paper_trail 6.0.1 → 6.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e2aaa66f683707d78b3d5c9a294e01c9e9b16813
-  data.tar.gz: f9e5043fea515093cd21d151eda33e7b915de194
+  metadata.gz: c23b36829183d413cfe6fa50f86b50dc5d5dd99a
+  data.tar.gz: c1964749e5fb1f1d23d8d066558d8d61323a6b73
 SHA512:
-  metadata.gz: ac92887f5f16f868f7f5936e9e9c6353533c3a9f233989ae075d3cb1550a3c4bc9b51b6523dc22899e695b2bbfded7f3a9ed4a7bbd814fe9e9c4ec15eabea30b
-  data.tar.gz: 8b31ac54123aeba74eb156b5d6971c3a579e3a3cae0ee8e2b55c2c824c018e8e0267f616fb92aa09ebec1a2404b93e57e2ffe8ad4c9554a9509c4ea4d38e142f
+  metadata.gz: 31692c33ac64c0322c894038b1a75c50ba5231a42ba7ebfa08a08517b721d0a08eba2e2e821566586da4a7bca7c7da92b7f74aee257bc5c698dbe8e8284a42dd
+  data.tar.gz: 0fe50a103b744687e0e2acd02dbb24c5f32f82c0255a356e89f2a66a1c5bd4bd0b688ac7eb8394cb34fb08b856780cc8e55b53be6afbaea7f6f99c24cfc5d408

data/.github/CONTRIBUTING.md

@@ -18,7 +18,9 @@ Please use our [bug report template][1].
 
 ## Development
 
-Install gems with `bundle exec appraisal install`.
+Install gems with `bundle exec appraisal install`. This requires ruby >= 2.0.
+(It is still possible to run the `ar-4.2` gemfile locally on ruby 1.9.3, but
+not the `ar-5.0` gemfile.)
 
 Testing is a little awkward because the test suite:
 
@@ -26,43 +28,73 @@ Testing is a little awkward because the test suite:
 1. Contains a "dummy" rails app with three databases (test, foo, and bar)
 1. Supports three different RDBMS': sqlite, mysql, and postgres
 
-### Run tests with sqlite
+### Test sqlite, AR 4.2
 
 ```
 # Create the appropriate database config. file
 rm test/dummy/config/database.yml
 DB=sqlite bundle exec rake prepare
 
-# If this is the first test run ever, create databases
+# If this is the first test run ever, create databases.
+# We can't use `appraisal` inside the test dummy, so we must set `BUNDLE_GEMFILE`.
+# See test/dummy/config/boot.rb for a complete explanation.
 cd test/dummy
+export BUNDLE_GEMFILE=../../gemfiles/ar_4.2.gemfile
 RAILS_ENV=test bundle exec rake db:setup
 RAILS_ENV=foo bundle exec rake db:setup
 RAILS_ENV=bar bundle exec rake db:setup
+unset BUNDLE_GEMFILE
+cd ../..
+
+# Run tests
+DB=sqlite bundle exec appraisal ar-4.2 rake
+```
+
+### Test sqlite, AR 5
+
+```
+# Create the appropriate database config. file
+rm test/dummy/config/database.yml
+DB=sqlite bundle exec rake prepare
+
+# If this is the first test run ever, create databases.
+# We can't use `appraisal` inside the test dummy, so we must set `BUNDLE_GEMFILE`.
+# See test/dummy/config/boot.rb for a complete explanation.
+cd test/dummy
+export BUNDLE_GEMFILE=../../gemfiles/ar_5.0.gemfile
+RAILS_ENV=test bundle exec rake db:environment:set db:setup
+RAILS_ENV=foo bundle exec rake db:environment:set db:setup
+RAILS_ENV=bar bundle exec rake db:environment:set db:setup
+unset BUNDLE_GEMFILE
 cd ../..
 
 # Run tests
 DB=sqlite bundle exec appraisal ar-5.0 rake
 ```
 
-### Run tests with mysql
+### Test mysql, AR 5
 
 ```
 # Create the appropriate database config. file
 rm test/dummy/config/database.yml
 DB=mysql bundle exec rake prepare
 
-# If this is the first test run ever, create databases
+# If this is the first test run ever, create databases.
+# We can't use `appraisal` inside the test dummy, so we must set `BUNDLE_GEMFILE`.
+# See test/dummy/config/boot.rb for a complete explanation.
 cd test/dummy
-RAILS_ENV=test bundle exec rake db:setup
-RAILS_ENV=foo bundle exec rake db:setup
-RAILS_ENV=bar bundle exec rake db:setup
+export BUNDLE_GEMFILE=../../gemfiles/ar_5.0.gemfile
+RAILS_ENV=test bundle exec rake db:environment:set db:setup
+RAILS_ENV=foo bundle exec rake db:environment:set db:setup
+RAILS_ENV=bar bundle exec rake db:environment:set db:setup
+unset BUNDLE_GEMFILE
 cd ../..
 
 # Run tests
 DB=mysql bundle exec appraisal ar-5.0 rake
 ```
 
-### Run tests with postgres
+### Test postgres, AR 5
 
 ```
 # Create the appropriate database config. file
@@ -71,10 +103,14 @@ DB=postgres bundle exec rake prepare
 
 # If this is the first test run ever, create databases.
 # Unlike mysql, use create/migrate instead of setup.
+# We can't use `appraisal` inside the test dummy, so we must set `BUNDLE_GEMFILE`.
+# See test/dummy/config/boot.rb for a complete explanation.
 cd test/dummy
+export BUNDLE_GEMFILE=../../gemfiles/ar_5.0.gemfile
 DB=postgres RAILS_ENV=test bundle exec rake db:drop db:create db:migrate
 DB=postgres RAILS_ENV=foo bundle exec rake db:drop db:create db:migrate
 DB=postgres RAILS_ENV=bar bundle exec rake db:drop db:create db:migrate
+unset BUNDLE_GEMFILE
 cd ../..
 
 # Run tests

data/.rubocop_todo.yml

@@ -2,13 +2,13 @@
 # one by one as the offenses are removed from the code base.
 
 Metrics/AbcSize:
-  Max: 30 # Goal: 15
+  Max: 22 # Goal: 15
 
 Metrics/CyclomaticComplexity:
   Max: 8 # Goal: 6
 
 Metrics/PerceivedComplexity:
-  Max: 10 # Goal: 7
+  Max: 9 # Goal: 7
 
 Style/FrozenStringLiteralComment:
   Enabled: false

data/CHANGELOG.md

@@ -17,6 +17,28 @@ recommendations of [keepachangelog.com](http://keepachangelog.com/).
 
 - None
 
+## 6.0.2 (2016-12-13)
+
+### Breaking Changes
+
+- None
+
+### Added
+
+- None
+
+### Fixed
+
+- `88e513f` - Surprise argument modification bug in `where_object_changes`
+- `c7efd62` - Column type-detection bug in `where_object_changes`
+- [#905](https://github.com/airblade/paper_trail/pull/905) - Only invoke
+  `logger.warn` if `logger` instance exists
+
+### Code Quality
+
+- Improve Metrics/AbcSize from 30 to 22
+- Improve Metrics/PerceivedComplexity from 10 to 9
+
 ## 6.0.1 (2016-12-04)
 
 ### Breaking Changes

data/README.md

@@ -11,7 +11,7 @@ has been destroyed.
 | Version        | Documentation |
 | -------------- | ------------- |
 | Unreleased     | https://github.com/airblade/paper_trail/blob/master/README.md |
-| 6.0.1          | https://github.com/airblade/paper_trail/blob/v6.0.1/README.md |
+| 6.0.2          | https://github.com/airblade/paper_trail/blob/v6.0.2/README.md |
 | 5.2.3          | https://github.com/airblade/paper_trail/blob/v5.2.3/README.md |
 | 4.2.0          | https://github.com/airblade/paper_trail/blob/v4.2.0/README.md |
 | 3.0.9          | https://github.com/airblade/paper_trail/blob/v3.0.9/README.md |

data/lib/paper_trail/model_config.rb

@@ -124,22 +124,12 @@ module PaperTrail
 
       @model_class.send :attr_accessor, :paper_trail_event
 
-      # In rails 4, the `has_many` syntax for specifying order uses a lambda.
-      if ::ActiveRecord::VERSION::MAJOR >= 4
-        @model_class.has_many(
-          @model_class.versions_association_name,
-          -> { order(model.timestamp_sort_order) },
-          class_name: @model_class.version_class_name,
-          as: :item
-        )
-      else
-        @model_class.has_many(
-          @model_class.versions_association_name,
-          class_name: @model_class.version_class_name,
-          as: :item,
-          order: @model_class.paper_trail.version_class.timestamp_sort_order
-        )
-      end
+      @model_class.has_many(
+        @model_class.versions_association_name,
+        -> { order(model.timestamp_sort_order) },
+        class_name: @model_class.version_class_name,
+        as: :item
+      )
     end
 
     # Adds callbacks to record changes to habtm associations such that on save

data/lib/paper_trail/queries/versions/where_object.rb

@@ -0,0 +1,60 @@
+module PaperTrail
+  module Queries
+    module Versions
+      # For public API documentation, see `where_object` in
+      # `paper_trail/version_concern.rb`.
+      # @api private
+      class WhereObject
+        # - version_model_class - The class that VersionConcern was mixed into.
+        # - attributes - A `Hash` of attributes and values. See the public API
+        #   documentation for details.
+        # @api private
+        def initialize(version_model_class, attributes)
+          @version_model_class = version_model_class
+          @attributes = attributes
+        end
+
+        # @api private
+        def execute
+          case @version_model_class.columns_hash["object"].type
+          when :jsonb
+            jsonb
+          when :json
+            json
+          else
+            text
+          end
+        end
+
+        private
+
+        # @api private
+        def json
+          predicates = []
+          values = []
+          @attributes.each do |field, value|
+            predicates.push "object->>? = ?"
+            values.concat([field, value.to_s])
+          end
+          sql = predicates.join(" and ")
+          @version_model_class.where(sql, *values)
+        end
+
+        # @api private
+        def jsonb
+          @version_model_class.where("object @> ?", @attributes.to_json)
+        end
+
+        # @api private
+        def text
+          arel_field = @version_model_class.arel_table[:object]
+          where_conditions = @attributes.map { |field, value|
+            ::PaperTrail.serializer.where_object_condition(arel_field, field, value)
+          }
+          where_conditions = where_conditions.reduce { |a, e| a.and(e) }
+          @version_model_class.where(where_conditions)
+        end
+      end
+    end
+  end
+end

data/lib/paper_trail/queries/versions/where_object_changes.rb

@@ -0,0 +1,68 @@
+module PaperTrail
+  module Queries
+    module Versions
+      # For public API documentation, see `where_object` in
+      # `paper_trail/version_concern.rb`.
+      # @api private
+      class WhereObjectChanges
+        # - version_model_class - The class that VersionConcern was mixed into.
+        # - attributes - A `Hash` of attributes and values. See the public API
+        #   documentation for details.
+        # @api private
+        def initialize(version_model_class, attributes)
+          @version_model_class = version_model_class
+
+          # Currently, this `deep_dup` is necessary because the `jsonb` branch
+          # modifies `@attributes`, and that would be a nasty suprise for
+          # consumers of this class.
+          # TODO: Stop modifying `@attributes`, then remove `deep_dup`.
+          @attributes = attributes.deep_dup
+        end
+
+        # @api private
+        def execute
+          case @version_model_class.columns_hash["object_changes"].type
+          when :jsonb
+            jsonb
+          when :json
+            json
+          else
+            text
+          end
+        end
+
+        private
+
+        # @api private
+        def json
+          predicates = []
+          values = []
+          @attributes.each do |field, value|
+            predicates.push(
+              "((object_changes->>? ILIKE ?) OR (object_changes->>? ILIKE ?))"
+            )
+            values.concat([field, "[#{value.to_json},%", field, "[%,#{value.to_json}]%"])
+          end
+          sql = predicates.join(" and ")
+          @version_model_class.where(sql, *values)
+        end
+
+        # @api private
+        def jsonb
+          @attributes.each { |field, value| @attributes[field] = [value] }
+          @version_model_class.where("object_changes @> ?", @attributes.to_json)
+        end
+
+        # @api private
+        def text
+          arel_field = @version_model_class.arel_table[:object_changes]
+          where_conditions = @attributes.map { |field, value|
+            ::PaperTrail.serializer.where_object_changes_condition(arel_field, field, value)
+          }
+          where_conditions = where_conditions.reduce { |a, e| a.and(e) }
+          @version_model_class.where(where_conditions)
+        end
+      end
+    end
+  end
+end

data/lib/paper_trail/record_trail.rb

@@ -118,30 +118,47 @@ module PaperTrail
       source_version.nil?
     end
 
+    # Updates `data` from the model's `meta` option and from `controller_info`.
     # @api private
-    def merge_metadata(data)
-      # First we merge the model-level metadata in `meta`.
+    def merge_metadata_into(data)
+      merge_metadata_from_model_into(data)
+      merge_metadata_from_controller_into(data)
+    end
+
+    # Updates `data` from `controller_info`.
+    # @api private
+    def merge_metadata_from_controller_into(data)
+      data.merge(PaperTrail.controller_info || {})
+    end
+
+    # Updates `data` from the model's `meta` option.
+    # @api private
+    def merge_metadata_from_model_into(data)
       @record.paper_trail_options[:meta].each do |k, v|
-        data[k] =
-          if v.respond_to?(:call)
-            v.call(@record)
-          elsif v.is_a?(Symbol) && @record.respond_to?(v, true)
-            # If it is an attribute that is changing in an existing object,
-            # be sure to grab the current version.
-            if @record.has_attribute?(v) &&
-                attribute_changed_in_latest_version?(v) &&
-                data[:event] != "create"
-              attribute_in_previous_version(v)
-            else
-              @record.send(v)
-            end
-          else
-            v
-          end
+        data[k] = model_metadatum(v, data[:event])
       end
+    end
 
-      # Second we merge any extra data from the controller (if available).
-      data.merge(PaperTrail.controller_info || {})
+    # Given a `value` from the model's `meta` option, returns an object to be
+    # persisted. The `value` can be a simple scalar value, but it can also
+    # be a symbol that names a model method, or even a Proc.
+    # @api private
+    def model_metadatum(value, event)
+      if value.respond_to?(:call)
+        value.call(@record)
+      elsif value.is_a?(Symbol) && @record.respond_to?(value, true)
+        # If it is an attribute that is changing in an existing object,
+        # be sure to grab the current version.
+        if event != "create" &&
+            @record.has_attribute?(value) &&
+            attribute_changed_in_latest_version?(value)
+          attribute_in_previous_version(value)
+        else
+          @record.send(value)
+        end
+      else
+        value
+      end
     end
 
     # Returns the object (not a Version) as it became next.
@@ -210,7 +227,7 @@ module PaperTrail
         data[:object_changes] = recordable_object_changes
       end
       add_transaction_id_to(data)
-      merge_metadata(data)
+      merge_metadata_into(data)
     end
 
     def record_destroy
@@ -238,7 +255,7 @@ module PaperTrail
         whodunnit: PaperTrail.whodunnit
       }
       add_transaction_id_to(data)
-      merge_metadata(data)
+      merge_metadata_into(data)
     end
 
     # Returns a boolean indicating whether to store serialized version diffs
@@ -280,7 +297,7 @@ module PaperTrail
         data[:object_changes] = recordable_object_changes
       end
       add_transaction_id_to(data)
-      merge_metadata(data)
+      merge_metadata_into(data)
     end
 
     # Returns an object which can be assigned to the `object` attribute of a
@@ -329,29 +346,15 @@ module PaperTrail
     # Saves associations if the join table for `VersionAssociation` exists.
     def save_associations(version)
       return unless PaperTrail.config.track_associations?
-      save_associations_belongs_to(version)
-      save_associations_habtm(version)
+      save_bt_associations(version)
+      save_habtm_associations(version)
     end
 
-    def save_associations_belongs_to(version)
+    # Save all `belongs_to` associations.
+    # @api private
+    def save_bt_associations(version)
       @record.class.reflect_on_all_associations(:belongs_to).each do |assoc|
-        assoc_version_args = {
-          version_id: version.id,
-          foreign_key_name: assoc.foreign_key
-        }
-
-        if assoc.options[:polymorphic]
-          associated_record = @record.send(assoc.name) if @record.send(assoc.foreign_type)
-          if associated_record && associated_record.class.paper_trail.enabled?
-            assoc_version_args[:foreign_key_id] = associated_record.id
-          end
-        elsif assoc.klass.paper_trail.enabled?
-          assoc_version_args[:foreign_key_id] = @record.send(assoc.foreign_key)
-        end
-
-        if assoc_version_args.key?(:foreign_key_id)
-          PaperTrail::VersionAssociation.create(assoc_version_args)
-        end
+        save_bt_association(assoc, version)
       end
     end
 
@@ -359,7 +362,8 @@ module PaperTrail
     # HABTM associations looked like before any changes were made, by using
     # the `paper_trail_habtm` data structure. Then, we create
     # `VersionAssociation` records for each of the associated records.
-    def save_associations_habtm(version)
+    # @api private
+    def save_habtm_associations(version)
       @record.class.reflect_on_all_associations(:has_and_belongs_to_many).each do |a|
         next unless save_habtm_association?(a)
         habtm_assoc_ids(a).each do |id|
@@ -502,12 +506,34 @@ module PaperTrail
     end
 
     def log_version_errors(version, action)
-      version.logger.warn(
+      version.logger && version.logger.warn(
         "Unable to create version for #{action} of #{@record.class.name}" +
           "##{@record.id}: " + version.errors.full_messages.join(", ")
       )
     end
 
+    # Save a single `belongs_to` association.
+    # @api private
+    def save_bt_association(assoc, version)
+      assoc_version_args = {
+        version_id: version.id,
+        foreign_key_name: assoc.foreign_key
+      }
+
+      if assoc.options[:polymorphic]
+        associated_record = @record.send(assoc.name) if @record.send(assoc.foreign_type)
+        if associated_record && associated_record.class.paper_trail.enabled?
+          assoc_version_args[:foreign_key_id] = associated_record.id
+        end
+      elsif assoc.klass.paper_trail.enabled?
+        assoc_version_args[:foreign_key_id] = @record.send(assoc.foreign_key)
+      end
+
+      if assoc_version_args.key?(:foreign_key_id)
+        PaperTrail::VersionAssociation.create(assoc_version_args)
+      end
+    end
+
     # Returns true if the given HABTM association should be saved.
     # @api private
     def save_habtm_association?(assoc)