ls command: include projects, list all if no specific context is named.

project.properties

@@ -1,7 +1,8 @@
-#Mon, 29 Apr 2013 02:07:45 -0500
+#Mon, 05 Aug 2013 10:16:09 -0500
 lib.local=true
 name=jdb-gtd
-version=0.2
+version=1.1
 nailgun.classpath.dir=/home/jdbernard/programs/nailgun/classpath
-
-build.number=15
+executable.jar=true
+main.class=com.jdblabs.gtd.cli.GTDCLI
+build.number=2

src/main/com/jdblabs/gtd/cli/GTDCLI.groovy

@@ -10,7 +10,7 @@ import org.joda.time.DateTime
 
 public class GTDCLI {
 
-    public static final String VERSION = "0.2"
+    public static final String VERSION = "1.1"
     private static String EOL = System.getProperty("line.separator")
     private static GTDCLI nailgunInst
 
@@ -93,18 +93,22 @@ public class GTDCLI {
             switch (command.toLowerCase()) {
                 case ~/help/: printUsage(parsedArgs); break
                 case ~/done/: done(parsedArgs); break
+                case ~/cal|calendar/: calendar(parsedArgs); break
                 case ~/process/: process(parsedArgs); break
+                case ~/list-copies/: listCopies(parsedArgs); break
+                case ~/new/: newAction(parsedArgs); break
+                case ~/tickler/: tickler(parsedArgs); break
+                case ~/ls|list/: ls(parsedArgs); break;
                 default: 
-                    parsedArgs.addFirst(command)
-                    process(parsedArgs)
+                    println "Unrecognized command: ${command}"
                     break } } }
 
     protected void process(LinkedList args) {
 
         def path = args.poll()
         if (path) {
-            givenDir = new File(path)
-            if (!(gtdDirs = findGtdRootDir(givenPath))) {
+            def givenDir = new File(path)
+            if (!(gtdDirs = findGtdRootDir(givenDir))) {
                 println "'$path' is not a valid directory."; return }}
 
         // Start processing items
@@ -113,15 +117,6 @@ public class GTDCLI {
             println ""
             def response
             def readline = {stdin.nextLine().trim()}
-            def prompt = { msg ->
-                if (msg instanceof List) msg = msg.join(EOL)
-                msg += "> "
-                print msg
-                def line
-                
-                while(!(line = readline())) print msg 
-                
-                return line }
 
             // 1. Is it actionable?
             if (!item.title) item.title = filenameToString(item.file)
@@ -243,13 +238,17 @@ public class GTDCLI {
 
     protected void done(LinkedList args) {
 
-        def selectedFile = args.poll()
+        def selectedFilePath = args.poll()
+        def selectedFile = new File(selectedFilePath)
 
         if (!selectedFile) {
             println "gtd done command requires a <action-file> parameter."
             return }
 
-        def item = new Item(new File(workingDir, selectedFile))
+        def item
+        if (selectedFile.isAbsolute()) item = new Item(selectedFile)
+        else item = new Item(new File(workingDir, selectedFilePath))
+
         def itemMd5 = md5.digest(item.file.bytes)
 
         // Move to the done folder.
@@ -262,52 +261,295 @@ public class GTDCLI {
         if (inPath(gtdDirs.projects, oldFile)) {
 
             // Delete any copies of this item in the next actions folder.
-            gtdDirs["next-actions"].eachFileRecurse({ file -> 
-                if (file.isFile() && md5.digest(file.bytes) == itemMd5) {
-                    println "Deleting duplicate entry from the " +
+            findAllCopies(oldFile, gtdDirs."next-actions").each { file ->
+                println "Deleting duplicate entry from the " +
                         "${file.parentFile.name} context."
-                    file.delete() }})}
+                file.delete() }
 
-        // Check if this item was in the next-action folder.
-        if (inPath(gtdDirs["next-actions"], oldFile)) {
+            // Delete any copies of this item in the waiting folder.
+            findAllCopies(oldFile, gtdDirs.waiting).each { file ->
+                println "Deleting duplicate entry from the " +
+                    "${file.parentFile.name} waiting context."
+                file.delete() }}
 
-            // Delete any copies of this item in the next actions folder.
-            gtdDirs.projects.eachFileRecurse({ file ->
-                if (file.isFile() && md5.digest(file.bytes) == itemMd5) {
-                    println "Deleting duplicate entry from the " +
-                        "${file.parentFile.name} project."
-                    file.delete() }})}
+        // Check if this item was in the next-action or waiting folder.
+        if (inPath(gtdDirs["next-actions"], oldFile) ||
+            inPath(gtdDirs.waiting, oldFile)) {
+
+            // Delete any copies of this item in the projects folder.
+            findAllCopies(oldFile, gtdDirs.projects).each { file ->
+                println "Deleting duplicate entry from the " +
+                    "${file.parentFile.name} project."
+                file.delete() }}
 
         // Delete the original
         oldFile.delete()
 
         println "'$item' marked as done." }
     
+    protected void calendar(LinkedList args) {
+        def itemsOnCalendar = []
+
+        def addCalendarItems = { file ->
+            if (!file.isFile()) return
+            def item = new Item(file)
+            if (item.date) itemsOnCalendar << item }
+
+        gtdDirs."next-actions".eachFileRecurse(addCalendarItems)
+        gtdDirs.waiting.eachFileRecurse(addCalendarItems)
+        gtdDirs.projects.eachFileRecurse(addCalendarItems)
+
+        itemsOnCalendar = itemsOnCalendar.unique { md5.digest(it.file.bytes) }.
+                                          sort { it.date }
+
+        if (!itemsOnCalendar) println "No items on the calendar."
+
+        def currentDate = null
+            
+        itemsOnCalendar.each { item ->
+            def itemDay = new DateMidnight(item.date)
+            if (itemDay != currentDate) {
+                if (currentDate != null) println ""
+                println itemDay.toString("EEE, MM/dd")
+                println "----------"
+                currentDate = itemDay }
+
+            println "  $item" } }
+
+    protected void listCopies(LinkedList args) {
+
+        args.each { filePath ->
+            def file = new File(filePath)
+
+            if (!file.isAbsolute()) file = new File(workingDir, filePath)
+
+            if (!file.isFile()) {
+                println "${file.canonicalPath} is not a regular file."
+                return }
+
+            String originalRelativePath = getRelativePath(gtdDirs.root, file)
+            println "Copies of $originalRelativePath:"
+            println ""
+
+            findAllCopies(file, gtdDirs.root).each { copy ->
+                if (copy.canonicalPath != file.canonicalPath) {
+                    String relativePath = getRelativePath(gtdDirs.root, copy)
+                    println "  $relativePath" }} }
+
+        args.clear() }
+
+    protected void newAction(LinkedList args) {
+
+        def response = prompt(["Next action?", ""])
+        def file = new File(workingDir, stringToFilename(response))
+        file.createNewFile()
+        def item = new Item(file)
+        
+        item.action = response
+
+        println "Enter extra info. One 'key: value' pair per line."
+        println "(ex: date: YYYY-MM-DD, project=my-project)"
+        println "End with an empty line."
+        print "> "
+
+        while (response = stdin.nextLine().trim()) {
+            if (!(response =~ /[:=]/)) continue
+            def parts = response.split(/[:=]/)
+            item[parts[0].trim().toLowerCase()] =
+                PropertyHelp.parse(parts[1].trim())
+            print "> " }
+
+        item.save() }
+
+    protected void tickler(LinkedList args) {
+
+        gtdDirs.tickler.eachFileRecurse { file ->
+            def item = new Item(file)
+            def today = new DateMidnight()
+
+            // If the item is scheduled to be tickled today (or in the past)
+            // then move it into the next-actions folder
+            if ((item.tickle as DateMidnight) <= today) {
+                println "Moving '${item.action}' out of the tickler."
+                def oldFile = item.file
+                item.file = new File(gtdDirs."next-actions",
+                                     stringToFilename(item.action))
+                item.gtdProperties.remove("tickle")
+                item.save()
+                oldFile.delete() }}}
+
+    protected void ls(LinkedList args) {
+
+        def target = args.poll()
+
+        def printItems = { dir ->
+            if (!dir.exists() || !dir.isDirectory()) return
+            println "-- ${getRelativePath(gtdDirs.root, dir)} --"
+            dir.eachFile { file ->
+                if (!file.exists() || !file.isFile() || file.isHidden())
+                    return
+
+                def item = new Item(file)
+                println item.action }
+
+            println "" }
+
+        // If we have a named context or project, look for those items
+        // specifically
+        if (target) {
+
+            printItems(new File(gtdDirs['next-actions'], target))
+            printItems(new File(gtdDirs.waiting, target))
+            printItems(new File(gtdDirs.projects, target)) }
+
+        else {
+            printItems(gtdDirs['next-actions'])
+            printItems(gtdDirs['waiting'])
+            gtdDirs['next-actions'].eachDir(printItems)
+            gtdDirs['waiting'].eachDir(printItems) } }
+
     protected void printUsage(LinkedList args) {
 
         if (!args) {
-            println "Jonathan Bernard's Getting Things Done CLI v$VERSION"
-            println "usage: gtd [option...] <command>..."
-            println ""
-            println "options are:"
-            println ""
-            println "   -h, --help         Print this usage information."
-            println "   -d, --directory    Set the GTD root directory."
-            println "   -v, --version      Print the GTD CLI version."
-            println ""
-            println "top-leve commands:"
-            println ""
-            println "   process            Process inbox items systematically."
-            println "   help <command>     Print detailed help about a command."
+            println """\
+Jonathan Bernard's Getting Things Done CLI v$VERSION
+usage: gtd [option...] <command>...
+
+options are:
+
+   -h, --help                  Print this usage information.
+   -d, --directory             Set the GTD root directory.
+   -v, --version               Print the GTD CLI version.
+                              
+top-level commands:           
+                              
+   help <command>              Print detailed help about a command.
+   process                     Process inbox items systematically.
+   done <action-file>          Mark an action as done. This will automatically
+                               take care of duplicates of the action in project 
+                               or next-actions sub-folders.
+   calendar                    Show the tasks with specific days assigned to
+                               them, sorted by date.
+   list-copies <action-file>   Given an action item, list all the other places
+                               there the same item is filed (cross-reference
+                               with a project folder, for example).
+   new                         Interactively create a new action item in the
+                               current folder.
+   tickler                     Search the tickler file for items that need to be
+                               delivered and move them to the *next-actions*
+                               folder."""
         } else {
             def command = args.poll()
 
-            // TODO
-            //switch(command.toLowerCase())
-            //    case ~/process/:
+            switch(command.toLowerCase()) {
+                case ~/process/: println """\
+usage: gtd process
+
+This is an interactive command.
+
+GTD CLI goes through all the items in the "in" folder for this GTD repository
+and guides you through the *process* step of the GTD method as follows:
+
+                Is the item actionable?
+                           V
+                           +---------------------------> No
+                           |                           /   \\
+                          Yes                 Incubate       Trash
+                           |              (Someday/Maybe)
+                           V
+         Yes <--Too big for one action? --> No
+          |                                 |
+          V                                 |
+  Move to projects                          V
+(still needs organization)        What is the next action?
+                                          / 
+                                         / 
+                          Defer, delegate, or tickler?
+                          /         |              \\
+                         /     Move to the       Set a date for this
+              Move to the        waiting       to become active again.
+              next-actions      directory        Move to the tickler
+              directory                              directory."""
+                    break
+
+                case ~/done/: println """\
+usage: gtd done <action-file>
+
+Where <action-file> is expected to be the path (absolute or relative) to an
+action item file. The action item file is expected to be in the *projects*
+folder, the *next-actions* folder, the *waiting* folder, or a subfolder of one of
+the aforementioned folders. The item is prepended with the current date and
+moved to the *done* folder. If the item was in a project folder, the
+*next-actions* and *waiting* folders are scanned recursively for duplicates of
+the item, which are removed if found. Similarly, if the action was in a
+*next-actions* or *waiting* folder the *projects* folder is scanned recursively
+for duplicates.
+
+The intention of the duplicate removal is to allow you to copy actions from
+project folders into next action or waiting contexts, so you can keep a view of
+the item organized by the project or in your next actions list. The GTD CLI tool
+is smart enough to recognize that these are the same items filed in more than
+one place and deal with them all in one fell swoop. Duplicates are determined by
+exact file contents (MD5 has of the file contents)."""
+                    break
+
+                case ~/calendar/: println """\
+usage: gtd calendar
+
+Print an agenda of all the actions that are on the calendar, sorted by date.
+This prints a date heading first, then all of the actions assogned to that day.
+Remember that in the GTD calendar items are supposed to be hard dates, IE.
+things that *must* be done on the assigned date."""
+                    break
+
+                case ~/list-copies/: println """\
+usage: gtd list-copies <action-file>
+
+Where <action-file> is expected to be the path (absolute or relative) to an
+action item file.
+
+This command searched through the current GTD repository for any items that are
+duplicates of this item."""
+                    break
+
+                case ~/new/: println """\
+usage: gtd new
+
+This command is interactive (maybe allow it to take interactive prompts in the
+future?). It prompts the user for the next action and any extended properties
+that should be associated with it, then creates the action file in the current
+directory."""
+                    break
+
+                case ~/tickler/: println """\
+usage: gtd tickler
+
+This command should be scheduled for execution once a day. It checks the tickler
+file for any items that should become active (based on their <tickle> property)
+and moves them out of the tickler file and into the next-actions file."""
+                    break
+
+                case ~/ls|list-context/: println """\
+usage gtd ls [<context> ...]
+
+This command lists all the tasks for a given context or project. The purpose is
+to list in one place items that are sitting in the next-actions folder or the
+waiting folder for a specific context or list items for a given project. If no
+context or project is named, all contexts are listed."""
+            }
         }
     }
 
+    protected List<File> findAllCopies(File original, File inDir) {
+        def copies = []
+        def originalMD5 = md5.digest(original.bytes)
+
+        inDir.eachFileRecurse { file -> 
+            if (file.isFile() && md5.digest(file.bytes) == originalMD5)
+                copies << file }
+        
+        return copies }
+
     protected boolean inPath(File parent, File child) {
         def parentPath = parent.canonicalPath.split("/")
         def childPath = child.canonicalPath.split("/")
@@ -328,6 +570,18 @@ public class GTDCLI {
         // parent path.
         return true }
 
+    protected static String getRelativePath(File parent, File child) {
+        def parentPath = parent.canonicalPath.split("/")
+        def childPath = child.canonicalPath.split("/")
+
+        if (parentPath.length > childPath.length) return ""
+
+        int b = 0
+        while (b < parentPath.length && parentPath[b] == childPath[b] ) b++;
+
+        if (b != parentPath.length) return ""
+        return (['.'] + childPath[b..<childPath.length]).join('/') }
+
     protected Map findGtdRootDir(File givenDir) {
 
         def gtdDirs = [:]
@@ -346,12 +600,23 @@ public class GTDCLI {
 
         return [:] }
 
+    protected String prompt(def msg) {
+        if (msg instanceof List) msg = msg.join(EOL)
+        msg += "> "
+        print msg
+        def line
+        
+        while(!(line = stdin.nextLine().trim())) print msg 
+        
+        return line }
+
     static String filenameToString(File f) {
         return f.name.replaceAll(/[-_]/, " ").capitalize() }
 
     static String stringToFilename(String s) {
         return s.replaceAll(/\s/, '-').
-                replaceAll(/[';:]/, '').
+                replaceAll(/[';:(\.$)]/, '').
                 toLowerCase() }
+
 }
 

src/main/com/jdblabs/gtd/cli/Item.groovy

@@ -3,28 +3,28 @@ package com.jdblabs.gtd.cli
 public class Item {
     
     public File file
-    public Map properties = [:]
+    public Map gtdProperties = [:]
 
     public Item(File f) {
         this.file = f
 
         def javaProps = new Properties()
         f.withReader { reader -> javaProps.load(reader) }
-        javaProps.each { k, v -> properties[k] = PropertyHelp.parse(v) } }
+        javaProps.each { k, v -> gtdProperties[k] = PropertyHelp.parse(v) } }
 
     public void save() {
         def javaProps = new Properties()
-        properties.each { k, v -> javaProps[k] = PropertyHelp.format(v) }
+        gtdProperties.each { k, v -> javaProps[k] = PropertyHelp.format(v) }
         file.withOutputStream { os -> javaProps.store(os, "") } }
 
     public def propertyMissing(String name, def value) {
-        properties[name] = value }
+        gtdProperties[name] = value }
 
-    public def propertyMissing(String name) { return properties[name] }
+    public def propertyMissing(String name) { return gtdProperties[name] }
 
     public String toString() { 
-        if (properties.action) return properties.action
-        if (properties.outcome) return properties.outcome
-        if (properties.title) return properties.title
+        if (gtdProperties.action) return gtdProperties.action
+        if (gtdProperties.outcome) return gtdProperties.outcome
+        if (gtdProperties.title) return gtdProperties.title
         return file.name.replaceAll(/[-_]/, " ").capitalize() }
 }