tod 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0c54266418af0f1e8c33cd0fb4fff9208c49a15
-  data.tar.gz: ca0769c6200f87813c4c444739b682979ae4be22
+  metadata.gz: 853fd23075cb8c0131b49bae9b571249cf01f940
+  data.tar.gz: 8fcb950ad2f427b980232962831d6ac53c25353a
 SHA512:
-  metadata.gz: 0c208a905bbcc27834d337a9f089f8dc01addcaaacc21359e5999cc106142fe1439a759153c7ace52953986f6b7f5c5f52631d625cdb3a985deebef2c17da7fd
-  data.tar.gz: 67eb3aec32aa2e424eecec91b219700687bd2ba33592d59587509a31f1e3819e03a679be16c7c23c5ceff81789c0a35ff6db0943a1528d9f50b699798c27271c
+  metadata.gz: 07c301bb3668574f5d1129d7fcaed0109c50e1a9e85ec663da88d2f863831c703b9f30160cd5078a4d8b7807cb875f8fdb54162551ff2facac491075d0eb445f
+  data.tar.gz: 49b0c82abd08efa118b80cd7c63b3d5c1c034a4e856ac79eea31c626034c868c9683ea825d6c4d6ab159331e19657d7a703eabc7d6aad1a286ac1796ec2e61d5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tod (1.2.2)
+    tod (1.3.0)
 
 GEM
   remote: https://rubygems.org/

data/README.markdown

@@ -4,6 +4,9 @@ Tod
 Supplies TimeOfDay class that includes parsing, strftime, comparison, and
 arithmetic.
 
+Supplies Shift to represent a period of time, using a beginning and ending TimeOfDay. Allows to calculate its duration and
+to determine if a TimeOfDay is included inside the shift. For nightly shifts (when beginning time is greater than ending time),
+it supposes the shift ends the following day.
 
 Installation
 ============
@@ -84,6 +87,34 @@ then require 'tod/time_of_day' instead of 'tod'.
     Time.now.to_time_of_day                         # => 16:30:43
     DateTime.now.to_time_of_day                     # => 16:30:43
 
+
+Shifts
+=======================
+
+Represents a period of time, using a beginning and ending TimeOfDay. Allows to calculate its duration and
+to determine if a TimeOfDay is included inside the shift. For nightly shifts (when beginning time is greater than ending time),
+it supposes the shift ends the following day.
+
+Creating from TimeOfDay
+--------------------------------------
+
+    Shift.new(TimeOfDay.new(9), TimeOfDay.new(17))
+    Shift.new(TimeOfDay.new(22), TimeOfDay.new(4))
+
+Duration
+--------------------
+
+    Shift.new(TimeOfDay.new(9), TimeOfDay.new(17)).duration # => 28800
+    Shift.new(TimeOfDay.new(20), TimeOfDay.new(2)).duration # => 21600
+
+Include?
+--------------------
+
+    Shift.new(TimeOfDay.new(9), TimeOfDay.new(17)).include?(TimeOfDay.new(12)) # => true
+    Shift.new(TimeOfDay.new(9), TimeOfDay.new(17)).include?(TimeOfDay.new(7))  # => false
+    Shift.new(TimeOfDay.new(20), TimeOfDay.new(4)).include?(TimeOfDay.new(2))  # => true
+    Shift.new(TimeOfDay.new(20), TimeOfDay.new(4)).include?(TimeOfDay.new(18)) # => false
+
 Rails Time Zone Support
 =======================
 
@@ -113,6 +144,10 @@ Tod is compatible with Ruby 1.9.3 and 2.0.0 and Rails 3.0, 3.1, 3.2, and 4.0.
 History
 =======
 
+## 1.3.0 (December 9, 2013)
+
+* Add Shift class (Pablo Russo)
+
 ## 1.2.2 (November 16, 2013)
 
 * Fix dumping nil or empty string to PostgreSQL time column (Maik Arnold)

data/lib/tod/shift.rb

