thyme 0.0.1

data/LICENSE.md

@@ -0,0 +1,23 @@
+Copyright (c) Hugh Bien
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this list
+of conditions and the following disclaimer.
+
+Redistributions in binary form must reproduce the above copyright notice, this
+list of conditions and the following disclaimer in the documentation and/or
+other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,100 @@
+Description
+===========
+
+Thyme is a console pomodoro timer.
+
+Installation
+============
+
+    $ gem install thyme
+
+Usage
+=====
+
+Start thyme with:
+
+    $ thyme
+    [=.........................] 25m
+
+You'll have 25 minutes by default.  `Ctrl-C` to interrupt.  You can also start
+it in daemon mode, which is only useful if you've got tmux integration to notify
+you of the timer:
+
+    $ thyme -d
+
+To interrupt the timer in daemon mode, simply run `thyme --stop`.  Or wait 25
+minutes for it to kill itself.
+
+Configure
+=========
+
+Thyme is configurable and extensible.  All configurations live in the
+`~/.thymerc` file:
+
+    set :timer, 25
+    set :outfile, "~/.thyme-tmux"
+
+    option :o, :open, 'opens today & records sheets' do
+      `vim -O ~/.thyme-today.md ~/.thyme-records.md`
+    end
+
+    before do
+      puts "Get ready, get set, GO!"
+    end
+
+    after do
+      `mplayer ~/music/wohoo.mp3`
+      `vim -O ~/.thyme-today.md`
+    end
+
+The `set` method sets different configurations.  There are only two:
+
+* `:timer` is the number of minutes to countdown from
+* `:outfile` is the file to write out progress to for tmux integration
+
+The `option` method adds new options to the `thyme` command.  In the above
+example, we can now execute `thyme -o`.  Use `thyme -h` to see available
+options.
+
+The `before` and `after` adds hooks to our timer.  Now before the timer starts,
+STDOUT will receive a message.  After the timer ends, vim will open our today
+sheet.
+
+Integration
+===========
+
+For tmux integration, make sure to set the outfile in `~/.thymerc`:
+
+    set :outfile, "~/.thyme-tmux"
+
+Then in your `.tmux.conf` file:
+
+    set-option -g status-right '#(cat ~/.thyme-tmux)'
+
+For vim integration, I like to execute `thyme -d` to toggle the timer.  This only
+works if you have tmux integration setup for the countdown:
+
+    nmap <leader>t :!thyme -d
+    nmap <leader>T :!thyme -s
+
+TODO
+====
+
+* add directory stucture (binary, lib file, tests, Rakefile, gemspec)
+* add `--help`
+* add 25 minute timer
+* add progress bar
+* add `--daemon` switch and `--stop`
+* add config reader
+* add config `set`
+* add `set :timer`
+* add `set :outfile`
+* add config `option`
+* add config `before` and `after`
+* add color to outfile tmux integration (?)
+
+License
+=======
+
+Copyright Hugh Bien - http://hughbien.com.
+Released under BSD License, see LICENSE.md for more info.

data/thyme

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+require 'optparse'
+require File.expand_path('thyme', File.dirname(__FILE__))
+
+ARGV.options do |o|
+  o.set_summary_indent('  ')
+  o.banner =    "Usage: #{File.basename($0)} [OPTION]"
+  o.define_head "Timer for Pomodoro Technique"
+  o.on('-h', '--help', 'show this help message') { puts o; exit }
+  o.parse!
+  puts o
+end

data/thyme.rb

@@ -0,0 +1,4 @@
+class Thyme
+  VERSION = '0.0.1'
+  CONFIG_FILE = "#{ENV['HOME']}/.thymerc"
+end

data/thyme_test.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require "#{File.dirname(__FILE__)}/thyme"
+require 'minitest/autorun'
+
+class ThymeTest < MiniTest::Unit::TestCase
+  def setup
+  end
+
+  def test_truth
+    assert(true)
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: thyme
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Hugh Bien
+autorequire: 
+bindir: .
+cert_chain: []
+date: 2013-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Extensible and configurable timer for Pomodoro Technique.
+email:
+- hugh@hughbien.com
+executables:
+- thyme
+extensions: []
+extra_rdoc_files: []
+files:
+- thyme.rb
+- thyme_test.rb
+- LICENSE.md
+- README.md
+- thyme
+- ./thyme
+homepage: https://github.com/hughbien/thyme
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Timer for Pomodoro Technique
+test_files: []