time_frame 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 386f6c3ac3264d001e0178fd259596f891155635
-  data.tar.gz: 4446b493f555ccd977042920a76044efc1ecdf8b
+  metadata.gz: 46d453a744497db5265eff93a9c51b5dae6dad53
+  data.tar.gz: 0638ebac436ed0d318e36dcc10e7d9fd9dfa4c0a
 SHA512:
-  metadata.gz: fd4b735c5619dc44a5aabc730198be71ea14e00409916082af7640af37581f87b79e22aa5d985dbbb9a289eb9f5a48718bb6045d1d68e0e4809b49577f00264e
-  data.tar.gz: aa27285f47108fe95e0e73e161690e544f34ec5607c44b19cded583f371baaf7072a0dfd003d356a5b38e97229b72a1c22c024304302206f86fb9c0ebd41aa9b
+  metadata.gz: 44a1dcdaa9100b07e263ded5a781f9d62ceacb812e7ce494aed9e362e5f817e2b9ebd0b04267bad856cd4a7dbc0dd27252153254fae7e307db1cd20507ef1c9b
+  data.tar.gz: e5ddb3de3a236f3b2c0359c35b4fb30a0373d4d75acf07109fe8b9e6bffe704cc5880d8efa720a7be09918e978367f5e497be2ccd43c20bdb4a011a45d034b7f

data/.rubocop.yml

@@ -1,5 +1,7 @@
 AllCops:
-  Exclude: 
+  Exclude:
+    - time_frame.gemspec
+    - Guardfile
     - 'vendor/**/*'
     - 'spec/models/vogon_poem.rb'
 

data/lib/time_frame.rb

@@ -10,7 +10,7 @@ require 'time_frame/time_frame_overlaps'
 require 'time_frame/time_frame_uniter'
 
 require 'time_frame/time_frame'
-require 'time_frame/time_frame_handler'
+require 'time_frame/time_frame_predicate_builder_handler'
 
 require 'time_frame/tree_node'
 require 'time_frame/collection'

data/lib/time_frame/time_frame.rb

@@ -1,7 +1,7 @@
 # Encoding: utf-8
 
 # Temporary disable class length cop.
-# rubocop:disable Style/ClassLength
+# rubocop:disable Metrics/ClassLength
 
 # The time frame class provides an specialized and enhanced range for time
 # values.
@@ -24,7 +24,7 @@ class TimeFrame
 
   def ==(other)
     @min_float == other.min_float &&
-    @max_float == other.max_float
+      @max_float == other.max_float
   end
 
   def <=>(other)
@@ -40,7 +40,7 @@ class TimeFrame
   def cover?(element)
     if element.is_a?(TimeFrame)
       element.empty? ||
-      @min_float <= element.min_float && element.max_float <= max_float
+        @min_float <= element.min_float && element.max_float <= max_float
     else
       min_float <= element.to_f && element.to_f <= max_float
     end
@@ -69,13 +69,11 @@ class TimeFrame
   def time_between(item)
     case
     when item.is_a?(TimeFrame)
-      fail_if_empty item
-      [time_between(item.min), time_between(item.max)].min_by(&:abs)
+      time_between_time_frame(item)
     when cover?(item)
       0
     else
-      float_value = item.to_f
-      [(float_value - min_float).abs, (float_value - max_float).abs].min
+      time_between_float(item.to_f)
     end
   end
 
@@ -134,7 +132,7 @@ class TimeFrame
 
   def self.each_overlap(frames1, frames2)
     Overlaps.new(frames1, frames2).each do |first, second|
-      yield(first, second)
+      yield first, second
     end
   end
 
@@ -144,31 +142,41 @@ class TimeFrame
 
   protected
 
-  def without_frame(other)
-    intersection = self & other
+  attr_reader :min_float, :max_float
 
+  def without_frame(other)
     result = []
-    if intersection.min_float > min_float
-      result << TimeFrame.new(min: min, max: intersection.min)
+
+    if other.min_float > min_float
+      result << TimeFrame.new(min: min, max: other.min)
     end
-    if intersection.max_float < max_float
-      result << TimeFrame.new(min: intersection.max, max: max)
+
+    if other.max_float < max_float
+      result << TimeFrame.new(min: other.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?) &&
-        item.empty?
+                                                 item.empty?
   end
 
   def check_bounds
     fail ArgumentError, 'min is greater than max.' if min > max
   end
+
+  def time_between_time_frame(time_frame)
+    fail_if_empty time_frame
+    [time_between(time_frame.min), time_between(time_frame.max)].min_by(&:abs)
+  end
+
+  def time_between_float(float_value)
+    [(float_value - min_float).abs, (float_value - max_float).abs].min
+  end
 end
 
-# rubocop:enable Style/ClassLength
+# rubocop:enable Metrics/ClassLength

data/lib/time_frame/time_frame_overlaps.rb

@@ -25,7 +25,7 @@ class TimeFrame
 
     def shift
       if @array2.one? ||
-          @array1.many? && @array1.second.min < @array2.second.min
+         @array1.many? && @array1.second.min < @array2.second.min
         @array1.shift
       else
         @array2.shift

data/lib/time_frame/{time_frame_handler.rb → time_frame_predicate_builder_handler.rb}

@@ -1,16 +1,13 @@
 class TimeFrame
   # This class tells the active_record predicate builder how to handle
   # time_frame classes when passed into a where-clause
-  class Handler
+  class PredicateBuilderHandler
     def call(column, time_frame)
-      Arel::Nodes::Between.new(
-        column,
-        Arel::Nodes::And.new([time_frame.min, time_frame.max])
-      )
+      column.in(time_frame.min..time_frame.max)
     end
   end
 end
 
 ActiveRecord::PredicateBuilder.register_handler(
-    TimeFrame, TimeFrame::Handler.new
-  )
+  TimeFrame, TimeFrame::PredicateBuilderHandler.new
+)

data/lib/time_frame/version.rb

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

data/spec/collection_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe TimeFrame::Collection do
-
   let(:time_frame) { TimeFrame.new(min: Time.utc(2014), duration: 20.days) }
   let(:time) { Time.utc(2014) }
 
@@ -10,7 +9,7 @@ describe TimeFrame::Collection do
       time_frames = 20.times.map { |i| time_frame.shift_by((5 * i).days) }
       objects = time_frames.map { |tf| OpenStruct.new(interval: tf) }
       tree = TimeFrame::Collection.new(objects) { |o| o.interval }
-      expect(tree.map { |item| item.interval }).to eq time_frames
+      expect(tree.map(&:interval)).to eq time_frames
     end
   end
 
@@ -202,7 +201,6 @@ describe TimeFrame::Collection do
 
         result = tree.all_intersecting(interval.shift_by(300.days))
         expect(result).to eq []
-
       end
     end
   end

data/spec/time_frame_predicate_builder_handler_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+require 'models/vogon_poem'
+
+describe TimeFrame::PredicateBuilderHandler do
+  let(:time_frame) { TimeFrame.new(min: 5.days.ago, duration: 20.days) }
+
+  before { VogonPoem.delete_all }
+
+  it 'returns all records between min and max' do
+    poem_min = VogonPoem.create(written_at: time_frame.min)
+    poem_max = VogonPoem.create(written_at: time_frame.max)
+
+    result = VogonPoem.where(written_at: time_frame)
+
+    expect(result.count).to eq 2
+    expect(result.first).to eq poem_min
+    expect(result.last).to eq poem_max
+  end
+
+  it 'ignores records outside of min and max' do
+    poem_min = VogonPoem.create(written_at: time_frame.min + 1.minute)
+    VogonPoem.create(written_at: time_frame.min - 2.years)
+    VogonPoem.create(written_at: time_frame.max + 1.month)
+
+    result = VogonPoem.where(written_at: time_frame)
+
+    expect(result.count).to eq 1
+    expect(result.first).to eq poem_min
+  end
+
+  it 'handles items close to the borders correctly' do
+    poem_min = VogonPoem.create(written_at: time_frame.min + 1.second)
+    VogonPoem.create(written_at: time_frame.min - 1.second)
+    VogonPoem.create(written_at: time_frame.max + 1.second)
+
+    result = VogonPoem.where(written_at: time_frame)
+
+    expect(result.count).to eq 1
+    expect(result.first).to eq poem_min
+  end
+end

data/spec/time_frame_spec.rb

@@ -10,12 +10,12 @@ describe TimeFrame do
     I18n.enforce_available_locales = true
   end
 
-  it 'should be hashable' do
+  it 'is hashable' do
     hash = {}
     time_frame1 = TimeFrame.new(min: time, duration: duration)
     time_frame2 = TimeFrame.new(min: time, duration: duration)
     time_frame3 = TimeFrame.new(min: time, duration: duration / 2)
-    time_frame4 = TimeFrame.new(min: time - duration / 2 , max: time + duration)
+    time_frame4 = TimeFrame.new(min: time - duration / 2, max: time + duration)
     hash[time_frame1] = 1
     expect(hash[time_frame2]).to eq 1
     expect(hash[time_frame3]).not_to eq 1
@@ -92,14 +92,13 @@ describe TimeFrame do
 
         context 'when min is a date' do
           context 'and duration is 0' do
-            it 'should be valid' do
+            it 'is valid' do
               expect do
                 TimeFrame.new(min: Time.utc(2012), duration: 0.seconds)
               end.not_to raise_error
             end
           end
         end
-
       end
       context 'and time sframe covers a DST shift' do
         let(:time) do
@@ -135,14 +134,14 @@ describe TimeFrame do
       it { should eq 0 }
     end
     context 'when time frame containts a DST shift' do
-      it 'should gain 1 hour on summer -> winter shifts' do
+      it 'gains 1 hour on summer -> winter shifts' do
         Time.use_zone('Europe/Berlin') do
           time_frame = TimeFrame.new(min: Time.zone.local(2013, 10, 27),
                                      max: Time.zone.local(2013, 10, 28))
           expect(time_frame.duration).to eq 25.hours
         end
       end
-      it 'should lose 1 hour on winter -> summer shifts' do
+      it 'loses 1 hour on winter -> summer shifts' do
         Time.use_zone('Europe/Berlin') do
           time_frame = TimeFrame.new(min: Time.zone.local(2013, 3, 31),
                                      max: Time.zone.local(2013, 4, 1))
@@ -192,7 +191,7 @@ describe TimeFrame do
   describe '#<=>' do
     let(:time_frames) do
       array = TimeFrame.new(min: Time.utc(2014), duration: 30.days)
-                       .split_by_interval(1.day)
+              .split_by_interval(1.day)
       time_frame1 = TimeFrame.new(min: Time.utc(2014), duration: 2.days)
       array << time_frame1
       array << time_frame1.shift_by(1.day)
@@ -408,7 +407,6 @@ describe TimeFrame do
   end
 
   describe '.union' do
-
     context 'when given an empty array' do
       subject { TimeFrame.union([]) }
       it { should eq [] }
@@ -749,7 +747,7 @@ describe TimeFrame do
           expect(subject[day]).to eq expected.shift_by(day.days)
         end
       end
-      it 'should have a smaller time_frame at the end' do
+      it 'has a smaller time_frame at the end' do
         expected = TimeFrame.new(min: time + 7.days, duration: 12.hours)
         expect(subject[7]).to eq expected
       end
@@ -826,7 +824,6 @@ describe TimeFrame do
   end
 
   describe '#shift_to' do
-
     let(:duration) { 1.day }
     let(:min)      { Time.zone.local(2012, 1, 2) }
     let(:max)      { min + duration }
@@ -1013,7 +1010,6 @@ describe TimeFrame do
   end
 
   describe '.covering_time_frame_for' do
-
     context 'for a single time frame' do
       let(:time_frame) { TimeFrame.new(min: time, duration: 1.hour) }
       subject { TimeFrame.covering_time_frame_for([time_frame]) }
@@ -1054,7 +1050,6 @@ describe TimeFrame do
   end
 
   describe '.each_overlap' do
-
     # Visualization of example input:
     #
     # array1:       |---|-------|   |-------|-----------|

data/time_frame.gemspec

@@ -26,11 +26,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'rake', '~> 10.3.2'
-  spec.add_development_dependency 'rspec', '~> 3.0.0'
-  spec.add_development_dependency 'simplecov', '~> 0.8.2'
-  spec.add_development_dependency 'rubocop', '~> 0.23.0'
+  spec.add_development_dependency 'rake', '~> 10.3'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov', '~> 0.8'
+  spec.add_development_dependency 'rubocop', '~> 0.23'
   spec.add_development_dependency 'sqlite3'
-  spec.add_dependency 'activerecord', '~> 4.1.1'
-  spec.add_dependency 'activesupport', '~> 4.1.1'
+  spec.add_dependency 'activerecord', '~> 4.2'
+  spec.add_dependency 'activesupport', '~> 4.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: time_frame
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - Patrick Derichs
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-31 00:00:00.000000000 Z
+date: 2014-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -18,56 +18,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.3.2
+        version: '10.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.3.2
+        version: '10.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.2
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.2
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.23.0
+        version: '0.23'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.23.0
+        version: '0.23'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -88,28 +88,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.1
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.1
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.1
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.1
+        version: '4.2'
 description: TimeFrame
 email:
 - patrick.derichs@invision.de
@@ -131,8 +131,8 @@ files:
 - lib/time_frame/empty.rb
 - lib/time_frame/time_frame.rb
 - lib/time_frame/time_frame_covered.rb
-- lib/time_frame/time_frame_handler.rb
 - lib/time_frame/time_frame_overlaps.rb
+- lib/time_frame/time_frame_predicate_builder_handler.rb
 - lib/time_frame/time_frame_splitter.rb
 - lib/time_frame/time_frame_uniter.rb
 - lib/time_frame/tree_node.rb
@@ -140,7 +140,7 @@ files:
 - spec/collection_spec.rb
 - spec/models/vogon_poem.rb
 - spec/spec_helper.rb
-- spec/time_frame_handler_spec.rb
+- spec/time_frame_predicate_builder_handler_spec.rb
 - spec/time_frame_spec.rb
 - time_frame.gemspec
 homepage: https://github.com/injixo/time_frame
@@ -171,5 +171,5 @@ test_files:
 - spec/collection_spec.rb
 - spec/models/vogon_poem.rb
 - spec/spec_helper.rb
-- spec/time_frame_handler_spec.rb
+- spec/time_frame_predicate_builder_handler_spec.rb
 - spec/time_frame_spec.rb

data/spec/time_frame_handler_spec.rb

@@ -1,14 +0,0 @@
-require 'spec_helper'
-require 'models/vogon_poem'
-
-describe TimeFrame::Handler do
-  let(:time_frame) { TimeFrame.new(min: 5.days.ago, duration: 20.days) }
-  let!(:poem_min) { VogonPoem.create(written_at: time_frame.min) }
-  let!(:poem_max) { VogonPoem.create(written_at: time_frame.max) }
-
-  it 'should return all records between min and max' do
-    expect(VogonPoem.where(written_at: time_frame).count).to eq 2
-    expect(VogonPoem.where(written_at: time_frame).first).to eq poem_min
-    expect(VogonPoem.where(written_at: time_frame).last).to eq poem_max
-  end
-end