hystorical 0.0.1.alpha → 0.1.0

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+*.db

data/.rspec

@@ -1 +1,2 @@
 --color
+--order random

data/README.md

@@ -1,10 +1,11 @@
 # Hystorical
 
-Hystorical is a simple solution for managing explicit historical datasets. Provided that your records have a `start_date` and `end_date`, Hystorical will take care figuring which records are currently active, which were active during a particular date range and managing the archiving of records. It makes the following assumptions:
+Hystorical is a simple solution for managing historical datasets. Hystorical takes care of determining which objects are currently active or active on a particular day. It makes the following assumptions:
 
 * Objects in the collection have `start_date` and `end_date` attributes
 * `start_date` and `end_date` return a ruby `Date` object
-* the start and end dates can be accessed via either `[]` method or the `.` operator
+* Typically members of the collection will be objects or hashes, but anything that implements start_date and end_date via `[]` or `.` can be used.
+* Current objects have a `nil` end_date
 
 ## Installation
 
@@ -23,7 +24,7 @@ Or install it yourself as:
 ## Usage
 
 ### current
-Hystorical returns the current object which is determined as those with `nil` end_date
+Hystorical returns the current objects which is determined as objects with a end_date that returns `nil`
 ```ruby
 Hystorical.current(@subscriptions)
 # => returns enumerable collection of objects
@@ -46,19 +47,21 @@ Hystorical.current_on(@subscriptions, date)
 
 ```ruby
 Subscription = Struct.new(:start_date, :end_date)
-subscriptions = # collection of several Subscription objects
+subscription1 = Subscription.new(Date.new(2012, 9, 1), Date.new(2012, 9, 10))
+subscription2 = Subscription.new(Date.new(2012, 9, 11), nil)
+subscriptions = [subscription1, subscription2]
 
 Hystorical.current(subscriptions)
-# => returns enumerable collection of objects
+# => returns [subscription2]
 
-date = Date.new(2012, 01, 10)
+date = Date.new(2012, 09, 8)
 Hystorical.current_on(subscriptions, date)
-# => returns enumerable collection of objects that were current on January 10th
+# => returns [subscription1]
 ```
 
 ### Using Rails
 
-Hystorical accepts ActiveRecord::Relation collections. This means that all your scopes integrate fully with Hystorical.
+Hystorical accepts ActiveRecord::Relation collections. This means that all your scopes integrate fully with Hystorical. In order to be optimized for larger datasets, Hystorical takes advantage of ActiveRecord::Relation methods to build a SQL query instead of using Enumerable methods when pass an instance of ActiveRecordRelation.
 
 In a model
 ```ruby
@@ -71,7 +74,11 @@ class Subscription < ActiveRecord::Base
 
   def self.user_subscription_count_on(user_id, date)
     subscriptions = Subscription.for_user(user_id)
-    Hystorical.current subscriptions, date
+    Hystorical.current(subscriptions, date).count
+  end
+
+  def archive
+    update_attributes { end_date: Date.today }
   end
 
 end
@@ -85,10 +92,9 @@ end
 ```
 
 ## 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. Adding an adapter for ActiveRecord or any other 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`.
+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 search via SQL when passed `ActiveRecord::Relation`
  * Add ability to pass in a block option that can further filter results
 
 ## Contributing

data/hystorical.gemspec

@@ -1,6 +1,5 @@
 # -*- encoding: utf-8 -*-
-require File.expand_path('../lib/hystorical', __FILE__)
-require File.expand_path('../lib/ruby_hystorical', __FILE__)
+require File.expand_path('../lib/hystorical/version', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.authors       = ["Joel Quenneville"]
@@ -17,4 +16,6 @@ Gem::Specification.new do |gem|
   gem.version       = Hystorical::VERSION
 
   gem.add_development_dependency "rspec"
+  gem.add_development_dependency "sqlite3"
+  gem.add_development_dependency "with_model"
 end

data/lib/hystorical.rb

@@ -1,17 +1,20 @@
-class Hystorical
+require 'hystorical/ruby_collection'
+require 'hystorical/ar_relation'
+module Hystorical
 
-  VERSION = "0.0.1.alpha"
-  
-  def self.delegate_class
-    RubyHystorical
-    # add conditional to determine which subclass to use once other strategies are used (i.e. ActiveRecord)
+  def self.delegate_class(collection)
+    if collection.class == ActiveRecord::Relation
+      return Hystorical::ARRelation
+    else
+      return Hystorical::RubyCollection
+    end
   end
 
   def self.current(collection)
-    delegate_class.current(collection)
+    delegate_class(collection).current(collection)
   end
 
   def self.current_on(collection, date)
-    delegate_class.current_on(collection, date)
+    delegate_class(collection).current_on(collection, date)
   end
 end

data/lib/hystorical/ar_relation.rb

@@ -0,0 +1,13 @@
+module Hystorical
+  class ARRelation
+    class << self
+      def current(collection)
+        collection.where(end_date: nil)
+      end
+
+      def current_on(collection, date)
+        collection.where("? BETWEEN start_date AND end_date", date)
+      end
+    end
+  end
+end

data/lib/hystorical/ruby_collection.rb

@@ -0,0 +1,20 @@
+module Hystorical
+  class RubyCollection
+    class << self
+
+      def current(collection)
+        collection.select { |obj| obj.respond_to?(:[]) ? obj[:end_date].nil? : obj.end_date.nil? }
+      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
+        end
+      end
+    end
+  end
+end

data/lib/hystorical/version.rb

@@ -0,0 +1,3 @@
+module Hystorical
+  VERSION = "0.1.0"
+end

data/spec/hystorical/ar_relation_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Hystorical::ARRelation do
+
+  with_model :Subscription do
+    table do |t|
+      t.integer :user_id
+      t.date :start_date
+      t.date :end_date
+    end
+
+    model do
+      def self.for_user(user_id)
+        where user_id: user_id
+      end
+    end
+  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) }
+
+    it "should return the current subscription" do
+      Hystorical::ARRelation.current(Subscription.for_user(2)).should eq [obj3]
+    end
+  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) }
+
+    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
+  end
+end

