thyme 0.0.15 → 0.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2bd7f6b22e1eb3fb5b2cc353f25948207113f722
-  data.tar.gz: 9de5a45b3b793806536927db3e4464d157e5ab95
+SHA256:
+  metadata.gz: 5abf29ab5c23ad3c627e59ba2359fe9edadd4e29d3a9867a8bd5544bc3f4b9a1
+  data.tar.gz: 843d993b305a5e72067ba9e426f0b840fdc3f5f352c092fb3dff46087558c809
 SHA512:
-  metadata.gz: 3d1a24078f5c3d2ce251ef8c2b04010e32140a1206548dfec3d4771179ae2a7bf6c8eb890b1106a0db7c855929afb5e4c1057e4ea4e7fc7c6c9b67bb8fc89bb9
-  data.tar.gz: 7167e5a067fc49605767fd18a9d13b05a6d430b56a1b809f6c270894897d300ad216441939bfb66a42300354ad8cfed78e4e5bb5cd6bee5a2a99dadf3c7889ae
+  metadata.gz: 8258374971ba89526629690016690128b84cd3ba7a77adfaead03cdac0f463db4df4dbf02462938194f64483a9bd2f16fdd0a96c73a3f4a659745ffa401c4c52
+  data.tar.gz: 9bf433d64f8268e896a385e49777bb25d279f2b98af52bfc24c5598710dc1635a2161a54de9012aad992f762c9148b56dd45b816d699dc34e3322c7dad7d0796

data/README.md

@@ -47,7 +47,7 @@ Configurations live in the `~/.thymerc` file:
     # adds `-s --seconds num` option, which allows on the fly timer
     option :s, 'seconds num', 'run with custom seconds' do |num|
       set :timer, num.to_i
-      run
+      @run = true
     end
 
     # execute hook before thyme program starts
@@ -99,6 +99,11 @@ You can create your own plugins. They implement these methods:
     class MyThymePlugin
       def initialize(thyme, options={})
         # `thyme` is an instance of Thyme::Config (see lib/thyme/config.rb)
+
+        # adds `-t --today` option, which opens a text file in vim
+        thyme.option :t, :today, 'open today sheet' do
+          `vim -O ~/.thyme-today.md ~/.thyme-records.md < \`tty\` > \`tty\``
+        end
       end
 
       def before_all

data/lib/thyme/config.rb

@@ -1,15 +1,18 @@
 module Thyme
+  # Configure state for the application. This can be done via the thymerc file or CLI flags.
+  # Public methods in this file are exposed to the thymerc file.
   class Config
     CONFIG_FILE = "#{ENV['HOME']}/.thymerc"
     PID_FILE = "#{ENV['HOME']}/.thyme-pid"
     TMUX_FILE = "#{ENV['HOME']}/.thyme-tmux"
-    OPTIONS = [:break_color, :interval, :timer, :timer_break, :tmux, :tmux_theme, :warning, :warning_color]
+    OPTIONS = [:default_color, :break_color, :interval, :timer, :timer_break, :tmux, :tmux_theme, :warning, :warning_color]
     OPTIONS.each { |opt| attr_reader(opt) }
-    attr_accessor :break, :daemon, :repeat, :repeat_index
+    attr_accessor :break, :daemon, :repeat, :repeat_index, :optparse
 
     def initialize
       # options set via config file
       @break_color = 'default'
+      @default_color = 'default'
       @interval = 1
       @timer = 25 * 60
       @timer_break = 5 * 60
@@ -54,8 +57,9 @@ module Thyme
       @hooks_plugin.add(:tick, &block)
     end
 
-    def option(optparse, short, long, desc, &block)
-      optparse.on("-#{short}", "--#{long}", desc) do |*args|
+    def option(short, long, desc, &block)
+      return if !@optparse
+      @optparse.on("-#{short}", "--#{long}", desc) do |*args|
         self.instance_exec(*args, &block)
         exit if !@run
       end

data/lib/thyme/console.rb

