paper_trail 5.0.1 → 5.1.0

data/lib/paper_trail/version_concern.rb

@@ -1,4 +1,5 @@
 require "active_support/concern"
+require "paper_trail/attribute_serializers/object_changes_attribute"
 
 module PaperTrail
   # Originally, PaperTrail did not provide this module, and all of this
@@ -109,8 +110,10 @@ module PaperTrail
         end
       end
 
+      # Query the `versions.objects` column using the SQL LIKE operator.
       # Performs an attribute search on the serialized object by invoking the
       # identically-named method in the serializer being used.
+      # @api public
       def where_object(args = {})
         raise ArgumentError, "expected to receive a Hash" unless args.is_a?(Hash)
 
@@ -135,6 +138,9 @@ module PaperTrail
         end
       end
 
+      # Query the `versions.object_changes` column by attributes, using the
+      # SQL LIKE operator.
+      # @api public
       def where_object_changes(args = {})
         raise ArgumentError, "expected to receive a Hash" unless args.is_a?(Hash)
 
@@ -279,7 +285,7 @@ module PaperTrail
       # First, deserialize the `object_changes` column.
       changes = HashWithIndifferentAccess.new(object_changes_deserialized)
 
-      # The next step is, perhaps unfortunately, called "un-serialization",
+      # The next step is, perhaps unfortunately, called "de-serialization",
       # and appears to be responsible for custom attribute serializers. For an
       # example of a custom attribute serializer, see
       # `Person::TimeZoneSerializer` in the test suite.
@@ -291,7 +297,9 @@ module PaperTrail
       #
       # Note: `item` returns nil if `event` is "destroy".
       unless item.nil?
-        item.class.unserialize_attribute_changes_for_paper_trail!(changes)
+        AttributeSerializers::ObjectChangesAttribute.
+          new(item.class).
+          deserialize(changes)
       end
 
       # Finally, return a Hash mapping each attribute name to

data/lib/paper_trail/version_number.rb

@@ -2,8 +2,8 @@ module PaperTrail
   # :nodoc:
   module VERSION
     MAJOR = 5
-    MINOR = 0
-    TINY = 1
+    MINOR = 1
+    TINY = 0
     PRE = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".").freeze

data/paper_trail.gemspec

@@ -35,7 +35,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "generator_spec", "~> 0.9.3"
   s.add_development_dependency "database_cleaner", "~> 1.2"
   s.add_development_dependency "pry-nav", "~> 0.2.4"
-  s.add_development_dependency "rubocop", "~> 0.37.2"
+  s.add_development_dependency "rubocop", "~> 0.40.0"
   s.add_development_dependency "timecop", "~> 0.8.0"
 
   if defined?(JRUBY_VERSION)

data/spec/models/widget_spec.rb

@@ -121,7 +121,8 @@ describe Widget, type: :model do
     describe "sort order" do
       it "should sort by the timestamp order from the `VersionConcern`" do
         expect(widget.versions.to_sql).to eq(
-          widget.versions.reorder(PaperTrail::Version.timestamp_sort_order).to_sql)
+          widget.versions.reorder(PaperTrail::Version.timestamp_sort_order).to_sql
+        )
       end
     end
   end

data/spec/modules/version_number_spec.rb

@@ -28,7 +28,8 @@ describe PaperTrail::VERSION do
 
       it "should join the numbers into a period separated string" do
         expect(subject::STRING).to eq(
-          [subject::MAJOR, subject::MINOR, subject::TINY, subject::PRE].compact.join("."))
+          [subject::MAJOR, subject::MINOR, subject::TINY, subject::PRE].compact.join(".")
+        )
       end
     end
   end

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

@@ -1,4 +1,5 @@
 class FooHabtm < ActiveRecord::Base
   has_and_belongs_to_many :bar_habtms
+  accepts_nested_attributes_for :bar_habtms
   has_paper_trail
 end

data/test/unit/associations_test.rb

@@ -988,5 +988,29 @@ class AssociationsTest < ActiveSupport::TestCase
         end
       end
     end
+
+    context "updated via nested attributes" do
+      setup do
+        @foo = FooHabtm.create(
+          name: "foo",
+          bar_habtms_attributes: [{ name: "bar" }]
+        )
+        Timecop.travel 1.second.since
+        @foo.update_attributes(
+          name: "foo2",
+          bar_habtms_attributes: [{ id: @foo.bar_habtms.first.id, name: "bar2" }]
+        )
+
+        @reified = @foo.versions.last.reify(has_and_belongs_to_many: true)
+      end
+
+      should "see the associated object as it was at the time" do
+        assert_equal "bar", @reified.bar_habtms.first.name
+      end
+
+      should "not persist changes to the live object" do
+        assert_not_equal @reified.bar_habtms.first.name, @foo.reload.bar_habtms.first.name
+      end
+    end
   end
 end

