paper_trail 1.4.0 → 1.4.1

data/README.md

@@ -10,6 +10,7 @@ PaperTrail lets you track changes to your models' data.  It's good for auditing
 * Does not store updates 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.
+* Allows you to get at the version as of a particular time.
 * Automatically records who was responsible if your controller has a `current_user` method.
 * Allows you to set who is responsible at model-level (useful for migrations).
 * Allows you to store arbitrary metadata with each version (useful for filtering versions).
@@ -118,6 +119,13 @@ PaperTrail makes reverting to a previous version easy:
     >> widget = widget.versions.last.reify  # the widget as it was before the update
     >> widget.save                          # reverted
 
+Alternatively you can find the version at a given time:
+
+    >> widget = widget.version_at(1.day.ago)  # the widget as it was one day ago
+    >> widget.save                            # reverted
+
+Note `version_at` gives you the object, not a version, so you don't need to call `reify`.
+
 Undeleting is just as simple:
 
     >> widget = Widget.find 42
@@ -201,6 +209,11 @@ And on again like this:
 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.
 
 
+## Articles
+
+[Keep a Paper Trail with PaperTrail](http://www.linux-mag.com/id/7528), Linux Magazine, 16th September 2009.
+
+
 ## Problems
 
 Please use GitHub's [issue tracker](http://github.com/airblade/paper_trail/issues).
@@ -211,6 +224,7 @@ Please use GitHub's [issue tracker](http://github.com/airblade/paper_trail/issue
 Many thanks to:
 
 * [Zachery Hostens](http://github.com/zacheryph)
+* [Jeremy Weiskotten](http://github.com/jeremyw)
 
 
 ## Inspirations

data/VERSION

@@ -1 +1 @@
-1.4.0
+1.4.1

data/init.rb

@@ -1 +1 @@
-# Include hook code here
+require 'paper_trail'

data/install.rb

@@ -1 +1 @@
-# Install hook code here
+puts 'You have chosen wisely.'

data/lib/paper_trail/has_paper_trail.rb

@@ -19,7 +19,7 @@ module PaperTrail
 
       cattr_accessor :meta
       self.meta = options[:meta] || {}
-      
+
       cattr_accessor :paper_trail_active
       self.paper_trail_active = true
 
@@ -63,6 +63,18 @@ module PaperTrail
       end
     end
 
+    # Returns the object (not a Version) as it was at the given timestamp.
+    def version_at(timestamp)
+      # Short-circuit if the current state is applicable.
+      return self if self.updated_at <= timestamp
+      # Look for the first version created after, rather than before, the
+      # timestamp because a version stores how the object looked before the
+      # change.
+      version = versions.first :conditions => ['created_at > ?', timestamp],
+                               :order      => 'created_at ASC'
+      version.reify if version
+    end
+
     private
 
     def merge_metadata(data)

data/paper_trail.gemspec

@@ -1,15 +1,15 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in rakefile, and run the gemspec command
+# 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.4.0"
+  s.version = "1.4.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andy Stewart"]
-  s.date = %q{2010-01-06}
+  s.date = %q{2010-03-18}
   s.email = %q{boss@airbladesoftware.com}
   s.extra_rdoc_files = [
     "README.md"
@@ -29,9 +29,7 @@ Gem::Specification.new do |s|
      "lib/paper_trail/has_paper_trail.rb",
      "lib/paper_trail/version.rb",
      "paper_trail.gemspec",
-     "rails/init.rb",
      "tasks/paper_trail_tasks.rake",
-     "test/database.yml",
      "test/paper_trail_controller_test.rb",
      "test/paper_trail_model_test.rb",
      "test/paper_trail_schema_test.rb",

data/test/paper_trail_controller_test.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/test_helper.rb'
+require 'test_helper'
 
 class ApplicationController < ActionController::Base
   def rescue_action(e)
@@ -32,10 +32,11 @@ end
 
 
 class PaperTrailControllerTest < ActionController::TestCase #Test::Unit::TestCase
+  tests WidgetsController
   def setup
-    @controller = WidgetsController.new
-    @request = ActionController::TestRequest.new
-    @response = ActionController::TestResponse.new
+    #@controller = WidgetsController.new
+    #@request = ActionController::TestRequest.new
+    #@response = ActionController::TestResponse.new
 
     ActionController::Routing::Routes.draw do |map|
       map.resources :widgets

data/test/paper_trail_model_test.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/test_helper.rb'
+require 'test_helper'
 
 class Widget < ActiveRecord::Base
   has_paper_trail
@@ -30,7 +30,7 @@ class HasPaperTrailModelTest < Test::Unit::TestCase
 
   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 }
@@ -100,7 +100,7 @@ class HasPaperTrailModelTest < Test::Unit::TestCase
           assert_match /update/i, @widget.versions.last.event
         end
 
-        
+
         context 'and has one associated object' do
           setup do
             @wotsit = @widget.create_wotsit :name => 'John'
@@ -356,6 +356,47 @@ class HasPaperTrailModelTest < Test::Unit::TestCase
       @widget.update_attributes :name => 'Digit'
     end
 
+    context 'which were created over time' do
+      setup do
+        @created       = 2.days.ago
+        @first_update  = 1.day.ago
+        @second_update = 1.hour.ago
+        @widget.versions[0].update_attributes :created_at => @created
+        @widget.versions[1].update_attributes :created_at => @first_update
+        @widget.versions[2].update_attributes :created_at => @second_update
+        @widget.update_attribute :updated_at, @second_update
+      end
+
+      should 'return nil for version_at before it was created' do
+        assert_nil @widget.version_at(@created - 1)
+      end
+
+      should 'return how it looked when created for version_at its creation' do
+        assert_equal 'Widget', @widget.version_at(@created).name
+      end
+
+      should "return how it looked when created for version_at just before its first update" do
+        assert_equal 'Widget', @widget.version_at(@first_update - 1).name
+      end
+
+      should "return how it looked when first updated for version_at its first update" do
+        assert_equal 'Fidget', @widget.version_at(@first_update).name
+      end
+
+      should 'return how it looked when first updated for version_at just before its second update' do
+        assert_equal 'Fidget', @widget.version_at(@second_update - 1).name
+      end
+
+      should 'return how it looked when subsequently updated for version_at its second update' do
+        assert_equal 'Digit', @widget.version_at(@second_update).name
+      end
+
+      should 'return the current object for version_at after latest update' do
+        assert_equal 'Digit', @widget.version_at(1.day.from_now).name
+      end
+    end
+
+
     context 'on the first version' do
       setup { @version = @widget.versions.first }
 

data/test/test_helper.rb

@@ -1,43 +1,37 @@
-require 'test/unit'
-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
+require 'rubygems'
 
-  %w(action_pack action_controller active_record active_support initializer).each {|f| require f}
-end
+require 'test/unit'
 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'] || 'sqlite3'
+require 'active_record'
+require 'action_controller'
+require 'action_controller/test_process'
+require 'active_support'
+require 'active_support/test_case'
 
-  if db_adapter.nil?
-    raise "No DB Adapter selected. Pass the DB= option to pick one, or install Sqlite or Sqlite3."
-  end
+require 'lib/paper_trail'
 
-  ActiveRecord::Base.establish_connection(config[db_adapter])
+def connect_to_database
+  ActiveRecord::Base.establish_connection(
+    :adapter  => "sqlite3",
+    :database => ":memory:"
+  )
+  ActiveRecord::Migration.verbose = false
 end
 
 def load_schema
   connect_to_database
-  load(File.dirname(__FILE__) + "/schema.rb")
-  require File.dirname(__FILE__) + '/../rails/init.rb'
+  load File.dirname(__FILE__) + '/schema.rb'
 end
 
 def change_schema
-  load(File.dirname(__FILE__) + "/schema_change.rb")
+  load File.dirname(__FILE__) + '/schema_change.rb'
+end
+
+class ActiveRecord::Base
+  def logger
+    @logger ||= Logger.new(nil)
+  end
 end
+
+load_schema

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: paper_trail
 version: !ruby/object:Gem::Version 
-  version: 1.4.0
+  version: 1.4.1
 platform: ruby
 authors: 
 - Andy Stewart
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-06 00:00:00 +00:00
+date: 2010-03-18 00:00:00 +00:00
 default_executable: 
 dependencies: []
 
@@ -36,9 +36,7 @@ files:
 - lib/paper_trail/has_paper_trail.rb
 - lib/paper_trail/version.rb
 - paper_trail.gemspec
-- rails/init.rb
 - tasks/paper_trail_tasks.rake
-- test/database.yml
 - test/paper_trail_controller_test.rb
 - test/paper_trail_model_test.rb
 - test/paper_trail_schema_test.rb

data/rails/init.rb

@@ -1 +0,0 @@
-require 'paper_trail'

data/test/database.yml

@@ -1,18 +0,0 @@
-sqlite3:
-  adapter: sqlite3
-  database: ":memory:"
-
-postgresql:
-  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