paradeiser 0.2.0 → 0.4.0

data/bin/par

@@ -1,8 +1,5 @@
 #!/usr/bin/env ruby
 
-require 'bundler'
-Bundler.require
-
 require 'commander/import'
 require 'paradeiser'
 include Paradeiser
@@ -52,6 +49,20 @@ begin
   end
   alias_command :interrupt, :'pomodoro interrupt'
 
+  command :'pomodoro annotate' do |c|
+    c.syntax  = "#{program(:name)} #{c.name}"
+    c.summary = 'Annotates the active or most recent pomodoro'
+    c.action router.dispatch(c)
+  end
+  alias_command :annotate, :'pomodoro annotate'
+
+  command :'pomodoro log' do |c|
+    c.syntax  = "#{program(:name)} #{c.name}"
+    c.summary = 'Logs an already finished pomodoro'
+    c.action router.dispatch(c)
+  end
+  alias_command :log, :'pomodoro log'
+
   command :'break start' do |c|
     c.syntax  = "#{program(:name)} #{c.name}"
     c.summary = 'Start a break'
@@ -71,10 +82,15 @@ begin
     c.action router.dispatch(c)
   end
 
+  command :export do |c|
+    c.syntax  = "#{program(:name)} #{c.name}"
+    c.summary = 'Export all pomodori as JSON'
+    c.action router.dispatch(c)
+  end
+
   command :status do |c|
     c.syntax  = "#{program(:name)} #{c.name}"
     c.summary = 'Show status of active pomodoro or break'
-    c.option '--quiet', 'Be quiet - no output is printed. The exit code reflects the status.'
     c.action router.dispatch(c)
   end
 rescue

data/lib/paradeiser/controllers/breaks_controller.rb

@@ -4,7 +4,6 @@ module Paradeiser
       raise SingletonError.new(Break, Repository.active, :start) if Repository.active?
 
       @break = Break.new
-      @break.start!
       Repository.save(@break)
     end
 

data/lib/paradeiser/controllers/controller.rb

@@ -4,7 +4,7 @@ module Paradeiser
 
     def initialize(method)
       @method = method
-      @exitstatus = -1
+      @exitstatus = 0
       @has_output = false
     end
 
@@ -12,6 +12,7 @@ module Paradeiser
       @args = args
       @options = options
       send(@method)
+      render
     end
 
     def model
@@ -22,6 +23,19 @@ module Paradeiser
       return binding
     end
 
+    def render(options = {})
+      return if @already_rendered # render only once
+      return unless (@options && @options.verbose) || has_output
+
+      if options.has_key?(:text)
+        puts options[:text]
+      else
+        puts View.new(model, @method).render(binding)
+      end
+
+      @already_rendered = true
+    end
+
   protected
 
     attr_writer :exitstatus, :has_output

data/lib/paradeiser/controllers/paradeiser_controller.rb

@@ -1,4 +1,8 @@
 require 'fileutils'
+#require 'action_view/helpers/text_helper'
+require 'active_support/core_ext/enumerable'
+require 'active_model'
+require 'active_model/serializers/json'
 
 module Paradeiser
   class ParadeiserController < Controller
@@ -8,7 +12,19 @@ module Paradeiser
     end
 
     def report
-      @pom = Repository.all
+      pomodori = Repository.all_pomodori
+
+      @finished = pomodori.select{|p| p.finished?}.size
+      @canceled = pomodori.select{|p| p.canceled?}.size
+      @external_interrupts = pomodori.map{|p| p.interrupts}.flatten.select{|i| :external == i.type}.size
+      @internal_interrupts = pomodori.map{|p| p.interrupts}.flatten.select{|i| :internal == i.type}.size
+
+      breaks = Repository.all_breaks
+      @breaks = breaks.size
+      @break_minutes = breaks.sum{|b| b.duration}.to_i.minutes
+
+      @annotations = pomodori.collect{|p| p.annotations}.flatten
+
       self.has_output = true
     end
 
@@ -16,6 +32,12 @@ module Paradeiser
       @pom = Repository.active || Repository.all.last
       self.exitstatus = Status.of(@pom).to_i
       self.has_output = true
