pomo 1.0.1 → 2.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/DEVELOPMENT

@@ -0,0 +1,15 @@
+To run the development rake tasks, you need bundler installed.
+
+Before you push any changes, run the RSpec suite:
+
+  $ rake spec
+
+To build a new version of the gem:
+
+  $ rake build
+
+To push the new version to Rubygems:
+
+  $ rake release
+
+(http://rubygems.org/gems/pomo)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pomo.gemspec
+gemspec

data/{History.md → HISTORY.md}

@@ -1,3 +1,13 @@
+2.0.0 / 2012-12-16
+==================
+
+  * Added detach mode, on by default. To get the 1.x progress bar run `pomo start -p`. Closes #1
+  * Added notification support for Mac OS X User Notifications, Quicksilver and libnotify.
+    Growl continues to be supported. Closes #23
+  * Added optional tmux status bar support to display Pomo timer.
+  * Fixed import of Github issues list. Closes #11
+  * Added support for importing a single Github issue. Closes #2
+  * Added `pomo ls` as an alias to `pomo list`
 
 1.0.1 / 2010-03-10
 ==================
@@ -72,4 +82,4 @@
 0.0.1 / 2009-10-15
 ==================
 
-  * Initial release
+  * Initial release

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 TJ Holowaychuk <tj@vision-media.ca>
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,186 @@
+# Pomo
+
+Command-line application for the [Pomodoro](http://www.pomodorotechnique.com/)
+time management technique, with notification and tmux status bar support.
+
+## 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 Notification Center, Growl, libnotify, or Quicksilver.
+These notifications appear half-way, at the 5 minute point, and when the task
+duration has expired. Also, the Pomo timer can be displayed in your tmux
+status bar.
+
+## Installation
+
+    $ gem install pomo
+    
+## 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). 
+  
+    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
+    complete   : selects complete tasks         : Ex: pomo remove complete
+    incomplete : selects incomplete tasks       : Ex: pomo remove incomplete
+    all        : selects all tasks              : Ex: pomo remove all
+
+## 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 (or use `pomo` which defaults to `pomo list`):
+
+        $ pomo list
+            0. Fix IE stying issues                : 25 minutes
+            1. Destroy IE                          : 25 minutes
+
+  * Start the first incomplete task:
+
+        $ pomo start
+        Started Fix IE stying issues, you have 25 minutes :)
+
+  * Alternatively, you can start the first incomplete task with a progress bar:
+
+        $ pomo start -p
+        Started Fix IE stying issues, you have 25 minutes :)
+        (=........................) 24 minutes remaining
+    
+  * Once you have completed the task, list again (alternatively `pomo ls`):
+
+        $ pomo ls
+          ✓ 0. Fix IE stying issues                : 25 minutes
+            1. Destroy IE                          : 25 minutes
+        
+  * Or take a break:
+
+        $ pomo break
+        $ pomo break 10
+        $ pomo break --length 10
+        
+  * List only remaining tasks:
+
+        $ pomo ls --incomplete
+            1. Destroy IE                          : 25 minutes
+        
+  * List only completed tasks:
+
+        $ pomo ls --complete
+          ✓ 0. Fix IE stying issues                : 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 all
+        $ pomo complete incomplete
+        $ pomo complete 5..7
+
+  * 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 2..5
+        $ pomo rm 1..-1
+    
+  * View task details:
+
+        $ pomo view first
+        $ pomo view last
+        $ pomo view 5
+        $ pomo view 1 2 3
+
+  * Remove all tasks:
+
+        $ pomo remove all
+        $ pomo rm all
+
+  * Or if you prefer, create a directory specific task list. Pomo will
+    auto-detect `./.pomo` in this directory, and utilize its contents.
+
+        $ pomo init
+    
+## Configuration
+
+Pomo uses `~/.pomorc` for configuration options.
+
+Configuration options:
+
+* `: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`
+
+For example on Mac OS X Mountain Lion, `~/.pomorc` defaults to:
+
+    ---
+    :notifier: notification_center
+    :tmux: false
+
+## tmux Status Bar Integration
+
+The Pomo timer can be displayed in tmux's status bar with the following
+configurations set:
+
+    :tmux: true
+
+Then add the below to your `~/.tmux.conf`:
+
+    set-option -g status-right '#(cat ~/.pomo_stat)'
+
+The timer will display with the default color when not active,
+green during a Pomodoro, red during the last 5 minutes of a Pomodoro,
+and blue during a break e.g.
+
+![tmux status bar](http://i.imgur.com/uIzM3.png)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -1,17 +1,8 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
 
-$:.unshift 'lib'
-require 'pomo'
-require 'rubygems'
-require 'rake'
-require 'echoe'
-
-Echoe.new "pomo", Pomo::VERSION do |p|
-  p.author = "TJ Holowaychuk"
-  p.email = "tj@vision-media.ca"
-  p.summary = "Pomodoro time management for the command-line"
-  p.url = "http://github.com/visionmedia/pomo"
-  p.runtime_dependencies << 'commander >=4.0.2'
-  p.runtime_dependencies << 'growl >=1.0.3'
+desc 'Run specs'
+RSpec::Core::RakeTask.new do |t|
+  t.verbose = false
+  t.rspec_opts = '--color'
 end
-
-Dir['tasks/**/*.rake'].sort.each { |f| load f }

data/bin/pomo

@@ -1,18 +1,19 @@
 #!/usr/bin/env ruby
 # coding: utf-8
 
-$:.unshift File.dirname(__FILE__) + '/../lib' 
+$:.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 
+    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). 
-    
+    shown below which can be used with most of the commands
+    (those with [task ...] in their synopsis).
+
     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
@@ -28,7 +29,8 @@ program :int_message, "\nTerminated pomo" \
                       "\n  * previously running tasks not marked as complete" \
                       "\n  * manually complete a task with `$ pomo complete <task>`"
 
-list = Pomo::List.new File.exists?('.pomo') ? '.pomo' : '~/.pomo'
+config = Pomo::Configuration.new
+list = Pomo::List.new
 
 default_command :list
 
@@ -36,11 +38,11 @@ command :init do |c|
   c.syntax = 'pomo init [options]'
   c.description = 'Initialize pomo in the current directory'
   c.action do |args, options|
-    Pomo::List.new '.pomo'
-    say "Initialized at `./.pomo`"
-    say "  - Any commands run while in this directory will reference this file for tasks"
-    say "  - To remove simply execute `rm .pomo`"
-  end  
+    Pomo::List.new :init => true
+    say 'Initialized at `./.pomo`'
+    say '  - Any commands run while in this directory will reference this file for tasks'
+    say '  - To remove simply execute `rm .pomo`'
+  end
 end
 
 command :start do |c|
@@ -51,44 +53,56 @@ command :start do |c|
   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.action do |args, options|
+    abort 'a task is already running' if list.running
+
+    options.default :progress => false
     args = ['incomplete'] if args.empty?
     list.find(*args) do |task, i|
       abort 'task already completed' if task.complete?
-      say "Started #{task}, you have #{task.length} minutes :)"
-      task.start
-      list.save
+      task.start(config, :progress => options.progress, :list => list)
       break
     end
   end
 end
 
 command :import do |c|
-  c.syntax = 'pomo import <user> <project> [options]'
+  c.syntax = 'pomo import <user> <project> [issue_number]'
   c.summary = 'Import Github project issues'
   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.action do |args, options|
-    gem 'octopi', '>=0.2.1'
-    require 'octopi'
     user = args.shift or raise('Github <user> is required')
     project = args.shift or raise('Github <project> is required')
-    if repo = Octopi::Repository.find(:user => user, :name => project)
-      say "Importing items from http://github.com/#{user}/#{project}"
-      repo.issues.select { |i| not i.closed_at }.each do |issue|
-        task = Pomo::GithubTask.new issue.title, 
+    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,
+          :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
     end
   end
 end
- 
+
 command :add do |c|
   c.syntax = 'pomo add <task> [options]'
   c.summary = 'Add a task'
@@ -134,10 +148,12 @@ command :break do |c|
   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.action do |args, options|
+    options.default :progress => false
     options.default :length => args.first ? args.first.to_i : 5
-    task = Pomo::Task.new('Break time', options.__hash__)
-    task.start
+    task = Pomo::Break.new('Break time', options.__hash__)
+    task.start(config, :progress => options.progress)
   end
 end
 
@@ -220,7 +236,7 @@ command :incomplete do |c|
 end
 
 command :list do |c|
-  c.syntax = 'pomo list [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'
@@ -236,4 +252,5 @@ command :list do |c|
     say ' ' * 55 + '%d minutes' % total
   end
 end
+alias_command :ls, :list
 

data/lib/pomo.rb

@@ -1,29 +1,15 @@
-#--
-# Copyright (c) 2009 TJ Holowaychuk <tj@vision-media.ca>
-#
-# Permission is hereby granted, free of charge, to any person obtaining
-# a copy of this software and associated documentation files (the
-# "Software"), to deal in the Software without restriction, including
-# without limitation the rights to use, copy, modify, merge, publish,
-# distribute, sublicense, and/or sell copies of the Software, and to
-# permit persons to whom the Software is furnished to do so, subject to
-# the following conditions:
-#
-# The above copyright notice and this permission notice shall be
-# included in all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-#++
-
 require 'yaml'
-require 'growl'
+require 'octokit'
+require 'terminal-notifier' if /darwin/ =~ RUBY_PLATFORM
+require 'growl'             if /darwin/ =~ RUBY_PLATFORM
+require 'libnotify'         if /linux/ =~ RUBY_PLATFORM
+require 'pomo/configuration'
+require 'pomo/notifier'
+require 'pomo/notifier/notification_center'
+require 'pomo/notifier/growl'
+require 'pomo/notifier/libnotify'
 require 'pomo/list'
 require 'pomo/task'
 require 'pomo/github_task'
-require 'pomo/version'
+require 'pomo/break'
+require 'pomo/version'