acts_as_revisionable 1.2.0 → 1.2.1

data/lib/acts_as_revisionable.rb

@@ -5,10 +5,6 @@ module ActsAsRevisionable
   
   autoload :RevisionRecord, File.expand_path('../acts_as_revisionable/revision_record', __FILE__)
   
-  def self.included(base)
-    base.extend(ActsMethods)
-  end
-  
   module ActsMethods
     # Calling acts_as_revisionable will inject the revisionable behavior into the class. Specifying a :limit option
     # will limit the number of revisions that are kept per record. Specifying :minimum_age will ensure that revisions are
@@ -39,6 +35,11 @@ module ActsAsRevisionable
     #     :version => 1
     #   }
     #
+    # As a shortcut, you can can also just pass an attribute name or array of attribute names to copy to the revision
+    # record.
+    #
+    #   acts_as_revisionable :meta => :updated_by
+    #
     # The values to the <tt>:meta</tt> hash can be either symbols or Procs. If it is a symbol, the method
     # so named will be called on the record being revisioned. If it is a Proc, it will be called with the
     # record as the argument. Any other class will be sent directly to the revision record.
@@ -57,7 +58,6 @@ module ActsAsRevisionable
       acts_as_revisionable_options[:class_name] = acts_as_revisionable_options[:class_name].name if acts_as_revisionable_options[:class_name].is_a?(Class)
       extend ClassMethods
       include InstanceMethods
-      class_name = 
       class_name = acts_as_revisionable_options[:class_name].to_s if acts_as_revisionable_options[:class_name]
       has_many_options = {:as => :revisionable, :order => 'revision DESC', :class_name => class_name}
       has_many_options[:dependent] = :destroy unless options[:dependent] == :keep
@@ -217,7 +217,6 @@ module ActsAsRevisionable
                 truncate_revisions!
               end
             rescue => e
-              puts e
               logger.warn(e) if logger
             end
             
@@ -235,7 +234,6 @@ module ActsAsRevisionable
             begin
               revision.destroy
             rescue => e
-              puts e
               logger.warn(e) if logger
             end
           end
@@ -247,17 +245,18 @@ module ActsAsRevisionable
     
     # Create a revision record based on this record and save it to the database.
     def create_revision!
-      revision = revision_record_class.new(self, acts_as_revisionable_options[:encoding])
-      if self.acts_as_revisionable_options[:meta].is_a?(Hash)
-        self.acts_as_revisionable_options[:meta].each do |attribute, value|
-          case value
-          when Symbol
-            value = self.send(value)
-          when Proc
-            value = value.call(self)
-          end
-          revision.send("#{attribute}=", value)
+      revision_options = self.class.acts_as_revisionable_options
+      revision = revision_record_class.new(self, revision_options[:encoding])
+      if revision_options[:meta].is_a?(Hash)
+        revision_options[:meta].each do |attribute, value|
+          set_revision_meta_attribute(revision, attribute, value)
         end
+      elsif revision_options[:meta].is_a?(Array)
+        revision_options[:meta].each do |attribute|
+          set_revision_meta_attribute(revision, attribute, attribute.to_sym)
+        end
+      elsif revision_options[:meta]
+        set_revision_meta_attribute(revision, revision_options[:meta], revision_options[:meta].to_sym)
       end
       revision.save!
       return revision
@@ -265,7 +264,7 @@ module ActsAsRevisionable
     
     # Truncate the number of revisions kept for this record. Available options are :limit and :minimum_age.
     def truncate_revisions!(options = nil)
-      options = {:limit => acts_as_revisionable_options[:limit], :minimum_age => acts_as_revisionable_options[:minimum_age]} unless options
+      options = {:limit => self.class.acts_as_revisionable_options[:limit], :minimum_age => self.class.acts_as_revisionable_options[:minimum_age]} unless options
       revision_record_class.truncate_revisions(self.class, self.id, options)
     end
     
@@ -301,7 +300,18 @@ module ActsAsRevisionable
         update_without_revision
       end
     end
+    
+    # Set an attribute based on a meta argument
+    def set_revision_meta_attribute(revision, attribute, value)
+      case value
+      when Symbol
+        value = self.send(value)
+      when Proc
+        value = value.call(self)
+      end
+      revision.send("#{attribute}=", value)
+    end
   end
 end
 
-ActiveRecord::Base.send(:include, ActsAsRevisionable)
+ActiveRecord::Base.extend(ActsAsRevisionable::ActsMethods)

data/spec/acts_as_revisionable_spec.rb

@@ -143,7 +143,7 @@ describe ActsAsRevisionable do
 
   context "injected methods" do
     it "should be able to inject revisionable behavior onto ActiveRecord::Base" do
-      ActiveRecord::Base.included_modules.should include(ActsAsRevisionable)
+      ActiveRecord::Base.should respond_to(:acts_as_revisionable)
     end
   
     it "should add as has_many :record_revisions association" do
@@ -275,8 +275,8 @@ describe ActsAsRevisionable do
       record_1.create_revision!
       ActsAsRevisionable::RevisionRecord.count.should == 1
     end
-  
-    it "should set metadata on the revison when creating a revision record" do
+
+    it "should set metadata on the revison when creating a revision record using a complex attribute to value mapping" do
       record_1 = OtherRevisionableTestModel.create!(:name => "test", :updated_by => "dude")
       RevisionRecord2.count.should == 0
       record_1.create_revision!
@@ -286,6 +286,38 @@ describe ActsAsRevisionable do
       revision.updated_by.should == "dude"
       revision.version.should == 1
     end
+
+    it "should set metadata on the revison when creating a revision record using a simply string to define a method to copy" do
+      meta_value = OtherRevisionableTestModel.acts_as_revisionable_options[:meta]
+      begin
+        OtherRevisionableTestModel.acts_as_revisionable_options[:meta] = "label"
+        record_1 = OtherRevisionableTestModel.create!(:name => "test", :updated_by => "dude")
+        record_1.stub!(:label => "this is a label")
+        record_1.create_revision!
+        revision = record_1.last_revision
+        revision.label.should == "this is a label"
+        revision.updated_by.should == nil
+        revision.version.should == nil
+      ensure
+        OtherRevisionableTestModel.acts_as_revisionable_options[:meta] = meta_value
+      end
+    end
+
+    it "should set metadata on the revison when creating a revision record using an array of attribute names to copy" do
+      meta_value = OtherRevisionableTestModel.acts_as_revisionable_options[:meta]
+      begin
+        OtherRevisionableTestModel.acts_as_revisionable_options[:meta] = [:label, "version"]
+        record_1 = OtherRevisionableTestModel.create!(:name => "test", :updated_by => "dude")
+        record_1.stub!(:label => "this is a label", :version => 100)
+        record_1.create_revision!
+        revision = record_1.last_revision
+        revision.label.should == "this is a label"
+        revision.updated_by.should == nil
+        revision.version.should == 100
+      ensure
+        OtherRevisionableTestModel.acts_as_revisionable_options[:meta] = meta_value
+      end
+    end
   
     it "should not create a revision entry if revisioning is disabled" do
       record = RevisionableTestModel.create!(:name => "test")
@@ -322,7 +354,7 @@ describe ActsAsRevisionable do
       end
       model.reload
       ActsAsRevisionable::RevisionRecord.count.should == 0
-
+  
       model.should_receive(:update).and_raise("update failed")
       model.name = 'new_name'
       begin
@@ -334,7 +366,7 @@ describe ActsAsRevisionable do
       end
       ActsAsRevisionable::RevisionRecord.count.should == 0
     end
-
+  
     it "should not save a revision if an update fails with errors" do
       model = RevisionableTestModel.new(:name => 'test')
       model.store_revision do
@@ -342,7 +374,7 @@ describe ActsAsRevisionable do
       end
       model.reload
       ActsAsRevisionable::RevisionRecord.count.should == 0
-
+  
       model.name = 'new_name'
       model.store_revision do
         ActsAsRevisionable::RevisionRecord.count.should == 1
@@ -351,7 +383,7 @@ describe ActsAsRevisionable do
       end
       ActsAsRevisionable::RevisionRecord.count.should == 0
     end
-
+  
     it "should mark the last revision for a deleted record as being trash" do
       model = ActsAsRevisionable::RevisionableNamespaceModel.new(:name => 'test')
       model.save!
@@ -364,7 +396,7 @@ describe ActsAsRevisionable do
       ActsAsRevisionable::RevisionRecord.last_revision(ActsAsRevisionable::RevisionableNamespaceModel, model.id).should be_trash  
     end
   end
-
+  
   context "restoring revisions" do
     it "should restore a record without associations" do
       model = RevisionableTestModel.new(:name => 'test')
