todotxt 0.0.3 → 0.1.0

data/features/move.feature

@@ -0,0 +1,33 @@
+Feature: move
+
+  So that I can keep items organised
+  As a user
+  I want to move items between files
+
+  Background:
+    Given a config exists with the following files:
+      | alias    | path         |
+      | todo     | todo.txt     | 
+      | wishlist | wishlist.txt | 
+    And a todofile with the following items exists:
+      | todo                               |
+      | Getting Things Done @bookstore     |
+      | Label Maker @officesupply          |
+    And an empty todofile named "wishlist.txt" exists
+
+  Scenario: Move item from todo.txt to wishlist.txt
+    When I run `todotxt move 1 wishlist`
+    Then it should pass with:
+      """
+      1. Getting Things Done @bookstore
+      => Moved to wishlist.txt
+      """
+    And the file "todo.txt" should not contain "Getting Things Done @bookstore"
+    And the file "wishlist.txt" should contain "Getting Things Done @bookstore"
+
+  Scenario: Move an illegal item
+    When I run `todotxt move 1337 wishlist`
+    Then it should pass with:
+      """
+      ERROR: No todo found at line 1337
+      """

data/features/prepend.feature

@@ -0,0 +1,28 @@
+Feature: Prepend
+
+  So that I can change items
+  As a user
+  I want to prepend text to an item
+
+  Background:
+    Given a default config exists
+    And a todofile with the following items exists:
+       | todo                               |
+       | (B) Install todotxt @cli +todotxt  |
+       | Drink coffee                       |
+
+  Scenario: Add text to an item
+    When I run `todotxt prepend 2 Brew and`
+    Then it should pass with:
+      """
+      2. Brew and Drink coffee
+      """
+    And the file "todo.txt" should contain "Brew and Drink coffee"
+
+
+  Scenario: Add text to an illegal item:
+    When I run `todotxt prepend 1337 @sofa`
+    Then it should pass with:
+      """
+      ERROR: No todo found at line 1337
+      """

data/features/pri.feature

@@ -0,0 +1,40 @@
+Feature: Prioritise
+
+  So that I can make items more important
+  As a user
+  I want to prioritise items
+
+  Background:
+    Given a default config exists
+    And a todofile with the following items exists:
+       | todo                               |
+       | (B) Install todotxt @cli +todotxt  |
+       | Drink coffee                       |
+
+  Scenario: Set priority of an item should report it and change it in the file
+    When I run `todotxt pri 2 A`
+    Then it should pass with:
+      """
+      2. (A) Drink coffee
+      """
+    And the file "todo.txt" should contain "(A) Drink coffee"
+
+  Scenario: Set the priority of an already prioritised item
+    When I run `todotxt pri 1 A`
+    Then the file "todo.txt" should contain "(A) Install todotxt @cli +todotxt"
+
+  #todo: make it throw an error instead.
+  Scenario: Attempt to set priority to an illegal priority
+    When I run `todotxt pri 2 Foo`
+    Then it should pass with:
+      """
+      2. Drink coffee
+      """
+    And the file "todo.txt" should not contain "(Foo) Drink coffee"
+
+  Scenario: Attempt to set the priority of an illegal line
+    When I run `todotxt pri 1337 A`
+    Then it should pass with:
+       """
+       ERROR: No todo found at line 1337
+       """

data/features/replace.feature

@@ -0,0 +1,28 @@
+Feature: Replace
+
+  So that I can change items
+  As a user
+  I want to completely replace an item with new text
+
+  Background:
+    Given a default config exists
+    And a todofile with the following items exists:
+       | todo                               |
+       | (B) Install todotxt @cli +todotxt  |
+       | Drink coffee                       |
+
+  Scenario: Add text to an item
+    When I run `todotxt replace 2 sip frappucino @buckstar`
+    Then it should pass with:
+      """
+      2. sip frappucino @buckstar
+      """
+    And the file "todo.txt" should contain "sip frappucino @buckstar"
+    And the file "todo.txt" should not contain "Drink coffee"
+
+  Scenario: Add text to an illegal item:
+    When I run `todotxt prepend 1337 @sofa`
+    Then it should pass with:
+      """
+      ERROR: No todo found at line 1337
+      """

data/features/step_definitions/environment_steps.rb

