todotxt 0.0.3 → 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NjE5ZGQyNjI2ODg5YzBhNGM3MDBlNjAzZDhkN2I4YTEwMDcxZDA2NA==
+  data.tar.gz: !binary |-
+    ZGY2NmJiOTM2OWUxMzUzMjFkYmZmMzE1NGJlMGQ1OGU2ZWZmZjNhYg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZGU5YTU3YjIwNmU3YTNmNzg4ZTlhNDczMmJjZGI5YTE2OTFkY2JmYTM3MDNm
+    MTBhNjliYThhOTk4YjdmODM1ZGM4MTEyYmQwNzRkMDU0Y2IzNjVjMTg3YjBh
+    ZTdiZDIyMjZiODg3YjAzMzRhZmM0YjdjNGFkYzZmNjA4Y2JlOTI=
+  data.tar.gz: !binary |-
+    MjFiMTU5YzIxNjMxMTZlZTlhZmIxYTRmZmFkMTAzMzY3NmM2OGQ2NDJjYWY3
+    N2ExMDgwZThjMGJhODk0NmJmNTM5Nzc0N2IxNTJiMWM1ODcwYzY5ZjFlMDAy
+    NWI0MmEwNjcxMzNmMDJlNjZlMWY4ZTM1NGEwNGQwOWEyZDU2YjA=

data/.gitignore

@@ -2,3 +2,5 @@
 .bundle
 Gemfile.lock
 pkg/*
+coverage/*
+tmp/*

data/README.md

@@ -43,6 +43,7 @@ todo.txt.
       todotxt del | rm ITEM#[, ITEM#, ITEM#, ...]    # Remove ITEM#
       todotxt do ITEM#[, ITEM#, ITEM#, ...]          # Mark ITEM# as done
       todotxt dp | depri ITEM#[, ITEM#, ITEM#, ...]  # Remove priority for ITEM#
+      todotxt edit                                   # Open todo.txt file in your default editor
       todotxt generate_txt                           # Create a sample todo.txt
       todotxt generate_config                        # Create a .todotxt.cfg file in your home folder, containing the path to todo.txt
       todotxt help [TASK]                            # Describe available tasks or one specific task

data/bin/todotxt

@@ -5,9 +5,9 @@ $LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
 
 args = ARGV.clone
 
-if args.empty?
-  args.push "ls"
-end
+#if args.empty?
+  #args.push "ls"
+#end
 
 require "todotxt"
 Todotxt::CLI.start(args)

data/conf/todotxt.cfg

@@ -1 +1,13 @@
-todo_txt_path = ~/todo.txt
+# list files that may contain todo.txt lines.
+#  Obviously, todo.txt is required.
+#  Additionally use for files such as done.txt, deferred.txt or archive.txt.
+#  In contrary to required todo.txt, these will not be 
+#  auto-generated for you on initialisation.
+[files]
+# Path to your todo.txt file. The only required file.
+todo     = ~/todo.txt 
+done     = ""
+deferred = ""
+
+# set editor for todotxt, defaults to $EDITOR.
+# editor = "vim"

data/cucumber.yml

@@ -0,0 +1,3 @@
+default: --tags ~@wip --tags ~@todo --require features
+wip: --tags @wip:3 --wip --require features
+todo: --tags @todo:3 --wip --require features

data/features/add.feature

@@ -0,0 +1,24 @@
+Feature: Add items
+
+  So that I can add new todos
+  As a user
+  I want to insert several new todos
+
+  Background:
+    Given a default config exists
+    And a todofile exists
+
+  Scenario: Adding a todo reports the added todo back to the user
+    When I run `todotxt add "Make Coffee"`
+    Then it should pass with:
+      """
+      Make Coffee
+      """
+
+  Scenario: Adding a todo inserts it into the file
+    When I run `todotxt add "Make Coffee"`
+    Then the file "todo.txt" should contain "Make Coffee"
+
+  Scenario: Adding a todo with weird character adds it to the file
+    When I run `todotxt add Äta gul snö`
+    Then the file "todo.txt" should contain "Äta gul snö"

data/features/append.feature

@@ -0,0 +1,28 @@
+Feature: Append
+
+  So that I can change items
+  As a user
+  I want to append 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 append 2 @sofa`
+    Then it should pass with:
+      """
+      2. Drink coffee @sofa
+      """
+    And the file "todo.txt" should contain "Drink coffee @sofa"
+
+
+  Scenario: Add text to an illegal item:
+    When I run `todotxt append 1337 @sofa`
+    Then it should pass with:
+      """
+      ERROR: No todo found at line 1337
+      """

data/features/backwards.feature

@@ -0,0 +1,28 @@
+Feature: Backwards compatibility
+
+  So that I can continue using todotxt on an older system
+  As a user
+  I want to run todotxt with an old config
+
+  Scenario: Running with an old config-file still works
+    Given an old config exists
+    And a todofile with the following items exists:
+       | todo                  | 
+       | Update my config file | 
+    When I run `todotxt`
+    Then it should pass with:
+      """
+      1. Update my config file
+      """
+
+  Scenario: Running with an old config-file and option --files fails
+    Given an old config exists
+    And a todofile with the following items exists:
+      | todo                  |
+      | Update my config file |
+    When I run `todotxt --file=done`
+    Then it should pass with exactly:
+      """
+      ERROR: You are using an old config, which has no support for mulitple files. Please update your configuration.
+
+      """

data/features/colors.feature

@@ -0,0 +1,51 @@
+Feature: Colors and markup
+
+  So that I can glance over my todos
+  As a user
+  I want to see output colored and highlighted
+
+  Background:
+    Given a default config exists
+    Given a todofile with the following items exists:
+       | todo                     | 
+       | Drink Coffee             | 
+       | Sip Frappucino @buckstar | 
+       | Lurk Americano +break    | 
+       | x brew coffee            | 
+       | (A) Order coffee         |
+       | (B) Pay coffee           |
+       | (C) Pick up coffee       |
+       | (D) Thank for service    |
+
+  @ansi
+  Scenario: See todos with a bright, dark number and uncolored todo-text
+    When I successfully run `todotxt list Drink`
+    Then it should output "1. " brightly in "black"
+    And the output should contain "Drink Coffee"
+
+  @ansi
+  Scenario: See todo-count in bright dark letters
+    When I successfully run `todotxt list Drink`
+    Then it should output "TODO: 1 items" brightly in "black"
+
+  @ansi
+  Scenario: See contexts in blue
+    When I successfully run `todotxt list @buckstar`
+    Then it should output "@buckstar" in "blue"
+
+  @ansi
+  Scenario: See projects in green
+    When I successfully run `todotxt list +break`
+    Then it should output "+break" in "green"
+
+  @ansi
+  Scenario Outline:
+    When I successfully run `todotxt list (<priority>)`
+    Then it should output "(<priority>) " in "<color>"
+  Examples:
+     | priority | color  | 
+     | A        | red    | 
+     | B        | yellow | 
+     | C        | green  | 
+     | D        | white  | 
+

data/features/del.feature

@@ -0,0 +1,52 @@
+Feature: delete
+
+  So that I can change my mind
+  As a user
+  I want to remove items from the todolist
+
+  Background:
+    Given a default config exists
+    And a todofile with the following items exists:
+       | todo                               |
+       | (B) Install todotxt @cli +todotxt  |
+       | Drink coffee                       |
+       | x Make coffee                      |
+
+  Scenario: Remove item with confirmation
+    When I run `todotxt del 2` interactively
+    And I type "Y"
+    Then it should pass with:
+      """
+      2. Drink coffee
+      Remove this item? [y/N] => Removed from list
+      """
+    And the file "todo.txt" should not contain "Drink coffee"
+
+  Scenario: Remove several items with confirmation
+    When I run `todotxt del 1 2` interactively
+    And I type "Y"
+    And I type "Y"
+    Then it should pass with:
+       """
+       1. (B) Install todotxt @cli +todotxt
+       Remove this item? [y/N] => Removed from list
+       2. Drink coffee
+       Remove this item? [y/N] => Removed from list
+       """
+    And the file "todo.txt" should not contain "(B) Install todotxt @cli +todotxt"
+    And the file "todo.txt" should not contain "Drink coffee"
+
+  Scenario: Remove item without confirmation
+    When I run `todotxt del 2 -f`
+    Then it should pass with:
+       """
+       2. Drink coffee
+       => Removed from list
+       """
+
+  Scenario: Attempt to delete an illegal item
+    When I run `todotxt del 1337`
+    Then it should pass with:
+      """
+      ERROR: No todo found at line 1337
+      """

data/features/depri.feature

@@ -0,0 +1,38 @@
+Feature: Depri, remove priority
+
+  So that I can make tasks less important
+  As a user
+  I want to remove the priorities
+
+  Background:
+    Given a default config exists
+    And a todofile with the following items exists:
+       | todo                               |
+       | (B) Install todotxt @cli +todotxt  |
+       | Drink coffee                       |
+
+  Scenario: Remove priority of an item
+    When I run `todotxt depri 1`
+    Then it should pass with:
+      """
+      1. Install todotxt @cli +todotxt
+      """
+    And the file "todo.txt" should contain exactly:
+      """
+      Install todotxt @cli +todotxt
+      Drink coffee
+      """
+
+  Scenario: Remove the priority of an unprioritized item
+    When I run `todotxt depri 2`
+    Then it should pass with:
+      """
+      2. Drink coffee
+      """
+
+  Scenario: Remove the priority of an illegal item
+    When I run `todotxt depri 1337`
+    Then it should pass with:
+       """
+       ERROR: No todo found at line 1337
+       """

data/features/do.feature

@@ -0,0 +1,47 @@
+Feature: Do
+
+  So that I can keep track of progress
+  As a user
+  I want to mark items done
+
+  Background:
+    Given a default config exists
+    Given a todofile with the following items exists:
+      | todo                                      |
+      | 2013-01-01 Install todotxt @cli +todotxt  |
+      | Read documentation +todotxt               |
+      | 2012-12-12 Buy GTD book @amazon +wishlist |
+
+  Scenario: Mark item done reports that item and marks checked in the file
+    When I run `todotxt do 1`
+    Then it should pass with:
+      """
+      1. x 2013-01-01 Install todotxt @cli +todotxt
+      """
+    And the file "todo.txt" should contain:
+      """
+      x 2013-01-01 Install todotxt @cli +todotxt
+      """
+
+  Scenario: Mark multiple items done
+    When I run `todotxt do 1 2 3`
+    Then it should pass with:
+      """
+      1. x 2013-01-01 Install todotxt @cli +todotxt
+      2. x Read documentation +todotxt
+      3. x 2012-12-12 Buy GTD book @amazon +wishlist
+      """
+    And the file "todo.txt" should contain:
+      """
+      x 2013-01-01 Install todotxt @cli +todotxt
+      x Read documentation +todotxt
+      x 2012-12-12 Buy GTD book @amazon +wishlist
+      """
+
+  Scenario: Mark an invalid item done
+    When I run `todotxt do 1337`
+    #Then it should fail with: @TODO: should fail, not pass
+    Then it should pass with:
+      """
+      No todo found at line 1337
+      """

data/features/due.feature

@@ -0,0 +1,49 @@
+Feature: Due
+
+  So that I can see what needs to be done
+  As a user
+  I want to get a list of due items
+
+  Background:
+    Given a default config exists
+
+  Scenario: Show todays date
+    Given a todofile exists
+    When I run `todotxt due` interactively
+    Then it should pass with todays date
+
+  Scenario: List due items
+    Given the date is "2012-12-12"
+    And a todofile with the following items exists:
+      | todo                                      |
+      | 2012-12-17 Install todotxt @cli +todotxt  |
+      | Read documentation +todotxt               |
+      | 2012-12-12 Buy GTD book @amazon +wishlist |
+      | 2012-12-19 Evaluate installation +todotxt |
+    When I run `todotxt due` interactively
+    Then it should pass with exactly:
+      """
+      Due today (2012-12-12)
+      3. 2012-12-12 Buy GTD book @amazon +wishlist
+
+      Past-due items
+
+      Due 7 days in advance
+      1. 2012-12-17 Install todotxt @cli +todotxt
+      4. 2012-12-19 Evaluate installation +todotxt
+
+      """
+
+  Scenario: list overdue items
+    Given the date is "2012-12-12"
+    And a todofile with the following items exists:
+      | todo                                      |
+      | 2012-12-17 Install todotxt @cli +todotxt  |
+      | Read documentation +todotxt               |
+      | 2012-11-11 Buy GTD book @amazon +wishlist |
+    When I run `todotxt due` interactively
+    Then it should pass with:
+      """
+      Past-due items
+      3. 2012-11-11 Buy GTD book @amazon +wishlist
+      """

data/features/edit.feature

@@ -0,0 +1,31 @@
+Feature: Edit
+
+  So that I can modify my entire todolist
+  As a user
+  I want to open the todofile in my editor
+
+
+  Background:
+    Given a todofile with the following items exists:
+      | todo                                      |
+      | 2013-01-01 Install todotxt @cli +todotxt  |
+      | Read documentation +todotxt               |
+      | 2012-12-12 Buy GTD book @amazon +wishlist |
+
+  Scenario: Open the file in the systems editor
+    Given the enviromnent variable "EDITOR" is set to "echo"
+    And a default config exists
+    When I run `todotxt edit`
+    Then it should pass with:
+     """
+     todo.txt
+     """
+
+  Scenario: Open the file in the configured editor
+    Given a default config exists with the editor set to "echo"
+    When I run `todotxt edit`
+    Then it should pass with:
+      """
+      todo.txt
+      """
+

data/features/generate_config.feature

@@ -0,0 +1,19 @@
+Feature: Generate config file
+
+  So that I can start using todotxt
+  As a new user
+  I want to create a config file
+
+  Scenario: Generate a config file in an uninitialised environment
+    Given an empty environment
+    When I successfully run `todotxt generate_config`
+    Then a file named ".todotxt.cfg" should exist
+
+  Scenario: Attempt to override an existing config file
+    Given a default config exists
+    When I run `todotxt generate_config` interactively
+    And I type "Y"
+    Then it should pass with regexp:
+      """
+      Overwrite \/([^/]+\/)+.todotxt.cfg\?
+      """

data/features/generate_txt.feature

@@ -0,0 +1,20 @@
+Feature: Generate example todofile
+
+  So that I can start using todotxt
+  As a new user
+  I want to create an example todofile
+
+  Scenario: Generate a config file in an uninitialised environment
+    Given an empty environment
+    When I successfully run `todotxt generate_txt`
+    Then a file named "todo.txt" should exist
+
+  Scenario: Attempt to override an existing config file
+    Given a default config exists
+    And a todofile exists
+    When I run `todotxt generate_txt` interactively
+    And I type "Y"
+    Then it should pass with regexp:
+      """
+      Overwrite \/([^/]+\/)+todo\.txt\?
+      """

data/features/initialize.feature

@@ -0,0 +1,73 @@
+Feature: Initialize
+
+  So that I can start using todotxt
+  As a new user
+  I want to set up example files
+
+  Scenario: Completely clean system asks to create both config and todotxt
+    When I run `todotxt` interactively
+    And I type "yes"
+    And I type "yes"
+    Then it should pass with regexp:
+      """
+      Create \/(.*)\/\.todotxt.cfg\? \[y\/N\]
+      """
+    And it should pass with regexp:
+      """
+      Create \/(.*)\/todo.txt\? \[y\/N\]
+      """
+
+  Scenario: New installation asks and creates a config file
+    When I run `todotxt` interactively
+    And I type "yes"
+    And I type "no"
+    Then it should pass with:
+      """
+      .todotxt.cfg doesn't exist yet. Would you like to generate a sample file?
+      """
+    And a file named ".todotxt.cfg" should exist
+
+  Scenario: New installation does not create a config file when I tell it not to
+    When I run `todotxt` interactively
+    And I type "no"
+    Then a file named ".todotxt.cfg" should not exist
+
+  Scenario Outline: New installation does not ask to create for certain options
+    When I run `todotxt <option>`
+    Then the output should not match:
+      """
+      \[y\/N\] \?
+      """
+
+    Examples:
+       | option          |
+       | help            |
+       | generate_config |
+       | generate_txt    |
+
+  Scenario: New installation asks and creates a dummy todo.txt
+    Given a default config exists
+    When I run `todotxt` interactively
+    And I type "yes"
+    Then it should pass with:
+      """
+      todo.txt doesn't exist yet. Would you like to generate a sample file?
+      """
+    And a file named "todo.txt" should exist
+
+  Scenario: New installation does not create a sample file when I tell it not to
+    Given a default config exists
+    When I run `todotxt` interactively
+    And I type "no"
+    Then a file named "todo.txt" should not exist
+
+  Scenario: Running with an old config-file still works
+    Given an old config exists
+    And a todofile with the following items exists:
+       | todo                  | 
+       | Update my config file | 
+    When I run `todotxt`
+    Then it should pass with:
+      """
+      1. Update my config file
+      """

data/features/list.feature

@@ -0,0 +1,132 @@
+Feature: Listing todos
+
+  So that I can see what I have to do
+  As a the user
+  I want to list and filter my todos.
+
+  Background:
+    Given a default config exists
+    And a todofile exists
+
+  Scenario: List is default action
+    When I run `todotxt`
+    Then I should see all entries from the todofile with numbers
+
+  Scenario: Show all entries
+    When I run `todotxt list`
+    Then I should see all entries from the todofile with numbers
+
+  Scenario: Run with alias ls
+    When I run `todotxt ls`
+    Then I should see all entries from the todofile with numbers
+
+  Scenario: Omits done tasks
+    Given a todofile with done items exists
+    When I run `todotxt list`
+    Then the output should not match:
+      """
+      [\d]\.\s+x
+      """
+  Scenario: List done tasks
+    Given a todofile with done items exists
+    When I run `todotxt list --done`
+    Then I should see all entries from the todofile with numbers
+    When I run `todotxt list -d`
+    Then I should see all entries from the todofile with numbers
+
+  Scenario: Simple output for scripts
+    When I run `todotxt list --simple`
+    Then I should see all entries from the todofile without formatting
+
+  Scenario Outline:
+    Given a todofile with the following items exists:
+       | todo                           |
+       | Install todotxt @cli +todotxt  |
+       | Read documentation +todotxt    |
+       | Buy GTD book @amazon +wishlist |
+    When I run `todotxt list <filter>`
+    Then the output should match /.*<todos>.*/
+    Then it should count <amount> TODO-items
+
+    Examples:
+        | filter            | todos                                 | amount |
+        | @cli              | Install todotxt                       | 1      |
+        | +todotxt          | Install todotxt .* Read documentation | 2      |
+        | book              | Buy GTD book                          | 1      |
+        | install           | Install todotxt                       | 1      |
+        | "Install todotxt" | Install todotxt                       | 1      |
+        | foo-bar           |                                       | 0      |
+        | "buy install"     |                                       | 0      |
+
+  Scenario: List is sorted by priority
+    Given a todofile with the following items exists:
+       | todo                               |
+       | (B) Install todotxt @cli +todotxt  |
+       | Drink coffee                       |
+       | (A) Read documentation +todotxt    |
+       | (C) Buy GTD book @amazon +wishlist |
+    When I run `todotxt list`
+    Then it should pass with:
+      """
+      3. (A) Read documentation +todotxt
+      1. (B) Install todotxt @cli +todotxt
+      4. (C) Buy GTD book @amazon +wishlist
+      2. Drink coffee
+      """
+
+  @todo
+  Scenario: List is sorted by date
+    Given a todofile with the following items exists:
+      | todo                                      |
+      | 2013-01-01 Install todotxt @cli +todotxt  |
+      | Read documentation +todotxt               |
+      | 2012-12-12 Buy GTD book @amazon +wishlist |
+    When I run `todotxt list`
+    Then it should pass with:
+      """
+      3. 2012-12-12 Buy GTD book @amazon +wishlist
+      1. 2013-01-01 Install todotxt @cli +todotxt
+      2. Read documentation +todotxt
+      """
+
+  Scenario: List all done items
+    Given a todofile with the following items exists:
+      | todo                           |
+      | x Buy GTD book @amazon +wishlist |
+      | Install todotxt @cli +todotxt  |
+      | x Read documentation +todotxt    |
+    When I run `todotxt lsdone`
+    Then it should pass with:
+      """
+      1. x Buy GTD book @amazon +wishlist
+      3. x Read documentation +todotxt
+      """
+    Then it should count 2 TODO-items
+    When I run `todotxt lsd`
+    Then it should count 2 TODO-items
+
+  Scenario: List all projects
+    Given a todofile with the following items exists:
+      | todo                           |
+      | Buy GTD book @amazon +wishlist |
+      | Install todotxt @cli +todotxt  |
+      | Read documentation +todotxt    |
+    When I run `todotxt lsproj`
+    Then it should pass with:
+      """
+      +todotxt
+      +wishlist
+      """
+
+  Scenario: List all contexts
+    Given a todofile with the following items exists:
+      | todo                           |
+      | Install todotxt @cli +todotxt  |
+      | Buy GTD book @amazon +wishlist |
+      | Read documentation +todotxt    |
+    When I run `todotxt lscon`
+    Then it should pass with:
+      """
+      @amazon
+      @cli
+      """