acts_as_dated_detail 0.0.1 → 0.0.2

data/lib/active_record/acts/dated.rb

@@ -19,6 +19,7 @@ module ActiveRecord
             )
             tracked_attribute_writer_methods << %(
               def #{attribute}=(value)
+                write_attribute('#{attribute}', value)
                 dated_detail.send('#{attribute}=', value)
               end
             )
@@ -34,6 +35,8 @@ module ActiveRecord
 
             include ActiveRecord::Acts::Dated::InstanceMethods
             
+            alias_method_chain :reload, :dated_detail
+            
 #            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)|
@@ -46,12 +49,15 @@ module ActiveRecord
       end
       
       module InstanceMethods
+        
+        
         def on
           @time ||= Time.now
         end
         
         def on=(time)
           @time = time
+          @fixed_time = true
           @dated_detail = nil
         end
         
@@ -59,10 +65,29 @@ module ActiveRecord
           @dated_detail ||= dated_details.on(on).first || dated_details.build
         end
         
+        def current?
+          !@fixed_time
+        end
+        
+        def current!
+          @fixed_time = false
+          @dated_detail = nil
+          @time = nil
+        end
+        
+        def reload_with_dated_detail
+          if current?
+            @dated_detail = nil
+            @time = nil
+          end
+          reload_without_dated_detail
+        end
+        
         private
         
         def save_dated_detail
           dated_detail.save!
+          @time = dated_detail.start_on
         end
       end
     end

data/lib/active_record/acts/dated_detail.rb

@@ -11,6 +11,7 @@ module ActiveRecord
             belongs_to :#{self.name.underscore.sub(/_dated_detail$/, '')}
 
             before_update :split!
+            before_save :set_start_date
 
             named_scope :on, lambda { |time| { :conditions => "\#{start_on_or_before_condition(time)} AND \#{end_on_or_after_condition(time)}" } }
 
@@ -36,9 +37,8 @@ module ActiveRecord
       end
 
       module InstanceMethods
-        def initialize(*args)
-          super
-          self.start_on = Time.now
+        def set_start_date
+          self.start_on ||= Time.now
         end
         
         def split!

data/test/dated_detail_test.rb

@@ -98,6 +98,7 @@ class ActsAsDatedDetailTest < Test::Unit::TestCase
       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
+    # A lot of tests rely on this method stubbing Time.now
     Time.stubs(:now).returns(now)
     pirate
   end
@@ -119,7 +120,7 @@ class ParentTest < ActsAsDatedDetailTest
   # Creation
   
   def test_related_dated_detail_created_along_with_model
-    pirate = Pirate.create!
+    pirate = create_pirate
     assert_equal 1, pirate.dated_details.count
   end
   
@@ -127,20 +128,49 @@ class ParentTest < ActsAsDatedDetailTest
   
   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
+    pirate = create_pirate([now])
+    assert_equal now, pirate.on
   end
   
   def test_setting_value_of_currently_effective_timestamp
-    now = Time.now
-    Time.stubs(:now).returns(now)
-    pirate = Pirate.create!
+    pirate = create_pirate
     one_month_ago = Time.now - 1.month
     pirate.on = one_month_ago
     assert_equal one_month_ago, pirate.on
   end
   
+  # Determining if instance is tracking latest history
+  
+  def test_tracks_latest_history_by_default
+    pirate = create_pirate
+    assert pirate.current?
+  end
+  
+  def test_does_not_track_latest_history_when_currently_effective_timestamp_set
+    [1.day.ago, Time.now].each do |time|
+      pirate = create_pirate
+      pirate.on = time
+      assert !pirate.current?
+    end
+  end
+  
+  def test_does_not_track_latest_history_when_currently_effective_timestamp_reset_to_now
+    pirate = create_pirate
+    pirate.on = 1.day.ago
+    pirate.on = Time.now
+    assert !pirate.current?
+  end
+  
+  # Forcing instance to track latest history again
+  
+  def test_tracks_latest_history_again
+    pirate = create_pirate([1.year.ago, 6.months.ago, 1.month.ago])
+    pirate.on = 6.months.ago
+    pirate.current!
+    assert pirate.current?
+    assert_equal catchphrase(1.month.ago), pirate.catchphrase
+  end
+  
   # Tracked Attribute Retrieval
   
   def test_tracked_attribute_for_oldest_timestamp_set_by_instance_method
@@ -160,40 +190,41 @@ class ParentTest < ActsAsDatedDetailTest
     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
+  
+  # Reloading
+  
+  def test_reloading_when_tracking_latest_history
+    pirate = create_pirate([1.hour.ago])
+    same_pirate = Pirate.find(pirate.id)
+    new_ruthlessness = 999 #same_pirate.ruthlessness + 1
+    same_pirate.update_attribute(:ruthlessness, new_ruthlessness)
+    flunk 'Pirate must be tracking latest history' unless pirate.current?
+    pirate.reload
+    assert_equal new_ruthlessness, pirate.ruthlessness
+  end
+  
+  def test_reloading_when_not_tracking_latest_history
+    pirate = create_pirate([6.months.ago, 1.hour.ago])
+    pirate.on = 5.months.ago
+    ruthlessness = pirate.ruthlessness
+    same_pirate = Pirate.find(pirate.id)
+    same_pirate.update_attribute(:ruthlessness, same_pirate.ruthlessness + 1)
+    flunk 'Pirate must not be tracking latest history' if pirate.current?
+    pirate.reload
+    assert_equal ruthlessness, pirate.ruthlessness
+  end
+  
+  def test_reloading_returns_self
+    # #reload is aliased. Test that it returns correctly
+    pirate = create_pirate
+    assert_equal pirate, pirate.reload
+  end
   
   # Tracked Attribute Methods
   
   def test_read_tracked_attributes
     # Ensure value from dated_detail is returned
-    pirate = Pirate.create!
+    pirate = create_pirate
     dated_detail = pirate.dated_detail
     pirate.stubs(:dated_detail).returns(dated_detail)
     PirateDatedDetail.tracked_attributes.each do |attribute|
@@ -205,58 +236,50 @@ class ParentTest < ActsAsDatedDetailTest
   end
   
   def test_write_tracked_attributes
-    pirate = Pirate.create!
+    pirate = create_pirate
     PirateDatedDetail.tracked_attributes.each do |attribute|
       value = 10
       pirate.send("#{attribute}=", value)
+      assert_equal value, pirate.attributes[attribute]
       assert_equal value, pirate.dated_detail.send(attribute)
     end
   end
   
   # Updating Attributes
   
+  def test_updating_tracked_attribute_updates_currently_effective_timestamp
+    pirate = create_pirate([1.year.ago])
+    pirate.update_attribute(:catchphrase, 'Yar!')
+    assert_equal Time.now, pirate.on
+  end
+  
   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 = create_pirate([1.year.ago])
     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 = create_pirate([1.year.ago])
     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 = create_pirate([1.year.ago])
     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)
+    pirate = create_pirate([1.year.ago])
     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 = create_pirate([1.year.ago])
     pirate.update_attribute(:name, 'Long John Silver')
     assert_equal 1, pirate.dated_details.count
   end
@@ -281,29 +304,26 @@ class DatedDetailTest < ActsAsDatedDetailTest
   # Creation
   
   def test_initial_start_on_value
-    pirate = Pirate.create!
+    pirate = create_pirate
     assert_equal Time.now.to_i, PirateDatedDetail.first.start_on.to_i
   end
   
   def test_initial_end_on_value
-    pirate = Pirate.create!
+    pirate = create_pirate
     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)
+    pirate = create_pirate([Time.now - 1.year])
     
     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_equal Time.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)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: acts_as_dated_detail
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Paul Gillard
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-02 00:00:00 +00:00
+date: 2010-01-05 00:00:00 +00:00
 default_executable: 
 dependencies: []