paper_trail 2.2.8 → 2.2.9

data/README.md

@@ -23,6 +23,7 @@ There's an excellent [Railscast on implementing Undo with Paper Trail](http://ra
 * No configuration necessary.
 * Stores everything in a single database table by default (generates migration for you), or can use separate tables for separate models.
 * Supports custom version classes so different models' versions can have different behaviour.
+* Supports custom name for versions association.
 * Thoroughly tested.
 * Threadsafe.
 
@@ -327,6 +328,17 @@ This allows you to store each model's versions in a separate table, which is use
 
 Alternatively you could store certain metadata for one type of version, and other metadata for other versions.
 
+You can also specify a custom name for the versions association.  This is useful if you already have a `versions` method on your model.  For example:
+
+    class Post < ActiveRecord::Base
+      has_paper_trail :versions_association_name => :paper_trail_versions
+
+      # Existing versions method.  We don't want to clash.
+      def versions
+        ...
+      end
+    end
+
 
 ## Associations
 

data/lib/paper_trail/has_paper_trail.rb

@@ -18,6 +18,7 @@ module PaperTrail
       #               Values are objects or procs (which are called with `self`, i.e. the model with the paper
       #               trail).  See `PaperTrail::Controller.info_for_paper_trail` for how to store data from
       #               the controller.
+      # :versions_association_name    the name to use for the versions association.  Default is `:versions`.
       def has_paper_trail(options = {})
         # Lazily include the instance methods so we don't clutter up
         # any more ActiveRecord models than we have to.
@@ -41,7 +42,13 @@ module PaperTrail
         cattr_accessor :paper_trail_enabled_for_model
         self.paper_trail_enabled_for_model = true
 
-        has_many :versions, :class_name => version_class_name, :as => :item, :order => "created_at ASC, #{self.primary_key} ASC"
+        cattr_accessor :versions_association_name
+        self.versions_association_name = options[:versions] || :versions
+
+        has_many self.versions_association_name,
+                 :class_name => version_class_name,
+                 :as         => :item,
+                 :order      => "created_at ASC, #{self.primary_key} ASC"
 
         after_create  :record_create
         before_update :record_update
@@ -77,13 +84,13 @@ module PaperTrail
       def version_at(timestamp, reify_options={})
         # Because a version stores how its object looked *before* the change,
         # we need to look for the first version created *after* the timestamp.
-        version = versions.after(timestamp).first
+        version = send(self.class.versions_association_name).after(timestamp).first
         version ? version.reify(reify_options) : self
       end
 
       # Returns the object (not a Version) as it was most recently.
       def previous_version
-        preceding_version = version ? version.previous : versions.last
+        preceding_version = version ? version.previous : send(self.class.versions_association_name).last
         preceding_version.try :reify
       end
 
@@ -103,7 +110,7 @@ module PaperTrail
 
       def record_create
         if switched_on?
-          versions.create merge_metadata(:event => 'create', :whodunnit => PaperTrail.whodunnit)
+          send(self.class.versions_association_name).create merge_metadata(:event => 'create', :whodunnit => PaperTrail.whodunnit)
         end
       end
 
@@ -114,13 +121,13 @@ module PaperTrail
             :object    => object_to_string(item_before_change),
             :whodunnit => PaperTrail.whodunnit
           }
-          if Version.method_defined? :object_changes
+          if version_class.column_names.include? 'object_changes'
             # The double negative (reject, !include?) preserves the hash structure of self.changes.
             data[:object_changes] = self.changes.reject do |key, value|
               !notably_changed.include?(key)
             end.to_yaml
           end
-          versions.build merge_metadata(data)
+          send(self.class.versions_association_name).build merge_metadata(data)
         end
       end
 
@@ -132,7 +139,7 @@ module PaperTrail
                                               :object    => object_to_string(item_before_change),
                                               :whodunnit => PaperTrail.whodunnit)
         end
-        versions.send :load_target
+        send(self.class.versions_association_name).send :load_target
       end
 
       def merge_metadata(data)

data/lib/paper_trail/version.rb

@@ -82,7 +82,7 @@ class Version < ActiveRecord::Base
   # Returns what changed in this version of the item.  Cf. `ActiveModel::Dirty#changes`.
   # Returns nil if your `versions` table does not have an `object_changes` text column.
   def changeset
-    if Version.method_defined?(:object_changes)
+    if self.class.column_names.include? 'object_changes'
       if changes = object_changes
         YAML::load(changes)
       else

data/lib/paper_trail/version_number.rb

@@ -1,3 +1,3 @@
 module PaperTrail
-  VERSION = '2.2.8'
+  VERSION = '2.2.9'
 end

data/test/dummy/app/models/document.rb

@@ -0,0 +1,3 @@
+class Document < ActiveRecord::Base
+  has_paper_trail :versions => :paper_trail_versions
+end

data/test/dummy/db/migrate/20110208155312_set_up_test_tables.rb

@@ -93,6 +93,10 @@ class SetUpTestTables < ActiveRecord::Migration
       t.string :name
       t.string :species   # single table inheritance column
     end
+
+    create_table :documents, :force => true do |t|
+      t.string :name
+    end
   end
 
   def self.down
@@ -110,5 +114,6 @@ class SetUpTestTables < ActiveRecord::Migration
     remove_index :versions, :column => [:item_type, :item_id]
     drop_table :versions
     drop_table :widgets
+    drop_table :documents
   end
 end

data/test/test_helper.rb

@@ -47,11 +47,3 @@ def change_schema
   end
   ActiveRecord::Migration.verbose = true
 end
-
-def remove_object_changes_column
-  ActiveRecord::Migration.verbose = false
-  ActiveRecord::Schema.define do
-    remove_column :versions, :object_changes
-  end
-  ActiveRecord::Migration.verbose = true
-end

data/test/unit/model_test.rb

@@ -109,12 +109,6 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
           assert_equal ({'name' => ['Henry', 'Harry']}), @widget.versions.last.changeset
         end
 
-        should "not have stored changes if object_changes column doesn't exist" do
-          remove_object_changes_column
-          Version.reset_column_information
-          assert_nil @widget.versions.last.changeset
-        end
-
         if defined?(ActiveRecord::IdentityMap) && ActiveRecord::IdentityMap.respond_to?(:without)
           should 'not clobber the IdentityMap when reifying' do
             module ActiveRecord::IdentityMap
@@ -786,6 +780,9 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
       setup { @post.update_attributes({ :content => "Some new content" }) }
       should_change('the number of post versions') { PostVersion.count }
       should_not_change('the number of versions') { Version.count }
+      should "not have stored changes when object_changes column doesn't exist" do
+        assert_nil @post.versions.last.changeset
+      end
     end
   end
 
@@ -815,6 +812,26 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
     end
   end
 
+  context 'A model with a custom association' do
+    setup do
+      @doc = Document.create
+      @doc.update_attributes :name => 'Doc 1'
+    end
+
+    should 'not respond to versions method' do
+      assert !@doc.respond_to?(:versions)
+    end
+
+    should 'create a new version record' do
+      assert_equal 2, @doc.paper_trail_versions.length
+    end
+
+    should 'respond to previous_version as normal' do
+      @doc.update_attributes :name => 'Doc 2'
+      assert_equal 3, @doc.paper_trail_versions.length
+      assert_equal 'Doc 1', @doc.previous_version.name
+    end
+  end
 
   private
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: paper_trail
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: false
   segments: 
   - 2
   - 2
-  - 8
-  version: 2.2.8
+  - 9
+  version: 2.2.9
 platform: ruby
 authors: 
 - Andy Stewart
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-14 00:00:00 +01:00
+date: 2011-07-23 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -128,6 +128,7 @@ files:
 - test/dummy/app/models/authorship.rb
 - test/dummy/app/models/book.rb
 - test/dummy/app/models/cat.rb
+- test/dummy/app/models/document.rb
 - test/dummy/app/models/dog.rb
 - test/dummy/app/models/fluxor.rb
 - test/dummy/app/models/foo_widget.rb
@@ -222,6 +223,7 @@ test_files:
 - test/dummy/app/models/authorship.rb
 - test/dummy/app/models/book.rb
 - test/dummy/app/models/cat.rb
+- test/dummy/app/models/document.rb
 - test/dummy/app/models/dog.rb
 - test/dummy/app/models/fluxor.rb
 - test/dummy/app/models/foo_widget.rb