yesterday 0.2 → 0.3

data/README.rdoc

@@ -19,7 +19,7 @@ And then run the generator in your Rails 3 project:
 
   class Contact < ActiveRecord::Base
     has_many :addresses
-    tracks_changes
+    track_changes
   end
 
   class Address < ActiveRecord::Base

data/lib/yesterday/model.rb

@@ -46,7 +46,7 @@ module Yesterday
         @tracked_attributes || []
       end
 
-      def tracks_changes(options = {})
+      def track_changes(options = {})
         send :include, InstanceMethods
 
         after_save :serialize_current_state
@@ -55,13 +55,13 @@ module Yesterday
 
       def version(version_number)
         if object = first
-          Versioning.versioned_object_for(version_number, object)
+          Versioning.versioned_object_for version_number, object
         end
       end
 
       def diff_version(from_version_number, to_version_number)
         if object = first
-          Versioning.diff_for(from_version_number, to_version_number, object)
+          Versioning.diff_for from_version_number, to_version_number, object
         end
       end
 
@@ -69,29 +69,41 @@ module Yesterday
 
     module InstanceMethods
       def changesets
-        Versioning.changesets_for(self)
+        @changesets ||= Versioning.changesets_for(self)
       end
 
       def version_number
-        Versioning.current_version_number_for(self)
+        @version_number ||= Versioning.current_version_number_for(self)
       end
 
       def previous_version_number
-        version_number > 1 ? version_number - 1 : version_number
+        @previous_version_number ||= (version_number > 1 ? version_number - 1 : version_number)
       end
 
       def version(version_number)
-        Versioning.versioned_object_for(version_number, self)
+        @version ||= {}
+        @version[version_number] ||= Versioning.versioned_object_for(version_number, self)
       end
 
       def diff_version(from_version_number, to_version_number)
-        Versioning.diff_for(from_version_number, to_version_number, self)
+        @diff_version ||= {}
+        @diff_version[from_version_number] ||= {}
+        @diff_version[from_version_number][to_version_number] ||= Versioning.diff_for(from_version_number, to_version_number, self)
       end
 
       private
 
       def serialize_current_state
         Versioning.create_changeset_for self
+        invalidate_cached_versioning
+      end
+
+      def invalidate_cached_versioning
+        cached_versioned_items.each { |item| instance_variable_set(:"@#{item}", nil) }
+      end
+
+      def cached_versioned_items
+        %w(changesets version_number previous_version_number version diff_version)
       end
 
     end

data/lib/yesterday/serializer.rb

@@ -14,7 +14,7 @@ module Yesterday
       each_association_collection(object) do |association, association_name, item|
         path << object
 
-        if assocation_has_collection?(association)
+        if association_has_collection?(association)
           hash[association_name] ||= []
           hash[association_name] << hash_object(item)
         else
@@ -27,7 +27,7 @@ module Yesterday
       hash
     end
 
-    def assocation_has_collection?(association)
+    def association_has_collection?(association)
       [:has_many, :has_and_belongs_to_many].include? association.macro
     end
 

data/lib/yesterday/version.rb

@@ -1,3 +1,3 @@
 module Yesterday
-  VERSION = "0.2"
+  VERSION = "0.3"
 end

data/spec/models.rb

@@ -1,12 +1,20 @@
+class Report < ActiveRecord::Base
+  has_many :contacts
+  has_many :companies
+
+  track_changes
+end
+
 class Contact < ActiveRecord::Base
   has_and_belongs_to_many :addresses
-  tracks_changes
 end
 
 class Address < ActiveRecord::Base
 end
 
 class Company < ActiveRecord::Base
-  tracks_changes
+  has_and_belongs_to_many :addresses
+
+  track_changes
   exclude_tracking_for :attributes => [:created_at, :updated_at]
 end

data/spec/schema.rb

@@ -1,11 +1,18 @@
 ActiveRecord::Schema.define(:version => 1) do
 
+  create_table 'reports', :force => true do |t|
+    t.string    'description'
+    t.datetime  'created_at'
+    t.datetime  'updated_at'
+  end
+
   create_table 'contacts', :force => true do |t|
     t.string    'first_name'
     t.string    'middle_name'
     t.string    'last_name'
     t.datetime  'created_at'
     t.datetime  'updated_at'
+    t.integer   'report_id'
   end
 
   create_table 'addresses', :force => true do |t|
@@ -23,6 +30,11 @@ ActiveRecord::Schema.define(:version => 1) do
     t.integer   'address_id'
   end
 
+  create_table 'addresses_companies', :id => false, :force => true do |t|
+    t.integer   'company_id'
+    t.integer   'address_id'
+  end
+
   create_table 'changesets', :force => true do |t|
     t.integer   'changed_object_id'
     t.string    'changed_object_type'
@@ -36,6 +48,7 @@ ActiveRecord::Schema.define(:version => 1) do
     t.string    'name'
     t.datetime  'created_at'
     t.datetime  'updated_at'
+    t.integer   'report_id'
   end
 
 end

data/spec/serializer_spec.rb

@@ -6,7 +6,7 @@ describe Yesterday::Serializer do
 
     address1 = Address.create(
       :street => 'street',
-      :house_number => 1,
+      :house_number => '1',
       :zipcode => '1234AA',
       :city => 'Armadillo',
       :country => 'FooCountry'
@@ -14,7 +14,7 @@ describe Yesterday::Serializer do
 
     address2 = Address.create(
       :street => 'lane',
-      :house_number => 1337,
+      :house_number => '1337',
       :zipcode => '2211AB',
       :city => 'Cougar town',
       :country => 'BarCountry'
@@ -24,6 +24,7 @@ describe Yesterday::Serializer do
     contact.addresses << address2
 
     Yesterday::Serializer.new(contact).to_hash.should == {
+      'report_id' => nil,
       'id' => contact.id,
       'first_name' => 'foo',
       'middle_name' => nil,
@@ -34,7 +35,7 @@ describe Yesterday::Serializer do
         {
           'id' => address1.id,
           'street' => 'street',
-          'house_number' => 1,
+          'house_number' => '1',
           'zipcode' => '1234AA',
           'city' => 'Armadillo',
           'country' => 'FooCountry',
@@ -44,7 +45,7 @@ describe Yesterday::Serializer do
         {
           'id' => address2.id,
           'street' => 'lane',
-          'house_number' => 1337,
+          'house_number' => '1337',
           'zipcode' => '2211AB',
           'city' => 'Cougar town',
           'country' => 'BarCountry',
@@ -60,7 +61,8 @@ describe Yesterday::Serializer do
 
     Yesterday::Serializer.new(company).to_hash.should == {
       'id' => company.id,
-      'name' => 'foobar'
+      'name' => 'foobar',
+      'report_id' => nil
     }
   end
 end

data/spec/yesterday_model_spec.rb

@@ -5,117 +5,126 @@ require 'models'
 describe Yesterday::Model do
 
   it 'should have mixed in yesterday::model' do
-    Contact.new.should respond_to :version_number
+    Report.new.should respond_to :version_number
     Address.new.should_not respond_to :version_number
   end
 
   it 'should create a new changeset when saved' do
     Yesterday::Changeset.count.should == 0
-    Contact.create :first_name => 'foo', :last_name => 'bar'
+    Report.create :description => 'bar'
     Yesterday::Changeset.count.should == 1
   end
 
   it 'should return all related changesets' do
-    contact = Contact.create(:first_name => 'foo', :last_name => 'bar')
-    contact.changesets.size.should == 1
-    contact.changesets.first.changed_object_type.should == 'Contact'
+    report = Report.create(:description => 'foo bar')
+    report.changesets.size.should == 1
+    report.changesets.first.changed_object_type.should == 'Report'
   end
 
   describe 'returning version numbers' do
     it 'should return version number when new record' do
-      contact = Contact.new(:first_name => 'foo', :last_name => 'bar')
-      contact.version_number.should == 0
+      report = Report.new(:description => 'foo bar')
+      report.version_number.should == 0
     end
 
     it 'should return version number after first save' do
-      contact = Contact.create(:first_name => 'foo', :last_name => 'bar')
-      contact.version_number.should == 1
+      report = Report.create(:description => 'foo bar')
+      report.version_number.should == 1
     end
 
     it 'should return version number after update' do
-      contact = Contact.create(:first_name => 'foo', :last_name => 'bar')
-      contact.last_name = 'baz'
-      contact.save!
+      report = Report.create(:description => 'foo bar')
+      report.description = 'foo bar baz'
+      report.save!
 
-      contact.version_number.should == 2
+      report.version_number.should == 2
     end
   end
 
   describe' returning older versions' do
     it 'should not return and old version when there is no history' do
-      Contact.new
-      Contact.version(0).should == nil
+      Report.new
+      Report.version(0).should == nil
     end
 
     it 'should return a historical item' do
-      contact = Contact.create!(:first_name => 'foo', :last_name => 'bar')
-      Contact.where(:id => contact.id).version(0).should == nil
-      Contact.where(:id => contact.id).version(1).should be_a(Yesterday::VersionedObject)
+      report = Report.create!(:description => 'bar')
+      Report.where(:id => report.id).version(0).should == nil
+      Report.where(:id => report.id).version(1).should be_a(Yesterday::VersionedObject)
     end
 
     describe 'return a historical view of a version' do
       before do
-        @contact = Contact.create!(:first_name => 'foo', :last_name => 'bar')
-        @contact.update_attributes :first_name => 'john', :last_name => 'dough'
-        @contact.update_attributes :first_name => 'ronald', :last_name => 'mcdonald'
+        @report = Report.create!(:description => 'foo')
+        @report.update_attributes :description => 'bar'
+        @report.update_attributes :description => 'baz'
       end
 
       it 'using scopes' do
-        @contact.version_number.should == 3
+        @report.version_number.should == 3
 
-        Contact.where(:id => @contact.id).version(2).first_name.should == 'john'
-        Contact.where(:id => @contact.id).version(2).last_name.should == 'dough'
-
-        Contact.where(:id => @contact.id).version(1).first_name.should == 'foo'
-        Contact.where(:id => @contact.id).version(1).last_name.should == 'bar'
+        Report.where(:id => @report.id).version(3).description.should == 'baz'
+        Report.where(:id => @report.id).version(2).description.should == 'bar'
+        Report.where(:id => @report.id).version(1).description.should == 'foo'
       end
 
       it 'using instance method' do
-        @contact.version(2).first_name.should == 'john'
-        @contact.version(2).last_name.should == 'dough'
-
-        @contact.version(1).first_name.should == 'foo'
-        @contact.version(1).last_name.should == 'bar'
+        @report.version(3).description.should == 'baz'
+        @report.version(2).description.should == 'bar'
+        @report.version(1).description.should == 'foo'
       end
     end
   end
 
   describe 'diffing two versions' do
     it 'should diff version 1 with version 2' do
-      contact = Contact.create(:first_name => 'foo', :last_name => 'bar')
-      contact.update_attributes :first_name => 'john', :last_name => 'do'
+      report = Report.create(:description => 'foo bar')
+      report.update_attributes :description => 'foo bar baz'
 
-      diff = contact.diff_version(1, 2)
+      diff = report.diff_version(1, 2)
       diff.should be_a(Yesterday::VersionedObject)
 
-      diff.first_name.current.should == 'john'
-      diff.first_name.previous.should == 'foo'
-
-      diff.last_name.current.should == 'do'
-      diff.last_name.previous.should == 'bar'
+      diff.description.current.should == 'foo bar baz'
+      diff.description.previous.should == 'foo bar'
     end
 
     it 'should diff version 1 with version 3' do
-      contact = Contact.create(:first_name => 'foo', :last_name => 'bar')
-      contact.update_attributes :first_name => 'john', :last_name => 'do'
-      contact.update_attributes :first_name => 'edward', :last_name => 'foo'
+      report = Report.create(:description => 'foo')
+      report.update_attributes :description => 'bar'
+      report.update_attributes :description => 'baz'
 
-      diff = contact.diff_version(1, 3)
+      diff = report.diff_version(1, 3)
       diff.should be_a(Yesterday::VersionedObject)
 
-      diff.first_name.current.should == 'edward'
-      diff.first_name.previous.should == 'foo'
-
-      diff.last_name.current.should == 'foo'
-      diff.last_name.previous.should == 'bar'
+      diff.description.current.should == 'baz'
+      diff.description.previous.should == 'foo'
     end
 
     it 'should detect that new associations are created' do
-      contact = Contact.create(:first_name => 'foo', :last_name => 'bar')
+      address1 = Address.new(
+        :street => 'street',
+        :house_number => 1,
+        :zipcode => '1234AA',
+        :city => 'ElectricCity',
+        :country => 'Netherlands'
+      )
+
+      report = Report.create(
+        :description => 'foo bar baz',
+        :contacts => [
+          Contact.create(
+            :first_name => 'John',
+            :last_name => 'Doe',
+            :addresses => [
+              address1
+            ]
+          )
+        ]
+      )
 
-      contact.version_number.should == 1
+      report.version_number.should == 1
 
-      address1 = Address.create(
+      address2 = Address.new(
         :street => 'street',
         :house_number => 1,
         :zipcode => '1234AA',
@@ -123,7 +132,7 @@ describe Yesterday::Model do
         :country => 'FooCountry'
       )
 
-      address2 = Address.create(
+      address3 = Address.new(
         :street => 'lane',
         :house_number => 1337,
         :zipcode => '2211AB',
@@ -131,22 +140,52 @@ describe Yesterday::Model do
         :country => 'BarCountry'
       )
 
-      contact.addresses = [address1, address2]
-      contact.save!
+      report.contacts.first.addresses = [address1, address2, address3]
 
-      contact.version_number.should == 2
+      report.save!
 
-      diff = contact.diff_version(1, 2)
-      diff.created_addresses.count.should == 2
-      diff.created_addresses.first.id.should == address1.id
-      diff.created_addresses.last.id.should ==  address2.id
+      report.version_number.should == 2
+
+      diff = report.diff_version(1, 2)
+
+      diff.contacts.count.should == 1
+      diff.contacts.first.addresses.count.should == 1
+      diff.contacts.first.addresses.first.id.should == address1.id
+
+      diff.contacts.first.created_addresses.count.should == 2
+      diff.contacts.first.created_addresses.first.id.should == address2.id
+      diff.contacts.first.created_addresses.last.id.should ==  address3.id
     end
 
     describe 'association removal' do
       before do
-        @contact = Contact.create(:first_name => 'foo', :last_name => 'bar')
+        @report = Report.create(
+          :description => 'foo bar baz',
+          :contacts => [
+            Contact.create(
+              :first_name => 'John',
+              :last_name => 'Doe',
+              :addresses => [
+                Address.create(
+                  :street => 'street',
+                  :house_number => 1,
+                  :zipcode => '1234AA',
+                  :city => 'ElectricCity',
+                  :country => 'Netherlands'
+                )
+              ]
+            )
+          ],
+          :companies => [
+            Company.create(
+              :name => 'Test company'
+            )
+          ]
+        )
+
+        @report.version_number.should == 1
 
-        @address1 = Address.create(
+        @address1 = Address.new(
           :street => 'street',
           :house_number => 1,
           :zipcode => '1234AA',
@@ -154,7 +193,7 @@ describe Yesterday::Model do
           :country => 'FooCountry'
         )
 
-        @address2 = Address.create(
+        @address2 = Address.new(
           :street => 'lane',
           :house_number => 1337,
           :zipcode => '2211AB',
@@ -162,32 +201,37 @@ describe Yesterday::Model do
           :country => 'BarCountry'
         )
 
-        @contact.addresses = [@address1, @address2]
-        @contact.save!
+        @report.contacts.first.addresses = [@address1, @address2]
+        @report.save!
 
-        @contact.addresses = [@address1]
-        @address2.destroy
+        @report.contacts.first.addresses = [@address1]
+        @report.companies.first.addresses = [@address1]
+        @report.save!
 
-        @contact.save!
-
-        @contact.version_number.should == 3
+        @report.version_number.should == 3
       end
 
       it 'should detect that associations are destroyed when diffing version 2 with 3' do
+        diff = @report.diff_version(2, 3)
+        diff.contacts.count.should == 1
+
+        diff.contacts.first.addresses.count.should == 1
+        diff.contacts.first.destroyed_addresses.count.should == 1
 
-        diff = @contact.diff_version(2, 3)
-        diff.addresses.count.should == 1
-        diff.destroyed_addresses.count.should == 1
+        diff.contacts.first.destroyed_addresses.first.id.should == @address2.id
+        diff.contacts.first.addresses.first.id.should == @address1.id
 
-        diff.destroyed_addresses.first.id.should == @address2.id
-        diff.addresses.first.id.should == @address1.id
+        diff.companies.first.created_addresses.count.should == 1
       end
 
       it 'should detect that associations are created when diffing version 1 with 3' do
-        diff = @contact.diff_version(1, 3)
-        diff.should_not respond_to(:addresses)
-        diff.created_addresses.count.should == 1
-        diff.created_addresses.first.id.should == @address1.id
+        diff = @report.diff_version(1, 3)
+        diff.contacts.first.should_not respond_to(:addresses)
+
+        diff.contacts.first.created_addresses.count.should == 1
+        diff.contacts.first.created_addresses.first.id.should == @address1.id
+
+        diff.companies.first.created_addresses.count.should == 1
       end
     end
   end

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: yesterday
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: false
   segments: 
   - 0
-  - 2
-  version: "0.2"
+  - 3
+  version: "0.3"
 platform: ruby
 authors: 
 - Diederick Lawson
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-16 00:00:00 +01:00
+date: 2011-04-01 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency