timespan 0.5.3 → 0.5.4

data/.rspec

@@ -1 +1 @@
---color
+--color --format nested

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.5.4
+
+- Added subclasses LongDurationRange and ShortDurationRange for long and short durations.

data/README.md

@@ -5,7 +5,7 @@ Use Timespans in Ruby :)
 Will calculate time diff between two dates, then allow you to get the time difference in some time unit as a number.
 
 ```ruby
-	t = Timespan.new(:start => Date.today, :duration => 3.days.ago)
+	t = Timespan.new(:start => Date.today, :duration => 3.days)
 	t.to_days # => 3
 	t.to_weeks # => 0
 	t.to_secs # => 259200
@@ -324,6 +324,18 @@ dr.between?(4.days) # => true
 
 You can also use Range#intersect from *sugar-high* gem to test intersection of time ranges ;)
 
+The duration range by default supports the following units: [seconds, minutes, hours, days, weeks, months, years]
+
+You can subclass the DurationRange to supply your own list of time units to fit your particular scenario.
+
+This gem comes with two subclasses:
+
+`ShortDurationRange` and `LongDurationRange`
+
+They both override the method `#allowed_units` to provide a particular list:
+
+`ShortDurationRange` supports time ranges less than a day, whereas `LongDurationRange` only supports time ranges of a day or more.
+
 ## Client side helpers
 
 This gem now includes som javascript assets to assist in performing date and timespan (duration) calculations on the client side also:

data/VERSION

@@ -1 +1 @@
-0.5.3
+0.5.4

data/lib/timespan/core_ext/range.rb

@@ -23,10 +23,25 @@ class DurationRange < DelegateDecorator
   def initialize range, unit = :minutes
     range = (0..60) if range.min == nil || range.max == nil  
     super(range, except: %w{to_s to_str})
-    @unit = unit.to_s.pluralize.to_sym
+    unit = unit.to_s.pluralize.to_sym
+
+    unless allowed_unit? unit
+      raise ArgumentError, "Unit #{unit} not valid, only: #{allowed_units} are valid" 
+    end
+
+    @unit = unit
+    
     @range = range
   end
 
+  def allowed_unit? unit
+    allowed_units.include? unit.to_sym
+  end
+
+  def allowed_units
+    [:seconds, :minutes, :hours, :days, :weeks, :months, :years]
+  end
+
   def to_str
     to_s
   end
@@ -122,10 +137,22 @@ class DurationRange < DelegateDecorator
         end 
       end
     end
-
   end 
 end
 
+class LongDurationRange < DurationRange
+  def allowed_units
+    [:days, :weeks, :months, :years]
+  end
+end
+
+class ShortDurationRange < DurationRange
+  def allowed_units
+    [:seconds, :minutes, :hours]
+  end
+end  
+
+
 class Range
   [:seconds, :minutes, :hours, :days, :weeks, :months, :years].each do |unit|
     define_method unit do |type = :duration|

data/lib/timespan/mongoid/mongoid_3x.rb

@@ -76,7 +76,7 @@ class Timespan
     end
 
     def custom_specify(name, operator, value, options = {})
-      puts "custom_specify: #{name}"
+      # puts "custom_specify: #{name}"
       timespan = value.__evolve_to_timespan__
       case operator
         when '$gte', '$gt', '$lt', '$lte', '$eq', '$between', '$btw'
@@ -97,7 +97,7 @@ class Timespan
         query['from']['$gte'] = Serializer.serialize_time(timespan.min)
         query['to']['$lte'] = Serializer.serialize_time(timespan.max)
       end
-      puts "query: #{query}"
+      # puts "query: #{query}"
       query
     end
   end

data/spec/timespan/core_ext/duration_range_spec.rb

@@ -22,6 +22,12 @@ describe DurationRange do
 
   let(:range) { (1..5) }
 
+  context 'invalid range unit' do  
+    it 'should not allow invalid time unit' do
+      expect { DurationRange.new range, :yuppies }.to raise_error
+    end
+  end
+
   context 'day range' do
     let (:timerange) { range.days }
 
@@ -57,4 +63,40 @@ describe DurationRange do
     its(:max) { should == 5.years }
     its(:unit) { should == :years }
   end
+end
+
+describe LongDurationRange do
+  subject { timerange }
+
+  let(:range) { (1..5) }
+
+  context 'invalid range unit' do  
+    it 'should not allow invalid time unit' do
+      expect { LongDurationRange.new range, :hours }.to raise_error
+    end
+  end
+
+  context 'valid range unit' do  
+    it 'should allow valid long time unit' do
+      expect { LongDurationRange.new range, :day }.to_not raise_error
+    end
+  end
+end
+
+describe ShortDurationRange do
+  subject { timerange }
+
+  let(:range) { (1..5) }
+
+  context 'invalid range unit' do  
+    it 'should not allow invalid time unit' do
+      expect { ShortDurationRange.new range, :day }.to raise_error
+    end
+  end
+
+  context 'valid range unit' do  
+    it 'should allow valid long time unit' do
+      expect { ShortDurationRange.new range, :hour }.to_not raise_error
+    end
+  end
 end

data/timespan.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "timespan"
-  s.version = "0.5.3"
+  s.version = "0.5.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristian Mandrup"]
-  s.date = "2012-12-12"
+  s.date = "2013-01-25"
   s.description = "Makes it easy to calculate time distance in different units"
   s.email = "kmandrup@gmail.com"
   s.extra_rdoc_files = [
@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
     ".rspec",
+    "CHANGELOG.md",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: timespan
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-12 00:00:00.000000000 Z
+date: 2013-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chronic
@@ -245,6 +245,7 @@ extra_rdoc_files:
 files:
 - .document
 - .rspec
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -308,7 +309,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1354784355607378735
+      hash: 297766673639236930
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: