a_clockwork_ruby 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end
+
+group :test do
+  gem "shoulda"
+  gem "timecop"
+end

data/Gemfile.lock

@@ -0,0 +1,22 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+    timecop (0.3.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  rcov
+  shoulda
+  timecop

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Mike Taylor, Michael Pearce
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,13 @@
+# A Clockwork Ruby - A clock class for use with time of day.
+
+# Credits
+
+Shared Shoulda is maintained by [Mike Taylor](http://github.com/sealabcore) and is funded by [BookRenter.com](http://www.bookrenter.com "BookRenter.com"). Help provided by [Michael Pearce](http://github.com/michaelgpearce), and [Miguel Huibonhoa](http://github.com/phuibonhoa).
+
+![BookRenter.com Logo](http://assets0.bookrenter.com/images/header/bookrenter_logo.gif "BookRenter.com")
+
+
+# Copyright
+
+Copyright (c) 2012 Bookrenter.com. See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "a_clockwork_ruby"
+  gem.homepage = "http://github.com/sealabcore/a_clockwork_ruby"
+  gem.license = "MIT"
+  gem.summary = %Q{A clock class for use with time of day}
+  gem.description = %Q{A clock class for use with time of day}
+  gem.email = "michael.taylor@bookrenter.com"
+  gem.authors = ["Mike Taylor", "Michael Pearce"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "a_clockwork_ruby #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/a_clockwork_ruby.gemspec

@@ -0,0 +1,61 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "a_clockwork_ruby"
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mike Taylor", "Michael Pearce"]
+  s.date = "2012-02-03"
+  s.description = "A clock class for use with time of day"
+  s.email = "michael.taylor@bookrenter.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "a_clockwork_ruby.gemspec",
+    "lib/a_clockwork_ruby.rb",
+    "lib/a_clockwork_ruby/clock.rb",
+    "test/clock_test.rb",
+    "test/helper.rb"
+  ]
+  s.homepage = "http://github.com/sealabcore/a_clockwork_ruby"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "A clock class for use with time of day"
+  s.test_files = [
+    "test/clock_test.rb",
+    "test/helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/a_clockwork_ruby/clock.rb

@@ -0,0 +1,79 @@
+class Clock
+  include Comparable
+  attr_accessor :hour, :min, :sec, :usec
+  
+  def initialize(hour = nil, min = nil, sec = nil, usec = nil)
+    if hour.nil?
+      time = Time.now
+      @hour = time.hour
+      @min = time.min
+      @sec = time.sec
+      @usec = time.usec
+    else
+      @hour = hour
+      @min = min || 0
+      @sec = sec || 0
+      @usec = usec || 0
+    end
+  end
+  
+  def self.now
+    self.new
+  end
+  
+  def self.from_i seconds
+    self.new(seconds / 60**2 % 60**2, seconds / 60 % 60, seconds % 60)
+  end
+  
+  def hour= hour
+    raise ArgumentError if hour < 0 or hour > 23
+    @hour = hour
+  end
+  
+  def min= min
+    raise ArgumentError if min < 0 or min > 59
+    @min = min
+  end
+  
+  def sec= sec
+    raise ArgumentError if sec < 0 or sec > 59
+    @sec = sec
+  end
+  
+  def usec= usec
+    raise ArgumentError if usec < 0 or usec > 999999
+    @usec = usec
+  end
+  
+  def strfclock format
+    to_time.strftime(format)
+  end
+  
+  def to_time
+    to_time_helper(Time.now)
+  end
+
+  def to_s
+    strfclock("%l:%M %p")
+  end
+  
+  def to_i
+    @sec + (@min * 60) + (@hour * 60**2)
+  end
+  
+  def == other
+    time = Time.now
+    to_time_helper(time) == other.send(:to_time_helper, time)
+  end
+  
+  def <=> other
+    time = Time.now
+    to_time_helper(time) <=> other.send(:to_time_helper, time)
+  end
+  
+  private
+  
+  def to_time_helper(time)
+    Time.mktime(time.year, time.month, time.day, @hour, @min, @sec, @usec)
+  end
+end

data/lib/a_clockwork_ruby.rb

@@ -0,0 +1,3 @@
+$: << File.expand_path(File.join(File.dirname(__FILE__), 'a_clockwork_ruby'))
+
+require 'clock'

data/test/clock_test.rb

@@ -0,0 +1,139 @@
+require 'helper'
+require 'a_clockwork_ruby'
+require 'timecop'
+
+class ClockTest < Test::Unit::TestCase
+
+  context ".new" do
+    should "return a clock using the current time when no args are passed" do
+      Timecop.freeze do 
+        time = Time.now
+        clock = Clock.new
+        assert_equal time.hour, clock.hour
+        assert_equal time.min, clock.min
+        assert_equal time.sec, clock.sec
+        assert_equal time.usec, clock.usec
+      end
+    end
+    
+    should "allow clocky arguments" do
+      clock = Clock.new(1, 2, 3, 4)
+      assert_equal 1, clock.hour
+      assert_equal 2, clock.min
+      assert_equal 3, clock.sec
+      assert_equal 4, clock.usec
+    end
+
+    should "allow optional clocky arguments" do
+      clock = Clock.new(1)
+      assert_equal 1, clock.hour
+      assert_equal 0, clock.min
+      assert_equal 0, clock.sec
+      assert_equal 0, clock.usec
+    end
+  end
+  
+  context ".strfclock" do
+    should "allow formatting using strftime args" do
+      clock = Clock.new(14, 2, 3)
+      assert_equal " 2:02:03 PM", clock.strfclock("%l:%M:%S %p")
+    end
+  end
+  
+  context ".to_s" do
+    should "return clock as hours:minutes" do
+      clock = Clock.new(13, 20)
+      assert_equal " 1:20 PM", clock.to_s
+    end
+  end
+  
+  context ".==" do
+    should "check equality" do
+      assert Clock.new(3, 24) == Clock.new(3, 24)
+      assert Clock.new(3, 24) != Clock.new(3, 23)
+    end
+  end
+  
+  context ".<=>" do
+    should "compare clocks" do
+      assert Clock.new(3, 23) < Clock.new(3, 24)
+      assert Clock.new(3, 24) > Clock.new(3, 23)
+    end
+  end
+  
+  context ".to_i" do
+    should "return the number of seconds" do
+      clock = Clock.new(1, 2, 3, 4)
+      assert_equal 3 + (2 * 60) + (1 * 60**2), clock.to_i
+    end
+  end
+  
+  context ".from_i" do
+    should "create a clock from the number of seconds" do
+      seconds = 3 + (2 * 60) + (1 * 60**2)
+      clock = Clock.from_i(seconds)
+      assert_equal 3, clock.sec
+      assert_equal 2, clock.min
+      assert_equal 1, clock.hour
+    end
+  end
+  
+  context ".now" do
+    should "return a clock using the current time" do
+      Timecop.freeze do 
+        time = Time.now
+        clock = Clock.now
+        assert_equal time.hour, clock.hour
+        assert_equal time.min, clock.min
+        assert_equal time.sec, clock.sec
+        assert_equal time.usec, clock.usec
+      end
+    end
+  end
+  
+  context "setters" do
+    setup do
+      @clock = Clock.new
+    end
+    
+    should "set the hour" do
+      @clock.hour = 14
+      assert_equal 14, @clock.hour
+    end
+    
+    should "raise when hour is set to value out of range" do
+      assert_raise(ArgumentError) { @clock.hour = 24 }
+      assert_raise(ArgumentError) { @clock.hour = -1 }
+    end
+    
+    should "set the min" do
+      @clock.min = 14
+      assert_equal 14, @clock.min
+    end
+    
+    should "raise when minute is set to value out of range" do
+      assert_raise(ArgumentError) { @clock.min = 60 }
+      assert_raise(ArgumentError) { @clock.min = -1 }
+    end
+    
+    should "set the sec" do
+      @clock.sec = 14
+      assert_equal 14, @clock.sec
+    end
+    
+    should "raise when seconds is set to value out of range" do
+      assert_raise(ArgumentError) { @clock.sec = 60 }
+      assert_raise(ArgumentError) { @clock.sec = -1 }
+    end
+    
+    should "set the usec" do
+      @clock.usec = 14
+      assert_equal 14, @clock.usec
+    end
+    
+    should "raise when usec is set to value out of range" do
+      assert_raise(ArgumentError) { @clock.sec = 1000000 }
+      assert_raise(ArgumentError) { @clock.sec = -1 }
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development, :test)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification 
+name: a_clockwork_ruby
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Mike Taylor
+- Michael Pearce
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-02-03 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  requirement: *id001
+  prerelease: false
+  name: bundler
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  type: :development
+  requirement: *id002
+  prerelease: false
+  name: jeweler
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  requirement: *id003
+  prerelease: false
+  name: rcov
+description: A clock class for use with time of day
+email: michael.taylor@bookrenter.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- a_clockwork_ruby.gemspec
+- lib/a_clockwork_ruby.rb
+- lib/a_clockwork_ruby/clock.rb
+- test/clock_test.rb
+- test/helper.rb
+homepage: http://github.com/sealabcore/a_clockwork_ruby
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A clock class for use with time of day
+test_files: 
+- test/clock_test.rb
+- test/helper.rb