dooby 0.2.0 → 0.3.0

data/.rspec

@@ -0,0 +1,2 @@
+--format doc
+--color

data/CHANGELOG.md

@@ -0,0 +1,38 @@
+CHANGELOG
+=========
+
+Version 0.3.0 (November 06, 2010)
+--------------------------------
+
+* use as git commit message the item marked as :doing wth **$ dooby commit**
+* fix autocompletion of strings starting with an at sign (@)
+* due dates handled through curly braces containing a date in this format: {mmm/dd/yyyy}, ie. {May/02/2011}
+* **#tomorrow** tag is replaced by tomorrow's date, ie. {Nov/04/2010} and then replaced by #today at the next day.
+* show items containing the tomorrow's date if user issues **$ dooby list #tomorrow** or **tomorrow**
+* fix error when autocompletion isn't set
+* add autocompletion to **ilist** (interactive)
+* colorize strings starting with a colon (statuses)
+
+---
+
+Version 0.2.0 (October 28, 2010)
+----------------------------
+
+* add sections for items marked as **#today** and **#urgent**
+* add messages when user executes dooby without arguments and list is empty
+* add **bulk delete** (interactive and completion)  
+    $ dooby bulkdelete  
+* add **shortcuts** to list tags  
+    $ dooby l@  
+    $ dooby l#  
+    $ dooby l%  
+
+---
+
+Version 0.1.0 (October 27, 2010)
+--------------------------------
+
+* add, edit, list, interactive list, delete, trash and flush
+* colorize strings starting with @, # and %
+
+* Initial release

data/Gemfile

@@ -1,5 +1,15 @@
 source "http://rubygems.org"
 
-gem "main", "4.2.0"
-gem "colored", "1.2"
-gem "highline", "1.6.1"
+group :development do
+  gem "rspec", "~> 2.0.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.0.pre5"
+  gem "rcov", ">= 0"
+end
+
+group :production do
+	gem "main", "4.2.0"
+	gem "colored", "1.2"
+	gem "highline", "1.6.1"
+	gem "chronic", "0.3.0"
+end

data/Gemfile.lock

@@ -2,17 +2,41 @@ GEM
   remote: http://rubygems.org/
   specs:
     arrayfields (4.7.4)
+    chronic (0.3.0)
     colored (1.2)
+    diff-lcs (1.1.2)
     fattr (2.1.0)
+    git (1.2.5)
     highline (1.6.1)
+    jeweler (1.5.0.pre5)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
     main (4.2.0)
       arrayfields (>= 4.7.4)
       fattr (>= 2.1.0)
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+      rspec-mocks (~> 2.0.1)
+    rspec-core (2.0.1)
+    rspec-expectations (2.0.1)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  bundler (~> 1.0.0)
+  chronic (= 0.3.0)
   colored (= 1.2)
   highline (= 1.6.1)
+  jeweler (~> 1.5.0.pre5)
   main (= 4.2.0)
+  rcov
+  rspec (~> 2.0.0)

data/README.md

@@ -3,33 +3,23 @@ dooby
 
 A **very simplistic** command-line to-do/note list manager in Ruby.
 
-WARNING!!!
--------
-
-You should know this gem lacks of fancy things, meaning: social, cloud, mobile, web interface, etc.
-
 Why another to-do list manager?
 ----
 
-I spend a lot of time in the terminal and I didn't really like any of the current options.
+I spend a lot of time in the terminal and I haven't liked any of the current options.
 
 How does Dooby works?
 ---------------------
 
 ### A bunch of lists
-Dooby is directory-based, so you can maintain different to-do/notes lists in every directory you want.
-
-For instance, I use one to-do list per project, that way I don't have all the tasks in one place so I can get focused in just one set of tasks, in one context.
-
-### Priorities
-Dooby doesn't like to handle priorities, that's your concern. The main goal of Dooby is to help me to handle my today/tomorrow tasks and to handle my personal notes.
+Dooby can handle one list per directory.
 
-### Due dates
-Due dates for today/tomorrow tasks? well, maybe later.
+For instance, I use one to-do list per project, that way I don't have all the items in one place so I can get focused in just one set of items, in one context.
 
-### #tag #tag and #tag again and tell @jim to #tag everything in his %life as well
+### A bunch of tags
+#### #tag #tag and #tag again and tell @jim :now to #tag everything in his %life as well
 
-Dooby uses some special characters to visually help us to differentiate between things and let us search tasks very easily, the ones that you might recognize are **@** and **#**, I stole the idea from Twitter, but of course they don't behave as in Twitter, the **@** sign is not an username but a character to simply tag a person, that's all, nothing else (so far).
+Dooby uses some special characters to visually help us to differentiate between things and let us search items very easily, the ones that you might recognize are **@** and **#**, I stole the idea from Twitter, but of course they don't behave as in Twitter, the **@** sign is not an username but a character to tag a person, that's all, nothing else (so far).
 
 People
 
@@ -43,64 +33,88 @@ Contexts (states of mind, mood, places, etc)
 	
 	#thinking, #sad
 
-Projects
+Item sets (for objectives that takes more than one task to achieve)
 
-	%website, %shoppinglist, %whatever
-
-Most of these characters are meaningless to Dooby, she (yes, she's a woman) isn't aware of them, Dooby is aware only of some of them:
+	%fix_computer, %shopping_list, %subproject, %today
+	
+As you can see we can use % as if it were #, I mean, as a context, this is because most of these tags are meaningless to Dooby, she (yes, she's a woman) isn't aware of them, Dooby is aware only of some of them:
 
 	#today
 	#urgent
 	#tomorrow
+	:doing
 
-All the tasks tagged with *#today* and *#urgent* will be shown in a special section every time you list your to-dos/notes.
+#### #today and #urgent (**not %today, not %urgent**)
+All the items tagged with *#today* and *#urgent* will be shown in a special section every time you list your to-dos/notes.
 
-All the tasks tagged with *#tomorrow* will be marked with the tag *#today* at the next day.
+#### #tomorrow
+It will be converted into tomorrow's date and marked with the tag *#today* at the next day.
+Say today is November, 2 2010, and you create an item like this:
 
-Usage
------
+    I need to #fix the #bug #tomorrow
+
+Dooby will save it as
+
+    I need to #fix the #bug {Nov/03/2010}
+
+Now say today is November, 3 2010, Dooby will show it like this:
+
+    I need to #fix the #bug #today
+
+Of course it'd be shown in the TODAY section.
+
+#### :doing
+`xThe item tagged as **:doing** will be the *current item* and some commands will affect it or use it for specifying an item id.
 
-###Creating an alias
+Basic Usage
+-----------
+
+NOTE: All the commands have a shortcut, which is the first or two first letters of it.
+
+First of all, create an alias if you want to save some keystrokes:
 
 	$ alias d='dooby'
 
 ### Initializing Dooby
 
 	$ d init
+	$ d i
 
-This creates a **.dooby/list.yml** file in the current directory. Dooby will save all the tasks on it.
+This creates a **.dooby/list.yml** file in the current directory. Dooby will save all the items in it.
 
 ### Adding items
 
-	$ d add "#fix the email error in %website, talk to @peter #today"
+	$ d add "#fix the email error in %website, check this out with @peter #today"
 	
 	$ d a "learn to use the #aliases of the #commands"
+	
+	$ d a "#pair with @jim on the %tickets module"
 
 ### Listing items
 
+Try the following commands once you create the items above:
+
 	$ d list @peter
 
 	$ d l today
 	
-	$ d l \#today
-	
 	$ d l "#today"
 	
 	$ d l %website
 	
 	$ d l @
-	 > shows tasks related to people
 
 	$ d l %
-	 > shows all the tasks with a related project
 	
-#### Listing items interactively 
+#### Listing items interactively (use q or ctrl-c to interrupt)
 	
+You can use the [TAB] key to autocomplete tags
+
 	$ d il
 	
-	> #today
+	> #t[TAB]oday
 	Showing items containing: #today
-	 (b954bf)  #fix the email error in %website, talk to @peter #today
+	 (393415)  #fix the email error in %website, check this out with @peter #today
 	 (9cfbf4)  Need to go to the #doctor @hendrix #today
 	
 	> #doctor
@@ -109,9 +123,9 @@ This creates a **.dooby/list.yml** file in the current directory. Dooby will sav
 	
 	> email
 	Showing items containing: email
-	(b954bf)  #fix the email error in %website, talk to @peter #today
+	(393415)  #fix the email error in %website, check this out with @peter #today
 
-**Note:** Dooby uses SHA1 as Task ID.
+**Note:** Dooby uses SHA1 as Item ID.
 
 #### Listing all the hashtags you have used
 
@@ -119,120 +133,106 @@ This creates a **.dooby/list.yml** file in the current directory. Dooby will sav
 	#today
 	#doctor
 	#fix
+	#pair
 	
 #### Listing all the people you have tagged
 	
 	$ d l@
 	@peter
 	@hendrix
+	@jim
 
-#### Listing all the projects you have tagged
+#### Listing all the item sets
 
 	$ d l%
 	%website
+	%tickets
 
-### Editing items
-
-**Dooby** supports autocompletion of task IDs in the *delete* and the *edit* commands, to fire it just do the same as in a bash shell, press TAB TAB.
-
-	$ d edit
-	
-or
-	
-	$ d e
-	Task ID > TAB TAB
-	b954bf 9cfbf4 (we only have 2 tasks)
-
-	$ d e
-	Task ID > b TAB
+### Editing items (use q or ctrl-c to interrupt)
 
-and you'll see that the task id have been auto-completed
+**Dooby** supports autocompletion of item IDs in the *delete*, *bulkdelete* and the *edit* commands as well.
 
-	$ d e
-	Task ID > b954bf
+	$ d edit	
+	Item ID > b[TAB]954bf
 
-now press Enter and TAB TAB again if you want the original text of the item:
+now press Enter and [TAB] again if you want the original text of the item:
 
 	$ d e
-	Task ID > b954bf
-	TAB or up arrow to edit > TAB
+	Item ID > b954bf
+	TAB or up arrow to edit > [TAB]#fix the email error in %website, check this out with @peter #today
 
-	$ d e
-	Task ID > b954bf
-	TAB or up arrow to edit > #fix the email error in %website, talk to @peter #today
+Edit it and press Enter and the item will be saved.
 
 	$ d e
-	Task ID > b954bf
+	Item ID > b954bf
 	TAB or up arrow to edit > #fix the email error in %website #today
 	
-Edit it and press Enter and the task will be saved.
-
-### Deleting items
+### Deleting items (use q or ctrl-c to interrupt)
 
 	$ d delete
+	Item ID > 5[TAB]21a3d
 	
-or
-	
-	$ d d
-	Task ID > TAB TAB
-	521a3d 9cfbf4
-	
-**Note:** the *SHA1* of the task we edited previously has changed because it's based on the content
+**Note:** the *SHA1* of the item we edited previously has changed because it's based on the content
 
 	$ d d
-	Task ID > 9cfbf4
+	Item ID > 9cfbf4
 	9cfbf4 deleted...
 
-**Dooby** won't ask you if you really want to delete the task.
+**Dooby** won't ask you if you really really want to delete the item.
 
 	$ d l
 	Showing all items...
-	 (521a3d)  #fix the email error in %website #today
+	 (c733ff)  #fix the email error in %website #today
 
 ### Bulk delete
 
-If you want to delete all the tasks containing a tag or set of tags this is what bulk delete is useful for. This feature will delete only by tag, not simple text, actually if you enter simple text it will simply ignore it.
+If you want to delete all the items containing an exact tag or set of tags or a tag starting with some text you can use bulk delete to do so. This feature will delete only by tag, not simple text, actually if you enter simple text it will simply ignore it.
 
-Bulk delete supports auto-completion too. Say you want to delete all the tasks containing @hendrix AND #today.
+Bulk delete supports auto-completion too. Say you want to delete all the items containing @hendrix AND #today.
 
 	$ d bulkdelete
+	What do you want to bulk delete?
+	> #t[TAB]oday @h[TAB]endrix
 
-or
-	
-	$ d b
-	What do you want to bulk delete? (@, #, % allowed)
-	_ #TAB TAB
-	#today #doctor
+What if you want to delete all the items containing a tag starting with **#ma** like *#mac*, *#manual*, and *#macro*?, simple:
 
 	$ d b
-	What do you want to bulk delete? (@, #, % allowed)
-	#today @hendrix
+	What do you want to bulk delete?
+	> #ma [ENTER]
 
 That's it
 
 ### Deleting all the items
 	
 	$ d flush
-	
-or
-
-	$ d f
 	Sure??? (yes/no)
 	yes
-	All the task were deleted!
+	All the items were deleted!
 
-### Deleting the **.dooby** directory and all the tasks
+### Deleting the **.dooby** directory (list.yml included, of course)
 
 	$ d trash
-
-or
-
-	$ d t
 	Sure??? (yes/no)
 	yes
 	No more dooby here T_T
 	
-### Help
+## The current item (item tagged with **:doing**)
+
+### Use an item as commit message (git)
+
+Let's say we add a task we need to get done:
+
+    $ d a "#fix the bug in cart :doing"
+
+and that once we get the task done we want to commit the fix:
+
+	$ git add the_file
+	
+	$ d commit
+	The commit message was #fix the bug in cart
+
+	
+## Help
 
 You can check the help out using the -h flag
 
@@ -248,7 +248,7 @@ You can check the help out using the -h flag
 	  dooby list [what_to_show*] [options]+
 
 	DESCRIPTION
-	  Lists @people, #tags, %projects or tasks (default)
+	  Lists @people, #tags, %projects or items (default)
 
 	PARAMETERS
 	  what_to_show (-1 ~> what_to_show) 
@@ -257,7 +257,18 @@ You can check the help out using the -h flag
 Known bugs
 ----------
 
-* Auto-completion doesn't work with at signs (@)
+* In Windows the text is shown with the color codes even installing the *win32console* gem
+
+To Do
+-----
+
+* refactor List#find method, it must return a hash of items not the strings to show in terminal
+* **$ dooby done** should tag the current item as *:done*
+* Make it configurable through an external file
+* Get rid of special chars (@, #, %) when item is used as git commit message
+* if item is tagged as *:doing* check if there are others tagged with the same tag, if so, tag them with *:hold*
+* Hide items tagged as *:hidden*
+* Only show items not containing the specified word(s)
 
 Special Thanks
 --------------
@@ -270,7 +281,6 @@ Most of the the ideas to code **dooby** were based on the work of other programm
 
 Thanks all of you!
 
-
 Note on Patches/Pull Requests
 -----------------------------
  
@@ -285,4 +295,4 @@ Note on Patches/Pull Requests
 Copyright
 ---------
 
-Copyright (c) 2010 Rafael Magana. See LICENSE for details.
+Copyright (c) 2010 Rafael Magana. See LICENSE for details.