tod 3.0.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8986b140f4dcc736d253b188cd5f9a46a72110f38887cd6e8ff93ecee823c438
-  data.tar.gz: 95d31c83abc1264946bf2ce6aa6ba6fac45dcaeca1362b76a22d54eab27f402f
+  metadata.gz: 9abbaa919b6c5095de1d85a9e4db5da1160d4d80038515366502c2144d007b75
+  data.tar.gz: 87106d404f688c2ba9997b18874172440f34f7bcacfe35f41c693309693c7654
 SHA512:
-  metadata.gz: 2d1c3b50deb1df502928666b38e113fb7d58b4a25c140119bac8155ad3ff3add0689cffba810b7bdd6ab1461493838873a839ac259895630210e47679ae9ef89
-  data.tar.gz: 98a76ddcb2b8c866f602efe1def27c236b88ffcc6bbb12812580794113dc964d5b6df1bd95b0f055a48e9e95ca4b69ccf3dea93b20f866ca72be7932596e1aaf
+  metadata.gz: a890e3dc2b7aee24401388d8d85214c01e0f730c0547a61f7c46d9a097dce842fccf2a43836d46e52af3eba87f1df2c9aa2bd13fe6f10f5e780b085e43b9741d
+  data.tar.gz: f6bdb357ba0c50aaba4b30f84038378a5418112776452832b2bfa8a53313975c88ca7caea2cdc8f4701acc7206b55dab19dfd08a3eb32214e3cf53f0fa771760

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+# 3.1.1 (June 11, 2023)
+
+* Allow use in Rails forms with time_select (Bill Pearce)
+* Prevent error when comparing a range to nil (Chris Northwood)
+
+# 3.1.0 (December 20, 2021)
+
+* Allow / ignore parsing milliseconds (Eli Fatsi)
+* Improve TimeOfDate#inspect and Shift#inspect (zverok)
+* Fix Shift#contains? with exclusive ending (nazamoresco)
+
 # 3.0.0 (March 6, 2021)
 
 * Support and require Rails 6

data/Gemfile.lock

@@ -1,40 +1,40 @@
 PATH
   remote: .
   specs:
-    tod (3.0.0)
+    tod (3.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.1.3)
-      activesupport (= 6.1.3)
-    activerecord (6.1.3)
-      activemodel (= 6.1.3)
-      activesupport (= 6.1.3)
-    activesupport (6.1.3)
+    activemodel (7.0.5)
+      activesupport (= 7.0.5)
+    activerecord (7.0.5)
+      activemodel (= 7.0.5)
+      activesupport (= 7.0.5)
+    activesupport (7.0.5)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
     byebug (11.1.3)
     coderay (1.1.3)
-    concurrent-ruby (1.1.8)
-    i18n (1.8.9)
+    concurrent-ruby (1.2.2)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     method_source (1.0.0)
-    minitest (5.14.4)
-    pry (0.13.1)
+    mini_portile2 (2.8.2)
+    minitest (5.18.0)
+    pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    pry-byebug (3.9.0)
+    pry-byebug (3.10.1)
       byebug (~> 11.0)
-      pry (~> 0.13.0)
-    rake (13.0.3)
-    sqlite3 (1.4.2)
-    tzinfo (2.0.4)
+      pry (>= 0.13, < 0.15)
+    rake (13.0.6)
+    sqlite3 (1.6.3)
+      mini_portile2 (~> 2.8.0)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -49,4 +49,4 @@ DEPENDENCIES
   tzinfo
 
 BUNDLED WITH
-   2.0.2
+   2.2.15

data/README.markdown

@@ -182,7 +182,7 @@ Include?
     Tod::Shift.new(Tod::TimeOfDay.new(5), Tod::TimeOfDay.new(9), true).include?(Tod::TimeOfDay.new(9)) # => false
 
 
-Overlap?
+Overlaps?
 --------------------
 
     breakfast = Tod::Shift.new(Tod::TimeOfDay.new(8), Tod::TimeOfDay.new(11))
@@ -201,8 +201,8 @@ Overlap?
 
 Contains?
 --------------------