data/test/unit/serializers/json_test.rb

@@ -40,7 +40,9 @@ class JSONTest < ActiveSupport::TestCase
     context "when value is a string" do
       should "construct correct WHERE query" do
         matches = PaperTrail::Serializers::JSON.where_object_condition(
-          PaperTrail::Version.arel_table[:object], :arg1, "Val 1")
+          PaperTrail::Version.arel_table[:object], :arg1,
+          "Val 1"
+        )
 
         assert matches.instance_of?(Arel::Nodes::Matches)
         if Arel::VERSION >= "6"
@@ -54,7 +56,10 @@ class JSONTest < ActiveSupport::TestCase
     context "when value is `null`" do
       should "construct correct WHERE query" do
         matches = PaperTrail::Serializers::JSON.where_object_condition(
-          PaperTrail::Version.arel_table[:object], :arg1, nil)
+          PaperTrail::Version.arel_table[:object],
+          :arg1,
+          nil
+        )
 
         assert matches.instance_of?(Arel::Nodes::Matches)
         if Arel::VERSION >= "6"
@@ -68,7 +73,10 @@ class JSONTest < ActiveSupport::TestCase
     context "when value is a number" do
       should "construct correct WHERE query" do
         grouping = PaperTrail::Serializers::JSON.where_object_condition(
-          PaperTrail::Version.arel_table[:object], :arg1, -3.5)
+          PaperTrail::Version.arel_table[:object],
+          :arg1,
+          -3.5
+        )
 
         assert grouping.instance_of?(Arel::Nodes::Grouping)
         matches = grouping.select { |v| v.instance_of?(Arel::Nodes::Matches) }

data/test/unit/serializers/yaml_test.rb

@@ -39,7 +39,10 @@ class YamlTest < ActiveSupport::TestCase
   context "`where_object` class method" do
     should "construct correct WHERE query" do
       matches = PaperTrail::Serializers::YAML.where_object_condition(
-        PaperTrail::Version.arel_table[:object], :arg1, "Val 1")
+        PaperTrail::Version.arel_table[:object],
+        :arg1,
+        "Val 1"
+      )
       assert matches.instance_of?(Arel::Nodes::Matches)
       if Arel::VERSION >= "6"
         assert_equal matches.right.val, "%\narg1: Val 1\n%"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paper_trail
 version: !ruby/object:Gem::Version
-  version: 5.0.1
+  version: 5.1.0
 platform: ruby
 authors:
 - Andy Stewart
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-04 00:00:00.000000000 Z
+date: 2016-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -231,14 +231,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.37.2
+        version: 0.40.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.37.2
+        version: 0.40.0
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -315,6 +315,7 @@ files:
 - README.md
 - Rakefile
 - doc/bug_report_template.rb
+- doc/warning_about_not_setting_whodunnit.md
 - gemfiles/ar3.gemfile
 - gemfiles/ar4.gemfile
 - gemfiles/ar5.gemfile
@@ -325,7 +326,11 @@ files:
 - lib/generators/paper_trail/templates/create_version_associations.rb
 - lib/generators/paper_trail/templates/create_versions.rb
 - lib/paper_trail.rb
-- lib/paper_trail/attributes_serialization.rb
+- lib/paper_trail/attribute_serializers/README.md
+- lib/paper_trail/attribute_serializers/cast_attribute_serializer.rb
+- lib/paper_trail/attribute_serializers/legacy_active_record_shim.rb
+- lib/paper_trail/attribute_serializers/object_attribute.rb
+- lib/paper_trail/attribute_serializers/object_changes_attribute.rb
 - lib/paper_trail/cleaner.rb
 - lib/paper_trail/config.rb
 - lib/paper_trail/frameworks/active_record.rb

data/lib/paper_trail/attributes_serialization.rb

@@ -1,161 +0,0 @@
-module PaperTrail
-  # "Serialization" here refers to the preparation of data for insertion into a
-  # database, particularly the `object` and `object_changes` columns in the
-  # `versions` table.
-  #
-  # Likewise, "deserialization" refers to any processing of data after they
-  # have been read from the database, for example preparing the result of
-  # `VersionConcern#changeset`.
-  module AttributesSerialization
-    # An attribute which needs no processing. It is part of our backport (shim)
-    # of rails 4.2's attribute API. See `type_for_attribute` below.
-    class NoOpAttribute
-      def type_cast_for_database(value)
-        value
-      end
-
-      def type_cast_from_database(data)
-        data
-      end
-    end
-    NO_OP_ATTRIBUTE = NoOpAttribute.new
-
-    # An attribute which requires manual (de)serialization to/from what we get
-    # from the database. It is part of our backport (shim) of rails 4.2's
-    # attribute API. See `type_for_attribute` below.
-    class SerializedAttribute
-      def initialize(coder)
-        @coder = coder.respond_to?(:dump) ? coder : PaperTrail.serializer
-      end
-
-      def type_cast_for_database(value)
-        @coder.dump(value)
-      end
-
-      def type_cast_from_database(data)
-        @coder.load(data)
-      end
-    end
-
-    # The `AbstractSerializer` (de)serializes model attribute values. For
-    # example, the string "1.99" serializes into the integer `1` when assigned
-    # to an attribute of type `ActiveRecord::Type::Integer`.
-    #
-    # This implementation depends on the `type_for_attribute` method, which was
-    # introduced in rails 4.2. In older versions of rails, we shim this method
-    # below.
-    #
-    # At runtime, the `AbstractSerializer` has only one child class, the
-    # `CastedAttributeSerializer`, whose implementation varies depending on the
-    # version of ActiveRecord.
-    class AbstractSerializer
-      def initialize(klass)
-        @klass = klass
-      end
-
-      private
-
-      def apply_serialization(method, attr, val)
-        @klass.type_for_attribute(attr).send(method, val)
-      end
-    end
-
-    if ::ActiveRecord::VERSION::MAJOR >= 5
-      # This implementation uses AR 5's `serialize` and `deserialize`.
-      class CastedAttributeSerializer < AbstractSerializer
-        def serialize(attr, val)
-          apply_serialization(:serialize, attr, val)
-        end
-
-        def deserialize(attr, val)
-          apply_serialization(:deserialize, attr, val)
-        end
-      end
-    else
-      # This implementation uses AR 4.2's `type_cast_for_database`. For
-      # versions of AR < 4.2 we provide an implementation of
-      # `type_cast_for_database` in our shim attribute type classes,
-      # `NoOpAttribute` and `SerializedAttribute`.
-      class CastedAttributeSerializer < AbstractSerializer
-        def serialize(attr, val)
-          val = defined_enums[attr][val] if defined_enums[attr]
-          apply_serialization(:type_cast_for_database, attr, val)
-        end
-
-        def deserialize(attr, val)
-          val = apply_serialization(:type_cast_from_database, attr, val)
-
-          if defined_enums[attr]
-            defined_enums[attr].key(val)
-          else
-            val
-          end
-        end
-
-        private
-
-        def defined_enums
-          @defined_enums ||= (@klass.respond_to?(:defined_enums) ? @klass.defined_enums : {})
-        end
-      end
-    end
-
-    # Backport Rails 4.2 and later's `type_for_attribute` so we can build
-    # on a common interface.
-    if ::ActiveRecord::VERSION::STRING < "4.2"
-      def type_for_attribute(attr_name)
-        serialized_attribute_types[attr_name.to_s] || NO_OP_ATTRIBUTE
-      end
-
-      def serialized_attribute_types
-        @attribute_types ||= Hash[serialized_attributes.map do |attr_name, coder|
-          [attr_name, SerializedAttribute.new(coder)]
-        end]
-      end
-      private :serialized_attribute_types
-    end
-
-    # Used for `Version#object` attribute.
-    def serialize_attributes_for_paper_trail!(attributes)
-      alter_attributes_for_paper_trail!(:serialize, attributes)
-    end
-
-    def unserialize_attributes_for_paper_trail!(attributes)
-      alter_attributes_for_paper_trail!(:deserialize, attributes)
-    end
-
-    def alter_attributes_for_paper_trail!(serialization_method, attributes)
-      # Don't serialize before values before inserting into columns of type
-      # `JSON` on `PostgreSQL` databases.
-      return attributes if paper_trail_version_class.object_col_is_json?
-
-      serializer = CastedAttributeSerializer.new(self)
-      attributes.each do |key, value|
-        attributes[key] = serializer.send(serialization_method, key, value)
-      end
-    end
-
-    # Used for Version#object_changes attribute.
-    def serialize_attribute_changes_for_paper_trail!(changes)
-      alter_attribute_changes_for_paper_trail!(:serialize, changes)
-    end
-
-    def unserialize_attribute_changes_for_paper_trail!(changes)
-      alter_attribute_changes_for_paper_trail!(:deserialize, changes)
-    end
-
-    def alter_attribute_changes_for_paper_trail!(serialization_method, changes)
-      # Don't serialize before values before inserting into columns of type
-      # `JSON` on `PostgreSQL` databases.
-      return changes if paper_trail_version_class.object_changes_col_is_json?
-
-      serializer = CastedAttributeSerializer.new(self)
-      changes.clone.each do |key, change|
-        # `change` is an Array with two elements, representing before and after.
-        changes[key] = Array(change).map do |value|
-          serializer.send(serialization_method, key, value)
-        end
-      end
-    end
-  end
-end