relativity 0.0.5 → 0.0.6

data/Changelog.rdoc

@@ -1,25 +1,22 @@
-0.0.5 2012-02-06:
+0.0.6 2012-02-07:
+* DayTimeRange input/output now useable
+* DayTimeRange exceptions improved
 
+0.0.5 2012-02-06:
 * DayTimeRange can now be created
-
 * DayTime.new("8:30") now takes a string
 
 0.0.4 2012-01-17:
-
 * Revert seconds_since_start to seconds_since_midnight
-  ("start" was arbitrary; "midnight" is a real world reference)
-
+("start" was arbitrary; "midnight" is a real world reference)
 * Added an Relativity::Exception class
 
 0.0.3 2012-01-12
-
 * Change RelativeTime into DayTime
 * Added an initial DayTimeRange class
 
 0.0.2 2012-01-12
-
 * Add the MIT license
 
 0.0.1 2012-01-11
-
 * Initial version with minimal TimeRelative functionality

data/README.rdoc

@@ -23,10 +23,13 @@ ranges of opening hours can be represented.
   dt.seconds #=> 40
   dt.nano_seconds #=> 568257238
 
+  DayTimeRange.default_separator # => " until "
   dtr = DayTimeRange.new("8 until 12:30")
   # => #<DayTimeRange:0x9bfa4ec @start_day_time=08:00:00, @end_day_time=12:30:00>
   dtr.start # => 08:00:00
   dtr.end # => 12:30:00
+  dtr.to_s # => "08:00:00 until 12:30:00"
 
   night_shift = DayTimeRange.new("21:45..06:05", :separator => '..')
   # => #<DayTimeRange:0x9b997dc @start_day_time=21:45:00, @end_day_time=06:05:00>
+  night_shift.to_s # => "21:45..06:05"

data/lib/relativity/day_time/conversions.rb

@@ -19,11 +19,7 @@ module DayTime::Conversions
   end
 
   def to_s
-    [hours, minutes, seconds].map{|e| rjust_2_0(e.to_s)}.join(self.class.separator)
-  end
-
-  def self.separator
-    ':'
+    [hours, minutes, seconds].map{|e| rjust_2_0(e.to_s)}.join(self.class.default_separator)
   end
 
 private

data/lib/relativity/day_time/new.rb

@@ -26,16 +26,16 @@ module DayTime::New
 private
 
   def hh_mm_ss_from_string(input)
-    separator = self.class.separator
-    separator = Regexp.escape(separator) # e.g. separator is '.'
+    separator = self.class.default_separator
+    esc_separator = Regexp.escape(separator) # e.g. separator is '.'
     input.strip!
     match_hh = '(?<hh>\d\d?)'
-    match_mm = '(' + separator + '(?<mm>\d\d?))?'
-    match_ss = '(' + separator + '(?<ss>\d\d?))?'
+    match_mm = '(' + esc_separator + '(?<mm>\d\d?))?'
+    match_ss = '(' + esc_separator + '(?<ss>\d\d?))?'
     matcher = '\A' + match_hh + match_mm + match_ss + '\Z'
     r = Regexp.new(matcher)
     matchdata = r.match(input)
-    raise Relativity::InvalidFormat if matchdata.nil?
+    raise Relativity::InvalidFormatError if matchdata.nil?
     return [matchdata[:hh].to_i, matchdata[:mm].to_i, matchdata[:ss].to_i]
   end
 

data/lib/relativity/day_time.rb

@@ -8,7 +8,7 @@ class DayTime
   include DayTime::New
   include DayTime::Conversions
 
-  def self.separator
+  def self.default_separator
     ':'
   end
 

data/lib/relativity/day_time_range.rb

@@ -1,7 +1,10 @@
 class DayTimeRange
 
+  attr_accessor :separator
+
   def initialize(first, second = nil)
     super()
+    # NOTE don't forget to set the @separator
     @start_day_time, @end_day_time =
       case first
       when String
@@ -17,18 +20,23 @@ class DayTimeRange
     @end_day_time
   end
 
-  def self.separator
+  def to_s
+    start.to_s + @separator + self.end.to_s
+  end
+
+  def self.default_separator
     " until "
   end
 
 private
 
   def start_end_from_string(input, options)
-    separator = (options && options[:separator]) || self.class.separator
-    separator = Regexp.escape(separator)
-    matcher = '\A(?<start>.+)' + separator + '(?<end>.+)\Z'
+    @separator = (options && options[:separator]) || self.class.default_separator
+    esc_separator = Regexp.escape(@separator)
+    matcher = '\A(?<start>.+)' + esc_separator + '(?<end>.+)\Z'
     r = Regexp.new(matcher)
     matchdata = r.match(input)
+    raise Relativity::InvalidRangeFormatError.new(:separator => @separator) if matchdata.nil?
     return [DayTime.new(matchdata[:start]), DayTime.new(matchdata[:end])]
   end
 

data/lib/relativity/exception.rb

@@ -3,7 +3,16 @@ module Relativity
   class InternalError < RuntimeError
   end
 
-  class InvalidFormat < ArgumentError
+  class InvalidFormatError < ArgumentError
+  end
+
+  class InvalidRangeFormatError < ArgumentError
+    def initialize(options = {})
+      @options = options
+    end
+    def to_s
+      "Maybe the range separator was not set correctly? Separator used was \"#{@options[:separator]}\""
+    end
   end
 
 end

data/lib/relativity/version.rb

