paradeiser 0.1.0 → 0.2.0

data/lib/paradeiser/models/interrupt.rb

@@ -0,0 +1,18 @@
+module Paradeiser
+  class Interrupt
+    KNOWN_TYPES = [:internal, :external]
+    attr_reader :created_at, :type
+
+    def initialize(type = nil)
+      @type = type || :internal
+      raise InvalidTypeError.new(@type, KNOWN_TYPES) unless KNOWN_TYPES.include?(@type)
+      @created_at = Time.now
+    end
+  end
+
+  class ExternalInterrupt < Interrupt
+    def initialize
+      super(:external)
+    end
+  end
+end

data/lib/paradeiser/models/job.rb

@@ -4,7 +4,7 @@ module Paradeiser
 
     attr_reader :id
 
-    JOB_PATTERN = %r{^pom .+$}
+    JOB_PATTERN = %r|^#{BIN_PAR} .+$|
 
     def initialize(id)
       @id = id

data/lib/paradeiser/models/pomodoro.rb

@@ -1,32 +1,46 @@
 module Paradeiser
-  class Pomodoro
-    LENGTH_SECONDS = 25 * 60
+  class Pomodoro < Scheduled
+    attr_reader :interrupts, :interrupt_type
+    attr_accessor :canceled_at
 
-    attr_accessor :id, :started_at, :finished_at
+    MINUTES_25 = 25
 
     state_machine :status, :initial => :idle do
       event :start do
         transition :idle => :active
       end
 
+      event :interrupt do
+        transition :active => :active
+      end
+
+      event :cancel do
+        transition :active => :canceled
+      end
+
       event :finish do
         transition :active => :finished
       end
 
-      state :finished
-      state :active
-      state :idle
-
       after_transition :on => :start do |pom, transition|
         pom.started_at = Time.now
         Scheduler.clear # There must be no other jobs scheduled because of Rule #1
-        Scheduler.add(:finish, LENGTH_SECONDS.minutes)
+        Scheduler.add(:"#{pom.name} finish", pom.length.minutes)
+      end
+
+      after_transition :on => :interrupt do |pom, transition|
+        pom.interrupts << Interrupt.new(pom.interrupt_type)
       end
 
       around_transition do |pom, transition, block|
-        Hook.new(:before).execute(pom, transition)
+        Hook.new(:before).execute(pom, transition.event)
         block.call
-        Hook.new(:after).execute(pom, transition)
+        Hook.new(:after).execute(pom, transition.event)
+      end
+
+      after_transition :on => :cancel do |pom, transition|
+        pom.canceled_at = Time.now
+        Scheduler.clear # There must be no other jobs scheduled because of Rule #1
       end
 
       after_transition :on => :finish do |pom, transition|
@@ -37,22 +51,16 @@ module Paradeiser
 
     def initialize
       super # required for state_machine
+      @interrupts = []
     end
 
-    def new?
-      @id.nil?
-    end
-
-    # from https://github.com/travis-ci/travis/blob/master/lib/travis/client/job.rb
-    def duration
-      start  = started_at  || Time.now
-      finish = finished_at || Time.now
-      (finish - start).to_i
+    def length
+      MINUTES_25 * 60
     end
 
-    def remaining
-      raise NoActivePomodoroError if !active?
-      LENGTH_SECONDS - Time.now.to_i + started_at.to_i
+    def interrupt!(type = nil)
+      @interrupt_type = type
+      super
     end
   end
 end

data/lib/paradeiser/models/repository.rb

@@ -16,18 +16,31 @@ module Paradeiser
       end
 
       def active
-        all_active = find{|pom| pom.active?}
-        raise SingletonError.new(all_active.first) if all_active.size > 1
-        all_active.first
+        all_active = find{|pom| pom.active?}.sort{|a,b| a.started_at <=> b.started_at}
+
+        # Cannot recover from an internal inconsistency.
+        if all_active.size > 1
+          raise "The repository was corrupted. There are #{all_active.size} active objects, but only one is allowed to be active."
+        end
+
+        all_active.last
       end
 
       def active?
         !!active
       end
 
+      def last_finished
+        find{|p| p.finished?}.sort{|a,b| a.started_at <=> b.started_at}.last
+      end
+
+      def last_canceled
+        find{|p| p.canceled?}.sort{|a,b| a.started_at <=> b.started_at}.last
+      end
+
       def save(pom)
         raise IllegalStatusError if pom.idle?
-        raise SingletonError.new(self.active) if self.active? && active.id != pom.id
+        raise SingletonError.new(pom.class, self.active, :save) if self.active? && active.id != pom.id
 
         pom.id = next_id if pom.new?
         backend.transaction do
@@ -35,23 +48,23 @@ module Paradeiser
         end
       end
 
+      def next_id
+        if all.empty?
+          1
+        else
+          all.max{|a, b| a.id <=> b.id}.id + 1
+        end
+      end
+
     private
 
       def backend
         begin
-          @backend ||= PStore.new(File.join(Paradeiser.pom_dir, 'repository.pstore'), true)
+          @backend ||= PStore.new(File.join(Paradeiser.par_dir, 'repository.pstore'), true)
         rescue PStore::Error => e
           raise NotInitializedError.new(e.message)
         end
       end
-
-      def next_id
-        if all.empty?
-          1
-        else
-          all.max{|a, b| a.id <=> b.id}.id + 1
-        end
-      end
     end
   end
 end

data/lib/paradeiser/models/scheduled.rb

@@ -0,0 +1,25 @@
+module Paradeiser
+  class Scheduled
+    attr_accessor :id, :started_at, :finished_at
+
+    def new?
+      @id.nil?
+    end
+
+    # 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 - start).to_i
+    end
+
+    def remaining
+      raise NotActiveError unless active?
+      length - Time.now.to_i + started_at.to_i
+    end
+
+    def name
+      self.class.name.split("::").last.downcase
+    end
+  end
+end

data/lib/paradeiser/models/scheduler.rb

@@ -17,7 +17,7 @@ module Paradeiser
       end
 
       def add(command, minutes)
-        _, err = exec("echo pom #{command} | #{at} -q #{queue} now + #{minutes} minutes")
+        _, err = exec("echo #{BIN_PAR} #{command} | #{at} -q #{queue} now + #{minutes} minutes")
         id = parse_add(err.chomp)
         Job.new(id)
       end

data/lib/paradeiser/models/status.rb

@@ -0,0 +1,21 @@
+module Paradeiser
+  module Status
+
+    MAP = {
+      'pomodoro:active' => 0,
+      'pomodoro:finished' => 1,
+      'break:active' => 2,
+      'break:finished' => 3,
+    }
+
+    def self.of(thing)
+      thing.nil? ? -1 : MAP[key(thing)]
+    end
+
+  private
+
+    def self.key(thing)
+      "#{thing.name}:#{thing.status}"
+    end
+  end
+end

data/lib/paradeiser/{refinements.rb → refinements/numeric.rb}

@@ -2,4 +2,8 @@ class Numeric
   def minutes
     self / 60
   end
+
+  def seconds
+    self
+  end
 end

data/lib/paradeiser/router.rb

@@ -1,3 +1,5 @@
+require 'active_support/core_ext/string/inflections'
+
 module Paradeiser
   class Router
     attr_reader :status
@@ -8,19 +10,22 @@ module Paradeiser
 
     def dispatch(command)
       Proc.new do |args, options|
-        method = command.name
+        parts = command.name.split
+        resource = parts.shift
+        controller_name = "#{resource.pluralize.capitalize}Controller".to_sym
 
-        # TODO Dynamically find the controller that handles the method. :pomodoro is the default.
-        if (:init == method.to_sym)
-          controller_class = ParadeiserController
+        if Paradeiser.const_defined?(controller_name)
+          verb = parts.join
+          controller_class = Paradeiser.const_get(controller_name)
         else
-          controller_class = PomodoriController
+          verb = resource
+          controller_class = ParadeiserController
         end
 
-        controller = controller_class.new(method)
+        controller = controller_class.new(verb)
         controller.call(args, options)
 
-        View.new(controller.model, method).render(controller.get_binding) if options.verbose || controller.has_output
+        View.new(controller.model, verb).render(controller.get_binding) if options.verbose || controller.has_output
 
         @status = controller.exitstatus
       end

data/lib/paradeiser/version.rb

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

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

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

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

@@ -0,0 +1,5 @@
+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
+<% end %>

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

@@ -0,0 +1,13 @@
+<% 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
+  %><%= @pom.name.capitalize %> is active for another <%= @pom.remaining.minutes %> minutes.<%
+when :finished
+  %>Nothing active. Last <%= @pom.name %> was finished at <%= @pom.finished_at.strftime('%R') %>.<% unless !@pom.respond_to?(:interrupts) || @pom.interrupts.empty? %> It had <%= @pom.interrupts.size %> interrupts.<% end %><%
+when :canceled
+  %>Nothing active. Last <%= @pom.name %> was canceled at <%= @pom.canceled_at.strftime('%R') %>.<% unless !@pom.respond_to?(:interrupts) || @pom.interrupts.empty? %> It had <%= @pom.interrupts.size %> interrupts.<% end %><%
+else
+  %>Current state is <%= @pom.status %>.<%
+end
+%>

data/paradeiser.gemspec

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

data/templates/linux/hooks/after-finish-break

@@ -0,0 +1,10 @@
+#!/bin/sh
+
+#
+# Sample after-finish-break hook for Paradeiser (called after a break ended). It
+# displays a simple notification.
+#
+# $PAR_BREAK_ID - the ID of the break that just ended
+# $PAR_BREAK_STARTED_AT - the time when the break was started
+#
+notify-send "Pomodoro" "The break $PAR_BREAK_ID (started at $PAR_BREAK_STARTED_AT) is over." -u critical > /dev/null

data/templates/linux/hooks/after-finish-pomodoro

@@ -0,0 +1,10 @@
+#!/bin/sh
+
+#
+# Sample after-finish-pomodoro hook for Paradeiser (called after a pomodoro ended). It
+# displays a simple notification.
+#
+# $PAR_POMODORO_ID - the ID of the pomodoro that just ended
+# $PAR_POMODORO_STARTED_AT - the time when the pomodoro was started
+#
+notify-send "Pomodoro" "The pomodoro $PAR_POMODORO_ID (started at $PAR_POMODORO_STARTED_AT) is over." -u critical > /dev/null

data/templates/linux/hooks/after-start-break

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+#
+# Sample after-start-break hook for Paradeiser (called after a break started). It
+# displays a simple notification.
+#
+notify-send "Pomodoro" "A new break started." -u critical > /dev/null

data/templates/linux/hooks/after-start-pomodoro

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+#
+# Sample after-start-pomodoro hook for Paradeiser (called after a pomodoro started). It
+# displays a simple notification.
+#
+notify-send "Pomodoro" "A new pomodoro started." -u critical > /dev/null

data/templates/mac/hooks/after-finish-break

@@ -0,0 +1,10 @@
+#!/bin/sh
+
+#
+# Sample after-finish-break hook for Paradeiser (called after a break ended). It
+# displays a simple notification.
+#
+# $PAR_BREAK_ID - the ID of the break that just ended
+# $PAR_BREAK_STARTED_AT - the time when the break was started
+#
+terminal-notifier-success -message "The break $PAR_BREAK_ID (started at $PAR_BREAK_STARTED_AT) is over." > /dev/null

data/templates/mac/hooks/after-finish-pomodoro

@@ -0,0 +1,10 @@
+#!/bin/sh
+
+#
+# Sample after-finish-pomodoro hook for Paradeiser (called after a pomodoro ended). It
+# displays a simple notification.
+#
+# $PAR_POMODORO_ID - the ID of the pomodoro that just ended
+# $PAR_POMODORO_STARTED_AT - the time when the pomodoro was started
+#
+terminal-notifier-success -message "The pomodoro $PAR_POMODORO_ID (started at $PAR_POMODORO_STARTED_AT) is over." > /dev/null

data/templates/mac/hooks/after-start-break

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+#
+# Sample after-start-break hook for Paradeiser (called after a break started). It
+# displays a simple notification.
+#
+terminal-notifier-success -message "A new break started." > /dev/null

data/templates/mac/hooks/after-start-pomodoro

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+#
+# Sample after-start-pomodoro hook for Paradeiser (called after a pomodoro started). It
+# displays a simple notification.
+#
+terminal-notifier-success -message "A new pomodoro started." > /dev/null

data/test/helper.rb

@@ -10,15 +10,48 @@ class MiniTest::Test
 
 protected
 
-  def start!(pom = @pom)
+  def start!(thing = @pom || @break)
     Scheduler.stub(:add, nil) do
-      pom.start!
+      thing.start!
     end
   end
 
-  def finish!(pom = @pom)
+  def interrupt!(type = :internal, pom = @pom)
     Scheduler.stub(:clear, nil) do
-      pom.finish!
+      pom.interrupt!(type)
+    end
+  end
+
+  def finish!(thing = @pom || @break)
+    Scheduler.stub(:clear, nil) do
+      thing.finish!
+    end
+  end
+
+  def cancel!(pom = @pom)
+    Scheduler.stub(:clear, nil) do
+      pom.cancel!
+    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