timer 0.1.0 → 0.1.1

data/Rakefile

@@ -6,12 +6,14 @@ begin
   Jeweler::Tasks.new do |gem|
     gem.name = "timer"
     gem.summary = %Q{Simple timer to perform a block and display the elapsed time}
-    gem.description = %Q{Simple timer to perform a block and display the elapsed time}
+    gem.description = %Q{Simple timer to perform a block and display the elapsed time. Growls message if growl is turned on.}
     gem.email = "progressions@gmail.com"
     gem.homepage = "http://github.com/progressions/timer"
     gem.authors = ["Jeff Coleman"]
     gem.add_development_dependency "ruby-growl", ">= 0"
     gem.add_development_dependency "progressions-g", ">= 0"
+    gem.add_development_dependency "rspec", ">= 0"
+    gem.add_development_dependency "timecop", ">= 0"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new
@@ -19,36 +21,9 @@ rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/test_*.rb'
-    test.verbose = true
-  end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
-  end
-end
-
-task :test => :check_dependencies
-
-task :default => :test
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "timer #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+require 'spec/rake/spectask'
+desc 'run all specs'
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = ['-c']
 end

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/timer.rb

@@ -2,43 +2,42 @@ require 'rubygems'
 require 'g'
 
 class Timer
-  attr_accessor :timer_title, :growl
+  attr_accessor :title, :growl
   
   def initialize(options={})
-    @timer_title = options[:title]
-    if options[:growl] == nil
-      options[:growl] = true
+    @title = options[:title]
+    @growl = true
+    if options.has_key?(:growl)
+      @growl = options[:growl]
     end
-    @growl = options[:growl]
   end
   
   def time(message="", options={})
-    title = options[:title] || timer_title
+    current_title = options[:title] || title
     
     start_time = Time.now
     yield
     end_time = Time.now
-    put_elapsed_time(start_time, end_time, message, title)
+    put_elapsed_time(start_time, end_time, message, current_title)
   end
   
-  private
-  
   def growl?
     @growl
   end
+  
+  private
 
-  def put_elapsed_time(start_time, end_time, message="", title=nil)
+  def put_elapsed_time(start_time, end_time, message="", current_title=nil)
     elapsed_time = format_time(start_time, end_time)
 
-    puts
     e = ""
     if message.to_s.strip != ""
       message += ". "
     end
     e = message + e
     e += "Elapsed time: #{elapsed_time}"
-    puts e
-    growl(e, title)
+    $stdout.puts "\n" + e
+    growl(e, current_title)
   end
   
   def format_time(start_time, end_time=nil)
@@ -47,23 +46,26 @@ class Timer
     if seconds > 59
       minutes = seconds / 60.0
       seconds = (minutes - minutes.to_i) * 60
+      m = minutes.to_i
+      s = seconds.to_i
 
-      m = minutes.to_i > 1 ? "minutes" : "minute"
-      elapsed_time = "#{minutes.to_i} #{m}"
-      if seconds > 0
-        s = seconds.to_i > 1 ? "seconds" : "minutes"
-        elapsed_time += ", #{seconds.to_i} #{s}"
+      minutes_msg = m != 1 ? "minutes" : "minute"
+      elapsed_time = "#{m} #{minutes_msg}"
+      if s > 0
+        seconds_msg = s != 1 ? "seconds" : "second"
+        elapsed_time += ", #{s} #{seconds_msg}"
       end
     else
-      s = seconds.to_i > 1 ? "seconds" : "minutes"
+      s = seconds.to_i != 1 ? "seconds" : "second"
       elapsed_time = "#{seconds.to_i} #{s}"
-    end    
+    end
+    elapsed_time
   end
   
-  def growl(message, title)
+  def growl(message, current_title)
     if growl?
       if title
-        g(message, :title => title)
+        g(message, :title => current_title)
       else
         g(message)
       end

data/spec/timer_spec.rb

@@ -0,0 +1,116 @@
+$:.unshift File.dirname(__FILE__) + '/../lib'
+require 'rubygems'
+require 'timecop'
+require 'timer'
+
+describe "Timer" do
+  before do
+    $stdout.stub!(:puts).as_null_object
+    @g = Object.new
+    Growl.stub(:new).and_return(@g)
+    @g.stub(:notify).as_null_object
+  end
+  
+  describe "growl" do
+    it "should growl a message" do
+      @g.should_receive(:notify).with(anything, anything, /hello/, anything, anything)
+      Timer.new.time("hello") do
+        x = 1
+      end
+    end
+  
+    it "should growl a title" do
+      @g.should_receive(:notify).with(anything, /word/, anything, anything, anything)
+      Timer.new(:title => "word").time("hello") do
+        x = 1
+      end
+    end
+  
+    it "should turn off growl" do
+      @timer = Timer.new(:growl => false)
+      @timer.growl?.should be_false
+    end
+  
+    it "shouldn't growl a message" do
+      Growl.should_not_receive(:new)
+      Timer.new(:growl => false).time("hello") do
+        x = 1
+      end
+    end
+    
+    it "should fail gracefully if growl is off" do
+      @g.should_receive(:notify).and_raise("Connection refused: send(2)")
+      lambda {
+        Timer.new.time("hello") do
+          x = 1
+        end
+      }.should_not raise_error
+    end
+    
+    it "should raise other exceptions" do
+      @g.should_receive(:notify).and_raise("Something else")
+      lambda {
+        Timer.new.time("hello") do
+          x = 1
+        end
+      }.should raise_error("Something else")
+    end
+  end
+  
+  it "puts a message" do
+    $stdout.should_receive(:puts).with(/hello/)
+    Timer.new.time("hello") do
+      x = 1
+    end
+  end
+  
+  describe "title" do
+    it "should set the title" do
+      Timer.new(:title => "YO").title.should == "YO"
+    end
+  
+    it "shuld reset the title" do
+      @timer = Timer.new(:title => "YO")
+      @timer.title = "HEY"
+      @timer.title.should == "HEY"
+    end
+  
+    it "should override the title" do
+      @g.should_receive(:notify).with(anything, /YEAH/, anything, anything, anything)
+      @timer = Timer.new(:title => "word")
+      @timer.time("hello", :title => "YEAH") do
+        x = 1
+      end
+    end
+  end
+  
+  describe "timing the action" do
+    before(:each) do
+      Timecop.return
+    end
+    
+    it "should report seconds" do
+      @g.should_receive(:notify).with(anything, anything, /Elapsed time: 3 seconds\"\n$/, anything, anything)
+      @timer = Timer.new
+      @timer.time("hello") do
+        Timecop.freeze(Time.now + 3)
+      end
+    end
+    
+    it "should report only minutes when it's even" do
+      @g.should_receive(:notify).with(anything, anything, /Elapsed time: 2 minutes\"\n$/, anything, anything)
+      @timer = Timer.new
+      @timer.time("hello") do
+        Timecop.freeze(Time.now + 120)
+      end
+    end
+    
+    it "should report minutes and seconds" do
+      @g.should_receive(:notify).with(anything, anything, /Elapsed time: 1 minute, 14 seconds\"\n$/, anything, anything)
+      @timer = Timer.new
+      @timer.time("hello") do
+        Timecop.freeze(Time.now + 74)
+      end
+    end
+  end
+end

data/timer.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{timer}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jeff Coleman"]
   s.date = %q{2010-01-11}
-  s.description = %q{Simple timer to perform a block and display the elapsed time}
+  s.description = %q{Simple timer to perform a block and display the elapsed time. Growls message if growl is turned on.}
   s.email = %q{progressions@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -24,6 +24,7 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "lib/timer.rb",
+     "spec/timer_spec.rb",
      "timer.gemspec"
   ]
   s.homepage = %q{http://github.com/progressions/timer}
@@ -31,6 +32,9 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.5}
   s.summary = %q{Simple timer to perform a block and display the elapsed time}
+  s.test_files = [
+    "spec/timer_spec.rb"
+  ]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
@@ -39,13 +43,19 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<ruby-growl>, [">= 0"])
       s.add_development_dependency(%q<progressions-g>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<timecop>, [">= 0"])
     else
       s.add_dependency(%q<ruby-growl>, [">= 0"])
       s.add_dependency(%q<progressions-g>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<timecop>, [">= 0"])
     end
   else
     s.add_dependency(%q<ruby-growl>, [">= 0"])
     s.add_dependency(%q<progressions-g>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<timecop>, [">= 0"])
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: timer
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Jeff Coleman
@@ -32,7 +32,27 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
-description: Simple timer to perform a block and display the elapsed time
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: timecop
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Simple timer to perform a block and display the elapsed time. Growls message if growl is turned on.
 email: progressions@gmail.com
 executables: []
 
@@ -49,6 +69,7 @@ files:
 - Rakefile
 - VERSION
 - lib/timer.rb
+- spec/timer_spec.rb
 - timer.gemspec
 has_rdoc: true
 homepage: http://github.com/progressions/timer
@@ -78,5 +99,5 @@ rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: Simple timer to perform a block and display the elapsed time
-test_files: []
-
+test_files: 
+- spec/timer_spec.rb