paper_trail_scrapbook 0.0.2

data/spec/dummy_app/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/spec/dummy_app/app/models/car.rb

@@ -0,0 +1,3 @@
+class Car < Vehicle
+  has_paper_trail
+end

data/spec/dummy_app/app/models/cat.rb

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

data/spec/dummy_app/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/spec/dummy_app/app/models/citation.rb

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

data/spec/dummy_app/app/models/custom_primary_key_record.rb

@@ -0,0 +1,15 @@
+require 'securerandom'
+
+class CustomPrimaryKeyRecord < ActiveRecord::Base
+  self.primary_key = :uuid
+
+  has_paper_trail class_name: 'CustomPrimaryKeyRecordVersion'
+
+  # This default_scope is to test the case of the Version#item association
+  # not returning the item due to unmatched default_scope on the model.
+  default_scope { where(name: 'custom_primary_key_record') }
+
+  before_create do
+    self.uuid ||= SecureRandom.uuid
+  end
+end

data/spec/dummy_app/app/models/customer.rb

@@ -0,0 +1,4 @@
+class Customer < ActiveRecord::Base
+  has_many :orders, dependent: :destroy
+  has_paper_trail
+end

data/spec/dummy_app/app/models/document.rb

@@ -0,0 +1,6 @@
+class Document < ActiveRecord::Base
+  has_paper_trail(
+    versions: :paper_trail_versions,
+    on: %i[create update]
+  )
+end

data/spec/dummy_app/app/models/dog.rb

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

data/spec/dummy_app/app/models/editor.rb

@@ -0,0 +1,4 @@
+# to demonstrate a has_through association that does not have paper_trail enabled
+class Editor < ActiveRecord::Base
+  has_many :editorships, dependent: :destroy
+end

data/spec/dummy_app/app/models/editorship.rb

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

data/spec/dummy_app/app/models/elephant.rb

@@ -0,0 +1,3 @@
+class Elephant < Animal
+  paper_trail.disable
+end

data/spec/dummy_app/app/models/fluxor.rb

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

data/spec/dummy_app/app/models/foo_habtm.rb

@@ -0,0 +1,5 @@
+class FooHabtm < ActiveRecord::Base
+  has_and_belongs_to_many :bar_habtms
+  accepts_nested_attributes_for :bar_habtms
+  has_paper_trail
+end

data/spec/dummy_app/app/models/foo_widget.rb

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

data/spec/dummy_app/app/models/fruit.rb

@@ -0,0 +1,5 @@
+class Fruit < ActiveRecord::Base
+  if ENV['DB'] == 'postgres' || JsonVersion.table_exists?
+    has_paper_trail class_name: 'JsonVersion'
+  end
+end

data/spec/dummy_app/app/models/gadget.rb

@@ -0,0 +1,3 @@
+class Gadget < ActiveRecord::Base
+  has_paper_trail ignore: :brand
+end

data/spec/dummy_app/app/models/kitchen/banana.rb

@@ -0,0 +1,5 @@
+module Kitchen
+  class Banana < ActiveRecord::Base
+    has_paper_trail class_name: 'Kitchen::BananaVersion'
+  end
+end

data/spec/dummy_app/app/models/legacy_widget.rb

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

data/spec/dummy_app/app/models/line_item.rb

@@ -0,0 +1,4 @@
+class LineItem < ActiveRecord::Base
+  belongs_to :order, dependent: :destroy
+  has_paper_trail
+end

data/spec/dummy_app/app/models/not_on_update.rb

@@ -0,0 +1,4 @@
+# This model does not record versions when updated.
+class NotOnUpdate < ActiveRecord::Base
+  has_paper_trail on: %i[create destroy]
+end

data/spec/dummy_app/app/models/on/create.rb

@@ -0,0 +1,6 @@
+module On
+  class Create < ActiveRecord::Base
+    self.table_name = :on_create
+    has_paper_trail on: [:create]
+  end
+end

data/spec/dummy_app/app/models/on/destroy.rb

@@ -0,0 +1,6 @@
+module On
+  class Destroy < ActiveRecord::Base
+    self.table_name = :on_destroy
+    has_paper_trail on: [:destroy]
+  end
+end

data/spec/dummy_app/app/models/on/empty_array.rb

@@ -0,0 +1,6 @@
+module On
+  class EmptyArray < ActiveRecord::Base
+    self.table_name = :on_empty_array
+    has_paper_trail on: []
+  end
+end

data/spec/dummy_app/app/models/on/update.rb

@@ -0,0 +1,6 @@
+module On
+  class Update < ActiveRecord::Base
+    self.table_name = :on_update
+    has_paper_trail on: [:update]
+  end
+end

data/spec/dummy_app/app/models/order.rb

@@ -0,0 +1,5 @@
+class Order < ActiveRecord::Base
+  belongs_to :customer
+  has_many :line_items
+  has_paper_trail
+end

data/spec/dummy_app/app/models/paragraph.rb

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

data/spec/dummy_app/app/models/person.rb

@@ -0,0 +1,39 @@
+class Person < ActiveRecord::Base
+  has_many :authorships, foreign_key: :author_id, dependent: :destroy
+  has_many :books, through: :authorships
+  belongs_to :mentor, class_name: 'Person', foreign_key: :mentor_id
+  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
+    class << self
+      def dump(zone)
+        zone.try(:name)
+      end
+
+      def load(value)
+        ::Time.find_zone(value)
+      end
+    end
+
+    def dump(zone)
+      self.class.dump(zone)
+    end
+
+    def load(value)
+      self.class.load(value)
+    end
+  end
+
+  serialize :time_zone, TimeZoneSerializer.new
+end

data/spec/dummy_app/app/models/post.rb

@@ -0,0 +1,3 @@
+class Post < ActiveRecord::Base
+  has_paper_trail class_name: 'PostVersion'
+end

data/spec/dummy_app/app/models/post_with_status.rb

@@ -0,0 +1,7 @@
+# This model tests ActiveRecord::Enum, which was added in AR 4.1
+# http://edgeguides.rubyonrails.org/4_1_release_notes.html#active-record-enums
+class PostWithStatus < ActiveRecord::Base
+  has_paper_trail
+
+  enum status: { draft: 0, published: 1, archived: 2 }
+end

data/spec/dummy_app/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/spec/dummy_app/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/spec/dummy_app/app/models/skipper.rb

@@ -0,0 +1,3 @@
+class Skipper < ActiveRecord::Base
+  has_paper_trail ignore: [:created_at], skip: [:another_timestamp]
+end

data/spec/dummy_app/app/models/song.rb

@@ -0,0 +1,37 @@
+module OverrideSongAttributesTheRails4Way
+  def attributes
+    if name
+      super.merge(name: name)
+    else
+      super
+    end
+  end
+
+  def changed_attributes
+    if name
+      super.merge(name: name)
+    else
+      super
+    end
+  end
+end
+
+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
+
+  if ActiveRecord::VERSION::MAJOR >= 5
+    attribute :name, :string
+  else
+    attr_accessor :name
+    prepend OverrideSongAttributesTheRails4Way
+  end
+end

data/spec/dummy_app/app/models/thing.rb

@@ -0,0 +1,3 @@
+class Thing < ActiveRecord::Base
+  has_paper_trail save_changes: false
+end

data/spec/dummy_app/app/models/translation.rb

@@ -0,0 +1,6 @@
+class Translation < ActiveRecord::Base
+  has_paper_trail(
+    if: proc { |t| t.language_code == 'US' },
+    unless: proc { |t| t.type == 'DRAFT' }
+  )
+end

data/spec/dummy_app/app/models/truck.rb

@@ -0,0 +1,4 @@
+class Truck < Vehicle
+  # This STI child class specifically does not call `has_paper_trail`.
+  # Of the sub-classes of `Vehicle`, only `Car` is versioned.
+end

data/spec/dummy_app/app/models/vehicle.rb

@@ -0,0 +1,4 @@
+class Vehicle < ActiveRecord::Base
+  # This STI parent class specifically does not call `has_paper_trail`.
+  # Of its sub-classes, only `Car` is versioned.
+end

data/spec/dummy_app/app/models/whatchamajigger.rb

@@ -0,0 +1,4 @@
+class Whatchamajigger < ActiveRecord::Base
+  has_paper_trail
+  belongs_to :owner, polymorphic: true
+end

data/spec/dummy_app/app/models/widget.rb

@@ -0,0 +1,8 @@
+class Widget < ActiveRecord::Base
+  EXCLUDED_NAME = 'Biglet'.freeze
+  has_paper_trail
+  has_one :wotsit
+  has_many(:fluxors, -> { order(:name) })
+  has_many :whatchamajiggers, as: :owner
+  validates :name, exclusion: { in: [EXCLUDED_NAME] }
+end

data/spec/dummy_app/app/models/wotsit.rb

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

data/spec/dummy_app/app/versions/custom_primary_key_record_version.rb

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

data/spec/dummy_app/app/versions/joined_version.rb

@@ -0,0 +1,6 @@
+# The purpose of this custom version class is to test the scope methods on the
+# VersionConcern::ClassMethods module. See
+# https://github.com/airblade/paper_trail/issues/295 for more details.
+class JoinedVersion < PaperTrail::Version
+  default_scope { joins('INNER JOIN widgets ON widgets.id = versions.item_id') }
+end

data/spec/dummy_app/app/versions/json_version.rb

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

data/spec/dummy_app/app/versions/kitchen/banana_version.rb

@@ -0,0 +1,5 @@
+module Kitchen
+  class BananaVersion < PaperTrail::Version
+    self.table_name = 'banana_versions'
+  end
+end

data/spec/dummy_app/app/versions/post_version.rb

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

data/spec/dummy_app/config/application.rb

@@ -0,0 +1,37 @@
+require File.expand_path('../boot', __FILE__)
+
+# Pick the frameworks you want:
+require 'active_record/railtie'
+require 'action_controller/railtie'
+
+Bundler.require(:default, Rails.env)
+require 'paper_trail'
+
+module Dummy
+  class Application < Rails::Application
+    config.encoding = 'utf-8'
+    config.filter_parameters += [:password]
+    config.active_support.escape_html_entities_in_json = true
+    config.active_support.test_order = :sorted
+
+    # Disable assets in rails 4.2. In rails 5, config does not respond to
+    # assets, probably because it was moved out of railties to some other gem,
+    # and we only have dev. dependencies on railties, not all of rails. When
+    # we drop support for rails 4.2, we can remove this whole conditional.
+    config.assets.enabled = false if config.respond_to?(:assets)
+
+    config.secret_key_base = 'A fox regularly kicked the screaming pile of biscuits.'
+
+    # `raise_in_transactional_callbacks` was added in rails 4, then deprecated
+    # in rails 5. Oh, how fickle are the gods.
+    if ActiveRecord.respond_to?(:gem_version)
+      v = ActiveRecord.gem_version
+      if v >= Gem::Version.new('4.2') && v < Gem::Version.new('5.0.0.beta1')
+        config.active_record.raise_in_transactional_callbacks = true
+      end
+      if v >= Gem::Version.new('5.0.0.beta1')
+        config.active_record.time_zone_aware_types = [:datetime]
+      end
+    end
+  end
+end

data/spec/dummy_app/config/boot.rb

@@ -0,0 +1,24 @@
+require 'rubygems'
+
+# We normally use the root project Gemfile (and gemspec), but when we run rake
+# locally (not on travis) in this dummy app, we set the BUNDLE_GEMFILE env.
+# variable. The project Gemfile/gemspec allows AR 4.0, which is a problem
+# because this dummy app uses `enum` in some of its models, and `enum` was
+# introduced in AR 4.1. So, when we run rake here, we use:
+#
+#     BUNDLE_GEMFILE=../../gemfiles/ar_4.2.gemfile bundle exec rake
+#
+# Once we drop support for AR 4.0 and 4.1 this will be less of a problem, but
+# we should keep the ability to specify BUNDLE_GEMFILE because the same
+# situation could come up in the future.
+unless ENV.key?('BUNDLE_GEMFILE')
+  gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+  if File.exist?(gemfile)
+    puts "Booting PT test dummy app: Using gemfile: #{gemfile}"
+    ENV['BUNDLE_GEMFILE'] = gemfile
+  end
+end
+require 'bundler'
+Bundler.setup
+
+$LOAD_PATH.unshift(File.expand_path('../../../../lib', __FILE__))

data/spec/dummy_app/config/database.sqlite.yml

@@ -0,0 +1,15 @@
+# SQLite version 3.x
+#   gem install sqlite3-ruby (not necessary on OS X Leopard)
+test: &test
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+  database: db/test.sqlite3
+
+foo:
+  <<: *test
+  database: db/test-foo.sqlite3
+
+bar:
+  <<: *test
+  database: db/test-bar.sqlite3

data/spec/dummy_app/config/database.yml

@@ -0,0 +1,15 @@
+# SQLite version 3.x
+#   gem install sqlite3-ruby (not necessary on OS X Leopard)
+test: &test
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+  database: db/test.sqlite3
+
+foo:
+  <<: *test
+  database: db/test-foo.sqlite3
+
+bar:
+  <<: *test
+  database: db/test-bar.sqlite3

data/spec/dummy_app/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/spec/dummy_app/config/environments/development.rb

@@ -0,0 +1,36 @@
+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 web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  # 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
+
+  # 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
+
+  # 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/spec/dummy_app/config/environments/production.rb

@@ -0,0 +1,74 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # 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
+
+  # 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
+
+  # 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
+
+  # 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 = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production
+  # config.cache_store = :mem_cache_store
+
+  # 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
+
+  # Enable threaded mode
+  # config.threadsafe!
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found)
+  config.i18n.fallbacks = true
+
+  # 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