@@ -0,0 +1,47 @@
+Given /^a default config exists$/ do
+  write_file(".todotxt.cfg", "[files]\ntodo = todo.txt")
+end
+
+Given /^an old config exists$/ do
+  write_file(".todotxt.cfg", "todo_txt_path = todo.txt")
+end
+
+Given /^an empty environment$/ do
+  step %{a file named ".todotxt.cfg" should not exist}
+  step %{a file named "todo.txt" should not exist}
+end
+
+Given /^a config exists with the following files:$/ do |files|
+  files_directive = "[files]\n"
+  files_directive += files.hashes.map {|file| "#{file["alias"]}=#{file["path"]}" }.join("\n")
+  write_file(".todotxt.cfg", files_directive)
+end
+
+Given /^a default config exists with the editor set to "(.*?)"$/ do |editor|
+  write_file(".todotxt.cfg", "editor=#{editor}\n[files]\ntodo = todo.txt")
+end
+
+Given /^a todofile exists$/ do
+  write_file("todo.txt", "Read documentation for todotxt\nWrite cucumber steps for todotxt")
+end
+
+Given /^a todofile with done items exists$/ do
+  write_file("todo.txt", "Read documentation for todotxt\nx Install todotxt\nWrite cucumber steps for todotxt")
+end
+
+Given /^a todofile with the following items exists:$/ do |todolist|
+  contents = todolist.hashes.map {|row| row["todo"] }.join("\n")
+  write_file("todo.txt", contents)
+end
+
+Given /^an empty todofile named "(.*?)" exists$/ do |filename|
+  write_file(filename, "")
+end
+
+Given /^the enviromnent variable "(.*?)" is set to "(.*?)"$/ do |name, value|
+  ENV[name] = value
+end
+
+Given /^the date is "(.*?)"$/ do |date|
+  step %{the enviromnent variable "date" is set to "#{date}"}
+end

data/features/step_definitions/list_steps.rb

