tod 1.0.0

data/.gitignore

@@ -0,0 +1,4 @@
+pkg/*
+*.gem
+.bundle
+nbproject

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Jack Christensen
+
+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.markdown

@@ -0,0 +1,89 @@
+Tod
+===
+
+Supplies TimeOfDay class that includes parsing, strftime, comparison, and
+arithmetic.
+
+
+Installation
+============
+
+    gem install tod
+
+Examples
+========
+
+Loading Tod
+-----------
+
+    require 'tod'
+
+Creating from hour, minute, and second
+--------------------------------------
+
+    TimeOfDay.new 8                                # => 08:00:00
+    TimeOfDay.new 8, 15, 30                        # => 08:15:30
+
+Parsing text
+------------
+
+Strings only need to contain an hour. Minutes, seconds, AM or PM, and colons
+are all optional.
+
+    TimeOfDay.parse "8"                            # => 08:00:00
+    TimeOfDay.parse "8am"                          # => 08:00:00
+    TimeOfDay.parse "8pm"                          # => 20:00:00
+    TimeOfDay.parse "8p"                           # => 20:00:00
+    TimeOfDay.parse "9:30"                         # => 09:30:00
+    TimeOfDay.parse "15:30"                        # => 15:30:00
+    TimeOfDay.parse "3:30pm"                       # => 15:30:00
+    TimeOfDay.parse "1230"                         # => 12:30:00
+    TimeOfDay.parse "3:25:58"                      # => 03:25:58
+    TimeOfDay.parse "515p"                         # => 17:15:00
+    TimeOfDay.parse "151253"                       # => 15:12:53
+
+Adding or subtracting time
+-----------------------------
+
+Seconds can be added to or subtracted TimeOfDay objects. Time correctly wraps
+around midnight.
+
+    TimeOfDay.new(8) + 3600                        # => 09:00:00
+    TimeOfDay.new(8) - 3600                        # => 07:00:00
+    TimeOfDay.new(0) - 30                          # => 23:59:30
+    TimeOfDay.new(23,59,45) + 30                   # => 00:00:15
+
+Comparing
+--------------------
+
+TimeOfDay includes Comparable.
+
+    TimeOfDay.new(8) < TimeOfDay.new(9)            # => true
+    TimeOfDay.new(8) == TimeOfDay.new(9)           # => false
+    TimeOfDay.new(9) == TimeOfDay.new(9)           # => true
+    TimeOfDay.new(10) > TimeOfDay.new(9)           # => true
+
+Formatting
+----------
+
+Format strings are passed to Time#strftime.
+
+    TimeOfDay.new(8,30).strftime("%H:%M")          # => "08:30"
+    TimeOfDay.new(17,15).strftime("%I:%M %p")      # => "05:15 PM"
+    TimeOfDay.new(22,5,15).strftime("%I:%M:%S %p") # => "10:05:15 PM"
+
+Convenience methods for dates and times
+---------------------------------------
+
+Tod adds Date#on and Time#to_time_of_day. If you do not want the core extensions
+then require 'tod/time_of_day' instead of 'tod'.
+
+    tod = TimeOfDay.new 8, 30                       # => 08:30:00
+    tod.on Date.today                               # => 2010-12-29 08:30:00 -0600
+    Date.today.at tod                               # => 2010-12-29 08:30:00 -0600
+    Time.now.to_time_of_day                         # => 16:30:43
+
+License
+=======
+
+Copyright (c) 2010 Jack Christensen, released under the MIT license

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "lib"
+  t.libs << "test"
+  t.test_files = FileList['test/tod/*_test.rb']
+  t.verbose = true
+end

data/lib/tod/date.rb

@@ -0,0 +1,6 @@
+class Date
+  # Returns a local Time instance with this date and time_of_day
+  def at(time_of_day)
+    Time.local year, month, day, time_of_day.hour, time_of_day.minute, time_of_day.second
+  end
+end

data/lib/tod/time.rb

@@ -0,0 +1,5 @@
+class Time
+  def to_time_of_day
+    TimeOfDay.new hour, min, sec
+  end
+end

data/lib/tod/time_of_day.rb

@@ -0,0 +1,129 @@
+module Tod
+  class TimeOfDay
+    include Comparable
+
+    attr_reader :hour, :minute, :second, :second_of_day
+    alias_method :min, :minute
+    alias_method :sec, :second
+
+    PARSE_24H_REGEX = /
+      \A
+      ([01]?\d|2[0-3])
+      :?
+      ([0-5]\d)?
+      :?
+      ([0-5]\d)?
+      \z
+    /x
+
+    PARSE_12H_REGEX = /
+      \A
+      (0?\d|1[0-2])
+      :?
+      ([0-5]\d)?
+      :?
+      ([0-5]\d)?
+      \s*
+      ([ap])
+      \.?
+      \s*
+      m?
+      \.?
+      \z
+    /x
+
+    NUM_SECONDS_IN_DAY = 86400
+    NUM_SECONDS_IN_HOUR = 3600
+    NUM_SECONDS_IN_MINUTE = 60
+
+    def initialize(h, m=0, s=0)
+      @hour = Integer(h)
+      @minute = Integer(m)
+      @second = Integer(s)
+
+      raise ArgumentError, "hour must be between 0 and 23" unless (0..23).include?(@hour)
+      raise ArgumentError, "minute must be between 0 and 59" unless (0..59).include?(@minute)
+      raise ArgumentError, "second must be between 0 and 59" unless (0..59).include?(@second)
+
+      @second_of_day = @hour * 60 * 60 + @minute * 60 + @second
+      
+      freeze # TimeOfDay instances are value objects
+    end
+
+    def <=>(other)
+      @second_of_day <=> other.second_of_day
+    end
+
+    # Formats identically to Time#strftime
+    def strftime(format_string)
+      Time.local(2000,1,1, @hour, @minute, @second).strftime(format_string)
+    end
+
+    def to_s
+      strftime "%H:%M:%S"
+    end
+
+    # Return a new TimeOfDay num_seconds greater than self. It will wrap around
+    # at midnight.
+    def +(num_seconds)
+      TimeOfDay.from_second_of_day @second_of_day + num_seconds
+    end
+
+    # Return a new TimeOfDay num_seconds less than self. It will wrap around
+    # at midnight.
+    def -(num_seconds)
+      TimeOfDay.from_second_of_day @second_of_day - num_seconds
+    end
+
+    # Returns a Time instance on date using self as the time of day
+    def on(date)
+      Time.local date.year, date.month, date.day, @hour, @minute, @second
+    end
+
+    # Build a new TimeOfDay instance from second_of_day
+    #
+    #   TimeOfDay.from_second_of_day(3600) == TimeOfDay.new(1)   # => true
+    def self.from_second_of_day(second_of_day)
+      remaining_seconds = second_of_day % NUM_SECONDS_IN_DAY
+      hour = remaining_seconds / NUM_SECONDS_IN_HOUR
+      remaining_seconds -= hour * NUM_SECONDS_IN_HOUR
+      minute = remaining_seconds / NUM_SECONDS_IN_MINUTE
+      remaining_seconds -= minute * NUM_SECONDS_IN_MINUTE
+      new hour, minute, remaining_seconds
+    end
+
+    # Build a TimeOfDay instance from string
+    #
+    # Strings only need to contain an hour. Minutes, seconds, AM or PM, and colons
+    # are all optional.
+    #   TimeOfDay.parse "8"                            # => 08:00:00
+    #   TimeOfDay.parse "8am"                          # => 08:00:00
+    #   TimeOfDay.parse "8pm"                          # => 20:00:00
+    #   TimeOfDay.parse "8p"                           # => 20:00:00
+    #   TimeOfDay.parse "9:30"                         # => 09:30:00
+    #   TimeOfDay.parse "15:30"                        # => 15:30:00
+    #   TimeOfDay.parse "3:30pm"                       # => 15:30:00
+    #   TimeOfDay.parse "1230"                         # => 12:30:00
+    #   TimeOfDay.parse "3:25:58"                      # => 03:25:58
+    #   TimeOfDay.parse "515p"                         # => 17:15:00
+    #   TimeOfDay.parse "151253"                       # => 15:12:53
+    def self.parse(tod_string)
+      tod_string = tod_string.strip
+      tod_string = tod_string.downcase
+      if PARSE_24H_REGEX =~ tod_string || PARSE_12H_REGEX =~ tod_string
+        hour, minute, second, a_or_p = $1.to_i, $2.to_i, $3.to_i, $4
+        if hour == 12 && a_or_p == "a"
+          hour = 0
+        elsif hour < 12 && a_or_p == "p"
+          hour += 12
+        end
+
+        new hour, minute, second
+      else
+        raise ArgumentError, "Invalid time of day string"
+      end
+    end
+  end
+end
+
+TimeOfDay = Tod::TimeOfDay

data/lib/tod/version.rb

@@ -0,0 +1,3 @@
+class TimeOfDay
+  VERSION = "1.0.0"
+end

data/lib/tod.rb

@@ -0,0 +1,3 @@
+require 'tod/time_of_day'
+require 'tod/date'
+require 'tod/time'

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__),'..','lib')
+
+require 'tod'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'

data/test/tod/date_test.rb

@@ -0,0 +1,11 @@
+require File.expand_path(File.join(File.dirname(__FILE__),'..','test_helper'))
+
+class DateTest < Test::Unit::TestCase
+  context "at" do
+    should "accept TimeOfDay and return Time on same date" do
+      date = Date.civil 2000,1,1
+      tod = TimeOfDay.new 8,30
+      assert_equal Time.local(2000,1,1, 8,30), date.at(tod)
+    end
+  end
+end

data/test/tod/time_of_day_test.rb

@@ -0,0 +1,183 @@
+require File.expand_path(File.join(File.dirname(__FILE__),'..','test_helper'))
+
+class TimeOfDayTest < Test::Unit::TestCase
+  context "initialize" do
+    should "block invalid hours" do
+      assert_raise(ArgumentError) { TimeOfDay.new -1 }
+      assert_raise(ArgumentError) { TimeOfDay.new 24 }
+    end
+
+    should "block invalid minutes" do
+      assert_raise(ArgumentError) { TimeOfDay.new 0, -1 }
+      assert_raise(ArgumentError) { TimeOfDay.new 0, 60 }
+    end
+
+    should "block invalid seconds" do
+      assert_raise(ArgumentError) { TimeOfDay.new 0, 0, -1 }
+      assert_raise(ArgumentError) { TimeOfDay.new 0, 0, 60 }
+    end
+  end
+
+  context "second_of_day" do
+    should "be 0 at midnight" do
+      assert_equal 0, TimeOfDay.new(0,0,0).second_of_day
+    end
+
+    should "be 3661 at 1:01:01" do
+      assert_equal 3661, TimeOfDay.new(1,1,1).second_of_day
+    end
+
+    should "be 86399 at last second of day" do
+      assert_equal 86399, TimeOfDay.new(23,59,59).second_of_day
+    end
+  end
+
+  def self.should_parse(parse_string, expected_hour, expected_minute, expected_second)
+    expected_tod = TimeOfDay.new expected_hour, expected_minute, expected_second
+
+    should "parse '#{parse_string}' into #{expected_tod.inspect}" do
+      assert_equal expected_tod, TimeOfDay.parse(parse_string)
+    end
+  end
+
+  def self.should_not_parse(parse_string)
+    should "not parse '#{parse_string}'" do
+      assert_raise(ArgumentError) { TimeOfDay.parse(parse_string) }
+    end
+  end
+
+  should_parse "9",            9, 0, 0
+  should_parse "13",          13, 0, 0
+  should_parse "1230",        12,30, 0
+  should_parse "08:15",        8,15, 0
+  should_parse "08:15:30",     8,15,30
+  should_parse "18",          18, 0, 0
+  should_parse "23",          23, 0, 0
+
+  should_parse "9a",           9, 0, 0
+  should_parse "900a",         9, 0, 0
+  should_parse "9A",           9, 0, 0
+  should_parse "9am",          9, 0, 0
+  should_parse "9AM",          9, 0, 0
+  should_parse "9 a",          9, 0, 0
+  should_parse "9 am",         9, 0, 0
+  should_parse "09:30:45 am",  9,30,45
+
+  should_parse "9p",          21, 0, 0
+  should_parse "900p",        21, 0, 0
+  should_parse "9P",          21, 0, 0
+  should_parse "9pm",         21, 0, 0
+  should_parse "9PM",         21, 0, 0
+  should_parse "9 p",         21, 0, 0
+  should_parse "9 pm",        21, 0, 0
+  should_parse "09:30:45 pm", 21,30,45
+
+  should_parse "12a",          0, 0, 0
+  should_parse "12p",         12, 0, 0
+
+  should_not_parse "-1:30"
+  should_not_parse "24:00:00"
+  should_not_parse "24"
+  should_not_parse "00:60"
+  should_not_parse "00:00:60"
+  should_not_parse "13a"
+  should_not_parse "13p"
+  should_not_parse "10.5"
+
+  should "provide spaceship operator" do
+    assert_equal -1, TimeOfDay.new(8,0,0) <=> TimeOfDay.new(9,0,0)
+    assert_equal 0, TimeOfDay.new(9,0,0) <=> TimeOfDay.new(9,0,0)
+    assert_equal 1, TimeOfDay.new(10,0,0) <=> TimeOfDay.new(9,0,0)
+  end
+
+  should "compare equality by value" do
+    assert_equal TimeOfDay.new(8,0,0), TimeOfDay.new(8,0,0)
+  end
+
+
+  context "strftime" do
+    should "delegate to Time.parse" do
+      format_string = "%H:%M"
+      Time.any_instance.expects(:strftime).with(format_string)
+      TimeOfDay.new(8,15,30).strftime format_string
+    end
+  end
+
+  context "to_s" do
+    should "format to HH:MM:SS" do
+      assert_equal "08:15:30", TimeOfDay.new(8,15,30).to_s
+      assert_equal "22:10:45", TimeOfDay.new(22,10,45).to_s
+    end
+  end
+
+  context "addition" do
+    should "add seconds" do
+      original = TimeOfDay.new(8,0,0)
+      result = original + 15
+      assert_equal TimeOfDay.new(8,0,15), result
+    end
+
+    should "wrap around midnight" do
+      original = TimeOfDay.new(23,0,0)
+      result = original + 7200
+      assert_equal TimeOfDay.new(1,0,0), result
+    end
+
+    should "return new TimeOfDay" do
+      original = TimeOfDay.new(8,0,0)
+      result = original + 15
+      assert_not_equal original.object_id, result.object_id
+    end
+  end
+
+  context "subtraction" do
+    should "subtract seconds" do
+      original = TimeOfDay.new(8,0,0)
+      result = original - 15
+      assert_equal TimeOfDay.new(7,59,45), result
+    end
+
+    should "wrap around midnight" do
+      original = TimeOfDay.new(1,0,0)
+      result = original - 7200
+      assert_equal TimeOfDay.new(23,0,0), result
+    end
+
+    should "return new TimeOfDay" do
+      original = TimeOfDay.new(8,0,0)
+      result = original - 15
+      assert_not_equal original.object_id, result.object_id
+    end
+  end
+
+  context "from_second_of_day" do
+    should "handle positive numbers" do
+      assert_equal TimeOfDay.new(0,0,30), TimeOfDay.from_second_of_day(30)
+      assert_equal TimeOfDay.new(0,1,30), TimeOfDay.from_second_of_day(90)
+      assert_equal TimeOfDay.new(1,1,5), TimeOfDay.from_second_of_day(3665)
+      assert_equal TimeOfDay.new(23,59,59), TimeOfDay.from_second_of_day(86399)
+    end
+
+    should "handle positive numbers a day or more away" do
+      assert_equal TimeOfDay.new(0,0,0), TimeOfDay.from_second_of_day(86400)
+      assert_equal TimeOfDay.new(0,0,30), TimeOfDay.from_second_of_day(86430)
+      assert_equal TimeOfDay.new(0,1,30), TimeOfDay.from_second_of_day(86490)
+      assert_equal TimeOfDay.new(1,1,5), TimeOfDay.from_second_of_day(90065)
+      assert_equal TimeOfDay.new(23,59,59), TimeOfDay.from_second_of_day(172799)
+    end
+
+    should "handle negative numbers" do
+      assert_equal TimeOfDay.new(23,59,30), TimeOfDay.from_second_of_day(-30)
+    end
+
+    should "handle negative numbers more than a day away" do
+      assert_equal TimeOfDay.new(23,59,30), TimeOfDay.from_second_of_day(-86430)
+    end
+  end
+
+  context "on" do
+    should "be local Time on given date" do
+      assert_equal Time.local(2010,12,29, 8,30), TimeOfDay.new(8,30).on(Date.civil(2010,12,29))
+    end
+  end
+end

data/test/tod/time_test.rb

@@ -0,0 +1,10 @@
+require File.expand_path(File.join(File.dirname(__FILE__),'..','test_helper'))
+
+class TimeTest < Test::Unit::TestCase
+  context "to_time_of_day" do
+    should "be TimeOfDay" do
+      time = Time.local 2000,1,1, 12,30,15
+      assert_equal TimeOfDay.new(12,30,15), time.to_time_of_day
+    end
+  end
+end

data/tod.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "tod/version"
+
+Gem::Specification.new do |s|
+  s.name        = "tod"
+  s.version     = TimeOfDay::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jack Christensen"]
+  s.email       = ["jack@jackchristensen.com"]
+  s.homepage    = "https://github.com/JackC/tod"
+  s.summary     = %q{Supplies TimeOfDay class}
+  s.description = %q{Supplies TimeOfDay class that includes parsing, strftime, comparison, and arithmetic.}
+
+  s.add_development_dependency "test-unit"
+  s.add_development_dependency "shoulda"
+  s.add_development_dependency "mocha"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification 
+name: tod
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Jack Christensen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-29 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: test-unit
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: Supplies TimeOfDay class that includes parsing, strftime, comparison, and arithmetic.
+email: 
+- jack@jackchristensen.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- MIT-LICENSE
+- README.markdown
+- Rakefile
+- lib/tod.rb
+- lib/tod/date.rb
+- lib/tod/time.rb
+- lib/tod/time_of_day.rb
+- lib/tod/version.rb
+- test/test_helper.rb
+- test/tod/date_test.rb
+- test/tod/time_of_day_test.rb
+- test/tod/time_test.rb
+- tod.gemspec
+has_rdoc: true
+homepage: https://github.com/JackC/tod
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Supplies TimeOfDay class
+test_files: []
+