paper_trail_without_deprecated 3.0.0.beta1

data/lib/paper_trail/version_number.rb

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

data/paper_trail.gemspec

@@ -0,0 +1,36 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'paper_trail/version_number'
+
+Gem::Specification.new do |s|
+  s.name          = 'paper_trail_without_deprecated'
+  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")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_dependency 'activerecord', ['>= 3.0', '< 5.0']
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'shoulda', '~> 3.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.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/custom_json_serializer.rb

@@ -0,0 +1,13 @@
+# This custom serializer excludes nil values
+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

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+Dummy::Application.load_tasks

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

@@ -0,0 +1,17 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+
+  def rescue_action(e)
+    raise e
+  end
+
+  # Returns id of hypothetical current user
+  def current_user
+    153
+  end
+
+  def info_for_paper_trail
+    {:ip => request.remote_ip, :user_agent => request.user_agent}
+  end
+  
+end

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

@@ -0,0 +1,5 @@
+class TestController < ActionController::Base
+  def current_user
+    Thread.current.object_id
+  end
+end

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

@@ -0,0 +1,31 @@
+class WidgetsController < ApplicationController
+
+  def paper_trail_enabled_for_controller
+    request.user_agent != 'Disable User-Agent'
+  end
+
+  def create
+    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]
+    if PaperTrail.active_record_protected_attributes?
+      @widget.update_attributes params[:widget]
+    else
+      @widget.update_attributes params[:widget].permit!
+    end
+    head :ok
+  end
+
+  def destroy
+    @widget = Widget.find params[:id]
+    @widget.destroy
+    head :ok
+  end
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

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

@@ -0,0 +1,4 @@
+class Animal < ActiveRecord::Base
+  has_paper_trail
+  self.inheritance_column = 'species'
+end

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

@@ -0,0 +1,16 @@
+class Article < ActiveRecord::Base
+  has_paper_trail :ignore => :title,
+                  :only => [:content],
+                  :skip => [:file_upload],
+                  :meta => {
+                              :answer => 42,
+                              :action => :action_data_provider_method,
+                              :question => Proc.new { "31 + 11 = #{31 + 11}" },
+                              :article_id => Proc.new { |article| article.id },
+                              :title => :title
+                            }
+
+  def action_data_provider_method
+    self.object_id.to_s
+  end
+end

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

@@ -0,0 +1,5 @@
+class Authorship < ActiveRecord::Base
+  belongs_to :book
+  belongs_to :person
+  has_paper_trail
+end

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

@@ -0,0 +1,5 @@
+class Book < ActiveRecord::Base
+  has_many :authorships, :dependent => :destroy
+  has_many :authors, :through => :authorships, :source => :person
+  has_paper_trail
+end

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

@@ -0,0 +1,2 @@
+class Cat < Animal
+end

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

@@ -0,0 +1,4 @@
+class Document < ActiveRecord::Base
+  has_paper_trail :versions => :paper_trail_versions,
+                  :on => [:create, :update]
+end

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

@@ -0,0 +1,2 @@
+class Dog < Animal
+end

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

@@ -0,0 +1,3 @@
+class Elephant < Animal
+  paper_trail_off
+end

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

@@ -0,0 +1,3 @@
+class Fluxor < ActiveRecord::Base
+  belongs_to :widget
+end

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

@@ -0,0 +1,2 @@
+class FooWidget < Widget
+end

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

@@ -0,0 +1,4 @@
+class LegacyWidget < ActiveRecord::Base
+  has_paper_trail :ignore  => :version,
+                  :version => 'custom_version'
+end

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

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

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

@@ -0,0 +1,4 @@
+class Post < ActiveRecord::Base
+  has_paper_trail :class_name => "PostVersion"
+
+end

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

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

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

@@ -0,0 +1,12 @@
+# Example from 'Overwriting default accessors' in ActiveRecord::Base.
+class Song < ActiveRecord::Base
+  has_paper_trail
+
+  # Uses an integer of seconds to hold the length of the song
+  def length=(minutes)
+    write_attribute(:length, minutes.to_i * 60)
+  end
+  def length
+    read_attribute(:length) / 60
+  end
+end

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

@@ -0,0 +1,4 @@
+class Translation < ActiveRecord::Base
+  has_paper_trail :if     => Proc.new { |t| t.language_code == 'US' },
+                  :unless => Proc.new { |t| t.type == 'DRAFT'       }
+end

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

@@ -0,0 +1,10 @@
+class Widget < ActiveRecord::Base
+  has_paper_trail
+  has_one :wotsit
+
+  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/models/wotsit.rb

@@ -0,0 +1,4 @@
+class Wotsit < ActiveRecord::Base
+  has_paper_trail
+  belongs_to :widget
+end

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

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

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag :all %>
+  <%= javascript_include_tag :defaults %>
+  <%= csrf_meta_tag %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/test/dummy/config/application.rb

@@ -0,0 +1,63 @@
+require File.expand_path('../boot', __FILE__)
+
+# Pick the frameworks you want:
+require "active_record/railtie"
+require "action_controller/railtie"
+
+Bundler.require(:default, Rails.env) if defined?(Bundler)
+require 'paper_trail'
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # 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.
+    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