has_moderated 1.0.rc4 → 1.0.rc5

data/README.rdoc

@@ -5,7 +5,7 @@
 
 Add it to your project's Gemfile
 
-  gem "has_moderated"
+  gem "has_moderated", ">=1.0.rc4"
 
 and run
 
@@ -28,6 +28,8 @@ When upgrading, rerun the generator
 
 If there is a new migration file and you have filename conflicts, remove the old one and apply the new one, in case the schema changed. This is especially important if you are upgrading from a previous version to v1.x.
 
+Before upgrading make sure you have reviewed and accepted/declined all current moderations first! This means the moderations table in database must be empty, otherwise the migration process will fail (on purpose). I suggest you modify the migration generated by has_moderated:install to first accept or discard all existing moderations, based on your preference - or do it in your administrative interface before deploying the upgrade.
+
 == Why use this instead of something like Papertrail?
 
 Papertrail and vestal_versions for example, are designed not for moderation, but for tracking changes on models. If you use Papertrail for moderating, you will always have the "newest" version in the database, while previous changes will be recorded in a special table. The problem with this for moderation is that when you are showing records, you have to read from both the model table and the "changes" table in the database, and do additional processing to combine them. This will impact performance quite a bit.
@@ -110,16 +112,33 @@ Do not use moderation.destroy, because discard triggers certain callbacks which
 
 == Preview moderation
 
-You can see a preview of what a moderation will do. Right now, you can only preview changes to attributes, not associations. To create a preview of how a record will look after applying a moderation, use
+You can see a preview of what a moderation will do.
 
-  record_preview = moderation.preview
-  
-This will return the record with modified attributes, but not saved to database. You can see what changed by looking at (provided by ActiveRecord)
+=== Get a read-only preview
 
-  record_preview.changes
+This method allows you to retrieve a fake object which behaves like an ActiveRecord object, but is read-only.
+This object allows you to see the value of all attributes, as well as all the associations (including non-moderated).
+It also supports dirty tracking through ActiveModel, so you can use all its functionality (http://api.rubyonrails.org/classes/ActiveModel/Dirty.html).
+
+  preview = moderation.preview
+  preview.some_attr # => "new value"
+  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]>
   
-Just be careful not to call record_preview.save, as this will create a new moderation record.
+This preview is cached from applying the moderation in a transaction and then rolling it back (so it does not *really* affect the database).
+
+=== Get a real ActiveRecord preview
 
+This way, you will get a real ActiveRecord object that is really in the database. You can do whatever you want on it, however the difference is that you need to use it inside the live_preview block. This is because the moderation is applied in a transaction and after you are done using the preview, the transaction will be rolled back. I would recommend using the read-only fake object (see above) if you can, as it is safer. But sometimes you just need access to the real ActiveRecord object.
+
+  moderation.live_preview do |preview|
+    preview.some_attr # => "new value"
+    # note how we need to use .previous_changes when using live_preview,
+    # .changes will be blank as the record has already been saved to DB
+    preview.previous_changes # => {"attr"=>["old", "new"]}
+    preview.some_association.first # => ActiveRecord object
+  end
+  
 == Which kind of moderation is it?
 
 You can call the following convenience methods to determine the type of moderation
@@ -227,6 +246,8 @@ It is also possible you will encounter problems with some heavily customized ass
 
 This is just for my personal todo list...
 
+improve functionality when rerunning has_moderated:install generator
+
 hm maybe has_moderated_association could be just a has_moderated_create on the assoc? just check stuff like if task_id is not nil or something. could be much easier to implement then
 
 also maybe use dirty https://github.com/rails/rails/blob/master/activemodel/lib/active_model/dirty.rb

data/Rakefile

@@ -23,9 +23,14 @@ end
 Bundler::GemHelper.install_tasks
 
 require 'rspec/core/rake_task'
-
 RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.rspec_opts = %w(--color)
   spec.pattern = 'test/dummy/spec{,/*/**}/*_spec.rb'
 end
 
-task :default  => :spec
+task :prepare_test_env do
+  puts "Preparing test environment..."
+  system("cd test/dummy && RAILS_ENV=test rake db:schema:load") # db:test:prepare
+end
+
+task :default  => [:spec]

data/lib/has_moderated/associations/base.rb

@@ -130,12 +130,7 @@ module HasModerated
         end
       
         # add/delete associations to a record
-        def self.apply(moderation, data)
-          record = if moderation.kind_of? Moderation
-            moderation.moderatable
-          else
-            moderation
-          end
+        def self.apply(record, data)
           associations = data[:associations]
           delete_associations = data[:delete_associations]
           
@@ -154,6 +149,8 @@ module HasModerated
               apply_delete_association(record, reflection, attrs) if attrs.present?
             end
           end
+          
+          record
         end
       end # module
     end

data/lib/has_moderated/moderated_attributes.rb

@@ -51,16 +51,13 @@ module HasModerated
     end
     
     module ApplyModeration
-      def self.apply(moderation, value, do_save = true)
+      def self.apply(rec, value)
         if value[:attributes].present?
-          rec = moderation.moderatable
           rec.without_moderation do
             value[:attributes].each_pair do |attr_name, attr_value|
               # bypass attr_accessible protection
               rec.send(attr_name.to_s+"=", attr_value)
             end
-            # don't run validations on save (were already ran when moderation was created)
-            rec.save(:validate => false) if do_save
           end
         end
         rec

data/lib/has_moderated/moderated_create.rb

@@ -16,19 +16,20 @@ module HasModerated
     end
     
     module ApplyModeration
-      def self.apply(moderation, value)
+      def self.apply(klass, value)
+        rec = nil
         if value[:create].present?
           # create the main record
-          rec = moderation.moderatable_type.constantize.new
+          rec = klass.new
           attrs = value[:create][:attributes]
           # bypass attr_accessible protection
           attrs && attrs.each_pair do |key, val|
             rec.send(key.to_s+"=", val) unless key.to_s == 'id'
           end
           rec.without_moderation { rec.save(:validate => false) }
-          moderation.moderatable = rec # just so associations can be applied in next line
-          HasModerated::Associations::Base::ApplyModeration::apply(moderation, value[:create])
+          HasModerated::Associations::Base::ApplyModeration::apply(rec, value[:create])
         end
+        rec
       end
     end
     

data/lib/has_moderated/moderated_destroy.rb

@@ -12,9 +12,12 @@ module HasModerated
     end
     
     module ApplyModeration
-      def self.apply(moderation, value)
+      def self.apply(record, value)
         if value[:destroy] == true
-          moderation.moderatable.without_moderation { |m| m.destroy }
+          record.without_moderation { |m| m.destroy }
+          nil
+        else
+          record
         end
       end
     end

data/lib/has_moderated/moderation_model.rb

@@ -4,13 +4,35 @@ module HasModerated
       @parsed_data ||= YAML::load(data)
     end
     
+    def apply
+      if create?
+        record = HasModerated::ModeratedCreate::ApplyModeration::apply(moderatable_type.constantize, parsed_data)
+      else
+        record = moderatable
+        if record
+          record = HasModerated::ModeratedAttributes::ApplyModeration::apply(record, parsed_data)
+          record = HasModerated::Associations::Base::ApplyModeration::apply(record, parsed_data)
+          record = HasModerated::ModeratedDestroy::ApplyModeration::apply(record, parsed_data)
+        end
+      end
+      record
+    end
+    
+    def accept_changes(record)
+      if record
+        HasModerated::Common::try_without_moderation(record) do
+          # don't run validations on save (were already ran when moderation was created)
+          record.save(:validate => false)
+        end
+      end
+      record
+    end
+    
     def accept
-      loaded_val = parsed_data
-      HasModerated::ModeratedCreate::ApplyModeration::apply(self, loaded_val)
-      HasModerated::ModeratedAttributes::ApplyModeration::apply(self, loaded_val)
-      HasModerated::Associations::Base::ApplyModeration::apply(self, loaded_val)
-      HasModerated::ModeratedDestroy::ApplyModeration::apply(self, loaded_val)
+      record = apply
+      accept_changes(record)
       self.destroy
+      record
     end
 
     def discard
@@ -21,8 +43,21 @@ module HasModerated
       self.destroy
     end
     
+    def live_preview
+      ActiveRecord::Base.transaction do
+        record = accept
+        yield(record)
+        raise ActiveRecord::Rollback
+      end
+      nil
+    end
+    
     def preview
-      HasModerated::ModeratedAttributes::ApplyModeration::apply(self, parsed_data, false)
+      fake_record = nil
+      live_preview do |record|
+        fake_record = HasModerated::Preview::from_live(record)
+      end
+      fake_record
     end
     
     def create?

data/lib/has_moderated/moderation_preview.rb

