airblade-paper_trail 1.0.1 → 1.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+test/debug.log
+test/paper_trail_plugin.sqlite3.db

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 [name of plugin creator]
+Copyright (c) 2009 Andy Stewart, AirBlade Software Ltd.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -127,9 +127,11 @@ And on again like this:
 
     `config.gem 'airblade-paper_trail', :lib => 'paper_trail', :source => 'http://gems.github.com'`
 
+    or:
+
     `script/plugin install git://github.com/airblade/paper_trail.git`
 
-2. Generate a migration which wll add a `versions` table to your database.
+2. Generate a migration which will add a `versions` table to your database.
 
     `script/generate paper_trail`
 

data/generators/paper_trail/templates/create_versions.rb

@@ -8,9 +8,11 @@ class CreateVersions < ActiveRecord::Migration
       t.text     :object
       t.datetime :created_at
     end
+    add_index :versions, [:item_type, :item_id]
   end
 
   def self.down
+    remove_index :versions, [:item_type, :item_id]
     drop_table :versions
   end
 end

data/lib/paper_trail/version.rb

@@ -4,17 +4,56 @@ class Version < ActiveRecord::Base
 
   def reify
     unless object.nil?
-      # Using +item_type.constantize+ rather than +item.class+
-      # allows us to retrieve destroyed objects.
-      model = item_type.constantize.new
-      YAML::load(object).each do |k, v|
+      # Attributes
+
+      attrs = YAML::load object
+
+      # Normally a polymorphic belongs_to relationship allows us
+      # to get the object we belong to by calling, in this case,
+      # +item+.  However this returns nil if +item+ has been
+      # destroyed, and we need to be able to retrieve destroyed
+      # objects.
+      #
+      # In this situation we constantize the +item_type+ to get hold of
+      # the class...except when the stored object's attributes
+      # include a +type+ key.  If this is the case, the object
+      # we belong to is using single table inheritance and the
+      # +item_type+ will be the base class, not the actual subclass.
+      # If +type+ is present but empty, the class is the base class.
+
+      if item
+        model = item
+      else
+        class_name = attrs['type'].blank? ? item_type : attrs['type']
+        klass = class_name.constantize
+        model = klass.new
+      end
+
+      attrs.each do |k, v|
         begin
           model.send "#{k}=", v
         rescue NoMethodError
           RAILS_DEFAULT_LOGGER.warn "Attribute #{k} does not exist on #{item_type} (Version id: #{id})."
         end
       end
+
       model
     end
   end
+
+  def next
+    Version.first :conditions => ["id > ? AND item_type = ? AND item_id = ?", id, item_type, item_id],
+                  :order => 'id ASC'
+  end
+
+  def previous
+    Version.first :conditions => ["id < ? AND item_type = ? AND item_id = ?", id, item_type, item_id],
+                  :order => 'id DESC'
+  end
+
+  def index
+    Version.all(:conditions => ["item_type = ? AND item_id = ?", item_type, item_id],
+                :order => 'id ASC').index(self)
+  end
+  
 end

data/paper_trail.gemspec

@@ -2,17 +2,18 @@
 
 Gem::Specification.new do |s|
   s.name = %q{paper_trail}
-  s.version = "1.0.1"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andy Stewart"]
-  s.date = %q{2009-05-28}
+  s.date = %q{2009-06-22}
   s.email = %q{boss@airbladesoftware.com}
   s.extra_rdoc_files = [
     "README.md"
   ]
   s.files = [
-    "MIT-LICENSE",
+    ".gitignore",
+     "MIT-LICENSE",
      "README.md",
      "Rakefile",
      "VERSION",

data/test/paper_trail_model_test.rb

@@ -2,6 +2,19 @@ require File.dirname(__FILE__) + '/test_helper.rb'
 
 class Widget < ActiveRecord::Base
   has_paper_trail
+  has_one :wotsit
+  has_many :fluxors, :order => :name
+end
+
+class FooWidget < Widget
+end
+
+class Wotsit < ActiveRecord::Base
+  belongs_to :widget
+end
+
+class Fluxor < ActiveRecord::Base
+  belongs_to :widget
 end
 
 
@@ -65,22 +78,63 @@ class HasPaperTrailModelTest < Test::Unit::TestCase
           assert_match /update/i, @widget.versions.last.event
         end
 
+        
+        context 'and has one associated object' do
+          setup do
+            @wotsit = @widget.create_wotsit :name => 'John'
+            @reified_widget = @widget.versions.last.reify
+          end
+
+          should 'copy the has_one association when reifying' do
+            assert_equal @wotsit, @reified_widget.wotsit
+          end
+        end
+
+
+        context 'and has many associated objects' do
+          setup do
+            @f0 = @widget.fluxors.create :name => 'f-zero'
+            @f1 = @widget.fluxors.create :name => 'f-one'
+            @reified_widget = @widget.versions.last.reify
+          end
+
+          should 'copy the has_many associations when reifying' do
+            assert_equal @widget.fluxors.length, @reified_widget.fluxors.length
+            assert_same_elements @widget.fluxors, @reified_widget.fluxors
+
+            assert_equal @widget.versions.length, @reified_widget.versions.length
+            assert_same_elements @widget.versions, @reified_widget.versions
+          end
+        end
+
 
         context 'and then destroyed' do
-          setup { @widget.destroy }
+          setup do
+            @fluxor = @widget.fluxors.create :name => 'flux'
+            @widget.destroy
+            @reified_widget = @widget.versions.last.reify
+          end
+
+          should 'record the correct event' do
+            assert_match /destroy/i, @widget.versions.last.event
+          end
 
           should 'have three previous versions' do
             assert_equal 3, @widget.versions.length
           end
 
           should 'be available in its previous version' do
-            widget = @widget.versions.last.reify
-            assert_equal @widget.id, widget.id
-            assert_equal @widget.attributes, widget.attributes
+            assert_equal @widget.id, @reified_widget.id
+            assert_equal @widget.attributes, @reified_widget.attributes
           end
 
-          should 'record the correct event' do
-            assert_match /destroy/i, @widget.versions.last.event
+          should 'be re-creatable from its previous version' do
+            assert @reified_widget.save
+          end
+
+          should 'restore its associations on its previous version' do
+            @reified_widget.save
+            assert_equal 1, @reified_widget.fluxors.length
           end
         end
       end
@@ -88,7 +142,7 @@ class HasPaperTrailModelTest < Test::Unit::TestCase
   end
 
 
-  # Test the serialisation and unserialisation.
+  # Test the serialisation and deserialisation.
   # TODO: binary
   context "A record's papertrail" do
     setup do
@@ -248,4 +302,69 @@ class HasPaperTrailModelTest < Test::Unit::TestCase
       end
     end
   end
+
+
+  context 'A subclass' do
+    setup do
+      @foo = FooWidget.create
+      @foo.update_attributes :name => 'Fooey'
+    end
+
+    should 'reify with the correct type' do
+      thing = @foo.versions.last.reify
+      assert_kind_of FooWidget, thing
+    end
+
+
+    context 'when destroyed' do
+      setup { @foo.destroy }
+
+      should 'reify with the correct type' do
+        thing = @foo.versions.last.reify
+        assert_kind_of FooWidget, thing
+      end
+    end
+  end
+
+
+  context 'An item with versions' do
+    setup do
+      @widget = Widget.create :name => 'Widget'
+      @widget.update_attributes :name => 'Fidget'
+      @widget.update_attributes :name => 'Digit'
+    end
+
+    context 'on the first version' do
+      setup { @version = @widget.versions.first }
+
+      should 'have a nil previous version' do
+        assert_nil @version.previous
+      end
+
+      should 'return the next version' do
+        assert_equal @widget.versions[1], @version.next
+      end
+
+      should 'return the correct index' do
+        assert_equal 0, @version.index
+      end
+    end
+
+    context 'on the last version' do
+      setup { @version = @widget.versions.last }
+
+      should 'return the previous version' do
+        assert_equal @widget.versions[@widget.versions.length - 2], @version.previous
+      end
+
+      should 'have a nil next version' do
+        assert_nil @version.next
+      end
+
+      should 'return the correct index' do
+        assert_equal @widget.versions.length - 1, @version.index
+      end
+    end
+  end
+
 end

data/test/paper_trail_schema_test.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class PaperTrailTest < ActiveSupport::TestCase
+class PaperTrailSchemaTest < ActiveSupport::TestCase
   def setup
     load_schema
   end
@@ -8,6 +8,7 @@ class PaperTrailTest < ActiveSupport::TestCase
   def test_schema_has_loaded_correctly
     assert_equal [], Widget.all
     assert_equal [], Version.all
-    assert_equal [], User.all
+    assert_equal [], Wotsit.all
+    assert_equal [], Fluxor.all
   end
 end

data/test/schema.rb

@@ -12,11 +12,7 @@ ActiveRecord::Schema.define(:version => 0) do
     t.boolean   :a_boolean
     t.datetime  :created_at, :updated_at
     t.string    :sacrificial_column
-  end
-
-  create_table :users, :force => true do |t|
-    t.string   :name
-    t.datetime :created_at, :updated_at
+    t.string    :type
   end
 
   create_table :versions, :force => true do |t|
@@ -27,5 +23,16 @@ ActiveRecord::Schema.define(:version => 0) do
     t.text     :object
     t.datetime :created_at
   end
+  add_index :versions, [:item_type, :item_id]
+
+  create_table :wotsits, :force => true do |t|
+    t.integer :widget_id
+    t.string  :name
+  end
+
+  create_table :fluxors, :force => true do |t|
+    t.integer :widget_id
+    t.string  :name
+  end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: airblade-paper_trail
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors: 
 - Andy Stewart
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-28 00:00:00 -07:00
+date: 2009-06-22 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -22,6 +22,7 @@ extensions: []
 extra_rdoc_files: 
 - README.md
 files: 
+- .gitignore
 - MIT-LICENSE
 - README.md
 - Rakefile