paper_trail 1.2.14 → 1.3.1

data/.gitignore

@@ -1,2 +1,3 @@
 test/debug.log
 test/paper_trail_plugin.sqlite3.db
+coverage

data/README.md

@@ -6,7 +6,7 @@ PaperTrail lets you track changes to your models' data.  It's good for auditing
 ## Features
 
 * Stores every create, update and destroy.
-* Does not store updates which don't change anything.
+* Does not store updates which don't change anything (or which only change attributes you are ignoring).
 * Allows you to get at every version, including the original, even once destroyed.
 * Allows you to get at every version even if the schema has since changed.
 * Automatically records who was responsible if your controller has a `current_user` method.
@@ -87,6 +87,25 @@ Here's a helpful table showing what PaperTrail stores:
 PaperTrail stores the values in the Model Before column.  Most other auditing/versioning plugins store the After column.
 
 
+## Ignoring changes to certain attributes
+
+You can ignore changes to certain attributes like this:
+
+    class Article < ActiveRecord::Base
+      has_paper_trail :ignore => [:title, :rating]
+    end
+
+This means that changes to just the `title` or `rating` will not store another version of the article.  It does not mean that the `title` and `rating` attributes will be ignored if some other change causes a new `Version` to be crated.  For example:
+
+    >> a = Article.create
+    >> a.versions.length                         # 1
+    >> a.update_attributes :title => 'My Title', :rating => 3
+    >> a.versions.length                         # 1
+    >> a.update_attributes :content => 'Hello'
+    >> a.versions.length                         # 2
+    >> a.versions.last.reify.title               # 'My Title'
+
+
 ## Reverting And Undeleting A Model
 
 PaperTrail makes reverting to a previous version easy:
@@ -160,7 +179,7 @@ And on again like this:
 
 ## Testing
 
-PaperTrail has a thorough suite of tests.  However they only run when PaperTrail is sitting in a Rails app's `vendor/plugins` directory.  If anyone can tell me how to get them to run outside of a Rails app, I'd love to hear it.
+PaperTrail has a thorough suite of tests.  Thanks to [Zachery Hostens](http://github.com/zacheryph) for making them able to run standalone, i.e. without needing PaperTrail to be sitting in a Rails app.
 
 
 ## Problems
@@ -168,6 +187,13 @@ PaperTrail has a thorough suite of tests.  However they only run when PaperTrail
 Please use GitHub's [issue tracker](http://github.com/airblade/paper_trail/issues).
 
 
+## Contributors
+
+Many thanks to:
+
+* [Zachery Hostens](http://github.com/zacheryph)
+
+
 ## Inspirations
 
 * [Simply Versioned](http://github.com/github/simply_versioned)

data/Rakefile

@@ -11,8 +11,9 @@ begin
     gemspec.homepage = 'http://github.com/airblade/paper_trail'
     gemspec.authors = ['Andy Stewart']
   end
+  Jeweler::GemcutterTasks.new
 rescue LoadError
-  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
 end
 
 desc 'Test the paper_trail plugin.'

data/VERSION

@@ -1 +1 @@
-1.2.13
+1.3.1

data/generators/paper_trail/templates/create_versions.rb

@@ -7,10 +7,8 @@ class CreateVersions < ActiveRecord::Migration
       t.string   :whodunnit
       t.text     :object
       t.datetime :created_at
-      t.integer  :user_id,   :null => true
     end
     add_index :versions, [:item_type, :item_id]
-    add_index :versions, :user_id
   end
 
   def self.down

data/lib/paper_trail.rb

@@ -1,27 +1,14 @@
 require 'yaml'
-require 'paper_trail/config'
 require 'paper_trail/has_paper_trail'
 require 'paper_trail/version'
 
 module PaperTrail
   @@whodunnit = nil
 
-  def self.config
-    @@config ||= PaperTrail::Config.instance
-  end
-
   def self.included(base)
     base.before_filter :set_whodunnit
   end
 
-  def self.enabled=(value)
-    PaperTrail.config.enabled = value
-  end
-
-  def self.enabled?
-    !!PaperTrail.config.enabled
-  end
-
   def self.whodunnit
     @@whodunnit.respond_to?(:call) ? @@whodunnit.call : @@whodunnit
   end
@@ -37,7 +24,6 @@ module PaperTrail
       self.send :current_user rescue nil
     }
   end
-
 end
 
 ActionController::Base.send :include, PaperTrail

data/lib/paper_trail/has_paper_trail.rb

@@ -6,9 +6,14 @@ module PaperTrail
 
 
   module ClassMethods
-    def has_paper_trail
+    # Options:
+    # :ignore    an array of attributes for which a new +Version+ will not be created if only they change.
+    def has_paper_trail(options = {})
       send :include, InstanceMethods
 
+      cattr_accessor :ignore
+      self.ignore = (options[:ignore] || []).map &:to_s
+      
       cattr_accessor :paper_trail_active
       self.paper_trail_active = true
 
@@ -32,11 +37,11 @@ module PaperTrail
   module InstanceMethods
     def record_create
       versions.create(:event     => 'create',
-                      :whodunnit => PaperTrail.whodunnit) if self.class.paper_trail_active && PaperTrail.enabled?
+                      :whodunnit => PaperTrail.whodunnit) if self.class.paper_trail_active
     end
 
     def record_update
-      if changed? and self.class.paper_trail_active and PaperTrail.enabled?
+      if changed_and_we_care? and self.class.paper_trail_active
         versions.build :event     => 'update',
                        :object    => object_to_string(previous_version),
                        :whodunnit => PaperTrail.whodunnit
@@ -46,59 +51,9 @@ module PaperTrail
     def record_destroy
       versions.create(:event     => 'destroy',
                       :object    => object_to_string(previous_version),
-                      :whodunnit => PaperTrail.whodunnit) if self.class.paper_trail_active && PaperTrail.enabled?
+                      :whodunnit => PaperTrail.whodunnit) if self.class.paper_trail_active
     end
 
-    # Returns the object at the version that was valid at the given timestamp.
-    def version_at timestamp
-      # short-circuit if the current state is valid
-      return self if self.updated_at < timestamp
-
-      version = versions.first(
-        :conditions => ['created_at < ?', timestamp],
-        :order => 'created_at DESC')
-      version.reify if version
-    end
-
-    # Walk the versions to construct an audit trail of the edits made
-    # over time, and by whom.
-    def audit_trail options={}
-      options[:attributes_to_ignore] ||= %w(updated_at)
-
-      audit_trail = []
-
-      versions_desc = versions_including_current_in_descending_order
-
-      versions_desc.each_with_index do |version, index|
-        previous_version = versions_desc[index + 1]
-        break if previous_version.nil?
-
-        attributes_after = yaml_to_hash(version.object)
-        attributes_before = yaml_to_hash(previous_version.object)
-
-        # remove some attributes that we don't need to report
-        [attributes_before, attributes_after].each do |hash|
-          hash.reject! { |k,v| k.in? Array(options[:attributes_to_ignore]) }
-        end
-
-        audit_trail << {
-          :event => previous_version.event,
-          :changed_by => transform_whodunnit(previous_version.whodunnit),
-          :changed_at => previous_version.created_at,
-          :changes => differences(attributes_before, attributes_after)
-          }
-      end
-
-      audit_trail
-    end
-
-    protected
-
-    def transform_whodunnit(whodunnit)
-      whodunnit
-    end
-
-
     private
 
     def previous_version
@@ -114,30 +69,8 @@ module PaperTrail
       object.attributes.to_yaml
     end
 
-    def yaml_to_hash(yaml)
-      return {} if yaml.nil?
-      YAML::load(yaml).to_hash
-    end
-
-    # Returns an array of hashes, where each hash specifies the +:attribute+,
-    # value +:before+ the change, and value +:after+ the change.
-    def differences(before, after)
-      before.diff(after).keys.sort.inject([]) do |diffs, k|
-        diff = { :attribute => k, :before => before[k], :after => after[k] }
-        diffs << diff; diffs
-      end
-    end
-
-    def versions_including_current_in_descending_order
-      if self.new_record?
-        v = Version.all(:order => 'created_at desc', :conditions => {:item_id => id, :item_type => self.class.name})
-      else
-        v = self.versions.dup
-      end
-      v << Version.new(:event => 'update',
-        :object => object_to_string(self),
-        :created_at => self.updated_at)
-      v.reverse # newest first
+    def changed_and_we_care?
+      changed? and !(changed - self.class.ignore).empty?
     end
   end
 

data/lib/paper_trail/version.rb

@@ -1,19 +1,7 @@
 class Version < ActiveRecord::Base
   belongs_to :item, :polymorphic => true
-  belongs_to :user
-  before_save :set_user_id
   validates_presence_of :event
 
-  named_scope :for_item_type, lambda { |item_types|
-    { :conditions => { :item_type => item_types } }
-  }
-
-  named_scope :created_after, lambda { |time|
-    { :conditions => ['versions.created_at > ?', time] }
-  }
-
-  named_scope :by_created_at_ascending, :order => 'versions.created_at asc'
-
   def reify
     unless object.nil?
       # Attributes
@@ -45,7 +33,7 @@ class Version < ActiveRecord::Base
         begin
           model.send "#{k}=", v
         rescue NoMethodError
-          RAILS_DEFAULT_LOGGER.warn "Attribute #{k} does not exist on #{item_type} (Version id: #{id})."
+          logger.warn "Attribute #{k} does not exist on #{item_type} (Version id: #{id})."
         end
       end
 
@@ -68,10 +56,4 @@ class Version < ActiveRecord::Base
                 :order => 'id ASC').index(self)
   end
   
-  private
-
-  def set_user_id
-    self.user_id = self.whodunnit.id if self.whodunnit.is_a?(ActiveRecord::Base)
-    return true
-  end
 end

data/paper_trail.gemspec

@@ -1,13 +1,16 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{paper_trail}
-  s.version = "1.2.14"
+  s.version = "1.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Andy Stewart", "Jeremy Weiskotten", "Joe Lind"]
-  s.date = %q{2009-10-02}
-  s.email = %q{jeremy@weiskotten.com}
+  s.authors = ["Andy Stewart"]
+  s.date = %q{2009-11-24}
+  s.email = %q{boss@airbladesoftware.com}
   s.extra_rdoc_files = [
     "README.md"
   ]
@@ -23,7 +26,6 @@ Gem::Specification.new do |s|
      "init.rb",
      "install.rb",
      "lib/paper_trail.rb",
-     "lib/paper_trail/config.rb",
      "lib/paper_trail/has_paper_trail.rb",
      "lib/paper_trail/version.rb",
      "paper_trail.gemspec",
@@ -38,8 +40,7 @@ Gem::Specification.new do |s|
      "test/test_helper.rb",
      "uninstall.rb"
   ]
-  s.has_rdoc = true
-  s.homepage = %q{http://github.com/jeremyw/paper_trail}
+  s.homepage = %q{http://github.com/airblade/paper_trail}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.5}
@@ -53,13 +54,14 @@ Gem::Specification.new do |s|
      "test/test_helper.rb"
   ]
 
-  # if s.respond_to? :specification_version then
-  #   current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-  #   s.specification_version = 2
-  #
-  #   if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-  #   else
-  #   end
-  # else
-  # end
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
 end
+

data/test/database.yml

@@ -1,22 +1,18 @@
-sqlite:
-  :adapter: sqlite
-  :dbfile: vendor/plugins/paper_trail/test/paper_trail_plugin.sqlite.db
-
 sqlite3:
-  :adapter: sqlite3
-  :dbfile: vendor/plugins/paper_trail/test/paper_trail_plugin.sqlite3.db
+  adapter: sqlite3
+  database: ":memory:"
 
 postgresql:
-  :adapter: postgresql
-  :username: postgres
-  :password: postgres
-  :database: paper_trail_plugin_test
-  :min_messages: ERROR
+  adapter: postgresql
+  username: postgres
+  password: postgres
+  database: paper_trail_plugin_test
+  min_messages: ERROR
 
 mysql:
-  :adapter: mysql
-  :host: localhost
-  :username: andy
-  :password: 
-  :database: paper_trail_plugin_test
-  :socket: /tmp/mysql.sock
+  adapter: mysql
+  host: localhost
+  username: andy
+  password: 
+  database: paper_trail_plugin_test
+  socket: /tmp/mysql.sock

data/test/paper_trail_controller_test.rb

@@ -1,8 +1,6 @@
 require File.dirname(__FILE__) + '/test_helper.rb'
-require 'application_controller'
-require 'action_controller/test_process'
 
-class ApplicationController
+class ApplicationController < ActionController::Base
   def rescue_action(e)
     raise e
   end

data/test/paper_trail_model_test.rb

@@ -17,10 +17,29 @@ class Fluxor < ActiveRecord::Base
   belongs_to :widget
 end
 
+class Article < ActiveRecord::Base
+  has_paper_trail :ignore => [:title]
+end
+
 
 class HasPaperTrailModelTest < Test::Unit::TestCase
   load_schema
 
+  context 'A record' do
+    setup { @article = Article.create }
+    
+    context 'which updates an ignored column' do
+      setup { @article.update_attributes :title => 'My first title' }
+      should_not_change('the number of versions') { Version.count }
+    end
+
+    context 'which updates an ignored column and a non-ignored column' do
+      setup { @article.update_attributes :title => 'My first title', :content => 'Some text here.' }
+      should_change('the number of versions', :by => 1) { Version.count }
+    end
+
+  end
+
   context 'A new record' do
     setup { @widget = Widget.new }
 
@@ -194,7 +213,7 @@ class HasPaperTrailModelTest < Test::Unit::TestCase
     should 'handle datetimes' do
       # Is there a better way to test equality of two datetimes?
       format = '%a, %d %b %Y %H:%M:%S %z' # :rfc822
-      assert_equal @date_time.strftime(format), @previous.a_datetime.strftime(format)
+      assert_equal @date_time.utc.strftime(format), @previous.a_datetime.utc.strftime(format)
     end
 
     should 'handle times' do
@@ -224,14 +243,14 @@ class HasPaperTrailModelTest < Test::Unit::TestCase
 
       should 'restore all forward-compatible attributes' do
         format = '%a, %d %b %Y %H:%M:%S %z' # :rfc822
-        assert_equal    'Warble',                    @last.reify.name
-        assert_equal    'The quick brown fox',       @last.reify.a_text
-        assert_equal    42,                          @last.reify.an_integer
-        assert_in_delta 153.01,                      @last.reify.a_float,   0.001
-        assert_in_delta 2.71828,                     @last.reify.a_decimal, 0.00001
-        assert_equal    @date_time.strftime(format), @last.reify.a_datetime.strftime(format)
-        assert_equal    @time,                       @last.reify.a_time
-        assert_equal    @date,                       @last.reify.a_date
+        assert_equal    'Warble',                        @last.reify.name
+        assert_equal    'The quick brown fox',           @last.reify.a_text
+        assert_equal    42,                              @last.reify.an_integer
+        assert_in_delta 153.01,                          @last.reify.a_float,   0.001
+        assert_in_delta 2.71828,                         @last.reify.a_decimal, 0.00001
+        assert_equal    @date_time.utc.strftime(format), @last.reify.a_datetime.utc.strftime(format)
+        assert_equal    @time,                           @last.reify.a_time
+        assert_equal    @date,                           @last.reify.a_date
         assert          @last.reify.a_boolean
       end
     end

data/test/paper_trail_schema_test.rb

@@ -10,5 +10,6 @@ class PaperTrailSchemaTest < ActiveSupport::TestCase
     assert_equal [], Version.all
     assert_equal [], Wotsit.all
     assert_equal [], Fluxor.all
+    assert_equal [], Article.all
   end
 end

data/test/schema.rb

@@ -35,4 +35,9 @@ ActiveRecord::Schema.define(:version => 0) do
     t.string  :name
   end
 
+  create_table :articles, :force => true do |t|
+    t.integer :title
+    t.string  :content
+  end
+
 end

data/test/test_helper.rb

@@ -1,33 +1,29 @@
-require 'rubygems'
-require 'active_support'
-require 'active_support/test_case'
-require 'shoulda'
-
-ENV['RAILS_ENV'] = 'test'
-ENV['RAILS_ROOT'] ||= File.dirname(__FILE__) + '/../../../..'
-
 require 'test/unit'
-require File.expand_path(File.join(ENV['RAILS_ROOT'], 'config/environment.rb'))
+RAILS_ROOT = File.join(File.dirname(__FILE__), %w{.. .. .. ..})
+$:.unshift(File.join(File.dirname(__FILE__), %w{.. lib}))
+
+unless defined?(ActiveRecord)
+  if File.directory? RAILS_ROOT + 'config'
+    puts 'using config/boot.rb'
+    ENV['RAILS_ENV'] = 'test'
+    require File.join(RAILS_ROOT, 'config', 'boot.rb')
+  else
+    # simply use installed gems if available
+    puts 'using rubygems'
+    require 'rubygems'
+    gem 'actionpack'; gem 'activerecord'; gem 'activesupport'; gem 'rails'
+  end
+
+  %w(action_pack action_controller active_record active_support initializer).each {|f| require f}
+end
+require 'shoulda'
+require 'paper_trail'
 
 def connect_to_database
   config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
   ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
 
-  db_adapter = ENV['DB']
-
-  # no db passed, try one of these fine config-free DBs before bombing.
-  db_adapter ||=
-    begin
-      require 'rubygems'
-      require 'sqlite'
-      'sqlite'
-    rescue MissingSourceFile
-      begin
-        require 'sqlite3'
-        'sqlite3'
-      rescue MissingSourceFile
-      end
-    end
+  db_adapter = ENV['DB'] || 'sqlite3'
 
   if db_adapter.nil?
     raise "No DB Adapter selected. Pass the DB= option to pick one, or install Sqlite or Sqlite3."

metadata

@@ -1,22 +1,20 @@
 --- !ruby/object:Gem::Specification 
 name: paper_trail
 version: !ruby/object:Gem::Version 
-  version: 1.2.14
+  version: 1.3.1
 platform: ruby
 authors: 
 - Andy Stewart
-- Jeremy Weiskotten
-- Joe Lind
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-10-02 00:00:00 -04:00
+date: 2009-11-24 00:00:00 +00:00
 default_executable: 
 dependencies: []
 
 description: 
-email: jeremy@weiskotten.com
+email: boss@airbladesoftware.com
 executables: []
 
 extensions: []
@@ -35,7 +33,6 @@ files:
 - init.rb
 - install.rb
 - lib/paper_trail.rb
-- lib/paper_trail/config.rb
 - lib/paper_trail/has_paper_trail.rb
 - lib/paper_trail/version.rb
 - paper_trail.gemspec
@@ -50,7 +47,7 @@ files:
 - test/test_helper.rb
 - uninstall.rb
 has_rdoc: true
-homepage: http://github.com/jeremyw/paper_trail
+homepage: http://github.com/airblade/paper_trail
 licenses: []
 
 post_install_message: 

data/lib/paper_trail/config.rb

@@ -1,10 +0,0 @@
-module PaperTrail
-  class Config
-    include Singleton
-    attr_accessor :enabled
-
-    def initialize
-      @enabled = true
-    end
-  end
-end