has_moderated 0.0.26 → 0.0.27

data/README.rdoc

@@ -26,6 +26,17 @@ When upgrading, rerun the generator
   rails generate has_moderated:install
 
 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.
+
+== 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.
+
+In contrast, with this gem the database will always represent the last accepted/confirmed version of the model, and not necessarily the newest as with Paperclip. A "changes" table like in Paperclip is used here too, but it is used to store "suggested" (to-be-accepted) changes. Therefore you have no performance hit when querying for the last accepted version of the model, like you would have with Paperclip. You only have a performance hit when accepting a moderation, but this is irrelevant. Also this way all changes submitted are relative to the currently last accepted version and not to the newest version like in Paperclip.
+
+So Paperclip and vestal_versions are designed for model versioning and changes tracking, while this gem is designed for moderation. The database will not be changed until a moderation is actually accepted.
+
+Note that because of this, handling associations is quite a bit harder, so this gem is a little bit more complex. Therefore is recommended you test moderated associations before deploying to production, to avoid any possible bugs.
+
 == Usage
 To moderate one or more attributes, add
 
@@ -98,7 +109,7 @@ For example you have a Comment model, and it is moderated. But your visitors are
 
 * first create a migration to add user_id into Moderation
 
-  rails g migration AddUserIdToModerations user_id:integer
+    rails g migration AddUserIdToModerations user_id:integer
   
 * run rake db:migrate
 * in models/comment.rb, add something like this:
@@ -139,48 +150,23 @@ You can run the tests by running
 
   rake spec
 
-in the root directory.
+in the root directory of this gem (so you have to clone it first).
 
 == TODO
 
-DONT save association when calling .build... only when calling save!
-
 This is just for my personal todo list...
 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.
 
-For automagic associations, look at https://github.com/rails/rails/blob/master/activerecord/lib/active_record/associations/collection_association.rb method concat, concat_records, add_to_target
-u get the instance of this class from with .association("name")
-assoc = t.association(:subtasks)
-def assoc.concat *args ; whatever ; end
-or if we need block (capture outer scope)
-metaclass = class << assoc; self; end
-metaclass.send(:define_method, :concat) do
-   puts "concat 2"
-end
-
-in model use 
-after_initialize do...end
-to overwrite these methods
-ruby-1.8.7-p334 :013 > def assoc.concat_with_mo *args
-ruby-1.8.7-p334 :014?>   puts "in concat mo"
-ruby-1.8.7-p334 :015?>   concat_without_mo *args
-ruby-1.8.7-p334 :016?>   end
- => nil 
-ruby-1.8.7-p334 :017 > assoc.class_eval do
-ruby-1.8.7-p334 :018 >     alias_method_chain :concat, :mo
-ruby-1.8.7-p334 :019?>   end
-use add_to_target!!! lowest lvl
-add something like has_moderated_association
-don't do anything on create (parent.new_record?) since we already handle that
-test also for one-to-one and join table and has_many through assoc
-
-fix tests for offline working
 == Problems
 
+If you have problems open an issue here on Github.
+
 You may encounter problems with models that have some sort of non-serializable attributes. This might be something like file attachments, you'll have to try it to see.
 If you have a problem like that you can extract the problematic attributes into a seperate has_one association. If you moderate create, save that model without the foreign key first, and then use has_moderated_create :with_associations => [:association_name] and add the association (to the existing associated model) before saving the moderated model. If you have questions about this or don't understand what I mean, open an issue here at GitHub and I will explain it further.
 
+It is also possible you will encounter problems with some heavily customized associations, or with has_many :through associations (although I have tested this for a simple, ordinary case and it works). If that happens open an issue here on Github.
+
 == License
 
 This project rocks and uses MIT-LICENSE.

data/lib/has_moderated/moderated_attributes.rb

@@ -15,7 +15,7 @@ module HasModerated
         self.moderated_options ||= {}
 
         args.each do |arg|
-          if arg.respond_to?("[]")
+          if arg.class == Hash || arg.class == HashWithIndifferentAccess
             self.moderated_options = self.moderated_options.merge(arg)
           else
             self.moderated_attributes.push(arg.to_s)

data/lib/has_moderated/version.rb

@@ -1,3 +1,3 @@
 module HasModerated
-  VERSION = "0.0.26"
+  VERSION = "0.0.27"
 end

data/test/dummy/log/development.log

@@ -6454,3 +6454,85 @@ Migrating to CreateHabtmNameTests (20111018180207)
    (1.7ms)  INSERT INTO "schema_migrations" (version) VALUES ('20111009205545')
    (1.8ms)  INSERT INTO "schema_migrations" (version) VALUES ('20111018172409')
    (2.1ms)  INSERT INTO "schema_migrations" (version) VALUES ('20111018174319')
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.1ms)  select sqlite_version(*)
+   (1.8ms)  CREATE TABLE "habtm_name_tests" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "title" varchar(255), "created_at" datetime, "updated_at" datetime) 
+   (1.5ms)  CREATE TABLE "habtm_name_tests_tasks" ("task_id" integer, "habtm_name_test_id" integer) 
+   (1.7ms)  CREATE TABLE "hjoin_tests" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "title" varchar(255), "created_at" datetime, "updated_at" datetime) 
+   (1.2ms)  CREATE TABLE "hjoin_tests_tasks" ("task_id" integer, "hjoin_test_id" integer) 
+   (1.5ms)  CREATE TABLE "hmany_fk_tests" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "something_id" integer, "title" varchar(255), "created_at" datetime, "updated_at" datetime) 
+   (1.7ms)  CREATE TABLE "hmanythrough_joins" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "hmanythrough_test_id" integer, "task_id" integer, "exdata" varchar(255), "created_at" datetime, "updated_at" datetime) 
+   (2.0ms)  CREATE TABLE "hmanythrough_tests" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "title" varchar(255), "created_at" datetime, "updated_at" datetime) 
+   (1.6ms)  CREATE TABLE "hone_as_tests" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "testable_id" integer, "testable_type" varchar(255), "title" varchar(255), "created_at" datetime, "updated_at" datetime) 
+   (2.4ms)  CREATE TABLE "hone_tests" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "task_id" integer, "created_at" datetime, "updated_at" datetime, "title" varchar(255)) 
+   (1.4ms)  CREATE TABLE "hook_tests" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "title" varchar(255), "foo" varchar(255), "created_at" datetime, "updated_at" datetime) 
+   (1.8ms)  CREATE TABLE "moderations" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "moderatable_id" integer, "moderatable_type" varchar(255) NOT NULL, "attr_name" varchar(60) NOT NULL, "attr_value" text NOT NULL, "created_at" datetime, "updated_at" datetime) 
+   (1.8ms)  CREATE TABLE "photo_holders" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "title" varchar(255), "created_at" datetime, "updated_at" datetime) 
+   (2.2ms)  CREATE TABLE "photos" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "photo" varchar(255), "created_at" datetime, "updated_at" datetime, "photo_holder_id" integer) 
+   (1.7ms)  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, "task_all_id" integer) 
+   (1.8ms)  CREATE TABLE "task_alls" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "title" varchar(255), "value" varchar(255), "created_at" datetime, "updated_at" datetime) 
+   (2.0ms)  CREATE TABLE "task_photos" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "photo" varchar(255), "task_id" integer, "created_at" datetime, "updated_at" datetime) 
+   (1.7ms)  CREATE TABLE "tasks" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "title" varchar(255), "desc" varchar(255), "created_at" datetime, "updated_at" datetime) 
+   (1.6ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+   (0.0ms)  PRAGMA index_list("schema_migrations")
+   (2.0ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+   (0.2ms)  SELECT version FROM "schema_migrations"
+   (1.7ms)  INSERT INTO "schema_migrations" (version) VALUES ('20111018180207')
+   (2.0ms)  INSERT INTO "schema_migrations" (version) VALUES ('20110901013205')
+   (1.9ms)  INSERT INTO "schema_migrations" (version) VALUES ('20110901013228')
+   (1.6ms)  INSERT INTO "schema_migrations" (version) VALUES ('20110901013618')
+   (1.9ms)  INSERT INTO "schema_migrations" (version) VALUES ('20110908025410')
+   (1.7ms)  INSERT INTO "schema_migrations" (version) VALUES ('20110908025606')
+   (2.5ms)  INSERT INTO "schema_migrations" (version) VALUES ('20111003205633')
+   (1.4ms)  INSERT INTO "schema_migrations" (version) VALUES ('20111003234101')
+   (1.7ms)  INSERT INTO "schema_migrations" (version) VALUES ('20111004153147')
+   (1.4ms)  INSERT INTO "schema_migrations" (version) VALUES ('20111004164509')
+   (1.4ms)  INSERT INTO "schema_migrations" (version) VALUES ('20111008195728')
+   (1.6ms)  INSERT INTO "schema_migrations" (version) VALUES ('20111008195809')
+   (2.7ms)  INSERT INTO "schema_migrations" (version) VALUES ('20111009193145')
+   (1.3ms)  INSERT INTO "schema_migrations" (version) VALUES ('20111009201729')
+   (1.5ms)  INSERT INTO "schema_migrations" (version) VALUES ('20111009205517')
+   (1.6ms)  INSERT INTO "schema_migrations" (version) VALUES ('20111009205545')
+   (1.6ms)  INSERT INTO "schema_migrations" (version) VALUES ('20111018172409')
+   (1.6ms)  INSERT INTO "schema_migrations" (version) VALUES ('20111018174319')
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.1ms)  select sqlite_version(*)
+   (2.7ms)  CREATE TABLE "habtm_name_tests" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "title" varchar(255), "created_at" datetime, "updated_at" datetime) 
+   (1.4ms)  CREATE TABLE "habtm_name_tests_tasks" ("task_id" integer, "habtm_name_test_id" integer) 
+   (1.7ms)  CREATE TABLE "hjoin_tests" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "title" varchar(255), "created_at" datetime, "updated_at" datetime) 
+   (1.4ms)  CREATE TABLE "hjoin_tests_tasks" ("task_id" integer, "hjoin_test_id" integer) 
+   (238.6ms)  CREATE TABLE "hmany_fk_tests" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "something_id" integer, "title" varchar(255), "created_at" datetime, "updated_at" datetime) 
+   (1.6ms)  CREATE TABLE "hmanythrough_joins" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "hmanythrough_test_id" integer, "task_id" integer, "exdata" varchar(255), "created_at" datetime, "updated_at" datetime) 
+   (1.7ms)  CREATE TABLE "hmanythrough_tests" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "title" varchar(255), "created_at" datetime, "updated_at" datetime) 
+   (2.0ms)  CREATE TABLE "hone_as_tests" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "testable_id" integer, "testable_type" varchar(255), "title" varchar(255), "created_at" datetime, "updated_at" datetime) 
+   (1.7ms)  CREATE TABLE "hone_tests" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "task_id" integer, "created_at" datetime, "updated_at" datetime, "title" varchar(255)) 
+   (228.6ms)  CREATE TABLE "hook_tests" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "title" varchar(255), "foo" varchar(255), "created_at" datetime, "updated_at" datetime) 
+   (2.0ms)  CREATE TABLE "moderations" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "moderatable_id" integer, "moderatable_type" varchar(255) NOT NULL, "attr_name" varchar(60) NOT NULL, "attr_value" text NOT NULL, "created_at" datetime, "updated_at" datetime) 
+   (1.9ms)  CREATE TABLE "photo_holders" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "title" varchar(255), "created_at" datetime, "updated_at" datetime) 
+   (2.1ms)  CREATE TABLE "photos" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "photo" varchar(255), "created_at" datetime, "updated_at" datetime, "photo_holder_id" integer) 
+   (231.8ms)  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, "task_all_id" integer) 
+   (2.0ms)  CREATE TABLE "task_alls" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "title" varchar(255), "value" varchar(255), "created_at" datetime, "updated_at" datetime) 
+   (1.9ms)  CREATE TABLE "task_photos" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "photo" varchar(255), "task_id" integer, "created_at" datetime, "updated_at" datetime) 
+   (1.6ms)  CREATE TABLE "tasks" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "title" varchar(255), "desc" varchar(255), "created_at" datetime, "updated_at" datetime) 
+   (232.9ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+   (0.2ms)  PRAGMA index_list("schema_migrations")
+   (2.1ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+   (0.1ms)  SELECT version FROM "schema_migrations"
+   (1.5ms)  INSERT INTO "schema_migrations" (version) VALUES ('20111018180207')
+   (1.7ms)  INSERT INTO "schema_migrations" (version) VALUES ('20110901013205')
+   (1.9ms)  INSERT INTO "schema_migrations" (version) VALUES ('20110901013228')
+   (233.6ms)  INSERT INTO "schema_migrations" (version) VALUES ('20110901013618')
+   (1.7ms)  INSERT INTO "schema_migrations" (version) VALUES ('20110908025410')
+   (1.6ms)  INSERT INTO "schema_migrations" (version) VALUES ('20110908025606')
+   (1.5ms)  INSERT INTO "schema_migrations" (version) VALUES ('20111003205633')
+   (1.6ms)  INSERT INTO "schema_migrations" (version) VALUES ('20111003234101')
+   (245.8ms)  INSERT INTO "schema_migrations" (version) VALUES ('20111004153147')
+   (2.0ms)  INSERT INTO "schema_migrations" (version) VALUES ('20111004164509')
+   (1.5ms)  INSERT INTO "schema_migrations" (version) VALUES ('20111008195728')
+   (1.5ms)  INSERT INTO "schema_migrations" (version) VALUES ('20111008195809')
+   (1.5ms)  INSERT INTO "schema_migrations" (version) VALUES ('20111009193145')
+   (1.6ms)  INSERT INTO "schema_migrations" (version) VALUES ('20111009201729')
+   (1.4ms)  INSERT INTO "schema_migrations" (version) VALUES ('20111009205517')
+   (1.3ms)  INSERT INTO "schema_migrations" (version) VALUES ('20111009205545')
+   (1.5ms)  INSERT INTO "schema_migrations" (version) VALUES ('20111018172409')
+   (1.4ms)  INSERT INTO "schema_migrations" (version) VALUES ('20111018174319')