pomo 0.0.1 → 0.0.2

data/Readme.md

@@ -3,12 +3,75 @@
 
   Command-line application for the [Pomodoro](http://www.pomodorotechnique.com/) time management technique.
   
-## Features
-
-  * Communicates via Growl 
+## Description
 
+With Pomo you can add, remove, list, view, and start timing tasks all via the 
+command-line with a simple, slick interface. You are reminded of the remaining 
+time on a task via Growl. These notifications appear half-way, at the 5 minute point, 
+and when the task duration has expired. 
+  
 ## Examples
 
+View global or command specific help:
+    $ pomo help
+    $ pomo help add
+    $ pomo help remove
+
+Get started by adding a task:
+    $ pomo add "Fix IE stying issues"
+    
+And another:
+    $ pomo add "Destroy IE" --description "because IE is terrible"
+    
+List your tasks:
+    $ pomo list
+        0. Fix IE stying issues                : 25 minutes
+        1. Destroy IE                          : 25 minutes
+
+Start the first task:
+    $ pomo start
+    Started Fix IE stying issues, you have 25 minutes :)
+    (=........................) 24 minutes remaining
+    
+Once you have completed the task, list again:
+    $ pomo list
+      √ 0. Fix IE stying issues                : 25 minutes
+        1. Destroy IE                          : 25 minutes
+        
+At any time mid-task you may terminate pomo via CTRL + C, at which time
+you may manually complete the task:
+    $ pomo complete first
+    $ pomo complete last
+    $ pomo complete 1
+    $ pomo complete 5
+        
+The next time you run `pomo start` the first incomplete task will start:
+    $ pomo start
+    
+Or choose a specific task:
+    $ pomo start first
+    $ pomo start last
+    $ pomo start 5
+    
+You may also remove tasks
+    $ pomo remove first
+    $ pomo remove last
+    $ pomo remove 2
+    $ pomo remove 1
+    $ pomo remove 6
+    $ pomo rm first
+    $ pomo rm last
+    
+View task details:
+    $ pomo view first
+    $ pomo view last
+    $ pomo view 5
+    $ pomo view 1
+
+Remove all tasks:
+    $ pomo remove all
+    $ pomo rm all
+
 ## License
 
 (The MIT License)

data/bin/pomo

@@ -15,12 +15,17 @@ command :start do |c|
   c.syntax = 'pomo start [number] [options]'
   c.summary = 'Start a task'
   c.description = 'Start a task, given the task [number] or the first task'
+  c.example 'Start the first task', 'pomo start'
+  c.example 'Start the first task', 'pomo start 0'
+  c.example 'Start the first task', 'pomo start first'
+  c.example 'Start the fifth task', 'pomo start 5'
   c.action do |args, options|
-    task = list.tasks.at(args.first ? args.first.to_i : 0)
-    abort 'task already completed' if task.complete?
-    say "Started #{task}, you have #{task.length} minutes :)"
-    task.start
-    list.save
+    if task = list.tasks.at(args.first ? args.first.to_i : 0)
+      abort 'task already completed' if task.complete?
+      say "Started #{task}, you have #{task.length} minutes :)"
+      task.start
+      list.save
+    end
   end
 end
 alias_command :'start first', :start, '0'
@@ -46,6 +51,10 @@ command :remove do |c|
   c.syntax = 'pomo [remove|rm] <number> [options]'
   c.summary = 'Remove a task'
   c.description = 'Remove a task, given the task <number>'
+  c.example 'Remove the first task', 'pomo remove first'
+  c.example 'Remove the last task', 'pomo remove last'
+  c.example 'Remove the fifth task', 'pomo remove 5'
+  c.example 'Remove the fifth task', 'pomo rm 5'
   c.action do |args, options|
    list.tasks.each_with_index do |task, i|
      if i == args.first.to_i
@@ -60,10 +69,24 @@ alias_command :rm, :remove
 alias_command :'remove first', :remove, '0'
 alias_command :'remove last', :remove, list.tasks.length - 1
 
+command :'remove all' do |c|
+  c.syntax = 'pomo remove all'
+  c.description = 'Remove all tasks'
+  c.action do 
+   list.tasks = []
+   list.save
+   say "Tasks removed"
+  end
+end
+alias_command :'rm all', :'remove all'
+
 command :view do |c|
   c.syntax = 'pomo view [number] [options]'
   c.summary = 'View a task'
   c.description = 'View verbose information for the given task [number] or the first task'
+  c.example 'View the first task', 'pomo view first'
+  c.example 'View the last task', 'pomo view last'
+  c.example 'View the fifth task', 'pomo view 5'
   c.action do |args, options|
     if task = list.tasks.at(args.first ? args.first.to_i : 0)
       format = "%15s : %s\n"
@@ -76,9 +99,28 @@ end
 alias_command :'view first', :view, '0'
 alias_command :'view last', :view, list.tasks.length - 1
 
+command :complete do |c|
+  c.syntax = 'pomo complete [number] [options]'
+  c.summary = 'Mark a task as completed'
+  c.description = 'Mark the given task [number] or the first task to complete'
+  c.example 'Mark first task as complete', 'pomo complete first'
+  c.example 'Mark last task as complete', 'pomo complete last'
+  c.example 'Mark fifth task as complete', 'pomo complete 5'
+  c.action do |args, options|
+    if task = list.tasks.at(args.first ? args.first.to_i : 0)
+      task.complete = true
+      list.save
+      say "Completed #{task}"
+    end
+  end
+end
+alias_command :'complete first', :complete, '0'
+alias_command :'complete last', :complete, list.tasks.length - 1
+
 command :list do |c|
   c.syntax = 'pomo list [options]'
   c.description = 'List all tasks'
+  c.example 'List all tasks', 'pomo list'
   c.action do |args, options|
    list.tasks.each_with_index do |task, i|
      say ' %s %2d. %-35s : %d minutes' % [task.complete? ? '√' : ' ', i, task.to_s, task.length]

data/lib/pomo/list.rb

@@ -10,7 +10,7 @@ module Pomo
     ##
     # Task array.
     
-    attr_reader :tasks
+    attr_accessor :tasks
     
     ##
     # Initialize with _path_.

data/lib/pomo/task.rb

@@ -24,6 +24,11 @@ module Pomo
     
     attr_reader :description
     
+    ##
+    # Task completion bool.
+    
+    attr_accessor :complete
+    
     ##
     # Initialize with _name_ and _options_.
     
@@ -38,7 +43,7 @@ module Pomo
     # Check if the task has been completed.
     
     def complete?
-      @complete
+      complete
     end
     
     ##

data/lib/pomo/version.rb

@@ -1,4 +1,4 @@
 
 module Pomo
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/pomo.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{pomo}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["TJ Holowaychuk"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: pomo
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - TJ Holowaychuk