pomo 2.0.2 → 2.1.0

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - ruby-head
+  - 1.9.3
+  - 1.9.2
+  - 1.8.7
+  - ree

data/{HISTORY.md → CHANGELOG.md}

@@ -1,14 +1,36 @@
+CHANGELOG
+=========                                                                                                                                                 
+
+2.1.0 / 2013-01-17                                                                                                                                                 
+==================                                                                                                                                                 
+
+* Added `pomo initconfig` to set up global preferences. Preferences
+  can be overridden on the command-line (e.g. `pomo start --notifier
+  growl`). Closes #30
+* Added multiple args to commands (e.g. `pomo rm 1..3 5..8`). Closes [#12]
+* Added `pomo move` and `pomo copy`. Closes #18
+* Added RSpec specs and Cucumber features. Closes #9
+
+View [the full changelog][2.1.0].
+[2.1.0]: https://github.com/visionmedia/pomo/compare/v2.0.2...v2.1.0
+
 2.0.2 / 2012-12-18
 ==================
 
   * Fixed Growl support. Closes #29
   * Removed unused configuration option `pomo_stat` from `.pomorc`
 
+View [the full changelog][2.0.2].
+[2.0.2]: https://github.com/visionmedia/pomo/compare/v2.0.1...v2.0.2
+
 2.0.1 / 2012-12-16
 ==================
 
   * Minor fix bug release for tmux status bar coloring.
 
+View [the full changelog][2.0.1].
+[2.0.1]: https://github.com/visionmedia/pomo/compare/v2.0.0...v2.0.1
+
 2.0.0 / 2012-12-16
 ==================
 
@@ -20,6 +42,9 @@
   * Added support for importing a single Github issue. Closes #2
   * Added `pomo ls` as an alias to `pomo list`
 
+View [the full changelog][2.0.0].
+[2.0.0]: https://github.com/visionmedia/pomo/compare/1.0.1...v2.0.0
+
 1.0.1 / 2010-03-10
 ==================
 

data/README.md

@@ -15,22 +15,36 @@ status bar.
 ## Installation
 
     $ gem install pomo
-    
+
+## Configuration
+
+Pomo uses `~/.pomorc` for configuration options.
+
+To initialize a default configuration file:
+
+    $ pomo initconfig
+
+See [Configuration Options](#configuration-options) for more details on all the available options.
+
 ## Task Selection API
 
 Taken from `pomo help`:
 
-    Most of the subcommands work directly with tasks,
-    and because of this pomo provides a unified task selection api
-    shown below which can be used with most of the commands 
-    (those with [task ...] in their synopsis). 
-  
+    pomo provides a unified task selection api which can be used
+    with most of the commands. Commands with [task] or [task ...]
+    in their synopsis accept only single or both single and multiple
+    task selection, respectively.
+
+    Single task selection:
     n          : selects a single task by index : Ex: pomo remove 1
-    [n ]+      : selects several tasks by index : Ex: pomo remove 2 8 1
-    n..n       : selects a range of tasks       : Ex: pomo remove 5..9
-    n..-n      : selects a range of tasks       : Ex: pomo remove 2..-1
     first      : selects the first task         : Ex: pomo remove first
     last       : selects the last task          : Ex: pomo remove last
+
+    Multiple task selection:
+    [n ]+      : selects several tasks by index : Ex: pomo remove 2 8 1
+    [n..n]+    : selects a range of tasks       : Ex: pomo remove 5..9 11..14
+    [n..-n]+   : selects a range of tasks       : Ex: pomo remove 2..-1
+    [api ]+    : selects several tasks by api   : Ex: pomo remove first last
     complete   : selects complete tasks         : Ex: pomo remove complete
     incomplete : selects incomplete tasks       : Ex: pomo remove incomplete
     all        : selects all tasks              : Ex: pomo remove all
@@ -67,7 +81,7 @@ Taken from `pomo help`:
 
   * Alternatively, you can start the first incomplete task with a progress bar:
 
-        $ pomo start -p
+        $ pomo start --progress
         Started Fix IE6 stying issues, you have 25 minutes :)
         (=........................) 24 minutes remaining
     
@@ -141,34 +155,35 @@ Taken from `pomo help`:
     auto-detect `./.pomo` in this directory, and utilize its contents.
 
         $ pomo init
-    
-## Configuration
 
-Pomo uses `~/.pomorc` for configuration options.
+## Configuration Options
 
-Configuration options:
+The default configuration for pomo is as follows:
 
-* `:notifier`: Notification library
-    * Format: String
-    * Default: depends on OS
-    * Valid values: `notification_center`, `libnotify`, `growl`, `quicksilver`
-* `:tmux`: Refresh tmux status bar on timer change
-    * Format: Boolean
-    * Default: `false`
-    * Valid values: `true`, `false`
+* Notification library is set to Notification Center on OSX 10.8; Growl on OSX
+10.7 or less and Windows; and libnotify on Linux
+* Progress bar is turned off
+* tmux integration is turned off
 
-For example on Mac OS X Mountain Lion, `~/.pomorc` defaults to:
+Settings are easily customizable. Taken from `pomo help initconfig`:
 
-    ---
-    :notifier: notification_center
-    :tmux: false
+    Examples:
 
-## tmux Status Bar Integration
+    # Configure with notification center, no progress bar, and tmux integration
+    pomo initconfig --notifier notification_center --no-progress --tmux
 
-The Pomo timer can be displayed in tmux's status bar with the following
-configurations set:
+    Options:
+      --notifier <lib>     Specify notificaiton library: `notification_center`, `libnotify`, `growl`, `quicksilver` 
+      --[no-]progress      Run with progress bar 
+      --[no-]tmux          Refresh tmux status bar on timer change 
+      --[no-]force         force overwrite of existing config file 
 
-    :tmux: true
+### Tmux Status Bar Integration
+
+Pomo's timer can be displayed in tmux's status bar with the following
+configuration set:
+
+    pomo initconfig --tmux
 
 Then add the below to your `~/.tmux.conf`:
 
@@ -180,3 +195,15 @@ and blue during a break e.g.
 
 ![tmux status bar](http://i.imgur.com/uIzM3.png)
 
+## Contributing
+
+We :heart: pull requests and feedback. Feel free to
+[submit a ticket](https://github.com/visionmedia/pomo/issues) or see
+[CONTRIBUTING](https://github.com/visionmedia/pomo/blob/master/CONTRIBUTING.md)
+for details on pull requests.
+
+## Copyright
+
+Copyright (c) 2012 TJ Holowaychuk. See
+[LICENSE](https://github.com/visionmedia/pomo/blob/master/LICENSE.md)
+for details.

data/Rakefile

@@ -1,8 +1,15 @@
+require 'cucumber/rake/task'
 require 'rspec/core/rake_task'
 require 'bundler/gem_tasks'
+require 'yard'
 
-desc 'Run specs'
-RSpec::Core::RakeTask.new do |t|
-  t.verbose = false
-  t.rspec_opts = '--color'
-end
+task :default => :test
+
+Cucumber::Rake::Task.new(:cucumber)
+
+RSpec::Core::RakeTask.new(:spec)
+
+YARD::Rake::YardocTask.new(:doc)
+
+desc 'Run tests, both RSpec and Cucumber'
+task :test => [:spec, :cucumber]

data/bin/pomo

@@ -1,43 +1,62 @@
 #!/usr/bin/env ruby
 # coding: utf-8
 
-$:.unshift File.dirname(__FILE__) + '/../lib'
-require 'rubygems'
 require 'commander/import'
 require 'pomo'
 
 program :version, Pomo::VERSION
 
 program :description, "Pomodoro time management.
-    Most of the subcommands work directly with tasks, and
-    because of this pomo provides a unified task selection api
-    shown below which can be used with most of the commands
-    (those with [task ...] in their synopsis).
 
+    pomo provides a unified task selection api which can be used
+    with most of the commands. Commands with [task] or [task ...]
+    in their synopsis accept only single or both single and multiple
+    task selection, respectively.
+
+    Single task selection:
     n          : selects a single task by index : Ex: pomo remove 1
-    [n ]+      : selects several tasks by index : Ex: pomo remove 2 8 1
-    n..n       : selects a range of tasks       : Ex: pomo remove 5..9
-    n..-n      : selects a range of tasks       : Ex: pomo remove 2..-1
     first      : selects the first task         : Ex: pomo remove first
     last       : selects the last task          : Ex: pomo remove last
+
+    Multiple task selection:
+    [n ]+      : selects several tasks by index : Ex: pomo remove 2 8 1
+    [n..n]+    : selects a range of tasks       : Ex: pomo remove 5..9 11..14
+    [n..-n]+   : selects a range of tasks       : Ex: pomo remove 2..-1
+    [api ]+    : selects several tasks by api   : Ex: pomo remove first last
     complete   : selects complete tasks         : Ex: pomo remove complete
     incomplete : selects incomplete tasks       : Ex: pomo remove incomplete
-    all        : selects all tasks              : Ex: pomo remove all
-"
+    all        : selects all tasks              : Ex: pomo remove all"
+
+program :help_formatter, :compact
 
 program :int_message, "\nTerminated pomo" \
                       "\n  * previously running tasks not marked as complete" \
                       "\n  * manually complete a task with `$ pomo complete <task>`"
 
-config = Pomo::Configuration.new
 list = Pomo::List.new
 
 default_command :list
 
+command :initconfig do |c|
+  c.syntax      = 'pomo initconfig [options]'
+  c.description = 'Initialize default configuration'
+  c.example 'Configure with notification center, no progress bar, and tmux integration', 'pomo initconfig --notifier notification_center --no-progress --tmux'
+
+  c.option '--notifier <lib>', String, 'Specify notificaiton library: `notification_center`, `libnotify`, `growl`, `quicksilver`'
+  c.option '--[no-]progress'         , 'Run with progress bar'
+  c.option '--[no-]tmux'             , 'Refresh tmux status bar on timer change'
+  c.option '--[no-]force'            , 'force overwrite of existing config file'
+  c.action do |args, options|
+    Pomo::Configuration.save(options.__hash__)
+  end
+end
+
 command :init do |c|
-  c.syntax = 'pomo init [options]'
+  c.syntax      = 'pomo init [options]'
   c.description = 'Initialize pomo in the current directory'
+
   c.action do |args, options|
+    config = Pomo::Configuration.load
     Pomo::List.new :init => true
     say 'Initialized at `./.pomo`'
     say '  - Any commands run while in this directory will reference this file for tasks'
@@ -46,20 +65,23 @@ command :init do |c|
 end
 
 command :start do |c|
-  c.syntax = 'pomo start [task] [options]'
-  c.summary = 'Start a task'
+  c.syntax      = 'pomo start [task] [options]'
+  c.summary     = 'Start a task'
   c.description = 'Start a task, given the task [task] or the first task'
   c.example 'Start the first incomplete 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.option '-p', '--progress', 'Run with progress bar in foreground'
+  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.option '--notifier <lib>', String, 'Specify notificaiton library: `notification_center`, `libnotify`, `growl`, `quicksilver`'
+  c.option '--[no-]progress'         , 'Run with progress bar'
+  c.option '--[no-]tmux'             , 'Refresh tmux status bar on timer change'
   c.action do |args, options|
     abort 'a task is already running' if list.running
 
-    options.default :progress => false
+    config = Pomo::Configuration.load(options.__hash__)
     args = ['incomplete'] if args.empty?
-    list.find(*args) do |task, i|
+    list.find(*args) do |task|
       abort 'task already completed' if task.complete?
       task.start(config, :progress => options.progress, :list => list)
       break
@@ -68,50 +90,39 @@ command :start do |c|
 end
 
 command :import do |c|
-  c.syntax = 'pomo import <user> <project> [issue_number]'
-  c.summary = 'Import Github project issues'
+  c.syntax      = 'pomo import <user> <project> [issue_number]'
+  c.summary     = 'Import Github issue(s)'
   c.description = 'Import Github project issues which have not yet been closed'
   c.example 'Import all open Github issues from "visionmedia/pomo"', 'pomo import visionmedia pomo'
-  c.example 'Import Github issue #3 from "visionmedia/pomo"', 'pomo import visionmedia pomo 3'
+  c.example 'Import Github issue #3 from "visionmedia/pomo"'       , 'pomo import visionmedia pomo 3'
+
   c.action do |args, options|
+    config = Pomo::Configuration.load
     user = args.shift or raise('Github <user> is required')
     project = args.shift or raise('Github <project> is required')
     number = args.shift
-    begin
-      if number
-        issues = [Octokit.issue({:username => user, :repo => project}, number)]
-      else
-        issues = Octokit.list_issues({:username => user, :repo => project}, :state => 'open', :sort => 'created')
-      end
-      issues.each_with_index do |issue, index|
-        say "Importing issues from https://github.com/#{user}/#{project}" if index == 0
-        task = Pomo::GithubTask.new(issue.title,
-          :username => user,
-          :project => project,
-          :description => issue.body,
-          :labels => issue.labels.map(&:name),
-          :number => issue.number
-        )
-        list << task
-        say "  - Added #{task}"
-      end
-      list.save
-    rescue Octokit::NotFound => e
-      say '404: This is not the repo you are looking for.'
-      say e.message
+
+    say "Importing issues from https://github.com/#{user}/#{project}"
+    tasks = Pomo::GithubTask.import(user, project, number)
+    tasks.each do |task|
+      list << task
+      say "  - Added #{task}"
     end
+    list.save
   end
 end
 
 command :add do |c|
-  c.syntax = 'pomo add <task> [options]'
-  c.summary = 'Add a task'
+  c.syntax      = 'pomo add <task> [options]'
+  c.summary     = 'Add a task'
   c.description = 'Add a task to the current list of tasks'
   c.example 'Adds the task "fix IE styling issues"', 'pomo add "fix IE styling issues"'
-  c.example 'Add a task with 60 minute limit', 'pomo add "create executable" --length 60'
+  c.example 'Add a task with 60 minute limit'      , 'pomo add "create executable" --length 60'
+
   c.option '-d', '--description string', 'Add verbose task description'
   c.option '-l', '--length minutes', Integer, 'Change the default length in minutes'
   c.action do |args, options|
+    config = Pomo::Configuration.load
     task = Pomo::Task.new(args.shift, options.__hash__)
     list << task
     list.save
@@ -120,17 +131,19 @@ command :add do |c|
 end
 
 command :edit do |c|
-  c.syntax = 'pomo edit [task ...] [options]'
-  c.summary = 'Edit tasks'
+  c.syntax      = 'pomo edit [task ...] [options]'
+  c.summary     = 'Edit task(s)'
   c.description = 'Edit the given task(s) or the first task'
-  c.example 'Changes the description for the first task', 'pomo edit first -d "fix IE styling issues"'
+  c.example 'Changes the description for the first task'           , 'pomo edit first -d "fix IE styling issues"'
   c.example 'Changes the description and length for the third task', 'pomo edit 3 -d "fix IE styling issues" -l 60'
-  c.example 'Changes the length of several tasks', 'pomo edit 1..5 -l 10'
+  c.example 'Changes the length of several tasks'                  , 'pomo edit 1..5 -l 10'
+
   c.option '-n', '--name string', 'Change the task name'
   c.option '-d', '--description string', 'Change the task description'
   c.option '-l', '--length minutes', Integer, 'Change the task length'
   c.action do |args, options|
-    list.find(*args) do |task, i|
+    config = Pomo::Configuration.load
+    list.find(*args) do |task|
       options.__hash__.each do |key, value|
         task.send :"#{key}=", value
       end
@@ -141,77 +154,127 @@ command :edit do |c|
 end
 
 command :break do |c|
-  c.syntax = 'pomo break [length] [options]'
-  c.summary = 'Take a break'
+  c.syntax      = 'pomo break [length] [options]'
+  c.summary     = 'Start a break'
   c.description = 'Take a break, defaults to 5 minutes or [length] or --length'
   c.example 'Take a five minute break', 'pomo break'
-  c.example 'Take a 30 minute break', 'pomo break 30'
-  c.example 'Take a 30 minute break', 'pomo break --length 30'
+  c.example 'Take a 30 minute break'  , 'pomo break 30'
+  c.example 'Take a 30 minute break'  , 'pomo break --length 30'
+
   c.option '-l', '--length minutes', Integer, 'Change the default length in minutes'
-  c.option '-p', '--progress', 'Run with progress bar in foreground'
+  c.option '--notifier <lib>', String, 'Specify notificaiton library: `notification_center`, `libnotify`, `growl`, `quicksilver`'
+  c.option '--[no-]progress'         , 'Run with progress bar'
+  c.option '--[no-]tmux'             , 'Refresh tmux status bar on timer change'
   c.action do |args, options|
-    options.default :progress => false
     options.default :length => args.first ? args.first.to_i : 5
+
+    config = Pomo::Configuration.load(options.__hash__)
     task = Pomo::Break.new('Break time', options.__hash__)
     task.start(config, :progress => options.progress)
   end
 end
 
 command :remove do |c|
-  c.syntax = 'pomo [remove|rm] [task ...] [options]'
-  c.summary = 'Remove tasks'
+  c.syntax      = 'pomo [remove|rm] [task ...] [options]'
+  c.summary     = 'Remove task(s)'
   c.description = 'Remove task(s) or the first task'
-  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 first task'           , 'pomo remove first'
+  c.example 'Remove the fifth task'           , 'pomo rm 5'
   c.example 'Remove the fifth and second task', 'pomo rm 5 2'
-  c.example 'Remove a range of tasks', 'pomo rm 2..6'
-  c.example 'Remove all but the first task', 'pomo rm 2..-1'
-  c.example 'Remove all tasks', 'pomo rm all'
+  c.example 'Remove a range of tasks'         , 'pomo rm 2..6'
+  c.example 'Remove all but the first task'   , 'pomo rm 2..-1'
+  c.example 'Remove all tasks'                , 'pomo rm all'
+
   c.action do |args, options|
-    list.find(*args) do |task, i|
+    config = Pomo::Configuration.load
+    list.find(*args) do |task|
       list.tasks -= [task]
       say "  - Removed #{task}"
     end
-   list.save
+    list.save
   end
 end
 alias_command :rm, :remove
 alias_command :clear, :remove, 'all'
 
-command :view do |c|
-  c.syntax = 'pomo view [task ...] [options]'
-  c.summary = 'View verbose task information'
-  c.description = 'View verbose information for the given task(s) 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'
+command :copy do |c|
+  c.syntax      = 'pomo [copy|cp] [task...]'
+  c.summary     = 'Copy task(s)'
+  c.description = 'Copy task(s) to the end of the current list as an incomplete task'
+  c.example 'Copy first task'               , 'pomo copy first'
+  c.example 'Copy the fourth task'          , 'pomo cp 4'
+  c.example 'Copy the fifth and second task', 'pomo cp 5 2'
+  c.example 'Copy a range of tasks'         , 'pomo cp 2..6'
+  c.example 'Copy all but the first task'   , 'pomo cp 2..-1'
+  c.example 'Copy all tasks'                , 'pomo cp all'
+
+  c.action do |args, options|
+    config = Pomo::Configuration.load
+    list.find(*args) do |task|
+      dup_task = Marshal::load(Marshal.dump(task))
+      dup_task.complete = false
+      list.tasks << dup_task
+      say "  - Copied #{task}"
+    end
+    list.save
+  end
+end
+alias_command :cp, :copy
+
+command :move do |c|
+  c.syntax      = 'pomo move [from] [to]'
+  c.summary     = 'Move a task'
+  c.description = 'Move a task to a different position in the current list'
+  c.example 'Move task 4 to position 2'       , 'pomo move 4 2'
+  c.example 'Move last task to first position', 'pomo mv last first'
+
+  c.action do |args, options|
+    config = Pomo::Configuration.load
+    from = args.shift or raise('<from> is required')
+    to = args.shift or raise('<to> is required')
+    list.find(from) do |task|
+      list.find(to) do |other_task|
+        list.move(from, to)
+        say "  - Moved #{task} from position #{from} to #{to}"
+      end
+    end
+    list.save
+  end
+end
+alias_command :mv, :move
+
+# TODO remove view alias in 3.0 release
+command :show do |c|
+  c.syntax      = 'pomo show [task ...] [options]'
+  c.summary     = 'Show verbose task information'
+  c.description = 'Show verbose information for the given task(s) or the first task'
+  c.example 'Show the first task', 'pomo show first'
+  c.example 'Show the last task' , 'pomo show last'
+  c.example 'Show the fifth task', 'pomo show 5'
+
   c.action do |args, options|
-    list.find(*args) do |task, i|
+    config = Pomo::Configuration.load
+    list.find(*args) do |task|
       say "\n"
       format = "%15s : %s\n"
-      say format % ['name', task.name]
-      say format % ['length', "#{task.length} minutes"]
-      say format % ['description', task.description] if task.description and not task.description.empty?
-      if task.github?
-        say format % ['labels', task.labels.join(', ')] if task.labels and not task.labels.empty?
-        say format % ['number', task.number ]
-        say format % ['uri', task.uri ]
-      end
+      task.verbose_output(format)
     end
     say "\n"
   end
 end
+alias_command :view, :show
 
 command :complete do |c|
-  c.syntax = 'pomo complete [task ...] [options]'
-  c.summary = 'Mark tasks as completed'
+  c.syntax      = 'pomo complete [task ...] [options]'
+  c.summary     = 'Mark task(s) as completed'
   c.description = 'Mark the given task(s) 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 last task as complete' , 'pomo complete last'
   c.example 'Mark fifth task as complete', 'pomo complete 5'
+
   c.action do |args, options|
-    list.find(*args) do |task, i|
+    config = Pomo::Configuration.load
+    list.find(*args) do |task|
       task.complete = true
       say "  - Completed #{task}"
     end
@@ -220,14 +283,16 @@ command :complete do |c|
 end
 
 command :incomplete do |c|
-  c.syntax = 'pomo incomplete [task ...] [options]'
-  c.summary = 'Mark tasks as incompleted'
+  c.syntax      = 'pomo incomplete [task ...] [options]'
+  c.summary     = 'Mark task(s) as incompleted'
   c.description = 'Mark the given task(s) or the first task as not completed'
   c.example 'Mark first task as not completed', 'pomo incomplete first'
-  c.example 'Mark last task as not completed', 'pomo incomplete last'
+  c.example 'Mark last task as not completed' , 'pomo incomplete last'
   c.example 'Mark fifth task as not completed', 'pomo incomplete 5'
+
   c.action do |args, options|
-    list.find(*args) do |task, i|
+    config = Pomo::Configuration.load
+    list.find(*args) do |task|
       task.complete = false
       say "  - #{task} marked incomplete"
     end
@@ -236,20 +301,24 @@ command :incomplete do |c|
 end
 
 command :list do |c|
-  c.syntax = 'pomo [list|ls] [options]'
+  c.syntax      = 'pomo [list|ls] [options]'
   c.description = 'List all tasks'
   c.example 'List all tasks', 'pomo list'
+
   c.option '-c', '--complete', 'List only completed tasks'
   c.option '-i', '--incomplete', 'List only incompleted tasks'
   c.action do |args, options|
+    abort "invalid command. See 'pomo help' for more information" unless args.empty?
+
+    config = Pomo::Configuration.load
     total = 0
     list.tasks.each_with_index do |task, i|
       next if options.complete && !task.complete?
       next if options.incomplete && task.complete?
-      say ' %s %2d. %-45s : %d minutes' % [task.complete? ? '✓' : ' ', i, task.to_s, task.length]
+      say ' %s %2d. %-50s : %d minutes' % [task.complete? ? '✓' : ' ', i, task.to_s, task.length]
       total += task.length
     end
-    say ' ' * 55 + '%d minutes' % total
+    say ' ' * 60 + '%d minutes' % total
   end
 end
 alias_command :ls, :list