paper_trail 3.0.0.rc1 → 3.0.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9bf681540718f57e237227b7237dd75588325471
-  data.tar.gz: 53ca44944999542128882287cfeb7a2a0c3957e6
+  metadata.gz: 0c33a2d2b003d082bede1ad845e1a4b158707782
+  data.tar.gz: 4e47a0a036926d20dca09f9cf22ab7c7c492dadd
 SHA512:
-  metadata.gz: 0c71e183ad7347c6d2a4202b8f4c5a00cfda6c8945a91edf325d5dbbde3c1458bee5e06cbf135deb3f33446038de435e51682d29b68b0aaf9fba77925c5e839b
-  data.tar.gz: 49fc4e1bc5e418bf1565749e8853f6516dc937fca663638da0a011dd47d6284dc53338cf479f6e8ad3ff74a7f53a93f168708108ce76a93c0474161c49d156d1
+  metadata.gz: ae06bb1637cea1664c1f75ede2ac0195cac6f44a490d2988921a71d5461ac8d65cd96171ddbe4ad8d273340c9cba21aed937fdf755bdd56438d96ee49e261deb
+  data.tar.gz: 63587c8419be2ed421ffee4019564b84f64ed1536f5e323437070aab0144e3216800f32698154f98193d383087a0cc2e7ed04f647ed451aa73da8c2a281fbd79

data/CHANGELOG.md

@@ -1,5 +1,7 @@
 ## 3.0.0 (Unreleased)
 
+  - [#295](https://github.com/airblade/paper_trail/issues/295) - Explicitly specify table name for version class when
+    querying attributes. Prevents `AmbiguousColumn` errors on certain `JOIN` statements.
   - [#289](https://github.com/airblade/paper_trail/pull/289) - Use `ActiveSupport::Concern` for implementation of base functionality on
     `PaperTrail::Version` class. Increases flexibility and makes it easier to use custom version classes with multiple `ActiveRecord` connections.
   - [#288](https://github.com/airblade/paper_trail/issues/288) - Change all scope declarations to class methods on the `PaperTrail::Version`

data/README.md

@@ -64,7 +64,7 @@ steps for setting up your app with `PaperTrail` will look something like this:
 
 1. Add `PaperTrail` to your `Gemfile`.
 
-    `gem 'paper_trail', '>= 3.0.0.beta1'`
+    `gem 'paper_trail', '>= 3.0.0.rc1'`
 
 2. Generate a migration to add a `versions` table to your database.
 

data/lib/paper_trail.rb

@@ -5,7 +5,6 @@ require 'paper_trail/cleaner'
 # Require serializers
 Dir[File.join(File.dirname(__FILE__), 'paper_trail', 'serializers', '*.rb')].each { |file| require file }
 
-# PaperTrail's module methods can be called in both models and controllers.
 module PaperTrail
   extend PaperTrail::Cleaner
 
@@ -20,18 +19,18 @@ module PaperTrail
     !!PaperTrail.config.enabled
   end
 
+  # Sets whether PaperTrail is enabled or disabled for the current request.
+  def self.enabled_for_controller=(value)
+    paper_trail_store[:request_enabled_for_controller] = value
+  end
+
   # Returns `true` if PaperTrail is enabled for the request, `false` otherwise.
   #
-  # See `PaperTrail::Controller#paper_trail_enabled_for_controller`.
+  # See `PaperTrail::Rails::Controller#paper_trail_enabled_for_controller`.
   def self.enabled_for_controller?
     !!paper_trail_store[:request_enabled_for_controller]
   end
 
-  # Sets whether PaperTrail is enabled or disabled for the current request.
-  def self.enabled_for_controller=(value)
-    paper_trail_store[:request_enabled_for_controller] = value
-  end
-
   # Set the field which records when a version was created.
   def self.timestamp_field=(field_name)
     PaperTrail.config.timestamp_field = field_name
@@ -42,11 +41,6 @@ module PaperTrail
     PaperTrail.config.timestamp_field
   end
 
-  # Returns who is reponsible for any changes that occur.
-  def self.whodunnit
-    paper_trail_store[:whodunnit]
-  end
-
   # Sets who is responsible for any changes that occur.
   # You would normally use this in a migration or on the console,
   # when working with models directly.  In a controller it is set
@@ -55,12 +49,9 @@ module PaperTrail
     paper_trail_store[:whodunnit] = value
   end
 
-  # Returns any information from the controller that you want
-  # PaperTrail to store.
-  #
-  # See `PaperTrail::Controller#info_for_paper_trail`.
-  def self.controller_info
-    paper_trail_store[:controller_info]
+  # Returns who is reponsible for any changes that occur.
+  def self.whodunnit
+    paper_trail_store[:whodunnit]
   end
 
   # Sets any information from the controller that you want PaperTrail
@@ -69,6 +60,14 @@ module PaperTrail
     paper_trail_store[:controller_info] = value
   end
 
+  # Returns any information from the controller that you want
+  # PaperTrail to store.
+  #
+  # See `PaperTrail::Rails::Controller#info_for_paper_trail`.
+  def self.controller_info
+    paper_trail_store[:controller_info]
+  end
+
   # Getter and Setter for PaperTrail Serializer
   def self.serializer=(value)
     PaperTrail.config.serializer = value
@@ -98,7 +97,6 @@ module PaperTrail
   def self.configure
     yield config
   end
-
 end
 
 # Ensure `ProtectedAttributes` gem gets required if it is available before the `Version` class gets loaded in

data/lib/paper_trail/frameworks/cucumber.rb

@@ -1,6 +1,7 @@
 # before hook for Cucumber
 before do
   ::PaperTrail.enabled = false
+  ::PaperTrail.enabled_for_controller = true
   ::PaperTrail.whodunnit = nil
   ::PaperTrail.controller_info = {} if defined? ::Rails
 end

data/lib/paper_trail/frameworks/rspec.rb

@@ -7,6 +7,7 @@ RSpec.configure do |config|
 
   config.before(:each) do
     ::PaperTrail.enabled = false
+    ::PaperTrail.enabled_for_controller = true
     ::PaperTrail.whodunnit = nil
     ::PaperTrail.controller_info = {} if defined?(::Rails) && defined?(::RSpec::Rails)
   end

data/lib/paper_trail/has_paper_trail.rb

@@ -5,7 +5,6 @@ module PaperTrail
       base.send :extend, ClassMethods
     end
 
-
     module ClassMethods
       # Declare this in your model to track every create, update, and destroy.  Each version of
       # the model is available in the `versions` association.
@@ -324,7 +323,7 @@ module PaperTrail
       end
 
       def paper_trail_switched_on?
-        PaperTrail.enabled? && PaperTrail.enabled_for_controller? && self.class.paper_trail_enabled_for_model
+        PaperTrail.enabled? && PaperTrail.enabled_for_controller? && self.paper_trail_enabled_for_model
       end
 
       def save_version?

data/lib/paper_trail/version.rb

@@ -35,17 +35,19 @@ module PaperTrail
       # These methods accept a timestamp or a version and returns other versions that come before or after
       def subsequent(obj)
         obj = obj.send(PaperTrail.timestamp_field) if obj.is_a?(self)
-        where("#{PaperTrail.timestamp_field} > ?", obj).order("#{PaperTrail.timestamp_field} ASC")
+        where("#{table_name}.#{PaperTrail.timestamp_field} > ?", obj).
+          order("#{table_name}.#{PaperTrail.timestamp_field} ASC")
       end
 
       def preceding(obj)
         obj = obj.send(PaperTrail.timestamp_field) if obj.is_a?(self)
-        where("#{PaperTrail.timestamp_field} < ?", obj).order("#{PaperTrail.timestamp_field} DESC")
+        where("#{table_name}.#{PaperTrail.timestamp_field} < ?", obj).
+          order("#{table_name}.#{PaperTrail.timestamp_field} DESC")
       end
 
       def between(start_time, end_time)
-        where("#{PaperTrail.timestamp_field} > ? AND #{PaperTrail.timestamp_field} < ?", start_time, end_time).
-          order("#{PaperTrail.timestamp_field} ASC")
+        where("#{table_name}.#{PaperTrail.timestamp_field} > ? AND #{table_name}.#{PaperTrail.timestamp_field} < ?",
+          start_time, end_time).order("#{table_name}.#{PaperTrail.timestamp_field} ASC")
       end
 
       # Returns whether the `object` column is using the `json` type supported by PostgreSQL
@@ -71,56 +73,56 @@ module PaperTrail
     #              set to a float to change the lookback time (check whether your db supports
     #              sub-second datetimes if you want them).
     def reify(options = {})
+      return nil if object.nil?
+
       without_identity_map do
         options[:has_one] = 3 if options[:has_one] == true
         options.reverse_merge! :has_one => false
 
-        unless object.nil?
-          attrs = self.class.object_col_is_json? ? object : PaperTrail.serializer.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
-            # Look for attributes that exist in the model and not in this version. These attributes should be set to nil.
-            (model.attribute_names - attrs.keys).each { |k| attrs[k] = nil }
-          else
-            inheritance_column_name = item_type.constantize.inheritance_column
-            class_name = attrs[inheritance_column_name].blank? ? item_type : attrs[inheritance_column_name]
-            klass = class_name.constantize
-            model = klass.new
-          end
+        attrs = self.class.object_col_is_json? ? object : PaperTrail.serializer.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
+          # Look for attributes that exist in the model and not in this version. These attributes should be set to nil.
+          (model.attribute_names - attrs.keys).each { |k| attrs[k] = nil }
+        else
+          inheritance_column_name = item_type.constantize.inheritance_column
+          class_name = attrs[inheritance_column_name].blank? ? item_type : attrs[inheritance_column_name]
+          klass = class_name.constantize
+          model = klass.new
+        end
 
-          model.class.unserialize_attributes_for_paper_trail attrs
+        model.class.unserialize_attributes_for_paper_trail attrs
 
-          # Set all the attributes in this version on the model
-          attrs.each do |k, v|
-            if model.respond_to?("#{k}=")
-              model[k.to_sym] = v
-            else
-              logger.warn "Attribute #{k} does not exist on #{item_type} (Version id: #{id})."
-            end
+        # Set all the attributes in this version on the model
+        attrs.each do |k, v|
+          if model.respond_to?("#{k}=")
+            model[k.to_sym] = v
+          else
+            logger.warn "Attribute #{k} does not exist on #{item_type} (Version id: #{id})."
           end
+        end
 
-          model.send "#{model.class.version_association_name}=", self
+        model.send "#{model.class.version_association_name}=", self
 
-          unless options[:has_one] == false
-            reify_has_ones model, options[:has_one]
-          end
-
-          model
+        unless options[:has_one] == false
+          reify_has_ones model, options[:has_one]
         end
+
+        model
       end
     end
 
@@ -163,8 +165,10 @@ module PaperTrail
     end
 
     def index
-      @index ||= sibling_versions.select([PaperTrail.timestamp_field, self.class.primary_key.to_sym]).
-        order("#{PaperTrail.timestamp_field} ASC").index(self)
+      table_name = self.class.table_name
+      @index ||= sibling_versions.
+        select(["#{table_name}.#{PaperTrail.timestamp_field}", "#{table_name}.#{self.class.primary_key}"]).
+        order("#{table_name}.#{PaperTrail.timestamp_field} ASC").index(self)
     end
 
     private

data/lib/paper_trail/version_number.rb

@@ -1,3 +1,3 @@
 module PaperTrail
-  VERSION = '3.0.0.rc1'
+  VERSION = '3.0.0.rc2'
 end

data/paper_trail.gemspec

@@ -5,11 +5,11 @@ Gem::Specification.new do |s|
   s.name          = 'paper_trail'
   s.version       = PaperTrail::VERSION
   s.platform      = Gem::Platform::RUBY
-  s.summary       = "Track changes to your models' data.  Good for auditing or versioning."
+  s.summary       = "Track changes to your models' data. Good for auditing or versioning."
   s.description   = s.summary
   s.homepage      = 'http://github.com/airblade/paper_trail'
   s.authors       = ['Andy Stewart', 'Ben Atkins']
-  s.email         = 'boss@airbladesoftware.com'
+  s.email         = 'batkinz@gmail.com'
   s.license       = 'MIT'
 
   s.files         = `git ls-files`.split("\n")
@@ -22,6 +22,7 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'rake'
   s.add_development_dependency 'shoulda', '~> 3.5'
+  # s.add_development_dependency 'shoulda-matchers', '~> 1.5' # needed for ActiveRecord < 4
   s.add_development_dependency 'ffaker',  '>= 1.15'
   s.add_development_dependency 'railties', ['>= 3.0', '< 5.0']
   s.add_development_dependency 'sinatra', '~> 1.0'

data/spec/models/joined_version_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe JoinedVersion, :versioning => true do
+  it { JoinedVersion.superclass.should == PaperTrail::Version }
+
+  let(:widget) { Widget.create!(:name => Faker::Name.name) }
+  let(:version) { JoinedVersion.first }
+
+  describe "Scopes" do
+    describe "default_scope" do
+      it { JoinedVersion.default_scopes.should_not be_empty }
+    end
+
+    describe "VersionConcern::ClassMethods" do
+      before { widget } # persist a widget
+
+      describe :subsequent do
+        it "shouldn't error out when there is a default_scope that joins" do
+          JoinedVersion.subsequent(version).first
+        end
+      end
+
+      describe :preceding do
+        it "shouldn't error out when there is a default scope that joins" do
+          JoinedVersion.preceding(version).first
+        end
+      end
+
+      describe :between do
+        it "shouldn't error out when there is a default scope that joins" do
+          JoinedVersion.between(Time.now, 1.minute.from_now).first
+        end
+      end
+    end
+  end
+
+  describe "Methods" do
+    describe :index do
+      it { should respond_to(:index) }
+
+      it "shouldn't error out when there is a default scope that joins" do
+        widget # persist a widget
+        version.index
+      end
+    end
+  end
+end

data/spec/models/version_spec.rb

@@ -33,7 +33,7 @@ describe PaperTrail::Version do
       end
 
       describe :version_author do
-        it { should respond_to(:terminator) }
+        it { should respond_to(:version_author) }
 
         it "should be an alias for the `terminator` method" do
           subject.method(:version_author).should == subject.method(:terminator)

data/spec/requests/articles_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe "Articles" do
+  let(:valid_params) { { :article => { :title => 'Doh', :content => Faker::Lorem.sentence } } }
+
+  context "versioning disabled" do
+    specify { PaperTrail.enabled?.should be_false }
+
+    it "should not create a version" do
+      expect { post articles_path(valid_params) }.to_not change(PaperTrail::Version, :count)
+    end
+
+    it "should not leak the state of the `PaperTrail.enabled_for_controlller?` into the next test" do
+      PaperTrail.enabled_for_controller?.should be_true
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -39,5 +39,5 @@ RSpec.configure do |config|
   # order dependency and want to debug it, you can fix the order by providing
   # the seed, which is printed after each run.
   #     --seed 1234
-  config.order = 'random'
+  # config.order = 'random'
 end

data/test/dummy/app/versions/joined_version.rb

@@ -0,0 +1,5 @@
+# The purpose of this custom version class is to test the scope methods on the VersionConcern::ClassMethods
+# module. See https://github.com/airblade/paper_trail/issues/295 for more details.
+class JoinedVersion < PaperTrail::Version
+  default_scope { joins('INNER JOIN widgets ON widgets.id = versions.item_id') }
+end

data/test/dummy/config/routes.rb

@@ -1,4 +1,4 @@
 Dummy::Application.routes.draw do
   resources :articles, :only => [:create]
-  resources :widgets
+  resources :widgets, :only => [:create, :update, :destroy]
 end

data/test/unit/version_test.rb

@@ -62,7 +62,7 @@ class PaperTrail::VersionTest < ActiveSupport::TestCase
       should "return all versions that were created before the Timestamp; descendingly by order of the `PaperTrail.timestamp_field`" do
         value = PaperTrail::Version.subsequent(1.hour.ago)
         assert_equal value, @animal.versions.to_a
-        assert_not_nil value.to_sql.match(/ORDER BY created_at ASC\z/)
+        assert_not_nil value.to_sql.match(/ORDER BY versions.created_at ASC\z/)
       end
     end
 
@@ -72,7 +72,7 @@ class PaperTrail::VersionTest < ActiveSupport::TestCase
         assert_equal value, @animal.versions.to_a.tap { |assoc| assoc.shift }
         # This asssertion can't pass in Ruby18 because the `strftime` method doesn't accept the %6 (milliseconds) command
         if RUBY_VERSION.to_f >= 1.9 and not defined?(JRUBY_VERSION)
-          assert_not_nil value.to_sql.match(/WHERE \(created_at > '#{@animal.versions.first.send(PaperTrail.timestamp_field).strftime("%F %T.%6N")}'\)/)
+          assert_not_nil value.to_sql.match(/WHERE \(versions.created_at > '#{@animal.versions.first.send(PaperTrail.timestamp_field).strftime("%F %T.%6N")}'\)/)
         end
       end
     end
@@ -85,7 +85,7 @@ class PaperTrail::VersionTest < ActiveSupport::TestCase
       should "return all versions that were created before the Timestamp; descendingly by order of the `PaperTrail.timestamp_field`" do
         value = PaperTrail::Version.preceding(Time.now)
         assert_equal value, @animal.versions.reverse
-        assert_not_nil value.to_sql.match(/ORDER BY created_at DESC\z/)
+        assert_not_nil value.to_sql.match(/ORDER BY versions.created_at DESC\z/)
       end
     end
 
@@ -95,7 +95,7 @@ class PaperTrail::VersionTest < ActiveSupport::TestCase
         assert_equal value, @animal.versions.to_a.tap { |assoc| assoc.pop }.reverse
         # This asssertion can't pass in Ruby18 because the `strftime` method doesn't accept the %6 (milliseconds) command
         if RUBY_VERSION.to_f >= 1.9 and not defined?(JRUBY_VERSION)
-          assert_not_nil value.to_sql.match(/WHERE \(created_at < '#{@animal.versions.last.send(PaperTrail.timestamp_field).strftime("%F %T.%6N")}'\)/)
+          assert_not_nil value.to_sql.match(/WHERE \(versions.created_at < '#{@animal.versions.last.send(PaperTrail.timestamp_field).strftime("%F %T.%6N")}'\)/)
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paper_trail
 version: !ruby/object:Gem::Version
-  version: 3.0.0.rc1
+  version: 3.0.0.rc2
 platform: ruby
 authors:
 - Andy Stewart
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-29 00:00:00.000000000 Z
+date: 2013-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -169,8 +169,8 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.2'
-description: Track changes to your models' data.  Good for auditing or versioning.
-email: boss@airbladesoftware.com
+description: Track changes to your models' data. Good for auditing or versioning.
+email: batkinz@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -202,10 +202,12 @@ files:
 - lib/paper_trail/version.rb
 - lib/paper_trail/version_number.rb
 - paper_trail.gemspec
+- spec/models/joined_version_spec.rb
 - spec/models/version_spec.rb
 - spec/models/widget_spec.rb
 - spec/modules/version_concern_spec.rb
 - spec/paper_trail_spec.rb
+- spec/requests/articles_spec.rb
 - spec/spec_helper.rb
 - test/custom_json_serializer.rb
 - test/dummy/Rakefile
@@ -232,6 +234,7 @@ files:
 - test/dummy/app/models/translation.rb
 - test/dummy/app/models/widget.rb
 - test/dummy/app/models/wotsit.rb
+- test/dummy/app/versions/joined_version.rb
 - test/dummy/app/versions/post_version.rb
 - test/dummy/app/views/layouts/application.html.erb
 - test/dummy/config.ru
@@ -305,12 +308,14 @@ rubyforge_project:
 rubygems_version: 2.1.10
 signing_key: 
 specification_version: 4
-summary: Track changes to your models' data.  Good for auditing or versioning.
+summary: Track changes to your models' data. Good for auditing or versioning.
 test_files:
+- spec/models/joined_version_spec.rb
 - spec/models/version_spec.rb
 - spec/models/widget_spec.rb
 - spec/modules/version_concern_spec.rb
 - spec/paper_trail_spec.rb
+- spec/requests/articles_spec.rb
 - spec/spec_helper.rb
 - test/custom_json_serializer.rb
 - test/dummy/Rakefile
@@ -337,6 +342,7 @@ test_files:
 - test/dummy/app/models/translation.rb
 - test/dummy/app/models/widget.rb
 - test/dummy/app/models/wotsit.rb
+- test/dummy/app/versions/joined_version.rb
 - test/dummy/app/versions/post_version.rb
 - test/dummy/app/views/layouts/application.html.erb
 - test/dummy/config.ru