acts_as_revisionable 1.1.1 → 1.1.2

data/lib/acts_as_revisionable.rb

@@ -29,9 +29,15 @@ module ActsAsRevisionable
     # <tt>empty_trash</tt> method. You can set <tt>:on_destroy => true</tt> to automatically create the trash revision
     # whenever a record is destroyed. It is recommended that you turn both of these features on.
     #
+    # Revision records have an optional +label+ field which can be used for display purposes to distinguish revisions
+    # in a view. This value will only be set if you provide a Proc for the <tt>:label</tt> option to the +acts_as_revisionable+
+    # call. The proc will be yielded to with the record before it is revisioned.
+    #
+    #   acts_as_revisionable :label => lambda{|record| "Updated by #{record.updated_by} at #{record.updated_at}"}
+    #
     # A has_many :revision_records will also be added to the model for accessing the revisions.
     def acts_as_revisionable(options = {})
-      class_attribute :acts_as_revisionable_options
+      class_attribute :acts_as_revisionable_options, :instance_writer => false, :instance_reader => false
       self.acts_as_revisionable_options = options.clone
         extend ClassMethods
       include InstanceMethods
@@ -220,6 +226,9 @@ module ActsAsRevisionable
     # Create a revision record based on this record and save it to the database.
     def create_revision!
       revision = RevisionRecord.new(self, acts_as_revisionable_options[:encoding])
+      if self.acts_as_revisionable_options[:label].is_a?(Proc)
+        revision.label = self.acts_as_revisionable_options[:label].call(self)
+      end
       revision.save!
       return revision
     end

data/spec/acts_as_revisionable_spec.rb

@@ -94,7 +94,7 @@ describe ActsAsRevisionable do
         t.column :secret, :integer
       end unless table_exists?
       
-      acts_as_revisionable :on_update => true
+      acts_as_revisionable :on_update => true, :label => lambda{|record| "name was '#{record.name}'"}
     end
 
     module ActsAsRevisionable
@@ -266,6 +266,14 @@ describe ActsAsRevisionable do
       ActsAsRevisionable::RevisionRecord.count.should == 1
     end
   
+    it "should yield to the label proc when creating a revision record" do
+      record_1 = OtherRevisionableTestModel.create(:name => "test")
+      ActsAsRevisionable::RevisionRecord.count.should == 0
+      record_1.create_revision!
+      ActsAsRevisionable::RevisionRecord.count.should == 1
+      record_1.last_revision.label.should == "name was 'test'"
+    end
+  
     it "should not create a revision entry if revisioning is disabled" do
       record = RevisionableTestModel.create(:name => "test")
       ActsAsRevisionable::RevisionRecord.count.should == 0

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: acts_as_revisionable
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 23
   prerelease: 
   segments: 
   - 1
   - 1
-  - 1
-  version: 1.1.1
+  - 2
+  version: 1.1.2
 platform: ruby
 authors: 
 - Brian Durand
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-05 00:00:00 -05:00
+date: 2011-07-12 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency