paradeiser 0.0.1 → 0.1.0

data/lib/paradeiser/models/scheduler.rb

@@ -0,0 +1,43 @@
+require 'open3'
+
+module Paradeiser
+  class Scheduler
+    class << self
+      include Executor
+
+      def list
+        out, _ = exec("#{at} -l -q #{queue}")
+
+        out.lines.map do |line|
+          id = parse_list(line)
+          Job.new(id)
+        end.select do |job|
+          job.ours?
+        end
+      end
+
+      def add(command, minutes)
+        _, err = exec("echo pom #{command} | #{at} -q #{queue} now + #{minutes} minutes")
+        id = parse_add(err.chomp)
+        Job.new(id)
+      end
+
+      def clear
+        if list.any? # On Linux, at must not be called with an empty job list.
+          job_ids = list.map{|j| j.id}.join(' ')
+          exec("#{at} -q #{queue} -r #{job_ids}")
+        end
+      end
+
+    private
+
+      def parse_list(line)
+        line[/^(\d+)/]
+      end
+
+      def parse_add(line)
+        line.match(/^job (?<job>\d+)/)[:job]
+      end
+    end
+  end
+end

data/lib/paradeiser/refinements.rb

@@ -0,0 +1,5 @@
+class Numeric
+  def minutes
+    self / 60
+  end
+end

data/lib/paradeiser/router.rb

@@ -0,0 +1,29 @@
+module Paradeiser
+  class Router
+    attr_reader :status
+
+    def initialize
+      @status = 0
+    end
+
+    def dispatch(command)
+      Proc.new do |args, options|
+        method = command.name
+
+        # TODO Dynamically find the controller that handles the method. :pomodoro is the default.
+        if (:init == method.to_sym)
+          controller_class = ParadeiserController
+        else
+          controller_class = PomodoriController
+        end
+
+        controller = controller_class.new(method)
+        controller.call(args, options)
+
+        View.new(controller.model, method).render(controller.get_binding) if options.verbose || controller.has_output
+
+        @status = controller.exitstatus
+      end
+    end
+  end
+end

data/lib/paradeiser/version.rb

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

data/lib/paradeiser/view.rb

@@ -0,0 +1,21 @@
+module Paradeiser
+  class View
+    def initialize(model, method)
+      @model, @method = model, method
+    end
+
+    def render(controller_binding)
+      puts(template.result(controller_binding))
+    end
+
+  private
+
+    def template
+      ERB.new(File.read(template_file), 0, '%<>')
+    end
+
+    def template_file
+      File.join(File.dirname(__FILE__), 'views', @model.downcase, "#{@method}.erb")
+    end
+  end
+end

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

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

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

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

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

@@ -0,0 +1,5 @@
+ID | Status | Started | Ended
+<% @pom.each do |pom| %>
+<%= pom.id %> | <%= pom.status %> | <%= pom.started_at.strftime('%R') %> | <%= pom.finished_at.strftime('%R') if pom.finished? %>
+
+<% end %>

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

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

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

@@ -0,0 +1,9 @@
+<% case @pom.status_name
+when :active
+  %>Pomodoro #<%= @pom.id %> is active for another <%= @pom.remaining.minutes %> minutes (started at <%= @pom.started_at.strftime('%R') %>).<%
+when :finished
+  %>No active pomodoro. Last one was finished at <%= @pom.finished_at.strftime('%R') %>.<%
+else
+  %>Current state is <%= @pom.status %>.<%
+end
+%>

data/paradeiser.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Paradeiser::VERSION
   spec.authors       = ["Nicholas E. Rabenau"]
   spec.email         = ["nerab@gmx.net"]
