paper_trail 2.7.2 → 3.0.0.beta1

data/lib/paper_trail/version_number.rb

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

data/paper_trail.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   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']
+  s.authors       = ['Andy Stewart', 'Ben Atkins']
   s.email         = 'boss@airbladesoftware.com'
 
   s.files         = `git ls-files`.split("\n")
@@ -15,17 +15,21 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ['lib']
 
-  s.add_dependency 'railties', '~> 3.0'
-  s.add_dependency 'activerecord', '~> 3.0'
+  s.add_dependency 'activerecord', ['>= 3.0', '< 5.0']
 
   s.add_development_dependency 'rake'
-  s.add_development_dependency 'shoulda', '~> 3.3'
-  s.add_development_dependency 'shoulda-matchers', '~> 1.5'
+  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'
+  s.add_development_dependency 'rack-test', '>= 0.6'
+  s.add_development_dependency 'rspec-rails', '~> 2.14'
+
   # JRuby support for the test ENV
   unless defined?(JRUBY_VERSION)
     s.add_development_dependency 'sqlite3', '~> 1.2'
   else
-    s.add_development_dependency 'activerecord-jdbcsqlite3-adapter', '~> 1.2.9'
+    s.add_development_dependency 'activerecord-jdbcsqlite3-adapter', ['>= 1.3.0.rc1', '< 1.4']
   end
 end

data/spec/models/widget_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Widget do
+  it { should be_versioned }
+
+  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
+    end
+  end
+end

data/spec/paper_trail_spec.rb

@@ -0,0 +1,47 @@
+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
+    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
+  end
+
+  describe :whodunnit do
+    before(:all) { ::PaperTrail.whodunnit = 'foobar' }
+
+    it "should get set to `nil` by default" do
+      ::PaperTrail.whodunnit.should be_nil
+    end
+  end
+
+  describe :controller_info do
+    before(:all) { ::PaperTrail.controller_info = {:foo => 'bar'} }
+
+    it "should get set to an empty hash before each test" do
+      ::PaperTrail.controller_info.should == {}
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,41 @@
+ENV["RAILS_ENV"] ||= 'test'
+require File.expand_path('../../test/dummy/config/environment', __FILE__)
+
+require 'rspec/rails'
+require 'rspec/autorun'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[Rails.root.join('spec/support/**/*.rb')].each { |f| require f }
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+
+  # ## Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  # config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+
+  # If true, the base class of anonymous controllers will be inferred
+  # automatically. This will be the default behavior in future versions of
+  # rspec-rails.
+  config.infer_base_class_for_anonymous_controllers = false
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

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

@@ -5,13 +5,21 @@ class WidgetsController < ApplicationController
   end
 
   def create
-    @widget = Widget.create params[:widget]
+    if PaperTrail.active_record_protected_attributes?
+      @widget = Widget.create params[:widget]
+    else
+      @widget = Widget.create params[:widget].permit!
+    end
     head :ok
   end
 
   def update
     @widget = Widget.find params[:id]
-    @widget.update_attributes params[:widget]
+    if PaperTrail.active_record_protected_attributes?
+      @widget.update_attributes params[:widget]
+    else
+      @widget.update_attributes params[:widget].permit!
+    end
     head :ok
   end
 

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

@@ -1,3 +1,3 @@
 class ProtectedWidget < Widget
-  attr_accessible :name, :a_text
+  attr_accessible :name, :a_text if ::PaperTrail.active_record_protected_attributes?
 end

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

@@ -1,5 +1,10 @@
 class Widget < ActiveRecord::Base
   has_paper_trail
   has_one :wotsit
-  has_many :fluxors, :order => :name
+
+  if ActiveRecord::VERSION::STRING.to_f >= 4.0 # `has_many` syntax for specifying order uses a lambda in Rails 4
+    has_many :fluxors, lambda { order(:name) }
+  else
+    has_many :fluxors, :order => :name
+  end
 end

data/test/dummy/app/versions/post_version.rb

@@ -1,3 +1,3 @@
-class PostVersion < Version
+class PostVersion < PaperTrail::Version
   self.table_name = 'post_versions'
 end

data/test/dummy/config/application.rb

@@ -1,9 +1,8 @@
 require File.expand_path('../boot', __FILE__)
 
-require "active_model/railtie"
+# Pick the frameworks you want:
 require "active_record/railtie"
 require "action_controller/railtie"