data/spec/{ruby_hystorical_spec.rb → hystorical/ruby_collection_spec.rb}

@@ -1,4 +1,6 @@
-describe RubyHystorical do
+require 'spec_helper'
+
+describe Hystorical::RubyCollection do
   class HistoricalObjet
     attr_accessor :start_date, :end_date
 
@@ -22,13 +24,13 @@ describe RubyHystorical do
   describe ".current" do
     context "when attributes are accessed via []" do
       it "should return the current object" do
-        RubyHystorical.current(collection).should eq [obj3]
+        Hystorical::RubyCollection.current(collection).should eq [obj3]
       end
     end
 
     context "when attributes are accessed via ." do
       it "should return the current object" do
-        RubyHystorical.current(collection2).should eq [obj6]
+        Hystorical::RubyCollection.current(collection2).should eq [obj6]
       end
     end
   end
@@ -38,14 +40,14 @@ describe RubyHystorical do
 
     context "when attributes are accessed via []" do
       it "should return the current object" do
-        RubyHystorical.current_on(collection, date).should eq [obj2]
+        Hystorical::RubyCollection.current_on(collection, date).should eq [obj2]
       end
     end
 
     context "when attributes are accessed via ." do
       it "should return the current object" do
-        RubyHystorical.current_on(collection2, date).should eq [obj5]
+        Hystorical::RubyCollection.current_on(collection2, date).should eq [obj5]
       end
     end
   end
-end
+end

data/spec/hystorical_spec.rb

@@ -1,16 +1,26 @@
-describe Hystorical do
+require 'spec_helper'
 
+describe Hystorical do
   describe ".delegate_class" do
-    it "should return RubyHystorical" do
-      Hystorical.delegate_class.should be RubyHystorical
+    context "when ActiveRecord::Relation" do
+      it "should return RubyHystorical" do
+        collection = double("ActiveRecord::Relation")
+        collection.stub(:class) {ActiveRecord::Relation}
+        Hystorical.delegate_class(collection).should eq Hystorical::ARRelation
+      end
+    end
+    context "when not ActiveRecord:Relation" do
+      it "should return RubyHystorical" do
+        Hystorical.delegate_class(stub).should eq Hystorical::RubyCollection
+      end
     end
   end
 
   let(:collection) { stub }
-  before { Hystorical.stub(:delegate_class).and_return(RubyHystorical) }
   describe ".current" do
+    before { Hystorical.stub(:delegate_class).and_return(Hystorical::RubyCollection) }
     it "send current message to delegate class" do
-      RubyHystorical.should_receive(:current).with(collection)
+      Hystorical::RubyCollection.should_receive(:current).with(collection)
       Hystorical.current(collection)
     end
   end
@@ -18,8 +28,8 @@ describe Hystorical do
   describe ".current_on" do
     it "send current_on message to delegate class" do
       date = stub
-      RubyHystorical.should_receive(:current_on).with(collection, date)
+      Hystorical::RubyCollection.should_receive(:current_on).with(collection, date)
       Hystorical.current_on(collection, date)
     end
   end
-end
+end

data/spec/spec_helper.rb

@@ -1,2 +1,16 @@
+$:.unshift File.expand_path("../../lib", __FILE__)
+
+require 'date'
+require 'sqlite3'
+require 'active_record'
+require 'with_model'
 require "hystorical"
-require "ruby_hystorical"
+
+ActiveRecord::Base.establish_connection(
+  :adapter => "sqlite3",
+  :database  => "test.db"
+)
+
+RSpec.configure do |config|
+  config.extend WithModel
+end

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: hystorical
 version: !ruby/object:Gem::Version
-  version: 0.0.1.alpha
-  prerelease: 6
+  version: 0.1.0
+  prerelease: 
 platform: ruby
 authors:
 - Joel Quenneville
@@ -27,6 +27,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: with_model
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Hystorical is a simple solution for managing explicit historical datasets
 email:
 - joel.quen@gmail.com
@@ -42,9 +74,12 @@ files:
 - Rakefile
 - hystorical.gemspec
 - lib/hystorical.rb
-- lib/ruby_hystorical.rb
+- lib/hystorical/ar_relation.rb
+- lib/hystorical/ruby_collection.rb
+- lib/hystorical/version.rb
+- spec/hystorical/ar_relation_spec.rb
+- spec/hystorical/ruby_collection_spec.rb
 - spec/hystorical_spec.rb
-- spec/ruby_hystorical_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses: []
@@ -61,16 +96,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: Hystorical is a simple solution for managing explicit historical datasets
 test_files:
+- spec/hystorical/ar_relation_spec.rb
+- spec/hystorical/ruby_collection_spec.rb
 - spec/hystorical_spec.rb
-- spec/ruby_hystorical_spec.rb
 - spec/spec_helper.rb

data/lib/ruby_hystorical.rb

@@ -1,16 +0,0 @@
-class RubyHystorical
-
-  def self.current(collection)
-    collection.select { |obj| obj.respond_to?(:[]) ? obj[:end_date].nil? : obj.end_date.nil? }
-  end
-
-  def self.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
-    end
-  end
-end