tod 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 853fd23075cb8c0131b49bae9b571249cf01f940
-  data.tar.gz: 8fcb950ad2f427b980232962831d6ac53c25353a
+  metadata.gz: 859e21d92e38e6ed8e88f2ccde4ba7b65ece6386
+  data.tar.gz: 7e329ea20c81ffb0cd5018d4cd008f4e257a9cfc
 SHA512:
-  metadata.gz: 07c301bb3668574f5d1129d7fcaed0109c50e1a9e85ec663da88d2f863831c703b9f30160cd5078a4d8b7807cb875f8fdb54162551ff2facac491075d0eb445f
-  data.tar.gz: 49b0c82abd08efa118b80cd7c63b3d5c1c034a4e856ac79eea31c626034c868c9683ea825d6c4d6ab159331e19657d7a703eabc7d6aad1a286ac1796ec2e61d5
+  metadata.gz: f7cff04a19eaca1af690f985541192e0070e6a5e0a11b25a5ed03ac10f149180f3e3df9ff19bdb55a58fe9f39878c2fb987313f42b202a8ec73f323306167240
+  data.tar.gz: 60a3e8f699de9196d90c1d99027b8cd9e6f6c3c4b6d4f3259455439ddaa15b0d9203ea8af53c91bbe4a6a6d238e3d71af1757e7d765a3e6790af470ea8501a48

data/README.markdown

@@ -45,6 +45,18 @@ are all optional.
     TimeOfDay.parse "515p"                         # => 17:15:00
     TimeOfDay.parse "151253"                       # => 15:12:53
 
+TimeOfDay.parse raises an ArgumentError is the argument to parse is not
+parsable. TimeOfDay.try_parse will instead return nil if the argument is not
+parsable.
+
+    TimeOfDay.try_parse "3:30pm"                   # => 15:30:00
+    TimeOfDay.try_parse "foo"                      # => nil
+
+Values can be tested with TimeOfDay.parsable? to see if they can be parsed.
+
+    TimeOfDay.parsable? "3:30pm"                   # => true
+    TimeOfDay.parsable? "foo"                      # => false
+
 Adding or subtracting time
 -----------------------------
 
@@ -87,6 +99,16 @@ 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
 
+Conversion method
+-----------------
+
+Tod provides a conversion method which will handle a variety of input types:
+
+    TimeOfDay(TimeOfDay.new(8, 30))           # => 08:30:00
+    TimeOfDay("09:45")                        # => 09:45:00
+    TimeOfDay(Time.new(2014, 1, 1, 12, 30))   # => 12:30:00
+    TimeOfDay(Date.new(2014, 1, 1))           # => 00:00:00
+
 
 Shifts
 =======================
@@ -144,6 +166,11 @@ 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.4.0 (April 3, 2014)
+
+* Add try_parse (Stuart Olivera)
+* Add parse? (Stuart Olivera)
+
 ## 1.3.0 (December 9, 2013)
 
 * Add Shift class (Pablo Russo)

data/lib/tod/conversions.rb

@@ -0,0 +1,15 @@
+module Tod
+  module Conversions
+    module_function
+
+    def TimeOfDay(obj_or_string)
+      if obj_or_string.is_a?(TimeOfDay)
+        obj_or_string
+      elsif obj_or_string.respond_to?(:to_time_of_day)
+        obj_or_string.to_time_of_day
+      else
+        TimeOfDay.parse(obj_or_string)
+      end
+    end
+  end
+end

data/lib/tod/mongoization.rb

@@ -0,0 +1,36 @@
+module Tod
+  module Mongoization
+
+    # Converts an object of this instance into a database friendly value.
+    def mongoize
+      to_s
+    end
+
+    module ClassMethods
+
+      # Get the object as it was stored in the database, and instantiate
+      # this custom class from it.
+      def demongoize(object)
+        Tod::TimeOfDay.parse(object) if object
+      end
+
+      # Takes any possible object and converts it to how it would be
+      # stored in the database.
+      def mongoize(object)
+        case object
+        when TimeOfDay then object.mongoize
+        else object
+        end
+      end
+
+      # Converts the object that was supplied to a criteria and converts it
+      # into a database friendly form.
+      def evolve(object)
+        case object
+        when TimeOfDay then object.mongoize
+        else object
+        end
+      end
+    end
+  end
+end

data/lib/tod/time_of_day.rb

@@ -113,6 +113,15 @@ module Tod
     #   TimeOfDay.parse "515p"                         # => 17:15:00
     #   TimeOfDay.parse "151253"                       # => 15:12:53
     def self.parse(tod_string)
+      try_parse(tod_string) || (raise ArgumentError, "Invalid time of day string")
+    end
+
+    # Same as parse(), but return nil if not parsable (instead of raising an error)
+    #   TimeOfDay.try_parse "8am"                      # => 08:00:00
+    #   TimeOfDay.try_parse ""                         # => nil
+    #   TimeOfDay.try_parse "abc"                      # => nil
+    def self.try_parse(tod_string)
+      tod_string = tod_string.to_s
       tod_string = tod_string.strip
       tod_string = tod_string.downcase
       if PARSE_24H_REGEX =~ tod_string || PARSE_12H_REGEX =~ tod_string
@@ -125,10 +134,17 @@ module Tod
 
         new hour, minute, second
       else
-        raise ArgumentError, "Invalid time of day string"
+        nil
       end
     end
 
+    # Determine if a string is parsable into a TimeOfDay instance
+    #   TimeOfDay.parsable? "8am"                      # => true
+    #   TimeOfDay.parsable? "abc"                      # => false
+    def self.parsable?(tod_string)
+      !!try_parse(tod_string)
+    end
+
     # If ActiveSupport TimeZone is available and set use current time zone else return Time
     def self.time_zone
       (Time.respond_to?(:zone) && Time.zone) || Time
@@ -150,6 +166,4 @@ module Tod
       end
     end
   end
-end
-
-TimeOfDay = Tod::TimeOfDay
+end

data/lib/tod/version.rb

@@ -1,3 +1,3 @@
 module Tod
-  VERSION = "1.3.0"
+  VERSION = "1.4.0"
 end

data/lib/tod.rb

@@ -2,3 +2,12 @@ require 'tod/time_of_day'
 require 'tod/date'
 require 'tod/time'
 require 'tod/shift'
+require 'tod/conversions'
+require 'tod/mongoization'
+
+include Tod
+include Tod::Conversions
+class TimeOfDay
+  include(Tod::Mongoization)
+  extend(Tod::Mongoization::ClassMethods)
+end

data/test/tod/conversion_test.rb

@@ -0,0 +1,36 @@
+require File.expand_path(File.join(File.dirname(__FILE__),'..','test_helper'))
+require 'active_support/time'
+
+class TimeOfDayConversionTest < Test::Unit::TestCase
+  should "handle TimeOfDay" do
+    t   = TimeOfDay.new(13, 56, 12)
+    tod = TimeOfDay(t)
+
+    assert_equal(t, tod)
+  end
+  should "handle Time" do
+    t   = Time.new(2014, 2, 27, 12, 01, 02)
+    tod = TimeOfDay(t)
+
+    assert_equal(tod, TimeOfDay.new(12, 01, 02))
+  end
+  should "handle Date" do
+    t   = Date.new(2014, 2, 27)
+    tod = TimeOfDay(t)
+
+    assert_equal(tod, TimeOfDay.new(0, 0, 0))
+  end
+  should "handle DateTime" do
+    t   = DateTime.new(2014, 2, 27, 12, 01, 02)
+    tod = TimeOfDay(t)
+
+    assert_equal(tod, TimeOfDay.new(12, 01, 02))
+  end
+  should "string" do
+    t   = "12:01:02"
+    tod = TimeOfDay(t)
+
+    assert_equal(tod, TimeOfDay.new(12, 01, 02))
+  end
+
+end

data/test/tod/time_of_day_test.rb

@@ -42,12 +42,16 @@ class TimeOfDayTest < Test::Unit::TestCase
     expected_tod = TimeOfDay.new expected_hour, expected_minute, expected_second
 
     should "parse '#{parse_string}' into #{expected_tod.inspect}" do
+      assert_equal true, TimeOfDay.parsable?(parse_string)
+      assert_equal expected_tod, TimeOfDay.try_parse(parse_string)
       assert_equal expected_tod, TimeOfDay.parse(parse_string)
     end
   end
 
   def self.should_not_parse(parse_string)
     should "not parse '#{parse_string}'" do
+      assert_equal false, TimeOfDay.parsable?(parse_string)
+      assert_equal nil, TimeOfDay.try_parse(parse_string)
       assert_raise(ArgumentError) { TimeOfDay.parse(parse_string) }
     end
   end
@@ -89,6 +93,15 @@ class TimeOfDayTest < Test::Unit::TestCase
   should_not_parse "13a"
   should_not_parse "13p"
   should_not_parse "10.5"
+  should_not_parse "abc"
+  should_not_parse ""
+  should_not_parse []
+
+  should "not parse 'nil'" do
+    assert_equal false, TimeOfDay.parsable?(nil)
+    assert_equal nil, TimeOfDay.try_parse(nil)
+    assert_raise(ArgumentError) { TimeOfDay.parse(nil) }
+  end
 
   should "provide spaceship operator" do
     assert_equal -1, TimeOfDay.new(8,0,0) <=> TimeOfDay.new(9,0,0)

metadata

@@ -1,111 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: tod
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Jack Christensen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-09 00:00:00.000000000 Z
+date: 2014-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: tzinfo
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Supplies TimeOfDay and Shift class that includes parsing, strftime, comparison,
@@ -116,8 +116,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - MIT-LICENSE
@@ -128,7 +128,9 @@ files:
 - gemfiles/3.2.gemfile
 - gemfiles/4.0.gemfile
 - lib/tod.rb
+- lib/tod/conversions.rb
 - lib/tod/date.rb
+- lib/tod/mongoization.rb
 - lib/tod/shift.rb
 - lib/tod/time.rb
 - lib/tod/time_of_day.rb
@@ -136,6 +138,7 @@ 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/conversion_test.rb
 - test/tod/date_test.rb
 - test/tod/shift_test.rb
 - test/tod/time_of_day_serializable_attribute_test.rb
@@ -152,17 +155,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Supplies TimeOfDay and Shift class
@@ -170,10 +173,10 @@ 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/conversion_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: