paper_trail 2.3.2 → 2.3.3

data/README.md

@@ -42,10 +42,11 @@ When you declare `has_paper_trail` in your model, you get these methods:
       has_paper_trail   # you can pass various options here
     end
 
-    # Returns this widget's versions.
+    # Returns this widget's versions.  You can customise the name of the association.
     widget.versions
 
     # Return the version this widget was reified from, or nil if it is live.
+    # You can customise the name of the method.
     widget.version
 
     # Returns true if this widget is the current, live one; or false if it is from a previous version.
@@ -649,6 +650,7 @@ Many thanks to:
 * [nir0](https://github.com/nir0)
 * [Eduard Tsech](https://github.com/edtsech)
 * [Mathieu Arnold](https://github.com/mat813)
+* [Nicholas Thrower](https://github.com/throwern)
 
 
 ## Inspirations

data/lib/paper_trail/has_paper_trail.rb

@@ -21,13 +21,18 @@ module PaperTrail
       #               trail).  See `PaperTrail::Controller.info_for_paper_trail` for how to store data from
       #               the controller.
       # :versions     the name to use for the versions association.  Default is `:versions`.
+      # :version_name the name to use for the method which returns the version the instance was reified from.
+      #               Default is `:version`.
       def has_paper_trail(options = {})
         # Lazily include the instance methods so we don't clutter up
         # any more ActiveRecord models than we have to.
         send :include, InstanceMethods
 
+        class_attribute :version_name
+        self.version_name = options[:version_name] || 'version'
+
         # The version this instance was reified from.
-        attr_accessor :version
+        attr_accessor self.version_name
 
         class_attribute :version_class_name
         self.version_class_name = options[:class_name] || 'Version'
@@ -74,7 +79,7 @@ module PaperTrail
       # Returns true if this instance is the current, live one;
       # returns false if this instance came from a previous version.
       def live?
-        version.nil?
+        source_version.nil?
       end
 
       # Returns who put the object into its current state.
@@ -86,13 +91,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 = send(self.class.versions_association_name).after(timestamp).first
-        version ? version.reify(reify_options) : self
+        v = send(self.class.versions_association_name).after(timestamp).first
+        v ? v.reify(reify_options) : self
       end
 
       # Returns the object (not a Version) as it was most recently.
       def previous_version
-        preceding_version = version ? version.previous : send(self.class.versions_association_name).last
+        preceding_version = source_version ? source_version.previous : send(self.class.versions_association_name).last
         preceding_version.try :reify
       end
 
@@ -100,7 +105,7 @@ module PaperTrail
       def next_version
         # NOTE: if self (the item) was not reified from a version, i.e. it is the
         # "live" item, we return nil.  Perhaps we should return self instead?
-        subsequent_version = version ? version.next : nil
+        subsequent_version = source_version ? source_version.next : nil
         subsequent_version.reify if subsequent_version
       end
 
@@ -119,6 +124,10 @@ module PaperTrail
         version_class_name.constantize
       end
 
+      def source_version
+        send self.class.version_name
+      end
+
       def record_create
         if switched_on?
           send(self.class.versions_association_name).create merge_metadata(:event => 'create', :whodunnit => PaperTrail.whodunnit)

data/lib/paper_trail/version.rb

@@ -68,7 +68,7 @@ class Version < ActiveRecord::Base
           end
         end
 
-        model.version = self
+        model.send "#{model.class.version_name}=", self
 
         unless options[:has_one] == false
           reify_has_ones model, options[:has_one]

data/lib/paper_trail/version_number.rb

@@ -1,3 +1,3 @@
 module PaperTrail
-  VERSION = '2.3.2'
+  VERSION = '2.3.3'
 end

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

@@ -0,0 +1,3 @@
+class LegacyWidget < ActiveRecord::Base
+  has_paper_trail :version_name => 'custom_version'
+end

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

@@ -97,6 +97,12 @@ class SetUpTestTables < ActiveRecord::Migration
     create_table :documents, :force => true do |t|
       t.string :name
     end
+    
+    create_table :legacy_widgets, :force => true do |t|
+      t.string    :name
+      t.integer   :version
+    end
+  
   end
 
   def self.down
@@ -115,5 +121,6 @@ class SetUpTestTables < ActiveRecord::Migration
     drop_table :versions
     drop_table :widgets
     drop_table :documents
+    drop_table :legacy_widgets
   end
 end

data/test/unit/model_test.rb

@@ -912,6 +912,42 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
     end
   end
 
+  context 'A model with column version and custom version_method' do
+    setup do
+      @legacy_widget = LegacyWidget.create(:name => "foo", :version => 2)
+    end
+
+    should 'set version on create' do
+      assert_equal 2, @legacy_widget.version
+    end
+
+    should 'allow version updates' do
+      @legacy_widget.update_attributes :version => 3
+      assert_equal 3, @legacy_widget.version
+    end
+
+    should 'create a new version record' do
+      assert_equal 1, @legacy_widget.versions.size
+    end
+  end
+
+  context 'A reified item with a column -version- and custom version_method' do
+    setup do
+      widget = LegacyWidget.create(:name => "foo", :version => 2)
+      %w( bar baz ).each { |name| widget.update_attributes :name => name }
+      @version = widget.versions.last
+      @widget = @version.reify
+    end
+
+    should 'know which version it came from' do
+      assert_equal @version, @widget.custom_version
+    end
+
+    should 'return its previous self' do
+      assert_equal @widget.versions[-2].reify, @widget.previous_version
+    end
+  end
+
   private
 
   # Updates `model`'s last version so it looks like the version was

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: paper_trail
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 5
   prerelease: false
   segments: 
   - 2
   - 3
-  - 2
-  version: 2.3.2
+  - 3
+  version: 2.3.3
 platform: ruby
 authors: 
 - Andy Stewart
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-31 00:00:00 +02:00
+date: 2011-09-14 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -134,6 +134,7 @@ files:
 - test/dummy/app/models/elephant.rb
 - test/dummy/app/models/fluxor.rb
 - test/dummy/app/models/foo_widget.rb
+- test/dummy/app/models/legacy_widget.rb
 - test/dummy/app/models/person.rb
 - test/dummy/app/models/post.rb
 - test/dummy/app/models/song.rb
@@ -230,6 +231,7 @@ test_files:
 - test/dummy/app/models/elephant.rb
 - test/dummy/app/models/fluxor.rb
 - test/dummy/app/models/foo_widget.rb
+- test/dummy/app/models/legacy_widget.rb
 - test/dummy/app/models/person.rb
 - test/dummy/app/models/post.rb
 - test/dummy/app/models/song.rb