relativity 0.0.7 → 0.0.8

data/Changelog.rdoc

@@ -1,3 +1,8 @@
+0.0.8 2012-02-15:
+* DayTime.normalize
+* DayTimeRange.normalize
+* useful for persisting to a database column
+
 0.0.7 2012-02-15:
 * Allow arbitrary separator and parse it automatically
 * The default_separator for DayTimeRange is removed

data/README.rdoc

@@ -32,3 +32,33 @@ ranges of opening hours can be represented.
 
   wrong_format = DayTimeRange.new("11 to 15", :separator => '..')
   Relativity::InvalidRangeFormatError: Maybe the range separator was not set correctly? Separator used was ".."
+
+  # normalize is intended for persisting a DayTime and DayTimeRange.
+
+  DayTime.normalize("8") # => "08:00:00"
+  DayTime.normalize(nil) # => nil
+  DayTimeRange.normalize("8..12") # => "08:00:00..12:00:00"
+  DayTimeRange.normalize("8 to 12", :separator => "..")
+  # => Relativity::InvalidRangeFormatError: Maybe the range separator\
+       was not set correctly? Separator used was ".."
+  DayTimeRange.normalize(nil) # => nil
+
+  # usage in ActiveRecord (>= 3.2.x)
+
+  class Shop < ActiveRecord::Base
+
+    def opening_hours=(dtr)
+      super(
+        begin
+          DayTimeRange.normalize(dtr, separator => '..')
+        rescue Relativity::FormatError
+          nil # or set a special error code here
+        end)
+      end
+    end
+
+    def opening_hours
+      dtr = super and DayTimeRange.new(dtr, :separator => '..')
+    end
+
+  end

data/lib/relativity/day_time/new.rb

@@ -2,7 +2,7 @@ module DayTime::New
 
   attr_reader :seconds_since_midnight
 
-  def initialize(first= nil, minutes = nil, seconds = nil, nano_seconds = nil)
+  def initialize(first = (no_args = true; nil), minutes = nil, seconds = nil, nano_seconds = nil)
     super()
     case first
     when Integer
@@ -14,6 +14,7 @@ module DayTime::New
       hh, mm, ss = hh_mm_ss_from_string(first)
       nn = 0
     else
+      raise Relativity::InvalidFormatError unless no_args
       t = Time.new
       hh = t.hour
       mm = t.min

data/lib/relativity/day_time.rb

@@ -25,4 +25,9 @@ class DayTime
     match_hh + match_mm + match_ss
   end
 
+  def self.normalize(*args)
+    return nil if args == [nil]
+    new(*args).to_s
+  end
+
 end

data/lib/relativity/day_time_range.rb

@@ -9,6 +9,8 @@ class DayTimeRange
       case first
       when String
         start_end_from_string(first, second)
+      else
+        raise Relativity::InvalidRangeFormatError
       end
   end
 
@@ -24,6 +26,11 @@ class DayTimeRange
     start.to_s + @separator + self.end.to_s
   end
 
+  def self.normalize(*args)
+    return nil if args[0] == nil
+    new(*args).to_s
+  end
+
 private
 
   def start_end_from_string(input, options)

data/lib/relativity/exception.rb

@@ -1,12 +1,15 @@
 module Relativity
 
-  class InternalError < RuntimeError
+  class InternalError < ::RuntimeError
   end
 
-  class InvalidFormatError < ArgumentError
+  class FormatError < ::ArgumentError
   end
 
-  class InvalidRangeFormatError < ArgumentError
+  class InvalidFormatError < FormatError
+  end
+
+  class InvalidRangeFormatError < FormatError
     def initialize(options = {})
       @options = options
     end

data/lib/relativity/version.rb

@@ -1,3 +1,3 @@
 module Relativity
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/spec/day_time/class_methods_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe DayTime, "normalize" do
+
+  it "normalize with 1 argument" do
+    DayTime.normalize("8").should == "08:00:00"
+  end
+
+  it "incorrect entry raises error" do
+    lambda {DayTime.normalize("A")}.should raise_error Relativity::InvalidFormatError
+  end
+
+  it "with nil returns nil" do
+    DayTime.normalize(nil).should be_nil
+  end
+
+end

data/spec/day_time/new_spec.rb

@@ -3,7 +3,11 @@ require 'spec_helper'
 describe DayTime do
 
   it "new builds a DayTime" do
-    lambda { subject }.should_not raise_error
+    subject
+  end
+
+  it "new(nil) fails" do
+    lambda {DayTime.new(nil)}.should raise_error(Relativity::InvalidFormatError)
   end
 
   it "new creates a DayTime close to now" do

data/spec/day_time_range/class_methods_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe DayTimeRange, "normalize" do
+
+  it "normalizes with 1 argument" do
+    DayTimeRange.normalize("8 until 11").should == "08:00:00 until 11:00:00"
+  end
+
+  it "incorrect entry raises error" do
+    lambda {DayTimeRange.normalize("8")}.should raise_error Relativity::InvalidRangeFormatError
+  end
+
+  it "checks separator" do
+    lambda {DayTimeRange.normalize("8..10", :separator => "to")}.should raise_error Relativity::InvalidRangeFormatError
+  end
+
+  it "with nil returns nil" do
+    DayTimeRange.normalize(nil).should be_nil
+  end
+
+  it "with nil, second_arg returns nil" do
+    DayTimeRange.normalize(nil, :second_arg).should be_nil
+  end
+
+end

data/spec/day_time_range/new_spec.rb

@@ -6,6 +6,10 @@ describe DayTimeRange do
     DayTimeRange.new("8 until 11").should_not be_nil
   end
 
+  it "new(nil) raises error" do
+    lambda {DayTimeRange.new(nil)}.should raise_error Relativity::InvalidRangeFormatError
+  end
+
   it "start day_time is correct" do
     dtr = DayTimeRange.new("8 until 11")
     dtr.start.should == DayTime.new(8)

data/spec/exception_spec.rb

@@ -8,12 +8,16 @@ module Relativity
       Relativity::InternalError.new.should be_a(RuntimeError)
     end
 
-    it "InvalidFormatError derived from ArgumentError" do
-      Relativity::InvalidFormatError.new.should be_a(ArgumentError)
+    it "FormatError derived from ArgumentError" do
+      Relativity::FormatError.new.should be_a(ArgumentError)
     end
 
-    it "InvalidRangeFormatError derived from ArgumentError" do
-      Relativity::InvalidRangeFormatError.new.should be_a(ArgumentError)
+    it "InvalidFormatError derived from FormatError" do
+      Relativity::InvalidFormatError.new.should be_a(Relativity::FormatError)
+    end
+
+    it "InvalidRangeFormatError derived from FormatError" do
+      Relativity::InvalidRangeFormatError.new.should be_a(Relativity::FormatError)
     end
 
     it "InvalidRangeFormatError accepts a hash with separator" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: relativity
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &80499580 !ruby/object:Gem::Requirement
+  requirement: &83122250 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '2.7'
   type: :development
   prerelease: false
-  version_requirements: *80499580
+  version_requirements: *83122250
 description: time and time_ranges relative to day, week, month, quarter etc.
 email:
 - peter@vandenabeele.com
@@ -49,12 +49,14 @@ files:
 - lib/relativity/version.rb
 - lib/relativity/week_time.rb
 - relativity.gemspec
+- spec/day_time/class_methods_spec.rb
 - spec/day_time/comparison_spec.rb
 - spec/day_time/conversions_spec.rb
 - spec/day_time/exception_spec.rb
 - spec/day_time/new_spec.rb
 - spec/day_time/output_spec.rb
 - spec/day_time/overflow_spec.rb
+- spec/day_time_range/class_methods_spec.rb
 - spec/day_time_range/marshal_spec.rb
 - spec/day_time_range/new_spec.rb
 - spec/day_time_range/output_spec.rb
@@ -82,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: time and time_ranges relative to day, week, month, quarter etc.