@@ -1,4 +1,5 @@
 module Thyme
+  # Exposes application to the CLI in bin/thyme
   class Console
     attr_accessor :config
 
@@ -27,16 +28,18 @@ module Thyme
       timer.run
     end
 
+    # Loads the thymerc configuration file. Requires optparse b/c users can extend CLI via thymerc
     def load(optparse, &block)
       return if block.nil? && !File.exists?(Config::CONFIG_FILE)
       config = @config
+      config.optparse = optparse
       environment = Class.new do
         define_method(:set) { |opt,val| config.set(opt,val) }
         define_method(:use) { |plugin,*args,&b| config.use(plugin,*args,&b) }
         define_method(:before) { |*args,&block| config.before(*args,&block) }
         define_method(:after) { |*args,&block| config.after(*args,&block) }
         define_method(:tick) { |&block| config.tick(&block) }
-        define_method(:option) { |sh,lo,desc,&b| config.option(optparse,sh,lo,desc,&b) }
+        define_method(:option) { |sh,lo,desc,&b| config.option(sh,lo,desc,&b) }
       end.new
 
       if block # for test environment

data/lib/thyme/error.rb

@@ -1,4 +1,4 @@
 module Thyme
-  class Error < StandardError; end
-  class StopTimer < StandardError; end
+  class Error < StandardError; end # catch all error for Thyme
+  class StopTimer < StandardError; end # used to stop repeat timers
 end

data/lib/thyme/format.rb

@@ -1,4 +1,5 @@
 module Thyme
+  # Methods used to nicely format output to the user
   class Format
     def initialize(config)
       @config = config
@@ -8,6 +9,7 @@ module Thyme
       ((DateTime.now - time) * 24 * 60 * 60).to_i
     end
 
+    # Displays time depending on configured interval eg. 15m OR 15:20
     def time_left(seconds, min_length)
       min = (seconds / 60).floor
       lead = ' ' * [0, min_length - min.to_s.length].max
@@ -34,7 +36,7 @@ module Thyme
       elsif seconds < @config.warning
         @config.warning_color
       else
-        'default'
+        @config.default_color
       end
     end
   end

data/lib/thyme/hooks_plugin.rb

@@ -1,4 +1,5 @@
 module Thyme
+  # Generic plugin for users to run Ruby code in Thyme event callbacks in thymerc
   class HooksPlugin
     def initialize(config)
       @config = config

data/lib/thyme/timer.rb

@@ -1,4 +1,5 @@
 module Thyme
+  # The actual timer logic where you can pause, unpause, or stop one or more timers
   class Timer
     def initialize(config)
       @config = config
@@ -40,6 +41,7 @@ module Thyme
 
     private
 
+    # TODO: refactor this method, too large!
     def run_single
       seconds_total = @config.break ? @config.timer_break : @config.timer
       seconds_left = seconds_total + 1
@@ -107,6 +109,8 @@ module Thyme
       @config.repeat == @config.repeat_index
     end
 
+    # Since timers can be daemonized, we'll use Unix signals to trigger events such as
+    # pause/unpause in a separate process.
     def send_signal(signal)
       pid = File.read(Config::PID_FILE).to_i
       Process.kill(signal, pid) if pid > 1

data/lib/thyme/tmux.rb

@@ -1,4 +1,6 @@
 module Thyme
+  # Provides tmux integration. Thyme outputs the timer to TMUX_FILE. Tmux reads this file and
+  # outputs to its bar.
   class Tmux
     def initialize(config)
       @config = config

data/lib/thyme/version.rb

@@ -1,3 +1,3 @@
 module Thyme
-  VERSION = '0.0.15'
+  VERSION = '0.0.16'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: thyme
 version: !ruby/object:Gem::Version
-  version: 0.0.15
+  version: 0.0.16
 platform: ruby
 authors:
 - Hugh Bien
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-01 00:00:00.000000000 Z
+date: 2020-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-progressbar
@@ -63,8 +63,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Timer for Pomodoro Technique