pomo 2.0.2 → 2.1.0

data/features/configuration.feature

@@ -0,0 +1,35 @@
+Feature: Configure pomo
+  In order to use pomo
+  As a user
+  I want a sane default configuration for my system
+  and a data file to store my tasks
+
+  Scenario: Execute pomo without configuration
+    When I run `pomo`
+    Then the following files should exist:
+      | /tmp/home/.pomorc |
+      | /tmp/home/.pomo   |
+    And the output should contain "Initialized default config file in /tmp/home/.pomorc. See 'pomo help initconfig' for options."
+
+  Scenario: Initialize configuration
+    When I run `pomo initconfig`
+    Then the following files should exist:
+      | /tmp/home/.pomorc |
+      | /tmp/home/.pomo   |
+    And the output should contain "Initialized config file"
+
+  Scenario: Initialize configuration (no clobber)
+    Given a file named "/tmp/home/.pomorc" with:
+      """
+      hello world
+      """
+    When I run `pomo initconfig`
+    Then the output should contain "Not overwriting existing config file"
+
+  Scenario: Force initialize configuration (clobber)
+    Given a file named "/tmp/home/.pomorc" with:
+      """
+      hello world
+      """
+    When I run `pomo initconfig --force`
+    Then the file "/tmp/home/.pomorc" should not contain "hello world"

data/features/manage_list.feature

@@ -0,0 +1,34 @@
+Feature: Manage Pomodoro list
+  In order to complete tasks
+  As a user
+  I want to manage the order and content of my task list
+
+  Scenario: Add tasks
+    When I run `pomo add 'Remember the milk'`
+    And I run `pomo list`
+    Then the output from "pomo list" should contain "Remember the milk"
+
+  Scenario: Remove tasks
+    Given the following tasks:
+      | Remember the milk |
+      | Walk the dog      |
+      | Shave the yak     |
+    When I run `pomo rm first`
+    And I run `pomo list`
+    Then the output from "pomo list" should not contain "Remember the milk"
+
+  Scenario: Move tasks
+    Given the following tasks:
+      | Remember the milk |
+      | Walk the dog      |
+      | Shave the yak     |
+    When I run `pomo mv first last`
+    And I run `pomo list`
+    Then the output from "pomo list" should contain exactly:
+    """
+        0. Walk the dog                                       : 25 minutes
+        1. Shave the yak                                      : 25 minutes
+        2. Remember the milk                                  : 25 minutes
+                                                                75 minutes
+
+    """

data/features/manage_tasks.feature

@@ -0,0 +1,73 @@
+Feature: Manage Pomodoro task
+  In order to track tasks
+  As a user
+  I want to manage the metadata and status of my tasks
+
+  Scenario: Edit tasks
+    When I run `pomo add 'Remember the milk' -d '1 qt Almond milk' -l 60`
+    And I run `pomo edit first -n 'Remember the Almond milk' -d '1 qt' -l 30`
+    And I run `pomo show first`
+    Then the output from "pomo show first" should contain exactly:
+    """
+
+               name : Remember the Almond milk
+             length : 30 minutes
+        description : 1 qt
+           complete : [ ]
+
+
+    """
+
+  Scenario: Copy tasks
+    When I run `pomo add 'Remember the milk'`
+    And I run `pomo complete first`
+    And I run `pomo show first`
+    Then the output from "pomo show first" should contain exactly:
+    """
+
+               name : Remember the milk
+             length : 25 minutes
+           complete : [✓]
+
+
+    """
+    When I run `pomo copy first`
+    And I run `pomo show last`
+    Then the output from "pomo show last" should contain exactly:
+    """
+
+               name : Remember the milk
+             length : 25 minutes
+           complete : [ ]
+
+
+    """
+
+  Scenario: Complete tasks
+    When I run `pomo add 'Remember the milk'`
+    And I run `pomo complete first`
+    And I run `pomo show first`
+    Then the output from "pomo show first" should contain exactly:
+    """
+
+               name : Remember the milk
+             length : 25 minutes
+           complete : [✓]
+
+
+    """
+
+  Scenario: Incomplete tasks
+    When I run `pomo add 'Remember the milk'`
+    And I run `pomo complete first`
+    And I run `pomo incomplete first`
+    And I run `pomo show first`
+    Then the output from "pomo show first" should contain exactly:
+    """
+
+               name : Remember the milk
+             length : 25 minutes
+           complete : [ ]
+
+
+    """

data/features/step_definitions/pomo_steps.rb

@@ -0,0 +1,8 @@
+Given /^the following tasks:$/ do |table|
+  data = table.raw
+  table.raw.each do |task|
+    steps %Q{
+      When I run `pomo add '#{task.first}'`
+    }
+  end
+end