-  spec.description   = %q{Paradeiser is a tool for the [Pomodoro Technique](http://www.pomodorotechnique.com/). It keeps track of the current pomodoro and assists the user in managing active and past pomodori.}
-  spec.summary       = %q{Paradeiser is a tool for the Pomodoro Technique}
+  spec.description   = %q{Paradeiser is a command-line tool for the Pomodoro Technique. It keeps track of the current pomodoro and assists the user in managing active and past pomodori as well as breaks. Status commands and reports are provided to get insights.}
+  spec.summary       = %q{Command-line tool for the Pomodoro Technique}
   spec.homepage      = "https://github.com/nerab/paradeiser"
   spec.license       = "MIT"
 
@@ -18,6 +18,23 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
+  spec.add_runtime_dependency 'commander'
+  spec.add_runtime_dependency 'require_all'
+  spec.add_runtime_dependency 'state_machine'
+
+  # Moved to the Gemfile so that Travis CI can load the test group
+  # spec.add_development_dependency 'rake'
+  # spec.add_development_dependency 'minitest'
+
+  spec.add_development_dependency 'guard-minitest'
+  spec.add_development_dependency 'guard-bundler'
+  spec.add_development_dependency 'terminal-notifier-guard'
+  spec.add_development_dependency 'libnotify'
+  spec.add_development_dependency 'rb-inotify'
+  spec.add_development_dependency 'rb-fsevent'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-nav'
+  spec.add_development_dependency 'pry-stack_explorer'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'ruby-graphviz'
 end

data/templates/linux/hooks/after-finish

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

data/templates/linux/hooks/after-start

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+#
+# Sample post-finish 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

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

data/templates/mac/hooks/after-start

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+#
+# Sample post-finish 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

@@ -0,0 +1,24 @@
+require 'minitest/autorun'
+require 'paradeiser'
+require_rel 'lib'
+
+require 'lib/at_mock'
+
+include Paradeiser
+
+class MiniTest::Test
+
+protected
+
+  def start!(pom = @pom)
+    Scheduler.stub(:add, nil) do
+      pom.start!
+    end
+  end
+
+  def finish!(pom = @pom)
+    Scheduler.stub(:clear, nil) do
+      pom.finish!
+    end
+  end
+end

data/test/integration/test_pom.rb

@@ -0,0 +1,17 @@
+require 'helper'
+
+class TestPom < MiniTest::Test
+  POM_BIN = 'pom'
+
+  def test_no_args_defaults_to_help
+    out, err, status = Open3.capture3(POM_BIN)
+    assert_equal(0, status.exitstatus, "Expected exit status to be 0, but it was #{status.exitstatus}. STDERR contains: #{err}")
+    assert_empty(err)
+  end
+
+  def test_unknown
+    out, err, status = Open3.capture3("#{POM_BIN} unknown")
+    refute_equal(0, status.exitstatus)
+    refute_empty(err)
+  end
+end

data/test/lib/assertions.rb

@@ -0,0 +1,10 @@
+# from Gem::TestCase rubygems/test_case.rb
+def assert_path_exists(path, msg = nil)
+  msg = message(msg){"Expected path '#{path}' to exist"}
+  assert(File.exist?(path), msg)
+end
+
+def refute_path_exists(path, msg = nil)
+  msg = message(msg){"Expected path '#{path}' to NOT exist"}
+  refute(File.exist?(path), msg)
+end

data/test/lib/at_mock.rb

@@ -0,0 +1,6 @@
+# Include this module in order to use another queue for at commands
+module Executor
+  def queue
+    't'
+  end
+end

data/test/lib/options_mock.rb

@@ -0,0 +1,7 @@
+require 'ostruct'
+
+class OptionsMock < OpenStruct
+  def initialize(attributes)
+    super(attributes)
+  end
+end

data/test/lib/pomodoro_mock.rb

@@ -0,0 +1,11 @@
+require 'ostruct'
+
+class PomodoroMock < OpenStruct
+  def initialize(attributes)
+    super(attributes)
+  end
+
+  def active?
+    !!active
+  end
+end

data/test/lib/process_status_mock.rb

@@ -0,0 +1,2 @@
+class ProcessStatusMock < Struct.new(:exitstatus)
+end

data/test/lib/pstore_mock.rb

@@ -0,0 +1,16 @@
+class PStoreMock
+  extend Forwardable
+  def_delegators :@hash, :[]=, :[], :size
+
+  def initialize
+    @hash = {}
+  end
+
+  def transaction(read_only = true)
+    yield if block_given?
+  end
+
+  def roots
+    @hash.keys
+  end
+end

data/test/templates/hooks/pre-finish

@@ -0,0 +1 @@
+echo pre-finish-hook

data/test/unit/test_paradeiser_controller.rb

@@ -0,0 +1,88 @@
+require 'helper'
+require 'fakefs/safe'
+
+class TestParadeiserController < MiniTest::Test
+  HOOKS = ['after-finish', 'before-finish']
+
+  def setup
+    @orig_pom_dir = ENV['POM_DIR']
+    FakeFS.activate!
+    create_hook_templates
+  end
+
+  def teardown
+    FileUtils.rm_r(Paradeiser.pom_dir, :force => true) if Dir.exists?(Paradeiser.pom_dir)
+    FakeFS.deactivate!
+    ENV['POM_DIR'] = @orig_pom_dir
+  end
+
+  def test_init_virgin
+    ENV.delete('POM_DIR')
+    refute(Dir.exists?(Paradeiser.pom_dir), "Expect #{Paradeiser.pom_dir} to not exist yet")
+
+    ParadeiserController.new(:init).call(nil, nil)
+    assert(Dir.exists?(Paradeiser.pom_dir))
+    assert_hooks_exist
+  end
+
+  def test_init_existing
+    FileUtils.mkdir_p(Paradeiser.pom_dir, 0700)
+    assert(Dir.exists?(Paradeiser.pom_dir))
+
+    ParadeiserController.new(:init).call(nil, nil)
+    assert(Dir.exists?(Paradeiser.pom_dir))
+    assert_hooks_exist
+  end
+
+  def test_init_virgin_with_env_override
+    dir = tempdir_name
+    refute_equal(dir, Paradeiser.pom_dir)
+    ENV['POM_DIR'] = dir
+    assert_equal(dir, Paradeiser.pom_dir)
+    refute(Dir.exists?(Paradeiser.pom_dir), "POM_DIR override #{Paradeiser.pom_dir} must not exist")
+
+    ParadeiserController.new(:init).call(nil, nil)
+
+    assert(Dir.exists?(Paradeiser.pom_dir))
+    assert_hooks_exist
+  end
+
+  def test_init_existing_with_env_override
+    ENV.delete('POM_DIR')
+
+    Dir.mktmpdir do |dir|
+      refute_equal(dir, Paradeiser.pom_dir)
+      ENV['POM_DIR'] = dir
+      assert_equal(dir, Paradeiser.pom_dir)
+      assert(Dir.exists?(Paradeiser.pom_dir), "POM_DIR override #{Paradeiser.pom_dir} must exist")
+
+      ParadeiserController.new(:init).call(nil, nil)
+      assert(Dir.exists?(Paradeiser.pom_dir), "POM_DIR override #{Paradeiser.pom_dir} must exist")
+      assert_hooks_exist
+    end
+  end
+
+private
+
+  # Makes a temporary directory name, but does not create the directory
+  def tempdir_name
+    dir = File.join(Dir.tmpdir, SecureRandom.uuid)
+    refute(Dir.exists?(dir))
+    dir
+  end
+
+  def create_hook_templates
+    hook_templates_dir = File.join(Paradeiser.templates_dir, Paradeiser.os.to_s, 'hooks')
+    FileUtils.mkdir_p(hook_templates_dir)
+
+    HOOKS.each do |hook|
+      FileUtils.touch(File.join(hook_templates_dir, hook))
+    end
+  end
+
+  def assert_hooks_exist
+    HOOKS.each do |hook|
+      assert(File.exist?(File.join(Paradeiser.hooks_dir, hook)))
+    end
+  end
+end

data/test/unit/test_pomodori_controller.rb

@@ -0,0 +1,103 @@
+require 'helper'
+
+class TestPomodoriController < MiniTest::Test
+  def setup
+    @backend = PStoreMock.new
+  end
+
+  def test_start
+    pom, has_output = invoke(:start, '@pom', 'has_output')
+    assert_equal(:active, pom.status_name)
+    assert_equal(false, has_output)
+    assert_equal(1, @backend.size)
+  end
+
+  def test_start_active
+    invoke(:start)
+    assert_equal(1, @backend.size)
+
+    assert_raises SingletonError do
+      invoke(:start)
+    end
+    assert_equal(1, @backend.size)
+  end
+
+  def test_finish
+    invoke(:start)
+    pom, has_output = invoke(:finish, '@pom', 'has_output')
+    assert_equal(:finished, pom.status_name)
+    assert_equal(false, has_output)
+    assert_equal(1, @backend.size)
+  end
+
+  def test_finish_idle
+    assert_raises NoActivePomodoroError do
+      invoke(:finish)
+    end
+    assert_equal(0, @backend.size)
+  end
+
+  def test_report_idle
+    pomodori, has_output = invoke(:report, '@pom', 'has_output')
+    assert_empty(pomodori)
+    assert_equal(true, has_output)
+  end
+
+  def test_report_active
+    invoke(:start)
+    pomodori, has_output = invoke(:report, '@pom', 'has_output')
+    assert_equal(1, pomodori.size)
+    assert_equal(true, has_output)
+  end
+
+  def test_report_finished
+    invoke(:start)
+    invoke(:finish)
+    invoke(:start)
+    pomodori, has_output = invoke(:report, '@pom', 'has_output')
+    assert_equal(2, pomodori.size)
+    assert_equal(true, has_output)
+  end
+
+  def test_status_idle
+    pom, has_output = invoke(:status, '@pom', 'has_output')
+    assert_equal(:idle, pom.status_name)
+    assert_equal(true, has_output)
+    assert_equal(0, @backend.size)
+  end
+
+  def test_status_active
+    invoke(:start)
+    pom, has_output = invoke(:status, '@pom', 'has_output')
+    assert_equal(:active, pom.status_name)
+    assert_equal(true, has_output)
+    assert_equal(1, @backend.size)
+  end
+
+  def test_status_finished
+    invoke(:start)
+    invoke(:finish)
+    pom, has_output = invoke(:status, '@pom', 'has_output')
+    assert_equal(:finished, pom.status_name)
+    assert_equal(true, has_output)
+    assert_equal(1, @backend.size)
+  end
+
+private
+
+  def invoke(method, *attributes)
+    controller = PomodoriController.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