thyme 0.0.13 → 0.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2dc55d1fa48aa2ebf2655f9140fa9ca1a06758b3
-  data.tar.gz: a55a448d17fabd05cb12a2ba86a17a30d9ebc2af
+  metadata.gz: 0a34024e5c3c57ea62c834ea83adf0c118b3fad2
+  data.tar.gz: b0e6459d5fb05917846384d5296c7b4da76d0ce1
 SHA512:
-  metadata.gz: 2f2b2bff48e1730abbe236b56f930638911f4f4f33991269253af116262b8e82bd04e5e2808226717a5128fe456ef14131493802c6d5563b49b20606952d03b4
-  data.tar.gz: dd12fc5edede848a295f164d3a4ec37e01a698b17fb3069c4e78842249366eb879281637ec8916a33d77d674de42ba7348d02bb366f344d9bc026f2959545783
+  metadata.gz: bfd282a9ff8df019c9c58b4add8c98bdc7e08e37a71cf4ea980bdacd366cbc9142450fcd9b062e783a4d4e5c0735c3a3ceb35a2c6b6a0c05c0f1d913a2d8b5b9
+  data.tar.gz: 82391d021bf3735a7e34be5a354de37cd62e104664886ead5e03af649a5b2849cac58c16226f9ab6d6472a1aea4ecd458a45929c29dc2d790717abe58f23d53c

data/README.md

@@ -90,6 +90,37 @@ works if you have tmux integration setup for the countdown:
 
     nmap <leader>t :!thyme -d<cr>
 
+Plugins
+=======
+
+Thyme's functionality can also be extended with plugins.  They'll usually follow this
+format:
+
+    require "thyme_growl"
+    use ThymeGrowl, text: "Go take a break!"
+
+You can create your own plugins.  They implement these methods:
+
+    class MyThymePlugin
+      def initialize(thyme, options={})
+        # `thyme` is an instance of Thyme (see lib/thyme.rb)
+      end
+
+      def before
+        # code to run when timer starts
+      end
+
+      def tick(seconds_left)
+        # code to run each tick
+      end
+
+      def after(seconds_left)
+        # code to run when timer stops
+      end
+    end
+
+The `before`, `tick`, and `after` methods are all optional.
+
 License
 =======
 

data/lib/thyme.rb

@@ -2,7 +2,7 @@ require 'ruby-progressbar'
 require 'date'
 
 class Thyme
-  VERSION = '0.0.13'
+  VERSION = '0.0.14'
   CONFIG_FILE = "#{ENV['HOME']}/.thymerc"
   PID_FILE = "#{ENV['HOME']}/.thyme-pid"
   TMUX_FILE = "#{ENV['HOME']}/.thyme-tmux"
@@ -17,6 +17,11 @@ class Thyme
     @tmux_theme = "#[default]#[fg=%s]%s#[default]" 
     @warning = 5 * 60
     @warning_color = "red,bold"
+    @plugins = []
+  end
+
+  def use(plugin_class, *args, &block)
+    @plugins << plugin_class.new(self, *args, &block)
   end
 
   def run(force=false)
@@ -46,15 +51,15 @@ class Thyme
   end
 
   def before(&block)
-    @before = block
+    hooks_plugin.add(:before, &block)
   end
 
   def after(&block)
-    @after = block
+    hooks_plugin.add(:after, &block)
   end
 
   def tick(&block)
-    @tick = block
+    hooks_plugin.add(:tick, &block)
   end
 
   def option(optparse, short, long, desc, &block)
@@ -67,14 +72,15 @@ class Thyme
   def load_config(optparse)
     return if !File.exists?(CONFIG_FILE)
     app = self
-    Object.class_eval do
+    environment = Class.new do
       define_method(:set) { |opt,val| app.set(opt,val) }
+      define_method(:use) { |plugin,*args,&b| app.use(plugin,*args,&b) }
       define_method(:before) { |&block| app.before(&block) }
       define_method(:after) { |&block| app.after(&block) }
       define_method(:tick) { |&block| app.tick(&block) }
       define_method(:option) { |sh,lo,desc,&b| app.option(optparse,sh,lo,desc,&b) }
-    end
-    load(CONFIG_FILE, true)
+    end.new
+    environment.instance_eval(File.read(CONFIG_FILE), CONFIG_FILE)
   end
 
   def running?
@@ -85,12 +91,12 @@ class Thyme
 
   def start_timer
     File.open(PID_FILE, "w") { |f| f.print(Process.pid) }
-    before_hook = @before
     seconds_start = @break ? @timer_break : @timer
     seconds_left = seconds_start + 1
     start_time = DateTime.now
     min_length = (seconds_left / 60).floor.to_s.length
     tmux_file = File.open(TMUX_FILE, "w") if @tmux
+    started = false
     bar = ENV['THYME_TEST'].nil? && !daemon? ?
       ProgressBar.create(
         title: format(seconds_left-1, min_length),
@@ -112,13 +118,11 @@ class Thyme
         tmux_file.write(@tmux_theme % [fg, title])
         tmux_file.flush
       end
-      if before_hook
-        self.instance_exec(&before_hook)
-        before_hook = nil
-      end
-      if @tick
-        self.instance_exec(seconds_left, &@tick)
+      unless started
+        started = true
+        send_to_plugin :before
       end
+      send_to_plugin :tick, seconds_left
       sleep(@interval)
     end
   rescue SignalException => e
@@ -128,7 +132,7 @@ class Thyme
     File.delete(TMUX_FILE) if File.exists?(TMUX_FILE)
     File.delete(PID_FILE) if File.exists?(PID_FILE)
     seconds_left = [seconds_start - seconds_since(start_time), 0].max
-    self.instance_exec(seconds_left, &@after) if @after
+    send_to_plugin :after, seconds_left
   end
 
   def stop_timer
@@ -139,6 +143,23 @@ class Thyme
     File.delete(PID_FILE) if File.exists?(PID_FILE)
   end
 
+  def send_to_plugin(message, *args)
+    @plugins.each do |plugin|
+      begin
+        plugin.public_send(message, *args) if plugin.respond_to?(message)
+      rescue
+        $stderr.puts "Exception raised from #{plugin.class}:", $!, $@
+      end
+    end
+  end
+
+  def hooks_plugin
+    @hooks_plugin ||= begin
+      use ThymeHooksPlugin
+      @plugins.last
+    end
+  end
+
   def seconds_since(time)
     ((DateTime.now - time) * 24 * 60 * 60).to_i
   end
@@ -159,3 +180,26 @@ class Thyme
 end
 
 class ThymeError < StandardError; end;
+
+class ThymeHooksPlugin
+  def initialize(app)
+    @app = app
+    @hooks = {before: [], tick: [], after: []}
+  end
+
+  def add(type, &block)
+    @hooks[type] << block
+  end
+
+  def before
+    @hooks[:before].each { |b| @app.instance_exec(&b) }
+  end
+
+  def tick(seconds_left)
+    @hooks[:tick].each { |t| @app.instance_exec(seconds_left, &t) }
+  end
+
+  def after(seconds_left)
+    @hooks[:after].each { |a| @app.instance_exec(seconds_left, &a) }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: thyme
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.14
 platform: ruby
 authors:
 - Hugh Bien
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-10 00:00:00.000000000 Z
+date: 2014-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-progressbar
@@ -55,7 +55,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Timer for Pomodoro Technique