comments 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b69f183e6db423112985c8c233a7da74454c0fc3
+  data.tar.gz: c289b5f8b723643fe25dc21b24f7219892e583dd
+SHA512:
+  metadata.gz: 29eb19e867928a24074ac93c1579967113f1565bd5a62e5341a26c821a322c895d7829842f74aa76ff91f0b090475a823a052fea6d8d5eedb905bab79ae1b0f1
+  data.tar.gz: 186b63afb693e135d1c6f248880c64431804ad8fc872cd256a3ccc7938603bc3503c73f20ffe1998381f7a46335c92c28a50b8e68b81d73e9b58fbb0de4c17ee

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Jason Lee
+
+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.md

@@ -0,0 +1,43 @@
+# Comments
+
+Comment feature for any applications's any models.
+
+[![Gem Version](https://badge.fury.io/rb/comments.svg)](https://badge.fury.io/rb/comments) [![Build Status](https://travis-ci.org/rails-engine/comments.svg)](https://travis-ci.org/rails-engine/comments) [![Code Climate](https://codeclimate.com/github/rails-engine/comments/badges/gpa.svg)](https://codeclimate.com/github/rails-engine/comments) [![codecov.io](https://codecov.io/github/rails-engine/comments/coverage.svg?branch=master)](https://codecov.io/github/rails-engine/comments?branch=master) [![](http://inch-ci.org/github/rails-engine/comments.svg?branch=master)](http://inch-ci.org/github/rails-engine/comments?branch=master)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'comments'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+## Mount engine
+
+in `config/routes.rb`
+
+```rb
+mount Comments::Engine => "/comments"
+```
+
+## In view, render comment list:
+
+```erb
+# app/views/posts/show.html.erb
+
+<%= comments_tag(@post) %>
+```
+
+## Contributing
+
+Contribution directions go here.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/app/assets/stylesheets/comments.scss

@@ -0,0 +1,54 @@
+.comments {
+  border-radius: 3px;
+
+  .heading {
+    padding: 10px;
+    font-size: 20px;
+  }
+
+  .comment {
+    margin-bottom: 10px;
+    padding: 10px;
+    border-top: 1px solid #eee;
+    color: #999;
+
+    @for $i from 1 through 20 {
+      &.comment-depth-#{$i} {
+        margin-left: 40px * $i;
+      }
+    }
+
+    a { color: #555; }
+
+
+    .media-content {
+      color: #333;
+      p:last-chind {
+        margin-bottom: 0;
+      }
+    }
+
+    .media-heading {
+      .opts {
+        a { padding: 1px 6px; display:inline-block; }
+        a:link,
+        a:visited { color: #555; }
+        a:hover { text-decoration: none; background: #f0f0f0; }
+      }
+    }
+
+    .user-avatar {
+      img { width: 32px; height: 32px; border-radius: 120px; }
+    }
+
+    .media-right {
+      min-width: 100px;
+      color: #AAA;
+      font-size: 13px;
+    }
+
+    form {
+      margin-left: 40px;
+    }
+  }
+}

data/app/controllers/comments/application_controller.rb

@@ -0,0 +1,18 @@
+module Comments
+  class ApplicationController < ::ApplicationController
+    helper_method :current_user
+
+    alias_method :origin_current_user, Comments.config.current_user_method.to_sym
+    alias_method :origin_authenticate_user!, Comments.config.authenticate_user_method.to_sym
+
+    before_action :authenticate_user!
+
+    def current_user
+      origin_current_user
+    end
+
+    def authenticate_user!
+      origin_authenticate_user!
+    end
+  end
+end

data/app/controllers/comments/comments_controller.rb

@@ -0,0 +1,48 @@
+module Comments
+  class CommentsController < ApplicationController
+    before_action :authenticate_user!
+    before_action :set_comment, only: [:edit, :update, :destroy]
+
+    # GET /comments
+    def index
+      @comments = Comment.order('id asc').page(params[:page])
+    end
+
+    # POST /comments
+    def create
+      @comment = Comment.new(comment_params)
+      @comment.user = current_user
+      @comment.save
+    end
+
+    # PATCH/PUT /comments/1
+    def update
+      @success = @comment.update(comment_params)
+    end
+
+    def reply
+      @parent = Comment.find(params[:id])
+      @comment = Comment.new(parent_id: @parent.id, commentable: @parent.commentable)
+    end
+
+    # DELETE /comments/1
+    def destroy
+      if @comment.user_id != current_user.id
+        raise ActiveRecord::RecordNotFound
+      end
+
+      @comment.destroy
+    end
+
+    private
+      # Use callbacks to share common setup or constraints between actions.
+      def set_comment
+        @comment = Comment.find(params[:id])
+      end
+
+      # Only allow a trusted parameter "white list" through.
+      def comment_params
+        params.require(:comment).permit(:commentable_type, :commentable_id, :parent_id, :body)
+      end
+  end
+end

data/app/models/comment.rb

@@ -0,0 +1,6 @@
+# Model from comments gem
+class Comment < ActiveRecord::Base
+  include Comments::Model
+
+  self.per_page = 50
+end

data/app/views/comments/_comment.html.erb

@@ -0,0 +1,33 @@
+<div id="comment-<%= comment.id %>"
+    class="comment comment-depth-<%= comment.depth %> media"
+    data-parent-id="<%= comment.parent_id %>">
+  <div class="media-left">
+    <%= link_to image_tag(comment.user_avatar_url), comment.user_profile_url,
+                                                    title: comment.user_name,
+                                                    class: 'user-avatar' %>
+  </div>
+  <div class="media-body">
+    <div class="media-heading">
+      <span class="name">
+        <%= link_to comment.user_name, comment.user_profile_url,
+                                       title: comment.user_name,
+                                       class: 'user-avatar' %>
+      </span>
+      <span class="time">
+        <%= l comment.created_at, format: :long %>
+      </span>
+      <span class="opts pull-xs-right">
+        <% if comment.can_reply? %>
+          <%= link_to raw('<i class="fa fa-reply"></i>'), comments.reply_comment_path(comment), data: { remote: true } %>
+        <% end %>
+
+        <% if current_user.id == comment.user_id %>
+          <%= link_to raw('<i class="fa fa-trash"></i>'), comments.comment_path(comment), data: { method: 'delete', remote: true, confirm: "Are you sure?" } %>
+        <% end %>
+      </span>
+    </div>
+    <div class="media-content markdown">
+      <%= simple_format comment.body %>
+    </div>
+  </div>
+</div>

data/app/views/comments/_comments.html.erb

@@ -0,0 +1,11 @@
+<div class="comments comments-<%= commentable.class.name.dasherize %>">
+  <div class="heading">Comments</div>
+  <div class="comments-list">
+    <%= render partial: '/comments/comment', collection: comments, as: :comment %>
+  </div>
+  <div class="comments-footer">
+    <%= will_paginate comments %>
+  </div>
+</div>
+
+<%= render partial: '/comments/form', locals: { comment: comments.new } %>

data/app/views/comments/_form.html.erb

@@ -0,0 +1,21 @@
+<%= form_for(comment, remote: true) do |f| %>
+  <div style="display:none">
+    <%= f.hidden_field :commentable_type %>
+    <%= f.hidden_field :commentable_id %>
+    <%= f.hidden_field :parent_id %>
+  </div>
+
+  <div class="form-group row">
+    <div class="col-sm-9">
+      <%= f.text_area :body, class: 'form-control' %>
+    </div>
+    <div class="col-sm-3">
+      <% if comment.parent_id.blank? %>
+        <%= f.submit class: 'btn btn-primary btn-block' %>
+      <% else %>
+        <%= f.submit 'Reply', class: 'btn btn-primary' %>
+        <a href="#" class="btn btn-secondary" onclick="$(this).closest('.new_comment').remove(); return false;">Cancel</a>
+      <% end %>
+    </div>
+  </div>
+<% end %>

data/app/views/comments/comments/create.js.erb

@@ -0,0 +1,14 @@
+var html = '<%= j(render(partial: '/comments/comment', locals: { comment: @comment })) %>';
+<% if @comment.parent_id %>
+  var children = $('.comments .comment[data-parent-id=<%= @comment.parent_id %>]');
+  console.log(children);
+  if (children.length > 0) {
+    children.last().after(html);
+  } else {
+    $('#comment-<%= @comment.parent_id %>').after(html);
+  }
+<% else %>
+  $('.comments').append(html);
+<% end %>
+$(".comment .new_comment").remove();
+$('.new_comment [name="comment[body]"]').val('');

data/app/views/comments/comments/destroy.js.erb

@@ -0,0 +1,2 @@
+$('#comment-<%= @comment.id %>').remove();
+$('.comments .comment[data-parent-id=<%= @comment.id %>]').remove();

data/app/views/comments/comments/reply.js.erb

@@ -0,0 +1,5 @@
+var formHTML = '<%= j(render(partial: '/comments/form', locals: { comment: @comment })) %>';
+$(".comment .new_comment").remove();
+var commentItem = $("#comment-<%= @parent.id %>");
+commentItem.find(".new_comment").remove();
+commentItem.append(formHTML);

data/config/initializers/comments.rb

@@ -0,0 +1,22 @@
+# comments Config
+Comments.configure do
+  # Class name of you User model, default: 'User'
+  # self.user_class = 'User'
+
+  # Method of user name in User model, default: 'name'
+  # self.user_name_method = 'name'
+
+  # Method of user avatar in User model, default: nil
+  # self.user_avatar_url_method = nil
+
+  # Method name of user profile page path, in User model, default: 'profile_url'
+  # self.user_profile_url_method = 'profile_url'
+
+  # authenticate_user method in your Controller, default: 'authenticate_user!'
+  # If you use Devise, authenticate_user! is correct
+  # self.authenticate_user_method = 'authenticate_user!'
+
+  # current_user method name in your Controller, default: 'current_user'
+  # If you use Devise, current_user is correct
+  # self.current_user_method = 'current_user'
+end

data/config/routes.rb

@@ -0,0 +1,7 @@
+Comments::Engine.routes.draw do
+  resources :comments, path: '' do
+    member do
+      get :reply
+    end
+  end
+end

data/db/migrate/20160331035951_create_comments.rb

@@ -0,0 +1,19 @@
+class CreateComments < ActiveRecord::Migration
+  def change
+    create_table :comments do |t|
+      t.integer :user_id
+      t.string :commentable_type
+      t.integer :commentable_id
+      t.text :body
+      t.integer :parent_id, :lft, :rgt
+      t.integer :depth, default: 0, null: false
+
+      t.timestamps null: false
+    end
+
+    add_index :comments, [:commentable_type, :commentable_id]
+    add_index :comments, :parent_id
+    add_index :comments, :lft
+    add_index :comments, :rgt
+  end
+end

data/lib/comments.rb

@@ -0,0 +1,31 @@
+require 'comments/configuration'
+require 'comments/version'
+require 'comments/model'
+require 'comments/view_helpers'
+require 'comments/engine'
+require 'awesome_nested_set'
+require 'will_paginate'
+require 'will_paginate/active_record'
+
+module Comments
+  class << self
+    def config
+      return @config if defined?(@config)
+      @config = Configuration.new
+      @config.user_class = 'User'
+      @config.user_name_method = 'name'
+      @config.user_avatar_url_method = nil
+      @config.user_profile_url_method = 'profile_url'
+      @config.authenticate_user_method = 'authenticate_user!'
+      @config.current_user_method = 'current_user'
+      @config.max_reply_depth = 10
+      @config
+    end
+
+    def configure(&block)
+      config.instance_exec(&block)
+    end
+  end
+end
+
+ActionController::Base.send(:helper, Comments::ViewHelpers)

data/lib/comments/configuration.rb

@@ -0,0 +1,46 @@
+module Comments
+  class Configuration
+    # class name of you User model, default: 'User'
+    attr_accessor :user_class
+
+    # method of user name in User model, default: 'name'
+    attr_accessor :user_name_method
+
+    # method of user avatar in User model, default: nil
+    #
+    # We suggest you give image size more than 48x48 px.
+    #
+    # Example:
+    #
+    # class User
+    #   def avatar_url
+    #     self.avatar.url('48x48')
+    #   end
+    # end
+    #
+    # config.user_avatar_url_method = :avatar_url
+    #
+    attr_accessor :user_avatar_url_method
+
+    # method name of user profile page path, in User model, default: 'profile_url'
+    # Example:
+    #
+    # class User
+    #   def profile_url
+    #     "http://www.host.com/u/#{self.username}"
+    #   end
+    # end
+    #
+    # config.user_profile_url_method = 'profile_url'
+    attr_accessor :user_profile_url_method
+
+    # current_user method name in your Controller, default: 'current_user'
+    attr_accessor :current_user_method
+
+    # authenticate_user method in your Controller, default: 'authenticate_user!'
+    attr_accessor :authenticate_user_method
+
+    # Limit of reply depth, default: 10
+    attr_accessor :max_reply_depth
+  end
+end

data/lib/comments/engine.rb

@@ -0,0 +1,5 @@
+module Comments
+  class Engine < ::Rails::Engine
+    isolate_namespace Comments
+  end
+end

data/lib/comments/model.rb

@@ -0,0 +1,36 @@
+module Comments
+  module Model
+    extend ActiveSupport::Concern
+
+    DEFAULT_AVATAR = 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAPAAAADwCAMAAAAJixmgAAAAFVBMVEWkpKSnp6eqqqq3t7fS0tLV1dXZ2dmshcKEAAAAtklEQVR4Ae3XsRGAAAjAQFRk/5HtqaTz5H+DlInvAQAAAAAAAAAAAAAAAAAAAACymiveO6o7BQsWLFiwYMGCBS8PFixYsGDBggULFixYsGDBggULFixYsGDBggULFixYsGDBc4IFCxYsWLBgwYIFC14ZfOeAPRQ8IliwYMGCBQsWLFiwYMGCBQsWLFiwYMGCBQsWLFiwYMGCBQsWLFiwYMGCBQv+JQAAAAAAAAAAAAAAAAAAAOAB4KJfdHmj+kwAAAAASUVORK5CYII='
+
+    included do
+      acts_as_nested_set scope: [:commentable_type, :commentable_id]
+
+      belongs_to :commentable, polymorphic: true, touch: true
+      belongs_to :user, class_name: Comments.config.user_class
+
+      validates :body, presence: true
+    end
+
+    def user_name
+      return "" if self.user.blank?
+      self.user.send(Comments.config.user_name_method)
+    end
+
+    def user_avatar_url
+      return DEFAULT_AVATAR if Comments.config.user_avatar_url_method.blank?
+      return DEFAULT_AVATAR if self.user.blank?
+      self.user.send(Comments.config.user_avatar_url_method)
+    end
+
+    def user_profile_url
+      return '#' if self.user.blank?
+      self.user.send(Comments.config.user_profile_url_method)
+    end
+
+    def can_reply?
+      self.depth <= Comments.config.max_reply_depth
+    end
+  end
+end

data/lib/comments/version.rb

@@ -0,0 +1,3 @@
+module Comments
+  VERSION = '0.1.0'
+end

data/lib/comments/view_helpers.rb

@@ -0,0 +1,14 @@
+module Comments
+  module ViewHelpers
+    extend ActiveSupport::Concern
+
+    included do
+    end
+
+    def comments_tag(commentable, opts = {})
+      comments = Comment.where(commentable: commentable).includes(:user).order("lft asc, id asc").page(params[:page])
+
+      render partial: '/comments/comments', locals: { commentable: commentable, comments: comments }
+    end
+  end
+end

data/lib/generators/comments/controllers_generator.rb

@@ -0,0 +1,22 @@
+require 'rails/generators'
+
+module Comments
+  module Generators
+    class ControllsGenerator < Rails::Generators::Base #:nodoc:
+      source_root File.expand_path("../../../../app/controllers", __FILE__)
+      desc "Used to copy Comments's controllers to your application's controllers."
+
+      def copy_controllers
+        %w(comments).each do |fname|
+          path = "#{Rails.root}/app/controllers/comments/#{fname}_controller.rb"
+          if File.exists?(path)
+            puts "Skipping comments/#{fname}_controller.rb creation, as file already exists!"
+          else
+            puts "Adding model (comments/#{fname}_controller.rb)..."
+            template "comments/#{fname}_controller.rb", path
+          end
+        end
+      end
+    end
+  end
+end

data/lib/generators/comments/install_generator.rb

@@ -0,0 +1,33 @@
+require 'rails/generators'
+module Comments
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "Create Comments's base files"
+      source_root File.expand_path("../../../../", __FILE__)
+
+      def add_initializer
+        path = "#{Rails.root}/config/initializers/comments.rb"
+        if File.exists?(path)
+          puts "Skipping config/initializers/comments.rb creation, as file already exists!"
+        else
+          puts "Adding Comments initializer (config/initializers/comments.rb)..."
+          template "config/initializers/comments.rb", path
+        end
+      end
+
+      def add_models
+        path = "#{Rails.root}/app/models/comment.rb"
+        if File.exists?(path)
+          puts "Skipping app/models/comment.rb creation, as file already exists!"
+        else
+          puts "Adding Comments model (app/models/comment.rb)..."
+          template "app/models/comment.rb", path
+        end
+      end
+
+      def add_migrations
+        exec("rails comments:install:migrations")
+      end
+    end
+  end
+end

data/lib/generators/comments/templates/config/initializers/comments.rb

@@ -0,0 +1,24 @@
+Comments.configure do
+  # Page Size
+  # self.per_page = 32
+
+  # Class name of you User model, default: 'User'
+  # self.user_class = 'User'
+
+  # Method of user name in User model, default: 'name'
+  # self.user_name_method = 'name'
+
+  # Method of user avatar in User model, default: nil
+  # self.user_avatar_url_method = nil
+
+  # Method name of user profile page path, in User model, default: 'profile_url'
+  # self.user_profile_url_method = 'profile_url'
+
+  # authenticate_user method in your Controller, default: 'authenticate_user!'
+  # If you use Devise, authenticate_user! is correct
+  # self.authenticate_user_method = 'authenticate_user!'
+
+  # current_user method name in your Controller, default: 'current_user'
+  # If you use Devise, current_user is correct
+  # self.current_user_method = 'current_user'
+end

data/lib/generators/comments/views_generator.rb

@@ -0,0 +1,22 @@
+require 'rails/generators'
+
+module Comments
+  module Generators
+    class ViewsGenerator < Rails::Generators::Base #:nodoc:
+      source_root File.expand_path("../../../../app/views", __FILE__)
+      desc "Used to copy Comments's views to your application's controllers."
+
+      def copy_views
+        %w(comments).each do |fname|
+          path = "#{Rails.root}/app/views/comments"
+          if File.exists?(path)
+            puts "Skipping app/views/comments creation, as file already exists!"
+          else
+            puts "Adding views..."
+            directory "comments/", path
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: comments
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jason Lee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: will_paginate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: awesome_nested_set
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+description: Comment feature for any applications's any models.
+email:
+- huacnlee@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- app/assets/stylesheets/comments.scss
+- app/controllers/comments/application_controller.rb
+- app/controllers/comments/comments_controller.rb
+- app/models/comment.rb
+- app/views/comments/_comment.html.erb
+- app/views/comments/_comments.html.erb
+- app/views/comments/_form.html.erb
+- app/views/comments/comments/create.js.erb
+- app/views/comments/comments/destroy.js.erb
+- app/views/comments/comments/reply.js.erb
+- config/initializers/comments.rb
+- config/routes.rb
+- db/migrate/20160331035951_create_comments.rb
+- lib/comments.rb
+- lib/comments/configuration.rb
+- lib/comments/engine.rb
+- lib/comments/model.rb
+- lib/comments/version.rb
+- lib/comments/view_helpers.rb
+- lib/generators/comments/controllers_generator.rb
+- lib/generators/comments/install_generator.rb
+- lib/generators/comments/templates/config/initializers/comments.rb
+- lib/generators/comments/views_generator.rb
+homepage: https://github.com/rails-engine/comments
+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.6.3
+signing_key: 
+specification_version: 4
+summary: Comment feature for any applications's any models.
+test_files: []