+      render(:text => 'There are no pomodori or breaks.') unless @pom
+    end
+
+    def export
+      self.has_output = true
+      render(:text => Repository.all.to_json)
     end
   end
 end

data/lib/paradeiser/controllers/pomodori_controller.rb

@@ -7,7 +7,6 @@ module Paradeiser
       raise SingletonError.new(Pomodoro, Repository.active, :start) if Repository.active?
 
       @pom = Pomodoro.new
-      @pom.start!
       Repository.save(@pom)
     end
 
@@ -15,6 +14,7 @@ module Paradeiser
       @pom = Repository.active
       raise NotActiveError unless @pom
       raise SingletonError.new(Pomodoro, @pom, :finish) if Repository.active? && !@pom.kind_of?(Pomodoro)
+      @pom.annotate(@args.join(' ')) if @args.any?
       @pom.cancel!
       Repository.save(@pom)
     end
@@ -23,6 +23,7 @@ module Paradeiser
       @pom = Repository.active
       raise NotActiveError unless @pom
       raise SingletonError.new(Pomodoro, @pom, :finish) if Repository.active? && !@pom.kind_of?(Pomodoro)
+      @pom.annotate(@args.join(' ')) if @args.any?
       @pom.finish!
       Repository.save(@pom)
     end
@@ -32,15 +33,36 @@ module Paradeiser
       raise NotActiveError unless @pom
       raise SingletonError.new(Pomodoro, @pom, :interrupt) if Repository.active? && !@pom.kind_of?(Pomodoro)
 
+      @pom.annotate(@args.join(' ')) if @args.any?
+
       if @options.external
+        @interrupt_type = 'externally'
         @pom.interrupt!(:external)
       else
+        @interrupt_type = 'internally'
         @pom.interrupt!
       end
 
       Repository.save(@pom)
     end
 
+    def annotate
+      raise MissingAnnotationError unless @args && @args.any?
+      @pom = Repository.all.select{|p| p.kind_of?(Pomodoro)}.sort{|a,b| a.started_at <=> b.started_at}.last
+      @pom.annotate(@args.join(' '))
+      Repository.save(@pom)
+    end
+
+    def log
+      @pom = Pomodoro.new
+      @pom.id = Repository.next_id
+      @pom.annotate(@args.join(' ')) if @args.any?
+      @pom.status = :finished
+      @pom.finished_at = Time.now
+      @pom.started_at = @pom.finished_at - Pomodoro::MINUTES_25 * 60
+      Repository.save(@pom)
+    end
+
   private
 
     def end_break

data/lib/paradeiser/errors.rb

@@ -34,4 +34,10 @@ module Paradeiser
       super("'#{type}' is not a valid type. Valid are only #{choices}.")
     end
   end
+
+  class MissingAnnotationError < StandardError
+    def initialize
+      super('The mandatory text is missing for the annotation')
+    end
+  end
 end

data/lib/paradeiser/executor.rb

@@ -12,6 +12,6 @@ module Executor
   end
 
   def queue
-    'p'
+    ENV['PAR_AT_QUEUE'] || 'p'
   end
 end

data/lib/paradeiser/initializers/inflections.rb

@@ -1,4 +1,7 @@
 ActiveSupport::Inflector.inflections do |inflect|
+  inflect.irregular 'paradeiser', 'paradeiser'
   inflect.irregular 'pomodoro', 'pomodori'
+  inflect.irregular 'interrupt', 'interrupts'
   inflect.irregular 'break', 'breaks'
+  inflect.irregular 'minute', 'minutes'
 end

data/lib/paradeiser/models/break.rb

@@ -31,6 +31,7 @@ module Paradeiser
     def initialize(length = 300.seconds)
       super() # required for state_machine
       @length = length
+      start!
     end
 
     def length

data/lib/paradeiser/models/pomodoro.rb

@@ -1,6 +1,6 @@
 module Paradeiser
   class Pomodoro < Scheduled
-    attr_reader :interrupts, :interrupt_type
+    attr_reader :interrupts, :interrupt_type, :annotations
     attr_accessor :canceled_at
 
     MINUTES_25 = 25
@@ -52,6 +52,8 @@ module Paradeiser
     def initialize
       super # required for state_machine
       @interrupts = []
+      @annotations = []
+      start!
     end
 
     def length
@@ -62,5 +64,15 @@ module Paradeiser
       @interrupt_type = type
       super
     end
+
+    def duration
+      start  = started_at  || Time.now
+      finish = finished_at || canceled_at || Time.now
+      (finish - start).to_i
+    end
+
+    def annotate(text)
+      @annotations << text
+    end
   end
 end

data/lib/paradeiser/models/repository.rb

@@ -7,6 +7,14 @@ module Paradeiser
         end
       end
 
+      def all_pomodori
+        all.select{|p| p.kind_of?(Pomodoro)}
+      end
+
+      def all_breaks
+        all.select{|b| b.kind_of?(Break)}
+      end
+
       def any?(&blk)
         all.any?(&blk)
       end
@@ -40,7 +48,9 @@ module Paradeiser
 
       def save(pom)
         raise IllegalStatusError if pom.idle?
-        raise SingletonError.new(pom.class, self.active, :save) if self.active? && active.id != pom.id
+
+        # Do not allow saving of a new active pomodoro while another pomodoro or break is active
+        raise SingletonError.new(pom.class, self.active, :save) if self.active? && pom.new?
 
         pom.id = next_id if pom.new?
         backend.transaction do

data/lib/paradeiser/models/scheduled.rb

@@ -1,3 +1,5 @@
+require 'active_support/core_ext/enumerable'
+
 module Paradeiser
   class Scheduled
     attr_accessor :id, :started_at, :finished_at
@@ -9,7 +11,7 @@ module Paradeiser
     # from https://github.com/travis-ci/travis/blob/master/lib/travis/client/job.rb
     def duration
       start  = started_at  || Time.now
-      finish = finished_at || (respond_to?(:canceled_at) ? canceled_at : nil) || Time.now
+      finish = finished_at || Time.now
       (finish - start).to_i
     end
 
@@ -21,5 +23,9 @@ module Paradeiser
     def name
       self.class.name.split("::").last.downcase
     end
+
+    def as_json(*options)
+      {:type => name.titlecase, :length => length}.merge(super(*options))
+    end
   end
 end

data/lib/paradeiser/refinements/pluralize.rb

@@ -0,0 +1,10 @@
+# stand-in for 'action_view/helpers/text_helper'
+def pluralize(count, singular, plural = nil)
+  word = if (count == 1 || count =~ /^1(\.0+)?$/)
+    singular
+  else
+    plural || singular.pluralize
+  end
+
+  "#{count || 0} #{word}"
+end

data/lib/paradeiser/router.rb

@@ -25,8 +25,6 @@ module Paradeiser
         controller = controller_class.new(verb)
         controller.call(args, options)
 
-        View.new(controller.model, verb).render(controller.get_binding) if options.verbose || controller.has_output
-
         @status = controller.exitstatus
       end
     end

data/lib/paradeiser/version.rb

@@ -1,3 +1,3 @@
 module Paradeiser
-  VERSION = '0.2.0'
+  VERSION = '0.4.0'
 end

data/lib/paradeiser/view.rb

@@ -5,7 +5,7 @@ module Paradeiser
     end
 
     def render(controller_binding)
-      puts(template.result(controller_binding))
+      template.result(controller_binding)
     end
 
   private

data/lib/paradeiser/views/breaks/finish.erb

@@ -0,0 +1 @@
+Finished break #<%= @break.id %> after <%= @break.duration.minutes %> minutes.

data/lib/paradeiser/views/breaks/start.erb

@@ -0,0 +1 @@
+Started a new break (<%= @break.length.minutes %> minutes).

data/lib/paradeiser/views/paradeiser/init.erb

@@ -1 +1 @@
-Suffessfully initialized <%= Paradeiser.par_dir %>.
+Successfully initialized <%= Paradeiser.par_dir %>.

data/lib/paradeiser/views/paradeiser/report.erb

