easy_timer 0.9.1 → 0.9.2

data/README.md

@@ -1,6 +1,6 @@
 # EasyTimer
 
-A simple and elegant way to add timer functionality to your projects. Adds class method timer and instance method verbose to Time class.
+A simple and elegant way to add timer functionality to your projects. Adds class method :timer and instance method :verbose to Time class.
 
 ## Installation
 
@@ -19,22 +19,24 @@ Or install it yourself as:
 ## Usage
 Calling timer will return a time object.
 		
-	Time.timer{sleep 1} #=> Time object
+    Time.timer{sleep 1} #=> Time object
 
-Calling verbose on a Time object will return a formatted string.
+Calling verbose on a Time instance will return a formatted string.
 		
-	Time.timer{sleep 1}.verbose #=> 1.00 seconds
+    Time.timer{sleep 1}.verbose #=> 1.00 seconds
+    Time.at(2.weeks + 2.days + 2.hours + 2.minutes + 2.22.seconds) #=> "2 weeks 2 days 2 hours 2 minutes 2.22 seconds"
+    Time.at(694861.11) #=> "1 week 1 day 1 hour 1 minute 1.11 seconds"
 
 You can also pass :v => true or :verbose => true.
 		
-	Time.timer(:v => true){sleep 1} #=> 1.00 seconds
+    Time.timer(:v => true){sleep 1} #=> 1.00 seconds
 
 A practical usage would be:
 
-	puts Time.timer do
-		Model.update_all({:criteria => false}, {:criteria => true})
-		puts "All models with criteria=false have been updated."
-	end.verbose
+    puts Time.timer do
+     Model.update_all({:criteria => false}, {:criteria => true})
+     puts "All models with criteria=false have been updated."
+    end.verbose
 
 
 ## Contributing

data/lib/easy_timer/version.rb

@@ -1,3 +1,3 @@
 module EasyTimer
-  VERSION = "0.9.1"
+  VERSION = "0.9.2"
 end

data/lib/easy_timer.rb

@@ -1,39 +1,39 @@
 require "easy_timer/version"
 
 module EasyTimer
-	def self.included(base)
-		base.extend(ClassMethods)
-	end
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
 
 	module ClassMethods
-	  def timer(options = {}, &block)
-	  	start_time = Time.now
-	  	yield
-	  	total_time = Time.at(Time.now - start_time)
-	  	if options[:verbose] || options[:v]
-	  	  return total_time.verbose 
-		  else
-		  	return total_time
-		  end
-	  end
+    def timer(options = {}, &block)
+      start_time = Time.now
+      yield
+      total_time = Time.at(Time.now - start_time)
+      if options[:verbose] || options[:v]
+        return total_time.verbose 
+      else
+        return total_time
+      end
+    end
 	end
 
   def verbose
-  	time_hash = {}
-  	seconds = self.to_i
-  	milliseconds = (self.to_f - seconds)
-  	time_hash[:weeks], seconds = seconds.divmod(604800)
-  	time_hash[:days], seconds = seconds.divmod(86400)
-  	time_hash[:hours], seconds = seconds.divmod(3600)
-  	time_hash[:minutes], seconds = seconds.divmod(60)
-  	time_hash[:seconds] = seconds + milliseconds
-  	return time_hash.select{|k,v| v > 0}.inject([]){|verbose, array|
-  		k, v = array
-  		verbose << "#{v.is_a?(Float) ? sprintf("%.2f", v) : v} #{k}"
-  	}.join(" ")
+    time_hash = {}
+    seconds = self.to_i
+    milliseconds = (self.to_f - seconds)
+    time_hash[:weeks], seconds = seconds.divmod(604800)
+    time_hash[:days], seconds = seconds.divmod(86400)
+    time_hash[:hours], seconds = seconds.divmod(3600)
+    time_hash[:minutes], seconds = seconds.divmod(60)
+    time_hash[:seconds] = seconds + milliseconds
+    return time_hash.select{|k,v| v > 0}.inject([]){|verbose, array|
+      k, v = array
+      verbose << "#{v.is_a?(Float) ? sprintf("%.2f", v) : v} #{v > 1 ? k : k.to_s.chars.to_a[0..-2].join}"
+    }.join(" ")
   end
 end
 
 class Time
-	include EasyTimer
+  include EasyTimer
 end

data/spec/easy_timer_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe "timer instance" do
+	let(:verbose_time){Time.at(694861.111111).verbose}
+	it "should return a string" do
+		expect(verbose_time.class).to eql String
+	end
+
+	it "should be a singular verbose time" do
+		expect(verbose_time).to eql "1 week 1 day 1 hour 1 minute 1.11 seconds"
+	end
+
+	it "shold be a plural verbose time" do
+		expect(Time.at(1389722.22).verbose).to eql "2 weeks 2 days 2 hours 2 minutes 2.22 seconds"	
+	end
+
+	it "should show 1 seconds" do
+		expect(Time.timer{sleep 1}.verbose).to eql "1.00 seconds"
+	end
+end
+
+describe "Timer" do
+	before :all do
+		@five = Time.timer{sleep 5}
+	end
+
+	it "should return a Time object" do
+		expect(@five.class).to eql Time
+	end
+
+	it "should return 5 seconds" do
+		expect(@five.to_f).to be_within(0.1).of(5)
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rspec'
+require 'easy_timer'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter     = 'documentation'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easy_timer
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.2
   prerelease: 
 platform: ruby
 authors:
@@ -18,6 +18,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .DS_Store
 - .gitignore
 - Gemfile
 - LICENSE
@@ -26,6 +27,8 @@ files:
 - easy_timer.gemspec
 - lib/easy_timer.rb
 - lib/easy_timer/version.rb
+- spec/easy_timer_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/isaacsloan/easy_timer
 licenses: []
 post_install_message: 
@@ -50,4 +53,6 @@ rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Adds easy to use timer method to Time class.
-test_files: []
+test_files:
+- spec/easy_timer_spec.rb
+- spec/spec_helper.rb