paper_trail 3.0.6 → 4.2.0

data/spec/support/alt_db_init.rb

@@ -9,7 +9,7 @@ configs = YAML.load_file("#{Rails.root}/config/database.yml")
 db_directory = "#{Rails.root}/db"
 # setup alternate databases
 if ENV["DB"] == "sqlite"
-  if  RUBY_VERSION.to_f >= 1.9
+  if  RUBY_VERSION >= '1.9'
     FileUtils.cp "#{db_directory}/test.sqlite3", "#{db_directory}/test-foo.sqlite3"
     FileUtils.cp "#{db_directory}/test.sqlite3", "#{db_directory}/test-bar.sqlite3"
   else

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

@@ -9,7 +9,7 @@ class ApplicationController < ActionController::Base
   def current_user
     @current_user ||= OpenStruct.new(:id => 153).tap do |obj|
       # Invoking `id` returns the `object_id` value in Ruby18 unless specifically overwritten
-      def obj.id; 153; end if RUBY_VERSION.to_f < 1.9
+      def obj.id; 153; end if RUBY_VERSION < '1.9'
     end
   end
 

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

@@ -9,6 +9,9 @@ class ArticlesController < ApplicationController
   end
 
   def current_user
-    'foobar'
+    'foobar'.tap do |string|
+      # Invoking `id` returns the `object_id` value in Ruby18 by default
+      string.class_eval { undef_method(:id) } if RUBY_VERSION < '1.9'
+    end
   end
 end

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

@@ -1,4 +1,6 @@
 class Animal < ActiveRecord::Base
   has_paper_trail
   self.inheritance_column = 'species'
+
+  attr_accessible :species, :name if ::PaperTrail.active_record_protected_attributes?
 end

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

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

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

@@ -0,0 +1,4 @@
+class Boolit < ActiveRecord::Base
+  default_scope { where(:scoped => true) }
+  has_paper_trail
+end

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/customer.rb

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

data/test/dummy/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/test/dummy/app/models/editorship.rb

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

data/test/dummy/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/test/dummy/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/test/dummy/app/models/line_item.rb

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

data/test/dummy/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 => [:create, :destroy]
+end

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

@@ -0,0 +1,5 @@
+class Order < ActiveRecord::Base
+  belongs_to :customer
+  has_many :line_items
+  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/person.rb

@@ -15,12 +15,22 @@ class Person < ActiveRecord::Base
 
   # 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) rescue nil
+      end
+    end
+
     def dump(zone)
-      zone.try(:name)
+      self.class.dump(zone)
     end
-   
+
     def load(value)
-      ::Time.find_zone!(value) rescue nil
+      self.class.load(value)
     end
   end
  

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

@@ -1,4 +1,3 @@
 class Post < ActiveRecord::Base
   has_paper_trail :class_name => "PostVersion"
-
 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/app/models/skipper.rb

@@ -0,0 +1,6 @@
+class Skipper < ActiveRecord::Base
+  has_paper_trail(
+    :ignore => [:created_at],
+    :skip => [:another_timestamp]
+  )
+end

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

@@ -1,6 +1,7 @@
 # Example from 'Overwriting default accessors' in ActiveRecord::Base.
 class Song < ActiveRecord::Base
   has_paper_trail
+  attr_accessor :name
 
   # Uses an integer of seconds to hold the length of the song
   def length=(minutes)
@@ -9,4 +10,23 @@ class Song < ActiveRecord::Base
   def length
     read_attribute(:length) / 60
   end
+
+  # override attributes hashes like some libraries do
+  def attributes_with_name
+    if name
+      attributes_without_name.merge(:name => name)
+    else
+      attributes_without_name
+    end
+  end
+  alias_method_chain :attributes, :name
+
+  def changed_attributes_with_name
+    if name
+      changed_attributes_without_name.merge(:name => name)
+    else
+      changed_attributes_without_name
+    end
+  end
+  alias_method_chain :changed_attributes, :name
 end

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

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

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

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

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

@@ -1,6 +1,11 @@
 class Widget < ActiveRecord::Base
   has_paper_trail
   has_one :wotsit
+  has_many :whatchamajiggers, :as => :owner
+
+  EXCLUDED_NAME = 'Biglet'
+
+  validates :name, :exclusion => { :in => [EXCLUDED_NAME] }
 
   if ::ActiveRecord::VERSION::MAJOR >= 4 # `has_many` syntax for specifying order uses a lambda in Rails 4
     has_many :fluxors, lambda { order(:name) }

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

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

data/test/dummy/app/versions/kitchen/banana_version.rb

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

data/test/dummy/config/application.rb

@@ -59,5 +59,11 @@ module Dummy
 
     # Rails 4 key for generating secret key
     config.secret_key_base = 'A fox regularly kicked the screaming pile of biscuits.'
+
+    # supress warnings about raises in transactional callbacks on AR 4.2+
+    config.active_record.raise_in_transactional_callbacks = true if ActiveRecord::VERSION::STRING >= '4.2'
+
+    # Set test order for Test::Unit if possible
+    config.active_support.test_order = :sorted if config.active_support.respond_to?(:test_order=)
   end
 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/environments/test.rb

@@ -11,7 +11,11 @@ Dummy::Application.configure do
   config.eager_load = true
 
   # Configure static asset server for tests with Cache-Control for performance
-  config.serve_static_assets = true
+  if config.respond_to?(:serve_static_files=)
+    config.serve_static_files = true
+  else
+    config.serve_static_assets = true
+  end
   config.static_cache_control = "public, max-age=3600"
 
   # Show full error reports and disable caching

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

@@ -1,5 +1,10 @@
+# Turn on associations tracking when the test suite is run on Travis CI
+PaperTrail.config.track_associations = true if ENV['TRAVIS']
+
 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?
+    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

@@ -1,5 +1,11 @@
 class SetUpTestTables < ActiveRecord::Migration
   def self.up
+    create_table :skippers, :force => true do |t|
+      t.string     :name
+      t.datetime   :another_timestamp
+      t.timestamps :null => true
+    end
+
     create_table :widgets, :force => true do |t|
       t.string    :name
       t.text      :a_text
@@ -12,7 +18,7 @@ class SetUpTestTables < ActiveRecord::Migration
       t.boolean   :a_boolean
       t.string    :sacrificial_column
       t.string    :type
-      t.timestamps
+      t.timestamps :null => true
     end
 
     create_table :versions, :force => true do |t|
@@ -22,6 +28,7 @@ class SetUpTestTables < ActiveRecord::Migration
       t.string   :whodunnit
       t.text     :object
       t.text     :object_changes
+      t.integer  :transaction_id
       t.datetime :created_at
 
       # Metadata columns.
@@ -37,6 +44,14 @@ class SetUpTestTables < ActiveRecord::Migration
     end
     add_index :versions, [:item_type, :item_id]
 
+    create_table :version_associations do |t|
+      t.integer  :version_id
+      t.string   :foreign_key_name, :null => false
+      t.integer  :foreign_key_id
+    end
+    add_index :version_associations, [:version_id]
+    add_index :version_associations, [:foreign_key_name, :foreign_key_id], :name => 'index_version_associations_on_foreign_key'
+
     create_table :post_versions, :force => true do |t|
       t.string   :item_type, :null => false
       t.integer  :item_id,   :null => false
@@ -51,10 +66,41 @@ class SetUpTestTables < ActiveRecord::Migration
     end
     add_index :post_versions, [:item_type, :item_id]
 
+    if ENV['DB'] == 'postgres' && ::ActiveRecord::VERSION::MAJOR >= 4
+      create_table :json_versions, :force => true do |t|
+        t.string   :item_type, :null => false
+        t.integer  :item_id,   :null => false
+        t.string   :event,     :null => false
+        t.string   :whodunnit
+        t.json     :object
+        t.json     :object_changes
+        t.datetime :created_at
+      end
+      add_index :json_versions, [:item_type, :item_id]
+    end
+
+    create_table :not_on_updates, :force => true do |t|
+      t.timestamps :null => true
+    end
+
+    create_table :bananas, :force => true do |t|
+      t.timestamps :null => true
+    end
+
+    create_table :banana_versions, :force => true do |t|
+      t.string   :item_type, :null => false
+      t.integer  :item_id,   :null => false
+      t.string   :event,     :null => false
+      t.string   :whodunnit
+      t.text     :object
+      t.datetime :created_at
+    end
+    add_index :banana_versions, [:item_type, :item_id]
+
     create_table :wotsits, :force => true do |t|
       t.integer :widget_id
       t.string  :name
-      t.timestamps
+      t.timestamps :null => true
     end
 
     create_table :fluxors, :force => true do |t|
@@ -62,6 +108,12 @@ class SetUpTestTables < ActiveRecord::Migration
       t.string  :name
     end
 
+    create_table :whatchamajiggers, :force => true do |t|
+      t.string  :owner_type
+      t.integer :owner_id
+      t.string  :name
+    end
+
     create_table :articles, :force => true do |t|
       t.string :title
       t.string :content
@@ -83,6 +135,15 @@ class SetUpTestTables < ActiveRecord::Migration
       t.string :time_zone
     end
 
+    create_table :editorships, :force => true do |t|
+      t.integer :book_id
+      t.integer :editor_id
+    end
+
+    create_table :editors, :force => true do |t|
+      t.string :name
+    end
+
     create_table :songs, :force => true do |t|
       t.integer :length
     end
@@ -110,6 +171,10 @@ class SetUpTestTables < ActiveRecord::Migration
       t.integer   :version
     end
 
+    create_table :things, :force => true do |t|
+      t.string    :name
+    end
+
     create_table :translations, :force => true do |t|
       t.string    :headline
       t.string    :content
@@ -120,28 +185,103 @@ class SetUpTestTables < ActiveRecord::Migration
     create_table :gadgets, :force => true do |t|
       t.string    :name
       t.string    :brand
-      t.timestamps
+      t.timestamps :null => true
+    end
+
+    create_table :customers, :force => true do |t|
+      t.string    :name
+    end
+
+    create_table :orders, :force => true do |t|
+      t.integer :customer_id
+      t.string  :order_date
+    end
+
+    create_table :line_items, :force => true do |t|
+      t.integer :order_id
+      t.string  :product
+    end
+
+    create_table :fruits, :force => true do |t|
+      t.string :name
+      t.string :color
+    end
+
+    create_table :boolits, :force => true do |t|
+      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
     drop_table :posts
     drop_table :songs
+    drop_table :editors
+    drop_table :editorships
     drop_table :people
     drop_table :authorships
     drop_table :books
     drop_table :articles
+    drop_table :whatchamajiggers
     drop_table :fluxors
     drop_table :wotsits
     remove_index :post_versions, :column => [:item_type, :item_id]
     drop_table :post_versions
     remove_index :versions, :column => [:item_type, :item_id]
     drop_table :versions
+    if JsonVersion.table_exists?
+      remove_index :json_versions, :column => [:item_type, :item_id]
+      drop_table :json_versions
+    end
     drop_table :widgets
     drop_table :documents
     drop_table :legacy_widgets
+    drop_table :things
     drop_table :translations
     drop_table :gadgets
+    drop_table :customers
+    drop_table :orders
+    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