comrade 0.0.2 → 0.0.4

data/Gemfile

@@ -1,9 +1,11 @@
+# -*- encoding: utf-8 -*-
+
 source "http://rubygems.org"
-source "http://gems.github.com"
 
-gem 'treetop', '~> 1.4.9'
+gem 'treetop',   '~> 1.4.9'
 gem 'ruby-dzen', '~> 0.0.1'
+gem 'notifier',  '~> 0.1.2'
 
 group :development, :test do
-  gem 'rspec',  '~> 2.2'
+  gem 'rspec',   '~> 2.5.0'
 end

data/Gemfile.lock

@@ -1,17 +1,17 @@
 GEM
   remote: http://rubygems.org/
-  remote: http://gems.github.com/
   specs:
     diff-lcs (1.1.2)
+    notifier (0.1.2)
     polyglot (0.3.1)
-    rspec (2.2.0)
-      rspec-core (~> 2.2)
-      rspec-expectations (~> 2.2)
-      rspec-mocks (~> 2.2)
-    rspec-core (2.2.1)
-    rspec-expectations (2.2.0)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.2.0)
+    rspec-mocks (2.5.0)
     ruby-dzen (0.0.1)
     treetop (1.4.9)
       polyglot (>= 0.3.1)
@@ -20,6 +20,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  rspec (~> 2.2)
+  notifier (~> 0.1.2)
+  rspec (~> 2.5.0)
   ruby-dzen (~> 0.0.1)
   treetop (~> 1.4.9)

data/README.rdoc

@@ -0,0 +1,38 @@
+= About
+
+Comrade is a simple visual timer on top of dzen2.
+It draws a line on the top of your screen that progressively shrinks when the time passes.
+
+= Installing and Usage
+
+    gem install comrade
+
+To use just pass the time period you would like:
+
+    comrade 25m
+    comrade 5 minutes
+    comrade 60 seconds
+    comrade 24 hours
+    comrade 1 second
+    comrade 3s
+
+dzen2 binary is an external dependency, http://sites.google.com/site/gotmor/dzen
+
+= Maintainer
+
+* Renan Mendes Carvalho https://github.com/aitherios/comrade
+
+= License
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/Rakefile

@@ -1,10 +1,12 @@
 # -*- encoding: utf-8 -*-
 
 require 'fileutils'
-require 'lib/version'
 require 'rubygems'
 require 'rspec/core/rake_task'
 
+base_path = File.expand_path File.dirname(__FILE__)
+require File.join(base_path, 'lib', 'comrade', 'version')
+
 RSpec::Core::RakeTask.new
 
 desc 'Build gem'

data/TODO

@@ -1,4 +1,8 @@
 # -*- encoding: utf-8 -*-
 
-* adding comentaries to comrade
+* adding comentaries to comrade binary
 * RDoc
+* add a overview comentary to the comrade module
+* add flags to control some behaviour
+* add a help and usage message
+* keep https://github.com/fnando/notifier in mind

data/bin/comrade

@@ -3,24 +3,47 @@
 
 require 'rubygems'
 require 'dzen'
-require 'comrade'
+require 'notifier'
+require 'comrade/timer'
+require 'comrade/optparse'
+
+@options_hash = Comrade::Optparse.parse! ARGV
+@timer = Comrade::Timer.new @options_hash[:timer] if @options_hash[:timer]
+
+puts @options_hash[:message] unless @options_hash[:quiet]
+exit if @options_hash[:exit]
 
 configure do |c|
   c.interval = 2
-  c.output = IO.popen('dzen2 -h 1 -ta l -bg black -w 1280', 'w')
+  c.output = IO.popen(
+               'dzen2' <<
+                 " -h #{@options_hash[:thickness]}" <<
+                 " -w #{@options_hash[:size]}" <<
+                 " -x #{@options_hash[:xposition]}" <<
+                 " -y #{@options_hash[:yposition]}" <<
+                 ' -ta l' << 
+                 " -bg #{@options_hash[:background_color]}" <<
+                 " -fg #{@options_hash[:color]}" <<
+                 ' -e "onstart=ungrabkeys,ungrabmouse;onnewinput=raise"',
+               'w'
+              )
 end
 
 before_run do
