time_frame 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16119ae2815aedbad4ad320c8e31c4bf7c1d9389
-  data.tar.gz: 93f06cafdda61db5d3ab2b68ce126307c1f9bbf9
+  metadata.gz: bff74b0836d124c9e908e78228d6d2d6ce69a5c3
+  data.tar.gz: 2f508be6ca07c0d76e33c09da5491c69ebceed95
 SHA512:
-  metadata.gz: 124139bd01a35c6e7e9ae9ca22aa4c042bcc0b3df0880ba2814bfe57eef074a55766515bd31ca2e4b5bc660a60400ac2e35af492bab8347e7b5efe589f7f4b1f
-  data.tar.gz: 906d7abb6482845a0fd455e43520cbf79b6b8951ab12e7590f8b8bdb91cb960403fc90ec94181afa326245447170ec9dea5dad29e709ff55f963bd443b313bf4
+  metadata.gz: e46135147bb82bd9eead8ea48855359068dd1b8788547c57176c46b9791e17b6f7c76bc0ad193947cbfeca41ead41f4f785b598d95b0b4b059f9645084fd0ea5
+  data.tar.gz: fa004da36e99f6b3c0cba0e00e5f713d405013935a37e4b412f765dbeb7d9e1b630695efbffbacc8865486175f4f3b552ae069c17575159c9f06fdff9b5347a4

data/.rubocop.yml

@@ -1,5 +1,7 @@
 AllCops:
-  Exclude: []
+  Exclude: 
+    - 'vendor/**/*'
+    - 'spec/models/vogon_poem.rb'
 
 # Setting the line length to a maximum of 80 chars.
 LineLength:

data/README.md

@@ -51,18 +51,6 @@ my_time = Time.new(2014, 5, 7, 16)
 time_frame.cover?(my_time)
 # => true
 
-# Deviation to another time?
-earlier_time = time_frame.min - 1.day
-later_time = time_frame.max + 4.days
-time_frame.deviation_of(earlier_time)
-# => -86400.0
-time_frame.deviation_of(later_time)
-# => 345600.0
-# No deviation expected here:
-time_frame.deviation_of(time_frame.min + 20.minutes)
-# => 0
-# ... yay!
-
 # Shifting to another time... duration remains:
 time_frame.shift_to(Time.new(2016, 1, 1))
 # => 2016-01-01 00:00:00 +0100..2016-01-02 00:00:00 +0100

data/lib/time_frame/collection.rb

@@ -22,19 +22,21 @@ class TimeFrame
     end
 
     def all_covering(time)
-      [].tap do |result|
-        add_covering(time, @root, result) if any?
-      end
+      all_matching { |element| element.cover? time }
     end
 
     def all_intersecting(time_frame)
-      [].tap do |result|
-        add_intersecting(time_frame, @root, result) if any?
-      end
+      all_matching { |element| element.overlaps? time_frame }
     end
 
     private
 
+    def all_matching(&matcher)
+      [].tap do |result|
+        add_matching(@root, result, &matcher) if any?
+      end
+    end
+
     def sort_nodes
       @tree_nodes.sort_by! do |item|
         [item.time_frame.min, item.time_frame.max]
@@ -59,22 +61,12 @@ class TimeFrame
       node.update_child_frame(node.child_time_frame) if lower == upper
     end
 
-    def add_covering(time, node, result)
-      search_left = node.continue_left_side_search_for_time?(time)
-      search_right = node.continue_right_side_search_for_time?(time)
-
-      add_covering(time, node.left_child, result) if search_left
-      result << node.item if node.time_frame.cover?(time)
-      add_covering(time, node.right_child, result) if search_right
-    end
-
-    def add_intersecting(time_frame, node, result)
-      search_left = node.continue_left_side_search_for_time_frame?(time_frame)
-      search_right = node.continue_right_side_search_for_time_frame?(time_frame)
+    def add_matching(node, result, &matcher)
+      return unless node && matcher.call(node.child_time_frame)
 
-      add_intersecting(time_frame, node.left_child, result) if search_left
-      result << node.item if node.time_frame.overlaps? time_frame
-      add_intersecting(time_frame, node.right_child, result) if search_right
+      add_matching(node.left_child, result, &matcher)
+      result << node.item if matcher.call(node.time_frame)
+      add_matching(node.right_child, result, &matcher)
     end
   end
 end

data/lib/time_frame/time_frame.rb

@@ -12,7 +12,7 @@ class TimeFrame
 
   def initialize(args)
     min = args.fetch(:min)
-    max = args.fetch(:max, nil) || min + args.fetch(:duration)
+    max = args.fetch(:max) { min + args.fetch(:duration) }
     check_bounds(max, min)
     @max = max
     @min = min

data/lib/time_frame/time_frame_handler.rb

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

data/lib/time_frame/tree_node.rb

@@ -30,26 +30,6 @@ class TimeFrame
         @child_time_frame = TimeFrame.new(min: min, max: max)
         ancestor.update_child_frame(@child_time_frame) if ancestor
       end
-
-      def continue_left_side_search_for_time?(time)
-        left_child && left_child.child_time_frame.cover?(time)
-      end
-
-      def continue_left_side_search_for_time_frame?(interval)
-        left_child &&
-        left_child.child_time_frame.min <= interval.max &&
-        left_child.child_time_frame.max >= interval.min
-      end
-
-      def continue_right_side_search_for_time?(time)
-        right_child && right_child.child_time_frame.cover?(time)
-      end
-
-      def continue_right_side_search_for_time_frame?(interval)
-        right_child &&
-        right_child.child_time_frame.min <= interval.max &&
-        right_child.child_time_frame.max >= interval.min
-      end
     end
   end
 end

data/lib/time_frame/version.rb

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

data/lib/time_frame.rb

@@ -1,5 +1,5 @@
 # Encoding: utf-8
-require 'active_support'
+require 'active_record'
 require 'active_support/core_ext'
 require 'singleton'
 
@@ -10,6 +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/tree_node'
 require 'time_frame/collection'

data/spec/models/vogon_poem.rb

@@ -0,0 +1,23 @@
+# Vogon poetry is of course, the third worst in the universe.
+class VogonPoem < ActiveRecord::Base
+  def text
+    <<-EOS
+Oh freddled gruntbuggly,
+Thy micturitions are to me,
+As plurdled gabbleblotchits,
+On a lurgid bee,
+That mordiously hath blurted out,
+Its earted jurtles,
+Into a rancid festering confectious organ squealer. [drowned out by moaning and screaming]
+Now the jurpling slayjid agrocrustles,
+Are slurping hagrilly up the axlegrurts,
+And living glupules frart and slipulate,
+Like jowling meated liverslime,
+Groop, I implore thee, my foonting turling dromes,
+And hooptiously drangle me,
+With crinkly bindlewurdles,
+Or else I shall rend thee in the gobberwarts with my blurglecruncheon,
+See if I don't.
+    EOS
+  end
+end

data/spec/spec_helper.rb

@@ -12,3 +12,16 @@ require 'rspec'
 RSpec.configure do |config|
   config.order = 'random'
 end
+
+# active_record setup for active_record handler specs
+ActiveRecord::Base.establish_connection(
+  adapter: 'sqlite3', database: ':memory:'
+)
+
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :vogon_poems, force: true do |t|
+    t.datetime :written_at
+  end
+end

data/spec/time_frame_handler_spec.rb

@@ -0,0 +1,14 @@
+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

data/spec/time_frame_spec.rb

@@ -10,7 +10,7 @@ describe TimeFrame do
     I18n.enforce_available_locales = true
   end
 
-  it "should be hashable" do
+  it 'should be hashable' do
     hash = {}
     time_frame1 = TimeFrame.new(min: time, duration: duration)
     time_frame2 = TimeFrame.new(min: time, duration: duration)

data/time_frame.gemspec

@@ -30,5 +30,7 @@ Gem::Specification.new do |spec|
   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 'sqlite3'
+  spec.add_dependency 'activerecord', '~> 4.1.1'
   spec.add_dependency 'activesupport', '~> 4.1.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: time_frame
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
 platform: ruby
 authors:
 - Patrick Derichs
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-21 00:00:00.000000000 Z
+date: 2014-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -68,6 +68,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.23.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.1
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -103,13 +131,16 @@ 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_splitter.rb
 - lib/time_frame/time_frame_uniter.rb
 - lib/time_frame/tree_node.rb
 - lib/time_frame/version.rb
 - spec/collection_spec.rb
+- spec/models/vogon_poem.rb
 - spec/spec_helper.rb
+- spec/time_frame_handler_spec.rb
 - spec/time_frame_spec.rb
 - time_frame.gemspec
 homepage: https://github.com/injixo/time_frame
@@ -138,5 +169,7 @@ specification_version: 4
 summary: Ruby gem that offers support for time frames
 test_files:
 - spec/collection_spec.rb
+- spec/models/vogon_poem.rb
 - spec/spec_helper.rb
+- spec/time_frame_handler_spec.rb
 - spec/time_frame_spec.rb