@@ -1,3 +1,3 @@
 module Relativity
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/spec/day_time/new_spec.rb

@@ -70,7 +70,7 @@ describe DayTime do
   end
 
   it 'new with string rejects too much separators' do
-    lambda { DayTime.new("8:35:30:45") }.should raise_error Relativity::InvalidFormat
+    lambda {DayTime.new("8:35:30:45")}.should raise_error Relativity::InvalidFormatError
   end
 
 end

data/spec/day_time_range/new_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe DayTimeRange do
 
   it "builds new with 1 argument" do
-    lambda { DayTimeRange.new("8 until 11") }.should_not raise_error
+    DayTimeRange.new("8 until 11").should_not be_nil
   end
 
   it "start day_time is correct" do

data/spec/day_time_range/output_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe DayTimeRange do
+
+  context "output" do
+
+    it 'does "HH:MM:SS until HH:MM:SS" for to_s' do
+      dtr = DayTimeRange.new("22 until 06:30")
+      dtr.to_s.should match(/\A\d\d:\d\d:\d\d until \d\d:\d\d:\d\d\Z/)
+    end
+
+    it "does correct hours, minutes, seconds for to_s" do
+      dtr = DayTimeRange.new("22 until 06:30")
+      dtr.to_s.should == "22:00:00 until 06:30:00"
+    end
+
+    it 'setting the separator is used for to_s' do
+      dtr = DayTimeRange.new("22 until 06:30")
+      dtr.separator = '..'
+      dtr.to_s.should match(/\d..\d/)
+    end
+
+    #NOTE this is an integration test (many features in 1 test)
+    it 'uses the separator used for initializing also for to_s' do
+      dtr = DayTimeRange.new(" 22..06:30 ", :separator => '..')
+      dtr.to_s.should == "22:00:00..06:30:00"
+    end
+
+  end
+end

data/spec/day_time_range/parsing_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe DayTimeRange do
 
   it "default separator is ' until '" do
-    DayTimeRange.separator.should == ' until '
+    DayTimeRange.default_separator.should == ' until '
   end
 
   it "start time is correct" do
@@ -11,14 +11,38 @@ describe DayTimeRange do
     dtr.start.should == DayTime.new(8)
   end
 
-  it "start time is correct" do
+  it "parsing is correct with other separator" do
     dtr = DayTimeRange.new("8 - 11", :separator => " - ")
     dtr.start.should == DayTime.new(8)
   end
 
-  it "start time is correct" do
+  it "parsing is correct with separator without spaces" do
     dtr = DayTimeRange.new("8..11", :separator => "..")
     dtr.start.should == DayTime.new(8)
   end
 
+  it "InvalidRangeFormatError is raised with incorrect separator format" do
+    lambda {DayTimeRange.new("8..11")}.should raise_error Relativity::InvalidRangeFormatError
+  end
+
+  it "Exception with separator message is raised with incorrect separator format" do
+    lambda {DayTimeRange.new("8..11")}.should raise_error 'Maybe the range separator was not set correctly? Separator used was " until "'
+  end
+
+  it "parsing with other separator remembers the separator" do
+    dtr = DayTimeRange.new("8 - 11", :separator => " - ")
+    dtr.separator.should == " - "
+  end
+
+  it "sets the separator" do
+    dtr = DayTimeRange.new("8 - 11", :separator => " - ")
+    dtr.separator = ".."
+    dtr.separator.should == ".."
+  end
+
+  it "not setting separator returns default_separator" do
+    dtr = DayTimeRange.new("8 until 11")
+    dtr.separator.should == dtr.class.default_separator
+  end
+
 end

data/spec/exception_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+module Relativity
+
+  describe "Exceptions" do
+
+    it "InternalError derived from RuntimeError" do
+      Relativity::InternalError.new.should be_a(RuntimeError)
+    end
+
+    it "InvalidFormatError derived from ArgumentError" do
+      Relativity::InvalidFormatError.new.should be_a(ArgumentError)
+    end
+
+    it "InvalidRangeFormatError derived from ArgumentError" do
+      Relativity::InvalidRangeFormatError.new.should be_a(ArgumentError)
+    end
+
+    it "InvalidRangeFormatError accepts a hash with separator" do
+      lambda {e = Relativity::InvalidRangeFormatError.new(:separator => "abcd")}.
+        should_not raise_error
+    end
+
+    it "InvalidRangeFormatError gives a tailured message" do
+      e = Relativity::InvalidRangeFormatError.new(:separator => "abcd")
+      e.message.should == 'Maybe the range separator was not set correctly? Separator used was "abcd"'
+    end
+
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: relativity
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-06 00:00:00.000000000 Z
+date: 2012-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &78729730 !ruby/object:Gem::Requirement
+  requirement: &80549700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '2.7'
   type: :development
   prerelease: false
-  version_requirements: *78729730
+  version_requirements: *80549700
 description: time and time_ranges relative to day, week, month, quarter etc.
 email:
 - peter@vandenabeele.com
@@ -56,7 +56,9 @@ files:
 - spec/day_time/output_spec.rb
 - spec/day_time/overflow_spec.rb
 - spec/day_time_range/new_spec.rb
+- spec/day_time_range/output_spec.rb
 - spec/day_time_range/parsing_spec.rb
+- spec/exception_spec.rb
 - spec/spec_helper.rb
 - spec/week_time/week_time_spec.rb
 homepage: https://github.com/petervandenabeele/relativity
@@ -79,7 +81,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.