todo.txt 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cbbe3c577a2ed572182c84fc0529403187a78d76
-  data.tar.gz: 955a861d58cbabfccf886e2c9fd4ea8e9520a9da
+  metadata.gz: 9005f5878ad1e85af811526c8a82ad566d096ca2
+  data.tar.gz: 8874fd1b652471cb6476ecdb3e939c490b2f263a
 SHA512:
-  metadata.gz: 52552da4e560a61f35007feab5dcab4c5962e5defb01792885adf71ab7170d8eac923173020d089133e56b71ee75b93e3540f81649169a1c6d0746af2d2a9a7b
-  data.tar.gz: 8bed646c7f788d9aa5a134fa271c05b8e887986371663da9b5030e6d7ad82162b57d3acf03a73547feff0693cee01d3518f67e2e47d8dd74ef48071fb63f8f84
+  metadata.gz: 9b55d6efd15701f7228361db0b20386d721872c077d461b1be734d5076344c1c813269f016f601ae9d39d4602d36ca47a8afe5fb7a59cff60b335f272485b54b
+  data.tar.gz: e8a653e2279bdf69eeaa4afd53f8d1447773970376fe10fefe5e4279ab1b58dd0f74d74c41c02fcef2618553533728f01b2a209c1b8edc87bcfa588df898df88

data/README.md

@@ -1,11 +1,82 @@
 # TODO.txt
 
-My version of the [Todo.txt](https://github.com/ginatrapani/todo.txt-cli/wiki/The-Todo.txt-Format) format.
+- My personal flavor of the format. [Todo.txt](https://github.com/ginatrapani/todo.txt-cli/wiki/The-Todo.txt-Format)
 
-Integration:
+## Assumptions
 
-* Vim mapping to [toggle](https://github.com/svenfuchs/vim-todo.txt/blob/master/ftplugin/todo.vim#L1) a todo item status
-* Vim mapping to [push](https://github.com/svenfuchs/vim-todo.txt/blob/master/ftplugin/todo.vim#L2) done items to idonethis
-* Vim mapping to [archive](https://github.com/svenfuchs/vim-todo.txt/blob/master/ftplugin/todo.vim#L3) done items to a separate file
-* [launchctl](https://github.com/svenfuchs/todo.txt/blob/master/etc/me.todo-watch.plist) to `fswatch` the file, and [git push](https://github.com/svenfuchs/todo.txt/blob/master/bin/push) changes to a Gist
+These are my personal opinions, and probably due to how I am used to use my
+todo.txt file personally. Your mileage will most probably vary.
 
+* Being able to embed todo.txt item lines into arbirary text files, and format
+  a todo.txt file freely (adding section titles, comments, bullet point lists
+  etc) is a good thing. A tool must play nice with this and must not rewrite
+  any custom formatting.
+* An item can belong to one or many projects.
+* The concept of "contexts" (phone, work, home) seems like a stale from the GTD
+  era. Does anybody actually use this? Also, the format `@name` indicates a
+  person in most contexts nowadays.
+* Assigning explicit priorities don't really work well. Re-ordering items on
+  the todo.txt list works better.
+* A concept of generic key/value pairs seems like a useful addition to make the
+  format more flexible and adaptable. These also can be used for, e.g. due and
+  done dates (as well as contexts and priorities, if they still seem useful).
+* In order to integrate with services and other tools it seems useful to add
+  the concept of an `id`. I'll use `[id]` for this. Typing ids is a hassle, so
+  the tool should add them automatically.
+
+## Usage
+
+The gem comes with a command line executable, which plays nice with stdin and
+command line arguments. It makes most sense when integrated with another UI
+such as an editor. I'm using a simple VIM integration.
+
+```
+# Input files and stdin
+
+$ cat todo.txt | todo toggle foo   # outputs to stdout
+$ todo toggle foo --file todo.txt  # specify the file to work with
+$ todo toggle foo                  # should assume ./TODO.txt but i can't figure
+                                   # this out, see https://github.com/svenfuchs/todo.txt/blob/master/lib/todo/cli/cmd.rb#L29
+
+# Filtering items
+
+$ todo list --since yesterday                      # by done date
+$ todo list --since 2015-12-01 --before 2015-11-01 # by done date
+$ todo list --status pending                       # by status
+$ todo list --status done                          # by status
+$ todo list --project foo                          # by project
+$ todo list --project foo --project bar            # by project
+$ todo list --text foo                             # by text
+$ todo list foo                                    # by text
+$ todo list foo --since 2015-12-01 --status done   # by text, done date, and status
+
+Named dates are: one_month_ago, two_weeks_ago, one_week_ago: two_days_ago,
+yesterday, today.
+
+# Formats
+
+$ todo list --format short
+$ todo list --format full
+
+# Toggling
+
+$ todo toggle foo
+$ todo toggle --text foo
+$ todo toggle -- '- foo' # passing a full item line with a leading `-`
+
+# Archiving
+
+$ todo archive --since 2015-12-01
+$ todo archive # defaults to: two weeks ago
+```
+
+
+## Vim integration
+
+* Vim mapping to a todo item status [toggle](https://github.com/svenfuchs/vim-todo.txt/blob/master/ftplugin/todo.vim#L1)
+* Vim mapping to done items to idonethis [push](https://github.com/svenfuchs/vim-todo.txt/blob/master/ftplugin/todo.vim#L2)
+* Vim mapping to done items to a separate file [archive](https://github.com/svenfuchs/vim-todo.txt/blob/master/ftplugin/todo.vim#L3)
+
+## Mac OSX integration
+
+* to `fswatch` the file, and [git changes to a Gist [launchctl](https://github.com/svenfuchs/todo.txt/blob/master/etc/me.todo-watch.plist) push](https://github.com/svenfuchs/todo.txt/blob/master/bin/push)

data/lib/todo/cli/cmd.rb

@@ -10,17 +10,39 @@ module Todo
       extend Support::OptionsParser
       include Helpers::Hash::Slice
 
+      def self.normalize_date(date)
+        DATES[date.to_sym] ? DATES[date.to_sym] : date
+      end
+
       opt '-f', '--file FILENAME', 'Filename' do |opts, file|
         opts[:file] = file
       end
 
       def io
-        opts[:file] ? Src::File.new(opts[:file]) : Src::Io.new(slice(opts, :in, :out))
+        if opts[:file]
+          Src::File.new(opts[:file])
+        else
+          Src::Io.new(slice(opts, :in, :out))
+        end
       end
 
       def render(list, opts = {})
         View.new(list, opts).render
       end
+
+      # TODO how to test if stdin is attached?
+      #
+      # def stdin?
+      #   !$stdin.eof? # blocks
+      # end
+      #
+      # def stdin?
+      #   $stdin.read_nonblock(1)
+      #   $stdin.seek(-1) # can't seek on stdin?
+      #   true
+      # rescue IO::EAGAINWaitReadable
+      #   false
+      # end
     end
   end
 end

data/lib/todo/cli/list.rb

@@ -4,7 +4,7 @@ require 'todo/data/list'
 module Todo
   class Cli
     class List < Cmd
-      opt '-f', '--format FORMAT', 'Format' do |opts, format|
+      opt '--format FORMAT', 'Format' do |opts, format|
         opts[:format] = format
       end
 

data/lib/todo/cli/toggle.rb

@@ -5,6 +5,14 @@ require 'todo/data/parser'
 module Todo
   class Cli
     class Toggle < Cmd
+      opt '-i', '--id ID', 'ID' do |opts, id|
+        opts[:id] = id
+      end
+
+      opt '-t', '--text TEXT', 'Text' do |opts, text|
+        opts[:text] = text
+      end
+
       def run
         list = Data::List.parse(io.read)
         list.toggle(data)
@@ -14,7 +22,8 @@ module Todo
       private
 
         def data
-          data = Data::Parser.new(args.first).parse
+          data = Data::Parser.new(args.first.to_s).parse
+          data = data.merge(slice(opts, :id, :text))
           slice(data, :id, :text)
         end
     end

data/lib/todo/cli.rb

@@ -26,10 +26,6 @@ module Todo
 
     private
 
-      def normalize_date(date)
-        DATES[date.to_sym] ? DATES[date.to_sym] : date
-      end
-
       def const
         @const ||= Cli.const_get(camelize(cmd))
       rescue NameError

data/lib/todo/data/list.rb

@@ -56,8 +56,8 @@ module Todo
       private
 
         def validate(data, list)
-          raise Error.new(MSGS[:item_not_found] % to_pairs(data)) if list.size == 0
-          raise Error.new(MSGS[:multiple_items] % to_pairs(data)) if list.size > 1
+          raise Error.new(MSGS[:item_not_found] % to_pairs(data).join(' ')) if list.size == 0
+          raise Error.new(MSGS[:multiple_items] % to_pairs(data).join(' ')) if list.size > 1
         end
     end
   end

data/lib/todo/data/matcher.rb

@@ -32,7 +32,7 @@ module Todo
         end
 
         def match_text
-          item.text.include?(data[:text])
+          item.text.include?(data[:text]) unless data[:text].empty?
         end
 
         def match_projects

data/lib/todo/version.rb

@@ -1,3 +1,3 @@
 module Todo
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end

data/lib/todo.rb

@@ -6,7 +6,10 @@ module Todo
   }
 
   DATES = {
+    one_month_ago: (Time.now - 60 * 60 * 24 * 31).strftime('%Y-%m-%d'),
     two_weeks_ago: (Time.now - 60 * 60 * 24 * 14).strftime('%Y-%m-%d'),
+    one_week_ago:  (Time.now - 60 * 60 * 24 * 7).strftime('%Y-%m-%d'),
+    two_days_ago:  (Time.now - 60 * 60 * 24 * 2).strftime('%Y-%m-%d'),
     yesterday:     (Time.now - 60 * 60 * 24).strftime('%Y-%m-%d'),
     today:         Time.now.strftime('%Y-%m-%d')
   }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: todo.txt
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Sven Fuchs
@@ -19,7 +19,6 @@ files:
 - Gemfile
 - Gemfile.lock
 - MIT-LICENSE
-- NOTES.md
 - README.md
 - lib/todo.rb
 - lib/todo/cli.rb