time_frame 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bff74b0836d124c9e908e78228d6d2d6ce69a5c3
-  data.tar.gz: 2f508be6ca07c0d76e33c09da5491c69ebceed95
+  metadata.gz: f106979451ecad285f797d3da950839ab3f06af0
+  data.tar.gz: b1140e0f5bc73bbcf1ec5a8dd467057f7094b57c
 SHA512:
-  metadata.gz: e46135147bb82bd9eead8ea48855359068dd1b8788547c57176c46b9791e17b6f7c76bc0ad193947cbfeca41ead41f4f785b598d95b0b4b059f9645084fd0ea5
-  data.tar.gz: fa004da36e99f6b3c0cba0e00e5f713d405013935a37e4b412f765dbeb7d9e1b630695efbffbacc8865486175f4f3b552ae069c17575159c9f06fdff9b5347a4
+  metadata.gz: d632b2b40b133b92c70c259def3d414980ffdf548bfdbf96ed1c767ef73097df4794273268c3455076d3e358ca97641826a6b6b7efd39e04b2f0ce4c3c5d049b
+  data.tar.gz: 088b62f79eb26489a6dfdd9d57bc39479f7cbc96e6b54f9b44012a501ef60f97246d695f52d2db7c66d9add7ee84bdb2abbd3f0ea9b20dc30af806c617f0689b

data/README.md

@@ -23,66 +23,82 @@ or just by specifying a `min` and `duration`
 time_frame = TimeFrame.new(min: Time.now, duration: 1.day)
 ```
 
-Let's play around a bit:
+###Important:
+TimeFrame doesn't support Date class.
 
-```ruby
-# Using pp in some samples to beautify output:
-require 'pp'
-# => true
+## Let's play around a bit...
 
-# Create a time frame instance from today with duration of 1 day
+Create a time frame instance from today with duration of 1 day
+```ruby
 time_frame = TimeFrame.new(min: Time.now, duration: 1.day)
 # => 2014-05-07 14:58:47 +0200..2014-05-08 14:58:47 +0200
+```
 
-# Get the duration
+Get the duration
+```ruby
 time_frame.duration
 # => 86400.0 seconds
+```
 
-# Shift the whole time frame by... let's say... 2 days!
+Shift the whole time frame by... let's say... 2 days!
+```ruby
 later = time_frame.shift_by(2.days)
 # => 2014-05-09 14:58:47 +0200..2014-05-10 14:58:47 +0200
+```
 
-# Shifting can also be done in the other direction...
+Shifting can also be done in the other direction...
+```ruby
 earlier = time_frame.shift_by(-2.days)
 # => 2014-05-05 14:58:47 +0200..2014-05-06 14:58:47 +0200
+```
 
-# Is another time covered by our time frame?
+Is another time covered by our time frame?
+```ruby
 my_time = Time.new(2014, 5, 7, 16)
 time_frame.cover?(my_time)
 # => true
+```
 
-# Shifting to another time... duration remains:
+Shifting to another time... duration remains:
+```ruby
 time_frame.shift_to(Time.new(2016, 1, 1))
 # => 2016-01-01 00:00:00 +0100..2016-01-02 00:00:00 +0100
+```
 
-# Checking whether another time frame overlaps:
+Checking whether another time frame overlaps:
+```ruby
 other_frame = TimeFrame.new(
   min: time_frame.min - 3.days,
   max: time_frame.min + 40.minutes
 )
 time_frame.overlaps?(other_frame)
 # => true
+```
 
-# Time frame without another time frame:
+Time frame without another time frame:
+```ruby
 time_frame = TimeFrame.new(min: Time.new(2014, 5, 12), duration: 1.day)
 other = TimeFrame.new(min: Time.new(2014, 5, 12, 19), duration: 10.minutes)
-pp time_frame.without(other)
+time_frame.without(other)
 # [2014-05-12 00:00:00 +0200..2014-05-12 19:00:00 +0200,
 #  2014-05-12 19:10:00 +0200..2014-05-13 00:00:00 +0200]
+```
 
-# You can also use without with many TimeFrame's:
+You can also use without with many TimeFrame's:
+```ruby
 another = other.shift_by(15.minutes)
-pp time_frame.without(other, another)
+time_frame.without(other, another)
 # [2014-05-12 00:00:00 +0200..2014-05-12 19:00:00 +0200,
 #  2014-05-12 19:10:00 +0200..2014-05-12 19:15:00 +0200,
 #  2014-05-12 19:25:00 +0200..2014-05-13 00:00:00 +0200]
+```
 
-# Use of the mathematical &. The intersection is returned:
+Use of the mathematical &. The intersection is returned:
+```ruby
 time_frame = TimeFrame.new(min: Time.new(2014), duration: 1.day)
 other_time_frame = time_frame.shift_by(12.hours)
 time_frame & other_time_frame
 # => 2014-01-01 12:00:00 +0100..2014-01-02 00:00:00 +0100
-
 ```
 
 These are the most common functionalities of the `TimeFrame` class, but there is quite more to discover. If you have an array of time frames, you can compute their union and pairwise intersection using `TimeFrame.union` and `TimeFrame.intersection`. For two sorted arrays of time frames, you can traverse all overlaps of time frames in the first array with time frames in the second array in **linear time** using `TimeFrame.each_overlap`.

data/lib/time_frame/time_frame.rb

@@ -11,20 +11,20 @@ class TimeFrame
   EMPTY = Empty.instance
 
   def initialize(args)
-    min = args.fetch(:min)
-    max = args.fetch(:max) { min + args.fetch(:duration) }
-    check_bounds(max, min)
-    @max = max
-    @min = min
+    @min = args.fetch(:min)
+    @max = args.fetch(:max) { @min + args.fetch(:duration) }
+    check_bounds
+    @max_float = @max.to_f
+    @min_float = @min.to_f
   end
 
   def duration
-    (max - min).seconds
+    @duration ||= (@max_float - @min_float)
   end
 
   def ==(other)
-    min == other.min &&
-      max == other.max
+    @min_float == other.min_float &&
+    @max_float == other.max_float
   end
 
   alias_method :eql?, :==
@@ -34,42 +34,44 @@ class TimeFrame
   end
 
   def cover?(element)
-    if rangy?(element)
-      element.empty? || min <= element.min && element.max <= max
+    if element.is_a?(TimeFrame)
+      element.empty? ||
+      @min_float <= element.min_float && element.max_float <= max_float
     else
-      min <= element && element <= max
+      min_float <= element.to_f && element.to_f <= max_float
     end
   end
 
   def before?(item)
     case
-    when rangy?(item)
+    when item.is_a?(TimeFrame)
       fail_if_empty item
-      item.min > max
+      item.min.to_f > max_float
     else
-      item > max
+      item.to_f > max_float
     end
   end
 
   def after?(item)
     case
-    when rangy?(item)
+    when item.is_a?(TimeFrame)
       fail_if_empty item
-      item.max < min
+      item.max.to_f < min_float
     else
-      item < min
+      item.to_f < min_float
     end
   end
 
   def time_between(item)
     case
-    when rangy?(item)
+    when item.is_a?(TimeFrame)
       fail_if_empty item
       [time_between(item.min), time_between(item.max)].min_by(&:abs)
     when cover?(item)
       0
     else
-      [(item - min).abs, (item - max).abs].min
+      float_value = item.to_f
+      [(float_value - min_float).abs, (float_value - max_float).abs].min
     end
   end
 
@@ -90,7 +92,7 @@ class TimeFrame
   # Returns true if the interior intersect.
   def overlaps?(other)
     return false if other.duration == 0
-    other.max > min && other.min < max
+    other.max_float > min_float && other.min_float < max_float
   end
 
   def &(other)
@@ -142,27 +144,25 @@ class TimeFrame
     intersection = self & other
 
     result = []
-    if intersection.min > min
+    if intersection.min_float > min_float
       result << TimeFrame.new(min: min, max: intersection.min)
     end
-    if intersection.max < max
+    if intersection.max_float < max_float
       result << TimeFrame.new(min: intersection.max, max: max)
     end
     result
   end
 
+  attr_reader :min_float, :max_float
+
   private
 
   def fail_if_empty(item)
-    fail ArgumentError, 'time frame is empty' if item.respond_to?(:empty) &&
+    fail ArgumentError, 'time frame is empty' if item.respond_to?(:empty?) &&
         item.empty?
   end
 
-  def rangy?(item)
-    item.respond_to?(:min) && item.respond_to?(:max)
-  end
-
-  def check_bounds(max, min)
+  def check_bounds
     fail ArgumentError, 'min is greater than max.' if min > max
   end
 end

data/lib/time_frame/version.rb

@@ -1,5 +1,5 @@
 # Encoding: utf-8
 # gem version
 class TimeFrame
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

data/spec/spec_helper.rb

@@ -13,6 +13,8 @@ RSpec.configure do |config|
   config.order = 'random'
 end
 
+require 'byebug'
+
 # active_record setup for active_record handler specs
 ActiveRecord::Base.establish_connection(
   adapter: 'sqlite3', database: ':memory:'

data/spec/time_frame_spec.rb

@@ -94,7 +94,7 @@ describe TimeFrame do
           context 'and duration is 0' do
             it 'should be valid' do
               expect do
-                TimeFrame.new(min: Date.new(2012), duration: 0.seconds)
+                TimeFrame.new(min: Time.utc(2012), duration: 0.seconds)
               end.not_to raise_error
             end
           end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: time_frame
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Patrick Derichs
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-22 00:00:00.000000000 Z
+date: 2014-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake