has_moderated 1.0.alpha2 → 1.0.beta

data/README.rdoc

@@ -88,9 +88,13 @@ You can also see moderations for a specific record. For example, if you have Pos
   post = Post.first
   post.moderations
   
-Moderation is a normal ActiveRecord model, you can inspect it in rails console to see what it holds. Data is serialized in YAML format and can be deserialized by calling
+Moderation is a normal ActiveRecord model, you can inspect it in rails console to see what it holds. Data is serialized in YAML format
 
-  YAML::load(moderation.data)
+  moderation.data
+
+The data can be deserialized using YAML::load, but this has already been done for you
+
+  moderation.parsed_data
 
 To accept a moderation, call
 
@@ -139,24 +143,48 @@ This is just one example how you can do it. You need the attr_accessor here beca
 
 == CarrierWave support
 
-There is support for CarrierWave uploads to be moderated. You must put this line into the model that has a CarrierWave uploader mounted:
+There is support for CarrierWave uploads to be moderated. If you need some more customization look at this module in lib/has_moderated/carrier_wave.rb and make your own version.
+
+=== Example of moderating uploads
+
+This will moderate the upload no matter if the record is being created, or updated. Other unmoderated fields will be saved normally.
 
+  mount_uploader :avatar, GenericUploader
   include HasModerated::CarrierWave
+  has_moderated_carrierwave_field :avatar
+  has_moderated :avatar
 
-Right now *you must use the field name "photo" for the upload filename* because it is currently hardcoded into this module. If you do this, then moderation for the photo should work correctly.
+=== Example of moderating create of the whole model using a CarrierWave uploader
 
-It does not matter if this model has any moderation itself or if you just have an association to it from some other model that is moderated. You must include this module in either case, because it ensures proper serialization of the photo information.
-If you want to moderate changes to the photo on this model itself (e.g. not only when its associated to something else), add also
+This will moderate creating the whole record (all its fields), including the upload.
 
-  has_moderated :carrierwave_photo
+  mount_uploader :avatar, GenericUploader
+  has_moderated_create
+  include HasModerated::CarrierWave
+  has_moderated_carrierwave_field :avatar
+  
+To moderate later changes to the upload (avatar), additionally add
 
-If you need some more customization look at this module in lib/has_moderated/carrier_wave.rb and just copy the methods into your model and customize them (with some care when you do this, some methods should be class methods).
+  has_moderated :avatar
+  
+=== Example of moderating on association
+
+If you are moderating some other model, and the model with the upload is an association to it, you still need to add this
+
+  mount_uploader :avatar, GenericUploader
+  include HasModerated::CarrierWave
+  has_moderated_carrierwave_field :avatar
+
+This will only moderate the upload when it's being saved through an association which has
+
+  has_moderated_association :photos
 
 == Tests
 
 I've tested this project using RSpec. You can find the tests in
 
   test/dummy/spec/models/task_spec.rb
+  test/dummy/spec/models/photo_spec.rb
 
 You can run the tests by running
 
@@ -187,11 +215,6 @@ to make it possible to support other than activerecord, use activemodel when its
 
 use YARD for docs
 check again railscasts episodes for gems (e.g. railties)
--
-
-make hasone, hasmany etc. each a separate "extension" (like carrierwave). for tests just use 2 models (task, subtask) and dont define has_many in model but in test
-
-Amend moderations... Eg if you create a new record and save it, then change something additionally and save again.
 Preview method which gives changed object but doesnt save it.
 
 == License

data/lib/has_moderated/associations/base.rb

@@ -30,14 +30,14 @@ module HasModerated
           assoc_names.map{ |name| self.reflections[name] }.each do |assoc|
             case assoc.macro
               when :has_many then
-                self.send :extend, HasModerated::Associations::HasMany::ClassMethods
-                has_moderated_has_many_association(assoc)
+                self.send :extend, HasModerated::Associations::Collection::ClassMethods
+                has_moderated_collection_association(assoc)
               when :has_one then
                 self.send :extend, HasModerated::Associations::HasOne::ClassMethods
                 has_moderated_has_one_association(assoc)
               when :has_and_belongs_to_many then
-                  self.send :extend, HasModerated::Associations::HasMany::ClassMethods
-                  has_moderated_has_many_association(assoc)
+                self.send :extend, HasModerated::Associations::Collection::ClassMethods
+                has_moderated_collection_association(assoc)
               else raise "don't know how to moderate association macro #{assoc.macro}"
             end
           end

data/lib/has_moderated/associations/collection.rb

@@ -79,7 +79,6 @@ module HasModerated
         def self.add_assoc_to_record_hm(to, record, reflection)
           fk = HasModerated::Adapters::ActiveRecord::foreign_key(reflection).try(:to_s)
           field = if !reflection.options[:as].blank?
-            # todo: extract
             reflection.options[:as].to_s
           elsif !fk.blank?
             all_keys = []

data/lib/has_moderated/carrier_wave.rb

@@ -4,10 +4,6 @@ module HasModerated
     
     def self.included(base)
       base.send :extend, ClassMethods
-      base.send :include, InstanceMethods
-      
-      base.alias_method_chain :store_photo!, :moderation
-      base.alias_method_chain :write_photo_identifier, :moderation
     end  
     
     def self.photo_tmp_delete(value)
@@ -29,57 +25,84 @@ module HasModerated
     end
 
     module ClassMethods
+      def has_moderated_carrierwave_field field_names
+        base = self
+        base.send :include, InstanceMethods
+        
+        cattr_accessor :moderated_carrierwave_fields
+        
+        field_names = [field_names] unless field_names.kind_of? Array
+        
+        field_names.each do |field_name|
+          field_name = field_name.to_s
+          self.moderated_carrierwave_fields ||= []
+          self.moderated_carrierwave_fields.push(field_name)
+        
+          base.send :define_method, "#{field_name}_tmp_file=" do |value|
+            self.send("#{field_name}=", File.open(value))
+            HasModerated::CarrierWave::photo_tmp_delete(value)
+          end
+        
+          base.send :define_method, "store_#{field_name}_with_moderation!" do
+            is_moderated = self.class.respond_to?(:moderated_attributes) &&
+              self.class.moderated_attributes.include?(field_name)
+            if !is_moderated || self.moderation_disabled || !self.send("#{field_name}_changed?")
+              self.send("store_#{field_name}_without_moderation!")
+            else
+              self.create_moderation_with_hooks!({
+                :attributes => {
+                  "#{field_name}_tmp_file" => self.send(field_name).file.file
+                }
+              })
+            end
+          end
+        
+          base.send :define_method, "write_#{field_name}_identifier_with_moderation" do
+            is_moderated = self.class.respond_to?(:moderated_attributes) &&
+              self.class.moderated_attributes.include?(field_name)
+            if !is_moderated || self.moderation_disabled || !self.send("#{field_name}_changed?")
+              self.send("write_#{field_name}_identifier_without_moderation")
+            end
+          end
+        
+          base.alias_method_chain :get_moderation_attributes, :carrierwave unless base.instance_methods.include?("get_moderation_attributes_without_carrierwave")
+          base.alias_method_chain "store_#{field_name}!", :moderation
+          base.alias_method_chain "write_#{field_name}_identifier", :moderation
+        end
+      end
+      
       # use class method because we only operate on hash parameters, not with a real record
       # here we can delete the photo from tmp
       def moderatable_discard(moderation)
-        value = moderation.interpreted_value
-        if moderation.attr_name == "-" && value && value.respond_to?("[]") &&
-          value[:main_model] && value[:main_model][:photo_tmp_file]
-          value = value[:main_model][:photo_tmp_file]
-        elsif moderation.attr_name != "photo_tmp_file"
-          return # we dont want to process anything else than the above
-        end
-          
-        unless value.blank?
-          HasModerated::CarrierWave::photo_tmp_delete(value)
+        value = moderation.parsed_data
+        
+        moderated_carrierwave_fields.each do |field_name|
+          if value.kind_of? Hash
+            if value.has_key?(:create) && value[:create].has_key?(:attributes)
+              value = value[:create]
+            end
+            if value.has_key?(:attributes) && value[:attributes].has_key?("#{field_name}_tmp_file")
+              value = value[:attributes].send("#{field_name}_tmp_file")
+              if value.present?
+                HasModerated::CarrierWave::photo_tmp_delete(value)
+              end
+            else
+              return # we dont want to process anything else than the above
+            end
+          end
         end
       end
     end
     
     module InstanceMethods
-      attr_accessor :moderation_disabled # in case this model itself is not moderated
-      # maybe autodetect fields that use carrierwave, or specify them
-      def moderatable_hashize
-        attrs = self.attributes
-        attrs = attrs.merge({
-          :photo_tmp_file => self.photo.file.file
-        }) if self.photo && self.photo.file
-      end
-    
-      def photo_tmp_file=(value)
-        self.photo = File.open(value)
-        HasModerated::CarrierWave::photo_tmp_delete(value)
-      end
-      
-      def store_photo_with_moderation!
-        is_moderated = self.class.respond_to?(:moderated_attributes) &&
-          self.class.moderated_attributes.include?("carrierwave_photo")
-        if self.moderation_disabled || !is_moderated || !self.photo_changed?
-          store_photo_without_moderation!
-        else
-          self.moderations.create!({
-            :attr_name => "photo_tmp_file",
-            :attr_value => self.photo.file.file
-          })
-        end
-      end
-
-      def write_photo_identifier_with_moderation
-        is_moderated = self.class.respond_to?(:moderated_attributes) &&
-          self.class.moderated_attributes.include?("carrierwave_photo")
-        if self.moderation_disabled || !is_moderated || !self.photo_changed?
-          write_photo_identifier_without_moderation
+      def get_moderation_attributes_with_carrierwave
+        attrs = get_moderation_attributes_without_carrierwave
+        self.class.moderated_carrierwave_fields.each do |field_name|
+          attrs = attrs.merge({
+            "#{field_name}_tmp_file" => self.send(field_name).file.file
+          }) if self.send(field_name) && self.send(field_name).file
         end
+        attrs
       end
     end
   end

data/lib/has_moderated/moderated_create.rb

@@ -26,7 +26,7 @@ module HasModerated
             rec.send(key.to_s+"=", val) unless key.to_s == 'id'
           end
           rec.without_moderation { rec.save(:validate => false) }
-          moderation.moderatable = rec
+          moderation.moderatable = rec # just so associations can be applied in next line
           HasModerated::Associations::Base::ApplyModeration::apply(moderation, value[:create])
         end
       end

data/lib/has_moderated/moderation_model.rb

@@ -1,10 +1,14 @@
 module HasModerated
   module ModerationModel
+    def parsed_data
+      @parsed_data ||= YAML::load(data)
+    end
+    
     def accept
-      loaded_val = YAML::load(data)
-      HasModerated::Associations::Base::ApplyModeration::apply(self, loaded_val)
-      HasModerated::ModeratedAttributes::ApplyModeration::apply(self, loaded_val)
+      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)
       self.destroy
     end

data/lib/has_moderated/version.rb

@@ -1,3 +1,3 @@
 module HasModerated
-  VERSION = "1.0.alpha2"
+  VERSION = "1.0.beta"
 end

data/lib/has_moderated.rb

@@ -7,13 +7,14 @@ require 'has_moderated/adapters/active_record'
 require 'has_moderated/associations/base'
 require 'has_moderated/associations/has_one'
 require 'has_moderated/associations/collection'
-require 'has_moderated/associations/has_many'
 
 
 require 'has_moderated/moderated_attributes'
 require 'has_moderated/moderated_create'
 require 'has_moderated/moderated_destroy'
 
+require 'has_moderated/carrier_wave'
+
 module HasModerated
   def self.included(base)
     HasModerated::Common::included(base)

data/test/dummy/Guardfile

@@ -5,7 +5,6 @@ guard 'spork', :cucumber_env => { 'RAILS_ENV' => 'test' }, :rspec_env => { 'RAIL
   watch(%r{^config/initializers/.+\.rb$})
   watch('Gemfile')
   watch('Gemfile.lock')
-  watch('../../lib/has_moderated/associations/base.rb')
   watch('spec/spec_helper.rb') { :rspec }
   watch('test/test_helper.rb') { :test_unit }
   watch(%r{features/support/}) { :cucumber }

data/test/dummy/app/models/photo.rb

@@ -0,0 +1,4 @@
+class Photo < ActiveRecord::Base
+  mount_uploader :avatar, GenericUploader
+  mount_uploader :picture, GenericUploader
+end

data/test/dummy/db/migrate/20120520215008_initial_schema.rb

@@ -0,0 +1,48 @@
+class InitialSchema < ActiveRecord::Migration
+  def change
+    create_table "moderations", :force => true do |t|
+      t.integer  "moderatable_id"
+      t.string   "moderatable_type"
+      t.text     "data",             :null => false
+      t.datetime "created_at",       :null => false
+      t.datetime "updated_at",       :null => false
+    end
+
+    create_table "subtasks", :force => true do |t|
+      t.integer  "task_id"
+      t.string   "title"
+      t.string   "desc"
+      t.datetime "created_at"
+      t.datetime "updated_at"
+      t.integer  "parentable_id"
+      t.string   "parentable_type"
+    end
+
+    create_table "task_connections", :force => true do |t|
+      t.string   "title"
+      t.integer  "m1_id"
+      t.integer  "m2_id"
+      t.datetime "created_at", :null => false
+      t.datetime "updated_at", :null => false
+    end
+
+    create_table "task_photos", :force => true do |t|
+      t.string   "photo"
+      t.integer  "task_id"
+      t.datetime "created_at"
+      t.datetime "updated_at"
+    end
+
+    create_table "tasks", :force => true do |t|
+      t.string   "title"
+      t.string   "desc"
+      t.datetime "created_at"
+      t.datetime "updated_at"
+    end
+
+    create_table "tasks_jointable", :id => false, :force => true do |t|
+      t.integer "m1_id"
+      t.integer "m2_id"
+    end
+  end
+end

data/test/dummy/db/migrate/20120520215224_create_photos.rb

@@ -0,0 +1,13 @@
+class CreatePhotos < ActiveRecord::Migration
+  def change
+    create_table :photos do |t|
+      t.string :avatar
+      t.string :picture
+      t.integer :parentable_id
+      t.string :parentable_type
+      t.string :title
+
+      t.timestamps
+    end
+  end
+end

data/test/dummy/db/schema.rb

@@ -10,7 +10,7 @@
 #
 # It's strongly recommended to check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 20120515175621) do
+ActiveRecord::Schema.define(:version => 20120520215224) do
 
   create_table "moderations", :force => true do |t|
     t.integer  "moderatable_id"
@@ -20,6 +20,16 @@ ActiveRecord::Schema.define(:version => 20120515175621) do
     t.datetime "updated_at",       :null => false
   end
 
+  create_table "photos", :force => true do |t|
+    t.string   "avatar"
+    t.string   "picture"
+    t.integer  "parentable_id"
+    t.string   "parentable_type"
+    t.string   "title"
+    t.datetime "created_at",      :null => false
+    t.datetime "updated_at",      :null => false
+  end
+
   create_table "subtasks", :force => true do |t|
     t.integer  "task_id"
     t.string   "title"

data/test/dummy/log/development.log

@@ -7472,3 +7472,59 @@ Migrating to CreateModerations2 (20120515155730)
 DEPRECATION WARNING: ActiveSupport::Memoizable is deprecated and will be removed in future releases,simply use Ruby memoization pattern instead. (called from /Users/apple/rails/has_moderated/test/dummy/config/environment.rb:5)
 DEPRECATION WARNING: ActiveSupport::Memoizable is deprecated and will be removed in future releases,simply use Ruby memoization pattern instead. (called from /Users/apple/rails/has_moderated/test/dummy/config/environment.rb:5)
 DEPRECATION WARNING: ActiveSupport::Memoizable is deprecated and will be removed in future releases,simply use Ruby memoization pattern instead. (called from /Users/apple/rails/has_moderated/test/dummy/config/environment.rb:5)
+DEPRECATION WARNING: ActiveSupport::Memoizable is deprecated and will be removed in future releases,simply use Ruby memoization pattern instead. (called from /Users/apple/rails/has_moderated/test/dummy/config/environment.rb:5)
+DEPRECATION WARNING: ActiveSupport::Memoizable is deprecated and will be removed in future releases,simply use Ruby memoization pattern instead. (called from /Users/apple/rails/has_moderated/test/dummy/config/environment.rb:5)
+DEPRECATION WARNING: ActiveSupport::Memoizable is deprecated and will be removed in future releases,simply use Ruby memoization pattern instead. (called from /Users/apple/rails/has_moderated/test/dummy/config/environment.rb:5)
+   (0.2ms)  select sqlite_version(*)
+   (1.8ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+   (0.1ms)  PRAGMA index_list("schema_migrations")
+   (1.9ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+Migrating to InitialSchema (20120520215008)
+   (0.0ms)  begin transaction
+   (0.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) 
+   (0.3ms)  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)) 
+   (0.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) 
+   (0.1ms)  CREATE TABLE "task_photos" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "photo" varchar(255), "task_id" integer, "created_at" datetime, "updated_at" datetime) 
+   (0.1ms)  CREATE TABLE "tasks" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "title" varchar(255), "desc" varchar(255), "created_at" datetime, "updated_at" datetime) 
+   (0.1ms)  CREATE TABLE "tasks_jointable" ("m1_id" integer, "m2_id" integer) 
+   (0.1ms)  INSERT INTO "schema_migrations" ("version") VALUES ('20120520215008')
+   (1.6ms)  commit transaction
+   (0.1ms)  select sqlite_version(*)
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.1ms)  PRAGMA index_list("moderations")
+   (0.0ms)  PRAGMA index_list("subtasks")
+   (0.0ms)  PRAGMA index_list("task_connections")
+   (0.0ms)  PRAGMA index_list("task_photos")
+   (0.0ms)  PRAGMA index_list("tasks")
+   (0.0ms)  PRAGMA index_list("tasks_jointable")
+DEPRECATION WARNING: ActiveSupport::Memoizable is deprecated and will be removed in future releases,simply use Ruby memoization pattern instead. (called from /Users/apple/rails/has_moderated/test/dummy/config/environment.rb:5)
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+Migrating to InitialSchema (20120520215008)
+   (0.1ms)  select sqlite_version(*)
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.0ms)  PRAGMA index_list("moderations")
+   (0.0ms)  PRAGMA index_list("subtasks")
+   (0.0ms)  PRAGMA index_list("task_connections")
+   (0.0ms)  PRAGMA index_list("task_photos")
+   (0.0ms)  PRAGMA index_list("tasks")
+   (0.0ms)  PRAGMA index_list("tasks_jointable")
+DEPRECATION WARNING: ActiveSupport::Memoizable is deprecated and will be removed in future releases,simply use Ruby memoization pattern instead. (called from /Users/apple/rails/has_moderated/test/dummy/config/environment.rb:5)
+DEPRECATION WARNING: ActiveSupport::Memoizable is deprecated and will be removed in future releases,simply use Ruby memoization pattern instead. (called from /Users/apple/rails/has_moderated/test/dummy/config/environment.rb:5)
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+Migrating to InitialSchema (20120520215008)
+Migrating to CreatePhotos (20120520215224)
+   (0.0ms)  select sqlite_version(*)
+   (0.0ms)  begin transaction
+   (0.5ms)  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) 
+   (0.1ms)  INSERT INTO "schema_migrations" ("version") VALUES ('20120520215224')
+   (2.8ms)  commit transaction
+   (0.1ms)  select sqlite_version(*)
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.0ms)  PRAGMA index_list("moderations")
+   (0.0ms)  PRAGMA index_list("photos")
+   (0.0ms)  PRAGMA index_list("subtasks")
+   (0.0ms)  PRAGMA index_list("task_connections")
+   (0.0ms)  PRAGMA index_list("task_photos")
+   (0.0ms)  PRAGMA index_list("tasks")
+   (0.0ms)  PRAGMA index_list("tasks_jointable")