acts_as_dated_detail 0.0.1

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2009 Paul Gillard
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,39 @@
+= acts_as_dated_detail
+
+http://github.com/paulgillard/acts_as_dated_detail
+
+== DESCRIPTION:
+
+acts_as_dated_detil enables versioning of attributes by timestamp.
+
+== FEATURES:
+
+== SYNOPSIS:
+
+== REQUIREMENTS:
+
+== INSTALL:
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Paul Gillard
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/lib/active_record/acts/dated.rb

@@ -0,0 +1,70 @@
+module ActiveRecord
+  module Acts #:nodoc:
+    module Dated #:nodoc:
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+      
+      module ClassMethods
+        def acts_as_dated(options = {})
+          acts_as_dated_detail_class = "#{self.name}DatedDetail".constantize
+          
+          tracked_attribute_reader_methods = ''
+          tracked_attribute_writer_methods = ''
+          acts_as_dated_detail_class.tracked_attributes.each do |attribute|
+            tracked_attribute_reader_methods << %(
+              def #{attribute}
+                dated_detail.send('#{attribute}')
+              end
+            )
+            tracked_attribute_writer_methods << %(
+              def #{attribute}=(value)
+                dated_detail.send('#{attribute}=', value)
+              end
+            )
+          end
+          
+          class_eval <<-EOV
+            after_save :save_dated_detail
+
+            has_many :dated_details, :class_name => "#{acts_as_dated_detail_class.to_s}"
+
+            #{tracked_attribute_reader_methods}
+            #{tracked_attribute_writer_methods}
+
+            include ActiveRecord::Acts::Dated::InstanceMethods
+            
+#            def self.columns
+#              tracked_columns_hash = #{acts_as_dated_detail_class.to_s}.columns_hash.slice(*#{acts_as_dated_detail_class.to_s}.tracked_attributes)
+#              @columns ||= tracked_columns_hash.inject(super.columns) do |columns, (key, value)|
+#                columns << value
+#              end
+#              @columns
+#            end
+          EOV
+        end
+      end
+      
+      module InstanceMethods
+        def on
+          @time ||= Time.now
+        end
+        
+        def on=(time)
+          @time = time
+          @dated_detail = nil
+        end
+        
+        def dated_detail
+          @dated_detail ||= dated_details.on(on).first || dated_details.build
+        end
+        
+        private
+        
+        def save_dated_detail
+          dated_detail.save!
+        end
+      end
+    end
+  end
+end

data/lib/active_record/acts/dated_detail.rb

@@ -0,0 +1,55 @@
+module ActiveRecord
+  module Acts #:nodoc:
+    module DatedDetail #:nodoc:
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def acts_as_dated_detail()
+          class_eval <<-EOV
+            belongs_to :#{self.name.underscore.sub(/_dated_detail$/, '')}
+
+            before_update :split!
+
+            named_scope :on, lambda { |time| { :conditions => "\#{start_on_or_before_condition(time)} AND \#{end_on_or_after_condition(time)}" } }
+
+            def self.tracked_attributes
+              columns_hash.keys - ['id', "#{self.name.underscore.sub(/dated_detail$/, 'id')}", 'start_on', 'end_on', 'created_at', 'updated_at']
+            end
+
+            include ActiveRecord::Acts::DatedDetail::InstanceMethods
+
+            private
+
+            # Find all records starting on or before given time
+            def self.start_on_or_before_condition(time)
+              "(start_on <= '\#{time.to_s :db}')"
+            end
+
+            # Find all records ending on or after given time
+            def self.end_on_or_after_condition(time)
+              "(end_on IS NULL OR end_on >= '\#{time.to_s :db}')"
+            end
+          EOV
+        end
+      end
+
+      module InstanceMethods
+        def initialize(*args)
+          super
+          self.start_on = Time.now
+        end
+        
+        def split!
+          if changed?
+            self.start_on = Time.now
+            original = self.class.find(id).clone
+            original.end_on = start_on - 1
+            original.save!
+          end
+        end
+      end
+    end
+  end
+end

data/lib/acts_as_dated_detail.rb

@@ -0,0 +1,5 @@
+$:.unshift "#{File.dirname(__FILE__)}"
+require 'active_record/acts/dated'
+require 'active_record/acts/dated_detail'
+ActiveRecord::Base.class_eval { include ActiveRecord::Acts::DatedDetail }
+ActiveRecord::Base.class_eval { include ActiveRecord::Acts::Dated }

data/test/dated_detail_test.rb

@@ -0,0 +1,363 @@
+require 'test/unit'
+
+require 'rubygems'
+gem 'activerecord', '>= 1.15.4.7794'
+require 'active_record'
+require 'mocha'
+require 'ruby-debug'
+
+require "#{File.dirname(__FILE__)}/../lib/acts_as_dated_detail"
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+def setup_db
+  ActiveRecord::Schema.define(:version => 1) do
+    create_table :parrots do |t|
+      t.column :name, :string
+      t.column :created_at, :datetime
+      t.column :updated_at, :datetime
+    end
+
+    create_table :pirates do |t|
+      t.column :name, :string
+      t.column :catchphrase, :string
+      t.column :ruthlessness, :integer
+      t.column :birth_date, :datetime
+      t.column :parrot_id, :integer
+      t.column :created_at, :datetime
+      t.column :updated_at, :datetime
+    end
+
+    create_table :pirate_dated_details do |t|
+      # Ensure any attributes added here are added to relevant tests (search for 'catchphrase')
+      t.column :pirate_id, :integer
+      t.column :start_on, :datetime
+      t.column :end_on, :datetime
+      t.column :catchphrase, :string
+      t.column :ruthlessness, :integer
+      t.column :birth_date, :datetime
+      t.column :parrot_id, :integer
+      t.column :created_at, :datetime
+      t.column :updated_at, :datetime
+    end
+  end
+end
+
+def teardown_db
+  ActiveRecord::Base.connection.tables.each do |table|
+    ActiveRecord::Base.connection.drop_table(table)
+  end
+end
+
+setup_db
+
+class Parrot < ActiveRecord::Base
+  has_one :pirate
+  
+  def ==(other)
+    name == other.name
+  end
+end
+
+class PirateDatedDetail < ActiveRecord::Base
+  acts_as_dated_detail
+end
+
+class Pirate < ActiveRecord::Base
+  belongs_to :parrot
+  
+  acts_as_dated
+end
+
+teardown_db
+
+class ActsAsDatedDetailTest < Test::Unit::TestCase
+  def setup
+    setup_db
+  end
+
+  def teardown
+    teardown_db
+  end
+  
+  def default_test
+  end
+  
+  private
+  
+  def create_parrot(time)
+    parrot = Parrot.create!(:name => time.to_s)
+  end
+  
+  def create_pirate(times = [Time.now])
+    first_time = times.shift
+    now = Time.now
+    Time.stubs(:now).returns(first_time)
+    pirate = Pirate.create!(:name => pirate_name(first_time), :catchphrase => catchphrase(first_time), :ruthlessness => ruthlessness(first_time), :birth_date => first_time, :parrot => create_parrot(first_time))
+    times.each do |time|
+      Time.stubs(:now).returns(time)
+      pirate.update_attributes(:name => pirate_name(time), :catchphrase => catchphrase(time), :ruthlessness => ruthlessness(time), :birth_date => time, :parrot => create_parrot(time))
+    end
+    Time.stubs(:now).returns(now)
+    pirate
+  end
+  
+  def pirate_name(time)
+    time.to_s
+  end
+  
+  def catchphrase(time)
+    time.to_s
+  end
+  
+  def ruthlessness(time)
+    time.to_i
+  end
+end
+
+class ParentTest < ActsAsDatedDetailTest
+  # Creation
+  
+  def test_related_dated_detail_created_along_with_model
+    pirate = Pirate.create!
+    assert_equal 1, pirate.dated_details.count
+  end
+  
+  # Currently Effective Timestamp
+  
+  def test_default_value_of_currently_effective_timestamp
+    now = Time.now
+    Time.stubs(:now).returns(now)
+    pirate = Pirate.create!
+    assert_equal Time.now, pirate.on
+  end
+  
+  def test_setting_value_of_currently_effective_timestamp
+    now = Time.now
+    Time.stubs(:now).returns(now)
+    pirate = Pirate.create!
+    one_month_ago = Time.now - 1.month
+    pirate.on = one_month_ago
+    assert_equal one_month_ago, pirate.on
+  end
+  
+  # Tracked Attribute Retrieval
+  
+  def test_tracked_attribute_for_oldest_timestamp_set_by_instance_method
+    pirate = create_pirate([1.year.ago, 6.months.ago, 1.month.ago])
+    pirate.on = 8.months.ago
+    assert_equal catchphrase(1.year.ago), pirate.catchphrase
+  end
+  
+  def test_tracked_attribute_for_middle_timestamp_set_by_instance_method
+    pirate = create_pirate([1.year.ago, 6.months.ago, 1.month.ago])
+    pirate.on = 5.months.ago
+    assert_equal catchphrase(6.months.ago), pirate.catchphrase
+  end
+  
+  def test_tracked_attribute_for_newest_timestamp_set_by_instance_method
+    pirate = create_pirate([1.year.ago, 6.months.ago, 1.month.ago])
+    pirate.on = 2.weeks.ago
+    assert_equal catchphrase(1.month.ago), pirate.catchphrase
+  end
+
+  # def test_start_on
+  #   
+  # end
+  # 
+  # def test_end_on
+  #   
+  # end
+  # 
+  # def test_end_on_for_last_dated_detail
+  #   
+  # end
+  # 
+  # def test_previous
+  #   
+  # end
+  # 
+  # def test_previous_for_first_dated_detail
+  #   
+  # end
+  # 
+  # def test_next
+  #   
+  # end
+  # 
+  # def test_next_for_last_dated_detail
+  #   
+  # end
+  
+  # Tracked Attribute Methods
+  
+  def test_read_tracked_attributes
+    # Ensure value from dated_detail is returned
+    pirate = Pirate.create!
+    dated_detail = pirate.dated_detail
+    pirate.stubs(:dated_detail).returns(dated_detail)
+    PirateDatedDetail.tracked_attributes.each do |attribute|
+      value = 10
+      PirateDatedDetail.any_instance.stubs(attribute).returns("Error")
+      dated_detail.stubs(attribute).returns(value)
+      assert_equal value, pirate.send(attribute)
+    end
+  end
+  
+  def test_write_tracked_attributes
+    pirate = Pirate.create!
+    PirateDatedDetail.tracked_attributes.each do |attribute|
+      value = 10
+      pirate.send("#{attribute}=", value)
+      assert_equal value, pirate.dated_detail.send(attribute)
+    end
+  end
+  
+  # Updating Attributes
+  
+  def test_updating_tracked_integer_attribute
+    now = Time.now
+    Time.stubs(:now).returns(now - 1.year)
+    pirate = Pirate.create!
+    Time.stubs(:now).returns(now)
+    pirate.update_attribute(:ruthlessness, 10)
+    assert_equal 2, pirate.dated_details.count
+  end
+  
+  def test_updating_tracked_string_attribute
+    now = Time.now
+    Time.stubs(:now).returns(now - 1.year)
+    pirate = Pirate.create!
+    Time.stubs(:now).returns(now)
+    pirate.update_attribute(:catchphrase, 'Yar!')
+    assert_equal 2, pirate.dated_details.count
+  end
+  
+  def test_updating_tracked_datetime_attribute
+    now = Time.now
+    Time.stubs(:now).returns(now - 1.year)
+    pirate = create_pirate
+    Time.stubs(:now).returns(now)
+    pirate.update_attributes(:birth_date => pirate.birth_date + 1.day)
+    assert_equal 2, pirate.dated_details.count
+  end
+  
+  def test_updating_tracked_multiparameter_attribute
+    now = Time.now
+    Time.stubs(:now).returns(now - 1.year)
+    pirate = create_pirate
+    Time.stubs(:now).returns(now)
+    new_birth_date = pirate.birth_date + 1.day
+    pirate.update_attributes('birth_date(1i)' => "#{new_birth_date.year}", 'birth_date(2i)' => "#{new_birth_date.month}", 'birth_date(3i)' => "#{new_birth_date.day}")
+    assert_equal 2, pirate.dated_details.count
+  end
+  
+  def test_updating_untracked_attribute
+    now = Time.now
+    Time.stubs(:now).returns(now - 1.year)
+    pirate = Pirate.create!
+    Time.stubs(:now).returns(now)
+    pirate.update_attribute(:name, 'Long John Silver')
+    assert_equal 1, pirate.dated_details.count
+  end
+end
+
+class DatedDetailTest < ActsAsDatedDetailTest
+  def setup
+    setup_db
+    # create_pirate_with_dated_detail
+  end
+
+  def teardown
+    teardown_db
+  end
+  
+  # Associations
+  
+  def test_belongs_to_parent
+    assert_equal create_pirate, PirateDatedDetail.first.pirate
+  end
+  
+  # Creation
+  
+  def test_initial_start_on_value
+    pirate = Pirate.create!
+    assert_equal Time.now.to_i, PirateDatedDetail.first.start_on.to_i
+  end
+  
+  def test_initial_end_on_value
+    pirate = Pirate.create!
+    assert_nil PirateDatedDetail.first.end_on
+  end
+  
+  # Updating
+  
+  def test_updating
+    now = Time.now
+    Time.stubs(:now).returns(now - 1.year)
+    pirate = Pirate.create!
+    Time.stubs(:now).returns(now)
+    
+    dated_detail = pirate.dated_detail
+    original_dated_detail = dated_detail.class.find(dated_detail.id) # Cloning would keep millisecond parts of time which would make later comparisons harder
+    
+    dated_detail.update_attribute(:ruthlessness, 10)
+    
+    assert_equal now.to_i, dated_detail.start_on.to_i
+    assert_nil dated_detail.end_on
+    
+    previous_dated_detail = PirateDatedDetail.find_by_start_on(original_dated_detail.start_on)
+    assert_equal dated_detail.start_on.to_i - 1, previous_dated_detail.end_on.to_i
+    assert_equal original_dated_detail.attributes.except('end_on', 'id'), previous_dated_detail.attributes.except('end_on', 'id')
+  end
+  
+  # Tracked Attributes
+  
+  def test_tracked_attributes_includes_relevant_columns
+    assert PirateDatedDetail.tracked_attributes.include?('catchphrase')
+    assert PirateDatedDetail.tracked_attributes.include?('ruthlessness')
+    assert PirateDatedDetail.tracked_attributes.include?('birth_date')
+    assert PirateDatedDetail.tracked_attributes.include?('parrot_id')
+  end
+  
+  def test_tracked_attributes_excludes_id
+    assert !PirateDatedDetail.tracked_attributes.include?('id')
+  end
+  
+  def test_tracked_attributes_excludes_start_on
+    assert !PirateDatedDetail.tracked_attributes.include?('start_on')
+  end
+  
+  def test_tracked_attributes_excludes_end_on
+    assert !PirateDatedDetail.tracked_attributes.include?('end_on')
+  end
+  
+  def test_tracked_attributes_excludes_updated_at
+    assert !PirateDatedDetail.tracked_attributes.include?('updated_at')
+  end
+  
+  def test_tracked_attributes_excludes_created_at
+    assert !PirateDatedDetail.tracked_attributes.include?('created_at')
+  end
+  
+  def test_tracked_attributes_excludes_parent_id
+    assert !PirateDatedDetail.tracked_attributes.include?('pirate_id')
+  end
+  
+  # Dated Detail Retrieval
+  
+  def test_dated_detail_for_oldest_timestamp_retrieved_via_named_scope
+    pirate = create_pirate([1.year.ago, 6.months.ago, 1.month.ago])
+    assert_equal catchphrase(1.year.ago), pirate.dated_details.on(8.months.ago).first.catchphrase
+  end
+  
+  def test_tracked_attribute_for_middle_timestamp_retrieved_via_named_scope
+    pirate = create_pirate([1.year.ago, 6.months.ago, 1.month.ago])
+    assert_equal catchphrase(6.months.ago), pirate.dated_details.on(5.months.ago).first.catchphrase
+  end
+  
+  def test_tracked_attribute_for_newest_timestamp_retrieved_via_named_scope
+    pirate = create_pirate([1.year.ago, 6.months.ago, 1.month.ago])
+    assert_equal catchphrase(1.month.ago), pirate.dated_details.on(2.weeks.ago).first.catchphrase
+  end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: acts_as_dated_detail
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Paul Gillard
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-02 00:00:00 +00:00
+default_executable: 
+dependencies: []
+
+description: 
+email: paulmgillard@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+files: 
+- LICENSE
+- README.rdoc
+- lib/acts_as_dated_detail.rb
+- lib/active_record/acts/dated.rb
+- lib/active_record/acts/dated_detail.rb
+- test/dated_detail_test.rb
+has_rdoc: true
+homepage: http://github.com/paulgillard/acts_as_dated_detail
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: acts_as_dated_detail enables versioning of attributes by timestamp
+test_files: []
+