paper_trail 1.6.5 → 2.0.0

data/.gitignore

@@ -0,0 +1,6 @@
+test/debug.log
+test/paper_trail_plugin.sqlite3.db
+coverage
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/Gemfile.lock

@@ -0,0 +1,107 @@
+PATH
+  remote: .
+  specs:
+    paper_trail (2.0.0)
+      rails (~> 3)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.3)
+      actionpack (= 3.0.3)
+      mail (~> 2.2.9)
+    actionpack (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.13)
+      rack-test (~> 0.5.6)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+    activesupport (3.0.3)
+    arel (2.0.7)
+    builder (2.1.2)
+    capybara (0.4.1.1)
+      celerity (>= 0.7.9)
+      culerity (>= 0.2.4)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (>= 0.0.27)
+      xpath (~> 0.1.3)
+    celerity (0.8.7)
+    childprocess (0.1.6)
+      ffi (~> 0.6.3)
+    culerity (0.2.15)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    ffi (0.6.3)
+      rake (>= 0.8.7)
+    i18n (0.5.0)
+    json_pure (1.5.1)
+    mail (2.2.15)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    nokogiri (1.4.4)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.3)
+      actionmailer (= 3.0.3)
+      actionpack (= 3.0.3)
+      activerecord (= 3.0.3)
+      activeresource (= 3.0.3)
+      activesupport (= 3.0.3)
+      bundler (~> 1.0)
+      railties (= 3.0.3)
+    railties (3.0.3)
+      actionpack (= 3.0.3)
+      activesupport (= 3.0.3)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    rake (0.8.7)
+    rubyzip (0.9.4)
+    selenium-webdriver (0.1.2)
+      childprocess (~> 0.1.5)
+      ffi (~> 0.6.3)
+      json_pure
+      rubyzip
+    shoulda (2.10.3)
+    sqlite3-ruby (1.3.1)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.24)
+    xpath (0.1.3)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  capybara (>= 0.4.0)
+  paper_trail!
+  shoulda (= 2.10.3)
+  sqlite3-ruby (~> 1.2)

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Andy Stewart, AirBlade Software Ltd.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -26,7 +26,7 @@ PaperTrail lets you track changes to your models' data.  It's good for auditing
 
 ## Rails Version
 
-Works on Rails 3 and Rails 2.3.  Probably works on Rails 2.2 and 2.1.
+Works on Rails 3 and Rails 2.3.  The Rails 3 code is on the master branch and tagged v2.x.  The Rails 2.3 code is on the Rails 2 branch and tagged 1.x.
 
 
 ## API Summary
@@ -383,8 +383,12 @@ You can store arbitrary model-level metadata alongside each version like this:
 
     class Article < ActiveRecord::Base
       belongs_to :author
-      has_paper_trail :meta => { :author_id => Proc.new { |article| article.author_id },
-                                 :answer    => 42 }
+      has_paper_trail :meta => { :author_id  => Proc.new { |article| article.author_id },
+                                 :word_count => :count_words,
+                                 :answer     => 42 }
+      def count_words
+        153
+      end
     end
 
 PaperTrail will call your proc with the current article and store the result in the `author_id` column of the `versions` table.  (Remember to add your metadata columns to the table.)
@@ -393,6 +397,8 @@ Why would you do this?  In this example, `author_id` is an attribute of `Article
 
     Version.all(:conditions => ['author_id = ?', author_id])
 
+Note you can pass a symbol as a value in the `meta` hash to signal a method to call.
+
 You can also store any information you like from your controller.  Just override the `info_for_paper_trail` method in your controller to return a hash whose keys correspond to columns in your `versions` table.  E.g.:
 
     class ApplicationController
@@ -484,7 +490,7 @@ Over time your `versions` table will grow to an unwieldy size.  Because each ver
 
 1. Install PaperTrail as a gem via your `Gemfile`:
 
-    `gem 'paper_trail'`
+    `gem 'paper_trail', '~> 2'`
 
 2. Generate a migration which will add a `versions` table to your database.
 
@@ -500,7 +506,7 @@ Over time your `versions` table will grow to an unwieldy size.  Because each ver
 
 1. Install PaperTrail as a gem via your `config/environment.rb`:
 
-    `config.gem 'paper_trail'`
+    `config.gem 'paper_trail', :version => '~> 1'`
 
 2. Generate a migration which will add a `versions` table to your database.
 

data/Rakefile

@@ -8,7 +8,7 @@ Rake::TestTask.new(:test) do |t|
   t.libs << 'lib'
   t.libs << 'test'
   t.pattern = 'test/**/*_test.rb'
-  t.verbose = true
+  t.verbose = false
 end
 
 desc 'Default: run unit tests.'

data/lib/paper_trail.rb

@@ -1,15 +1,11 @@
 require 'singleton'
 require 'yaml'
 
-require 'action_controller'
-require 'active_record'
-
 require 'paper_trail/config'
 require 'paper_trail/controller'
 require 'paper_trail/has_paper_trail'
 require 'paper_trail/version'
 
-
 # PaperTrail's module methods can be called in both models and controllers.
 module PaperTrail
 
@@ -66,3 +62,12 @@ module PaperTrail
   end
 
 end
+
+
+ActiveSupport.on_load(:active_record) do
+  include PaperTrail::Model
+end
+
+ActiveSupport.on_load(:action_controller) do
+  include PaperTrail::Controller
+end

data/lib/paper_trail/controller.rb

@@ -59,5 +59,3 @@ module PaperTrail
 
   end
 end
-
-ActionController::Base.send :include, PaperTrail::Controller

data/lib/paper_trail/has_paper_trail.rb

@@ -64,7 +64,7 @@ module PaperTrail
 
       # Returns who put the object into its current state.
       def originator
-        versions.last.try :whodunnit
+        Version.with_item_keys(self.class.name, id).last.try :whodunnit
       end
 
       # Returns the object (not a Version) as it was at the given timestamp.
@@ -112,6 +112,7 @@ module PaperTrail
                                         :object    => object_to_string(item_before_change),
                                         :whodunnit => PaperTrail.whodunnit)
         end
+        versions.send :load_target
       end
 
       def merge_metadata(data)
@@ -158,5 +159,3 @@ module PaperTrail
 
   end
 end
-
-ActiveRecord::Base.send :include, PaperTrail::Model

data/lib/paper_trail/version.rb

@@ -2,25 +2,22 @@ class Version < ActiveRecord::Base
   belongs_to :item, :polymorphic => true
   validates_presence_of :event
 
-  named_scope :with_item_keys, lambda { |item_type, item_id| {
-    :conditions => { :item_type => item_type, :item_id => item_id }
-  } }
-
-  named_scope :subsequent, lambda { |version| {
-    :conditions => ["id > ?", version.is_a?(ActiveRecord::Base) ? version.id : version],
-    :order      => "id ASC",
-  } }
-
-  named_scope :preceding, lambda { |version| {
-    :conditions => ["id < ?", version.is_a?(ActiveRecord::Base) ? version.id : version],
-    :order      => "id DESC",
-  } }
-
-  named_scope :after, lambda { |timestamp| {
-    :conditions => ['created_at > ?', timestamp],
+  scope :with_item_keys, lambda { |item_type, item_id|
+    where(:item_type => item_type, :item_id => item_id)
+  }
+
+  scope :subsequent, lambda { |version|
+    where(["id > ?", version.is_a?(Version) ? version.id : version]).order("id ASC")
+  }
+
+  scope :preceding, lambda { |version|
+    where(["id < ?", version.is_a?(Version) ? version.id : version]).order("id DESC")
+  }
+
+  scope :after, lambda { |timestamp|
     # TODO: is this :order necessary, considering its presence on the has_many :versions association?
-    :order      => 'created_at ASC, id ASC'
-  } }
+    where(['created_at > ?', timestamp]).order('created_at ASC, id ASC')
+  }
 
   # Restore the item from this version.
   #

data/lib/paper_trail/version_number.rb

@@ -1,3 +1,3 @@
 module PaperTrail
-  VERSION = '1.6.5'
+  VERSION = '2.0.0'
 end

data/paper_trail.gemspec

@@ -1,30 +1,23 @@
-$LOAD_PATH.unshift 'lib'
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
 require 'paper_trail/version_number'
 
 Gem::Specification.new do |s|
-  s.name             = '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            = %w[ README.md Rakefile paper_trail.gemspec ]
-  s.files           += %w[ init.rb install.rb ]
-  s.files           += Dir.glob("lib/**/*")
-  s.files           += Dir.glob("generators/**/*")
-  s.require_path     = 'lib'
-  s.test_files       = Dir.glob("test/**/*")
+  s.name          = '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.add_development_dependency 'bundler',       '~> 1.0'
-  s.add_development_dependency 'rake',          '0.8.7'  # TODO: why do we need to list rake?
-  s.add_development_dependency 'shoulda',       '2.10.3'
-  s.add_development_dependency 'activesupport', '~> 2.3'
-  s.add_development_dependency 'sqlite3-ruby',  '~> 1.2'
-  # Repeated here to make bundler happy
-  s.add_development_dependency 'activerecord',  '~> 2.3'
-  s.add_development_dependency 'actionpack',    '~> 2.3'
+  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',  '~> 2.3'
-  s.add_dependency 'actionpack',    '~> 2.3'
+  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'
 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,16 @@
+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,18 @@
+class WidgetsController < ApplicationController
+  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/article.rb

@@ -0,0 +1,11 @@
+class Article < ActiveRecord::Base
+  has_paper_trail :ignore => [:title],
+                  :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/fluxor.rb

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