@@ -1,5 +1,11 @@
-ID | Name | Status | Started | Ended | Interrupts
-<% @pom.each do |pom| %>
-<% interrupts_by_type = pom.interrupts.group_by{|i| i.type } %>
-<%= pom.id %> | <%= pom.name %> | <%= pom.status %> | <%= pom.started_at.strftime('%R') %> | <%= pom.finished_at.strftime('%R') if pom.finished? %><%= pom.canceled_at.strftime('%R') if pom.canceled? %> | <%= interrupts[:internal].size rescue 0 %> I, <%= interrupts_by_type[:external].size rescue 0 %> E
+# Pomodoro Report
+- <%= pluralize(@finished, 'pomodoro') %> finished
+- <%= pluralize(@canceled, 'pomodoro') %> canceled
+- <%= pluralize(@internal_interrupts, 'internal interrupt') %>
+- <%= pluralize(@external_interrupts, 'external interrupt') %>
+- <%= pluralize(@breaks, 'break') %> (<%= pluralize(@break_minutes, 'minute') %> in total)
+<% if @annotations.any? %>
+
+## Annotations<% @annotations.each do |annotation| %>
+* <%= annotation %><% end %>
 <% end %>

data/lib/paradeiser/views/paradeiser/status.erb

@@ -1,4 +1,5 @@
-<% case @pom.status_name
+<%
+case @pom.status_name
 when :active
   %><%= @pom.name.capitalize %> #<%= @pom.id %> is active for another <%= @pom.remaining.minutes %> minutes (started at <%= @pom.started_at.strftime('%R') %>).<% unless !@pom.respond_to?(:interrupts) || @pom.interrupts.empty? %> <%= @pom.interrupts.size %> interrupts on record.<% end %><%
 when :break

data/lib/paradeiser/views/pomodori/annotate.erb

@@ -0,0 +1 @@
+Successfully annotated pomodoro #<%= @pom.id %>.

data/lib/paradeiser/views/pomodori/cancel.erb

@@ -0,0 +1 @@
+Canceled pomodoro #<%= @pom.id %> after <%= @pom.duration.minutes %> minutes.

data/lib/paradeiser/views/pomodori/interrupt.erb

@@ -0,0 +1 @@
+Marked pomodoro #<%= @pom.id %> as <%= @interrupt_type %> interrupted.

data/lib/paradeiser/views/pomodori/log.erb

@@ -0,0 +1 @@
+Successfully logged pomodoro #<%= @pom.id %>.

data/lib/paradeiser/views/pomodori/start.erb

@@ -1 +1 @@
-Starting pomodoro #<%= @pom.id %>.
+Started pomodoro #<%= @pom.id %>.

data/paradeiser.gemspec

@@ -23,6 +23,8 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'state_machine'
   spec.add_runtime_dependency 'activesupport'
   spec.add_runtime_dependency 'actionpack'
+#  spec.add_runtime_dependency 'actionview'
+  spec.add_runtime_dependency 'activemodel'
 
   # Moved to the Gemfile so that Travis CI can load the test group
   # spec.add_development_dependency 'rake'

data/test/bin/notify-send

@@ -0,0 +1 @@
+true

data/test/helper.rb

@@ -10,9 +10,13 @@ class MiniTest::Test
 
 protected
 
-  def start!(thing = @pom || @break)
-    Scheduler.stub(:add, nil) do
-      thing.start!
+  def produce(clazz)
+    @started = srand
+
+    Time.stub :now, Time.at(@started) do
+      Scheduler.stub(:add, nil) do
+        clazz.new
+      end
     end
   end
 
@@ -34,24 +38,3 @@ protected
     end
   end
 end
-
-class ControllerTest < MiniTest::Test
-
-protected
-
-  def invoke(method, *attributes)
-    controller = ParadeiserController.new(method)
-
-    Repository.stub :backend, @backend do
-      Scheduler.stub(:add, nil) do
-        Scheduler.stub(:clear, nil) do
-          controller.call(nil, nil)
-        end
-      end
-    end
-
-    attributes.map do |attribute|
-      controller.get_binding.eval(attribute)
-    end
-  end
-end