data/features/support/env.rb

@@ -0,0 +1,12 @@
+require "aruba/cucumber"
+
+Before do
+  set_env('POMO_ENV', 'test')
+  set_env('HOME', '/tmp/home')
+  FileUtils.rm_rf '/tmp/home'
+  FileUtils.mkdir '/tmp/home'
+end
+
+After do
+  restore_env
+end

data/lib/pomo.rb

@@ -1,15 +1,6 @@
-require 'rbconfig'
 require 'pomo/os'
-require 'terminal-notifier' if Pomo::OS.mac?
-require 'growl'             if Pomo::OS.mac? || Pomo::OS.windows?
-require 'libnotify'         if Pomo::OS.linux?
-require 'yaml'
-require 'octokit'
 require 'pomo/configuration'
 require 'pomo/notifier'
-require 'pomo/notifier/notification_center_notifier'
-require 'pomo/notifier/growl_notifier'
-require 'pomo/notifier/libnotify_notifier'
 require 'pomo/list'
 require 'pomo/task'
 require 'pomo/github_task'

data/lib/pomo/configuration.rb

@@ -1,3 +1,7 @@
+require 'yaml'
+require 'commander'
+include Commander::UI
+
 module Pomo
   class Configuration
     ##
@@ -7,6 +11,13 @@ module Pomo
 
     attr_reader :notifier
 
+    ##
+    # Run with progress bar.
+    #
+    # values: true | false
+
+    attr_accessor :progress
+
     ##
     # Refresh tmux status bar.
     #
@@ -16,29 +27,60 @@ module Pomo
 
     ##
     # Initialize configuration.
-    def initialize
-      options = {
-        :notifier  => default_notifier,
-        :tmux      => false
-      }
 
-      config_file = File.join(ENV['HOME'],'.pomorc')
+    def initialize(options = {})
+      @notifier = options[:notifier]
+      @progress = options[:progress]
+      @tmux     = options[:tmux]
+    end
 
-      if File.exists? config_file
-        config_options = YAML.load_file(config_file)
-        options.merge!(config_options)
-      else
+    ##
+    # Load configuration file or default_options. Passed options take precedence.
+
+    def self.load(options = {})
+      options.reject!{|k,v| ![:notifier, :progress, :tmux].include? k}
+
+      if !(File.exists? config_file)
+        File.open(config_file, 'w') { |file| YAML::dump(default_options, file) }
+        say "Initialized default config file in #{config_file}. See 'pomo help initconfig' for options."
+      end
+
+      config_file_options = YAML.load_file(config_file)
+      new(config_file_options.merge(options))
+    end
+
+    ##
+    # Save configuration. Passed options take precendence over default_options.
+
+    def self.save(options = {})
+      force_save = options.delete :force
+      options.reject!{|k,v| ![:notifier, :progress, :tmux].include? k}
+
+      options = default_options.merge(options)
+
+      if !(File.exists? config_file) || force_save
         File.open(config_file, 'w') { |file| YAML::dump(options, file) }
-        STDERR.puts "Initialized configuration file in #{config_file}"
+        say "Initialized config file in #{config_file}"
+      else
+        say_error "Not overwriting existing config file #{config_file}, use --force to override. See 'pomo help initconfig'."
       end
+    end
 
-      @notifier  = options[:notifier]
-      @tmux      = options[:tmux]
+    # Helpers
+
+    def self.config_file
+      File.join(ENV['HOME'],'.pomorc')
     end
 
-    private
+    def self.default_options
+      {
+        :notifier => default_notifier,
+        :progress => false,
+        :tmux     => false
+      }
+    end
 
-    def default_notifier
+    def self.default_notifier
       if Pomo::OS.has_notification_center?
         return 'notification_center'
       elsif Pomo::OS.linux?

data/lib/pomo/github_task.rb

@@ -1,11 +1,13 @@
+# This is to make sure Faraday doesn't warn the user about the `system_timer` gem missing in Ruby 1.8
+old_warn, $-w = $-w, nil
+begin
+  require 'faraday'
+ensure
+  $-w = old_warn
+end
+require 'octokit'
 
 module Pomo
-  class Task
-    def github?
-      false
-    end
-  end
-
   class GithubTask < Task
 
     ##
@@ -28,27 +30,63 @@ module Pomo
 
     attr_accessor :number
 
+    ##
+    # Absolute URI.
+
+    attr_accessor :url
+
     ##
     # Initialize with _name_ and _options_.
 
-    def initialize name = nil, options = {}
+    def initialize(name = nil, options = {})
       super
       options.each { |k,v| send :"#{k}=", v }
     end
 
     ##
-    # Check if the task is a github issue.
+    # Quoted github issue name and number.
 
-    def github?
-      true
+    def to_s
+      "#%-3s %s" % [ number, name]
     end
 
     ##
-    # Absolute URI to github issue.
+    # Output verbose task information.
 
-    def uri
-      "https://github.com/#{username}/#{project}/issues#issue/#{number}"
+    def verbose_output(format)
+      super(format)
+      say format % ['labels', labels.join(', ')] if labels and not labels.empty?
+      say format % ['project', [username, project].join('/')]
+      say format % ['url', url ]
     end
 
+    ##
+    # Import Github issue(s) with _user_, _project_, _number_ as GithubTask(s).
+
+    def self.import(user, project, number)
+      tasks = []
+      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 do |issue|
+        tasks << new(issue.title,
+          :username => user,
+          :project => project,
+          :description => issue.body,
+          :labels => issue.labels.map(&:name),
+          :number => issue.number,
+          :url => issue.html_url
+        )
+      end
+      return tasks
+    rescue Octokit::NotFound => e
+      say "\n"
+      say_error '404: This is not the repo you are looking for.'
+      say_error e.message
+      abort
+    end
   end
 end

data/lib/pomo/list.rb

@@ -1,3 +1,4 @@
+require 'yaml'
 
 module Pomo
   class List
@@ -15,11 +16,11 @@ module Pomo
     ##
     # Initialize with _path_.
 
-    def initialize opts = {}
+    def initialize(opts = {})
       if opts[:init]
         path = '.pomo'
       else
-        path = File.exists?('.pomo') ? '.pomo' : File.join(ENV['HOME'],'.pomo')
+        path = (File.exists?('.pomo') && ENV['POMO_ENV']!='test') ? '.pomo' : File.join(ENV['HOME'],'.pomo')
       end
       @path = File.expand_path path
       @tasks = []
@@ -35,35 +36,51 @@ module Pomo
     #  * n n n
     #  * n..n
     #  * n..-n
+    #  * n..n n..n n..n
     #  * first
     #  * last
+    #  * first last
     #  * incomplete
     #  * complete[d]
     #  * all
     #
 
-    def find *args, &block
+    def find(*args, &block)
       found = []
       found << tasks.first if args.empty?
-      if args.include? 'all'
-        found = tasks
-      elsif args.include? 'first'
-        found << tasks.first
-      elsif args.include? 'last'
-        found << tasks.last
-      elsif args.include?('complete') || args.include?('completed')
-        found = tasks.select { |task| task.complete? }
-      elsif args.include? 'incomplete'
-        found = tasks.select { |task| not task.complete? }
-      elsif args.any? { |arg| arg =~ /(\d+)\.\.(-?\d+)/ }
-        found = tasks[$1.to_i..$2.to_i]
-      else
-        tasks.each_with_index do |task, i|
-          found << task if args.any? { |a| a.to_i == i }
+
+      args.each do |arg|
+        case arg
+        when 'all'
+          found = tasks
+          break
+        when 'first'
+          found << tasks.first
+        when 'last'
+          found << tasks.last
+        when 'complete'
+          found.concat tasks.select { |task| task.complete? }
+        when 'completed'
+          found.concat tasks.select { |task| task.complete? }
+        when 'incomplete'
+          found.concat tasks.select { |task| not task.complete? }
+        when /^(\d+)$/
+          found << tasks[$1.to_i]
+        when /^(\d+)\.\.(-?\d+)$/
+          found.concat tasks[$1.to_i..$2.to_i]
         end
       end
-      found.each_with_index do |task, i|
-        yield task, i
+
+      found.compact!
+
+      if block.arity == 2
+        found.each_with_index do |task, i|
+          yield task, i
+        end
+      else
+        found.each do |task|
+          yield task
+        end
       end
     end
 
@@ -77,11 +94,18 @@ module Pomo
     ##
     # Add _task_ to the list in memory (requires saving).
 
-    def add task
+    def add(task)
       @tasks << task
     end
     alias :<< :add
 
+    ##
+    # Move task at _from_ index to _to_ index (requres saving).
+
+    def move(from, to)
+      @tasks.insert(index(to), @tasks.delete_at(index(from)))
+    end
+
     ##
     # Save the list.
 
@@ -100,5 +124,19 @@ module Pomo
       self
     end
 
+    private
+
+    def index(arg)
+      case arg
+      when 'first'
+        0
+      when 'last'
+        @tasks.size - 1
+      when /^(\d+)$/
+        $1.to_i
+      else
+        abort "Invalid argument: #{arg}. See 'pomo help move'"
+      end
+    end
   end
 end