xtdo 0.2

data/HISTORY

@@ -0,0 +1,7 @@
+0.2.0 - 28 November 2010
+  * Added ZSH completion
+  * Added XTDO_PATH environment variable for customizing storage location
+  * Added recurring tasks to list all
+
+0.1.0 - 27 November 2010
+  * Initial release

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2010 Xavier Shay
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,58 @@
+= xtdo
+
+An ultra fast command line todo list manager, with some strong opinions about workflow.
+
+== Usage
+
+Every command is mapped to a single character. If you want to be fast, you need to get the key strokes down.
+  
+  l = list
+  a = add (or all when used with list)
+  d = done
+  b = bump
+  r = recur
+  c = completion (to help enable shell tab completion)
+
+Here is how it fits together:
+
+  gem install xtdo
+
+  alias t=xtdo # Recommended!
+
+  t a some task          # Add to list
+  t l a                  # All tasks
+  t b 0 some task        # Move task to TODAY
+  t a 0 another task     # New task on today list, shortcut letter
+  t l                    # Today's tasks
+  t d another task       # It is done!
+  t b 1w some task       # Actually we will to it next week
+  t r a 1d,thu bin night # Bin night every Thursday
+  t r a 1m,4 pay rent    # Pay rent on the 4th of the month
+  t r d pay rent         # Bah who wants to pay rent
+
+  t l c                  # List all tasks in a format suitable for tab completion
+  t r c                  # List all recurring tasks for completion
+
+There is a command line completion script for ZSH in bin/xtdo_completion.zsh that you should use, since it auto completes task names for you. I don't know the best way to install this yet.
+
+By default tasks are stored in ~/.xtdo. Customize this by setting the XTDO_PATH environment variable. I store mine in Dropbox.
+
+== Why?
+
+I used to use a small subset of Things.app, and I really dug the workflow. I spend my life on the command-line though. Existing command line apps didn't quite match my workflow, or were too slow.
+
+Xtdo is fast in the sense that you type very little to make it do things, but also in that it is extremely quick to respond to commands - you will never notice any delay.
+
+== Compatibility
+
+Requires ruby 1.9.2. Will not run on any variant of 1.8.
+
+== Developing
+
+Refactors accepted, as long as they don't turn everything into a First Class Object. I see no reason why this code should require more than one file. I will likely not accept any features that I will not use personally.
+
+There are no runtime external dependencies. Let's keep it that way.
+
+== Status
+
+Almost, but not quite, useable. This file is the only documentation you'll get currently.

data/Rakefile

@@ -0,0 +1,10 @@
+desc 'Default: run specs.'
+task :default => :spec
+
+# RSpec provided helper doesn't like me, for now just run it myself
+desc "Run specs"
+task :spec do
+  commands = []
+  commands << "bundle exec rspec spec/*_spec.rb"
+  exec commands.join(" && ")
+end

data/TODO

@@ -0,0 +1,4 @@
+- gemspec
+- start using it
+- help on the command line
+- better UI feedback

data/bin/xtdo

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+
+require 'xtdo'
+file = ENV['XTDO_PATH'] || "~/.xtdo"
+result = Xtdo.run file, ARGV.join(" ")
+puts result if result && result.is_a?(String) && result.length > 0

data/bin/xtdo_completion.zsh

@@ -0,0 +1,26 @@
+autoload -U compinit
+compinit
+
+_xtdo() {
+  # TODO: Complete a bare 'xtdo' with commands + description
+
+  if [[ $words[2] == b ]]; then
+    if (( CURRENT == 4 )); then
+      compadd `bin/xtdo l c`
+    fi
+  fi
+
+  if [[ $words[2] == d ]]; then
+    if (( CURRENT == 3 )); then
+      compadd `bin/xtdo l c`
+    fi
+  fi
+
+  if [[ $words[2] == r && $words[3] == d ]]; then
+    if (( CURRENT == 4 )); then
+      compadd `bin/xtdo r c`
+    fi
+  fi
+}
+
+compdef _xtdo xtdo 

data/lib/xtdo.rb

@@ -0,0 +1,203 @@
+require 'date'
+require 'yaml'
+
+class Xtdo
+  def self.run(store, operation)
+    operation = operation.split(/\s+/)
+    verb = operation.shift
+
+#     tasks = {
+#       'T1' => {:scheduled => Date.today}
+#     }
+    store = File.expand_path(store)
+    tasks = if File.exists?(store)
+      YAML.load(File.open(store))
+    else
+      {}
+    end
+    tasks[:tasks] ||= {}
+    tasks[:recurring] ||= {}
+
+    manager = Xtdo.new(tasks)
+
+    ret = case verb
+    when 'a' then # A is for add!
+      manager.add operation.join(' ')
+    when 'b' then # B is for bump!
+      manager.bump operation.join(' ')
+    when 'd' then # D is for done!
+      manager.done operation.join(' ')
+    when 'l' then # L is for list!
+      case operation[0]
+      when 'a' then
+        manager.list [:today, :next, :scheduled]
+      when 'c' then
+        manager.list [:today, :next, :scheduled], :format => :completion
+      else
+        manager.list [:today]
+      end
+    when 'r' then # R is for recur!
+      manager.recur operation.join(' ')
+    end
+
+    manager.save(store)
+    ret
+  end
+
+  attr_reader :tasks, :recurring
+
+  def initialize(tasks)
+    @tasks = tasks[:tasks]
+    @recurring = tasks[:recurring]
+  end
+
+  def parse_relative_time(number, period)
+    adj = {
+      'd' => 1,
+      'w' => 7,
+      'm' => 30,
+      'y' => 365
+    }[period] || 1
+    Date.today + adj * number
+  end
+
+  def add(task)
+    number, period, task = /^(?:(\d+)([dwmy])? )?(.*)/.match(task).captures
+    @tasks[make_key task] = {:name => task}
+    @tasks[make_key task][:scheduled] = parse_relative_time(number.to_i, period) if number
+  end
+
+  def bump(task)
+    number, period, task = /^(?:(\d+)([dwmy])? )?(.*)/.match(task).captures
+    if !number
+      "Invalid time"
+    elsif tasks[make_key task]
+      tasks[make_key task][:scheduled] = parse_relative_time(number.to_i, period)
+    else
+      "No such task"
+    end
+  end
+
+  def done(task)
+    if tasks.delete(make_key task)
+      "Task done"
+    else
+      "No such task"
+    end
+  end
+
+  def list(groups, opts = {})
+    # Check for recurring
+    recurring.each do |name, task|
+      if task[:next] <= Date.today
+        tasks[make_key name] = {:scheduled => Date.today, :name => task[:name] }
+        number, period, start, _ = self.class.extract_recur_tokens(task[:period] + ' ' + name)
+
+        task[:next] = self.class.calculate_starting_day(Date.today, number, period, start)
+      end
+    end
+
+    if opts[:format] == :completion
+      tasks.keys.join "\n"
+    else
+      # Print groups
+      task_selector = {
+        :today     => lambda {|x| x && x <= Date.today },
+        :next      => lambda {|x| !x },
+        :scheduled => lambda {|x| x && x > Date.today }
+      }
+
+      groups.map do |group|
+        t = tasks.select {|name, opts| task_selector[group][opts[:scheduled]] }
+        next if t.empty?
+        "===== #{group.to_s.upcase}\n" + t.map { |name, attrs|
+          attrs[:name]
+        }.join("\n")
+      end.join("\n")
+    end
+  end
+
+  def recur(task)
+    tokens = task.split(/\s+/)
+    verb = tokens.shift
+    task = tokens.join(' ')
+    case verb
+    when 'a' then
+      number, period, start, name = self.class.extract_recur_tokens(task)
+
+      period_string = "#{number}#{period}"
+      period_string += ",#{start}" if start
+      recurring[make_key name] = {
+        :name   => name,
+        :next   => Date.today + 1,
+        :period => period_string
+      }
+    when 'd' then
+      if recurring.delete make_key(task)
+        "Recurring task removed"
+      else
+        "No such recurring task"
+      end
+    when 'l' then
+      "===== RECURRING\n" + recurring.map do |name, task|
+        "%-6s%s" % [task[:period], task[:name]]
+      end.join("\n")
+    when 'c' then
+      recurring.keys.join "\n"
+    end
+  end
+
+  def make_key(name)
+    name.gsub /[^a-zA-Z0-9,.]/, '-' 
+  end
+
+  def self.calculate_starting_day(date, number, period, start = nil)
+    days = %w(sun mon tue wed thu fri sat)
+    number = (number || 1).to_i
+
+    adjust = case period
+    when 'd' then 1
+    when 'w' then
+      if days.index(start)
+        (days.index(start) - date.wday) % 7 + (number - 1) * 7
+      end
+    when 'm' then
+      start = start.to_i
+      if start > 0
+        year = date.year
+        if start.to_i <= date.day
+          month = date.month + 1
+          if month > 12
+            month = 1
+            year += 1
+          end
+        else
+          month = date.month
+        end
+        Date.new(year, month, start.to_i) - date
+      end
+    end
+    if adjust
+      if adjust == 0
+        date + 7
+      else
+        date + adjust
+      end
+    end
+  end
+
+  def self.extract_recur_tokens(task)
+    /^(\d+)([dwmy])?(?:,(#{days.join('|')}|\d{1,2}))? (.*)/.match(task).captures
+  end
+  def self.days
+    days = %w(sun mon tue wed thu fri sat)
+  end
+
+  def save(file)
+    File.open(file, 'w') {|f| f.write({
+      :tasks     => tasks,
+      :recurring => recurring,
+      :version   => 1
+    }.to_yaml) } 
+  end
+end

data/spec/add_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+feature 'add' do
+  scenario 'to next' do
+    t('a T1')
+    t('l a').should have_task('T1', :in => :next)
+  end
+
+  scenario 'to today' do
+    t('a 0 T1')
+    t('l a').should have_task('T1', :in => :today)
+  end
+
+  scenario 'to scheduled' do
+    t('a 1w T1')
+    t('l a').should have_task('T1', :in => :scheduled, :for => Date.today + 7)
+  end
+end

data/spec/bump_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+feature 'bumping tasks' do
+  scenario 'moving around' do
+    t('a T1')
+    t('l').should_not have_task('T1', :in => :today)
+    t('b 0 T1')
+    t('l').should have_task('T1', :in => :today)
+    t('b 1 T1')
+    t('l a').should have_task('T1', :in => :scheduled, :for => Date.today + 1)
+    t('b 1w T1')
+    t('l a').should have_task('T1', :in => :scheduled, :for => Date.today + 7)
+  end
+
+  scenario 'invalid input' do
+    t('b 0 T1').should == 'No such task'
+    t('b T1').should == 'Invalid time'
+  end
+end

data/spec/completion_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+feature 'completion' do
+  scenario 'normal' do
+    t('a 0 T1') # Today
+    t('a T2')   # Next
+    t('a 1 T3') # Scheduled
+
+    t('l c').should have_completion_task('T1')
+    t('l c').should have_completion_task('T2')
+    t('l c').should have_completion_task('T3')
+  end
+
+  scenario 'recurring' do
+    t('r a 1d T1')
+    t('r c').should have_completion_task('T1')
+  end
+end

data/spec/done_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+feature 'done' do
+  scenario 'marking off tasks' do
+    t('a T1')
+    t('l a').should have_task('T1')
+    t('d T1').should == "Task done"
+    t('l').should_not have_task('T1')
+  end
+
+  scenario 'invalid input' do
+    t('d T1').should == "No such task"
+  end
+end

data/spec/list_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+feature 'list' do
+  scenario 'options' do
+    t('a 0 T1')    # Today
+    t('a T2')      # Next
+    t('a 1 T3')    # Scheduled
+
+    # Today
+    t('l').should have_task('T1')
+    t('l').should_not have_task('T2')
+    t('l').should_not have_task('T3')
+
+    # All
+    t('l a').should have_task('T1')
+    t('l a').should have_task('T2')
+    t('l a').should have_task('T3')
+  end
+end

data/spec/recurring_spec.rb

@@ -0,0 +1,93 @@
+require 'spec_helper'
+
+feature 'recurring' do
+  describe 'extract_r_tokens' do
+    it { Xtdo.extract_recur_tokens('1d T1').should == ['1', 'd', nil, 'T1'] }
+    it { Xtdo.extract_recur_tokens('1w,thu T1').should == ['1', 'w', 'thu', 'T1'] }
+    it { Xtdo.extract_recur_tokens('1m,2 T1').should == ['1', 'm', '2', 'T1'] }
+    it { Xtdo.extract_recur_tokens('1m,20 T1').should == ['1', 'm', '20', 'T1'] }
+  end
+
+  describe 'starting day' do
+    let(:today) { Date.new(2010,11,22) } # Monday
+
+    it { Xtdo.calculate_starting_day(today, 1, 'd').should == today + 1 }
+    it { Xtdo.calculate_starting_day(today, 1, 'w', 'mon').should == today + 7}
+    it { Xtdo.calculate_starting_day(today, 1, 'w', 'tue').should == today + 1}
+    it { Xtdo.calculate_starting_day(today, 1, 'w', 'sun').should == today + 6}
+    it { Xtdo.calculate_starting_day(today, 1, 'w', '0').should == nil }
+    it { Xtdo.calculate_starting_day(today, 1, 'm', '1').should == Date.new(2010,12,1)}
+    it { Xtdo.calculate_starting_day(today, 1, 'm', '22').should == Date.new(2010,12,22)}
+    it { Xtdo.calculate_starting_day(today, 1, 'm', '23').should == Date.new(2010,11,23)}
+    it { Xtdo.calculate_starting_day(today, 1, 'm', '0').should == nil }
+  end
+
+  let(:today) { Date.new(2010,11,17) } # Monday
+
+  scenario 'list' do
+    t('r a 1d T1')
+    t('r l').should have_task('1d    T1')
+  end
+
+  scenario 'daily' do
+
+    time_travel today
+    t('r a 1d T1')
+
+    time_travel today + 1
+    t('l').should have_task('T1')
+    t('b 1 T1')
+    t('l').should_not have_task('T1')
+    t('d T1')
+    t('l').should_not have_task('T1')
+
+    time_travel today + 2
+    t('l').should have_task('T1')
+    t('d T1')
+
+    time_travel today + 4
+    t('l').should have_task('T1')
+  end
+
+  scenario 'remove' do
+    time_travel today
+    t('r a 1d T1')
+    t('r d T1')
+    time_travel today + 1
+    t('l a').should_not have_task('T1')
+  end
+
+  scenario 'weekly' do
+    time_travel today
+    t('r a 1w,thu T1')
+
+    time_travel Date.new(2010,11,18) # Thursday
+    t('l').should have_task('T1')
+    t('b 1 T1')
+    t('l').should_not have_task('T1')
+    t('d T1')
+    t('l').should_not have_task('T1') # Do not recreate the task
+
+    time_travel Date.new(2010,11,25) # Next Thursday
+    t('l').should have_task('T1')
+    t('d T1')
+
+    time_travel Date.new(2010,12,3) # Friday after
+    t('l').should have_task('T1')
+  end
+
+  scenario 'monthly' do
+    time_travel today
+    t('r a 1m,3 T1')
+
+    time_travel Date.new(2010,12,3)
+    t('l').should have_task('T1')
+    t('b 1 T1')
+    t('l').should_not have_task('T1')
+    t('d T1')
+    t('l').should_not have_task('T1')
+
+    time_travel Date.new(2011,1,4)
+    t('l').should have_task('T1')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,112 @@
+require 'rspec'
+require 'tempfile'
+require 'date'
+require 'timecop'
+
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require 'xtdo'
+
+RSpec.configure do |config|
+  config.before :each do
+    @file = File.join(Dir.tmpdir, 'xtdo_test.yml')
+  end
+
+  config.after :each do
+    File.unlink @file if File.exists? @file
+    Timecop.return
+  end
+
+  def t(operation)
+    Xtdo.run @file, operation
+  end
+  
+  def time_travel(time)
+    Timecop.travel(time)
+  end
+end
+
+RSpec::Matchers.define(:have_completion_task) do |task|
+  match do |result|
+    parse(result).include? task
+  end
+
+  failure_message_for_should do |result|
+    buffer = "Expected to find #{task}. Instead found:\n"
+    parse(result).each do |found|
+      buffer += "  #{found}"  
+    end
+    buffer
+  end
+
+  def parse(data)
+    data.to_s.lines.map(&:chomp)
+  end
+end
+
+RSpec::Matchers.define(:have_task) do |task, opts = {}|
+  match do |result|
+    parsed = parse(result)
+    tasks = opts[:in] ? parsed[opts[:in]] : parsed.values.flatten
+    tasks && tasks.include?(task)
+  end
+
+  failure_message_for_should do |result|
+    in_string = " in #{opts[:in]}" if opts[:in]
+    buffer = "Expected to find #{task}#{in_string}. Instead found:\n"
+    parse(result).each do |group, tasks|
+      buffer += "  #{group}\n"
+      buffer += tasks.map {|x| "    #{x}" }.join("\n")
+      buffer += "\n"
+    end
+    buffer
+  end
+
+  failure_message_for_should_not do |result|
+    in_string = " in #{opts[:in]}" if opts[:in]
+    buffer = "Expected not to find #{task}#{in_string}:\n"
+    parse(result).each do |group, tasks|
+      buffer += "  #{group}\n"
+      buffer += tasks.map {|x| "    #{x}" }.join("\n")
+      buffer += "\n"
+    end
+    buffer
+  end
+
+  def parse(data)
+    @parsed ||= begin
+      group = nil
+      data.to_s.lines.inject({}) do |a, line|
+        if line =~ /^=+ (.+)/
+          group = line[/^=+ (.+)/, 1].downcase.to_sym
+        else
+          a[group] ||= [] 
+          a[group] << line.chomp
+        end
+        a
+      end
+    end
+  end
+end
+
+module Steak
+  module AcceptanceExampleGroup
+    def self.included(base)
+      base.instance_eval do
+        alias scenario example
+        alias background before
+      end
+    end
+  end
+
+  module DSL
+    def feature(*args, &block)
+      args << {} unless args.last.is_a?(Hash)
+      args.last.update :type => :acceptance, :steak => true, :caller => caller   
+      describe(*args, &block)
+    end
+  end
+end
+
+extend Steak::DSL
+
+RSpec.configuration.include Steak::AcceptanceExampleGroup, :type => :acceptance

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification 
+name: xtdo
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  version: "0.2"
+platform: ruby
+authors: 
+- Xavier Shay
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-28 00:00:00 +11:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 1
+        - 0
+        version: 2.1.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: timecop
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: 
+email: 
+- hello@xaviershay.com
+executables: 
+- xtdo
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- spec/add_spec.rb
+- spec/bump_spec.rb
+- spec/completion_spec.rb
+- spec/done_spec.rb
+- spec/list_spec.rb
+- spec/recurring_spec.rb
+- spec/spec_helper.rb
+- lib/xtdo.rb
+- bin/xtdo
+- bin/xtdo_completion.zsh
+- README.rdoc
+- HISTORY
+- LICENSE
+- Rakefile
+- TODO
+has_rdoc: false
+homepage: http://github.com/xaviershay/xtdo
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Minimal and fast command line todo manager
+test_files: []
+