acts_as_commentable 4.0.1 → 4.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZDQyZmE5ZjZmMmNhMDE1MTk2YzcwOTA1ZGE2N2ViMjZlNTE4NzQ3NQ==
+  data.tar.gz: !binary |-
+    MDRjMzI1NTNkMjVkMDgxZTk5MzM5ZTNiMzU0ODlkZmM3MmFjOTRkYQ==
+SHA512:
+  metadata.gz: !binary |-
+    ZjI5OWEyZmJkNjJjMTRhNmEzZGY2ODMwNTdjOGFmNjNiNGYxNjI3Y2EwODhj
+    YTVmZDkzOTRlMjcxMDU2NjVlMTQzZjdkYTE4MWQ0NTYxNGMyZDM2ZjM0MzQ3
+    MDdmY2Y4ZjBiZDZlY2UzNjlhM2VlMjdkNjNlNTZlYzg2NzY3YjM=
+  data.tar.gz: !binary |-
+    YWI1MzQ5NTQyZmYzZGNlMjFmOGM1ODIwMjA2ZGExYTI1NmI4NDNmOTU3MjQ0
+    NjE3Yzc3MDY3NDE3ZjI4ZTAyNjdlYWIyM2ZhYmFhMmYwNjdhM2E5N2Q1YjMw
+    OTBlZDA1NWE5ZjIzOGQwZmU5MGRmM2Q1ZDMzMzk1MmI2M2I1NzA=

data/README.rdoc

@@ -1,6 +1,9 @@
 = Acts As Commentable
 
-Allows for comments to be added to multiple and different models.
+Provides a single Comment model that can be attached to any model(s) within your app. It creates
+a Comment model and handles the plumbing between that model and any models that you declare to be
+commentable models.
+
 
 == Installation :
 
@@ -16,7 +19,7 @@ Add the following line to your Gemfile
 
 === Rails 2
 
-  gem 'acts_as_commentable', git: 'git@github.com:jackdempsey/acts_as_commentable.git'  , branch: '2.x'
+  gem 'acts_as_commentable', git: 'git@github.com:jackdempsey/acts_as_commentable.git', branch: '2.x'
 
  
 == Generator
@@ -30,29 +33,33 @@ Add the following line to your Gemfile
   
   script/generate comment
 
-Then migrate your database:
+Then migrate your database to add the comments model:
 
   rake db:migrate
 
 == Usage
- 
-Make your ActiveRecord model act as commentable:
+
+Make the desired ActiveRecord model act as commentable:
  
   class Post < ActiveRecord::Base
     acts_as_commentable
   end
- 
-Add a comment to a model instance:
+
+Add a comment to a model instance by adding the following to the controller:
  
   commentable = Post.create
-  commentable.comments.create(:title => "First comment.", :comment => "This is the first comment.")
+  comment = commentable.comments.create
+  comment.title = "First comment."
+  comment.comment = "This is the first comment."
+  comment.save
+
 
-Fetch comments for a commentable model:
+Fetch comments for the commentable model by adding the following to the view:
  
   commentable = Post.find(1)
   comments = commentable.comments.recent.limit(10).all
 
-Add multiple type of comments to a model:
+You can also add different types of comments to a model:
  
   class Todo < ActiveRecord::Base
     acts_as_commentable :public, :private
@@ -60,11 +67,26 @@ Add multiple type of comments to a model:
 
 *Note:* This feature is only available from version 4.0 and above
 
-Fetch comments for a this model:
+To fetch the different types of comments for this model:
 
   public_comments = Todo.find(1).public_comments
   private_comments = Todo.find(1).private_comments
 
+
+By default, `acts_as_commentable` will assume you are using a `Comment` model.
+To change this, or change any other join options, pass in an options hash:
+
+    class Todo < ActiveRecord::Base
+      acts_as_commentable { class_name: 'MyComment' }
+    end
+
+This also works in conjunction with comment types:
+
+    class Todo < ActiveRecord::Base
+      acts_as_commentable :public, :private, { class_name: 'MyComment' }
+    end
+
+
 == Credits
 
 Xelipe - This plugin is heavily influenced by Acts As Taggable.

data/lib/commentable_methods.rb

@@ -6,30 +6,56 @@ module Juixe
     module Commentable #:nodoc:
 
       def self.included(base)
