acts_as_commentable 3.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,48 +1,90 @@
-Acts As Commentable
-=================
+= 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.
 
-== Resources
 
-Install
+== Installation :
 
-* To install as a gem (recommended):
-** gem install acts_as_commentable
-** add the following line to your environment.rb: config.gem 'acts_as_commentable'
-** If using bundler then just add "gem 'acts_as_commentable'" to your Gemfile and "bundle install"
+Add the following line to your Gemfile
 
+=== Rails 4
 
-* To install as a plugin
-** Rails 3: script/plugin install http://github.com/jackdempsey/acts_as_commentable.git
-** Rails 2: script/plugin install http://github.com/jackdempsey/acts_as_commentable.git -r 2.x
+  gem 'acts_as_commentable'
+
+=== Rails 3
+
+  gem 'acts_as_commentable', '3.0.1'
+
+=== Rails 2
+
+  gem 'acts_as_commentable', git: 'git@github.com:jackdempsey/acts_as_commentable.git', branch: '2.x'
 
  
-Generate your comment model:
+== Generator
+
 
-script/generate comment
+=== Rails 3+
 
-Then migrate your database:
+  rails g comment
 
-rake db:migrate
+=== Rails 2
+  
+  script/generate comment
+
+Then migrate your database to add the comments model:
+
+  rake db:migrate
 
 == Usage
+
+Make the desired ActiveRecord model act as commentable:
  
- * Make your ActiveRecord model act as commentable.
- 
- class Post < ActiveRecord::Base
- 	acts_as_commentable
- end
+  class Post < ActiveRecord::Base
+    acts_as_commentable
+  end
+
+Add a comment to a model instance by adding the following to the controller:
  
- * Add a comment to a model instance
+  commentable = Post.create
+  comment = commentable.comments.create
+  comment.title = "First comment."
+  comment.comment = "This is the first comment."
+  comment.save
+
+
+Fetch comments for the commentable model by adding the following to the view:
  
- commentable = Post.create
- commentable.comments.create(:title => "First comment.", :comment => "This is the first comment.")
+  commentable = Post.find(1)
+  comments = commentable.comments.recent.limit(10).all
 
- * Fetch comments for a commentable model:
+You can also add different types of comments to a model:
  
- commentable = Post.find(1)
- comments = commentable.comments.recent.limit(10).all
+  class Todo < ActiveRecord::Base
+    acts_as_commentable :public, :private
+  end
+
+*Note:* This feature is only available from version 4.0 and above
+
+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
@@ -51,7 +93,7 @@ Xelipe - This plugin is heavily influenced by Acts As Taggable.
 
 == Contributors
 
-Jack Dempsey, Chris Eppstein, Jim Ray, Matthew Van Horn, Ole Riesenberg, ZhangJinzhu, maddox, monocle
+Jack Dempsey, Chris Eppstein, Jim Ray, Matthew Van Horn, Ole Riesenberg, ZhangJinzhu, maddox, monocle, mrzor, Michael Bensoussan
 
 == More
 

data/lib/comment_methods.rb

@@ -6,24 +6,28 @@ module ActsAsCommentable
   #   recent: Returns comments by how recently they were created (created_at DESC).
   #   limit(N): Return no more than N comments.
   module Comment
-    
+
     def self.included(comment_model)
       comment_model.extend Finders
-      comment_model.scope :in_order, comment_model.order('created_at ASC')
-      comment_model.scope :recent,   comment_model.order('created_at DESC')
+      comment_model.scope :in_order, -> { comment_model.order('created_at ASC') }
+      comment_model.scope :recent, -> { comment_model.reorder('created_at DESC') }
+    end
+
+    def is_comment_type?(type)
+      type.to_s == role.singularize.to_s
     end
-    
+
     module Finders
       # Helper class method to lookup all comments assigned
       # to all commentable types for a given user.
-      def find_comments_by_user(user)
-        where(["user_id = ?", user.id]).order("created_at DESC")
+      def find_comments_by_user(user, role = "comments")
+        where(["user_id = ? and role = ?", user.id, role]).order("created_at DESC")
       end
 
       # Helper class method to look up all comments for 
       # commentable class name and commentable id.
-      def find_comments_for_commentable(commentable_str, commentable_id)
-        where(["commentable_type = ? and commentable_id = ?", commentable_str, commentable_id]).order("created_at DESC")
+      def find_comments_for_commentable(commentable_str, commentable_id, role = "comments")
+        where(["commentable_type = ? and commentable_id = ? and role = ?", commentable_str, commentable_id, role]).order("created_at DESC")
       end
 
       # Helper class method to look up a commentable object
@@ -31,7 +35,7 @@ module ActsAsCommentable
       def find_commentable(commentable_str, commentable_id)
         model = commentable_str.constantize
         model.respond_to?(:find_comments_for) ? model.find(commentable_id) : nil
-			end
+      end
     end
   end
 end

data/lib/commentable_methods.rb

@@ -6,48 +6,83 @@ module Juixe
     module Commentable #:nodoc:
 
       def self.included(base)
-        base.extend ClassMethods  
+        base.extend ClassMethods
       end
 
-      module ClassMethods
-        def acts_as_commentable(options={})
-          has_many :comments, {:as => :commentable, :dependent => :destroy}.merge(options)
-          include Juixe::Acts::Commentable::InstanceMethods
-          extend Juixe::Acts::Commentable::SingletonMethods
+      module HelperMethods
+        private
+        def define_role_based_inflection(role)
+          send("define_role_based_inflection_#{Rails.version.first}", role)
         end
-      end
-      
-      # This module contains class methods
-      module SingletonMethods
-        # Helper method to lookup for comments for a given object.
-        # This method is equivalent to obj.comments.
-        def find_comments_for(obj)
-          commentable = self.base_class.name
-          Comment.find_comments_for_commentable(commentable, obj.id)
+
+        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
-        
-        # Helper class method to lookup comments for
-        # the mixin commentable type written by a given user.  
-        # This method is NOT equivalent to Comment.find_comments_for_user
-        def find_comments_by_user(user) 
-          commentable = self.base_class.name
-          Comment.where(["user_id = ? and commentable_type = ?", user.id, commentable]).order("created_at DESC")
+
+        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
-      end
-      
-      # This module contains instance methods
-      module InstanceMethods
-        # Helper method to sort comments by date
-        def comments_ordered_by_submitted
-          Comment.find_comments_for_commentable(self.class.name, id)
+
+        def has_many_options(role)
+          {:class_name => "Comment",
+                  :as => :commentable,
+                  :dependent => :destroy,
+                  :before_add => Proc.new { |x, c| c.role = role.to_s }
+          }
         end
-        
-        # Helper method that defaults the submitted time.
-        def add_comment(comment)
-          comments << comment
+      end
+
+      module ClassMethods
+        include HelperMethods
+
+        def acts_as_commentable(*args)
+          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)
+
+          if !comment_roles.blank?
+            comment_roles.each do |role|
+              define_role_based_inflection(role)
+            end
+            has_many :all_comments, { :as => :commentable, :dependent => :destroy, class_name: 'Comment' }.merge(join_options)
+          else
+            has_many :comments, {:as => :commentable, :dependent => :destroy}.merge(join_options)
+          end
+
+          comment_types.each do |role|
+            method_name = (role == :comments ? "comments" : "#{role.to_s}_comments").to_s
+            class_eval %{
+              def self.find_#{method_name}_for(obj)
+                commentable = self.base_class.name
+                Comment.find_comments_for_commentable(commentable, obj.id, "#{role.to_s}")
+              end
+
+              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
+
+              def #{method_name}_ordered_by_submitted
+                Comment.find_comments_for_commentable(self.class.name, id, "#{role.to_s}").order("created_at")
+              end
+
+              def add_#{method_name.singularize}(comment)
+                comment.role = "#{role.to_s}"
+                #{method_name} << comment
+              end
+            }
+          end
         end
       end
-      
     end
   end
 end

data/lib/generators/comment/templates/comment.rb

@@ -4,7 +4,7 @@ class Comment < ActiveRecord::Base
 
   belongs_to :commentable, :polymorphic => true
 
-  default_scope :order => 'created_at ASC'
+  default_scope -> { order('created_at ASC') }
 
   # NOTE: install the acts_as_votable plugin if you
   # want user to vote on the quality of comments.

data/lib/generators/comment/templates/create_comments.rb

@@ -5,6 +5,7 @@ class CreateComments < ActiveRecord::Migration
       t.text :comment
       t.references :commentable, :polymorphic => true
       t.references :user
+      t.string :role, :default => "comments"
       t.timestamps
     end
 

metadata

@@ -1,76 +1,55 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: acts_as_commentable
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 3
-  - 0
-  - 1
-  version: 3.0.1
+version: !ruby/object:Gem::Version
+  version: 4.0.2
 platform: ruby
-authors: 
+authors:
 - Cosmin Radoi, Jack Dempsey, Xelipe, Chris Eppstein
 autorequire: acts_as_commentable
 bindir: bin
 cert_chain: []
-
-date: 2010-10-28 00:00:00 -04:00
-default_executable: 
+date: 2014-10-02 00:00:00.000000000 Z
 dependencies: []
-
 description: Plugin/gem that provides comment functionality
 email: unknown@juixe.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.rdoc
 - MIT-LICENSE
-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
-- tasks/acts_as_commentable_tasks.rake
-- init.rb
-- install.rb
-has_rdoc: true
 homepage: http://www.juixe.com/techknow/index.php/2006/06/18/acts-as-commentable-plugin/
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 3
 summary: Plugin/gem that provides comment functionality
 test_files: []
-

data/tasks/acts_as_commentable_tasks.rake

@@ -1,4 +0,0 @@
-# desc "Explaining what the task does"
-# task :acts_as_commentable do
-#   # Task goes here
-# end