paper_trail 3.0.0.beta1 → 3.0.0.rc1

data/lib/paper_trail/version_number.rb

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

data/paper_trail.gemspec

@@ -4,11 +4,13 @@ require 'paper_trail/version_number'
 Gem::Specification.new do |s|
   s.name          = 'paper_trail'
   s.version       = PaperTrail::VERSION
+  s.platform      = Gem::Platform::RUBY
   s.summary       = "Track changes to your models' data.  Good for auditing or versioning."
   s.description   = s.summary
   s.homepage      = 'http://github.com/airblade/paper_trail'
   s.authors       = ['Andy Stewart', 'Ben Atkins']
   s.email         = 'boss@airbladesoftware.com'
+  s.license       = 'MIT'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
@@ -16,10 +18,10 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
 
   s.add_dependency 'activerecord', ['>= 3.0', '< 5.0']
+  s.add_dependency 'activesupport', ['>= 3.0', '< 5.0']
 
   s.add_development_dependency 'rake'
   s.add_development_dependency 'shoulda', '~> 3.5'
-  # s.add_development_dependency 'shoulda-matchers', '~> 1.5'
   s.add_development_dependency 'ffaker',  '>= 1.15'
   s.add_development_dependency 'railties', ['>= 3.0', '< 5.0']
   s.add_development_dependency 'sinatra', '~> 1.0'
@@ -30,6 +32,6 @@ Gem::Specification.new do |s|
   unless defined?(JRUBY_VERSION)
     s.add_development_dependency 'sqlite3', '~> 1.2'
   else
-    s.add_development_dependency 'activerecord-jdbcsqlite3-adapter', ['>= 1.3.0.rc1', '< 1.4']
+    s.add_development_dependency 'activerecord-jdbcsqlite3-adapter', '~> 1.3'
   end
 end

data/spec/models/version_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe PaperTrail::Version do
+  it "should include the `VersionConcern` module to get base functionality" do
+    PaperTrail::Version.should include(PaperTrail::VersionConcern)
+  end
+
+  describe "Attributes" do
+    it { should have_db_column(:item_type).of_type(:string) }
+    it { should have_db_column(:item_id).of_type(:integer) }
+    it { should have_db_column(:event).of_type(:string) }
+    it { should have_db_column(:whodunnit).of_type(:string) }
+    it { should have_db_column(:object).of_type(:text) }
+    it { should have_db_column(:created_at).of_type(:datetime) }
+  end
+
+  describe "Indexes" do
+    it { should have_db_index([:item_type, :item_id]) }
+  end
+
+  describe "Methods" do
+    describe "Instance" do
+      subject { PaperTrail::Version.new(attributes) rescue PaperTrail::Version.new }
+
+      describe :terminator do
+        it { should respond_to(:terminator) }
+
+        let(:attributes) { {:whodunnit => Faker::Name.first_name} }
+
+        it "is an alias for the `whodunnit` attribute" do
+          subject.whodunnit.should == attributes[:whodunnit]
+        end
+      end
+
+      describe :version_author do
+        it { should respond_to(:terminator) }
+
+        it "should be an alias for the `terminator` method" do
+          subject.method(:version_author).should == subject.method(:terminator)
+        end
+      end
+    end
+  end
+end

data/spec/models/widget_spec.rb

@@ -1,13 +1,23 @@
 require 'spec_helper'
 
 describe Widget do
-  it { should be_versioned }
+  describe '`be_versioned` matcher' do
+    it { should be_versioned }
+  end
+
+  describe "`versioning` option" do
+    let(:widget) { Widget.create :name => 'Bob', :an_integer => 1 }
+
+    context :enabled, :versioning => true do
+      it 'should enable versioning for models wrapped within a block' do
+        widget.versions.size.should == 1
+      end
+    end
 
-  context 'be_versioned matcher', :versioning => true do
-    it 'should respond to be_versioned' do
-      widget = Widget.create :name => 'Bob', :an_integer => 1
-      widget.should be_versioned
-      widget.versions.size.should == 1
+    context '`disabled` (default)' do
+      it 'should not enable versioning for models wrapped within a block not marked to used versioning' do
+        widget.versions.size.should == 0
+      end
     end
   end
 end

data/spec/modules/version_concern_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe PaperTrail::VersionConcern do
+
+  before(:all) do
+    module Foo
+      class Base < ActiveRecord::Base
+        self.abstract_class = true
+      end
+
+      class Document < Base
+        has_paper_trail :class_name => 'Foo::Version'
+      end
+
+      class Version < Base
+        include PaperTrail::VersionConcern
+      end
+    end
+    Foo::Base.establish_connection(:adapter => 'sqlite3', :database => File.expand_path('../../../test/dummy/db/test-foo.sqlite3', __FILE__))
+
+    module Bar
+      class Base < ActiveRecord::Base
+        self.abstract_class = true
+      end
+
+      class Document < Base
+        has_paper_trail :class_name => 'Bar::Version'
+      end
+
+      class Version < Base
+        include PaperTrail::VersionConcern
+      end
+    end
+    Bar::Base.establish_connection(:adapter => 'sqlite3', :database => File.expand_path('../../../test/dummy/db/test-bar.sqlite3', __FILE__))
+  end
+
+  it 'allows included class to have different connections' do
+    Foo::Version.connection.should_not eq Bar::Version.connection
+  end
+
+  it 'allows custom version class to share connection with superclass' do
+    Foo::Version.connection.should eq Foo::Document.connection
+    Bar::Version.connection.should eq Bar::Document.connection
+  end
+
+  it 'can be used with class_name option' do
+    Foo::Document.version_class_name.should eq 'Foo::Version'
+    Bar::Document.version_class_name.should eq 'Bar::Version'
+  end
+end

data/spec/paper_trail_spec.rb

@@ -1,31 +1,29 @@
 require 'spec_helper'
 
 describe "PaperTrail RSpec Helper" do
-  describe :enabled do
-    context 'default' do
-      it 'should have versioning off by default' do
-        ::PaperTrail.should_not be_enabled
-      end
-      it 'should turn versioning on in a with_versioning block' do
-        ::PaperTrail.should_not be_enabled
-        with_versioning do
-          ::PaperTrail.should be_enabled
-        end
-        ::PaperTrail.should_not be_enabled
-      end
+  context 'default' do
+    it 'should have versioning off by default' do
+      ::PaperTrail.should_not be_enabled
     end
-
-    context 'versioning: true', :versioning => true do
-      it 'should have versioning on by default' do
+    it 'should turn versioning on in a with_versioning block' do
+      ::PaperTrail.should_not be_enabled
+      with_versioning do
         ::PaperTrail.should be_enabled
       end
-      it 'should keep versioning on after a with_versioning block' do
-        ::PaperTrail.should be_enabled
-        with_versioning do
-          ::PaperTrail.should be_enabled
-        end
+      ::PaperTrail.should_not be_enabled
+    end
+  end
+
+  context '`versioning: true`', :versioning => true do
+    it 'should have versioning on by default' do
+      ::PaperTrail.should be_enabled
+    end
+    it 'should keep versioning on after a with_versioning block' do
+      ::PaperTrail.should be_enabled
+      with_versioning do
         ::PaperTrail.should be_enabled
       end
+      ::PaperTrail.should be_enabled
     end
   end
 

data/spec/spec_helper.rb

@@ -1,8 +1,10 @@
 ENV["RAILS_ENV"] ||= 'test'
-require File.expand_path('../../test/dummy/config/environment', __FILE__)
 
+require File.expand_path('../../test/dummy/config/environment', __FILE__)
 require 'rspec/rails'
 require 'rspec/autorun'
+require 'shoulda/matchers'
+require 'ffaker'
 
 # Requires supporting ruby files with custom matchers and macros, etc,
 # in spec/support/ and its subdirectories.

data/test/custom_json_serializer.rb

@@ -1,6 +1,6 @@
 # This custom serializer excludes nil values
 module CustomJsonSerializer
-  extend PaperTrail::Serializers::Json
+  extend PaperTrail::Serializers::JSON
 
   def self.load(string)
     parsed_value = super(string)

data/test/dummy/app/controllers/articles_controller.rb

@@ -0,0 +1,10 @@
+class ArticlesController < ApplicationController
+  def create
+    if PaperTrail.active_record_protected_attributes?
+      @article = Article.create params[:article]
+    else
+      @article = Article.create params.require(:article).permit!
+    end
+    head :ok
+  end
+end

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

@@ -1,6 +1,6 @@
 class Article < ActiveRecord::Base
-  has_paper_trail :ignore => :title,
-                  :only => [:content],
+  has_paper_trail :ignore => [:title, { :abstract => Proc.new { |obj| ['ignore abstract', 'Other abstract'].include? obj.abstract } } ],
+                  :only => [:content, { :abstract => Proc.new { |obj| obj.abstract.present? } } ],
                   :skip => [:file_upload],
                   :meta => {
                               :answer => 42,

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

@@ -1,4 +1,8 @@
 class Wotsit < ActiveRecord::Base
   has_paper_trail
   belongs_to :widget
+
+  def created_on
+    created_at.to_date
+  end
 end

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

@@ -27,7 +27,7 @@ Dummy::Application.configure do
 
   # 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
+  # config.active_record.auto_explain_threshold_in_seconds = 0.5
 
   # Do not compress assets
   config.assets.compress = false

data/test/dummy/config/routes.rb

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

data/test/functional/enabled_for_controller_test.rb

@@ -0,0 +1,29 @@
+require 'test_helper'
+
+class EnabledForControllerTest < ActionController::TestCase
+  tests ArticlesController
+
+  context "`PaperTrail.enabled? == true`" do
+    should 'enabled_for_controller?.should == true' do
+      assert PaperTrail.enabled?
+      post :create, :article => { :title => 'Doh', :content => Faker::Lorem.sentence }
+      assert_not_nil assigns(:article)
+      assert PaperTrail.enabled_for_controller?
+      assert_equal 1, assigns(:article).versions.length
+    end
+  end
+
+  context "`PaperTrail.enabled? == false`" do
+    setup { PaperTrail.enabled = false }
+    
+    should 'enabled_for_controller?.should == false' do
+      assert !PaperTrail.enabled?
+      post :create, :article => { :title => 'Doh', :content => Faker::Lorem.sentence }
+      assert !PaperTrail.enabled_for_controller?
+      assert_equal 0, assigns(:article).versions.length
+    end
+
+    teardown { PaperTrail.enabled = true }
+  end
+
+end

data/test/functional/modular_sinatra_test.rb

@@ -4,7 +4,7 @@ require 'sinatra/base'
 # --- Tests for modular `Sinatra::Base` style ----
 class BaseApp < Sinatra::Base
   ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => File.expand_path('../../dummy/db/test.sqlite3', __FILE__))
-  register Sinatra::PaperTrail
+  register PaperTrail::Sinatra
 
   get '/test' do
     Widget.create!(:name => 'foo')

data/test/functional/sinatra_test.rb

@@ -4,7 +4,7 @@ require 'test_helper'
 # --- Tests for non-modular `Sinatra::Application` style ----
 class Sinatra::Application
   ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => File.expand_path('../../dummy/db/test.sqlite3', __FILE__))
-  register Sinatra::PaperTrail # we shouldn't actually need this line if I'm not mistaken but the tests seem to fail without it ATM
+  register PaperTrail::Sinatra # we shouldn't actually need this line if I'm not mistaken but the tests seem to fail without it ATM
 
   get '/test' do
     Widget.create!(:name => 'bar')

data/test/test_helper.rb

@@ -3,16 +3,11 @@ ENV["RAILS_ENV"] = "test"
 
 require File.expand_path("../dummy/config/environment.rb",  __FILE__)
 require "rails/test_help"
-
-#ActionMailer::Base.delivery_method = :test
-#ActionMailer::Base.perform_deliveries = true
-#ActionMailer::Base.default_url_options[:host] = "test.com"
-
-Rails.backtrace_cleaner.remove_silencers!
-
 require 'shoulda'
 require 'ffaker'
 
+Rails.backtrace_cleaner.remove_silencers!
+
 # Run any available migration
 ActiveRecord::Migrator.migrate File.expand_path("../dummy/db/migrate/", __FILE__)
 

data/test/unit/model_test.rb

@@ -11,8 +11,21 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
       should 'not change the number of versions' do assert_equal(1, PaperTrail::Version.count) end
     end
 
-    context 'which updates an ignored column and a selected column' do
-      setup { @article.update_attributes :title => 'My first title', :content => 'Some text here.' }
+    context 'which updates an ignored column with truly Proc' do
+      setup { @article.update_attributes :abstract => 'ignore abstract' }
+      should 'not change the number of versions' do assert_equal(1, PaperTrail::Version.count) end
+    end
+
+    context 'which updates an ignored column with falsy Proc' do
+      setup { @article.update_attributes :abstract => 'do not ignore abstract!' }
+      should 'change the number of versions' do assert_equal(2, PaperTrail::Version.count) end
+    end
+
+    context 'which updates an ignored column, ignored with truly Proc and a selected column' do
+      setup { @article.update_attributes :title => 'My first title',
+                                         :content => 'Some text here.',
+                                         :abstract => 'ignore abstract'
+      }
       should 'change the number of versions' do assert_equal(2, PaperTrail::Version.count) end
 
       should "show the new version in the model's `versions` association" do
@@ -24,6 +37,22 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
       end
     end
 
+    context 'which updates an ignored column, ignored with falsy Proc and a selected column' do
+      setup { @article.update_attributes :title => 'My first title',
+                                         :content => 'Some text here.',
+                                         :abstract => 'do not ignore abstract'
+      }
+      should 'change the number of versions' do assert_equal(2, PaperTrail::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.'], 'abstract' => [nil, 'do not ignore abstract']}), @article.versions.last.changeset
+      end
+    end
+
     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, PaperTrail::Version.count) end
@@ -553,6 +582,31 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
   end
 
 
+  context 'Timestamps' do
+    setup do
+      @wotsit = Wotsit.create! :name => 'wotsit'
+    end
+
+    should 'record timestamps' do
+      @wotsit.update_attributes! :name => 'changed'
+      assert_not_nil @wotsit.versions.last.reify.created_at
+      assert_not_nil @wotsit.versions.last.reify.updated_at
+    end
+
+    should 'not generate warning' do
+      # Tests that it doesn't try to write created_on as an attribute just because a created_on
+      # method exists.
+      warnings = capture(:stderr) {  # Deprecation warning in Rails 3.2
+        assert_nothing_raised {  # ActiveModel::MissingAttributeError in Rails 4
+          @wotsit.update_attributes! :name => 'changed'
+        }
+      }
+      assert_equal '', warnings
+    end
+
+  end
+
+
   context 'A subclass' do
     setup do
       @foo = FooWidget.create

data/test/unit/serializer_test.rb

@@ -14,16 +14,16 @@ class SerializerTest < ActiveSupport::TestCase
       @fluxor.update_attributes :name => 'Some more text.'
     end
 
-    should 'work with the default yaml serializer' do
+    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.
+      # Check values are stored as `YAML`.
       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.
+      # 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
@@ -33,7 +33,7 @@ class SerializerTest < ActiveSupport::TestCase
   context 'JSON Serializer' do
     setup do
       PaperTrail.configure do |config|
-        config.serializer = PaperTrail::Serializers::Json
+        config.serializer = PaperTrail::Serializers::JSON
       end
 
       Fluxor.instance_eval <<-END
@@ -46,7 +46,7 @@ class SerializerTest < ActiveSupport::TestCase
     end
 
     teardown do
-      PaperTrail.config.serializer = PaperTrail::Serializers::Yaml
+      PaperTrail.config.serializer = PaperTrail::Serializers::YAML
     end
 
     should 'reify with JSON serializer' do
@@ -88,7 +88,7 @@ class SerializerTest < ActiveSupport::TestCase
     end
 
     teardown do
-      PaperTrail.config.serializer = PaperTrail::Serializers::Yaml
+      PaperTrail.config.serializer = PaperTrail::Serializers::YAML
     end
 
     should 'reify with custom serializer' do