has_moderated 1.0.rc6 → 1.0.rc7

data/README.rdoc

@@ -5,7 +5,7 @@
 
 Add it to your project's Gemfile
 
-  gem "has_moderated", ">=1.0.rc6"
+  gem "has_moderated", ">=1.0.rc7"
 
 and run
 
@@ -125,7 +125,19 @@ It also supports dirty tracking through ActiveModel, so you can use all its func
   preview.some_attr_change # => ["old value", "new value"]
   preview.some_association.first # => #<HasModerated::FakeTask @fake_of_model=Task, @attributes={"id"=>1, "title"=>"Task 1", "desc"=>nil, "created_at"=>"2012-06-08 15:49:56.726646", "updated_at"=>"2012-06-08 15:49:56.726646"}, @changed_attributes={}, reflections.keys => [:assoc1, :assoc2]>
   
-This preview is cached from applying the moderation in a transaction and then rolling it back (so it does not *really* affect the database).
+This preview is cached from applying the moderation in a transaction and then rolling it back (so it does not affect the database).
+
+=== Using the fake object to modify the moderation
+
+The fake object described above has a nifty feature (1.0.rc7+) that allows you to update attributes in the moderation by manipulating the fake object. Right now it can only handle attributes and not associations, but that might change in the future. See example below on how to use this feature.
+
+  moderation.parsed_data # => {:attributes=>{"title"=>"Task 1"}}
+  preview = moderation.preview(:saveable => true)
+  preview.title = "Task 2"
+  preview.update_moderation
+  moderation.parsed_data # => {:attributes=>{"title"=>"Task 2"}}
+  moderation.apply
+  Task.first.title # => "Task 2"
 
 === Get a real ActiveRecord preview
 
@@ -139,6 +151,25 @@ This way, you will get a real ActiveRecord object that is really in the database
     preview.some_association.first # => ActiveRecord object
   end
   
+Note that since a transaction is used in both cases, all the changes made to the database to produce the preview are only in effect inside the transaction, so the changes are only visible inside the transaction. For example, if a second database query comes from another Rails instance, it will not see the changes that are in effect in the transaction, even if the transaction is still in process.
+
+=== Example of using preview in your show action
+
+In this example I allow admin users to add a preview parameter to the URL to see the preview of how the record will look after applying a moderation, without having to change code in the views.
+
+  def show
+    @doctor = Doctor.find_by_slug(params[:id])
+    
+    if current_admin_user && params[:preview]
+      @doctor.moderations.find_by_id(params[:preview]).live_preview do |preview|
+        @doctor = preview
+        render :action => "show"
+      end
+    else
+      render :action => "show"
+    end
+  end
+
 == Which kind of moderation is it?
 
 You can call the following convenience methods to determine the type of moderation

data/lib/has_moderated/moderation_model.rb

@@ -44,18 +44,24 @@ module HasModerated
     end
     
     def live_preview
-      ActiveRecord::Base.transaction do
+      self.transaction do
         record = accept
         yield(record)
         raise ActiveRecord::Rollback
       end
+      # self.frozen? now became true
+      # since we don't actually commit to database, we don't need the freeze
+      # only way I found to unfreeze is to dup attributes
+      @attributes = @attributes.dup
+      
       nil
     end
     
-    def preview
+    def preview(options = {})
+      options[:saveable] ||= false
       fake_record = nil
       live_preview do |record|
-        fake_record = HasModerated::Preview::from_live(record)
+        fake_record = HasModerated::Preview::from_live(record, self, options[:saveable])
       end
       fake_record
     end

data/lib/has_moderated/moderation_preview.rb

@@ -1,6 +1,25 @@
 require 'ostruct'
 module HasModerated
   module Preview
+    module Saveable
+      def update_moderation
+        if @based_on_moderation.present?
+          data = @based_on_moderation.parsed_data
+        
+          # attributes
+          data[:attributes] ||= Hash.new
+          @attributes.each_pair do |key, value|
+            if value != @attributes_initial[key]
+              data[:attributes][key.to_s] = value
+            end
+          end
+          
+          @based_on_moderation.data = data
+          @based_on_moderation.save
+        end
+      end
+    end
+    
     class FakeRecord
       extend ActiveModel::Naming
       include ActiveModel::Conversion
@@ -8,8 +27,9 @@ module HasModerated
       
       attr_accessor :attributes
       
-      def initialize(fake_of_model)
-        @fake_of_model = fake_of_model
+      def initialize(based_on_model, based_on_moderation)
+        @based_on_model = based_on_model
+        @based_on_moderation = based_on_moderation
       end
       
       def persisted?
@@ -25,7 +45,7 @@ module HasModerated
       end
       
       def to_s
-        "#<HasModerated::Fake#{@fake_of_model.to_s}>"
+        "#<HasModerated::Fake#{@based_on_model.to_s}>"
       end
       
       def inspect
@@ -47,15 +67,16 @@ module HasModerated
       if cache[record.class][record.id].present?
         cache[record.class][record.id]
       else
-        cache[record.class][record.id] = from_live(record, cache)
+        cache[record.class][record.id] = from_live(record, nil, false, cache)
       end
     end
     
-    def self.from_live(record, object_cache = nil)
+    def self.from_live(record, moderation = nil, saveable = false, object_cache = nil)
       return nil if record.blank?
-      obj = FakeRecord.new(record.class)
+      obj = FakeRecord.new(record.class, moderation)
       eigenclass = (class << obj ; self ; end)
       
+      # attributes
       obj.instance_variable_set(:@attributes, record.instance_variable_get(:@attributes))
       changed_attributes = Hash.new
       record.previous_changes.each_pair do |attr_name, values|
@@ -63,6 +84,17 @@ module HasModerated
       end
       obj.instance_variable_set(:@changed_attributes, changed_attributes)
       
+      # saveable
+      if saveable
+        obj.instance_variable_set(:@attributes_initial, record.instance_variable_get(:@attributes).dup)
+        eigenclass.send(:include, Saveable)
+        obj.attributes.keys.each do |attr_name|
+          eigenclass.send(:define_method, "#{attr_name}=") do |value|
+            self.attributes[attr_name.to_s] = value
+          end
+        end
+      end
+      
       # associations
       object_cache ||= Hash.new
       object_cache[record.class] ||= Hash.new

data/lib/has_moderated/version.rb

@@ -1,3 +1,3 @@
 module HasModerated
-  VERSION = "1.0.rc6"
+  VERSION = "1.0.rc7"
 end