-require "action_view/railtie"
 
 Bundler.require(:default, Rails.env) if defined?(Bundler)
 require 'paper_trail'
@@ -50,15 +49,15 @@ module Dummy
     # 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
+    config.active_record.whitelist_attributes = false if ::PaperTrail.active_record_protected_attributes?
 
     # 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'
+
+    # Rails 4 key for generating secret key
+    config.secret_key_base = 'A fox regularly kicked the screaming pile of biscuits.'
   end
 end

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

@@ -6,8 +6,8 @@ Dummy::Application.configure do
   # 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.
-  config.whiny_nils = true
+  # Do not eager load code on boot.
+  config.eager_load = false
 
   # Show full error reports and disable caching
   config.consider_all_requests_local       = true
@@ -23,7 +23,7 @@ Dummy::Application.configure do
   config.action_dispatch.best_standards_support = :builtin
 
   # Raise exception on mass assignment protection for Active Record models
-  config.active_record.mass_assignment_sanitizer = :strict
+  config.active_record.mass_assignment_sanitizer = :strict if ::PaperTrail.active_record_protected_attributes?
 
   # Log the query plan for queries taking more than this (works
   # with SQLite, MySQL, and PostgreSQL)
@@ -32,7 +32,9 @@ Dummy::Application.configure do
   # Do not compress assets
   config.assets.compress = false
 
-  # Expands the lines which load the assets
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
   config.assets.debug = true
 end
 

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

@@ -4,6 +4,12 @@ Dummy::Application.configure do
   # Code is not reloaded between requests
   config.cache_classes = true
 
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both thread web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
   # Full error reports are disabled and caching is turned on
   config.consider_all_requests_local       = false
   config.action_controller.perform_caching = true

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

@@ -7,13 +7,13 @@ Dummy::Application.configure do
   # and recreated between test runs. Don't rely on the data there!
   config.cache_classes = true
 
+  # Eager loads all registered namespaces
+  config.eager_load = true
+
   # 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
   config.consider_all_requests_local       = true
   config.action_controller.perform_caching = false
@@ -30,7 +30,7 @@ Dummy::Application.configure do
   # config.action_mailer.delivery_method = :test
 
   # Raise exception on mass assignment protection for Active Record models
-  config.active_record.mass_assignment_sanitizer = :strict
+  config.active_record.mass_assignment_sanitizer = :strict if ::PaperTrail.active_record_protected_attributes?
 
   # Print deprecation notices to the stderr
   config.active_support.deprecation = :stderr

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

@@ -1,3 +1,5 @@
-class Version < ActiveRecord::Base
-  attr_accessible :created_at, :updated_at, :answer, :action, :question, :article_id, :ip, :user_agent, :title
+module PaperTrail
+  class Version < ActiveRecord::Base
+    attr_accessible :created_at, :updated_at, :answer, :action, :question, :article_id, :ip, :user_agent, :title if ::PaperTrail.active_record_protected_attributes?
+  end
 end

data/test/functional/controller_test.rb

@@ -34,7 +34,7 @@ class ControllerTest < ActionController::TestCase
     assert_equal 0, w.versions.length
     delete :destroy, :id => w.id
     widget = assigns(:widget)
-    assert_equal 0, Version.with_item_keys('Widget', w.id).size
+    assert_equal 0, PaperTrail::Version.with_item_keys('Widget', w.id).size
   end
 
   test 'create' do
@@ -62,7 +62,7 @@ class ControllerTest < ActionController::TestCase
     assert_equal 1, w.versions.length
     delete :destroy, :id => w.id
     widget = assigns(:widget)
-    versions_for_widget = Version.with_item_keys('Widget', w.id)
+    versions_for_widget = PaperTrail::Version.with_item_keys('Widget', w.id)
     assert_equal 2,               versions_for_widget.length
     assert_equal 153,             versions_for_widget.last.whodunnit.to_i
     assert_equal '127.0.0.1',     versions_for_widget.last.ip

data/test/functional/modular_sinatra_test.rb

@@ -0,0 +1,44 @@
+require 'test_helper'
+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
+
+  get '/test' do
+    Widget.create!(:name => 'foo')
+    'Hello'
+  end
+
+  def current_user
+    'foobar'
+  end
+end
+
+class ModularSinatraTest < ActionDispatch::IntegrationTest
+  include Rack::Test::Methods
+
+  def app
+    @app ||= BaseApp
+  end
+
+  test 'baseline' do
+    assert_nil Widget.first
+    assert_nil Widget.create.versions.first.whodunnit
+  end
+
+  context "`PaperTrail::Sinatra` in a `Sinatra::Base` application" do
+  
+    should "sets the `user_for_paper_trail` from the `current_user` method" do
+      get '/test'
+      assert_equal 'Hello', last_response.body
+      widget = Widget.first
+      assert_not_nil widget
+      assert_equal 'foo', widget.name
+      assert_equal 1, widget.versions.size
+      assert_equal 'foobar', widget.versions.first.whodunnit
+    end
+
+  end
+end

data/test/functional/sinatra_test.rb

@@ -0,0 +1,45 @@
+require 'test_helper'
+# require 'sinatra/main'
+
+# --- 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
+
+  get '/test' do
+    Widget.create!(:name => 'bar')
+    'Hai'
+  end
+
+  def current_user
+    'raboof'
+  end
+
+end
+
+class SinatraTest < ActionDispatch::IntegrationTest
+  include Rack::Test::Methods
+
+  def app
+    @app ||= Sinatra::Application
+  end
+
+  test 'baseline' do
+    assert_nil Widget.first
+    assert_nil Widget.create.versions.first.whodunnit
+  end
+
+  context "`PaperTrail::Sinatra` in a `Sinatra::Application` application" do
+
+    should "sets the `user_for_paper_trail` from the `current_user` method" do
+      get '/test'
+      assert_equal 'Hai', last_response.body
+      widget = Widget.first
+      assert_not_nil widget
+      assert_equal 'bar', widget.name
+      assert_equal 1, widget.versions.size
+      assert_equal 'raboof', widget.versions.first.whodunnit
+    end
+
+  end
+end

data/test/functional/thread_safety_test.rb

@@ -1,7 +1,7 @@
 require 'test_helper'
 
 class ThreadSafetyTest < ActionController::TestCase
-  should "be thread safe" do
+  test "be thread safe" do
     blocked = true
 
     slow_thread = Thread.new do

data/test/paper_trail_test.rb

@@ -2,7 +2,7 @@ require 'test_helper'
 
 class PaperTrailTest < ActiveSupport::TestCase
   test 'Sanity test' do
-    assert_kind_of Module, PaperTrail
+    assert_kind_of Module, PaperTrail::Version
   end
 
   test 'create with plain model class' do
@@ -21,7 +21,7 @@ class PaperTrailTest < ActiveSupport::TestCase
     widget = Widget.create
     assert_equal 1, widget.versions.length
     widget.destroy
-    versions_for_widget = Version.with_item_keys('Widget', widget.id)
+    versions_for_widget = PaperTrail::Version.with_item_keys('Widget', widget.id)
     assert_equal 2, versions_for_widget.length
   end
 end

data/test/unit/cleaner_test.rb

@@ -0,0 +1,143 @@
+require 'test_helper'
+
+class PaperTrailCleanerTest < ActiveSupport::TestCase
+
+  setup do
+    @animals = [@animal = Animal.new, @dog = Dog.new, @cat = Cat.new]
+    @animals.each do |animal|
+      3.times { animal.update_attribute(:name, Faker::Name.name) }
+    end
+  end
+
+  test 'Baseline' do
+    assert_equal 9, PaperTrail::Version.count
+    @animals.each { |animal| assert_equal 3, animal.versions.size }
+  end
+
+  context '`clean_versions!` method' do
+    should 'be extended by `PaperTrail` module' do
+      assert_respond_to PaperTrail, :clean_versions!
+    end
+
+    context 'No options provided' do
+      should 'removes extra versions for each item' do
+        PaperTrail.clean_versions!
+        assert_equal 3, PaperTrail::Version.count
+        @animals.each { |animal| assert_equal 1, animal.versions.size }
+      end
+
+      should 'removes the earliest version(s)' do
+        most_recent_version_names = @animals.map { |animal| animal.versions.last.reify.name }
+        PaperTrail.clean_versions!
+        assert_equal most_recent_version_names, @animals.map { |animal| animal.versions.last.reify.name }
+      end
+    end
+
+    context '`:keeping` option' do
+      should 'modifies the number of versions ommitted from destruction' do
+        PaperTrail.clean_versions!(:keeping => 2)
+        assert_equal 6, PaperTrail::Version.all.count
+        @animals.each { |animal| assert_equal 2, animal.versions.size }
+      end
+    end
+
+    context '`:date` option' do
+      setup do
+        @animal.versions.each { |ver| ver.update_attribute(:created_at, ver.created_at - 1.day) }
+        @date = @animal.versions.first.created_at.to_date
+        @animal.update_attribute(:name, Faker::Name.name)
+      end
+
+      should 'restrict the versions destroyed to those that were created on the date provided' do
+        assert_equal 10, PaperTrail::Version.count
+        assert_equal 4, @animal.versions.size
+        assert_equal 3, @animal.versions_between(@date, @date + 1.day).size
+        PaperTrail.clean_versions!(:date => @date)
+        assert_equal 8, PaperTrail::Version.count
+        assert_equal 2, @animal.versions(true).size
+        assert_equal @date, @animal.versions.first.created_at.to_date
+        assert_not_same @date, @animal.versions.last.created_at.to_date
+      end
+    end
+
+    context '`:item_id` option' do
+      context 'single ID received' do
+        should 'restrict the versions destroyed to the versions for the Item with that ID' do
+          PaperTrail.clean_versions!(:item_id => @animal.id)
+          assert_equal 1, @animal.versions.size
+          assert_equal 7, PaperTrail::Version.count
+        end
+      end
+
+      context "collection of ID's received" do
+        should "restrict the versions destroyed to the versions for the Item with those ID's" do
+          PaperTrail.clean_versions!(:item_id => [@animal.id, @dog.id])
+          assert_equal 1, @animal.versions.size
+          assert_equal 1, @dog.versions.size
+          assert_equal 5, PaperTrail::Version.count
+        end
+      end
+    end
+
+    context 'options combinations' do # additional tests to cover combinations of options
+      context '`:date`' do
+        setup do
+          [@animal, @dog].each do |animal|
+            animal.versions.each { |ver| ver.update_attribute(:created_at, ver.created_at - 1.day) }
+            animal.update_attribute(:name, Faker::Name.name)
+          end
+          @date = @animal.versions.first.created_at.to_date
+        end
+
+        should 'Baseline' do
+          assert_equal 11, PaperTrail::Version.count
+          [@animal, @dog].each do |animal|
+            assert_equal 4, animal.versions.size
+            assert_equal 3, animal.versions.between(@date, @date+1.day).size
+          end
+        end
+
+        context 'and `:keeping`' do
+          should 'restrict cleaning properly' do
+            PaperTrail.clean_versions!(:date => @date, :keeping => 2)
+            [@animal, @dog].each do |animal|
+              animal.versions.reload # reload the association to pick up the destructions made by the `Cleaner`
+              assert_equal 3, animal.versions.size
+              assert_equal 2, animal.versions.between(@date, @date+1.day).size
+            end
+            assert_equal 9, PaperTrail::Version.count # ensure that the versions for the `@cat` instance wasn't touched
+          end
+        end
+
+        context 'and `:item_id`' do
+          should 'restrict cleaning properly' do
+            PaperTrail.clean_versions!(:date => @date, :item_id => @dog.id)
+            @dog.versions.reload # reload the association to pick up the destructions made by the `Cleaner`
+            assert_equal 2, @dog.versions.size
+            assert_equal 1, @dog.versions.between(@date, @date+1.day).size
+            assert_equal 9, PaperTrail::Version.count # ensure the versions for other animals besides `@animal` weren't touched
+          end
+        end
+
+        context ', `:item_id`, and `:keeping`' do
+          should 'restrict cleaning properly' do
+            PaperTrail.clean_versions!(:date => @date, :item_id => @dog.id, :keeping => 2)
+            @dog.versions.reload # reload the association to pick up the destructions made by the `Cleaner`
+            assert_equal 3, @dog.versions.size
+            assert_equal 2, @dog.versions.between(@date, @date+1.day).size
+            assert_equal 10, PaperTrail::Version.count # ensure the versions for other animals besides `@animal` weren't touched
+          end
+        end
+      end
+
+      context '`:keeping` and `:item_id`' do
+        should 'restrict cleaning properly' do
+          PaperTrail.clean_versions!(:keeping => 2, :item_id => @animal.id)
+          assert_equal 2, @animal.versions.size
+          assert_equal 8, PaperTrail::Version.count # ensure the versions for other animals besides `@animal` weren't touched
+        end
+      end
+    end
+
+  end # clean_versions! method
+end