@@ -0,0 +1,86 @@
+require 'ostruct'
+module HasModerated
+  module Preview
+    class FakeRecord
+      extend ActiveModel::Naming
+      include ActiveModel::Conversion
+      include ActiveModel::Dirty
+      
+      attr_accessor :attributes
+      
+      def initialize(fake_of_model)
+        @fake_of_model = fake_of_model
+      end
+      
+      def persisted?
+        false
+      end
+      
+      def attribute name
+        attributes[name]
+      end
+      
+      def to_s
+        "#<HasModerated::Fake#{@fake_of_model.to_s}>"
+      end
+      
+      def inspect
+        to_s.chomp(">") +
+          instance_variables.map{|name| " #{name}=#{instance_variable_get(name)}"}.join(",") +
+          ", reflections.keys => [" + reflections.keys.map{|s| ":#{s}"}.join(", ")+ "]>"
+      end
+    end
+    
+    def self.create_fake_association(attr_name, value, target)
+      target.send(:define_method, attr_name) do
+        value
+      end
+    end
+    
+    def self.resolve_record(record, cache)
+      return nil if record.blank?
+      cache[record.class] ||= Hash.new
+      if cache[record.class][record.id].present?
+        cache[record.class][record.id]
+      else
+        cache[record.class][record.id] = from_live(record, cache)
+      end
+    end
+    
+    def self.from_live(record, object_cache = nil)
+      return nil if record.blank?
+      obj = FakeRecord.new(record.class)
+      eigenclass = (class << obj ; self ; end)
+      
+      obj.instance_variable_set(:@attributes, record.instance_variable_get(:@attributes))
+      changed_attributes = Hash.new
+      record.previous_changes.each_pair do |attr_name, values|
+        changed_attributes[attr_name] = values[0]
+      end
+      obj.instance_variable_set(:@changed_attributes, changed_attributes)
+      
+      # associations
+      object_cache ||= Hash.new
+      object_cache[record.class] ||= Hash.new
+      object_cache[record.class][record.id] = obj
+      eigenclass.send(:define_method, :reflections) do
+        record.class.reflections.reject{|k,v| k.to_sym == :moderations}
+      end
+      record.class.reflections.values.reject{|s| s.name.to_sym == :moderations}.each do |reflection|
+        if reflection.macro == :has_one || reflection.macro == :belongs_to
+          create_fake_association(
+            reflection.name,
+            resolve_record(record.send(reflection.name), object_cache),
+            eigenclass)
+        elsif reflection.collection?
+          create_fake_association(
+            reflection.name,
+            record.send(reflection.name).map{|r| resolve_record(r, object_cache)},
+            eigenclass)
+        end
+      end
+      
+      obj
+    end
+  end
+end

data/lib/has_moderated/version.rb

@@ -1,3 +1,3 @@
 module HasModerated
-  VERSION = "1.0.rc4"
+  VERSION = "1.0.rc5"
 end

data/lib/has_moderated.rb

@@ -1,6 +1,7 @@
 require 'has_moderated/common'
 require 'has_moderated/user_hooks'
 require 'has_moderated/moderation_model'
+require 'has_moderated/moderation_preview'
 
 require 'has_moderated/active_record/active_record_helpers'
 require 'has_moderated/associations/base'

data/test/dummy/log/development.log

@@ -0,0 +1,72 @@
+Connecting to database specified by database.yml
+   (0.2ms)  select sqlite_version(*)
+   (1.3ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+   (0.0ms)  PRAGMA index_list("schema_migrations")
+   (1.1ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+Connecting to database specified by database.yml
+   (1.7ms)  select sqlite_version(*)
+   (1.5ms)  CREATE TABLE "moderations" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "moderatable_id" integer, "moderatable_type" varchar(255), "data" text NOT NULL, "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL) 
+   (1.2ms)  CREATE TABLE "photos" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "avatar" varchar(255), "picture" varchar(255), "parentable_id" integer, "parentable_type" varchar(255), "title" varchar(255), "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL) 
+   (2.0ms)  CREATE TABLE "subtasks" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "task_id" integer, "title" varchar(255), "desc" varchar(255), "created_at" datetime, "updated_at" datetime, "parentable_id" integer, "parentable_type" varchar(255)) 
+   (1.2ms)  CREATE TABLE "task_connections" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "title" varchar(255), "m1_id" integer, "m2_id" integer, "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL) 
+   (1.3ms)  CREATE TABLE "task_photos" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "photo" varchar(255), "task_id" integer, "created_at" datetime, "updated_at" datetime) 
+   (1.1ms)  CREATE TABLE "tasks" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "title" varchar(255), "desc" varchar(255), "created_at" datetime, "updated_at" datetime) 
+   (1.1ms)  CREATE TABLE "tasks_jointable" ("m1_id" integer, "m2_id" integer) 
+   (0.1ms)  SELECT version FROM "schema_migrations"
+   (2.4ms)  INSERT INTO "schema_migrations" (version) VALUES ('20120520215224')
+   (1.0ms)  INSERT INTO "schema_migrations" (version) VALUES ('20120520215008')
+Connecting to database specified by database.yml
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.4ms)  select sqlite_version(*)
+   (65.9ms)  CREATE TABLE "moderations" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "moderatable_id" integer, "moderatable_type" varchar(255), "data" text NOT NULL, "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL) 
+   (21.1ms)  CREATE TABLE "photos" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "avatar" varchar(255), "picture" varchar(255), "parentable_id" integer, "parentable_type" varchar(255), "title" varchar(255), "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL) 
+   (2.0ms)  CREATE TABLE "subtasks" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "task_id" integer, "title" varchar(255), "desc" varchar(255), "created_at" datetime, "updated_at" datetime, "parentable_id" integer, "parentable_type" varchar(255)) 
+   (1.1ms)  CREATE TABLE "task_connections" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "title" varchar(255), "m1_id" integer, "m2_id" integer, "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL) 
+   (1.6ms)  CREATE TABLE "task_photos" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "photo" varchar(255), "task_id" integer, "created_at" datetime, "updated_at" datetime) 
+   (1.1ms)  CREATE TABLE "tasks" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "title" varchar(255), "desc" varchar(255), "created_at" datetime, "updated_at" datetime) 
+   (2.0ms)  CREATE TABLE "tasks_jointable" ("m1_id" integer, "m2_id" integer) 
+   (1.1ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+   (0.0ms)  PRAGMA index_list("schema_migrations")
+   (1.2ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+   (0.1ms)  SELECT version FROM "schema_migrations"
+   (1.2ms)  INSERT INTO "schema_migrations" (version) VALUES ('20120520215224')
+   (2.4ms)  INSERT INTO "schema_migrations" (version) VALUES ('20120520215008')
+Connecting to database specified by database.yml
+   (1.8ms)  select sqlite_version(*)
+   (1.4ms)  DROP TABLE "moderations"
+   (1.2ms)  CREATE TABLE "moderations" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "moderatable_id" integer, "moderatable_type" varchar(255), "data" text NOT NULL, "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL) 
+   (1.2ms)  DROP TABLE "photos"
+   (1.1ms)  CREATE TABLE "photos" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "avatar" varchar(255), "picture" varchar(255), "parentable_id" integer, "parentable_type" varchar(255), "title" varchar(255), "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL) 
+   (1.1ms)  DROP TABLE "subtasks"
+   (2.9ms)  CREATE TABLE "subtasks" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "task_id" integer, "title" varchar(255), "desc" varchar(255), "created_at" datetime, "updated_at" datetime, "parentable_id" integer, "parentable_type" varchar(255)) 
+   (1.2ms)  DROP TABLE "task_connections"
+   (1.2ms)  CREATE TABLE "task_connections" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "title" varchar(255), "m1_id" integer, "m2_id" integer, "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL) 
+   (1.1ms)  DROP TABLE "task_photos"
+   (1.2ms)  CREATE TABLE "task_photos" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "photo" varchar(255), "task_id" integer, "created_at" datetime, "updated_at" datetime) 
+   (1.1ms)  DROP TABLE "tasks"
+   (1.1ms)  CREATE TABLE "tasks" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "title" varchar(255), "desc" varchar(255), "created_at" datetime, "updated_at" datetime) 
+   (2.3ms)  DROP TABLE "tasks_jointable"
+   (1.2ms)  CREATE TABLE "tasks_jointable" ("m1_id" integer, "m2_id" integer) 
+   (0.1ms)  SELECT version FROM "schema_migrations"
+Connecting to database specified by database.yml
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.3ms)  select sqlite_version(*)
+   (1.4ms)  CREATE TABLE "moderations" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "moderatable_id" integer, "moderatable_type" varchar(255), "data" text NOT NULL, "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL) 
+   (1.2ms)  CREATE TABLE "photos" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "avatar" varchar(255), "picture" varchar(255), "parentable_id" integer, "parentable_type" varchar(255), "title" varchar(255), "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL) 
+   (1.1ms)  CREATE TABLE "subtasks" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "task_id" integer, "title" varchar(255), "desc" varchar(255), "created_at" datetime, "updated_at" datetime, "parentable_id" integer, "parentable_type" varchar(255)) 
+   (1.1ms)  CREATE TABLE "task_connections" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "title" varchar(255), "m1_id" integer, "m2_id" integer, "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL) 
+   (1.2ms)  CREATE TABLE "task_photos" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "photo" varchar(255), "task_id" integer, "created_at" datetime, "updated_at" datetime) 
+   (1.1ms)  CREATE TABLE "tasks" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "title" varchar(255), "desc" varchar(255), "created_at" datetime, "updated_at" datetime) 
+   (1.1ms)  CREATE TABLE "tasks_jointable" ("m1_id" integer, "m2_id" integer) 
+   (1.0ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+   (0.0ms)  PRAGMA index_list("schema_migrations")
+   (1.2ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+   (0.1ms)  SELECT version FROM "schema_migrations"
+   (1.1ms)  INSERT INTO "schema_migrations" (version) VALUES ('20120520215224')
+   (1.1ms)  INSERT INTO "schema_migrations" (version) VALUES ('20120520215008')
+Connecting to database specified by database.yml
+Connecting to database specified by database.yml
+Connecting to database specified by database.yml
+Connecting to database specified by database.yml
+Connecting to database specified by database.yml