paradeiser 0.0.1 → 0.1.0

data/bin/pom

@@ -0,0 +1,60 @@
+#!/usr/bin/env ruby
+
+require 'bundler'
+Bundler.require
+
+require 'commander/import'
+require 'paradeiser'
+include Paradeiser
+
+program :version, Paradeiser::VERSION
+program :description, "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."
+program :help, 'Author', 'Nicholas E. Rabenau <nerab@gmx.at>'
+
+global_option '-V', '--verbose', 'Enable verbose output'
+default_command :help
+
+router = Router.new
+
+begin
+  command :init do |c|
+    c.syntax  = "#{program(:name)} #{c.name}"
+    c.summary = 'Init paradeiser'
+    c.action router.dispatch(c)
+  end
+
+  command :start do |c|
+    c.syntax  = "#{program(:name)} #{c.name}"
+    c.summary = 'Start a new pomodoro'
+    c.action router.dispatch(c)
+  end
+
+  command :finish do |c|
+    c.syntax  = "#{program(:name)} #{c.name}"
+    c.summary = 'Finish the active pomodoro'
+    c.action router.dispatch(c)
+  end
+
+  command :report do |c|
+    c.syntax  = "#{program(:name)} #{c.name}"
+    c.summary = 'Show a report on all pomodori'
+    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
+  $stderr.puts("Error: #{$!.message}")
+  $stderr.puts $!.backtrace if options.trace
+  exit(1)
+end
+
+# We replace Commander's exit hook with our own in order to set a custom exit status.
+at_exit do
+  run!
+  exit(router.status)
+end

data/doc/Paradeiser::Pomodoro_status.svg

@@ -0,0 +1,50 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
+ "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<!-- Generated by graphviz version 2.30.1 (20130609.1303)
+ -->
+<!-- Title: G Pages: 1 -->
+<svg width="408pt" height="88pt"
+ viewBox="0.00 0.00 408.00 88.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 84)">
+<title>G</title>
+<polygon fill="white" stroke="white" points="-4,5 -4,-84 405,-84 405,5 -4,5"/>
+<!-- idle -->
+<g id="node1" class="node"><title>idle</title>
+<ellipse fill="none" stroke="black" cx="78" cy="-40" rx="36" ry="36"/>
+<text text-anchor="middle" x="78" y="-34.0493" font-family="Arial" font-size="14.00">idle</text>
+</g>
+<!-- active -->
+<g id="node3" class="node"><title>active</title>
+<ellipse fill="none" stroke="black" cx="214" cy="-40" rx="36" ry="36"/>
+<text text-anchor="middle" x="214" y="-34.0493" font-family="Arial" font-size="14.00">active</text>
+</g>
+<!-- idle&#45;&gt;active -->
+<g id="edge2" class="edge"><title>idle&#45;&gt;active</title>
+<path fill="none" stroke="black" d="M114.207,-40C130.389,-40 149.793,-40 167.103,-40"/>
+<polygon fill="black" stroke="black" points="167.563,-43.5001 177.563,-40 167.563,-36.5001 167.563,-43.5001"/>
+<text text-anchor="middle" x="146" y="-42.0986" font-family="Arial" font-size="14.00">start</text>
+</g>
+<!-- starting_state -->
+<g id="node2" class="node"><title>starting_state</title>
+<ellipse fill="black" stroke="black" cx="2" cy="-40" rx="1.8" ry="1.8"/>
+</g>
+<!-- starting_state&#45;&gt;idle -->
+<g id="edge1" class="edge"><title>starting_state&#45;&gt;idle</title>
+<path fill="none" stroke="black" d="M3.83105,-40C6.96908,-40 18.5857,-40 31.6682,-40"/>
+<polygon fill="black" stroke="black" points="31.8421,-43.5001 41.8421,-40 31.8421,-36.5001 31.8421,-43.5001"/>
+</g>
+<!-- finished -->
+<g id="node4" class="node"><title>finished</title>
+<ellipse fill="none" stroke="black" cx="360" cy="-40" rx="36" ry="36"/>
+<ellipse fill="none" stroke="black" cx="360" cy="-40" rx="40" ry="40"/>
+<text text-anchor="middle" x="360" y="-34.0493" font-family="Arial" font-size="14.00">finished</text>
+</g>
+<!-- active&#45;&gt;finished -->
+<g id="edge3" class="edge"><title>active&#45;&gt;finished</title>
+<path fill="none" stroke="black" d="M250.226,-40C268.083,-40 290.064,-40 309.582,-40"/>
+<polygon fill="black" stroke="black" points="309.829,-43.5001 319.829,-40 309.829,-36.5001 309.829,-43.5001"/>
+<text text-anchor="middle" x="285" y="-42.0986" font-family="Arial" font-size="14.00">finish</text>
+</g>
+</g>
+</svg>