-    workday = Shift.new(TimeOfDay.new(9), TimeOfDay.new(17))
-    lunch = Shift.new(TimeOfDay.new(10), TimeOfDay.new(14))
+    workday = Tod::Shift.new(Tod::TimeOfDay.new(9), Tod::TimeOfDay.new(17))
+    lunch = Tod::Shift.new(Tod::TimeOfDay.new(10), Tod::TimeOfDay.new(14))
     workday.contains?(lunch) # => true
     lunch.contains?(workday) # => false
 
@@ -234,6 +234,9 @@ in a column of the time type.
 Example:
 
 ```ruby
+ActiveModel::Type.register(:time_only, Tod::TimeOfDayType)
+ActiveRecord::Type.register(:time_only, Tod::TimeOfDayType)
+
 class Order < ActiveRecord::Base
   attribute :time, :time_only
 end
@@ -241,6 +244,18 @@ order = Order.create(time: Tod::TimeOfDay.new(9,30))
 order.time                                      # => 09:30:00
 ```
 
+In Rails, this can be used with `time_select` in forms like so:
+
+```ruby
+f.time_select :time, ignore_date: true
+```
+
+Or with **simple_form**:
+
+```ruby
+f.input :time, as: :time, ignore_date: true
+```
+
 MongoDB Support
 ===============
 

data/lib/tod/shift.rb

@@ -24,6 +24,10 @@ module Tod
       freeze # Shift instances are value objects
     end
 
+    def inspect
+      "#<#{self.class} #{beginning}#{exclude_end? ? '...' : '..'}#{ending}>"
+    end
+
     # Returns true if the time of day is inside the shift, false otherwise.
     def include?(tod)
       second = tod.to_i
@@ -70,7 +74,7 @@ module Tod
     end
 
     def contains?(shift)
-      self.include?(shift.beginning) && self.include?(shift.ending)
+      self.include?(shift.beginning) && self.include?(shift.inclusive_ending)
     end
 
     # Return shift duration in seconds.
@@ -84,11 +88,11 @@ module Tod
     end
 
     def ==(other)
-      @range == other.range
+      !other.nil? && @range == other.range
     end
 
     def eql?(other)
-      @range.eql?(other.range)
+      !other.nil? && @range.eql?(other.range)
     end
 
     def hash
@@ -99,5 +103,12 @@ module Tod
     def slide(seconds)
       self.class.new(beginning + seconds, ending + seconds, exclude_end?)
     end
+
+    protected
+
+    # If exclusive ending returns equivalent ending but inclusive
+    def inclusive_ending
+      self.exclude_end? ? ending - 1 : ending
+    end
   end
 end

data/lib/tod/time_of_day.rb

@@ -14,6 +14,7 @@ module Tod
       ([0-5]\d)?
       :?
       ([0-5]\d)?
+      (?:\.\d{3})?
       \z
     /x
 
@@ -24,6 +25,7 @@ module Tod
       ([0-5]\d)?
       :?
       ([0-5]\d)?
+      (?:\.\d{3})?
       \s*
       ([ap])
       \.?
@@ -110,6 +112,10 @@ module Tod
       to_s
     end
 
+    def inspect
+      "#<#{self.class} #{self}>"
+    end
+
     # Return a new TimeOfDay num_seconds greater than self. It will wrap around
     # at midnight.
     def +(num_seconds)

data/lib/tod/time_of_day_type.rb

@@ -4,7 +4,7 @@ module Tod
       if value.is_a? Hash
           # rails multiparam attribute
           # get hour, minute and second and construct new TimeOfDay object
-        ::Tod::TimeOfDay.new(value[4], value[5], value[6])
+        ::Tod::TimeOfDay.new(value[4], value[5], value[6] || 0)
       else
         # return nil, if input is not parsable
         Tod::TimeOfDay(value){}

data/lib/tod/version.rb

@@ -1,3 +1,3 @@
 module Tod
-  VERSION = "3.0.0"
+  VERSION = "3.1.1"
 end

data/test/test_helper.rb

@@ -1,6 +1,7 @@
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__),'..','lib')
 
 require 'bundler/setup'
+require 'active_support'
 require 'active_support/time'
 require 'tod'
 require 'tod/core_extensions'

data/test/tod/conversion_test.rb

@@ -88,4 +88,18 @@ describe "TimeOfDay()" do
 
     assert_equal(tod, Tod::TimeOfDay.new(24, 00, 00))
   end
+
+  it "parses 24:00:00.000" do
+    t   = "24:00:00.000"
+    tod = Tod::TimeOfDay(t)
+
+    assert_equal(tod, Tod::TimeOfDay.new(24, 00, 00))
+  end
+
+  it "parses 04:00:00.000 pm" do
+    t   = "04:00:00.000 pm"
+    tod = Tod::TimeOfDay(t)
+
+    assert_equal(tod, Tod::TimeOfDay.new(16, 00, 00))
+  end
 end

data/test/tod/shift_test.rb

@@ -11,6 +11,16 @@ describe "Shift" do
     end
   end
 
+  describe "inspect" do
+    it "provides friendly description" do
+      shift = Tod::Shift.new Tod::TimeOfDay.new(8), Tod::TimeOfDay.new(10), false
+      assert_equal "#<Tod::Shift 08:00:00..10:00:00>", shift.inspect
+
+      shift = Tod::Shift.new Tod::TimeOfDay.new(8), Tod::TimeOfDay.new(10), true
+      assert_equal "#<Tod::Shift 08:00:00...10:00:00>", shift.inspect
+    end
+  end
+
   describe "#duration" do
     it "returns 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
@@ -162,6 +172,12 @@ describe "Shift" do
       shift2 = Tod::Shift.new(Tod::TimeOfDay.new(18), Tod::TimeOfDay.new(19))
       refute shift1.contains?(shift2)
     end
+
+    it "is true when beginning is included and exclusive endings match" do
+      inside = Tod::Shift.new(Tod::TimeOfDay.new(13), Tod::TimeOfDay.new(17), true)
+      outside = Tod::Shift.new(Tod::TimeOfDay.new(10), Tod::TimeOfDay.new(17), true)
+      assert outside.contains?(inside)
+    end
   end
 
   describe "#include?" do
@@ -279,6 +295,13 @@ describe "Shift" do
       shift2 = Tod::Shift.new tod1, tod2, true
       assert !(shift1 == shift2)
     end
+
+    it "is false when one side is nil" do
+      tod1 = Tod::TimeOfDay.new 8,30
+      tod2 = Tod::TimeOfDay.new 13,00,30
+      shift = Tod::Shift.new tod1, tod2
+      assert !(shift == nil)
+    end
   end
 
   describe "#eql?" do
@@ -313,6 +336,13 @@ describe "Shift" do
       shift2 = Tod::Shift.new tod1, tod2, true
       assert !shift1.eql?(shift2)
     end
+
+    it "is false when one side is nil" do
+      tod1 = Tod::TimeOfDay.new 8,30
+      tod2 = Tod::TimeOfDay.new 13,00,30
+      shift = Tod::Shift.new tod1, tod2
+      assert !shift.eql?(nil )
+    end
   end
 
   describe "#hash" do

data/test/tod/time_of_day_attribute_test.rb

@@ -24,6 +24,11 @@ describe "TimeOfDay with ActiveRecord Attribute" do
     assert_equal Tod::TimeOfDay.new(8,6,5), order.time
   end
 
+  it "works with multiparam time arguments without seconds" do
+    order = Order.create!({"time(4i)" => "8", "time(5i)" => "6"})
+    assert_equal Tod::TimeOfDay.new(8,6,0), order.time
+  end
+
   it "should not raise Exception on access of unparsable values" do
     order = Order.new(time: 'unparsable')
     order.time

data/test/tod/time_of_day_test.rb

@@ -190,6 +190,13 @@ describe "TimeOfDay" do
     end
   end
 
+  describe "inspect" do
+    it "is friendly representation" do
+      t = Tod::TimeOfDay.new(12,15,05)
+      assert_equal "#<Tod::TimeOfDay 12:15:05>", t.inspect
+    end
+  end
+
   describe "to_i" do
     it "formats to integer" do
       assert_equal 29730, Tod::TimeOfDay.new(8,15,30).to_i

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tod
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.1
 platform: ruby
 authors:
 - Jack Christensen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-06 00:00:00.000000000 Z
+date: 2023-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -150,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: Supplies TimeOfDay and Shift class