paper_trail 2.0.2 → 2.1.0

data/.gitignore

@@ -1,6 +1,9 @@
 test/debug.log
 test/paper_trail_plugin.sqlite3.db
+test/dummy/log/*
+test/dummy/tmp/*
 coverage
 pkg/*
 *.gem
 .bundle
+Gemfile.lock

data/README.md

@@ -20,7 +20,8 @@ There's an excellent [Railscast on implementing Undo with Paper Trail](http://ra
 * Can be turned off/on per class (useful for migrations).
 * Can be turned off/on globally (useful for testing).
 * No configuration necessary.
-* Stores everything in a single database table (generates migration for you).
+* Stores everything in a single database table by default (generates migration for you), or can use separate tables for separate models.
+* Supports custom version classes so different models' versions can have different behaviour.
 * Thoroughly tested.
 * Threadsafe.
 
@@ -308,6 +309,24 @@ To find out who made a `version`'s object look that way, use `version.originator
     >> last_version.terminator                     # 'Bob'
 
 
+## Custom Version Classes
+
+You can specify custom version subclasses with the `:class_name` option:
+
+    class Post < ActiveRecord::Base
+      has_paper_trail :class_name => 'PostVersion'
+    end
+
+    class PostVersion < Version
+      # custom behaviour, e.g:
+      set_table_name :post_versions
+    end
+
+This allows you to store each model's versions in a separate table, which is useful if you have a lot of versions being created.
+
+Alternatively you could store certain metadata for one type of version, and other metadata for other versions.
+
+
 ## Associations
 
 I haven't yet found a good way to get PaperTrail to automatically restore associations when you reify a model.  See [here for a little more info](http://airbladesoftware.com/notes/undo-and-redo-with-papertrail).
@@ -562,6 +581,7 @@ Many thanks to:
 * [Franco Catena](https://github.com/francocatena)
 * [Emmanuel Gomez](https://github.com/emmanuel)
 * [Matthew MacLeod](https://github.com/mattmacleod)
+* [benzittlau](https://github.com/benzittlau)
 
 
 ## Inspirations

data/lib/paper_trail/has_paper_trail.rb

@@ -11,12 +11,13 @@ module PaperTrail
       # the model is available in the `versions` association.
       #
       # Options:
-      # :ignore    an array of attributes for which a new `Version` will not be created if only they change.
-      # :only      inverse of `ignore` - a new `Version` will be created only for these attributes if supplied
-      # :meta      a hash of extra data to store.  You must add a column to the `versions` table for each key.
-      #            Values are objects or procs (which are called with `self`, i.e. the model with the paper
-      #            trail).  See `PaperTrail::Controller.info_for_paper_trail` for how to store data from
-      #            the controller.
+      # :class_name   the name of a custom Version class.  This class should inherit from Version.
+      # :ignore       an array of attributes for which a new `Version` will not be created if only they change.
+      # :only         inverse of `ignore` - a new `Version` will be created only for these attributes if supplied
+      # :meta         a hash of extra data to store.  You must add a column to the `versions` table for each key.
+      #               Values are objects or procs (which are called with `self`, i.e. the model with the paper
+      #               trail).  See `PaperTrail::Controller.info_for_paper_trail` for how to store data from
+      #               the controller.
       def has_paper_trail(options = {})
         # Lazily include the instance methods so we don't clutter up
         # any more ActiveRecord models than we have to.
@@ -24,6 +25,9 @@ module PaperTrail
 
         # The version this instance was reified from.
         attr_accessor :version
+        
+        cattr_accessor :version_class_name
+        self.version_class_name = options[:class_name] || "Version"
 
         cattr_accessor :ignore
         self.ignore = ([options[:ignore]].flatten.compact || []).map &:to_s
@@ -39,7 +43,7 @@ module PaperTrail
         cattr_accessor :paper_trail_active
         self.paper_trail_active = true
 
-        has_many :versions, :as => :item, :order => 'created_at ASC, id ASC'
+        has_many :versions, :class_name => version_class_name, :as => :item, :order => 'created_at ASC, id ASC'
 
         after_create  :record_create
         before_update :record_update
@@ -68,7 +72,7 @@ module PaperTrail
 
       # Returns who put the object into its current state.
       def originator
-        Version.with_item_keys(self.class.name, id).last.try :whodunnit
+        version_class_name.constantize.with_item_keys(self.class.name, id).last.try :whodunnit
       end
 
       # Returns the object (not a Version) as it was at the given timestamp.
@@ -111,7 +115,7 @@ module PaperTrail
 
       def record_destroy
         if switched_on? and not new_record?
-          Version.create merge_metadata(:item_id   => self.id,
+          version_class_name.constantize.create merge_metadata(:item_id   => self.id,
                                         :item_type => self.class.name,
                                         :event     => 'destroy',
                                         :object    => object_to_string(item_before_change),

data/lib/paper_trail/version.rb

@@ -2,16 +2,16 @@ class Version < ActiveRecord::Base
   belongs_to :item, :polymorphic => true
   validates_presence_of :event
 
-  scope :with_item_keys, lambda { |item_type, item_id|
-    where(:item_type => item_type, :item_id => item_id)
-  }
+  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(["id > ?", version.is_a?(Version) ? version.id : version]).order("id ASC")
+    where(["id > ?", version.is_a?(self) ? version.id : version]).order("id ASC")
   }
 
   scope :preceding, lambda { |version|
-    where(["id < ?", version.is_a?(Version) ? version.id : version]).order("id DESC")
+    where(["id < ?", version.is_a?(self) ? version.id : version]).order("id DESC")
   }
 
   scope :after, lambda { |timestamp|
@@ -87,7 +87,7 @@ class Version < ActiveRecord::Base
   end
 
   def sibling_versions
-    Version.with_item_keys(item_type, item_id)
+    self.class.with_item_keys(item_type, item_id)
   end
 
   def next

data/lib/paper_trail/version_number.rb

@@ -1,3 +1,3 @@
 module PaperTrail
-  VERSION = '2.0.2'
+  VERSION = '2.1.0'
 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/versions/post_version.rb

@@ -0,0 +1,3 @@
+class PostVersion < Version
+  set_table_name :post_versions
+end

data/test/dummy/db/migrate/20110208155312_set_up_test_tables.rb

@@ -34,6 +34,20 @@ class SetUpTestTables < ActiveRecord::Migration
       t.string :user_agent
     end
     add_index :versions, [:item_type, :item_id]
+    
+    create_table :post_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
+
+      # Controller info columns.
+      t.string :ip
+      t.string :user_agent
+    end
+    add_index :post_versions, [:item_type, :item_id]
 
     create_table :wotsits, :force => true do |t|
       t.integer :widget_id
@@ -68,9 +82,15 @@ class SetUpTestTables < ActiveRecord::Migration
     create_table :songs, :force => true do |t|
       t.integer :length
     end
+    
+    create_table :posts, :force => true do |t|
+      t.string :title
+      t.string :content
+    end
   end
 
   def self.down
+    drop_table :posts
     drop_table :songs
     drop_table :people
     drop_table :authorships
@@ -78,6 +98,8 @@ class SetUpTestTables < ActiveRecord::Migration
     drop_table :articles
     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
     drop_table :widgets

data/test/dummy/db/schema.rb

@@ -36,6 +36,24 @@ ActiveRecord::Schema.define(:version => 20110208155312) do
     t.string "name"
   end
 
+  create_table "post_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"
+    t.string   "ip"
+    t.string   "user_agent"
+  end
+
+  add_index "post_versions", ["item_type", "item_id"], :name => "index_post_versions_on_item_type_and_item_id"
+
+  create_table "posts", :force => true do |t|
+    t.string "title"
+    t.string "content"
+  end
+
   create_table "songs", :force => true do |t|
     t.integer "length"
   end

data/test/unit/model_test.rb

@@ -710,6 +710,38 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
     end
   end
 
+  context 'A new model instance which uses a custom Version class' do
+    setup { @post = Post.new }
+    
+    context 'which is then saved' do
+      setup { @post.save }
+      should_change('the number of post versions') { PostVersion.count }
+      should_not_change('the number of versions') { Version.count }
+    end
+  end
+    
+  context 'An existing model instance which uses a custom Version class' do
+    setup { @post = Post.create }
+    
+    context 'on the first version' do
+      setup { @version = @post.versions.first }
+      
+      should 'have the correct index' do
+        assert_equal 0, @version.index
+      end
+    end
+    
+    should 'should have versions of the custom class' do
+      assert_equal "PostVersion", @post.versions.first.class.name
+    end
+    
+    context 'which is modified' do
+      setup { @post.update_attributes({ :content => "Some new content" }) }
+      should_change('the number of post versions') { PostVersion.count }
+      should_not_change('the number of versions') { Version.count }
+    end
+  end
+    
 
   context 'An overwritten default accessor' do
     setup do

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 2
+  - 1
   - 0
-  - 2
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors: 
 - Andy Stewart
@@ -15,12 +15,13 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-16 00:00:00 +01:00
+date: 2011-03-31 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
+  name: rails
   prerelease: false
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -29,12 +30,12 @@ dependencies:
         segments: 
         - 3
         version: "3"
-  requirement: *id001
-  name: rails
   type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
+  name: shoulda
   prerelease: false
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -45,12 +46,12 @@ dependencies:
         - 10
         - 3
         version: 2.10.3
-  requirement: *id002
-  name: shoulda
   type: :development
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
   prerelease: false
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -60,12 +61,12 @@ dependencies:
         - 1
         - 2
         version: "1.2"
-  requirement: *id003
-  name: sqlite3-ruby
   type: :development
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
+  name: capybara
   prerelease: false
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -76,9 +77,8 @@ dependencies:
         - 4
         - 0
         version: 0.4.0
-  requirement: *id004
-  name: capybara
   type: :development
+  version_requirements: *id004
 description: Track changes to your models' data.  Good for auditing or versioning.
 email: boss@airbladesoftware.com
 executables: []
@@ -90,7 +90,6 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
-- Gemfile.lock
 - MIT-LICENSE
 - README.md
 - Rakefile
@@ -115,9 +114,11 @@ files:
 - test/dummy/app/models/fluxor.rb
 - test/dummy/app/models/foo_widget.rb
 - test/dummy/app/models/person.rb
+- test/dummy/app/models/post.rb
 - test/dummy/app/models/song.rb
 - test/dummy/app/models/widget.rb
 - test/dummy/app/models/wotsit.rb
+- test/dummy/app/versions/post_version.rb
 - test/dummy/app/views/layouts/application.html.erb
 - test/dummy/config.ru
 - test/dummy/config/application.rb
@@ -203,9 +204,11 @@ test_files:
 - test/dummy/app/models/fluxor.rb
 - test/dummy/app/models/foo_widget.rb
 - test/dummy/app/models/person.rb
+- test/dummy/app/models/post.rb
 - test/dummy/app/models/song.rb
 - test/dummy/app/models/widget.rb
 - test/dummy/app/models/wotsit.rb
+- test/dummy/app/versions/post_version.rb
 - test/dummy/app/views/layouts/application.html.erb
 - test/dummy/config.ru
 - test/dummy/config/application.rb

data/Gemfile.lock

@@ -1,107 +0,0 @@
-PATH
-  remote: .
-  specs:
-    paper_trail (2.0.2)
-      rails (~> 3)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    abstract (1.0.0)
-    actionmailer (3.0.4)
-      actionpack (= 3.0.4)
-      mail (~> 2.2.15)
-    actionpack (3.0.4)
-      activemodel (= 3.0.4)
-      activesupport (= 3.0.4)
-      builder (~> 2.1.2)
-      erubis (~> 2.6.6)
-      i18n (~> 0.4)
-      rack (~> 1.2.1)
-      rack-mount (~> 0.6.13)
-      rack-test (~> 0.5.7)
-      tzinfo (~> 0.3.23)
-    activemodel (3.0.4)
-      activesupport (= 3.0.4)
-      builder (~> 2.1.2)
-      i18n (~> 0.4)
-    activerecord (3.0.4)
-      activemodel (= 3.0.4)
-      activesupport (= 3.0.4)
-      arel (~> 2.0.2)
-      tzinfo (~> 0.3.23)
-    activeresource (3.0.4)
-      activemodel (= 3.0.4)
-      activesupport (= 3.0.4)
-    activesupport (3.0.4)
-    arel (2.0.9)
-    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.4)
-      actionmailer (= 3.0.4)
-      actionpack (= 3.0.4)
-      activerecord (= 3.0.4)
-      activeresource (= 3.0.4)
-      activesupport (= 3.0.4)
-      bundler (~> 1.0)
-      railties (= 3.0.4)
-    railties (3.0.4)
-      actionpack (= 3.0.4)
-      activesupport (= 3.0.4)
-      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)