-  @timer = Comrade::Timer.new ARGV.join(' ').downcase
-  puts 'Started at ' << DateTime.now.to_s
+  puts 'Started @ ' << Time.now.to_s unless @options_hash[:quiet]
 end
 
 app :line do
-  if @timer.elapsed?
-    puts 'Stopped at ' << DateTime.now.to_s
+  if @timer.finished? and @timer.loop?
+    Notifier.notify :title => 'comrade', :message => ARGV.join(' ')
+    puts 'Another loop @ ' << Time.now.to_s unless @options_hash[:quiet]
+    @timer = Comrade::Timer.new @options_hash[:timer]
+  elsif @timer.finished?
+    Notifier.notify :title => 'comrade', :message => ARGV.join(' ')
+    echo 'Stopped @ ' << Time.now.to_s
     Process.kill('INT', $$)
-  else
-    line_width = (@timer.remaining_ratio * 1280).round
-    "^fg(red)^r(#{line_width}x1)"
   end
+
+  line_size = (@timer.remaining_ratio * @options_hash[:size].to_f).round
+  "^r(#{line_size}x#{@options_hash[:thickness]})"
 end

data/comrade.gemspec

@@ -1,7 +1,8 @@
 #!/usr/bin/env gem build
 # -*- encoding: utf-8 -*-
 
-require 'lib/version'
+base_path = File.expand_path File.dirname(__FILE__)
+require File.join(base_path, 'lib', 'comrade', 'version')
 
 Gem::Specification.new do |g|
   g.name = 'comrade'
@@ -9,20 +10,21 @@ Gem::Specification.new do |g|
   g.author = 'Renan Mendes Carvalho'
   g.email = 'aitherios@gmail.com'
   g.homepage = 'http://github.com/aitherios/comrade'
+  g.license = 'GPL-3'
   g.summary = 'Simple visual timer on top of dzen2.'
   g.description = 'Comrade is a simple visual timer on top of dzen2.' << 
-                  'It draws a line on your screen that progressively shrinks when the time passes.'
-  g.cert_chain = nil
-  g.rubyforge_project = 'Comrade'
+                  ' It draws a line on your screen that progressively shrinks when the time passes.' <<
+                  ' After that it notifies you when the time is over.'
 
   g.files = `git ls-files`.split("\n")
+  g.test_files = Dir.glob('spec/**/*_spec.rb')
   g.executables = Dir['bin/*'].map(&File.method(:basename))
-  g.require_path = 'lib'
 
   g.required_ruby_version = ::Gem::Requirement.new '> 1.8'
   g.add_dependency 'treetop',                      '~> 1.4.9'
   g.add_dependency 'ruby-dzen',                    '~> 0.0.1'
+  g.add_dependency 'notifier',                     '~> 0.1.2'
   g.add_development_dependency 'bundler',          '~> 1.0'
-  g.add_development_dependency 'rspec',            '~> 2.2'
+  g.add_development_dependency 'rspec',            '~> 2.5.0'
   g.requirements << 'dzen2, tested with version 0.8.5, http://sites.google.com/site/gotmor/dzen'
 end

data/lib/comrade/optparse.rb

@@ -0,0 +1,81 @@
+# -*- encoding: utf-8 -*-
+
+module Comrade
+  require 'optparse'
+
+  base_path = File.expand_path File.dirname(__FILE__)
+  # Comrade version file
+  require File.join(base_path, 'version')
+  
+  class Optparse
+    def self.parse! args
+      hash = {}
+      OptionParser.new do |opts|
+        opts.banner = 'Usage: comrade [options] [time]'
+
+        opts.separator ''
+        opts.separator 'Optional arguments:'
+
+        hash[:color] = 'red'
+        opts.on('-c', '--color COLOR', '--colour COLOR', String, 'Line color') do |color|
+          hash[:color] = color.strip
+        end
+
+        hash[:background_color] = 'black'
+        opts.on('-b', '--background COLOR', String, 'Line background color') do |color|
+          hash[:background_color] = color.strip
+        end
+
+        hash[:size] = `xrandr`.grep(/\*/)[0].match(/\d+/)[0]
+        opts.on('-s', '--size SIZE', Integer, 'Line size in pixels') do |size|
+          hash[:size] = size
+        end
+
+        hash[:thickness] = 1
+        opts.on('-t', '--thickness THICKNESS', Integer, 'Line thickness in pixels') do |thickness|
+          hash[:thickness] = thickness
+        end
+
+        hash[:xposition] = 0
+        opts.on('-x X', Integer, 'X axis position in pixels') do |x|
+          hash[:xposition] = x
+        end
+
+        hash[:yposition] = 0
+        opts.on('-y Y', Integer, 'Y axis position in pixels') do |y|
+          hash[:yposition] = y
+        end
+
+        opts.separator ''
+        opts.separator 'Common arguments:'
+
+        hash[:quiet] = false
+        opts.on_tail('-q', '--quiet', 'Keep quiet, doesn\'t print any text') do
+          hash[:quiet] = true
+        end
+
+        hash[:exit] = false
+        hash[:message] = ''
+
+        opts.on_tail('-h', '--help', 'Show this message') do
+          hash[:message] = opts.to_s
+          hash[:exit] = true
+        end
+
+        opts.on_tail('--version', 'Show version') do
+          hash[:message] = "comrade version #{Comrade::VERSION} \n\n" <<
+                           "Copyright (C) 2010 Free Software Foundation, Inc.\n" <<
+                           "License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.\n" <<
+                           "This is free software: you are free to change and redistribute it.\n" <<
+                           "There is NO WARRANTY, to the extent permitted by law.\n" <<
+                           "Written by Renan Mendes Carvalho.\n"
+          hash[:exit] = true
+        end
+      end.parse! args
+
+      hash[:timer] = args.join(' ') unless args.empty?
+
+      hash
+    end
+  end
+end

data/lib/{comrade.rb → comrade/timer.rb}

@@ -1,73 +1,73 @@
 # -*- encoding: utf-8 -*-
 
-require 'date'
-class DateTime
-  # Returns the Unix time, also know as POSIX time or Unix epoch.
-  # The number of seconds elapsed since midnight of January 1, 1970 UTC
-  # [return] Fixnum
-  def unix_time
-    strftime('%s').to_i
-  end
-end
-
 module Comrade
-  require 'version'
   require 'rubygems'
   require 'treetop'
 
   base_path = File.expand_path File.dirname(__FILE__)
   # Treetop grammar used to parse time period inputs
-  Treetop.load File.join(base_path, 'period_grammar.treetop')
+  Treetop.load File.join(base_path, '..', 'period_grammar.treetop')
+  # Comrade version file
+  require File.join(base_path, 'version')
+  # DateTime class append
+  require File.join(base_path, '..', 'date')
 
-  class Timer
 
+  class Timer
     # Initializes the variables started_at and stops_at
     # [param] time_period_string string to be parsed by treetop
-    def initialize time_period_string
-      @started_at = DateTime.now
-      @stops_at = @started_at + period_in_days(time_period_string)
+    def initialize string
+      @started_at = Time.now
+
+      @parsed = parse string
+      if @parsed.timestamp?
+        date = DateTime.parse "#{@parsed.input}#{@started_at.zone}"
+        @stops_at = date > @started_at ? date : date + 1
+      else
+        @stops_at = @started_at + @parsed.to_seconds
+      end
     end
 
     # Elapsed time ratio
-    # Starts at 1.0 and goes down to 0.0
+    # Starts at 0.0 and goes up to 1.0
     # [return] Float
-    def elapsed_ratio; elapsed_seconds.to_f / total_seconds.to_f end
+    def elapsed_ratio
+      ratio = elapsed_seconds.to_f / total_seconds.to_f
+      ratio > 1.0 ? 1.0 : ratio
+    end
 
     # Elapsed time percentage
-    # Starts at 100 and goes down to 0
+    # Starts at 0 and goes up to 100
     # [return] Float
     def elapsed_percentage; elapsed_ratio * 100 end
     
     # Remaining time ratio
-    # Starts at 0.0 and goes to 1.0
+    # Starts at 1.0 and goes down to 0.0
     # [return] Float
-    def remaining_ratio; 1 - elapsed_ratio end
+    def remaining_ratio;1 - elapsed_ratio end
 
     # Remaining time percentage
-    # Starts at 0 and goes down to 100
+    # Starts at 100 and goes down to 0
     # [return] Float
     def remaining_percentage; remaining_ratio * 100 end
 
     # Return if the time has elapsed
-    def elapsed?
-      DateTime.now >= @stops_at
-    end
+    def elapsed?; elapsed_ratio >= 1.0 end
     alias :finished? :elapsed?
 
+    # Timer should loop
+    def loop?
+      @parsed.loop?
+    end
+
     private
     
-    def period_in_days time_period_string
-      parsed = PeriodParser.new.parse time_period_string
-
+    # Parses the input using the PeriodParser
+    # raises 'Parsing Error' if parsing unsuccessful
+    def parse string
+      parsed = PeriodParser.new.parse string
       raise 'Parsing Error' if parsed.nil?
-
-      if parsed.time_unit.second?
-        parsed.number.text_value.to_f / 86400
-      elsif parsed.time_unit.minute?
-        parsed.number.text_value.to_f / 1440
-      elsif parsed.time_unit.hour?
-        parsed.number.text_value.to_f / 24
-      end
+      parsed
     end
 
     # Seconds between timer start and expected end
@@ -79,7 +79,7 @@ module Comrade
     # Elapsed seconds since timer started
     # [return] Fixnum
     def elapsed_seconds
-      DateTime.now.unix_time - @started_at.unix_time
+      Time.now.unix_time - @started_at.unix_time
     end
 
   end

data/lib/comrade/version.rb

@@ -0,0 +1,5 @@
+# -*- encoding: utf-8 -*-
+
+module Comrade
+  VERSION = '0.0.4' unless constants.include? 'VERSION'
+end

data/lib/date.rb

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+
+require 'date'
+
+class DateTime
+  # Returns the Unix time, also know as POSIX time or Unix epoch.
+  # The number of seconds elapsed since midnight of January 1, 1970 UTC
+  # [return] Fixnum
+  def unix_time
+    strftime('%s').to_f
+  end
+end
+
+class Time
+  # Returns the Unix time, also know as POSIX time or Unix epoch.
+  # The number of seconds elapsed since midnight of January 1, 1970 UTC
+  # [return] Fixnum
+  def unix_time
+    strftime('%s').to_f
+  end
+end

data/lib/period_grammar.treetop

@@ -3,17 +3,61 @@
 grammar Period
 
   rule period
-    [\s]* number [\s]* time_unit
+    ( 
+      number 
+      [\s]* 
+      time_unit 
+      [\s]*
+      loop:loop?
+      {
+        def timestamp?; false end
+        
+        def to_seconds
+          if time_unit.second?
+            number.text_value.to_f
+          elsif time_unit.minute?
+            number.text_value.to_f * 60
+          elsif time_unit.hour?
+            number.text_value.to_f * 60 * 24
+          end
+        end
+
+        def to_days
+          if time_unit.second?
+            number.text_value.to_f / 86400
+          elsif time_unit.minute?
+            number.text_value.to_f / 1440
+          elsif time_unit.hour?
+            number.text_value.to_f / 24
+          end
+        end
+
+        def loop?; not loop.text_value.empty? end
+      }
+    )
+    / 
+    ( 
+      timestamp 
+      {
+        def timestamp?; true end
+      }
+    )
   end
 
   rule number
-    [0-9]+
+    [\d]+
   end
 
   rule time_unit
     second / minute / hour
   end
 
+  rule timestamp
+    hour:[\d]1..2 ':' minute:[\d]2..2 
+    (':' second:[\d]2..2)?
+    ([\s]* 'am' / 'pm')?
+  end
+
   rule word_end
     !(!' ' .)
   end
@@ -21,9 +65,9 @@ grammar Period
   rule second
     (en_second / pt_second)
     {
-      def second?; true; end
-      def minute?; false; end
-      def hour?; false; end
+      def second?; true end
+      def minute?; false end
+      def hour?; false end
     }
   end
 
@@ -54,9 +98,9 @@ grammar Period
   rule minute
     (en_minute / pt_minute)
     {
-      def minute?; true; end
-      def second?; false; end
-      def hour?; false; end
+      def minute?; true end
+      def second?; false end
+      def hour?; false end
     }
   end
 
@@ -87,9 +131,9 @@ grammar Period
   rule hour
     (en_hour / pt_hour)
     {
-      def hour?; true; end
-      def second?; false; end
-      def minute?; false; end
+      def hour?; true end
+      def second?; false end
+      def minute?; false end
     }
   end
 
@@ -109,4 +153,8 @@ grammar Period
     'h' word_end
   end
 
+  rule loop
+    'loop'
+  end
+
 end

data/spec/optparse_spec.rb

@@ -0,0 +1,184 @@
+# -*- encoding: utf-8 -*-
+
+require 'spec_helper'
+
+describe Comrade::Optparse do
+
+  describe 'parse' do
+
+    it { Comrade::Optparse.parse!(['']).should be_an_instance_of Hash }
+    it { Comrade::Optparse.parse!(['-h']).should be_an_instance_of Hash }
+
+    context 'when parsing help flag' do
+      context 'short style' do
+        subject { Comrade::Optparse.parse! ['-h'] }
+        its([:message]) { should be_an_instance_of String }
+        its([:message]) { should_not be_empty }
+        its([:exit]) { should be_true }
+      end
+
+      context 'long style' do
+        subject { Comrade::Optparse.parse! ['--help'] }
+        its([:message]) { should be_an_instance_of String }
+        its([:message]) { should_not be_empty }
+        its([:exit]) { should be_true }
+      end
+    end
+
+    context 'when parsing version flag' do
+      subject { Comrade::Optparse.parse! ['--version'] }
+      its([:message]) { should be_an_instance_of String }
+      its([:message]) { should_not be_empty }
+      its([:exit]) { should be_true }
+    end
+
+    describe '[:color]', 'line color flag' do
+      context 'short style' do
+        subject { Comrade::Optparse.parse! ['-c', 'blue'] }
+        its([:color]) { should be_an_instance_of String }
+        its([:color]) { should_not be_empty }
+        its([:color]) { should == 'blue' }
+      end
+
+      context 'long style' do
+        subject { Comrade::Optparse.parse! ['--color', 'blue'] }
+        its([:color]) { should be_an_instance_of String }
+        its([:color]) { should_not be_empty }
+        its([:color]) { should == 'blue' }
+      end
+
+      context 'long style, british spelling' do
+        subject { Comrade::Optparse.parse! ['--colour', 'blue'] }
+        its([:color]) { should be_an_instance_of String }
+        its([:color]) { should_not be_empty }
+        its([:color]) { should == 'blue' }
+      end
+
+      context 'default value' do
+        subject { Comrade::Optparse.parse! ['25m'] }
+        its([:color]) { should be_an_instance_of String }
+        its([:color]) { should_not be_empty }
+        its([:color]) { should == 'red' }
+      end
+    end
+
+    describe '[:size]', 'line size flag' do
+      context 'short style' do
+        subject { Comrade::Optparse.parse! ['-s', '250'] }
+        its([:size]) { should be_an_instance_of Fixnum }
+        its([:size]) { should == 250 }
+      end
+
+      context 'long style' do
+        subject { Comrade::Optparse.parse! ['--size', '250'] }
+        its([:size]) { should be_an_instance_of Fixnum }
+        its([:size]) { should == 250 }
+      end
+
+      context 'default value' do
+        subject { Comrade::Optparse.parse! ['25m'] }
+        its([:size]) { should be_an_instance_of Fixnum }
+        its([:size]) { should == 1280 }
+      end
+    end
+
+    describe '[:thickness]', 'line thickness flag' do
+      context 'short style' do
+        subject { Comrade::Optparse.parse! ['-t', '250'] }
+        its([:thickness]) { should be_an_instance_of Fixnum }
+        its([:thickness]) { should == 250 }
+      end
+
+      context 'long style' do
+        subject { Comrade::Optparse.parse! ['--thickness', '250'] }
+        its([:thickness]) { should be_an_instance_of Fixnum }
+        its([:thickness]) { should == 250 }
+      end
+      
+      context 'default value' do
+        subject { Comrade::Optparse.parse! ['25m'] }
+        its([:thickness]) { should be_an_instance_of Fixnum }
+        its([:thickness]) { should == 1 }
+      end
+    end
+
+    describe '[:timer]', 'timer arguments' do
+      context 'without a loop' do
+        subject { Comrade::Optparse.parse! ['-t', '250', '25m'] }
+        its([:timer]) { should == '25m' }
+      end
+
+      context 'with a loop' do
+        subject { Comrade::Optparse.parse! ['-t', '250', '25m', 'loop'] }
+        its([:timer]) { should == '25m loop' }
+      end
+    end
+    
+    describe '[:xposition]', 'screen x position flag' do
+      context 'short style' do
+        subject { Comrade::Optparse.parse! ['-x', '300'] }
+        its([:xposition]) { should be_an_instance_of Fixnum }
+        its([:xposition]) { should == 300 }
+      end
+
+      context 'default value' do
+        subject { Comrade::Optparse.parse! ['25m'] }
+        its([:xposition]) { should be_an_instance_of Fixnum }
+        its([:xposition]) { should == 0 }
+      end
+    end
+
+    describe '[:yposition]', 'screen x position flag' do
+      context 'short style' do
+        subject { Comrade::Optparse.parse! ['-y', '300'] }
+        its([:yposition]) { should be_an_instance_of Fixnum }
+        its([:yposition]) { should == 300 }
+      end
+
+      context 'default value' do
+        subject { Comrade::Optparse.parse! ['25m'] }
+        its([:yposition]) { should be_an_instance_of Fixnum }
+        its([:yposition]) { should == 0 }
+      end
+    end
+
+    describe '[:background_color]', 'line background color flag' do
+      context 'short style' do
+        subject { Comrade::Optparse.parse! ['-b', 'red'] }
+        its([:background_color]) { should be_an_instance_of String }
+        its([:background_color]) { should == 'red' }
+      end
+
+      context 'long style' do
+        subject { Comrade::Optparse.parse! ['--background', 'red'] }
+        its([:background_color]) { should be_an_instance_of String }
+        its([:background_color]) { should == 'red' }
+      end
+
+      context 'default value' do
+        subject { Comrade::Optparse.parse! ['25m'] }
+        its([:background_color]) { should be_an_instance_of String }
+        its([:background_color]) { should == 'black' }
+      end
+    end
+
+    describe '[:quiet]', 'quiet flag' do
+      context 'short style' do
+        subject { Comrade::Optparse.parse! ['-q', '25m'] }
+        its([:quiet]) { should be_true }
+      end
+
+      context 'long style' do
+        subject { Comrade::Optparse.parse! ['--quiet', '25m'] }
+        its([:quiet]) { should be_true }
+      end
+
+      context 'default value' do
+        subject { Comrade::Optparse.parse! ['25m'] }
+        its([:quiet]) { should be_false }
+      end
+    end
+
+  end
+
+end

data/spec/period_grammar_spec.rb

@@ -48,5 +48,19 @@ describe PeriodParser do
       it { should parse '1 hora' }
       it { should parse '2 horas' }
     end
+
+    context 'when parsing a timestamp' do
+      it { should parse '1:30' }
+      it { should parse '23:30' }
+      it { should parse '23:30:21' }
+      it { should parse '11:30 am' }
+      it { should parse '11:30pm' }
+    end
+
+    context 'when parsing a time period with the loop option' do
+      it { should parse '1 hour loop' }
+      it { should parse '25 minutes loop' }
+    end
+
   end
 end

data/spec/spec_helper.rb

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 
-# requiring comrade module
 base_path = File.expand_path File.dirname(__FILE__)
-require File.join(base_path, '..', 'lib', 'comrade')
-# requiring support directory
-Dir[File.join base_path, 'support/**/*.rb'].each {|f| require f}
+# comrade module
+Dir[File.join base_path, '../lib/comrade/**/*.rb'].each { |f| require f }
+# support directory
+Dir[File.join base_path, 'support/**/*.rb'].each { |f| require f }

data/spec/support/construct_matcher.rb

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+
+RSpec::Matchers.define :construct do |string, opts|
+  match do |object|
+    begin
+      object.new string
+    rescue
+      false
+    end
+  end
+
+  failure_message_for_should do |object|
+    "expected that #{object} would #{description}"
+  end
+
+  failure_message_for_should_not do |object|
+    "expected that #{object} would not #{description}"
+  end
+
+  description do
+    "be created with with '#{string}'"
+  end
+end

