Namespacing version class under the PaperTrail module. Fix #165

README.md

@@ -72,7 +72,7 @@ Widget.paper_trail_off
 Widget.paper_trail_on
 ```
 
-And a `Version` instance has these methods:
+And a `PaperTrail::Version` instance has these methods:
 
 ```ruby
 # Returns the item restored from this version.
@@ -124,7 +124,7 @@ This gives you a `versions` method which returns the paper trail of changes to y
 
 ```ruby
 >> widget = Widget.find 42
->> widget.versions             # [<Version>, <Version>, ...]
+>> widget.versions             # [<PaperTrail::Version>, <PaperTrail::Version>, ...]
 ```
 
 Once you have a version, you can find out what happened:
@@ -193,7 +193,7 @@ class Article < ActiveRecord::Base
 end
 ```
 
-You may also have the `Version` model save a custom string in it's `event` field instead of the typical `create`, `update`, `destroy`.
+You may also have the `PaperTrail::Version` model save a custom string in it's `event` field instead of the typical `create`, `update`, `destroy`.
 PaperTrail supplies a custom accessor method called `paper_trail_event`, which it will attempt to use to fill the `event` field before
 falling back on one of the default events.
 
@@ -233,7 +233,7 @@ class Article < ActiveRecord::Base
 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 created.  For example:
+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 `PaperTrail::Version` to be created.  For example:
 
 ```ruby
 >> a = Article.create
@@ -267,7 +267,7 @@ This means that only changes to the `title` will save a version of the article:
 
 Passing both `:ignore` and `:only` options will result in the article being saved if a changed attribute is included in `:only` but not in `:ignore`.
 
-You can skip fields altogether with the `:skip` option.  As with `:ignore`, updates to these fields will not create a new `Version`.  In addition, these fields will not be included in the serialised version of the object whenever a new `Version` is created.
+You can skip fields altogether with the `:skip` option.  As with `:ignore`, updates to these fields will not create a new `PaperTrail::Version`.  In addition, these fields will not be included in the serialized version of the object whenever a new `PaperTrail::Version` is created.
 
 For example:
 
@@ -304,7 +304,7 @@ Undeleting is just as simple:
 >> widget = Widget.find 42
 >> widget.destroy
 # Time passes....
->> widget = Version.find(153).reify    # the widget as it was before it was destroyed
+>> widget = PaperTrail::Version.find(153).reify    # the widget as it was before it was destroyed
 >> widget.save                         # the widget lives!
 ```
 
@@ -388,7 +388,7 @@ In a migration or in `rails console` you can set who is responsible like this:
 You can avoid having to do this manually by setting your initializer to pick up the username of the current user from the OS, like this:
 
 ```ruby
-class Version < ActiveRecord::Base
+class PaperTrail::Version < ActiveRecord::Base
   if defined?(Rails::Console)
     PaperTrail.whodunnit = "#{`whoami`.strip}: console"
   elsif File.basename($0) == "rake"
@@ -423,7 +423,7 @@ To find out who made a `version`'s object look that way, use `version.originator
 You can specify custom version subclasses with the `:class_name` option:
 
 ```ruby
-class PostVersion < Version
+class PostVersion < PaperTrail::Version
   # custom behaviour, e.g:
   self.table_name = :post_versions
 end
@@ -438,7 +438,7 @@ This allows you to store each model's versions in a separate table, which is use
 If you are using Postgres, you should also define the sequence that your custom version class will use:
 
 ```ruby
-class PostVersion < Version
+class PostVersion < PaperTrail::Version
   self.table_name = :post_versions
   self.sequence_name = :post_version_id_seq
 end
@@ -451,7 +451,7 @@ If you only use custom version classes and don't use PaperTrail's built-in one,
 - either declare PaperTrail's version class abstract like this (in `config/initializers/paper_trail_patch.rb`):
 
 ```ruby
-Version.module_eval do
+PaperTrail::Version.module_eval do
   self.abstract_class = true
 end
 ```
@@ -609,15 +609,17 @@ For example:
 
 ```ruby
 # config/initializers/paper_trail.rb
-class Version < ActiveRecord::Base
+module PaperTrail
+  class Version < ActiveRecord::Base
     attr_accessible :author_id, :word_count, :answer
+  end
 end
 ```
 
 Why would you do this?  In this example, `author_id` is an attribute of `Article` and PaperTrail will store it anyway in serialized (YAML) form in the `object` column of the `version` record.  But let's say you wanted to pull out all versions for a particular author; without the metadata you would have to deserialize (reify) each `version` object to see if belonged to the author in question.  Clearly this is inefficient.  Using the metadata you can find just those versions you want:
 
 ```ruby
-Version.all(:conditions => ['author_id = ?', author_id])
+PaperTrail::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.
@@ -793,7 +795,7 @@ sql> delete from versions where created_at < 2010-06-01;
 ```
 
 ```ruby
->> Version.delete_all ["created_at < ?", 1.week.ago]
+>> PaperTrail::Version.delete_all ["created_at < ?", 1.week.ago]
 ```
 
 ## Installation

lib/paper_trail/has_paper_trail.rb

@@ -39,7 +39,7 @@ module PaperTrail
         attr_accessor self.version_association_name
 
         class_attribute :version_class_name
-        self.version_class_name = options[:class_name] || '::Version'
+        self.version_class_name = options[:class_name] || 'PaperTrail::Version'
 
         class_attribute :paper_trail_options
         self.paper_trail_options = options.dup

lib/paper_trail/version.rb

@@ -1,4 +1,5 @@
-class Version < ActiveRecord::Base
+module PaperTrail
+  class Version < ActiveRecord::Base
     belongs_to :item, :polymorphic => true
     validates_presence_of :event
     attr_accessible :item_type, :item_id, :event, :whodunnit, :object, :object_changes
@@ -195,4 +196,13 @@ class Version < ActiveRecord::Base
       excess_previous_versions.map(&:destroy)
     end
 
+  end
 end
+
+# Legacy support for old applications using the original `Version` class
+# class Version < PaperTrail::Version
+#   def initialize
+#     warn "DEPRECATED: Please use the namespaced `PaperTrail::Version` class instead."
+#     super
+#   end
+# end

test/dummy/app/versions/post_version.rb

@@ -1,3 +1,3 @@
-class PostVersion < Version
+class PostVersion < PaperTrail::Version
   self.table_name = 'post_versions'
 end

test/dummy/config/initializers/paper_trail.rb

@@ -1,3 +1,5 @@
-class Version < ActiveRecord::Base
+module PaperTrail
+  class Version < ActiveRecord::Base
     attr_accessible :created_at, :updated_at, :answer, :action, :question, :article_id, :ip, :user_agent, :title
+  end
 end

test/functional/controller_test.rb

@@ -34,7 +34,7 @@ class ControllerTest < ActionController::TestCase
     assert_equal 0, w.versions.length
     delete :destroy, :id => w.id
     widget = assigns(:widget)
-    assert_equal 0, Version.with_item_keys('Widget', w.id).size
+    assert_equal 0, PaperTrail::Version.with_item_keys('Widget', w.id).size
   end
 
   test 'create' do
@@ -62,7 +62,7 @@ class ControllerTest < ActionController::TestCase
     assert_equal 1, w.versions.length
     delete :destroy, :id => w.id
     widget = assigns(:widget)
-    versions_for_widget = Version.with_item_keys('Widget', w.id)
+    versions_for_widget = PaperTrail::Version.with_item_keys('Widget', w.id)
     assert_equal 2,               versions_for_widget.length
     assert_equal 153,             versions_for_widget.last.whodunnit.to_i
     assert_equal '127.0.0.1',     versions_for_widget.last.ip

test/paper_trail_test.rb

@@ -2,7 +2,7 @@ require 'test_helper'
 
 class PaperTrailTest < ActiveSupport::TestCase
   test 'Sanity test' do
-    assert_kind_of Module, PaperTrail
+    assert_kind_of Module, PaperTrail::Version
   end
 
   test 'create with plain model class' do
@@ -21,7 +21,7 @@ class PaperTrailTest < ActiveSupport::TestCase
     widget = Widget.create
     assert_equal 1, widget.versions.length
     widget.destroy
-    versions_for_widget = Version.with_item_keys('Widget', widget.id)
+    versions_for_widget = PaperTrail::Version.with_item_keys('Widget', widget.id)
     assert_equal 2, versions_for_widget.length
   end
 end

test/unit/inheritance_column_test.rb

@@ -21,19 +21,19 @@ class InheritanceColumnTest < ActiveSupport::TestCase
     end
 
     should 'work with custom STI inheritance column' do
-      assert_equal 12, Version.count
+      assert_equal 12, PaperTrail::Version.count
       assert_equal 4, @animal.versions.count
       assert @animal.versions.first.reify.nil?
       @animal.versions[1..-1].each { |v| assert_equal 'Animal', v.reify.class.name }
 
       # For some reason `@dog.versions` doesn't include the final `destroy` version.
       # Neither do `@dog.versions.scoped` nor `@dog.versions(true)` nor `@dog.versions.reload`.
-      dog_versions = Version.where(:item_id => @dog.id)
+      dog_versions = PaperTrail::Version.where(:item_id => @dog.id)
       assert_equal 4, dog_versions.count
       assert dog_versions.first.reify.nil?
       dog_versions[1..-1].each { |v| assert_equal 'Dog', v.reify.class.name }
 
-      cat_versions = Version.where(:item_id => @cat.id)
+      cat_versions = PaperTrail::Version.where(:item_id => @cat.id)
       assert_equal 4, cat_versions.count
       assert cat_versions.first.reify.nil?
       cat_versions[1..-1].each { |v| assert_equal 'Cat', v.reify.class.name }

test/unit/model_test.rb

@@ -4,16 +4,16 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
 
   context 'A record with defined "only" and "ignore" attributes' do
     setup { @article = Article.create }
-    should 'creation should change the number of versions' do assert_equal(1, Version.count) end
+    should 'creation should change the number of versions' do assert_equal(1, PaperTrail::Version.count) end
 
     context 'which updates an ignored column' do
       setup { @article.update_attributes :title => 'My first title' }
-      should 'not change the number of versions' do assert_equal(1, Version.count) end
+      should 'not change the number of versions' do assert_equal(1, PaperTrail::Version.count) end
     end
 
     context 'which updates an ignored column and a selected column' do
       setup { @article.update_attributes :title => 'My first title', :content => 'Some text here.' }
-      should 'change the number of versions' do assert_equal(2, Version.count) end
+      should 'change the number of versions' do assert_equal(2, PaperTrail::Version.count) end
 
       should "show the new version in the model's `versions` association" do
         assert_equal(2, @article.versions.size)
@@ -26,7 +26,7 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
 
     context 'which updates a selected column' do
       setup { @article.update_attributes :content => 'Some text here.' }
-      should 'change the number of versions' do assert_equal(2, Version.count) end
+      should 'change the number of versions' do assert_equal(2, PaperTrail::Version.count) end
 
       should "show the new version in the model's `versions` association" do
         assert_equal(2, @article.versions.size)
@@ -35,17 +35,17 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
 
     context 'which updates a non-ignored and non-selected column' do
       setup { @article.update_attributes :abstract => 'Other abstract'}
-      should 'not change the number of versions' do assert_equal(1, Version.count) end
+      should 'not change the number of versions' do assert_equal(1, PaperTrail::Version.count) end
     end
 
     context 'which updates a skipped column' do
       setup { @article.update_attributes :file_upload => 'Your data goes here' }
-      should 'not change the number of versions' do assert_equal(1, Version.count) end
+      should 'not change the number of versions' do assert_equal(1, PaperTrail::Version.count) end
     end
 
     context 'which updates a skipped column and a selected column' do
       setup { @article.update_attributes :file_upload => 'Your data goes here', :content => 'Some text here.' }
-      should 'change the number of versions' do assert_equal(2, Version.count) end
+      should 'change the number of versions' do assert_equal(2, PaperTrail::Version.count) end
 
       should "show the new version in the model's `versions` association" do
         assert_equal(2, @article.versions.size)
@@ -73,7 +73,7 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
 
     context 'which gets destroyed' do
       setup { @article.destroy }
-      should 'change the number of versions' do assert_equal(2, Version.count) end
+      should 'change the number of versions' do assert_equal(2, PaperTrail::Version.count) end
 
       should "show the new version in the model's `versions` association" do
         assert_equal(2, @article.versions.size)
@@ -86,7 +86,7 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
 
     context 'which updates an ignored column' do
       setup { @legacy_widget.update_attributes :version => 1 }
-      should 'not change the number of versions' do assert_equal(1, Version.count) end
+      should 'not change the number of versions' do assert_equal(1, PaperTrail::Version.count) end
     end
   end
 
@@ -95,16 +95,16 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
 
     context 'for non-US translations' do
       setup { @translation.save }
-      should 'not change the number of versions' do assert_equal(0, Version.count) end
+      should 'not change the number of versions' do assert_equal(0, PaperTrail::Version.count) end
 
       context 'after update' do
         setup { @translation.update_attributes :content => 'Content' }
-        should 'not change the number of versions' do assert_equal(0, Version.count) end
+        should 'not change the number of versions' do assert_equal(0, PaperTrail::Version.count) end
       end
 
       context 'after destroy' do
         setup { @translation.destroy }
-        should 'not change the number of versions' do assert_equal(0, Version.count) end
+        should 'not change the number of versions' do assert_equal(0, PaperTrail::Version.count) end
       end
     end
 
@@ -117,22 +117,22 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
           @translation.save
         end
 
-        should 'not change the number of versions' do assert_equal(0, Version.count) end
+        should 'not change the number of versions' do assert_equal(0, PaperTrail::Version.count) end
 
         context 'after update' do
           setup { @translation.update_attributes :content => 'Content' }
-          should 'not change the number of versions' do assert_equal(0, Version.count) end
+          should 'not change the number of versions' do assert_equal(0, PaperTrail::Version.count) end
         end
       end
 
       context 'that are not drafts' do
         setup { @translation.save }
 
-        should 'change the number of versions' do assert_equal(1, Version.count) end
+        should 'change the number of versions' do assert_equal(1, PaperTrail::Version.count) end
 
         context 'after update' do
           setup { @translation.update_attributes :content => 'Content' }
-          should 'change the number of versions' do assert_equal(2, Version.count) end
+          should 'change the number of versions' do assert_equal(2, PaperTrail::Version.count) end
 
           should "show the new version in the model's `versions` association" do
             assert_equal(2, @translation.versions.size)
@@ -141,7 +141,7 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
 
         context 'after destroy' do
           setup { @translation.destroy }
-          should 'change the number of versions' do assert_equal(2, Version.count) end
+          should 'change the number of versions' do assert_equal(2, PaperTrail::Version.count) end
 
           should "show the new version in the model's `versions` association" do
             assert_equal(2, @translation.versions.size)
@@ -297,15 +297,15 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
           setup do
             @fluxor = @widget.fluxors.create :name => 'flux'
             @widget.destroy
-            @reified_widget = Version.last.reify
+            @reified_widget = PaperTrail::Version.last.reify
           end
 
           should 'record the correct event' do
-            assert_match /destroy/i, Version.last.event
+            assert_match /destroy/i, PaperTrail::Version.last.event
           end
 
           should 'have three previous versions' do
-            assert_equal 3, Version.with_item_keys('Widget', @widget.id).length
+            assert_equal 3, PaperTrail::Version.with_item_keys('Widget', @widget.id).length
           end
 
           should 'be available in its previous version' do
@@ -536,7 +536,7 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
           setup do
             PaperTrail.whodunnit = 'Charlie'
             @widget.destroy
-            @version = Version.last
+            @version = PaperTrail::Version.last
           end
 
           should 'track who made the change' do
@@ -558,10 +558,10 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
     end
 
     should 'reify with the correct type' do
-      thing = Version.last.reify
+      thing = PaperTrail::Version.last.reify
       assert_kind_of FooWidget, thing
-      assert_equal @foo.versions.first, Version.last.previous
+      assert_equal @foo.versions.first, PaperTrail::Version.last.previous
-      assert_nil Version.last.next
+      assert_nil PaperTrail::Version.last.next
     end
 
     should 'should return the correct originator' do
@@ -574,10 +574,10 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
       setup { @foo.destroy }
 
       should 'reify with the correct type' do
-        thing = Version.last.reify
+        thing = PaperTrail::Version.last.reify
         assert_kind_of FooWidget, thing
-        assert_equal @foo.versions[1], Version.last.previous
+        assert_equal @foo.versions[1], PaperTrail::Version.last.previous
-        assert_nil Version.last.next
+        assert_nil PaperTrail::Version.last.next
       end
     end
   end
@@ -840,35 +840,35 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
     end
 
     should 'store version on source <<' do
-      count = Version.count
+      count = PaperTrail::Version.count
       @book.authors << @dostoyevsky
-      assert_equal 1, Version.count - count
+      assert_equal 1, PaperTrail::Version.count - count
-      assert_equal Version.last, @book.authorships.first.versions.first
+      assert_equal PaperTrail::Version.last, @book.authorships.first.versions.first
     end
 
     should 'store version on source create' do
-      count = Version.count
+      count = PaperTrail::Version.count
       @book.authors.create :name => 'Tolstoy'
-      assert_equal 2, Version.count - count
+      assert_equal 2, PaperTrail::Version.count - count
-      assert_same_elements [Person.last, Authorship.last], [Version.all[-2].item, Version.last.item]
+      assert_same_elements [Person.last, Authorship.last], [PaperTrail::Version.all[-2].item, PaperTrail::Version.last.item]
     end
 
     should 'store version on join destroy' do
       @book.authors << @dostoyevsky
-      count = Version.count
+      count = PaperTrail::Version.count
       @book.authorships(true).last.destroy
-      assert_equal 1, Version.count - count
+      assert_equal 1, PaperTrail::Version.count - count
-      assert_equal @book, Version.last.reify.book
+      assert_equal @book, PaperTrail::Version.last.reify.book
-      assert_equal @dostoyevsky, Version.last.reify.person
+      assert_equal @dostoyevsky, PaperTrail::Version.last.reify.person
     end
 
     should 'store version on join clear' do
       @book.authors << @dostoyevsky
-      count = Version.count
+      count = PaperTrail::Version.count
       @book.authorships(true).clear
-      assert_equal 1, Version.count - count
+      assert_equal 1, PaperTrail::Version.count - count
-      assert_equal @book, Version.last.reify.book
+      assert_equal @book, PaperTrail::Version.last.reify.book
-      assert_equal @dostoyevsky, Version.last.reify.person
+      assert_equal @dostoyevsky, PaperTrail::Version.last.reify.person
     end
   end
 
@@ -1038,17 +1038,17 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
   end
 
 
-  context 'A new model instance which uses a custom Version class' do
+  context 'A new model instance which uses a custom PaperTrail::Version class' do
     setup { @post = Post.new }
 
     context 'which is then saved' do
       setup { @post.save }
       should 'change the number of post versions' do assert_equal 1, PostVersion.count end
-      should 'not change the number of versions' do assert_equal(0, Version.count) end
+      should 'not change the number of versions' do assert_equal(0, PaperTrail::Version.count) end
     end
   end
 
-  context 'An existing model instance which uses a custom Version class' do
+  context 'An existing model instance which uses a custom PaperTrail::Version class' do
     setup { @post = Post.create }
     should 'have one post version' do assert_equal(1, PostVersion.count) end
 
@@ -1067,7 +1067,7 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
     context 'which is modified' do
       setup { @post.update_attributes({ :content => "Some new content" }) }
       should 'change the number of post versions' do assert_equal(2, PostVersion.count) end
-      should 'not change the number of versions' do assert_equal(0, Version.count) end
+      should 'not change the number of versions' do assert_equal(0, PaperTrail::Version.count) end
       should "not have stored changes when object_changes column doesn't exist" do
         assert_nil @post.versions.last.changeset
       end
@@ -1287,9 +1287,9 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
   # Updates `model`'s last version so it looks like the version was
   # created 2 seconds ago.
   def make_last_version_earlier(model)
-    Version.record_timestamps = false
+    PaperTrail::Version.record_timestamps = false
     model.versions.last.update_attributes :created_at => 2.seconds.ago
-    Version.record_timestamps = true
+    PaperTrail::Version.record_timestamps = true
   end
 
 end

test/unit/timestamp_test.rb

@@ -5,8 +5,8 @@ class TimestampTest < ActiveSupport::TestCase
   setup do
     PaperTrail.timestamp_field = :custom_created_at
     change_schema
-    Version.connection.schema_cache.clear!
+    PaperTrail::Version.connection.schema_cache.clear!
-    Version.reset_column_information
+    PaperTrail::Version.reset_column_information
 
     Fluxor.instance_eval <<-END
       has_paper_trail

test/unit/version_test.rb

@@ -1,55 +1,55 @@
 require 'test_helper'
 
-class VersionTest < ActiveSupport::TestCase
+class PaperTrail::VersionTest < ActiveSupport::TestCase
   setup {
     change_schema
     @article = Animal.create
-    assert Version.creates.present?
+    assert PaperTrail::Version.creates.present?
   }
 
-  context "Version.creates" do
+  context "PaperTrail::Version.creates" do
     should "return only create events" do
-      Version.creates.each do |version|
+      PaperTrail::Version.creates.each do |version|
         assert_equal "create", version.event
       end
     end
   end
 
-  context "Version.updates" do
+  context "PaperTrail::Version.updates" do
     setup {
       @article.update_attributes(:name => 'Animal')
-      assert Version.updates.present?
+      assert PaperTrail::Version.updates.present?
     }
 
     should "return only update events" do
-      Version.updates.each do |version|
+      PaperTrail::Version.updates.each do |version|
         assert_equal "update", version.event
       end
     end
   end
 
-  context "Version.destroys" do
+  context "PaperTrail::Version.destroys" do
     setup {
       @article.destroy
-      assert Version.destroys.present?
+      assert PaperTrail::Version.destroys.present?
     }
 
     should "return only destroy events" do
-      Version.destroys.each do |version|
+      PaperTrail::Version.destroys.each do |version|
         assert_equal "destroy", version.event
       end
     end
   end
 
-  context "Version.not_creates" do
+  context "PaperTrail::Version.not_creates" do
     setup {
       @article.update_attributes(:name => 'Animal')
       @article.destroy
-      assert Version.not_creates.present?
+      assert PaperTrail::Version.not_creates.present?
     }
 
     should "return all items except create events" do
-      Version.not_creates.each do |version|
+      PaperTrail::Version.not_creates.each do |version|
         assert_not_equal "create", version.event
       end
     end