acts_as_commentable_with_reply 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5a32bb048282677d32467d9497594ab8460c8932
+  data.tar.gz: ba0b1f24d4c6038938dc0537bb5b2c39aa148a86
+SHA512:
+  metadata.gz: cf67de519d7768066a44b0ee81caaeb12991762e8b67b6ba848249547019a0f165a4624b8eb1cf1df49bdc2e3c120463898d05346521619a401c6be3d6164669
+  data.tar.gz: eb19cbb00e6d4ae6c86c884b9ccaa8975626a5aef4664e661925247d156818a04826996df5b24e6989f311aebbd469d2199846a5af78ff39c6d5edc7d1b90426

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in acts_as_commentable_with_reply.gemspec
+gemspec
+
+group :development do
+  gem 'rails' #, :git => 'git://github.com/rails/rails.git', :branch => '4-0-stable'
+  # https://github.com/rails/rails/issues/6039
+  gem 'activerecord-deprecated_finders', git: 'git://github.com/rails/activerecord-deprecated_finders.git'
+  gem 'sqlite3'
+  gem 'pry'
+end
+
+gem 'test-unit'

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Lungelo Ximba
+
+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,95 @@
+= Acts As Commentable with Reply
+
+Provides a single Comment model that can be attached to any model(s) within your app. It creates
+Comment and CommentReply models and handles the plumbing between those models and any models that you declare to be
+commentable models. The replies are limited to one-level nesting. If you need no nesting then check out
+[acts_as_commentable](https://github.com/jackdempsey/acts_as_commentable). If you need deeper nesting then checkout
+[acts_as_commentable_with_threading](https://github.com/elight/acts_as_commentable_with_threading).
+
+The advantage of this gem over acts_as_commentable_with_threading is that it does not use the nested set model and
+this leads to faster writes. Check [this Wikipedia](http://en.wikipedia.org/wiki/Nested_set_model) article for
+further reading on the nested set model.
+
+
+== Installation :
+
+Add the following line to your Gemfile
+
+=== Rails 4
+
+  gem 'acts_as_commentable'
+
+== Generator
+
+
+=== Rails 4
+
+  rails g comment
+
+Then migrate your database to add the comments and comment_replies models:
+
+  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
+
+Add a reply to a comment instance by adding the following to the controller:
+
+  comment = Comment.find x # Any other way of obtaining a comment instance
+  reply = comment.comment_replies.create :reply => "This is the first reply."
+
+Fetch comments for the commentable model by adding the following to the view:
+ 
+  commentable = Post.find(1)
+  comments = commentable.comments.recent.limit(10).all
+
+Fetch replies for a comment instance by adding the following to the controller/view:
+
+  comment = Comment.find x # Any other way of obtaining a comment instance
+  replies = CommentReply.find_comment_replies comment
+
+You can also add different types of comments to a model:
+ 
+  class Todo < ActiveRecord::Base
+    acts_as_commentable :public, :private
+  end
+
+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
+
+Jack Dempsey - This plugin is heavily influenced by Acts As Commentable.
+
+== Contributors
+
+Lungelo Ximba

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rake/testtask'
+
+desc 'Test the acts_as_commentable_with_reply plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+task default: :test

data/acts_as_commentable_with_reply.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "acts_as_commentable_with_reply"
+  spec.version       = "1.0.0"
+  spec.authors       = ["Lungelo Ximba"]
+  spec.email         = ["lungeloximba@gmail.com"]
+
+  spec.summary       = %q{Rails gem that provides comment functionality with one-level nesting of comment replies}
+  spec.description   = %q{Rails gem that provides comment functionality with one-level nesting of comment replies (based on acts_as_commentable)}
+  spec.homepage      = %q{https://github.com/sximba/acts_as_commentable_with_reply}
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.has_rdoc      = false
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.license       = 'MIT'
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "acts_as_commentable_with_reply"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

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_with_reply.rb

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

data/lib/comment_methods.rb

@@ -0,0 +1,73 @@
+module ActsAsCommentableWithReply
+  # including this module into your CommentReply model will give you finders and named
+  # scopes useful for working with CommentReplies.
+  # The named scopes are:
+  #   in_order: Returns replies in the order they were created (created_at ASC).
+  #   recent: Returns replies by how recently they were created (created_at DESC).
+  #   limit(N): Return no more than N comments.
+  module CommentReply
+
+    def self.included(comment_reply_model)
+      comment_reply_model.extend Finders
+      comment_reply_model.scope :in_order, -> { comment_reply_model.order('created_at ASC') }
+      comment_reply_model.scope :recent, -> { comment_reply_model.reorder('created_at DESC') }
+    end
+
+    def is_comment_reply_type?(type)
+      type.to_s == role.singularize.to_s
+    end
+
+    module Finders
+      # Helper class method to lookup all comment replies assigned
+      # to a specific comment for a given user.
+      def find_comment_replies_by_user(comment, user)
+        where(["comment_id = ? and user_id = ?", comment.id, user.id]).order("created_at DESC")
+      end
+
+      # Helper class method to look up all replies for a comment
+      def find_comment_replies(comment)
+        where(["comment_id = ?", comment.id]).order("created_at DESC")
+      end
+    end
+  end
+
+  # 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, -> { 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, 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,90 @@
+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_4", 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)
+          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
+
+ActiveRecord::Base.send(:include, Juixe::Acts::Commentable)

data/lib/generators/comment/USAGE

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

data/lib/generators/comment/comment_generator.rb

@@ -0,0 +1,19 @@
+require 'rails/generators/migration'
+
+class CommentGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+
+  def self.source_root
+    @_acts_as_commentable_with_reply_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"
+    template "comment_reply.rb", "app/models/comment_reply.rb"
+    migration_template "create_comments.rb", "db/migrate/create_comments.rb"
+  end
+end

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

@@ -0,0 +1,17 @@
+class Comment < ActiveRecord::Base
+
+  include ActsAsCommentableWithReply::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
+
+  has_many :comment_replies
+end

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

@@ -0,0 +1,15 @@
+class CommentReply < ActiveRecord::Base
+
+  include ActsAsCommentableWithReply::CommentReply
+
+  belongs_to :comment
+
+  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,31 @@
+class CreateComments < ActiveRecord::Migration
+  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 null: true
+    end
+
+    create_table :comment_replies do |t|
+      t.string :reply
+      t.references :comment
+      t.references :user
+      t.timestamps null: true
+    end
+
+    add_index :comments, :commentable_type
+    add_index :comments, :commentable_id
+    add_index :comments, :user_id
+
+    add_index :comment_replies, :comment_id
+    add_index :comment_replies, :user_id
+  end
+
+  def self.down
+    drop_table :comment_replies
+    drop_table :comments
+  end
+end

data/rails/init.rb

@@ -0,0 +1,2 @@
+require File.join(File.dirname(__FILE__), '..', 'lib', 'acts_as_commentable_with_reply')
+

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_commentable_with_reply
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Lungelo Ximba
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Rails gem that provides comment functionality with one-level nesting
+  of comment replies (based on acts_as_commentable)
+email:
+- lungeloximba@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- acts_as_commentable_with_reply.gemspec
+- bin/console
+- bin/setup
+- init.rb
+- install.rb
+- lib/acts_as_commentable_with_reply.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/comment_reply.rb
+- lib/generators/comment/templates/create_comments.rb
+- rails/init.rb
+homepage: https://github.com/sximba/acts_as_commentable_with_reply
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Rails gem that provides comment functionality with one-level nesting of comment
+  replies
+test_files: []