meskyanichi-timer 0.1.0

data/README.rdoc

@@ -0,0 +1,68 @@
+Timer
+=====
+
+Timer, a simple plugin that calculates the time between a "start time" and a "end time".
+Currently Timer has the ability to take a Time object or a timestamp for the start and end times and will calculate the
+time between these values in days, hours (and days in hours), minutes and seconds!
+There is also the option to force it to display 2 digits at all times when you are creating a 'non-words' timer,
+though would display for example "09:34:02" instead of "9:34:2". However, when you aren't forcing the two digits to be displayed
+you could create a string such as: "7 days, 5 hours, 11 minutes and 56 seconds remaining..".
+
+The output it quite limited, but it also enables you to either extend the class to create your own custom outputs.
+You can of course choose not to create a whole new class to do this and just generate the strings inside of a specific helper/module,
+whatever you think is best!
+
+Example #1
+=======
+
+# New Instance of Timer
+t = Timer.new 
+
+# Set the start time to the current time
+t.start_time = Time.now 
+
+# Set the end time to begin 2010
+t.end_time = Time.parse('2010-01-01 00:00:00') 
+
+# Output Timer
+<%= "#{t.days} days, #{t.hours} hours, #{t.minutes} minutes, #{t.seconds} seconds" %>
+
+# Outputs
+313 days, 0 hours, 12 minutes, 29 seconds
+
+
+Example #2
+=======
+
+# New Instance of Timer
+t = Timer.new 
+
+# Set the start time to the current time
+t.start_time = Time.now 
+
+# Set the end time to begin 2010
+t.end_time = Time.parse('2010-01-01 00:00:00')
+
+# Force Timer to atleast output two digits (the zero's)
+t.force_two_digits = true
+
+
+# Output Timer
+<%= "#{t.days_in_hours}:#{t.minutes}:#{t.seconds}" %>
+
+#Outputs (Hours:Minutes:Seconds)
+7512:09:43
+
+
+OR
+
+
+# Output Timer
+<%= "#{t.hours}:#{t.minutes}:#{t.seconds} in #{t.days} days" %>
+
+#Outputs (Hours:Minutes:Seconds)
+00:06:51 in 313 days
+
+
+
+Copyright (c) 2009 [Michael van Rooijen], released under the MIT license

data/Rakefile

@@ -0,0 +1,15 @@
+# Rakefile
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('timer', '0.1.0') do |p|
+  p.description    = "This is a Timer class that calculates the time between two moments."
+  p.url            = "http://github.com/meskyanichi/timer"
+  p.author         = "Michael van Rooijen"
+  p.email          = "meskyan@gmail.com"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/lib/timer.rb

@@ -0,0 +1,89 @@
+class Timer
+  
+  # Initial Values
+  attr_accessor :start_time
+  attr_accessor :end_time
+  
+  # Params
+  attr_accessor :timer
+  attr_accessor :difference_in_seconds
+
+  # Booleans
+  attr_accessor :calculated
+  attr_accessor :force_two_digits
+  
+  
+  
+  def days
+    initialze_parse_settings
+    return timer[:days]
+  end
+  
+  def hours
+    initialze_parse_settings
+    return timer[:hours]
+  end
+  
+  def days_in_hours
+    initialze_parse_settings
+    return timer[:days_in_hours]
+  end
+  
+  def minutes
+    initialze_parse_settings
+    return timer[:minutes]
+  end
+  
+  def seconds
+    initialze_parse_settings
+    return timer[:seconds]
+  end
+
+  def exceeded?
+    return true if start_time > end_time
+  end
+  
+  
+  private
+  
+  def initialze_parse_settings
+    update_calculations unless already_calculated?
+    make_2_digits if forces_two_digits?
+  end
+  
+  def forces_two_digits?
+    return true if self.force_two_digits
+  end
+  
+  def already_calculated?
+    if self.calculated
+      return true
+    else
+      self.calculated = true
+      return false
+    end
+  end
+  
+  def update_calculations
+    if start_time and end_time
+      difference_in_seconds = end_time.to_i - start_time.to_i
+    end
+    
+    if difference_in_seconds
+      self.timer                  = {}
+      self.timer[:days]           = ( difference_in_seconds / 60 / 60 / 24 ).to_i
+      self.timer[:hours]          = ( ( difference_in_seconds - ( self.timer[:days] * 60 * 60 * 24 ) ) / 60 / 60 ).to_i
+      self.timer[:minutes]        = ( ( difference_in_seconds - ( self.timer[:days] * 60 * 60 * 24 ) - ( self.timer[:hours] * 60 * 60 ) ) / 60 ).to_i
+      self.timer[:seconds]        = ( ( ( difference_in_seconds - ( self.timer[:days] * 60 * 60 * 24 ) - ( self.timer[:hours] * 60 * 60 ) ) - ( self.timer[:minutes] * 60 ) ) ).to_i
+      self.timer[:days_in_hours]  = ( ( self.timer[:days] * 24) + self.timer[:hours] ).to_i
+    else
+      raise "To update calculations you need atleast a start_time and end_time."
+    end
+  end
+  
+  def make_2_digits
+    timers = [:hours, :minutes, :seconds, :days_in_hours]
+    timers.each {|t| self.timer[t] = sprintf('%02d', self.timer[t]) }
+  end
+  
+end

data/timer.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{timer}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Michael van Rooijen"]
+  s.date = %q{2009-03-30}
+  s.description = %q{This is a Timer class that calculates the time between two moments.}
+  s.email = %q{meskyan@gmail.com}
+  s.extra_rdoc_files = ["lib/timer.rb", "README.rdoc"]
+  s.files = ["lib/timer.rb", "Manifest", "Rakefile", "README.rdoc", "timer.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/meskyanichi/timer}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Timer", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{timer}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{This is a Timer class that calculates the time between two moments.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: meskyanichi-timer
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Michael van Rooijen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-30 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: This is a Timer class that calculates the time between two moments.
+email: meskyan@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- lib/timer.rb
+- README.rdoc
+files: 
+- lib/timer.rb
+- Manifest
+- Rakefile
+- README.rdoc
+- timer.gemspec
+has_rdoc: true
+homepage: http://github.com/meskyanichi/timer
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Timer
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: timer
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: This is a Timer class that calculates the time between two moments.
+test_files: []
+