paper_trail 4.0.2 → 4.1.0

data/lib/paper_trail/version_number.rb

@@ -1,8 +1,8 @@
 module PaperTrail
   module VERSION
     MAJOR = 4
-    MINOR = 0
-    TINY  = 2
+    MINOR = 1
+    TINY  = 0
     PRE   = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')

data/paper_trail.gemspec

@@ -33,19 +33,20 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec-rails', '~> 3.1.0'
   s.add_development_dependency 'generator_spec'
   s.add_development_dependency 'database_cleaner', '~> 1.2'
+  s.add_development_dependency 'pry-nav'
 
+  # Allow time travel in testing. timecop is only supported after 1.9.2 but does a better cleanup at 'return'
   if RUBY_VERSION < "1.9.2"
     s.add_development_dependency 'delorean'
-
-    # rack-cache 1.3 drops ruby 1.8.7 support
-    s.add_development_dependency 'rack-cache', '1.2'
   else
-    # timecop is only supported after 1.9.2 but does a better cleanup at 'return'
     s.add_development_dependency 'timecop'
   end
 
-  # JRuby support for the test ENV
-  unless defined?(JRUBY_VERSION)
+  if defined?(JRUBY_VERSION)
+    s.add_development_dependency 'activerecord-jdbcsqlite3-adapter', '~> 1.3'
+    s.add_development_dependency 'activerecord-jdbcpostgresql-adapter', '~> 1.3'
+    s.add_development_dependency 'activerecord-jdbcmysql-adapter', '~> 1.3'
+  else
     s.add_development_dependency 'sqlite3', '~> 1.2'
 
     # We would prefer to only constrain mysql2 to '~> 0.3',
@@ -54,9 +55,5 @@ Gem::Specification.new do |s|
     s.add_development_dependency 'mysql2', '~> 0.3.20'
 
     s.add_development_dependency 'pg', '~> 0.17'
-  else
-    s.add_development_dependency 'activerecord-jdbcsqlite3-adapter', '~> 1.3'
-    s.add_development_dependency 'activerecord-jdbcpostgresql-adapter', '~> 1.3'
-    s.add_development_dependency 'activerecord-jdbcmysql-adapter', '~> 1.3'
   end
 end

data/spec/models/animal_spec.rb

@@ -15,5 +15,22 @@ describe Animal, :type => :model do
         expect(dog).to be_instance_of(Dog)
       end
     end
+
+    context 'with callback-methods' do
+      context 'when only has_paper_trail set in super class' do
+        let(:callback_cat) { Cat.create(:name => 'Markus') }
+
+        it 'trails all events' do
+          callback_cat.update_attributes(:name => 'Billie')
+          callback_cat.destroy
+          expect(callback_cat.versions.collect(&:event)).to eq %w(create update destroy)
+        end
+
+        it 'does not break reify' do
+          callback_cat.destroy
+          expect { callback_cat.versions.last.reify }.not_to raise_error
+        end
+      end
+    end
   end
 end

data/spec/models/callback_modifier_spec.rb

@@ -0,0 +1,96 @@
+require 'rails_helper'
+
+describe CallbackModifier, :type => :model do
+  with_versioning do
+    describe 'callback-methods', :versioning => true do
+      describe 'paper_trail_on_destroy' do
+        it 'should add :destroy to paper_trail_options[:on]' do
+          modifier = NoArgDestroyModifier.create!(:some_content => Faker::Lorem.sentence)
+          expect(modifier.paper_trail_options[:on]).to eq [:destroy]
+        end
+
+        context 'when :before' do
+          it 'should create the version before destroy' do
+            modifier = BeforeDestroyModifier.create!(:some_content => Faker::Lorem.sentence)
+            modifier.test_destroy
+            expect(modifier.versions.last.reify).not_to be_flagged_deleted
+          end
+        end
+
+        context 'when :after' do
+          it 'should create the version after destroy' do
+            modifier = AfterDestroyModifier.create!(:some_content => Faker::Lorem.sentence)
+            modifier.test_destroy
+            expect(modifier.versions.last.reify).to be_flagged_deleted
+          end
+        end
+
+        context 'when no argument' do
+          it 'should default to after destroy' do
+            modifier = NoArgDestroyModifier.create!(:some_content => Faker::Lorem.sentence)
+            modifier.test_destroy
+            expect(modifier.versions.last.reify).to be_flagged_deleted
+          end
+        end
+      end
+
+      describe 'paper_trail_on_update' do
+        it 'should add :update to paper_trail_options[:on]' do
+          modifier = UpdateModifier.create!(:some_content => Faker::Lorem.sentence)
+          expect(modifier.paper_trail_options[:on]).to eq [:update]
+        end
+
+        it 'should create a version' do
+          modifier = UpdateModifier.create!(:some_content => Faker::Lorem.sentence)
+          modifier.update_attributes! :some_content => 'modified'
+          expect(modifier.versions.last.event).to eq 'update'
+        end
+      end
+
+      describe 'paper_trail_on_create' do
+        it 'should add :create to paper_trail_options[:on]' do
+          modifier = CreateModifier.create!(:some_content => Faker::Lorem.sentence)
+          expect(modifier.paper_trail_options[:on]).to eq [:create]
+        end
+
+        it 'should create a version' do
+          modifier = CreateModifier.create!(:some_content => Faker::Lorem.sentence)
+          expect(modifier.versions.last.event).to eq 'create'
+        end
+      end
+
+      context 'when no callback-method used' do
+        it 'should set paper_trail_options[:on] to [:create, :update, :destroy]' do
+          modifier = DefaultModifier.create!(:some_content => Faker::Lorem.sentence)
+          expect(modifier.paper_trail_options[:on]).to eq [:create, :update, :destroy]
+        end
+
+        it 'should default to track destroy' do
+          modifier = DefaultModifier.create!(:some_content => Faker::Lorem.sentence)
+          modifier.destroy
+          expect(modifier.versions.last.event).to eq 'destroy'
+        end
+
+        it 'should default to track update' do
+          modifier = DefaultModifier.create!(:some_content => Faker::Lorem.sentence)
+          modifier.update_attributes! :some_content => 'modified'
+          expect(modifier.versions.last.event).to eq 'update'
+        end
+
+        it 'should default to track create' do
+          modifier = DefaultModifier.create!(:some_content => Faker::Lorem.sentence)
+          expect(modifier.versions.last.event).to eq 'create'
+        end
+      end
+
+      context 'when only one callback-method' do
+        it 'does only track the corresponding event' do
+          modifier = CreateModifier.create!(:some_content => Faker::Lorem.sentence)
+          modifier.update_attributes!(:some_content => 'modified')
+          modifier.test_destroy
+          expect(modifier.versions.collect(&:event)).to eq ['create']
+        end
+      end
+    end
+  end
+end

data/spec/models/json_version_spec.rb

@@ -1,6 +1,8 @@
-if JsonVersion.table_exists?
+require 'rails_helper'
 
-  require 'rails_helper'
+# The `json_versions` table tests postgres' `json` data type. So, that
+# table is only created when testing against postgres and ActiveRecord >= 4.
+if JsonVersion.table_exists?
 
   describe JsonVersion, :type => :model do
     it "should include the `VersionConcern` module to get base functionality" do
@@ -70,31 +72,32 @@ if JsonVersion.table_exists?
           end
 
           context "valid arguments", :versioning => true do
-            let(:fruit_names) { %w(apple orange lemon banana lime strawberry blueberry) }
-            let(:tropical_fruit_names) { %w(coconut pineapple kiwi mango melon) }
-            let(:fruit) { Fruit.new }
-            let(:name) { 'pomegranate' }
-            let(:color) { Faker::Color.name }
+            let(:color) { %w[red green] }
+            let(:fruit) { Fruit.create!(:name => name[0]) }
+            let(:name) { %w[banana kiwi mango] }
 
             before do
-              fruit.update_attributes!(:name => name)
-              fruit.update_attributes!(:name => tropical_fruit_names.sample, :color => color)
-              fruit.update_attributes!(:name => fruit_names.sample, :color => Faker::Color.name)
+              fruit.update_attributes!(:name => name[1], :color => color[0])
+              fruit.update_attributes!(:name => name[2], :color => color[1])
             end
 
-            it "should be able to locate versions according to their `object_changes` contents" do
-              expect(fruit.versions.where_object_changes(:name => name)).to eq(fruit.versions[0..1])
-              expect(fruit.versions.where_object_changes(:color => color)).to eq(fruit.versions[1..2])
+            it "finds versions according to their `object_changes` contents" do
+              expect(
+                fruit.versions.where_object_changes(:name => name[0])
+              ).to match_array(fruit.versions[0..1])
+              expect(
+                fruit.versions.where_object_changes(:color => color[0])
+              ).to match_array(fruit.versions[1..2])
             end
 
-            it "should be able to handle queries for multiple attributes" do
-              expect(fruit.versions.where_object_changes(:color => color, :name => name)).to eq([fruit.versions[1]])
+            it "finds versions with multiple attributes changed" do
+              expect(
+                fruit.versions.where_object_changes(:color => color[0], :name => name[0])
+              ).to match_array([fruit.versions[1]])
             end
           end
         end
       end
-
     end
   end
-
 end

data/spec/paper_trail/config_spec.rb

@@ -0,0 +1,52 @@
+require "rails_helper"
+
+module PaperTrail
+  RSpec.describe Config do
+    describe ".instance" do
+      it "returns the singleton instance" do
+        expect { described_class.instance }.to_not raise_error
+      end
+    end
+
+    describe ".new" do
+      it "raises NoMethodError" do
+        expect { described_class.new }.to raise_error(NoMethodError)
+      end
+    end
+
+    describe "#enabled" do
+      context "when paper_trail_enabled is true" do
+        it "returns true" do
+          store = double
+          allow(store).to receive(:fetch).
+            with(:paper_trail_enabled, true).
+            and_return(true)
+          allow(PaperTrail).to receive(:paper_trail_store).and_return(store)
+          expect(described_class.instance.enabled).to eq(true)
+        end
+      end
+
+      context "when paper_trail_enabled is false" do
+        it "returns false" do
+          store = double
+          allow(store).to receive(:fetch).
+            with(:paper_trail_enabled, true).
+            and_return(false)
+          allow(PaperTrail).to receive(:paper_trail_store).and_return(store)
+          expect(described_class.instance.enabled).to eq(false)
+        end
+      end
+
+      context "when paper_trail_enabled is nil" do
+        it "returns true" do
+          store = double
+          allow(store).to receive(:fetch).
+            with(:paper_trail_enabled, true).
+            and_return(nil)
+          allow(PaperTrail).to receive(:paper_trail_store).and_return(store)
+          expect(described_class.instance.enabled).to eq(true)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,3 +1,9 @@
+begin
+  require 'pry-nav'
+rescue LoadError
+  # It's OK, we don't include pry in e.g. gemfiles/3.0.gemfile
+end
+
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
 # The generated `.rspec` file contains `--require spec_helper` which will cause this

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

@@ -0,0 +1,45 @@
+class CallbackModifier < ActiveRecord::Base
+  has_paper_trail :on => []
+
+  def test_destroy
+    transaction do
+      run_callbacks(:destroy) do
+        self.deleted = true
+        save!
+      end
+    end
+  end
+
+  def flagged_deleted?
+    deleted?
+  end
+end
+
+class BeforeDestroyModifier < CallbackModifier
+  has_paper_trail :on => []
+  paper_trail_on_destroy :before
+end
+
+class AfterDestroyModifier < CallbackModifier
+  has_paper_trail :on => []
+  paper_trail_on_destroy :after
+end
+
+class NoArgDestroyModifier < CallbackModifier
+  has_paper_trail :on => []
+  paper_trail_on_destroy
+end
+
+class UpdateModifier < CallbackModifier
+  has_paper_trail :on => []
+  paper_trail_on_update
+end
+
+class CreateModifier < CallbackModifier
+  has_paper_trail :on => []
+  paper_trail_on_create
+end
+
+class DefaultModifier < CallbackModifier
+  has_paper_trail
+end

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

@@ -0,0 +1,9 @@
+class Chapter < ActiveRecord::Base
+  has_many :sections, :dependent => :destroy
+  has_many :paragraphs, :through => :sections
+
+  has_many :quotations, :dependent => :destroy
+  has_many :citations, :through => :quotations
+
+  has_paper_trail
+end

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

@@ -0,0 +1,5 @@
+class Citation < ActiveRecord::Base
+  belongs_to :quotation
+
+  has_paper_trail
+end

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

@@ -0,0 +1,5 @@
+class Paragraph < ActiveRecord::Base
+  belongs_to :section
+
+  has_paper_trail
+end

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

@@ -0,0 +1,5 @@
+class Quotation < ActiveRecord::Base
+  belongs_to :chapter
+  has_many :citations, :dependent => :destroy
+  has_paper_trail
+end

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

@@ -0,0 +1,6 @@
+class Section < ActiveRecord::Base
+  belongs_to :chapter
+  has_many :paragraphs, :dependent => :destroy
+
+  has_paper_trail
+end

data/test/dummy/config/database.postgres.yml

@@ -12,4 +12,4 @@ foo:
 
 bar:
   <<: *test
-  database: paper_trail_bar
+  database: paper_trail_bar

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

@@ -3,6 +3,8 @@ PaperTrail.config.track_associations = true if ENV['TRAVIS']
 
 module PaperTrail
   class Version < ActiveRecord::Base
-    attr_accessible :answer, :action, :question, :article_id, :ip, :user_agent, :title if ::PaperTrail.active_record_protected_attributes?
+    if ::PaperTrail.active_record_protected_attributes?
+      attr_accessible :answer, :action, :question, :article_id, :ip, :user_agent, :title
+    end
   end
 end

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

@@ -211,9 +211,38 @@ class SetUpTestTables < ActiveRecord::Migration
       t.string :name
       t.boolean :scoped, :default => true
     end
+
+    create_table :callback_modifiers, :force => true do |t|
+      t.string  :some_content
+      t.boolean :deleted, :default => false
+    end
+
+    create_table :chapters, :force => true do |t|
+      t.string :name
+    end
+
+    create_table :sections, :force => true do |t|
+      t.integer :chapter_id
+      t.string :name
+    end
+
+    create_table :paragraphs, :force => true do |t|
+      t.integer :section_id
+      t.string :name
+    end
+
+    create_table :quotations, :force => true do |t|
+      t.integer :chapter_id
+    end
+
+    create_table :citations, :force => true do |t|
+      t.integer :quotation_id
+    end
   end
 
   def self.down
+    drop_table :citations
+    drop_table :quotations
     drop_table :animals
     drop_table :skippers
     drop_table :not_on_updates
@@ -247,8 +276,12 @@ class SetUpTestTables < ActiveRecord::Migration
     drop_table :line_items
     drop_table :fruits
     drop_table :boolits
+    drop_table :chapters
+    drop_table :sections
+    drop_table :paragraphs
     remove_index :version_associations, :column => [:version_id]
     remove_index :version_associations, :name => 'index_version_associations_on_foreign_key'
     drop_table :version_associations
+    drop_table :callback_modifiers
   end
 end