@@ -374,7 +406,7 @@ describe ActsAsRevisionable do
       end
       model.reload
       ActsAsRevisionable::RevisionRecord.count.should == 0
-
+  
       model.name = 'new_name'
       model.set_secret(5678)
       model.store_revision do
@@ -384,12 +416,12 @@ describe ActsAsRevisionable do
       ActsAsRevisionable::RevisionRecord.count.should == 1
       model.name.should == 'new_name'
       model.secret.should == 5678
-
+  
       restored = model.restore_revision(1)
       restored.name.should == 'test'
       restored.secret.should == 1234
       restored.id.should == model.id
-
+  
       restored.store_revision do
         restored.save!
       end
@@ -399,12 +431,12 @@ describe ActsAsRevisionable do
       restored_model.name.should == restored.name
       restored_model.secret.should == restored.secret
     end
-
+  
     it "should restore a record with has_many associations" do
       many_thing_1 = RevisionableTestManyThing.new(:name => 'many_thing_1')
       many_thing_1.sub_things.build(:name => 'sub_thing_1')
       many_thing_1.sub_things.build(:name => 'sub_thing_2')
-
+  
       model = RevisionableTestModel.new(:name => 'test')
       model.many_things << many_thing_1
       model.many_things.build(:name => 'many_thing_2')
@@ -416,7 +448,7 @@ describe ActsAsRevisionable do
       RevisionableTestSubThing.count.should == 2
       RevisionableTestManyOtherThing.count.should == 2
       ActsAsRevisionable::RevisionRecord.count.should == 0
-
+  
       model.store_revision do
         model.name = 'new_name'
         many_thing_1 = model.many_things.detect{|t| t.name == 'many_thing_1'}
@@ -439,7 +471,7 @@ describe ActsAsRevisionable do
         sub_thing_1.save!
         many_other_thing_1.save!
       end
-
+  
       model.reload
       ActsAsRevisionable::RevisionRecord.count.should == 1
       RevisionableTestManyThing.count.should == 2
@@ -449,7 +481,7 @@ describe ActsAsRevisionable do
       model.many_things.collect{|t| t.name}.sort.should == ['many_thing_3', 'new_many_thing_1']
       model.many_things.detect{|t| t.name == 'new_many_thing_1'}.sub_things.collect{|t| t.name}.sort.should == ['new_sub_thing_1', 'sub_thing_3']
       model.many_other_things.collect{|t| t.name}.sort.should == ['many_other_thing_3', 'new_many_other_thing_1']
-
+  
       # restore to memory
       restored = model.restore_revision(1)
       restored.name.should == 'test'
@@ -458,14 +490,14 @@ describe ActsAsRevisionable do
       restored.many_things.detect{|t| t.name == 'many_thing_1'}.sub_things.collect{|t| t.name}.sort.should == ['sub_thing_1', 'sub_thing_2']
       restored.many_other_things.collect{|t| t.name}.sort.should == ['many_other_thing_3', 'new_many_other_thing_1']
       restored.valid?.should == true
-
+  
       # make the restore to memory didn't affect the database
       model.reload
       model.name.should == 'new_name'
       model.many_things(true).collect{|t| t.name}.sort.should == ['many_thing_3', 'new_many_thing_1']
       model.many_things.detect{|t| t.name == 'new_many_thing_1'}.sub_things.collect{|t| t.name}.sort.should == ['new_sub_thing_1', 'sub_thing_3']
       model.many_other_things.collect{|t| t.name}.sort.should == ['many_other_thing_3', 'new_many_other_thing_1']
-
+  
       model.restore_revision!(1)
       RevisionableTestModel.count.should == 1
       RevisionableTestManyThing.count.should == 2
@@ -479,7 +511,7 @@ describe ActsAsRevisionable do
       restored.many_things.detect{|t| t.name == 'many_thing_2'}.sub_things.collect{|t| t.name}.sort.should == []
       restored.many_other_things.collect{|t| t.name}.sort.should == ['many_other_thing_3', 'new_many_other_thing_1']
     end
-
+  
     it "should restore a record with has_one associations" do
       model = RevisionableTestModel.new(:name => 'test')
       model.build_one_thing(:name => 'other')

data/spec/spec_helper.rb