data/lib/paradeiser.rb

@@ -1,5 +1,28 @@
-require "paradeiser/version"
+require 'pstore'
+require 'erb'
+require 'state_machine'
+
+require 'require_all'
+require_rel "paradeiser"
 
 module Paradeiser
-  # Your code goes here...
+  def self.pom_dir
+    ENV['POM_DIR'] || File.expand_path('~/.paradeiser/')
+  end
+
+  def self.hooks_dir
+    File.join(Paradeiser.pom_dir, 'hooks')
+  end
+
+  def self.templates_dir
+    File.join(File.dirname(__FILE__), '..', 'templates')
+  end
+
+  def self.os
+    case RUBY_PLATFORM
+      when /darwin/ then :mac
+      when /linux/ then :linux
+      else :other
+    end
+  end
 end

data/lib/paradeiser/controllers/controller.rb

@@ -0,0 +1,30 @@
+module Paradeiser
+  class Controller
+    attr_reader :exitstatus, :has_output
+
+    def initialize(method)
+      @method = method
+      @exitstatus = 0
+      @has_output = false
+    end
+
+    def call(args, options)
+      @args = args
+      @options = options
+      send(@method)
+    end
+
+    def model
+      self.class.name.split("::").last.sub('Controller', '')
+    end
+
+    def get_binding
+      return binding
+    end
+
+  protected
+
+    attr_writer   :exitstatus, :has_output
+    attr_reader   :options, :args
+  end
+end

data/lib/paradeiser/controllers/paradeiser_controller.rb

@@ -0,0 +1,10 @@
+require 'fileutils'
+
+module Paradeiser
+  class ParadeiserController < Controller
+    def init
+      FileUtils.mkdir_p(Paradeiser.pom_dir)
+      FileUtils.cp_r(File.join(Paradeiser.templates_dir, Paradeiser.os.to_s, 'hooks'), Paradeiser.pom_dir)
+    end
+  end
+end

data/lib/paradeiser/controllers/pomodori_controller.rb

@@ -0,0 +1,38 @@
+module Paradeiser
+  class PomodoriController < Controller
+    def start
+      # The repository will protect itself, but we don't want to create
+      # a new pomodoro if saving it will fail anyway.
+      raise SingletonError.new(Repository.active) if Repository.active?
+
+      @pom = Pomodoro.new
+      @pom.start!
+      Repository.save(@pom)
+    end
+
+    def finish
+      @pom = Repository.active
+      raise NoActivePomodoroError unless @pom
+      @pom.finish!
+      Repository.save(@pom)
+    end
+
+    def report
+      @pom = Repository.all
+      self.has_output = true
+    end
+
+    def status
+      if @pom = Repository.active
+        self.exitstatus = 0
+      elsif @pom = Repository.find{|pom| pom.finished?}.last
+        self.exitstatus = 1
+      # elsif Repository.find(:status => 'cancelled').last
+      #   self.exitstatus = 2
+      else
+        @pom = Pomodoro.new # nothing found, we are idle
+      end
+      self.has_output = true
+    end
+  end
+end

data/lib/paradeiser/errors.rb

@@ -0,0 +1,31 @@
+module Paradeiser
+  class SingletonError < StandardError
+    def initialize(pom)
+      super("Pomodoro #{pom.id} is already active.")
+    end
+  end
+
+  class NoActivePomodoroError < StandardError
+    def initialize
+      super('There is no active pomodoro.')
+    end
+  end
+
+  class NotInitializedError < StandardError
+    def initialize(msg)
+      super("Paradeiser was not properly initialized; #{msg}.")
+    end
+  end
+
+  class IllegalStatusError < StandardError
+    def initialize
+      super('Idle pomodori cannot be saved.')
+    end
+  end
+
+  class HookFailedError < StandardError
+    def initialize(hook, out, err, status)
+      super("The hook #{hook} failed with status #{status.exitstatus}. STDERR contained: #{err}")
+    end
+  end
+end

data/lib/paradeiser/executor.rb

@@ -0,0 +1,15 @@
+module Executor
+  def exec(cmd)
+    out, err, status = Open3.capture3(cmd)
+    raise err if 0 < status.exitstatus
+    [out, err]
+  end
+
+  def at
+    'at'
+  end
+
+  def queue
+    'p'
+  end
+end

data/lib/paradeiser/models/hook.rb

@@ -0,0 +1,26 @@
+module Paradeiser
+  class Hook
+    def initialize(phase)
+      @phase = phase
+    end
+
+    def execute(pom, transition)
+      name = "#{@phase}-#{transition.event}"
+      hook = hook(name)
+
+      if File.exist?(hook) && File.executable?(hook)
+        ENV['POM_ID'] = pom.id.to_s
+        ENV['POM_STARTED_AT'] = pom.started_at.strftime('%H:%M') if pom.started_at
+
+        out, err, status = Open3.capture3(hook)
+        raise HookFailedError.new(hook, out, err, status) if 0 != status.exitstatus
+      end
+    end
+
+  private
+
+    def hook(name)
+      File.join(Paradeiser.hooks_dir, name)
+    end
+  end
+end

data/lib/paradeiser/models/job.rb

@@ -0,0 +1,25 @@
+module Paradeiser
+  class Job
+    include Executor
+
+    attr_reader :id
+
+    JOB_PATTERN = %r{^pom .+$}
+
+    def initialize(id)
+      @id = id
+    end
+
+    def ==(other)
+      id == other.id
+    end
+
+    def ours?
+      exec("#{at} -c #{@id}")[-2, 2].each do |line|
+        if line
+          return true if line.chomp.match(JOB_PATTERN)
+        end
+      end
+    end
+  end
+end

data/lib/paradeiser/models/pomodoro.rb

@@ -0,0 +1,58 @@
+module Paradeiser
+  class Pomodoro
+    LENGTH_SECONDS = 25 * 60
+
+    attr_accessor :id, :started_at, :finished_at
+
+    state_machine :status, :initial => :idle do
+      event :start do
+        transition :idle => :active
+      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)
+      end
+
+      around_transition do |pom, transition, block|
+        Hook.new(:before).execute(pom, transition)
+        block.call
+        Hook.new(:after).execute(pom, transition)
+      end
+
+      after_transition :on => :finish do |pom, transition|
+        pom.finished_at = Time.now
+        Scheduler.clear # There must be no other jobs scheduled because of Rule #1
+      end
+    end
+
+    def initialize
+      super # required for state_machine
+    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
+    end
+
+    def remaining
+      raise NoActivePomodoroError if !active?
+      LENGTH_SECONDS - Time.now.to_i + started_at.to_i
+    end
+  end
+end

data/lib/paradeiser/models/repository.rb

@@ -0,0 +1,57 @@
+module Paradeiser
+  class Repository
+    class << self
+      def all
+        backend.transaction(true) do
+          backend.roots.map{|id| backend[id]}
+        end
+      end
+
+      def any?(&blk)
+        all.any?(&blk)
+      end
+
+      def find(&blk)
+        all.select(&blk)
+      end
+
+      def active
+        all_active = find{|pom| pom.active?}
+        raise SingletonError.new(all_active.first) if all_active.size > 1
+        all_active.first
+      end
+
+      def active?
+        !!active
+      end
+
+      def save(pom)
+        raise IllegalStatusError if pom.idle?
+        raise SingletonError.new(self.active) if self.active? && active.id != pom.id
+
+        pom.id = next_id if pom.new?
+        backend.transaction do
+          backend[pom.id] = pom
+        end
+      end
+
+    private
+
+      def backend
+        begin
+          @backend ||= PStore.new(File.join(Paradeiser.pom_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