@@ -0,0 +1,34 @@
+Then /^I should see all entries from the todofile with numbers$/ do
+  contents = ""
+  File.open(File.join(ENV["HOME"], "todo.txt")).each_line do |line|
+    # matching "1. Do Something"
+    contents += "([\\d]\.\\s+)#{Regexp.escape(line.strip)}.*"
+  end
+  step "it should pass with regex:", contents
+end
+
+Then /^I should see all entries from the todofile without formatting$/ do
+  contents = ""
+  File.open(File.join(ENV["HOME"], "todo.txt")).each_line do |line|
+    # matching "1 Do something", note the missing dot .
+    contents += "([\\d]\\s+)#{Regexp.escape(line.strip)}.*"
+  end
+  step "it should pass with regex:", contents
+  step "the output should not match /TODO: [\d]+ items/"
+end
+
+Then /^it should count (\d+) TODO\-items$/ do |count|
+  step %{the output should match /^TODO: #{count} items$/}
+end
+
+Then /^it should output "([^"]*)" brightly in "([^"]*)"$/ do |string, color|
+  assert_partial_output(string.color(color.to_sym).bright, all_output)
+end
+Then /^it should output "([^"]*)" in "([^"]*)"$/ do |string, color|
+  assert_partial_output(string.color(color.to_sym), all_output)
+end
+
+Then /^it should pass with todays date$/ do
+  today = DateTime.now.strftime("%Y-%m-%d")
+  step "it should pass with regex:", ".*#{today}.*"
+end

data/features/support/ansi.rb

@@ -0,0 +1,5 @@
+require "rainbow"
+
+Before('@ansi') do
+  ENV["FORCE_COLORS"] = "TRUE"
+end

data/features/support/aruba.rb

@@ -0,0 +1,9 @@
+require 'aruba/cucumber'
+
+# Temporarily enforce an isolated, fake, homedir.
+Around do |scenario, block|
+  @__aruba_original_home = ENV["HOME"]
+  ENV["HOME"] = File.expand_path(File.join("tmp", "aruba"))
+  block.call
+  ENV["HOME"] = @__aruba_original_home
+end

data/features/support/debugger.rb

@@ -0,0 +1 @@
+require "debugger"

data/features/undo.feature

@@ -0,0 +1,54 @@
+Feature: Undo
+
+  So that I can fix mistakes
+  As a user
+  I want to mark items as not done
+
+  Background:
+    Given a default config exists
+    Given a todofile with the following items exists:
+       | todo                                       |
+       | x 2013-01-01 Install todotxt @cli +todotxt |
+       | x Read documentation +todotxt              |
+       | 2012-12-12 Buy GTD book @amazon +wishlist  |
+
+  Scenario: Undo a single item reports it back and marks it as not done in the file
+    When I run `todotxt undo 2`
+    Then it should pass with:
+      """
+      2. Read documentation +todotxt
+      """
+    And the file "todo.txt" should contain exactly:
+      """
+      x 2013-01-01 Install todotxt @cli +todotxt
+      Read documentation +todotxt
+      2012-12-12 Buy GTD book @amazon +wishlist
+      """
+
+  Scenario: Undo multiple items
+    When I run `todotxt undo 1 2`
+    Then it should pass with:
+      """
+      1. 2013-01-01 Install todotxt @cli +todotxt
+      2. Read documentation +todotxt
+      """
+    And the file "todo.txt" should contain exactly:
+      """
+      2013-01-01 Install todotxt @cli +todotxt
+      Read documentation +todotxt
+      2012-12-12 Buy GTD book @amazon +wishlist
+      """
+
+  Scenario: Undo an item that was not marked as done
+    When I run `todotxt undo 3`
+    Then it should pass with:
+    """
+    3. 2012-12-12 Buy GTD book @amazon +wishlist
+    """
+
+  Scenario: Undo invalid items
+    When I run `todotxt undo 1337`
+    Then it should pass with:
+      """
+      ERROR: No todo found at line 1337
+     """

data/lib/todotxt/cli.rb

@@ -1,10 +1,9 @@
 require "thor"
 require "rainbow"
+require "chronic"
 require "parseconfig"
 
 module Todotxt
-  CFG_PATH = File.expand_path("~/.todotxt.cfg")
-
   class CLI < Thor
     include Thor::Actions
     include Todotxt::CLIHelpers
@@ -15,14 +14,31 @@ module Todotxt
 
     def initialize(*args)
       super
+      # Allow testing colors, rainbow usually detects whether
+      #  the output goes to a TTY, but Aruba/Cucumber is not a 
+      #  TTY, so we enforce it here, based on an environment var
+      Sickill::Rainbow.enabled = true if ENV["FORCE_COLORS"] == "TRUE"
+      @config = Config.new
+      @list   = nil
+      unless ["help", "generate_config", "generate_txt"].include? ARGV[0]
+        ask_and_create @config unless @config.file_exists?
+        if @config.deprecated? and options[:file]
+          error_and_exit "You are using an old config, which has no support for mulitple files. Please update your configuration."
+        end
 
-      unless ["help", "generate_config"].include? ARGV[0]
-        parse_config
-
-        @list = TodoList.new @txt_path
+        parse_conf
+        ask_and_create @file unless @file.exists?
+        @list = TodoList.new @file
       end
+
     end
 
+    class_option :file, :type => :string, :desc => "Use a different file than todo.txt
+     E.g. use 'done' to have the action performed on the file you set for 'done' in the todotxt
+     configuration under [files]."
+
+    default_task :list
+
     #
     # Listing
     #
@@ -31,12 +47,7 @@ module Todotxt
     method_option :done,   :type => :boolean, :aliases => "-d", :desc => "Include todo items that have been marked as done"
     method_option :simple, :type => :boolean, :desc => "Simple output (for scripts, etc)"
     def list search=""
-      with_done = false
-
-      with_done = true if options[:done]
-
-      @list.filter(search, :with_done => with_done)
-
+      @list.filter(search, :with_done => (options[:done] ? true : false))
       render_list :simple => !!options[:simple]
     end
     map "ls" => :list
@@ -61,6 +72,24 @@ module Todotxt
     end
     map "lsc" => :lscon
 
+    desc "due", "List due items"
+    def due
+      if ENV["date"] # Allow testing to "freeze" the date
+        today = DateTime.parse(ENV["date"]).to_date
+      else
+        today = DateTime.now.to_date
+      end
+
+      puts "Due today (#{today.strftime("%Y-%m-%d")})".bright
+      @list.on_date(today).each { |todo| puts format_todo(todo) }
+      puts "\nPast-due items".bright
+      @list.before_date(today).each { |todo| puts format_todo(todo) }
+      puts "\nDue 7 days in advance".bright
+      ((today+1)..(today+7)).each do |day|
+        @list.on_date(day).each { |todo| puts format_todo(todo) }
+      end
+    end
+
     #
     # Todo management
     #
@@ -201,21 +230,72 @@ module Todotxt
     end
     map "rm" => :del
 
+    desc "edit", "Open todo.txt file in your default editor"
+    def edit
+      system "#{@editor} #{@file.path}"
+    end
+
+    desc "move | mv ITEM#[, ITEM#, ITEM#, ...] file", "Move ITEM# to another file"
+    def move line1, *lines, other_list_alias
+      if @files[other_list_alias.to_sym].nil?
+        error_and_exit "File alias #{other_list_alias} not found"
+      else
+        other_list = TodoList.new @files[other_list_alias.to_sym]
+      end
+
+      lines.unshift(line1).each do |line|
+        todo = @list.find_by_line line
+        if todo
+          say format_todo(todo)
+          @list.move line, other_list
+          notice "Moved to #{other_list}"
+
+          other_list.save
+          @list.save
+        else
+          error "No todo found at line #{line}"
+        end
+      end
+    end
+    map "mv" => :move
+
+    desc "move | mv ITEM#[, ITEM#, ITEM#, ...] file", "Move ITEM# to another file"
+    def move line1, *lines, other_list_alias
+      if @files[other_list_alias.to_sym].nil?
+        error_and_exit "File alias #{other_list_alias} not found"
+      else
+        other_list = TodoList.new @files[other_list_alias.to_sym]
+      end
+
+      lines.unshift(line1).each do |line|
+        todo = @list.find_by_line line
+        if todo
+          say format_todo(todo)
+          @list.move line, other_list
+          notice "Moved to #{other_list}"
+
+          other_list.save
+          @list.save
+        else
+          error "No todo found at line #{line}"
+        end
+      end
+    end
+    map "mv" => :move
+
     #
     # File generation
     #
 
     desc "generate_config", "Create a .todotxt.cfg file in your home folder, containing the path to todo.txt"
     def generate_config
-      copy_file "todotxt.cfg", CFG_PATH
+      copy_file "todotxt.cfg", Config.config_path
       puts ""
-
-      parse_config
     end
 
     desc "generate_txt", "Create a sample todo.txt"
     def generate_txt
-      copy_file "todo.txt", @txt_path
+      copy_file "todo.txt", @file
       puts ""
     end
 
@@ -229,7 +309,6 @@ module Todotxt
     end
 
   private
-
     def render_list opts={}
       numsize = @list.count + 1
       numsize = numsize.to_s.length + 0
@@ -247,43 +326,50 @@ module Todotxt
       end
     end
 
-    def parse_config
-      unless File.exist? CFG_PATH
-        puts "You need a .todotxt.cfg file in your home folder to continue (used to determine the path of your todo.txt.) Answer yes to have it generated for you (pointing to ~/todo.txt), or no to create it yourself.\n\n"
-        confirm_generate = yes? "Create ~/.todotxt.cfg? [y/N]"
+    # File should respond_to "basename", "path" and "generate!"
+    def ask_and_create file
+      puts "#{file.basename} doesn't exist yet. Would you like to generate a sample file?"
+      confirm_generate = yes? "Create #{file.path}? [y/N]"
 
-        if confirm_generate
-          generate_config
-        else
-          puts ""
-          exit
-        end
+      if confirm_generate
+        file.generate!
+      else
+        puts ""
+        exit
       end
+    end
 
-      cfg = ParseConfig.new(CFG_PATH)
-
-      txt = cfg["todo_txt_path"]
-
-      if txt
-        @txt_path = File.expand_path(txt)
+    def parse_conf
+      @files = {}
 
-        unless File.exist? @txt_path
-          puts "#{txt} doesn't exist yet. Would you like to generate a sample file?"
-          confirm_generate = yes? "Create #{txt}? [y/N]"
+      return if @config.nil?
 
-          if confirm_generate
-            generate_txt
-          else
-            puts ""
-            exit
+      # Backwards compatibility with todo_txt_path
+      #   when old variable is still set, and no files=>todo 
+      #   given, fallback to this old version.
+      if @config["todo_txt_path"]
+        @files[:todo] ||= TodoFile.new(@config["todo_txt_path"])
+      else
+        # Fill the @files from settings.
+        @config["files"].each do |name, file_path|
+          unless file_path.empty?
+            @files[name.to_sym] = TodoFile.new(file_path)
           end
         end
+      end
+
+      # Determine what file should be activated, set that in @file
+      if options[:file]
+        file_sym = options[:file].to_sym
+        if @files.has_key? file_sym
+          @file = @files[file_sym]
+        end
       else
-        error "Couldn't find todo_txt_path setting in ~/.todotxt.cfg."
-        puts "Please run the following to create a new configuration file:"
-        puts "    todotxt generate_config"
-        exit
+        @file = @files[:todo]
       end
+
+      # Determine the editor
+      @editor = @config["editor"] || ENV["EDITOR"]
     end
   end
 end

data/lib/todotxt/clihelpers.rb

@@ -3,7 +3,6 @@ module Todotxt
 
     def format_todo(todo, number_padding=nil)
       line = todo.line.to_s
-      
       if number_padding
         line = line.rjust number_padding
       end
@@ -50,5 +49,9 @@ module Todotxt
       puts "ERROR: #{message}".color(:red)
     end
 
+    def error_and_exit message =""
+      error message
+      exit
+    end
   end
 end

data/lib/todotxt/config.rb

@@ -0,0 +1,58 @@
+require "parseconfig"
+require "fileutils"
+
+module Todotxt
+  class Config < ParseConfig
+    def initialize config_file = ""
+      if config_file.empty?
+        @config_file = Config.config_path
+      else
+        @config_file = config_file
+      end
+
+      if file_exists?
+        super @config_file
+        validate
+      else
+        @params = {}
+        @groups = []
+      end
+    end
+
+    def file_exists?
+      File.exists? @config_file
+    end
+
+    def files
+      params["files"] || {"todo" => params["todo_txt_path"] }
+    end
+
+    def generate!
+     FileUtils.copy File.join(File.dirname(File.expand_path(__FILE__)), "..", "..", "conf", "todotxt.cfg"), @config_file
+     import_config
+    end
+
+    def path
+      @config_file
+    end
+
+    def basename
+      File.basename @config_file
+    end
+
+    def self.config_path
+      File.join ENV["HOME"], ".todotxt.cfg"
+    end
+
+    def deprecated?
+      params["files"].nil?
+    end
+
+    private
+    def validate
+      if params["files"] && params["todo_txt_path"]
+        raise "Bad configuration file: use either files or todo_txt_path"
+      end
+    end
+  end
+end

data/lib/todotxt/regex.rb

@@ -2,5 +2,6 @@ module Todotxt
   PRIORITY_REGEX = /^\(([A-Z])\) /
   PROJECT_REGEX  = /(\+\w+)/
   CONTEXT_REGEX  = /(@\w+)/
+  DATE_REGEX     = /^(\([A-Z]\) )?(x )?((\d{4}-)(\d{1,2}-)(\d{1,2}))\s?/
   DONE_REGEX     = /^(\([A-Z]\) )?x /
 end

data/lib/todotxt/todo.rb

@@ -24,6 +24,11 @@ module Todotxt
       @done = !text.scan(DONE_REGEX).empty?
     end
 
+    def due
+      date = Chronic.parse(text.scan(DATE_REGEX).flatten[2])
+      date.nil? ? nil : date.to_date
+    end
+
     def do
       unless done
         @text = "x #{text}".strip

data/lib/todotxt/todofile.rb

@@ -0,0 +1,40 @@
+module Todotxt
+  class TodoFile
+
+    def initialize path
+      @path = File.expand_path(path)
+    end
+
+    # Generate a file from template
+    def generate!
+      FileUtils.copy File.join(File.dirname(File.expand_path(__FILE__)), "..", "..", "conf", "todo.txt"), @path
+    end
+
+    def path
+      @path
+    end
+
+    def basename
+      File.basename @path
+    end
+
+    def exists?
+      File.exists? File.expand_path(@path)
+    end
+
+    def self.from_key(key)
+      config = Todotxt::Config.new
+      if config.files.has_key? key
+        path = config.files[key]
+        self.new path
+      else
+        raise "Key not found in config"
+      end
+    end
+
+
+    def to_s
+      @path
+    end
+  end
+end