@@ -19,7 +19,7 @@ if ActiveRecord::VERSION::MAJOR >= 3
   if ActiveRecord::VERSION::MINOR == 0
     composite_primary_key_version = "~>3.1.0"
   else
-    composite_primary_key_version = "~>4.0.0.a"
+    composite_primary_key_version = ">=4.0.0"
   end
 else
   composite_primary_key_version = "~>2.3.5"

metadata

@@ -1,198 +1,80 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: acts_as_revisionable
-version: !ruby/object:Gem::Version 
-  hash: 31
+version: !ruby/object:Gem::Version
+  version: 1.2.1
   prerelease: 
-  segments: 
-  - 1
-  - 2
-  - 0
-  version: 1.2.0
 platform: ruby
-authors: 
+authors:
 - Brian Durand
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-08-05 00:00:00 -05:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: rake
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  prerelease: false
-  type: :runtime
-  requirement: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 2
-        - 6
-        - 0
-        version: 2.6.0
-  prerelease: false
-  type: :runtime
-  requirement: *id002
-- !ruby/object:Gem::Dependency 
+date: 2011-11-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activerecord
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  requirement: &2161226620 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 17
-        segments: 
-        - 2
-        - 3
-        - 9
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.3.9
-  prerelease: false
   type: :runtime
-  requirement: *id003
-- !ruby/object:Gem::Dependency 
-  name: activesupport
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 17
-        segments: 
-        - 2
-        - 3
-        - 9
-        version: 2.3.9
   prerelease: false
-  type: :runtime
-  requirement: *id004
-- !ruby/object:Gem::Dependency 
+  version_requirements: *2161226620
+- !ruby/object:Gem::Dependency
   name: composite_primary_keys
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  requirement: &2161226000 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
-  type: :runtime
-  requirement: *id005
-- !ruby/object:Gem::Dependency 
+  version_requirements: *2161226000
+- !ruby/object:Gem::Dependency
   name: sqlite3
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 19
-        segments: 
-        - 1
-        - 3
-        - 4
-        version: 1.3.4
-  prerelease: false
-  type: :runtime
-  requirement: *id006
-- !ruby/object:Gem::Dependency 
-  name: activerecord
-  version_requirements: &id007 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 17
-        segments: 
-        - 2
-        - 3
-        - 9
-        version: 2.3.9
-  prerelease: false
-  type: :runtime
-  requirement: *id007
-- !ruby/object:Gem::Dependency 
-  name: composite_primary_keys
-  version_requirements: &id008 !ruby/object:Gem::Requirement 
+  requirement: &2161225440 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  prerelease: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  requirement: *id008
-- !ruby/object:Gem::Dependency 
-  name: sqlite3
-  version_requirements: &id009 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
   prerelease: false
-  type: :development
-  requirement: *id009
-- !ruby/object:Gem::Dependency 
+  version_requirements: *2161225440
+- !ruby/object:Gem::Dependency
   name: rspec
-  version_requirements: &id010 !ruby/object:Gem::Requirement 
+  requirement: &2161224920 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 2
-        - 0
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.0.0
-  prerelease: false
   type: :development
-  requirement: *id010
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: *2161224920
+- !ruby/object:Gem::Dependency
   name: jeweler
-  version_requirements: &id011 !ruby/object:Gem::Requirement 
+  requirement: &2161224300 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  prerelease: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  requirement: *id011
-description: ActiveRecord extension that provides revision support so that history can be tracked and changes can be reverted. Emphasis for this plugin versus similar ones is including associations, saving on storage, and extensibility of the model.
+  prerelease: false
+  version_requirements: *2161224300
+description: ActiveRecord extension that provides revision support so that history
+  can be tracked and changes can be reverted. Emphasis for this plugin versus similar
+  ones is including associations, saving on storage, and extensibility of the model.
 email: brian@embellishedvisions.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.rdoc
-files: 
+files:
 - MIT-LICENSE
 - README.rdoc
 - Rakefile
@@ -202,39 +84,29 @@ files:
 - spec/revision_record_spec.rb
 - spec/spec_helper.rb
 - spec/version_1_1_upgrade_spec.rb
-has_rdoc: true
 homepage: http://github.com/bdurand/acts_as_revisionable
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.5.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: ActiveRecord extension that provides revision support so that history can be tracked and changes can be reverted.
+summary: ActiveRecord extension that provides revision support so that history can
+  be tracked and changes can be reverted.
 test_files: []
-