paper_trail 2.4.1 → 2.5.0

data/README.md

@@ -335,28 +335,33 @@ To find out who made a `version`'s object look that way, use `version.originator
 
 You can specify custom version subclasses with the `:class_name` option:
 
-    class Post < ActiveRecord::Base
-      has_paper_trail :class_name => 'PostVersion'
-    end
-
     class PostVersion < Version
       # custom behaviour, e.g:
       set_table_name :post_versions
     end
 
+    class Post < ActiveRecord::Base
+      has_paper_trail :class_name => 'PostVersion'
+    end
+
 This allows you to store each model's versions in a separate table, which is useful if you have a lot of versions being created.
 
 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:
+You can also specify custom names for the versions and version associations.  This is useful if you already have `versions` or/and `version` methods on your model.  For example:
 
     class Post < ActiveRecord::Base
-      has_paper_trail :versions => :paper_trail_versions
+      has_paper_trail :versions => :paper_trail_versions,
+                      :version  => :paper_trail_version
 
       # Existing versions method.  We don't want to clash.
       def versions
         ...
       end
+      # Existing version method.  We don't want to clash.
+      def version
+        ...
+      end
     end
 
 
@@ -633,6 +638,17 @@ Please see the `rails2` branch.
 
 PaperTrail uses Bundler to manage its dependencies (in development and testing).  You can run the tests with `bundle exec rake test`.  (You may need to `bundle install` first.)
 
+It's a good idea to reset PaperTrail before each test so data from one test doesn't spill over another.  For example:
+
+    RSpec.configure do |config|
+      config.before :each do
+        PaperTrail.controller_info = {}
+        PaperTrail.whodunnit = nil
+      end
+    end
+
+You may want to turn PaperTrail off to speed up your tests.  See the "Turning PaperTrail Off/On" section above.
+
 
 ## Articles
 
@@ -672,6 +688,7 @@ Many thanks to:
 * [Mathieu Arnold](https://github.com/mat813)
 * [Nicholas Thrower](https://github.com/throwern)
 * [Benjamin Curtis](https://github.com/stympy)
+* [Peter Harkins](https://github.com/pushcx)
 
 
 ## Inspirations

data/lib/paper_trail/has_paper_trail.rb

@@ -24,18 +24,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.
+      # :version      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'
+        class_attribute :version_association_name
+        self.version_association_name = options[:version] || :version
 
         # The version this instance was reified from.
-        attr_accessor self.version_name
+        attr_accessor self.version_association_name
 
         class_attribute :version_class_name
         self.version_class_name = options[:class_name] || 'Version'
@@ -131,7 +131,7 @@ module PaperTrail
       end
 
       def source_version
-        send self.class.version_name
+        send self.class.version_association_name
       end
 
       def record_create

data/lib/paper_trail/version.rb

@@ -69,7 +69,7 @@ class Version < ActiveRecord::Base
           end
         end
 
-        model.send "#{model.class.version_name}=", self
+        model.send "#{model.class.version_association_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.4.1'
+  VERSION = '2.5.0'
 end

data/paper_trail.gemspec

@@ -17,6 +17,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'rails', '~> 3'
 
+  s.add_development_dependency 'rake'
   s.add_development_dependency 'shoulda',      '2.10.3'
   s.add_development_dependency 'sqlite3-ruby', '~> 1.2'
   s.add_development_dependency 'capybara',     '>= 0.4.0'

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

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

data/test/unit/model_test.rb

@@ -2,7 +2,7 @@ require 'test_helper'
 
 class HasPaperTrailModelTest < ActiveSupport::TestCase
 
-  context 'A record' do
+  context 'A record with defined "only" and "ignore" attributes' do
     setup { @article = Article.create }
 
     context 'which updates an ignored column' do
@@ -28,12 +28,12 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
       setup { @article.update_attributes :abstract => 'Other abstract'}
       should_not_change('the number of versions') { Version.count }
     end
-    
+
     context 'which updates a skipped column' do
       setup { @article.update_attributes :file_upload => 'Your data goes here' }
       should_not_change('the number of versions') { Version.count }
     end
-    
+
     context 'which updates a skipped column and a selected column' do
       setup { @article.update_attributes :file_upload => 'Your data goes here', :content => 'Some text here.' }
       should_change('the number of versions', :by => 1) { Version.count }
@@ -41,23 +41,31 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
       should 'have stored only non-skipped attributes' do
         assert_equal ({'content' => [nil, 'Some text here.']}), @article.versions.last.changeset
       end
-      
+
       context 'and when updated again' do
         setup do
           @article.update_attributes :file_upload => 'More data goes here', :content => 'More text here.'
           @old_article = @article.versions.last
         end
-        
+
         should 'have removed the skipped attributes when saving the previous version' do
           assert_equal nil, YAML::load(@old_article.object)['file_upload']
         end
-        
+
         should 'have kept the non-skipped attributes in the previous version' do
           assert_equal 'Some text here.', YAML::load(@old_article.object)['content']
         end
       end
     end
-    
+  end
+
+  context 'A record with defined "ignore" attribute' do
+    setup { @legacy_widget = LegacyWidget.create }
+
+    context 'which updates an ignored column' do
+      setup { @legacy_widget.update_attributes :version => 1 }
+      should_not_change('the number of versions') { Version.count }
+    end
   end
 
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: paper_trail
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 2
-  - 4
-  - 1
-  version: 2.4.1
+  - 5
+  - 0
+  version: 2.5.0
 platform: ruby
 authors: 
 - Andy Stewart
@@ -15,13 +15,13 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-09 00:00:00 +01:00
+date: 2011-11-11 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rails
   prerelease: false
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -31,11 +31,25 @@ dependencies:
         - 3
         version: "3"
   type: :runtime
-  requirement: *id001
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: shoulda
   prerelease: false
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -47,11 +61,11 @@ dependencies:
         - 3
         version: 2.10.3
   type: :development
-  requirement: *id002
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: sqlite3-ruby
   prerelease: false
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -62,11 +76,11 @@ dependencies:
         - 2
         version: "1.2"
   type: :development
-  requirement: *id003
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: capybara
   prerelease: false
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -78,11 +92,11 @@ dependencies:
         - 0
         version: 0.4.0
   type: :development
-  requirement: *id004
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: turn
   prerelease: false
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -92,7 +106,7 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  requirement: *id005
+  version_requirements: *id006
 description: Track changes to your models' data.  Good for auditing or versioning.
 email: boss@airbladesoftware.com
 executables: []