paper_trail 2.6.4 → 2.7.0

data/.travis.yml

@@ -1,5 +1,5 @@
+language: ruby
 rvm:
-  - 1.8.7
   - 1.9.2
+  - 1.8.7
   - ree
-

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 2.7.0
+
+  - [#164](https://github.com/airblade/paper_trail/pull/164) - Allow for custom serializer for storage of object attributes.
+  - [#180](https://github.com/airblade/paper_trail/pull/180) - Store serialized representation of serialized attributes
+    on the `object_changes` column in the `Version` table.
+  - [#183](https://github.com/airblade/paper_trail/pull/183) - Fully qualify the `Version` class to help prevent
+    namespace resolution errors within other gems / plugins.
+
 ## 2.6.4
 
   - [#181](https://github.com/airblade/paper_trail/issues/181)/[#182](https://github.com/airblade/paper_trail/pull/182) -

data/README.md

@@ -572,7 +572,7 @@ You can store arbitrary model-level metadata alongside each version like this:
 ```ruby
 class Article < ActiveRecord::Base
   belongs_to :author
-  has_paper_trail :meta => { :author_id  => Proc.new { |article| article.author_id },
+  has_paper_trail :meta => { :author_id  => :author_id,
                              :word_count => :count_words,
                              :answer     => 42 }
   def count_words
@@ -741,6 +741,16 @@ Or a block:
 end
 ```
 
+## Using a custom serializer
+
+By default, PaperTrail stores your changes as a YAML dump. You can override this with the serializer config option:
+
+```ruby
+>> PaperTrail.serializer = MyCustomSerializer
+```
+
+The serializer needs to be a class that responds to a `load` and `dump` method.
+
 ## Deleting Old Versions
 
 Over time your `versions` table will grow to an unwieldy size.  Because each version is self-contained (see the Diffing section above for more) you can simply delete any records you don't want any more.  For example:
@@ -840,6 +850,16 @@ Many thanks to:
 * [Ben Woosley](https://github.com/Empact)
 * [Philip Arndt](https://github.com/parndt)
 * [Daniel Vydra](https://github.com/dvydra)
+* [Byron Bowerman](https://github.com/BM5k)
+* [Nicolas Buduroi](https://github.com/budu)
+* [Pikender Sharma](https://github.com/pikender)
+* [Paul Brannan](https://github.com/cout)
+* [Ben Morrall](https://github.com/bmorrall)
+* [Yves Senn](https://github.com/senny)
+* [Ben Atkins](https://github.com/fullbridge-batkins)
+* [Yves Senn](https://github.com/senny)
+* [Tyler Rick](https://github.com/TylerRick)
+* [Bradley Priest](https://github.com/bradleypriest)
 
 
 ## Inspirations

data/lib/paper_trail.rb

@@ -4,6 +4,7 @@ require 'paper_trail/config'
 require 'paper_trail/controller'
 require 'paper_trail/has_paper_trail'
 require 'paper_trail/version'
+require 'paper_trail/serializers/yaml'
 
 # PaperTrail's module methods can be called in both models and controllers.
 module PaperTrail
@@ -68,6 +69,9 @@ module PaperTrail
     paper_trail_store[:controller_info] = value
   end
 
+  def self.serializer
+    PaperTrail.config.serializer
+  end
 
   private
 

data/lib/paper_trail/config.rb

@@ -3,12 +3,12 @@ require 'singleton'
 module PaperTrail
   class Config
     include Singleton
-    attr_accessor :enabled, :timestamp_field
- 
+    attr_accessor :enabled, :timestamp_field, :serializer
+
     def initialize
-      # Indicates whether PaperTrail is on or off.
-      @enabled         = true
+      @enabled         = true # Indicates whether PaperTrail is on or off.
       @timestamp_field = :created_at
+      @serializer      = PaperTrail::Serializers::Yaml
     end
   end
 end

data/lib/paper_trail/has_paper_trail.rb

@@ -39,7 +39,7 @@ module PaperTrail
         attr_accessor self.version_association_name
 
         class_attribute :version_class_name
-        self.version_class_name = options[:class_name] || 'Version'
+        self.version_class_name = options[:class_name] || '::Version'
 
         class_attribute :paper_trail_options
         self.paper_trail_options = options.dup
@@ -80,6 +80,44 @@ module PaperTrail
       def paper_trail_on
         self.paper_trail_enabled_for_model = true
       end
+
+      # Used for Version#object attribute
+      def serialize_attributes(attributes)
+        serialized_attributes.each do |key, coder|
+          if attributes.key?(key)
+            attributes[key] = coder.dump(attributes[key])
+          end
+        end
+      end
+
+      def unserialize_attributes(attributes)
+        serialized_attributes.each do |key, coder|
+          if attributes.key?(key)
+            attributes[key] = coder.load(attributes[key])
+          end
+        end
+      end
+
+      # Used for Version#object_changes attribute
+      def serialize_attribute_changes(changes)
+        serialized_attributes.each do |key, coder|
+          if changes.key?(key)
+            old_value, new_value = changes[key]
+            changes[key] = [coder.dump(old_value),
+                            coder.dump(new_value)]
+          end
+        end
+      end
+
+      def unserialize_attribute_changes(changes)
+        serialized_attributes.each do |key, coder|
+          if changes.key?(key)
+            old_value, new_value = changes[key]
+            changes[key] = [coder.load(old_value),
+                            coder.load(new_value)]
+          end
+        end
+      end
     end
 
     # Wrap the following methods in a module so we can include them only in the
@@ -151,8 +189,7 @@ module PaperTrail
           }
 
           if changed_notably? and version_class.column_names.include?('object_changes')
-            # The double negative (reject, !include?) preserves the hash structure of self.changes.
-            data[:object_changes] = self.changes.reject { |k, _| !notably_changed.include?(k) }.to_yaml
+            data[:object_changes] = changes_for_paper_trail.to_yaml
           end
 
           send(self.class.versions_association_name).create merge_metadata(data)
@@ -167,15 +204,20 @@ module PaperTrail
             :whodunnit => PaperTrail.whodunnit
           }
           if version_class.column_names.include? 'object_changes'
-            # The double negative (reject, !include?) preserves the hash structure of self.changes.
-            data[:object_changes] = self.changes.reject do |key, value|
-              !notably_changed.include?(key)
-            end.to_yaml
+            data[:object_changes] = PaperTrail.serializer.dump(changes_for_paper_trail)
           end
           send(self.class.versions_association_name).build merge_metadata(data)
         end
       end
 
+      def changes_for_paper_trail
+        self.changes.keep_if do |key, value|
+          notably_changed.include?(key)
+        end.tap do |changes|
+          self.class.serialize_attribute_changes(changes) # Use serialized value for attributes when necessary
+        end
+      end
+
       def record_destroy
         if switched_on? and not new_record?
           version_class.create merge_metadata(:item_id   => self.id,
@@ -221,7 +263,10 @@ module PaperTrail
       end
 
       def object_to_string(object)
-        object.attributes.except(*self.class.paper_trail_options[:skip]).to_yaml
+        _attrs = object.attributes.except(*self.class.paper_trail_options[:skip]).tap do |attributes|
+          self.class.serialize_attributes attributes
+        end
+        PaperTrail.serializer.dump(_attrs)
       end
 
       def changed_notably?

data/lib/paper_trail/serializers/yaml.rb

@@ -0,0 +1,15 @@
+require 'yaml'
+
+module PaperTrail
+  module Serializers
+    class Yaml
+      def self.load(string)
+        YAML.load string
+      end
+
+      def self.dump(hash)
+        YAML.dump hash
+      end
+    end
+  end
+end

data/lib/paper_trail/version.rb

@@ -55,7 +55,7 @@ class Version < ActiveRecord::Base
       options.reverse_merge! :has_one => false
 
       unless object.nil?
-        attrs = YAML::load object
+        attrs = PaperTrail.serializer.load object
 
         # Normally a polymorphic belongs_to relationship allows us
         # to get the object we belong to by calling, in this case,
@@ -79,6 +79,7 @@ class Version < ActiveRecord::Base
           model = klass.new
         end
 
+        model.class.unserialize_attributes attrs
         attrs.each do |k, v|
           if model.respond_to?("#{k}=")
             model.send :write_attribute, k.to_sym, v
@@ -103,7 +104,9 @@ class Version < ActiveRecord::Base
   def changeset
     if self.class.column_names.include? 'object_changes'
       if changes = object_changes
-        HashWithIndifferentAccess[YAML::load(changes)]
+        HashWithIndifferentAccess[PaperTrail.serializer.load(changes)].tap do |changes|
+          item_type.constantize.unserialize_attribute_changes(changes)
+        end
       else
         {}
       end

data/lib/paper_trail/version_number.rb

@@ -1,3 +1,3 @@
 module PaperTrail
-  VERSION = '2.6.4'
+  VERSION = '2.7.0'
 end

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

@@ -2,4 +2,27 @@ class Person < ActiveRecord::Base
   has_many :authorships, :dependent => :destroy
   has_many :books, :through => :authorships
   has_paper_trail
+
+  # Convert strings to TimeZone objects when assigned
+  def time_zone=(value)
+    if value.is_a? ActiveSupport::TimeZone
+      super
+    else
+      zone = ::Time.find_zone(value)  # nil if can't find time zone
+      super zone
+    end
+  end
+
+  # Store TimeZone objects as strings when serialized to database
+  class TimeZoneSerializer
+    def dump(zone)
+      zone.try(:name)
+    end
+   
+    def load(value)
+      ::Time.find_zone!(value) rescue nil
+    end
+  end
+ 
+  serialize :time_zone, TimeZoneSerializer.new
 end

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

@@ -80,6 +80,7 @@ class SetUpTestTables < ActiveRecord::Migration
 
     create_table :people, :force => true do |t|
       t.string :name
+      t.string :time_zone
     end
 
     create_table :songs, :force => true do |t|

data/test/unit/model_test.rb

@@ -49,11 +49,11 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
         end
 
         should 'have removed the skipped attributes when saving the previous version' do
-          assert_equal nil, YAML::load(@old_article.object)['file_upload']
+          assert_equal nil, PaperTrail.serializer.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']
+          assert_equal 'Some text here.', PaperTrail.serializer.load(@old_article.object)['content']
         end
       end
     end
@@ -201,7 +201,7 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
         end
 
         should 'have stored changes' do
-          assert_equal ({'name' => ['Henry', 'Harry']}), YAML::load(@widget.versions.last.object_changes)
+          assert_equal ({'name' => ['Henry', 'Harry']}), PaperTrail.serializer.load(@widget.versions.last.object_changes)
           assert_equal ({'name' => ['Henry', 'Harry']}), @widget.versions.last.changeset
         end
 
@@ -916,6 +916,90 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
     end
   end
 
+  context 'When an attribute has a custom serializer' do
+    setup { @person = Person.new(:time_zone => "Samoa") }
+
+    should "be an instance of ActiveSupport::TimeZone" do
+      assert_equal ActiveSupport::TimeZone, @person.time_zone.class
+    end
+
+    context 'when the model is saved' do
+      setup do
+        @changes_before_save = @person.changes.dup
+        @person.save!
+      end
+
+      # Test for serialization:
+      should 'version.object_changes should not have stored the default, ridiculously long (to_yaml) serialization of the TimeZone object' do
+        assert @person.versions.last.object_changes.length < 105, "object_changes length was #{@person.versions.last.object_changes.length}"
+      end
+      # It should store the serialized value.
+      should 'version.object_changes attribute should have stored the value returned by the attribute serializer' do
+        as_stored_in_version = HashWithIndifferentAccess[YAML::load(@person.versions.last.object_changes)]
+        assert_equal [nil, 'Samoa'], as_stored_in_version[:time_zone]
+        assert_equal @person.instance_variable_get(:@attributes)['time_zone'].serialized_value, as_stored_in_version[:time_zone].last
+      end
+
+      # Tests for unserialization:
+      should 'version.changeset should convert the attribute value back to its original, unserialized value' do
+        assert_equal @person.instance_variable_get(:@attributes)['time_zone'].unserialized_value, @person.versions.last.changeset[:time_zone].last
+      end
+      should "record.changes (before save) returns the original, unserialized values" do
+        assert_equal [NilClass, ActiveSupport::TimeZone], @changes_before_save[:time_zone].map(&:class)
+      end
+      should 'version.changeset should be the same as record.changes was before the save' do
+        assert_equal @changes_before_save, @person.versions.last.changeset.delete_if { |key, val| key.to_sym == :id }
+        assert_equal [NilClass, ActiveSupport::TimeZone], @person.versions.last.changeset[:time_zone].map(&:class)
+      end
+
+      context 'when that attribute is updated' do
+        setup do
+          @attribute_value_before_change = @person.instance_variable_get(:@attributes)['time_zone']
+          @person.assign_attributes({ :time_zone => 'Pacific Time (US & Canada)' })
+          @changes_before_save = @person.changes.dup
+          @person.save!
+        end
+
+        # Tests for serialization:
+        # Before the serialized attributes fix, the object/object_changes value that was stored was ridiculously long (58723).
+        should 'version.object should not have stored the default, ridiculously long (to_yaml) serialization of the TimeZone object' do
+          assert @person.versions.last.object.        length < 105, "object         length was #{@person.versions.last.object        .length}"
+        end
+        should 'version.object_changes should not have stored the default, ridiculously long (to_yaml) serialization of the TimeZone object' do
+          assert @person.versions.last.object_changes.length < 105, "object_changes length was #{@person.versions.last.object_changes.length}"
+        end
+        # But now it stores the short, serialized value.
+        should 'version.object attribute should have stored the value returned by the attribute serializer' do
+          as_stored_in_version = HashWithIndifferentAccess[YAML::load(@person.versions.last.object)]
+          assert_equal 'Samoa', as_stored_in_version[:time_zone]
+          assert_equal @attribute_value_before_change.serialized_value, as_stored_in_version[:time_zone]
+        end
+        should 'version.object_changes attribute should have stored the value returned by the attribute serializer' do
+          as_stored_in_version = HashWithIndifferentAccess[YAML::load(@person.versions.last.object_changes)]
+          assert_equal ['Samoa', 'Pacific Time (US & Canada)'], as_stored_in_version[:time_zone]
+          assert_equal @person.instance_variable_get(:@attributes)['time_zone'].serialized_value, as_stored_in_version[:time_zone].last
+        end
+
+        # Tests for unserialization:
+        should 'version.reify should convert the attribute value back to its original, unserialized value' do
+          assert_equal @attribute_value_before_change.unserialized_value, @person.versions.last.reify.time_zone
+        end
+        should 'version.changeset should convert the attribute value back to its original, unserialized value' do
+          assert_equal @person.instance_variable_get(:@attributes)['time_zone'].unserialized_value, @person.versions.last.changeset[:time_zone].last
+        end
+        should "record.changes (before save) returns the original, unserialized values" do
+          assert_equal [ActiveSupport::TimeZone, ActiveSupport::TimeZone], @changes_before_save[:time_zone].map(&:class)
+        end
+        should 'version.changeset should be the same as record.changes was before the save' do
+          assert_equal @changes_before_save, @person.versions.last.changeset
+          assert_equal [ActiveSupport::TimeZone, ActiveSupport::TimeZone], @person.versions.last.changeset[:time_zone].map(&:class)
+        end
+
+      end
+    end
+  end
+
+
   context 'A new model instance which uses a custom Version class' do
     setup { @post = Post.new }
 

data/test/unit/serializer_test.rb

@@ -0,0 +1,71 @@
+require 'test_helper'
+
+class CustomSerializer
+  require 'json'
+  def self.dump(object_hash)
+    JSON.dump object_hash
+  end
+
+  def self.load(string)
+    JSON.parse string
+  end
+end
+
+class SerializerTest < ActiveSupport::TestCase
+
+  context 'YAML Serializer' do
+    setup do
+      Fluxor.instance_eval <<-END
+        has_paper_trail
+      END
+
+      @fluxor = Fluxor.create :name => 'Some text.'
+      @fluxor.update_attributes :name => 'Some more text.'
+    end
+
+    should 'work with the default yaml serializer' do
+      # Normal behaviour
+      assert_equal 2, @fluxor.versions.length
+      assert_nil @fluxor.versions[0].reify
+      assert_equal 'Some text.', @fluxor.versions[1].reify.name
+
+
+      # Check values are stored as YAML.
+      hash = {"widget_id" => nil,"name" =>"Some text.","id" =>1}
+      assert_equal YAML.dump(hash), @fluxor.versions[1].object
+      assert_equal hash, YAML.load(@fluxor.versions[1].object)
+
+    end
+  end
+
+  context 'Custom Serializer' do
+    setup do
+      PaperTrail.config.serializer = CustomSerializer
+
+      Fluxor.instance_eval <<-END
+        has_paper_trail
+      END
+
+      @fluxor = Fluxor.create :name => 'Some text.'
+      @fluxor.update_attributes :name => 'Some more text.'
+    end
+
+    teardown do
+      PaperTrail.config.serializer = PaperTrail::Serializers::Yaml
+    end
+
+    should 'work with custom serializer' do
+      # Normal behaviour
+      assert_equal 2, @fluxor.versions.length
+      assert_nil @fluxor.versions[0].reify
+      assert_equal 'Some text.', @fluxor.versions[1].reify.name
+
+      # Check values are stored as JSON.
+      hash = {"widget_id" => nil,"name" =>"Some text.","id" =>1}
+      assert_equal JSON.dump(hash), @fluxor.versions[1].object
+      assert_equal hash, JSON.parse(@fluxor.versions[1].object)
+
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paper_trail
 version: !ruby/object:Gem::Version
-  version: 2.6.4
+  version: 2.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-16 00:00:00.000000000 Z
+date: 2012-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -128,6 +128,7 @@ files:
 - lib/paper_trail/config.rb
 - lib/paper_trail/controller.rb
 - lib/paper_trail/has_paper_trail.rb
+- lib/paper_trail/serializers/yaml.rb
 - lib/paper_trail/version.rb
 - lib/paper_trail/version_number.rb
 - paper_trail.gemspec
@@ -192,6 +193,7 @@ files:
 - test/test_helper.rb
 - test/unit/inheritance_column_test.rb
 - test/unit/model_test.rb
+- test/unit/serializer_test.rb
 - test/unit/timestamp_test.rb
 - test/unit/version_test.rb
 homepage: http://github.com/airblade/paper_trail
@@ -280,5 +282,6 @@ test_files:
 - test/test_helper.rb
 - test/unit/inheritance_column_test.rb
 - test/unit/model_test.rb
+- test/unit/serializer_test.rb
 - test/unit/timestamp_test.rb
 - test/unit/version_test.rb