hystorical 0.2.0 → 1.0.0

data/README.md

@@ -99,11 +99,17 @@ $ rails g hystorical:dates Subscription
 $    create  db/migrate/20120917150948_add_start_date_end_date_to_subscriptions.rb
 ```
 
+## Filtering
+
+You can filter a dataset by passing in a block. This works similarly to Enumerable's `select` method.
+
+```ruby
+Hystorical.current subscriptions { |subscription| subscription.type == :gold }
+```
+
 ## Philosophy
 This gem was created using TDD and README-driven development. The architecture was designed with a strong focus on modularity and extensibility. Using ruby's `Enumerable` methods to return current object was chosen because of it's great flexibility to adapt to all ruby projects. However, when working with large datasets stored in a relational database, using SQL would yield greater performance. An adapter was added for ActiveRecord, but extending this to another ORM (such as DataMapper or Mongoid) is as simple as creating a new class that defines all the methods in the public api and adding a conditional in `Hystorical.delegate_class`.
 
-## TODO
- * Add ability to pass in a block option that can further filter results
 
 ## Contributing
 

data/lib/hystorical/ar_relation.rb

@@ -2,11 +2,13 @@ module Hystorical
   class ARRelation
     class << self
       def current(collection)
-        collection.where(end_date: nil)
+        current_items = collection.where(end_date: nil)
+        block_given? ? current_items.select { |item| yield item } : current_items
       end
 
       def current_on(collection, date)
-        collection.where("? BETWEEN start_date AND end_date", date)
+        current_items = collection.where("? BETWEEN start_date AND end_date", date)
+        block_given? ? current_items.select { |item| yield item } : current_items
       end
     end
   end

data/lib/hystorical/ruby_collection.rb

@@ -3,18 +3,24 @@ module Hystorical
     class << self
 
       def current(collection)
-        collection.select { |obj| obj.respond_to?(:[]) ? obj[:end_date].nil? : obj.end_date.nil? }
+        collection.select do |obj|
+          current = get_attr(obj, :end_date).nil?
+          block_given? ? (yield obj) && current : current
+        end
       end
 
       def current_on(collection, date)
         collection.select do |obj|
-          if obj.respond_to?(:[])
-            obj[:start_date] <= date && obj[:end_date] >= date
-          else
-            obj.start_date <= date && obj.end_date >= date
-          end
+          current = (get_attr(obj, :start_date) <= date) && (get_attr(obj, :end_date) >= date)
+          block_given? ? (yield obj) && current : current
         end
       end
+
+      private
+      def get_attr(obj, attribute)
+        obj.respond_to?(:[]) ? obj[attribute] : obj.send(attribute)
+      end
+
     end
   end
 end

data/lib/hystorical/version.rb

@@ -1,3 +1,3 @@
 module Hystorical
-  VERSION = "0.2.0"
+  VERSION = "1.0.0"
 end

data/spec/hystorical/ar_relation_spec.rb

@@ -5,6 +5,7 @@ describe Hystorical::ARRelation do
   with_model :Subscription do
     table do |t|
       t.integer :user_id
+      t.string :service
       t.date :start_date
       t.date :end_date
     end
@@ -17,16 +18,25 @@ describe Hystorical::ARRelation do
   end
 
   describe "current" do
-    let!(:obj1) { Subscription.create(user_id: 1, start_date: Date.new(2012, 9, 1), end_date: nil) }
-    let!(:obj2) { Subscription.create(user_id: 2, start_date: Date.new(2012, 9, 6), end_date: Date.new(2012, 9, 10)) }
-    let!(:obj3) { Subscription.create(user_id: 2, start_date: Date.new(2012, 9, 11), end_date: nil) }
+    let!(:obj1) { Subscription.create(user_id: 1, service: "gold", start_date: Date.new(2012, 9, 1), end_date: nil) }
+    let!(:obj2) { Subscription.create(user_id: 2, service: "silver", start_date: Date.new(2012, 9, 6), end_date: Date.new(2012, 9, 10)) }
+    let!(:obj3) { Subscription.create(user_id: 2, service: "gold", start_date: Date.new(2012, 9, 11), end_date: nil) }
 
     it "should return the current subscription" do
       Hystorical::ARRelation.current(Subscription.for_user(2)).should eq [obj3]
     end
+
+    context "block filter" do
+      let!(:obj4) { Subscription.create(user_id: 2, service: "silver", start_date: Date.new(2012, 9, 6), end_date: nil) }
+      it "should return the current filtered subscriptions" do
+        Hystorical::ARRelation.current Subscription.for_user(2) do |sub|
+          sub.service == "silver"
+        end.should eq [obj4]
+      end
+    end
   end
 
-  describe "current" do
+  describe "current_on" do
     let!(:obj1) { Subscription.create(user_id: 1, start_date: Date.new(2012, 9, 1), end_date: nil) }
     let!(:obj2) { Subscription.create(user_id: 2, start_date: Date.new(2012, 9, 6), end_date: Date.new(2012, 9, 10)) }
     let!(:obj3) { Subscription.create(user_id: 2, start_date: Date.new(2012, 9, 11), end_date: nil) }
@@ -34,5 +44,14 @@ describe Hystorical::ARRelation do
     it "should return the current subscription as of Sept 8" do
       Hystorical::ARRelation.current_on(Subscription.for_user(2), Date.new(2012, 9, 8)).should eq [obj2]
     end
+
+    context "block filter" do
+      let!(:obj4) { Subscription.create(user_id: 2, service: "gold", start_date: Date.new(2012, 9, 6), end_date: Date.new(2012, 9, 10)) }
+      it "should return the current filtered subscriptions" do
+        Hystorical::ARRelation.current_on Subscription.for_user(2), Date.new(2012, 9, 8) do |sub|
+          sub.service == "gold"
+        end.should eq [obj4]
+      end
+    end
   end
 end

data/spec/hystorical/ruby_collection_spec.rb

@@ -2,23 +2,24 @@ require 'spec_helper'
 
 describe Hystorical::RubyCollection do
   class HistoricalObjet
-    attr_accessor :start_date, :end_date
+    attr_accessor :start_date, :end_date, :type
 
-    def initialize(start_date, end_date)
+    def initialize(type, start_date, end_date)
+      @type = type
       @start_date = start_date
       @end_date = end_date
     end
   end
 
-  let(:obj1) { {start_date: Date.new(2012, 8, 15), end_date: Date.new(2012, 8, 26)} }
-  let(:obj2) { {start_date: Date.new(2012, 8, 27), end_date: Date.new(2012, 9, 4)} }
-  let(:obj3) { {start_date: Date.new(2012, 9, 5), end_date: nil} }
+  let(:obj1) { {type: :gold, start_date: Date.new(2012, 8, 15), end_date: Date.new(2012, 8, 26)} }
+  let(:obj2) { {type: :silver, start_date: Date.new(2012, 8, 27), end_date: Date.new(2012, 9, 4)} }
+  let(:obj3) { {type: :gold, start_date: Date.new(2012, 9, 5), end_date: nil} }
   let(:collection) { [obj1, obj2, obj3] }
 
 
-  let(:obj4) { HistoricalObjet.new(Date.new(2012, 8, 15), Date.new(2012, 8, 26)) }
-  let(:obj5) { HistoricalObjet.new(Date.new(2012, 8, 27), Date.new(2012, 9, 4)) }
-  let(:obj6) { HistoricalObjet.new(Date.new(2012, 9, 5), nil) }
+  let(:obj4) { HistoricalObjet.new(:gold, Date.new(2012, 8, 15), Date.new(2012, 8, 26)) }
+  let(:obj5) { HistoricalObjet.new(:silver, Date.new(2012, 8, 27), Date.new(2012, 9, 4)) }
+  let(:obj6) { HistoricalObjet.new(:gold, Date.new(2012, 9, 5), nil) }
   let(:collection2) { [obj4, obj5, obj6] }
 
   describe ".current" do
@@ -33,6 +34,15 @@ describe Hystorical::RubyCollection do
         Hystorical::RubyCollection.current(collection2).should eq [obj6]
       end
     end
+
+    context "filter block" do
+      let(:obj5) { HistoricalObjet.new(:silver, Date.new(2012, 8, 27), nil) }
+      it "should be filterable via a block" do
+        Hystorical::RubyCollection.current collection2 do |sub|
+          sub.type == :silver
+        end.should eq [obj5]
+      end
+    end
   end
 
   describe ".current_on" do
@@ -49,5 +59,14 @@ describe Hystorical::RubyCollection do
         Hystorical::RubyCollection.current_on(collection2, date).should eq [obj5]
       end
     end
+
+    context "filter block" do
+     let(:obj6) { HistoricalObjet.new(:gold, Date.new(2012, 9, 5), Date.new(2012, 9, 4)) }
+      it "should be filterable via a block" do
+        Hystorical::RubyCollection.current_on collection2, date do |sub|
+          sub.type == :silver
+        end.should eq [obj5]
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hystorical
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-17 00:00:00.000000000 Z
+date: 2012-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec