generators/acts_as_commentable_upgrade_migration/USAGE generators/acts_as_commentable_upgrade_migration/acts_as_commentable_upgrade_migration_generator.rb generators/acts_as_commentable_upgrade_migration/templates/migration.rb generators/acts_as_commentable_with_threading_migration/USAGE generators/acts_as_commentable_with_threading_migration/acts_as_commentable_with_threading_migration_generator.rb generators/acts_as_commentable_with_threading_migration/templates/migration.rb @@ -3,63 +3,58 @@ Acts As Commentable (now with comment threads (TM)!!! -- kidding on the (TM)) Allows for threaded comments to be added to multiple and different models. Drop-in compatible for acts_as_commentable (however requiring a database schema change) -== Resources +== Installation -Install +This plugin depends on CollectiveIdea's Awesome Nested Set plugin. - Rails +You can find the plugin on GitHub: http://github.com/collectiveidea/awesome_nested_set/tree/master - * To install as a plugin: - - script/plugin install http://github.com/jackdempsey/acts_as_commentable +script/plugin install git://github.com/collectiveidea/awesome_nested_set.git - Merb/Rails - - * To install as a gem: - - rake install - - * Create a new rails migration and add the following self.up and self.down methods - - def self.up - create_table "comments", :force => true do |t| - t.integer "commentable_id", :default => 0 - t.string "commentable_type", :limit => 15, :default => "" - t.string "title", :default => "" - t.text "body", :default => "" - t.string "subject", :default => "" - t.integer "user_id", :default => 0, :null => false - t.integer "parent_id" - t.integer "lft" - t.integer "rgt" - t.timestamps - end - - add_index "comments", "user_id" - add_index "comments", "commentable_id" - end - - def self.down - drop_table :comments - end + +Rails + * To install as a plugin: + + script/plugin install http://github.com/jackdempsey/acts_as_commentable + +Merb/Rails + * To install as a gem: + + rake install + + +Rails + * To install from scratch: + + script/generate acts_as_commentable_with_threading_migration + + This will generate the migration script necessary for the table + + * To upgrade to acts_as_commentable_with_threading from the old acts_as_commentable: + + script/generate acts_as_commentable_upgrade_migration + + This will generate the necessary migration to upgrade your comments table to work with acts_as_commentable_with_threading + == Usage - class Model < ActiveRecord::Base - acts_as_commentable - end + +class Model < ActiveRecord::Base + acts_as_commentable +end - * Add a comment to a model instance +* Add a comment to a model instance - model = Model.new - comment = Comment.new(:model => model, :body => "Your comment text here") - comment.save! - comment.move_to_child_of(the_desired_parent_comment) - - # Following doesn't work/make sense to me. Leaving for historical sake -- Jack - # * Each comment reference commentable object - # - # model = Model.find(1) - # model.comment_threads.first.commentable == model +model = Model.new +comment = Comment.new(:model => model, :body => "Your comment text here") +comment.save! +comment.move_to_child_of(the_desired_parent_comment) + +# Following doesn't work/make sense to me. Leaving for historical sake -- Jack +# * Each comment reference commentable object +# +# model = Model.find(1) +# model.comment_threads.first.commentable == model == Credits README f792e84589d480f12b5fd6a64bfbd6504c328510 Tom tom.cocca@gmail.com http://github.com/elight/acts_as_commentable_with_threading/commit/fd71fa4c85cdc7a4a29f633f4a34ac2c009cfedc fd71fa4c85cdc7a4a29f633f4a34ac2c009cfedc 2008-12-28T13:45:49-08:00 2008-12-28T13:45:49-08:00 Added generators to create migrations for a plain install and an upgrade from acts_as_commentable. Updated the README accordingly. 55fc31b6d69f326b6783fac9a71c6496d262b509 Tom tom.cocca@gmail.com