digitalmoksha-acts_as_commentable 6.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 56dc4bcd0dd16afe10a81b998bf36267c8a8aedab7069d8e3d7e1d9d19b64f9d
+  data.tar.gz: 22fa27c7b332d124e602ca69a2703691ce32f8a91741c0ae014d4869631e2073
+SHA512:
+  metadata.gz: e093162809f535495672ba6495e35fcd321378245295028777687a4c104eadb19c4c3a4be428ad8f093bacb64a7ceae25a57960ee2bc24cbc34320984f13a393
+  data.tar.gz: c25216c0cb22b50f57680e951b2c9ac955e274b77832de05e8fa7738fe6d0d0e4a28497fd2a5bc52a2defb90d3cb3cf7c06997303f2e2996c246fc1bbeafd34c

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2006 Cosmin Radoi
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,101 @@
+= Acts As Commentable
+
+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 :
+
+Add the following line to your Gemfile
+
+=== Rails 4
+
+  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'
+
+ 
+== Generator
+
+
+=== Rails 3+
+
+  rails g comment
+
+=== 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:
+ 
+  class Post < ActiveRecord::Base
+    acts_as_commentable
+  end
+
+Add a comment to a model instance by adding the following to the controller:
+ 
+  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.find(1)
+  comments = commentable.comments.recent.limit(10).all
+
+You can also add different types of comments to a model:
+ 
+  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
+
+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, mrzor, Michael Bensoussan
+
+== More
+
+http://www.juixe.com/techknow/index.php/2006/06/18/acts-as-commentable-plugin/
+http://www.juixe.com/projects/acts_as_commentable

data/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'rails', 'init')

data/install.rb

@@ -0,0 +1,2 @@
+puts "To create the comment model please run:"
+puts "script/generate comment"

data/lib/acts_as_commentable.rb

@@ -0,0 +1,2 @@
+require 'commentable_methods'
+require 'comment_methods'

data/lib/comment_methods.rb

@@ -0,0 +1,41 @@
+module ActsAsCommentable
+  # including this module into your Comment model will give you finders and named scopes
+  # useful for working with Comments.
+  # The named scopes are:
+  #   in_order: Returns comments in the order they were created (created_at ASC).
+  #   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, -> { order('created_at ASC') }
+      comment_model.scope :recent, -> { 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, 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, 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
+      # given the commentable class name and id
+      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

data/lib/commentable_methods.rb

@@ -0,0 +1,131 @@
+require 'active_record'
+
+# ActsAsCommentable
+module Juixe
+  module Acts #:nodoc:
+    module Commentable #:nodoc:
+
+      def self.included(base)
+        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 define_role_based_inflection_5(role)
+          has_many "#{role.to_s}_comments".to_sym,
+                   -> { where(role: role.to_s) },
+                   has_many_options(role)
+        end
+
+        def define_role_based_inflection_6(role)
+          if RUBY_VERSION.first >= '3'
+            has_many "#{role.to_s}_comments".to_sym,
+                     -> { where(role: role.to_s) },
+                     **has_many_options(role)
+          else
+            has_many "#{role.to_s}_comments".to_sym,
+                     -> { where(role: role.to_s) },
+                     has_many_options(role)
+          end
+        end
+
+        def define_role_based_inflection_7(role)
+          if RUBY_VERSION.first >= '3'
+            has_many "#{role.to_s}_comments".to_sym,
+                     -> { where(role: role.to_s) },
+                     **has_many_options(role)
+          else
+            has_many "#{role.to_s}_comments".to_sym,
+                     -> { where(role: role.to_s) },
+                     has_many_options(role)
+          end
+        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)
+          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)
+              accepts_nested_attributes_for "#{role.to_s}_comments".to_sym, allow_destroy: true, reject_if: proc { |attributes| attributes['comment'].blank? }
+            end
+            if RUBY_VERSION.first >= '3'
+              has_many :all_comments, **{ :as => :commentable, :dependent => :destroy, class_name: 'Comment' }.merge(join_options)
+            else
+              has_many :all_comments, { :as => :commentable, :dependent => :destroy, class_name: 'Comment' }.merge(join_options)
+            end
+          else
+            if RUBY_VERSION.first >= '3'
+              has_many :comments, **{:as => :commentable, :dependent => :destroy}.merge(join_options)
+            else
+              has_many :comments, {:as => :commentable, :dependent => :destroy}.merge(join_options)
+            end
+            accepts_nested_attributes_for :comments, allow_destroy: true, reject_if: proc { |attributes| attributes['comment'].blank? }
+          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
+
+ActiveRecord::Base.send(:include, Juixe::Acts::Commentable)

data/lib/generators/comment/USAGE

@@ -0,0 +1,6 @@
+Description:
+    Copies comment.rb to app/models/.
+    Copies create_comment.rb to db/migrate
+
+Examples:
+    `rails generate comment`

data/lib/generators/comment/comment_generator.rb

@@ -0,0 +1,18 @@
+require 'rails/generators/migration'
+
+class CommentGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+
+  def self.source_root
+    @_acts_as_commentable_source_root ||= File.expand_path("../templates", __FILE__)
+  end
+
+  def self.next_migration_number(path)
+    Time.now.utc.strftime("%Y%m%d%H%M%S")
+  end
+
+  def create_model_file
+    template "comment.rb", "app/models/comment.rb"
+    migration_template "create_comments.rb", "db/migrate/create_comments.rb"
+  end
+end

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

@@ -0,0 +1,15 @@
+class Comment < ActiveRecord::Base
+
+  include ActsAsCommentable::Comment
+
+  belongs_to :commentable, :polymorphic => true
+
+  default_scope -> { order('created_at ASC') }
+
+  # NOTE: install the acts_as_votable plugin if you
+  # want user to vote on the quality of comments.
+  #acts_as_votable
+
+  # NOTE: Comments belong to a user
+  belongs_to :user
+end

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

@@ -0,0 +1,20 @@
+class CreateComments < ActiveRecord::Migration[6.0]
+  def self.up
+    create_table :comments do |t|
+      t.string :title, :limit => 50, :default => ""
+      t.text :comment
+      t.references :commentable, :polymorphic => true
+      t.references :user
+      t.string :role, :default => "comments"
+      t.timestamps
+    end
+
+    add_index :comments, :commentable_type
+    add_index :comments, :commentable_id
+    add_index :comments, :user_id
+  end
+
+  def self.down
+    drop_table :comments
+  end
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: digitalmoksha-acts_as_commentable
+version: !ruby/object:Gem::Version
+  version: 6.0.0
+platform: ruby
+authors:
+- Cosmin Radoi, Jack Dempsey, Xelipe, Chris Eppstein
+- Diego Charles
+autorequire: acts_as_commentable
+bindir: bin
+cert_chain: []
+date: 2023-09-23 00:00:00.000000000 Z
+dependencies: []
+description: Plugin/gem that provides comment functionality
+email: unknown@juixe.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+- MIT-LICENSE
+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
+homepage: https://github.com/digitalmoksha/acts_as_commentable
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+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: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 3
+summary: Plugin/gem that provides comment functionality
+test_files: []