data/spec/support/parse_matcher.rb

@@ -5,11 +5,11 @@ RSpec::Matchers.define :parse do |string, opts|
     parser.parse(string) != nil
   end
 
-  failure_message_for_should do |array|
+  failure_message_for_should do |parser|
     "expected that #{parser} would #{description}"
   end
 
-  failure_message_for_should_not do |array|
+  failure_message_for_should_not do |parser|
     "expected that #{parser} would not #{description}"
   end
 

data/spec/timer_spec.rb

@@ -0,0 +1,75 @@
+# -*- encoding: utf-8 -*-
+
+require 'spec_helper'
+
+describe Comrade::Timer do
+
+  describe 'new' do
+    subject { Comrade::Timer }
+    it { should_not construct '' }
+    it { should construct '60 seconds' }
+    it { should construct '24h' }
+    it { should construct '13:37' }
+    it { should construct '25m loop' }
+  end
+
+  context 'beeing initialized with 10 seconds' do
+    before { @timer = Comrade::Timer.new '10 seconds' }
+    subject { @timer }
+  
+    context 'when elapsed seconds is 0' do
+      before { @timer.should_receive(:elapsed_seconds).any_number_of_times.and_return(0) }
+      its(:elapsed_ratio) { should == 0.0 }
+      its(:elapsed_percentage) { should == 0 }
+      its(:remaining_ratio) { should == 1.0 }
+      its(:remaining_percentage) { should == 100 }
+      its(:elapsed?) { should be_false }
+    end
+  
+    context 'when elapsed seconds is 5' do
+      before { @timer.should_receive(:elapsed_seconds).any_number_of_times.and_return(5) }
+      its(:elapsed_ratio) { should == 0.5 }
+      its(:elapsed_percentage) { should == 50 }
+      its(:remaining_ratio) { should == 0.5 }
+      its(:remaining_percentage) { should == 50 }
+      its(:elapsed?) { should be_false }
+    end
+  
+    context 'when elapsed seconds is 10' do
+      before { @timer.should_receive(:elapsed_seconds).any_number_of_times.and_return(10) }
+      its(:elapsed_ratio) { should == 1.0 }
+      its(:elapsed_percentage) { should == 100 }
+      its(:remaining_ratio) { should == 0.0 }
+      its(:remaining_percentage) { should == 0 }
+      its(:elapsed?) { should be_true }
+    end
+  
+    context 'when elapsed seconds greater than 10' do
+      before { @timer.should_receive(:elapsed_seconds).any_number_of_times.and_return(12) }
+      its(:elapsed_ratio) { should == 1.0 }
+      its(:elapsed_percentage) { should == 100 }
+      its(:remaining_ratio) { should == 0.0 }
+      its(:remaining_percentage) { should == 0 }
+      its(:elapsed?) { should be_true }
+    end
+  end
+
+  context 'when concerning the loop option' do
+    context 'present' do
+      before { @timer = Comrade::Timer.new '10 seconds loop' }
+      subject { @timer }
+
+      it { should respond_to :loop? }
+      its(:loop?) { should be_true }
+    end
+
+    context 'missing' do
+      before { @timer = Comrade::Timer.new '10 seconds' }
+      subject { @timer }
+
+      it { should respond_to :loop? }
+      its(:loop?) { should be_false }
+    end
+  end
+
+end

metadata

@@ -1,28 +1,31 @@
 --- !ruby/object:Gem::Specification 
 name: comrade
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 23
+  prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Renan Mendes Carvalho
 autorequire: 
 bindir: bin
-cert_chain: 
-date: 2011-01-27 00:00:00 -02:00
-default_executable: 
+cert_chain: []
+
+date: 2011-07-29 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: treetop
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 21
         segments: 
         - 1
         - 4
@@ -34,9 +37,11 @@ dependencies:
   name: ruby-dzen
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 29
         segments: 
         - 0
         - 0
@@ -45,36 +50,56 @@ dependencies:
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: bundler
+  name: notifier
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 0
+        - 1
+        - 2
+        version: 0.1.2
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
         segments: 
         - 1
         - 0
         version: "1.0"
   type: :development
-  version_requirements: *id003
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 27
         segments: 
         - 2
-        - 2
-        version: "2.2"
+        - 5
+        - 0
+        version: 2.5.0
   type: :development
-  version_requirements: *id004
-description: Comrade is a simple visual timer on top of dzen2.It draws a line on your screen that progressively shrinks when the time passes.
+  version_requirements: *id005
+description: Comrade is a simple visual timer on top of dzen2. It draws a line on your screen that progressively shrinks when the time passes. After that it notifies you when the time is over.
 email: aitherios@gmail.com
 executables: 
 - comrade
-- comrade~
 extensions: []
 
 extra_rdoc_files: []
@@ -91,42 +116,52 @@ files:
 - bin/comrade
 - comrade.gemspec
 - gpl-3.0.txt
-- lib/comrade.rb
+- lib/comrade/optparse.rb
+- lib/comrade/timer.rb
+- lib/comrade/version.rb
+- lib/date.rb
 - lib/period_grammar.treetop
-- lib/version.rb
+- spec/optparse_spec.rb
 - spec/period_grammar_spec.rb
 - spec/spec_helper.rb
+- spec/support/construct_matcher.rb
 - spec/support/parse_matcher.rb
-has_rdoc: true
+- spec/timer_spec.rb
 homepage: http://github.com/aitherios/comrade
-licenses: []
-
+licenses: 
+- GPL-3
 post_install_message: 
 rdoc_options: []
 
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">"
     - !ruby/object:Gem::Version 
+      hash: 31
       segments: 
       - 1
       - 8
       version: "1.8"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: 
 - dzen2, tested with version 0.8.5, http://sites.google.com/site/gotmor/dzen
-rubyforge_project: Comrade
-rubygems_version: 1.3.6
+rubyforge_project: 
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
 summary: Simple visual timer on top of dzen2.
-test_files: []
-
+test_files: 
+- spec/timer_spec.rb
+- spec/optparse_spec.rb
+- spec/period_grammar_spec.rb

data/bin/comrade~

@@ -1,56 +0,0 @@
-#!/usr/bin/env ruby
-# encoding: utf-8
-
-require 'rubygems'
-require 'dzen'
-
-include DZEN::Helpers
-
-# configure the output
-# these are the defaults,
-# change them if necessary, otherwise you can remove this block
-# `interval` and `output` are just two possible options,
-# see dzen/base.rb for more options
-configure do |c|
-  c.interval = 3
-
-  # output can be anything,
-  # just make sure it has #puts and #print
-  writeme = IO.popen("dzen2", "w")
-  c.output = writeme
-end
-
-before_run do
-  "--- loading ---#{DZEN::Base::Config[:ending]}"
-end
-
-# change order if necessary
-# without this the apps are displayed in the order they are defined
-# if an app is defined but not in this order list,
-# it wont be displayed at all
-#order :pidgin, :gajim, :loadavg
-
-# each little app has to return a string to be displayed
-
-# show hdd temperature
-# the hddtemp daemon should be running
-app :hdd_temp do
-  "HDD: #{`nc localhost 7634`.split(/\|/)[-2]}°C"
-end
-
-# show cpu temperature using the `sensors` program
-# and display the current frequency
-app :cpu do
-  "CPU: #{`sensors`.scan(/Core \d:\s+\+(\d+)\.\d/).flatten.map{|e|"#{e}°C"}.join("/")} " +
-  IO.read("/proc/cpuinfo").scan(/^cpu MHz\s+:\s+(\d+)/).flatten.map{|e|"%.1fGhz" % (e.to_i/1000.0)}.join("/")
-end
-
-# display the current load average
-app :loadavg do
-  IO.read('/proc/loadavg').split(/ /)[0,3].join(' ')
-end
-
-# display the time
-app :time do
-  Time.now.strftime("%d.%m.%Y %H:%M")
-end

data/lib/version.rb

@@ -1,5 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-module Comrade
-  VERSION = "0.0.2"
-end