paper_trail 2.7.0 → 2.7.1

data/CHANGELOG.md

@@ -1,10 +1,27 @@
+## 2.7.1
+
+  - [#206](https://github.com/airblade/paper_trail/issues/206) - Fixed Ruby 1.8.7 compatibility for tracking `object_changes`.
+  - [#200](https://github.com/airblade/paper_trail/issues/200) - Fixed `next_version` method so that it returns the live model
+    when called on latest reified version of a model prior to the live model.
+  - [#197](https://github.com/airblade/paper_trail/issues/197) - PaperTrail now falls back on using YAML for serialization of
+    serialized model attributes for storage in the `object` and `object_changes` columns in the `Version` table. This fixes
+    compatibility for `Rails 3.0.x` for projects that employ the `serialize` declaration on a model.
+  - [#194](https://github.com/airblade/paper_trail/issues/194) - A JSON serializer is now included in the gem.
+  - [#192](https://github.com/airblade/paper_trail/pull/192) - `object_changes` should store serialized representation of serialized
+    attributes for `create` actions (in addition to `update` actions, which had already been patched by
+    [#180](https://github.com/airblade/paper_trail/pull/180)).
+  - [#190](https://github.com/airblade/paper_trail/pull/190) - Fixed compatibility with
+    [SerializedAttributes](https://github.com/technoweenie/serialized_attributes) gem.
+  - [#189](https://github.com/airblade/paper_trail/pull/189) - Provided support for a `configure` block initializer.
+  - Added `setter` method for the `serializer` config option.
+
 ## 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.
+  - [#180](https://github.com/airblade/paper_trail/pull/180) - Store serialized representation of serialized attributes
+    on the `object` and `object_changes` columns in the `Version` table.
+  - [#164](https://github.com/airblade/paper_trail/pull/164) - Allow usage of custom serializer for storage of object attributes.
 
 ## 2.6.4
 

data/README.md

@@ -749,7 +749,10 @@ By default, PaperTrail stores your changes as a YAML dump. You can override this
 >> PaperTrail.serializer = MyCustomSerializer
 ```
 
-The serializer needs to be a class that responds to a `load` and `dump` method.
+A valid serializer is a `module` (or `class`) that defines a `load` and `dump` method.  These serializers are included in the gem for your convenience:
+
+* [Yaml](https://github.com/airblade/paper_trail/blob/master/lib/paper_trail/serializers/yaml.rb) - Default
+* [Json](https://github.com/airblade/paper_trail/blob/master/lib/paper_trail/serializers/json.rb)
 
 ## Deleting Old Versions
 
@@ -860,6 +863,7 @@ Many thanks to:
 * [Yves Senn](https://github.com/senny)
 * [Tyler Rick](https://github.com/TylerRick)
 * [Bradley Priest](https://github.com/bradleypriest)
+* [David Butler](https://github.com/dwbutler)
 
 
 ## Inspirations

data/lib/paper_trail.rb

@@ -1,10 +1,10 @@
-require 'yaml'
-
 require 'paper_trail/config'
 require 'paper_trail/controller'
 require 'paper_trail/has_paper_trail'
 require 'paper_trail/version'
+
 require 'paper_trail/serializers/yaml'
+require 'paper_trail/serializers/json'
 
 # PaperTrail's module methods can be called in both models and controllers.
 module PaperTrail
@@ -69,6 +69,11 @@ module PaperTrail
     paper_trail_store[:controller_info] = value
   end
 
+  # Getter and Setter for PaperTrail Serializer
+  def self.serializer=(value)
+    PaperTrail.config.serializer = value
+  end
+
   def self.serializer
     PaperTrail.config.serializer
   end
@@ -88,6 +93,10 @@ module PaperTrail
     @@config ||= PaperTrail::Config.instance
   end
 
+  def self.configure
+    yield config
+  end
+
 end
 
 

data/lib/paper_trail/has_paper_trail.rb

@@ -82,17 +82,19 @@ module PaperTrail
       end
 
       # Used for Version#object attribute
-      def serialize_attributes(attributes)
+      def serialize_attributes_for_paper_trail(attributes)
         serialized_attributes.each do |key, coder|
           if attributes.key?(key)
+            coder = PaperTrail::Serializers::Yaml unless coder.respond_to?(:dump) # Fall back to YAML if `coder` has no `dump` method
             attributes[key] = coder.dump(attributes[key])
           end
         end
       end
 
-      def unserialize_attributes(attributes)
+      def unserialize_attributes_for_paper_trail(attributes)
         serialized_attributes.each do |key, coder|
           if attributes.key?(key)
+            coder = PaperTrail::Serializers::Yaml unless coder.respond_to?(:dump)
             attributes[key] = coder.load(attributes[key])
           end
         end
@@ -102,6 +104,7 @@ module PaperTrail
       def serialize_attribute_changes(changes)
         serialized_attributes.each do |key, coder|
           if changes.key?(key)
+            coder = PaperTrail::Serializers::Yaml unless coder.respond_to?(:dump) # Fall back to YAML if `coder` has no `dump` method
             old_value, new_value = changes[key]
             changes[key] = [coder.dump(old_value),
                             coder.dump(new_value)]
@@ -112,6 +115,7 @@ module PaperTrail
       def unserialize_attribute_changes(changes)
         serialized_attributes.each do |key, coder|
           if changes.key?(key)
+            coder = PaperTrail::Serializers::Yaml unless coder.respond_to?(:dump)
             old_value, new_value = changes[key]
             changes[key] = [coder.load(old_value),
                             coder.load(new_value)]
@@ -151,15 +155,17 @@ module PaperTrail
       # Returns the object (not a Version) as it was most recently.
       def previous_version
         preceding_version = source_version ? source_version.previous : send(self.class.versions_association_name).last
-        preceding_version.try :reify
+        preceding_version.reify if preceding_version
       end
 
       # Returns the object (not a Version) as it became next.
+      # NOTE: if self (the item) was not reified from a version, i.e. it is the
+      #  "live" item, we return nil.  Perhaps we should return self instead?
       def next_version
-        # NOTE: if self (the item) was not reified from a version, i.e. it is the
-        # "live" item, we return nil.  Perhaps we should return self instead?
-        subsequent_version = source_version ? source_version.next : nil
-        subsequent_version.reify if subsequent_version
+        subsequent_version = source_version.next
+        subsequent_version ? subsequent_version.reify : self.class.find(self.id)
+      rescue
+        nil
       end
 
       # Executes the given method or block without creating a new version.
@@ -189,7 +195,7 @@ module PaperTrail
           }
 
           if changed_notably? and version_class.column_names.include?('object_changes')
-            data[:object_changes] = changes_for_paper_trail.to_yaml
+            data[:object_changes] = PaperTrail.serializer.dump(changes_for_paper_trail)
           end
 
           send(self.class.versions_association_name).create merge_metadata(data)
@@ -211,8 +217,8 @@ module PaperTrail
       end
 
       def changes_for_paper_trail
-        self.changes.keep_if do |key, value|
-          notably_changed.include?(key)
+        self.changes.delete_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
@@ -264,7 +270,7 @@ module PaperTrail
 
       def object_to_string(object)
         _attrs = object.attributes.except(*self.class.paper_trail_options[:skip]).tap do |attributes|
-          self.class.serialize_attributes attributes
+          self.class.serialize_attributes_for_paper_trail attributes
         end
         PaperTrail.serializer.dump(_attrs)
       end

data/lib/paper_trail/serializers/json.rb

@@ -0,0 +1,17 @@
+require 'active_support/json'
+
+module PaperTrail
+  module Serializers
+    module Json
+      extend self # makes all instance methods become module methods as well
+
+      def load(string)
+        ActiveSupport::JSON.decode string
+      end
+
+      def dump(object)
+        ActiveSupport::JSON.encode object
+      end
+    end
+  end
+end

data/lib/paper_trail/serializers/yaml.rb

@@ -2,13 +2,15 @@ require 'yaml'
 
 module PaperTrail
   module Serializers
-    class Yaml
-      def self.load(string)
+    module Yaml
+      extend self # makes all instance methods become module methods as well
+
+      def load(string)
         YAML.load string
       end
 
-      def self.dump(hash)
-        YAML.dump hash
+      def dump(object)
+        YAML.dump object
       end
     end
   end

data/lib/paper_trail/version.rb

@@ -79,10 +79,10 @@ class Version < ActiveRecord::Base
           model = klass.new
         end
 
-        model.class.unserialize_attributes attrs
+        model.class.unserialize_attributes_for_paper_trail attrs
         attrs.each do |k, v|
           if model.respond_to?("#{k}=")
-            model.send :write_attribute, k.to_sym, v
+            model[k.to_sym] = v
           else
             logger.warn "Attribute #{k} does not exist on #{item_type} (Version id: #{id})."
           end
@@ -102,15 +102,13 @@ class Version < ActiveRecord::Base
   # Returns what changed in this version of the item.  Cf. `ActiveModel::Dirty#changes`.
   # Returns nil if your `versions` table does not have an `object_changes` text column.
   def changeset
-    if self.class.column_names.include? 'object_changes'
-      if changes = object_changes
-        HashWithIndifferentAccess[PaperTrail.serializer.load(changes)].tap do |changes|
-          item_type.constantize.unserialize_attribute_changes(changes)
-        end
-      else
-        {}
-      end
+    return nil unless self.class.column_names.include? 'object_changes'
+
+    HashWithIndifferentAccess.new(PaperTrail.serializer.load(object_changes)).tap do |changes|
+      item_type.constantize.unserialize_attribute_changes(changes)
     end
+  rescue
+    {}
   end
 
   # Returns who put the item into the state stored in this version.

data/lib/paper_trail/version_number.rb

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

data/paper_trail.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'activerecord', '~> 3.0'
 
   s.add_development_dependency 'rake'
-  s.add_development_dependency 'shoulda',      '~> 3.3'
-  s.add_development_dependency 'sqlite3',      '~> 1.2'
-  s.add_development_dependency 'capybara',     '~> 2.0'
+  s.add_development_dependency 'shoulda', '~> 3.3'
+  s.add_development_dependency 'sqlite3', '~> 1.2'
+  s.add_development_dependency 'ffaker', '>= 1.15'
 end

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

@@ -0,0 +1,3 @@
+class ProtectedWidget < Widget
+  attr_accessible :name, :a_text
+end

data/test/dummy/config/application.rb

@@ -5,7 +5,7 @@ require "active_record/railtie"
 require "action_controller/railtie"
 require "action_view/railtie"
 
-Bundler.require
+Bundler.require(:default, Rails.env) if defined?(Bundler)
 require 'paper_trail'
 
 module Dummy
@@ -32,13 +32,33 @@ module Dummy
     # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
     # config.i18n.default_locale = :de
 
-    # JavaScript files you want as :defaults (application.js is always included).
-    # config.action_view.javascript_expansions[:defaults] = %w(jquery rails)
-
     # Configure the default encoding used in templates for Ruby 1.9.
     config.encoding = "utf-8"
 
     # Configure sensitive parameters which will be filtered from the log file.
     config.filter_parameters += [:password]
+
+    # Enable escaping HTML in JSON.
+    config.active_support.escape_html_entities_in_json = true
+
+    # Use SQL instead of Active Record's schema dumper when creating the database.
+    # This is necessary if your schema can't be completely dumped by the schema dumper,
+    # like if you have constraints or database-specific column types
+    # config.active_record.schema_format = :sql
+
+    # Enforce whitelist mode for mass assignment.
+    # This will create an empty whitelist of attributes available for mass-assignment for all models
+    # in your app. As such, your models will need to explicitly whitelist or blacklist accessible
+    # parameters by using an attr_accessible or attr_protected declaration.
+    #
+    # This is uncommented in new rails apps by default but for our testing purposes its more convenient
+    # to leave it commented out.
+    # config.active_record.whitelist_attributes = true
+
+    # Enable the asset pipeline
+    config.assets.enabled = false
+
+    # Version of your assets, change this if you want to expire all your assets
+    # config.assets.version = '1.0'
   end
 end

data/test/dummy/config/environments/development.rb

@@ -2,8 +2,8 @@ Dummy::Application.configure do
   # Settings specified here will take precedence over those in config/application.rb
 
   # In the development environment your application's code is reloaded on
-  # every request.  This slows down response time but is perfect for development
-  # since you don't have to restart the webserver when you make code changes.
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
   config.cache_classes = false
 
   # Log error messages when you accidentally call methods on nil.
@@ -11,16 +11,28 @@ Dummy::Application.configure do
 
   # Show full error reports and disable caching
   config.consider_all_requests_local       = true
-  config.action_view.debug_rjs             = true
   config.action_controller.perform_caching = false
 
   # Don't care if the mailer can't send
-  config.action_mailer.raise_delivery_errors = false
+  # config.action_mailer.raise_delivery_errors = false
 
   # Print deprecation notices to the Rails logger
   config.active_support.deprecation = :log
 
   # Only use best-standards-support built into browsers
   config.action_dispatch.best_standards_support = :builtin
+
+  # Raise exception on mass assignment protection for Active Record models
+  config.active_record.mass_assignment_sanitizer = :strict
+
+  # Log the query plan for queries taking more than this (works
+  # with SQLite, MySQL, and PostgreSQL)
+  config.active_record.auto_explain_threshold_in_seconds = 0.5
+
+  # Do not compress assets
+  config.assets.compress = false
+
+  # Expands the lines which load the assets
+  config.assets.debug = true
 end
 

data/test/dummy/config/environments/production.rb

@@ -1,7 +1,6 @@
 Dummy::Application.configure do
   # Settings specified here will take precedence over those in config/application.rb
 
-  # The production environment is meant for finished, "live" apps.
   # Code is not reloaded between requests
   config.cache_classes = true
 
@@ -9,31 +8,46 @@ Dummy::Application.configure do
   config.consider_all_requests_local       = false
   config.action_controller.perform_caching = true
 
-  # Specifies the header that your server uses for sending files
-  config.action_dispatch.x_sendfile_header = "X-Sendfile"
+  # Disable Rails's static asset server (Apache or nginx will already do this)
+  config.serve_static_assets = false
+
+  # Compress JavaScripts and CSS
+  config.assets.compress = true
+
+  # Don't fallback to assets pipeline if a precompiled asset is missed
+  config.assets.compile = false
+
+  # Generate digests for assets URLs
+  config.assets.digest = true
+
+  # Defaults to nil and saved in location specified by config.assets.prefix
+  # config.assets.manifest = YOUR_PATH
 
-  # For nginx:
-  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect'
+  # Specifies the header that your server uses for sending files
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
 
-  # If you have no front-end server that supports something like X-Sendfile,
-  # just comment this out and Rails will serve the files
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
 
   # See everything in the log (default is :info)
   # config.log_level = :debug
 
+  # Prepend all log lines with the following tags
+  # config.log_tags = [ :subdomain, :uuid ]
+
   # Use a different logger for distributed setups
-  # config.logger = SyslogLogger.new
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
 
   # Use a different cache store in production
   # config.cache_store = :mem_cache_store
 
-  # Disable Rails's static asset server
-  # In production, Apache or nginx will already do this
-  config.serve_static_assets = false
-
-  # Enable serving of images, stylesheets, and javascripts from an asset server
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server
   # config.action_controller.asset_host = "http://assets.example.com"
 
+  # Precompile additional assets (application.js, application.css, and all non-JS/CSS are already added)
+  # config.assets.precompile += %w( search.js )
+
   # Disable delivery errors, bad email addresses will be ignored
   # config.action_mailer.raise_delivery_errors = false
 
@@ -46,4 +60,8 @@ Dummy::Application.configure do
 
   # Send deprecation notices to registered listeners
   config.active_support.deprecation = :notify
+
+  # Log the query plan for queries taking more than this (works
+  # with SQLite, MySQL, and PostgreSQL)
+  # config.active_record.auto_explain_threshold_in_seconds = 0.5
 end

data/test/dummy/config/environments/test.rb

@@ -2,12 +2,16 @@ Dummy::Application.configure do
   # Settings specified here will take precedence over those in config/application.rb
 
   # The test environment is used exclusively to run your application's
-  # test suite.  You never need to work with it otherwise.  Remember that
+  # test suite. You never need to work with it otherwise. Remember that
   # your test database is "scratch space" for the test suite and is wiped
-  # and recreated between test runs.  Don't rely on the data there!
+  # and recreated between test runs. Don't rely on the data there!
   config.cache_classes = true
 
-  # Log error messages when you accidentally call methods on nil.
+  # Configure static asset server for tests with Cache-Control for performance
+  config.serve_static_assets = true
+  config.static_cache_control = "public, max-age=3600"
+
+  # Log error messages when you accidentally call methods on nil
   config.whiny_nils = true
 
   # Show full error reports and disable caching
@@ -18,17 +22,15 @@ Dummy::Application.configure do
   config.action_dispatch.show_exceptions = false
 
   # Disable request forgery protection in test environment
-  config.action_controller.allow_forgery_protection    = false
+  config.action_controller.allow_forgery_protection = false
 
   # Tell Action Mailer not to deliver emails to the real world.
   # The :test delivery method accumulates sent emails in the
   # ActionMailer::Base.deliveries array.
-  config.action_mailer.delivery_method = :test if config.respond_to?(:action_mailer)
+  # config.action_mailer.delivery_method = :test
 
-  # Use SQL instead of Active Record's schema dumper when creating the test database.
-  # This is necessary if your schema can't be completely dumped by the schema dumper,
-  # like if you have constraints or database-specific column types
-  # config.active_record.schema_format = :sql
+  # Raise exception on mass assignment protection for Active Record models
+  config.active_record.mass_assignment_sanitizer = :strict
 
   # Print deprecation notices to the stderr
   config.active_support.deprecation = :stderr

data/test/dummy/config/initializers/paper_trail.rb

@@ -0,0 +1,3 @@
+class Version < ActiveRecord::Base
+  attr_accessible :created_at, :updated_at, :answer, :action, :question, :article_id, :ip, :user_agent, :title
+end

data/test/test_helper.rb

@@ -11,11 +11,7 @@ require "rails/test_help"
 Rails.backtrace_cleaner.remove_silencers!
 
 require 'shoulda'
-
-# Configure capybara for integration testing
-require "capybara/rails"
-Capybara.default_driver   = :rack_test
-Capybara.default_selector = :css
+require 'ffaker'
 
 # Run any available migration
 ActiveRecord::Migrator.migrate File.expand_path("../dummy/db/migrate/", __FILE__)
@@ -42,8 +38,3 @@ def change_schema
   end
   ActiveRecord::Migration.verbose = true
 end
-
-class Version < ActiveRecord::Base
-  attr_accessible :created_at, :updated_at,
-    :answer, :action, :question, :article_id, :ip, :user_agent, :title
-end

data/test/unit/model_test.rb

@@ -4,6 +4,7 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
 
   context 'A record with defined "only" and "ignore" attributes' do
     setup { @article = Article.create }
+    should 'creation should change the number of versions' do assert_equal(1, Version.count) end
 
     context 'which updates an ignored column' do
       setup { @article.update_attributes :title => 'My first title' }
@@ -14,6 +15,10 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
       setup { @article.update_attributes :title => 'My first title', :content => 'Some text here.' }
       should 'change the number of versions' do assert_equal(2, Version.count) end
 
+      should "show the new version in the model's `versions` association" do
+        assert_equal(2, @article.versions.size)
+      end
+
       should 'have stored only non-ignored attributes' do
         assert_equal ({'content' => [nil, 'Some text here.']}), @article.versions.last.changeset
       end
@@ -22,6 +27,10 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
     context 'which updates a selected column' do
       setup { @article.update_attributes :content => 'Some text here.' }
       should 'change the number of versions' do assert_equal(2, Version.count) end
+
+      should "show the new version in the model's `versions` association" do
+        assert_equal(2, @article.versions.size)
+      end
     end
 
     context 'which updates a non-ignored and non-selected column' do
@@ -38,6 +47,10 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
       setup { @article.update_attributes :file_upload => 'Your data goes here', :content => 'Some text here.' }
       should 'change the number of versions' do assert_equal(2, Version.count) end
 
+      should "show the new version in the model's `versions` association" do
+        assert_equal(2, @article.versions.size)
+      end
+
       should 'have stored only non-skipped attributes' do
         assert_equal ({'content' => [nil, 'Some text here.']}), @article.versions.last.changeset
       end
@@ -57,6 +70,15 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
         end
       end
     end
+
+    context 'which gets destroyed' do
+      setup { @article.destroy }
+      should 'change the number of versions' do assert_equal(2, Version.count) end
+
+      should "show the new version in the model's `versions` association" do
+        assert_equal(2, @article.versions.size)
+      end
+    end
   end
 
   context 'A record with defined "ignore" attribute' do
@@ -111,11 +133,19 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
         context 'after update' do
           setup { @translation.update_attributes :content => 'Content' }
           should 'change the number of versions' do assert_equal(2, Version.count) end
+
+          should "show the new version in the model's `versions` association" do
+            assert_equal(2, @translation.versions.size)
+          end
         end
 
         context 'after destroy' do
           setup { @translation.destroy }
           should 'change the number of versions' do assert_equal(2, Version.count) end
+
+          should "show the new version in the model's `versions` association" do
+            assert_equal(2, @translation.versions.size)
+          end
         end
       end
     end
@@ -765,10 +795,10 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
       end
 
       should 'have a previous version' do
-        assert_equal @widget.versions.last.reify, @widget.previous_version
+        assert_equal @widget.versions.last.reify.name, @widget.previous_version.name
       end
 
-      should 'have a next version' do
+      should 'not have a next version' do
         assert_nil @widget.next_version
       end
     end
@@ -776,21 +806,20 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
 
   context 'A reified item' do
     setup do
-      widget = Widget.create :name => 'Bob'
-      %w( Tom Dick Jane ).each { |name| widget.update_attributes :name => name }
-      @versions      = widget.versions
-      @second_widget = @versions[1].reify  # first widget is null
-      @last_widget   = @versions.last.reify
+      @widget = Widget.create :name => 'Bob'
+      %w(Tom Dick Jane).each { |name| @widget.update_attributes :name => name }
+      @second_widget = @widget.versions[1].reify  # first widget is `nil`
+      @last_widget   = @widget.versions.last.reify
     end
 
     should 'have a previous version' do
-      assert_nil @second_widget.previous_version
-      assert_equal @versions[-2].reify, @last_widget.previous_version
+      assert_nil @second_widget.previous_version # `create` events return `nil` for `reify`
+      assert_equal @widget.versions[-2].reify.name, @last_widget.previous_version.name
     end
 
     should 'have a next version' do
-      assert_equal @versions[2].reify, @second_widget.next_version
-      assert_nil @last_widget.next_version
+      assert_equal @widget.versions[2].reify.name, @second_widget.next_version.name
+      assert_equal @last_widget.next_version.name, @widget.name
     end
   end
 
@@ -1076,7 +1105,11 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
       assert_equal 2, @doc.paper_trail_versions.length
     end
 
-    should 'respond to previous_version as normal' do
+    should 'respond to `next_version` as normal' do
+      assert_equal @doc.paper_trail_versions.last.reify.next_version.name, @doc.name
+    end
+
+    should 'respond to `previous_version` as normal' do
       @doc.update_attributes :name => 'Doc 2'
       assert_equal 3, @doc.paper_trail_versions.length
       assert_equal 'Doc 1', @doc.previous_version.name

data/test/unit/protected_attrs_test.rb

@@ -0,0 +1,41 @@
+require 'test_helper'
+
+class ProtectedAttrsTest < ActiveSupport::TestCase
+  subject { ProtectedWidget.new }
+
+  accessible_attrs = ProtectedWidget.accessible_attributes.to_a
+  accessible_attrs.each do |attr_name|
+    should allow_mass_assignment_of(attr_name.to_sym)
+  end
+  ProtectedWidget.column_names.reject { |column_name| accessible_attrs.include?(column_name) }.each do |attr_name|
+    should_not allow_mass_assignment_of(attr_name.to_sym)
+  end
+
+  context 'A model with `attr_accessible` created' do
+    setup do
+      @widget = ProtectedWidget.create! :name => 'Henry'
+      @initial_attributes = @widget.attributes
+    end
+
+    should 'be `nil` in its previous version' do
+      assert_nil @widget.previous_version
+    end
+
+    context 'which is then updated' do
+      setup do
+        @widget.assign_attributes(:name => 'Jeff', :a_text => 'Short statement')
+        @widget.an_integer = 42
+        @widget.save!
+      end
+
+      should 'not be `nil` in its previous version' do
+        assert_not_nil @widget.previous_version
+      end
+
+      should 'the previous version should contain right attributes' do
+        assert_equal @widget.previous_version.attributes, @initial_attributes
+      end
+    end
+
+  end
+end

data/test/unit/serializer_test.rb

@@ -1,16 +1,5 @@
 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
@@ -20,6 +9,7 @@ class SerializerTest < ActiveSupport::TestCase
       END
 
       @fluxor = Fluxor.create :name => 'Some text.'
+      @original_fluxor_attributes = @fluxor.send(:item_before_change).attributes # this is exactly what PaperTrail serializes
       @fluxor.update_attributes :name => 'Some more text.'
     end
 
@@ -29,24 +19,28 @@ class SerializerTest < ActiveSupport::TestCase
       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)
-
+      assert_equal @original_fluxor_attributes, YAML.load(@fluxor.versions[1].object)
+      # This test can't consistently pass in Ruby1.8 because hashes do no preserve order, which means the order of the
+      # attributes in the YAML can't be ensured.
+      if RUBY_VERSION.to_f >= 1.9
+        assert_equal YAML.dump(@original_fluxor_attributes), @fluxor.versions[1].object
+      end
     end
   end
 
   context 'Custom Serializer' do
     setup do
-      PaperTrail.config.serializer = CustomSerializer
+      PaperTrail.configure do |config|
+        config.serializer = PaperTrail::Serializers::Json
+      end
 
       Fluxor.instance_eval <<-END
         has_paper_trail
       END
 
       @fluxor = Fluxor.create :name => 'Some text.'
+      @original_fluxor_attributes = @fluxor.send(:item_before_change).attributes # this is exactly what PaperTrail serializes
       @fluxor.update_attributes :name => 'Some more text.'
     end
 
@@ -54,17 +48,26 @@ class SerializerTest < ActiveSupport::TestCase
       PaperTrail.config.serializer = PaperTrail::Serializers::Yaml
     end
 
-    should 'work with custom serializer' do
+    should 'reify 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)
+      assert_equal @original_fluxor_attributes, ActiveSupport::JSON.decode(@fluxor.versions[1].object)
+      # This test can't consistently pass in Ruby1.8 because hashes do no preserve order, which means the order of the
+      # attributes in the JSON can't be ensured.
+      if RUBY_VERSION.to_f >= 1.9
+        assert_equal ActiveSupport::JSON.encode(@original_fluxor_attributes), @fluxor.versions[1].object
+      end
+    end
 
+    should 'store object_changes' do
+      initial_changeset = {"name" => [nil, "Some text."], "id" => [nil, 1]}
+      second_changeset =  {"name"=>["Some text.", "Some more text."]}
+      assert_equal initial_changeset, @fluxor.versions[0].changeset
+      assert_equal second_changeset,  @fluxor.versions[1].changeset
     end
   end
 

data/test/unit/serializers/json_test.rb

@@ -0,0 +1,40 @@
+require 'test_helper'
+
+class JsonTest < ActiveSupport::TestCase
+
+  setup do
+    # Setup a hash with random values
+    @hash = {}
+    (1..4).each do |i|
+      @hash["key#{i}"] = Faker::Lorem.word
+    end
+    @hash_as_json = @hash.to_json
+    # Setup an array of random words
+    @array = []
+    (rand(5) + 4).times { @array << Faker::Lorem.word }
+    @array_as_json = @array.to_json
+  end
+
+  context '`load` class method' do
+    should 'exist' do
+      assert PaperTrail::Serializers::Json.respond_to?(:load)
+    end
+
+    should '`deserialize` JSON to Ruby' do
+      assert_equal @hash, PaperTrail::Serializers::Json.load(@hash_as_json)
+      assert_equal @array, PaperTrail::Serializers::Json.load(@array_as_json)
+    end
+  end
+
+  context '`dump` class method' do
+    should 'exist' do
+      assert PaperTrail::Serializers::Json.respond_to?(:dump)
+    end
+
+    should '`serialize` Ruby to JSON' do
+      assert_equal @hash_as_json, PaperTrail::Serializers::Json.dump(@hash)
+      assert_equal @array_as_json, PaperTrail::Serializers::Json.dump(@array)
+    end
+  end
+
+end

data/test/unit/serializers/mixin_json_test.rb

@@ -0,0 +1,48 @@
+require 'test_helper'
+
+module CustomJsonSerializer
+  extend PaperTrail::Serializers::Json
+
+  def self.load(string)
+    parsed_value = super(string)
+    parsed_value.is_a?(Hash) ? parsed_value.reject { |k,v| k.blank? || v.blank? } : parsed_value
+  end
+
+  def self.dump(object)
+    object.is_a?(Hash) ? super(object.reject { |k,v| v.nil? }) : super
+  end
+end
+
+class MixinJsonTest < ActiveSupport::TestCase
+
+  setup do
+    # Setup a hash with random values, ensuring some values are nil
+    @hash = {}
+    (1..4).each do |i|
+      @hash["key#{i}"] = [Faker::Lorem.word, nil].sample
+    end
+    @hash['tkey'] = nil
+    @hash[''] = 'foo'
+    @hash_as_json = @hash.to_json
+  end
+
+  context '`load` class method' do
+    should 'exist' do
+      assert CustomJsonSerializer.respond_to?(:load)
+    end
+
+    should '`deserialize` JSON to Ruby, removing pairs with `blank` keys or values' do
+      assert_equal @hash.reject { |k,v| k.blank? || v.blank? }, CustomJsonSerializer.load(@hash_as_json)
+    end
+  end
+
+  context '`dump` class method' do
+    should 'exist' do
+      assert CustomJsonSerializer.respond_to?(:dump)
+    end
+
+    should '`serialize` Ruby to JSON, removing pairs with `nil` values' do
+      assert_equal @hash.reject { |k,v| v.nil? }.to_json, CustomJsonSerializer.dump(@hash)
+    end
+  end
+end

data/test/unit/serializers/mixin_yaml_test.rb

@@ -0,0 +1,49 @@
+require 'test_helper'
+
+module CustomYamlSerializer
+  extend PaperTrail::Serializers::Yaml
+
+  def self.load(string)
+    parsed_value = super(string)
+    parsed_value.is_a?(Hash) ? parsed_value.reject { |k,v| k.blank? || v.blank? } : parsed_value
+  end
+
+  def self.dump(object)
+    object.is_a?(Hash) ? super(object.reject { |k,v| v.nil? }) : super
+  end
+end
+
+class MixinYamlTest < ActiveSupport::TestCase
+
+  setup do
+    # Setup a hash with random values, ensuring some values are nil
+    @hash = {}
+    (1..4).each do |i|
+      @hash["key#{i}"] = [Faker::Lorem.word, nil].sample
+    end
+    @hash['tkey'] = nil
+    @hash[''] = 'foo'
+    @hash_as_yaml = @hash.to_yaml
+  end
+
+  context '`load` class method' do
+    should 'exist' do
+      assert CustomYamlSerializer.respond_to?(:load)
+    end
+
+    should '`deserialize` YAML to Ruby, removing pairs with `blank` keys or values' do
+      assert_equal @hash.reject { |k,v| k.blank? || v.blank? }, CustomYamlSerializer.load(@hash_as_yaml)
+    end
+  end
+
+  context '`dump` class method' do
+    should 'exist' do
+      assert CustomYamlSerializer.respond_to?(:dump)
+    end
+
+    should '`serialize` Ruby to YAML, removing pairs with `nil` values' do
+      assert_equal @hash.reject { |k,v| v.nil? }.to_yaml, CustomYamlSerializer.dump(@hash)
+    end
+  end
+
+end

data/test/unit/serializers/yaml_test.rb

@@ -0,0 +1,40 @@
+require 'test_helper'
+
+class YamlTest < ActiveSupport::TestCase
+
+  setup do
+    # Setup a hash with random values
+    @hash = {}
+    (1..4).each do |i|
+      @hash["key#{i}".to_sym] = Faker::Lorem.word
+    end
+    @hash_as_yaml = @hash.to_yaml
+    # Setup an array of random words
+    @array = []
+    (rand(5) + 4).times { @array << Faker::Lorem.word }
+    @array_as_yaml = @array.to_yaml
+  end
+
+  context '`load` class method' do
+    should 'exist' do
+      assert PaperTrail::Serializers::Yaml.respond_to?(:load)
+    end
+
+    should '`deserialize` YAML to Ruby' do
+      assert_equal @hash, PaperTrail::Serializers::Yaml.load(@hash_as_yaml)
+      assert_equal @array, PaperTrail::Serializers::Yaml.load(@array_as_yaml)
+    end
+  end
+
+  context '`dump` class method' do
+    should 'exist' do
+      assert PaperTrail::Serializers::Yaml.respond_to?(:dump)
+    end
+
+    should '`serialize` Ruby to YAML' do
+      assert_equal @hash_as_yaml, PaperTrail::Serializers::Yaml.dump(@hash)
+      assert_equal @array_as_yaml, PaperTrail::Serializers::Yaml.dump(@array)
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paper_trail
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.7.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-28 00:00:00.000000000 Z
+date: 2013-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -92,21 +92,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.2'
 - !ruby/object:Gem::Dependency
-  name: capybara
+  name: ffaker
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '1.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '1.15'
 description: Track changes to your models' data.  Good for auditing or versioning.
 email: boss@airbladesoftware.com
 executables: []
@@ -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/json.rb
 - lib/paper_trail/serializers/yaml.rb
 - lib/paper_trail/version.rb
 - lib/paper_trail/version_number.rb
@@ -150,6 +151,7 @@ files:
 - test/dummy/app/models/legacy_widget.rb
 - test/dummy/app/models/person.rb
 - test/dummy/app/models/post.rb
+- test/dummy/app/models/protected_widget.rb
 - test/dummy/app/models/song.rb
 - test/dummy/app/models/translation.rb
 - test/dummy/app/models/widget.rb
@@ -167,6 +169,7 @@ files:
 - test/dummy/config/initializers/backtrace_silencers.rb
 - test/dummy/config/initializers/inflections.rb
 - test/dummy/config/initializers/mime_types.rb
+- test/dummy/config/initializers/paper_trail.rb
 - test/dummy/config/initializers/secret_token.rb
 - test/dummy/config/initializers/session_store.rb
 - test/dummy/config/locales/en.yml
@@ -187,13 +190,16 @@ files:
 - test/dummy/script/rails
 - test/functional/controller_test.rb
 - test/functional/thread_safety_test.rb
-- test/integration/navigation_test.rb
 - test/paper_trail_test.rb
-- test/support/integration_case.rb
 - test/test_helper.rb
 - test/unit/inheritance_column_test.rb
 - test/unit/model_test.rb
+- test/unit/protected_attrs_test.rb
 - test/unit/serializer_test.rb
+- test/unit/serializers/json_test.rb
+- test/unit/serializers/mixin_json_test.rb
+- test/unit/serializers/mixin_yaml_test.rb
+- test/unit/serializers/yaml_test.rb
 - test/unit/timestamp_test.rb
 - test/unit/version_test.rb
 homepage: http://github.com/airblade/paper_trail
@@ -239,6 +245,7 @@ test_files:
 - test/dummy/app/models/legacy_widget.rb
 - test/dummy/app/models/person.rb
 - test/dummy/app/models/post.rb
+- test/dummy/app/models/protected_widget.rb
 - test/dummy/app/models/song.rb
 - test/dummy/app/models/translation.rb
 - test/dummy/app/models/widget.rb
@@ -256,6 +263,7 @@ test_files:
 - test/dummy/config/initializers/backtrace_silencers.rb
 - test/dummy/config/initializers/inflections.rb
 - test/dummy/config/initializers/mime_types.rb
+- test/dummy/config/initializers/paper_trail.rb
 - test/dummy/config/initializers/secret_token.rb
 - test/dummy/config/initializers/session_store.rb
 - test/dummy/config/locales/en.yml
@@ -276,12 +284,15 @@ test_files:
 - test/dummy/script/rails
 - test/functional/controller_test.rb
 - test/functional/thread_safety_test.rb
-- test/integration/navigation_test.rb
 - test/paper_trail_test.rb
-- test/support/integration_case.rb
 - test/test_helper.rb
 - test/unit/inheritance_column_test.rb
 - test/unit/model_test.rb
+- test/unit/protected_attrs_test.rb
 - test/unit/serializer_test.rb
+- test/unit/serializers/json_test.rb
+- test/unit/serializers/mixin_json_test.rb
+- test/unit/serializers/mixin_yaml_test.rb
+- test/unit/serializers/yaml_test.rb
 - test/unit/timestamp_test.rb
 - test/unit/version_test.rb

data/test/integration/navigation_test.rb

@@ -1,7 +0,0 @@
-require 'test_helper'
-
-class NavigationTest < ActiveSupport::IntegrationCase
-  test 'Sanity test' do
-    assert_kind_of Dummy::Application, Rails.application
-  end
-end

data/test/support/integration_case.rb

@@ -1,5 +0,0 @@
-# Define a bare test case to use with Capybara
-class ActiveSupport::IntegrationCase < ActiveSupport::TestCase
-  include Capybara::DSL
-  include Rails.application.routes.url_helpers
-end