yesterday 0.2

data/spec/differ_spec.rb

@@ -0,0 +1,206 @@
+require 'yesterday'
+
+describe Yesterday::Differ do
+  it 'should detect changes' do
+    from = {
+      'id' => 1,
+      'description' => 'Some description',
+      'contacts' => [
+        {
+          'id' => 1,
+          'name' => 'Harold',
+          'addresses' => [
+            { 'id' => 1,
+              'address' => 'Sesamstreet 1' },
+            { 'id' => 2,
+              'address' => 'Sesamstreet 2' }
+           ]
+        }
+      ]
+    }
+
+    to = {
+      'id' => 1,
+      'description' => 'Other description',
+      'contacts' => [
+        {
+          'id' => 1,
+          'name' => 'Peter',
+          'addresses' => [
+            { 'id' => 1,
+              'address' => 'Foobar 1' },
+            { 'id' => 2,
+              'address' => 'Foobar 2' }
+          ]
+        }
+      ]
+    }
+
+    Yesterday::Differ.new(from, to).diff.should == {
+      'id' => 1,
+      'description' => ['Some description', 'Other description'],
+      'contacts' => [
+        {
+          'id' => 1,
+          'name' => ['Harold', 'Peter'],
+          'addresses' => [
+            { 'id' => 1,
+              'address' => ['Sesamstreet 1', 'Foobar 1'] },
+            { 'id' => 2,
+              'address' => ['Sesamstreet 2', 'Foobar 2'] }
+           ]
+        }
+      ]
+    }
+  end
+
+  it 'should detect destroyed items' do
+    from = {
+      'id' => 1,
+      'description' => 'Some description',
+      'contacts' => [
+        {
+          'id' => 1,
+          'name' => 'Harold',
+          'addresses' => [
+            { 'id' => 1,
+              'address' => 'Sesamstreet 1' },
+            { 'id' => 2,
+              'address' => 'Sesamstreet 2' }
+           ]
+        },
+        {
+          'id' => 2,
+          'name' => 'Peter',
+          'addresses' => [
+            { 'id' => 1,
+              'address' => 'Sesamstreet 1' },
+            { 'id' => 2,
+              'address' => 'Sesamstreet 2' }
+           ]
+        }
+      ]
+    }
+
+    to = {
+      'id' => 1,
+      'description' => 'Some description',
+      'contacts' => [
+        {
+          'id' => 1,
+          'name' => 'Harold',
+          'addresses' => [
+            { 'id' => 2,
+              'address' => 'Sesamstreet 2' }
+           ]
+        }
+      ]
+    }
+
+    Yesterday::Differ.new(from, to).diff.should == {
+      'id' => 1,
+      'description' => ['Some description', 'Some description'],
+      'contacts' => [
+        {
+          'id' => 1,
+          'name' => ['Harold', 'Harold'],
+          'addresses' => [
+            { 'id' => 2,
+              'address' => ['Sesamstreet 2', 'Sesamstreet 2'] }
+           ],
+           'destroyed_addresses' => [
+              { 'id' => 1,
+                'address' => 'Sesamstreet 1' }
+           ]
+        }
+      ],
+      'destroyed_contacts' => [
+        {
+          'id' => 2,
+          'name' => 'Peter',
+          'addresses' => [
+            { 'id' => 1,
+              'address' => 'Sesamstreet 1' },
+            { 'id' => 2,
+              'address' => 'Sesamstreet 2' }
+           ]
+        }
+      ]
+    }
+  end
+
+  it 'should detect created items' do
+    from = {
+      'id' => 1,
+      'description' => 'Some description',
+      'contacts' => [
+        {
+          'id' => 1,
+          'name' => 'Harold',
+          'addresses' => [
+            { 'id' => 2,
+              'address' => 'Sesamstreet 2' }
+           ]
+        }
+      ]
+    }
+
+    to = {
+      'id' => 1,
+      'description' => 'Some description',
+      'contacts' => [
+        {
+          'id' => 1,
+          'name' => 'Harold',
+          'addresses' => [
+            { 'id' => 1,
+              'address' => 'Sesamstreet 1' },
+            { 'id' => 2,
+              'address' => 'Sesamstreet 2' }
+           ]
+        },
+        {
+          'id' => 2,
+          'name' => 'Peter',
+          'addresses' => [
+            { 'id' => 1,
+              'address' => 'Sesamstreet 1' },
+            { 'id' => 2,
+              'address' => 'Sesamstreet 2' }
+           ]
+        }
+      ]
+    }
+
+    Yesterday::Differ.new(from, to).diff.should == {
+      'id' => 1,
+      'description' => ['Some description', 'Some description'],
+      'contacts' => [
+        {
+          'id' => 1,
+          'name' => ['Harold', 'Harold'],
+          'addresses' => [
+            { 'id' => 2,
+              'address' => ['Sesamstreet 2', 'Sesamstreet 2'] }
+           ],
+           'created_addresses' => [
+              { 'id' => 1,
+                'address' => 'Sesamstreet 1' }
+           ]
+        }
+      ],
+      'created_contacts' => [
+        {
+          'id' => 2,
+          'name' => 'Peter',
+          'addresses' => [
+            { 'id' => 1,
+              'address' => 'Sesamstreet 1' },
+            { 'id' => 2,
+              'address' => 'Sesamstreet 2' }
+           ]
+        }
+      ]
+    }
+  end
+end

data/spec/models.rb

@@ -0,0 +1,12 @@
+class Contact < ActiveRecord::Base
+  has_and_belongs_to_many :addresses
+  tracks_changes
+end
+
+class Address < ActiveRecord::Base
+end
+
+class Company < ActiveRecord::Base
+  tracks_changes
+  exclude_tracking_for :attributes => [:created_at, :updated_at]
+end

data/spec/schema.rb

@@ -0,0 +1,41 @@
+ActiveRecord::Schema.define(:version => 1) do
+
+  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'
+  end
+
+  create_table 'addresses', :force => true do |t|
+    t.string    'street'
+    t.string    'house_number'
+    t.string    'zipcode'
+    t.string    'city'
+    t.string    'country'
+    t.datetime  'created_at'
+    t.datetime  'updated_at'
+  end
+
+  create_table 'addresses_contacts', :id => false, :force => true do |t|
+    t.integer   'contact_id'
+    t.integer   'address_id'
+  end
+
+  create_table 'changesets', :force => true do |t|
+    t.integer   'changed_object_id'
+    t.string    'changed_object_type'
+    t.text      'object_attributes'
+    t.integer   'version_number'
+    t.datetime  'created_at'
+    t.datetime  'updated_at'
+  end
+
+  create_table 'companies', :force => true do |t|
+    t.string    'name'
+    t.datetime  'created_at'
+    t.datetime  'updated_at'
+  end
+
+end

data/spec/serializer_spec.rb

@@ -0,0 +1,66 @@
+require 'yesterday'
+
+describe Yesterday::Serializer do
+  it 'should serialize an activerecord object to a hash' do
+    contact = Contact.create(:first_name => 'foo', :last_name => 'bar')
+
+    address1 = Address.create(
+      :street => 'street',
+      :house_number => 1,
+      :zipcode => '1234AA',
+      :city => 'Armadillo',
+      :country => 'FooCountry'
+    )
+
+    address2 = Address.create(
+      :street => 'lane',
+      :house_number => 1337,
+      :zipcode => '2211AB',
+      :city => 'Cougar town',
+      :country => 'BarCountry'
+    )
+
+    contact.addresses << address1
+    contact.addresses << address2
+
+    Yesterday::Serializer.new(contact).to_hash.should == {
+      'id' => contact.id,
+      'first_name' => 'foo',
+      'middle_name' => nil,
+      'last_name' => 'bar',
+      'created_at' => contact.created_at,
+      'updated_at' => contact.updated_at,
+      'addresses' => [
+        {
+          'id' => address1.id,
+          'street' => 'street',
+          'house_number' => 1,
+          'zipcode' => '1234AA',
+          'city' => 'Armadillo',
+          'country' => 'FooCountry',
+          'created_at' => address1.created_at,
+          'updated_at' => address1.updated_at
+        },
+        {
+          'id' => address2.id,
+          'street' => 'lane',
+          'house_number' => 1337,
+          'zipcode' => '2211AB',
+          'city' => 'Cougar town',
+          'country' => 'BarCountry',
+          'created_at' => address2.created_at,
+          'updated_at' => address2.updated_at
+        }
+      ]
+    }
+  end
+
+  it 'should not serialize every attribute or association if exclude_tracking_for is used' do
+    company = Company.create :name => 'foobar'
+
+    Yesterday::Serializer.new(company).to_hash.should == {
+      'id' => company.id,
+      'name' => 'foobar'
+    }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,41 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+require 'active_record'
+require 'yaml'
+require 'rspec'
+
+RSpec.configure do |config|
+  config.before(:each) do
+    Contact.delete_all
+    Address.delete_all
+    Yesterday::Changeset.delete_all
+  end
+end
+
+$enabled = false
+
+ActiveSupport::Notifications.subscribe(/sql/i) do |*args|
+  if $enabled
+    event = ActiveSupport::Notifications::Event.new(*args)
+    puts "SQL #{event.duration}: #{event.payload[:sql]}"
+  end
+end
+
+def connect(environment)
+  conf = YAML::load(File.open(File.dirname(__FILE__) + '/database.yml'))
+  ActiveRecord::Base.establish_connection(conf[environment])
+end
+
+# Open ActiveRecord connection
+connect('test')
+
+original_stdout = $stdout
+$stdout = StringIO.new
+
+begin
+  load(File.dirname(__FILE__) + "/schema.rb")
+ensure
+  $stdout = original_stdout
+end
+

data/spec/versioned_object_creator_spec.rb

@@ -0,0 +1,41 @@
+require 'yesterday'
+
+describe Yesterday::VersionedObjectCreator do
+  it 'should deserialize a hash into a structured set of historical item classes' do
+    from = {
+      'id' => 1,
+      'description' => ['Old description', 'New description'],
+      'contacts' => [
+        {
+          'id' => 1,
+          'name' => ['Peter', 'Harold'],
+          'addresses' => [
+            { 'id' => 1,
+              'address' => ['Sesamstreet 1', 'Sesamstreet 1'] },
+            { 'id' => 2,
+              'address' => ['Sesamstreet 2', 'Sesamstreet 2'] }
+           ]
+        }
+      ]
+    }
+
+    object = Yesterday::VersionedObjectCreator.new(from).to_object
+
+    require 'pp'
+
+    object.description.current.should == 'New description'
+    object.id.should == 1
+
+    object.contacts.should be_a(Array)
+    object.contacts.size.should == 1
+
+    object.contacts.first.id.should == 1
+    object.contacts.first.name.to_s.should == 'Harold'
+    object.contacts.first.name.previous.should == 'Peter'
+    object.contacts.first.addresses.size.should == 2
+    object.contacts.first.addresses.first.address.previous.should == 'Sesamstreet 1'
+    object.contacts.first.addresses.first.address.current.should == 'Sesamstreet 1'
+    object.contacts.first.addresses.last.address.previous.should == 'Sesamstreet 2'
+    object.contacts.first.addresses.last.address.current.should == 'Sesamstreet 2'
+  end
+end

data/spec/yesterday_model_spec.rb

@@ -0,0 +1,195 @@
+require 'spec_helper'
+require 'yesterday'
+require 'models'
+
+describe Yesterday::Model do
+
+  it 'should have mixed in yesterday::model' do
+    Contact.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'
+    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'
+  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
+    end
+
+    it 'should return version number after first save' do
+      contact = Contact.create(:first_name => 'foo', :last_name => 'bar')
+      contact.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!
+
+      contact.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
+    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)
+    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'
+      end
+
+      it 'using scopes' do
+        @contact.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'
+      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'
+      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'
+
+      diff = contact.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'
+    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'
+
+      diff = contact.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'
+    end
+
+    it 'should detect that new associations are created' do
+      contact = Contact.create(:first_name => 'foo', :last_name => 'bar')
+
+      contact.version_number.should == 1
+
+      address1 = Address.create(
+        :street => 'street',
+        :house_number => 1,
+        :zipcode => '1234AA',
+        :city => 'Armadillo',
+        :country => 'FooCountry'
+      )
+
+      address2 = Address.create(
+        :street => 'lane',
+        :house_number => 1337,
+        :zipcode => '2211AB',
+        :city => 'Cougar town',
+        :country => 'BarCountry'
+      )
+
+      contact.addresses = [address1, address2]
+      contact.save!
+
+      contact.version_number.should == 2
+
+      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
+    end
+
+    describe 'association removal' do
+      before do
+        @contact = Contact.create(:first_name => 'foo', :last_name => 'bar')
+
+        @address1 = Address.create(
+          :street => 'street',
+          :house_number => 1,
+          :zipcode => '1234AA',
+          :city => 'Armadillo',
+          :country => 'FooCountry'
+        )
+
+        @address2 = Address.create(
+          :street => 'lane',
+          :house_number => 1337,
+          :zipcode => '2211AB',
+          :city => 'Cougar town',
+          :country => 'BarCountry'
+        )
+
+        @contact.addresses = [@address1, @address2]
+        @contact.save!
+
+        @contact.addresses = [@address1]
+        @address2.destroy
+
+        @contact.save!
+
+        @contact.version_number.should == 3
+      end
+
+      it 'should detect that associations are destroyed when diffing version 2 with 3' do
+
+        diff = @contact.diff_version(2, 3)
+        diff.addresses.count.should == 1
+        diff.destroyed_addresses.count.should == 1
+
+        diff.destroyed_addresses.first.id.should == @address2.id
+        diff.addresses.first.id.should == @address1.id
+      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
+      end
+    end
+  end
+
+end

data/yesterday.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "yesterday/version"
+
+Gem::Specification.new do |s|
+  s.name        = "yesterday"
+  s.version     = Yesterday::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Diederick Lawson"]
+  s.email       = ["webmaster@altovista.nl"]
+  s.homepage    = ""
+  s.summary     = "Track history in your active record models"
+  s.description = "Track history and view any made changes in your active record models"
+
+  s.rubyforge_project = "yesterday"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'sqlite3'
+  s.add_dependency 'rails'
+end