@@ -0,0 +1,41 @@
+module Tod
+  class Shift
+    attr_reader :beginning, :ending
+
+    def initialize(beginning, ending)
+      raise ArgumentError, "beginning can not be nil" unless beginning
+      raise ArgumentError, "ending can not be nil" unless ending
+
+      @beginning = beginning
+      @ending = ending
+      freeze # Shift instances are value objects
+    end
+
+    # Returns true if the time of day is inside the shift (inclusive range), false otherwise
+    def include?(tod)
+      if ending >= beginning
+        tod >= beginning && tod <= ending
+      else
+        start_of_day   = TimeOfDay.new(0,0,0)
+        end_of_day     = TimeOfDay.new(23,59,59)
+        (tod >= beginning && tod <= end_of_day) || (tod >= start_of_day && tod <= ending)
+      end
+    end
+
+    # Return shift duration in seconds.
+    # if ending is lower than beginning this method will calculate the duration as the ending time is from the following day
+    def duration
+      if ending >= beginning
+        (ending.to_i - beginning.to_i)
+      else
+        start_of_day   = TimeOfDay.new(0,0,0)
+        end_of_day     = TimeOfDay.new(23,59,59)
+        duration_day_1 = (end_of_day.to_i - beginning.to_i) + 1
+        duration_day_2 = (ending.to_i - start_of_day.to_i)
+        duration_day_1 + duration_day_2
+      end
+    end
+  end
+end
+
+Shift = Tod::Shift

data/lib/tod/version.rb

@@ -1,3 +1,3 @@
-class TimeOfDay
-  VERSION = "1.2.2"
+module Tod
+  VERSION = "1.3.0"
 end

data/lib/tod.rb

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

data/test/tod/shift_test.rb

@@ -0,0 +1,94 @@
+require File.expand_path(File.join(File.dirname(__FILE__),'..','test_helper'))
+require 'active_support/time'
+
+class ShiftTest < Test::Unit::TestCase
+  context "duration" do
+    should "return correct duration when first time is lower than the second one" do
+      duration_expected = 4 * 60 * 60 + 30 * 60 + 30 # 4 hours, 30 min and 30 sec later
+      tod1 = TimeOfDay.new 8,30
+      tod2 = TimeOfDay.new 13,00,30
+      shift = Shift.new tod1, tod2
+      duration = shift.duration
+      assert_equal duration, duration_expected
+    end
+    should "return correct duration when first time is greater than the second one" do
+      duration_expected = 4 * 60 * 60 + 30 * 60 + 30 # 4 hours, 30 min and 30 sec later
+      tod1 = TimeOfDay.new 22,30
+      tod2 = TimeOfDay.new 3,00,30
+      shift = Shift.new tod1, tod2
+      duration = shift.duration
+      assert_equal duration, duration_expected
+    end
+    should "be zero when both times are equal" do
+      tod1 = TimeOfDay.new 3,00,30
+      shift = Shift.new tod1, tod1
+      duration = shift.duration
+      assert_equal duration, 0
+    end
+  end
+
+  context "include?" do
+    # |------------------------|--------T1----V----T2----|------------------------|
+    should "be true when value is between ToDs and boths tods are in the same day" do
+      tod1  = TimeOfDay.new 8
+      tod2  = TimeOfDay.new 16
+      value = TimeOfDay.new 12
+      shift = Shift.new tod1, tod2
+      assert_equal shift.include?(value), true
+    end
+
+    # |------------------T1----|-------V----------T2-----|------------------------|
+    should "be true when value is on second day between ToDs and start ToD is in a different day" do
+      tod1  = TimeOfDay.new 20
+      tod2  = TimeOfDay.new 15
+      value = TimeOfDay.new 12
+      shift = Shift.new tod1, tod2
+      assert_equal shift.include?(value), true
+    end
+
+    # |------------------T1--V-|------------------T2-----|------------------------|
+    should "be true when value is on first day between ToDs and start ToD is in a different day" do
+      tod1  = TimeOfDay.new 20
+      tod2  = TimeOfDay.new 15
+      value = TimeOfDay.new 22
+      shift = Shift.new tod1, tod2
+      assert_equal shift.include?(value), true
+    end
+
+    # |------------------------|--------T1----------V----|----T2------------------|
+    should "be true when value is on first day between ToDs and end ToD is in a different day" do
+      tod1  = TimeOfDay.new 16
+      tod2  = TimeOfDay.new 4
+      value = TimeOfDay.new 20
+      shift = Shift.new tod1, tod2
+      assert_equal shift.include?(value), true
+    end
+
+    # |------------------------|--------T1---------------|--V---T2----------------|
+    should "be true when value is on second day between ToDs and end ToD is in a different day" do
+      tod1  = TimeOfDay.new 16
+      tod2  = TimeOfDay.new 4
+      value = TimeOfDay.new 2
+      shift = Shift.new tod1, tod2
+      assert_equal shift.include?(value), true
+    end
+
+    # |------------------------|--------T1-----T2----V---|------------------------|
+    should "be false when value is after second ToD" do
+      tod1  = TimeOfDay.new 10
+      tod2  = TimeOfDay.new 16
+      value = TimeOfDay.new 20
+      shift = Shift.new tod1, tod2
+      assert_equal shift.include?(value), false
+    end
+
+    # |------------------------|--V-----T1-----T2--------|------------------------|
+    should "be false when value is before first ToD" do
+      tod1  = TimeOfDay.new 10
+      tod2  = TimeOfDay.new 16
+      value = TimeOfDay.new 8
+      shift = Shift.new tod1, tod2
+      assert_equal shift.include?(value), false
+    end
+  end
+end

data/tod.gemspec

@@ -4,13 +4,13 @@ require "tod/version"
 
 Gem::Specification.new do |s|
   s.name        = "tod"
-  s.version     = TimeOfDay::VERSION
+  s.version     = Tod::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.summary     = %q{Supplies TimeOfDay and Shift class}
+  s.description = %q{Supplies TimeOfDay and Shift class that includes parsing, strftime, comparison, and arithmetic.}
 
   s.add_development_dependency "test-unit"
   s.add_development_dependency "shoulda"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tod
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Jack Christensen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-16 00:00:00.000000000 Z
+date: 2013-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
@@ -108,7 +108,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Supplies TimeOfDay class that includes parsing, strftime, comparison,
+description: Supplies TimeOfDay and Shift class that includes parsing, strftime, comparison,
   and arithmetic.
 email:
 - jack@jackchristensen.com
@@ -129,6 +129,7 @@ files:
 - gemfiles/4.0.gemfile
 - lib/tod.rb
 - lib/tod/date.rb
+- lib/tod/shift.rb
 - lib/tod/time.rb
 - lib/tod/time_of_day.rb
 - lib/tod/version.rb
@@ -136,6 +137,7 @@ files:
 - test/test_helper.rb
 - test/tod/a_a_a_time_of_day_time_zone_without_active_support_test.rb
 - test/tod/date_test.rb
+- test/tod/shift_test.rb
 - test/tod/time_of_day_serializable_attribute_test.rb
 - test/tod/time_of_day_test.rb
 - test/tod/time_of_day_time_zone_with_active_support_test.rb
@@ -163,5 +165,15 @@ rubyforge_project:
 rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
-summary: Supplies TimeOfDay class
-test_files: []
+summary: Supplies TimeOfDay and Shift class
+test_files:
+- test/support/active_record.rb
+- test/test_helper.rb
+- test/tod/a_a_a_time_of_day_time_zone_without_active_support_test.rb
+- test/tod/date_test.rb
+- test/tod/shift_test.rb
+- test/tod/time_of_day_serializable_attribute_test.rb
+- test/tod/time_of_day_test.rb
+- test/tod/time_of_day_time_zone_with_active_support_test.rb
+- test/tod/time_test.rb
+has_rdoc: