bkwld-paper_trail 2.3.2

data/lib/paper_trail/version.rb

@@ -0,0 +1,159 @@
+class Version < ActiveRecord::Base
+  belongs_to :item, :polymorphic => true
+  validates_presence_of :event
+  serialize :columns
+
+  def self.with_item_keys(item_type, item_id)
+    scoped(:conditions => { :item_type => item_type, :item_id => item_id })
+  end
+
+  scope :subsequent, lambda { |version|
+    where(["#{self.primary_key} > ?", version.is_a?(self) ? version.id : version]).order("#{self.primary_key} ASC")
+  }
+
+  scope :preceding, lambda { |version|
+    where(["#{self.primary_key} < ?", version.is_a?(self) ? version.id : version]).order("#{self.primary_key} DESC")
+  }
+
+  scope :after, lambda { |timestamp|
+    # TODO: is this :order necessary, considering its presence on the has_many :versions association?
+    where(['created_at > ?', timestamp]).order("created_at ASC, #{self.primary_key} ASC")
+  }
+
+  # Restore the item from this version.
+  #
+  # This will automatically restore all :has_one associations as they were "at the time",
+  # if they are also being versioned by PaperTrail.  NOTE: this isn't always guaranteed
+  # to work so you can either change the lookback period (from the default 3 seconds) or
+  # opt out.
+  #
+  # Options:
+  # +:has_one+   set to `false` to opt out of has_one reification.
+  #              set to a float to change the lookback time (check whether your db supports
+  #              sub-second datetimes if you want them).
+  def reify(options = {})
+    without_identity_map do
+      options[:has_one] = 3 if options[:has_one] == true
+      options.reverse_merge! :has_one => false
+
+      unless object.nil?
+        attrs = YAML::load object
+
+        # Normally a polymorphic belongs_to relationship allows us
+        # to get the object we belong to by calling, in this case,
+        # +item+.  However this returns nil if +item+ has been
+        # destroyed, and we need to be able to retrieve destroyed
+        # objects.
+        #
+        # In this situation we constantize the +item_type+ to get hold of
+        # the class...except when the stored object's attributes
+        # include a +type+ key.  If this is the case, the object
+        # we belong to is using single table inheritance and the
+        # +item_type+ will be the base class, not the actual subclass.
+        # If +type+ is present but empty, the class is the base class.
+
+        if item
+          model = item
+        else
+          inheritance_column_name = item_type.constantize.inheritance_column
+          class_name = attrs[inheritance_column_name].blank? ? item_type : attrs[inheritance_column_name]
+          klass = class_name.constantize
+          model = klass.new
+        end
+
+        attrs.each do |k, v|
+          begin
+            model.send :write_attribute, k.to_sym , v
+          rescue NoMethodError
+            logger.warn "Attribute #{k} does not exist on #{item_type} (Version id: #{id})."
+          end
+        end
+
+        model.version = self
+
+        unless options[:has_one] == false
+          reify_has_ones model, options[:has_one]
+        end
+
+        model
+      end
+    end
+  end
+
+  # Returns what changed in this version of the item.  Cf. `ActiveModel::Dirty#changes`.
+  # Returns nil if your `versions` table does not have an `object_changes` text column.
+  def changeset
+    if self.class.column_names.include? 'object_changes'
+      if changes = object_changes
+        HashWithIndifferentAccess[YAML::load(changes)]
+      else
+        {}
+      end
+    end
+  end
+
+  # Returns who put the item into the state stored in this version.
+  def originator
+    previous.try :whodunnit
+  end
+
+  # Returns who changed the item from the state it had in this version.
+  # This is an alias for `whodunnit`.
+  def terminator
+    whodunnit
+  end
+
+  def sibling_versions
+    self.class.with_item_keys(item_type, item_id)
+  end
+
+  def next
+    sibling_versions.subsequent(self).first
+  end
+
+  def previous
+    sibling_versions.preceding(self).first
+  end
+
+  def index
+    sibling_versions.select(:id).order("id ASC").map(&:id).index(self.id)
+  end
+
+  private
+
+  # In Rails 3.1+, calling reify on a previous version confuses the
+  # IdentityMap, if enabled. This prevents insertion into the map.
+  def without_identity_map(&block)
+    if defined?(ActiveRecord::IdentityMap) && ActiveRecord::IdentityMap.respond_to?(:without)
+      ActiveRecord::IdentityMap.without(&block)
+    else
+      block.call
+    end
+  end
+
+  # Restore the `model`'s has_one associations as they were when this version was
+  # superseded by the next (because that's what the user was looking at when they
+  # made the change).
+  #
+  # The `lookback` sets how many seconds before the model's change we go.
+  def reify_has_ones(model, lookback)
+    model.class.reflect_on_all_associations(:has_one).each do |assoc|
+      child = model.send assoc.name
+      if child.respond_to? :version_at
+        # N.B. we use version of the child as it was `lookback` seconds before the parent was updated.
+        # Ideally we want the version of the child as it was just before the parent was updated...
+        # but until PaperTrail knows which updates are "together" (e.g. parent and child being
+        # updated on the same form), it's impossible to tell when the overall update started;
+        # and therefore impossible to know when "just before" was.
+        if (child_as_it_was = child.version_at(created_at - lookback.seconds))
+          child_as_it_was.attributes.each do |k,v|
+            model.send(assoc.name).send :write_attribute, k.to_sym, v rescue nil
+          end
+        else
+          model.send "#{assoc.name}=", nil
+        end
+      end
+    end
+  end
+
+end

data/lib/paper_trail/version_number.rb

@@ -0,0 +1,3 @@
+module PaperTrail
+  VERSION = '2.3.2'
+end

data/paper_trail.gemspec

@@ -0,0 +1,24 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'paper_trail/version_number'
+
+Gem::Specification.new do |s|
+  s.name          = 'bkwld-paper_trail'
+  s.version       = PaperTrail::VERSION
+  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.email         = 'boss@airbladesoftware.com'
+
+  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 'rails', '~> 3'
+
+  s.add_development_dependency 'shoulda',      '2.10.3'
+  s.add_development_dependency 'sqlite3-ruby', '~> 1.2'
+  s.add_development_dependency 'capybara',     '>= 0.4.0'
+  s.add_development_dependency 'turn'
+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,23 @@
+class WidgetsController < ApplicationController
+
+  def paper_trail_enabled_for_controller
+    request.user_agent != 'Disable User-Agent'
+  end
+
+  def create
+    @widget = Widget.create params[:widget]
+    head :ok
+  end
+
+  def update
+    @widget = Widget.find params[:id]
+    @widget.update_attributes params[:widget]
+    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
+  set_inheritance_column 'species'
+end

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

@@ -0,0 +1,12 @@
+class Article < ActiveRecord::Base
+  has_paper_trail :ignore => :title,
+                  :only => [:content],
+                  :meta   => {:answer => 42,
+                              :action => :action_data_provider_method,
+                              :question => Proc.new { "31 + 11 = #{31 + 11}" },
+                              :article_id => Proc.new { |article| article.id } }
+
+  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/person.rb

@@ -0,0 +1,5 @@
+class Person < ActiveRecord::Base
+  has_many :authorships, :dependent => :destroy
+  has_many :books, :through => :authorships
+  has_paper_trail
+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/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/widget.rb

@@ -0,0 +1,5 @@
+class Widget < ActiveRecord::Base
+  has_paper_trail
+  has_one :wotsit
+  has_many :fluxors, :order => :name
+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 < Version
+  set_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,45 @@
+require File.expand_path('../boot', __FILE__)
+
+require "active_model/railtie"
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_view/railtie"
+require "action_mailer/railtie"
+
+Bundler.require
+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
+
+    # JavaScript files you want as :defaults (application.js is always included).
+    # config.action_view.javascript_expansions[:defaults] = %w(jquery rails)
+
+    # 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]
+  end
+end

data/test/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)