-        base.extend ClassMethods  
+        base.extend ClassMethods
+      end
+
+      module HelperMethods
+        private
+        def define_role_based_inflection(role)
+          send("define_role_based_inflection_#{Rails.version.first}", role)
+        end
+
+        def define_role_based_inflection_3(role)
+          has_many "#{role.to_s}_comments".to_sym,
+                   has_many_options(role).merge(:conditions => { role: role.to_s })
+        end
+
+        def define_role_based_inflection_4(role)
+          has_many "#{role.to_s}_comments".to_sym,
+                   -> { where(role: role.to_s) },
+                   has_many_options(role)
+        end
+
+        def has_many_options(role)
+          {:class_name => "Comment",
+                  :as => :commentable,
+                  :dependent => :destroy,
+                  :before_add => Proc.new { |x, c| c.role = role.to_s }
+          }
+        end
       end
 
       module ClassMethods
+        include HelperMethods
+
         def acts_as_commentable(*args)
-          comment_roles = args.to_a.flatten.compact.map(&:to_sym)
+          options = args.to_a.flatten.compact.partition{ |opt| opt.kind_of? Hash }
+          comment_roles = options.last.blank? ? nil : options.last.flatten.compact.map(&:to_sym)
+
+          join_options = options.first.blank? ? [{}] : options.first
+          throw 'Only one set of options can be supplied for the join' if join_options.length > 1
+          join_options = join_options.first
 
           class_attribute :comment_types
           self.comment_types = (comment_roles.blank? ? [:comments] : comment_roles)
 
-          options = ((args.blank? or args[0].blank?) ? {} : args[0])
-
           if !comment_roles.blank?
             comment_roles.each do |role|
-              has_many "#{role.to_s}_comments".to_sym,
-                -> { where(role: role.to_s) },
-                {:class_name => "Comment",
-                  :as => :commentable,
-                  :dependent => :destroy,
-                  :before_add => Proc.new { |x, c| c.role = role.to_s }}
+              define_role_based_inflection(role)
             end
-            has_many :all_comments, {:as => :commentable, :dependent => :destroy, class_name: "Comment"}
+            has_many :all_comments, { :as => :commentable, :dependent => :destroy, class_name: 'Comment' }.merge(join_options)
           else
-            has_many :comments, {:as => :commentable, :dependent => :destroy}
+            has_many :comments, {:as => :commentable, :dependent => :destroy}.merge(join_options)
           end
 
           comment_types.each do |role|
@@ -40,7 +66,7 @@ module Juixe
                 Comment.find_comments_for_commentable(commentable, obj.id, "#{role.to_s}")
               end
 
-              def self.find_#{method_name}_by_user(user) 
+              def self.find_#{method_name}_by_user(user)
                 commentable = self.base_class.name
                 Comment.where(["user_id = ? and commentable_type = ? and role = ?", user.id, commentable, "#{role.to_s}"]).order("created_at DESC")
               end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_commentable
 version: !ruby/object:Gem::Version
-  version: 4.0.1
-  prerelease: 
+  version: 4.0.2
 platform: ruby
 authors:
 - Cosmin Radoi, Jack Dempsey, Xelipe, Chris Eppstein
 autorequire: acts_as_commentable
 bindir: bin
 cert_chain: []
-date: 2010-03-13 00:00:00.000000000 Z
+date: 2014-10-02 00:00:00.000000000 Z
 dependencies: []
 description: Plugin/gem that provides comment functionality
 email: unknown@juixe.com
@@ -21,36 +20,35 @@ extra_rdoc_files:
 files:
 - MIT-LICENSE
 - README.rdoc
+- init.rb
+- install.rb
 - lib/acts_as_commentable.rb
 - lib/comment_methods.rb
 - lib/commentable_methods.rb
+- lib/generators/comment/USAGE
 - lib/generators/comment/comment_generator.rb
 - lib/generators/comment/templates/comment.rb
 - lib/generators/comment/templates/create_comments.rb
-- lib/generators/comment/USEGA
-- init.rb
-- install.rb
 homepage: http://www.juixe.com/techknow/index.php/2006/06/18/acts-as-commentable-plugin/
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 3
 summary: Plugin/gem that provides comment functionality