the_comments 2.2.2 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 49fd19e10fb5ca5adbbb061aced7c0c844b85bac
-  data.tar.gz: 36c6ab87c989e3bb71f108f382537084bf6aa78e
+  metadata.gz: d33700b0151040d95f8a455e475ad5d66eb8b928
+  data.tar.gz: 5d104aa0145c131bf1cc3a98002a0f1dff5e1365
 SHA512:
-  metadata.gz: 1ea2f9f5bf511f4350efc70c0a53a65c4db5cdeb0fcbe98e09d33afc6c9c57d5ab88a766b7e0e6db4ec1c21f9db209af10b9546285b0c414fe85f4920e56fea1
-  data.tar.gz: 096802337316119520c1811ecc7e463adb9f684deab5f97a7a4ba64d3c0137a53def4d110f292d65be7c237d5bd7eed4edc079bf03f86093244f8f865a12a6b4
+  metadata.gz: c37bcfd7ef8a5badd433e6eb711d3bc74d5e7a8b7349b13aa2bb7b3bb8e13e7d744e3ab5570c323a905a338f6efd75dc4b57dd38caf190d13c80ad97f81874d6
+  data.tar.gz: bf99d747ea1f2aa1e4df5fda067527e03571e596c34ea4226f5182ba6a0bd0657a008ed16323f611a9c7a1e2e54747d749d026c5f4e30ee2cc12f9206dd2315a

data/README.md

@@ -2,34 +2,36 @@
 
 [![Gem Version](https://badge.fury.io/rb/the_comments.png)](http://badge.fury.io/rb/the_comments) | [![Build Status](https://travis-ci.org/the-teacher/the_comments.png?branch=master)](https://travis-ci.org/the-teacher/the_comments) | [![Code Climate](https://codeclimate.com/github/the-teacher/the_comments.png)](https://codeclimate.com/github/the-teacher/the_comments) | [(rubygems)](http://rubygems.org/gems/the_comments)
 
-TheComments - probably, best commenting system for Rails
+TheComments - The best Rails gem for blog-style comments
 
-:question:   [Why TheComments is better than others gems?](docs/whats_wrong_with_other_gems.md#why-thecomments-is-better-than-others-gems)
+:question:   [Why is TheComments better than other gems?](docs/whats_wrong_with_other_gems.md#why-thecomments-is-better-than-others-gems)
 
-### Main features
+### Features
 
 * Threaded comments
 * Useful cache counters
 * Admin UI for moderation
 * Mountable Engine.routes
 * Online Support via skype: **ilya.killich**
-* [Denormalization](docs/denormalization_and_recent_comments.md) for Recent comments
+* [Denormalization](docs/denormalization_and_recent_comments.md) for recent comments
 * Production-ready commenting system for Rails 4+
-* Designed for preprocessors Sanitize, Textile, Markdawn etc.
+* Designed for preprocessors such as Sanitize, Textile, Markdown etc.
 
 ### :books:   [Documentation](docs/documentation.md)
 
 ## If you have any questions
 
-Please before ask anything try to launch and play with **[Dummy App](spec/dummy_app)** in spec folder. Maybe example of integration will be better than any documentation. Thank you!
+Please try playing around with the **[Dummy App](spec/dummy_app)** in the `spec` folder first. An example integration is often better than any documentation! Thanks.
 
-## How to start dummy app (screencast)
+## How to start the dummy app (screencast)
 
 [![Foo](https://raw.github.com/the-teacher/the_comments/master/docs/screencast.jpg)](http://vk.com/video_ext.php?oid=49225742&id=166578209&hash=10be1dba625149bb&hd=3)
 
 ## Quick Start Installation
 
-### 1. Gems install
+**NB: In the following examples, `Posts` is the model to which comments are being added. For your app, the model might be `Articles` or similar instead.**
+
+### 1. Install Gems 
 
 **Gemfile**
 
@@ -46,9 +48,9 @@ gem 'awesome_nested_set'  # or same gem
 bundle
 ```
 
-### 2. Migrations install
+Don't forget to restart your server!
 
-**Copy migrations**
+### 2. Add migrations
 
 ```
 rake the_comments_engine:install:migrations
@@ -80,13 +82,36 @@ class ChangeCommentable < ActiveRecord::Migration
 end
 ```
 
+:warning: &nbsp; **Open and change xxxxx_change_user.rb migration**
+
+```ruby
+class TheCommentsChangeUser < ActiveRecord::Migration
+  def change
+    #if you User class is not called User, you may want to change it.
+    change_table :users do |t|
+      # "Written by me" (cache counters)
+      t.integer :my_draft_comments_count,      default: 0
+      t.integer :my_published_comments_count,  default: 0
+      t.integer :my_comments_count,            default: 0 # my_draft_comments_count + my_published_comments_count
+
+      # commentable's comments => comcoms (cache counters)
+      # Relation through Comment#holder_id field
+      t.integer :draft_comcoms_count,     default: 0
+      t.integer :published_comcoms_count, default: 0
+      t.integer :deleted_comcoms_count,   default: 0
+      t.integer :spam_comcoms_count,      default: 0
+    end
+  end
+end
+```
+
 **Invoke migrations**
 
 ```
 rake db:migrate
 ```
 
-### 3. Code install
+### 3. Code installation
 
 ```ruby
 rails g the_comments install
@@ -98,7 +123,7 @@ Will create:
 * app/controllers/comments_controller.rb
 * app/models/comment.rb
  
-:warning: &nbsp; **Open each file and follow an instructions**
+:warning: &nbsp; **Open each file and follow the instructions**
 
 ### 4. Models modifictions
 
@@ -110,10 +135,12 @@ class User < ActiveRecord::Base
 
   has_many :posts
 
+  # IT'S JUST AN EXAMPLE OF ANY ROLE SYSTEM 
   def admin?
     self == User.first
   end
 
+  # YOU HAVE TO IMPLEMENT YOUR ROLE POLICY FOR COMMENTS HERE
   def comments_admin?
     admin?
   end
@@ -133,7 +160,7 @@ class Post < ActiveRecord::Base
   belongs_to :user
 
   # Denormalization methods
-  # Please, read about advanced using
+  # Check the documentation for information on advanced usage
   def commentable_title
     "Undefined Post Title"
   end
@@ -166,9 +193,11 @@ MyApp::Application.routes.draw do
 end
 ```
 
-Please, read [documentation](docs/documentation.md) to learn more
+Refer to the [documentation](docs/documentation.md) for more information
 
-### 6. Controller's addon
+### 6. Add to Application Controller
+
+**app/controllers/application_controller.rb**
 
 ```ruby
 class ApplicationController < ActionController::Base
@@ -180,7 +209,7 @@ class ApplicationController < ActionController::Base
 end
 ```
 
-### 7. Assets install
+### 7. Install assets
 
 **app/assets/stylesheets/application.css**
 
@@ -196,9 +225,9 @@ end
 //= require the_comments
 ```
 
-### 8. Controller code example
+### 8. Example controller code
 
-**app/controllers/posts_controllers.rb**
+**app/controllers/posts_controller.rb**
 
 ```ruby
 def show
@@ -207,7 +236,7 @@ def show
 end
 ```
 
-### 9. View code example
+### 9. Example view code
 
 **app/views/posts/show.html.haml**
 
@@ -217,11 +246,66 @@ end
 
 <hr>
 
+### Common problems
+
+For error with `unpermitted parameters` in webserver output.
+
+Example:
+
+    Unpermitted parameters: commentable_type, commentable_id
+
+    User Load (0.3ms)  SELECT  "users".* FROM "users"  WHERE "users"."id" = 1  ORDER BY "users"."id" ASC LIMIT 1
+
+    Completed 500 Internal Server Error in 8ms
+
+Add the following to your Comments Controller.
+
+    def comment_params
+      params
+      .require(:comment)
+      .permit(:title, :contacts, :raw_content, :parent_id, :commentable_type, :commentable_id)
+      .merge(denormalized_fields)
+      .merge(request_data_for_comment)
+      .merge(tolerance_time: params[:tolerance_time].to_i)
+      .merge(user: current_user, view_token: comments_view_token)
+    end
+
+See [here](https://github.com/the-teacher/the_comments/issues/34).
+
+<hr>
+
+For errors with `around_validation`.
+
+Example:
+
+    NoMethodError - protected method `around_validation' called for #<StateMachine::Machine:0x007f84148c3c60>:
+
+Create a new file `config/state_machine.rb`.
+
+    # Rails 4.1.0.rc1 and StateMachine don't play nice
+    # https://github.com/pluginaweek/state_machine/issues/295
+
+    require 'state_machine/version'
+
+    unless StateMachine::VERSION == '1.2.0'
+      # If you see this message, please test removing this file
+      # If it's still required, please bump up the version above
+      Rails.logger.warn "Please remove me, StateMachine version has changed"
+    end
+
+    module StateMachine::Integrations::ActiveModel
+      public :around_validation
+    end
+
+See [here](https://github.com/pluginaweek/state_machine/issues/295).
+
+<hr>
+
 ### Feedback
 
 :speech_balloon: &nbsp; My twitter: [@iam_teacher](https://twitter.com/iam_teacher) &nbsp; &nbsp; &nbsp; hashtag: **#the_comments**
 
-### Acknowledgment
+### Acknowledgments
 
 * Anna Nechaeva (my wife) - for love and my happy life
 * @tanraya (Andrew Kozlov) - for code review

data/app/assets/javascripts/the_comments.js.coffee

@@ -1,8 +1,9 @@
 # ERROR MSG BUILDER
 @comments_errors_builder = (errors) ->
   error_msgs = ''
-  for error in errors
-    error_msgs += "<p><b>#{ error }</b></p>"
+  for field, errs of errors
+    for err in errs
+      error_msgs += "<p><b>#{ field }:</b> #{ err }</p>"
   error_msgs
 
 # FORM CLEANER
@@ -38,7 +39,7 @@ $ ->
 
     if tolerance_time && (time_diff < tolerance_time)
       delta  = tolerance_time - time_diff
-      error_msgs = comments_errors_builder(["Please wait #{delta} secs"])
+      error_msgs = comments_errors_builder({ delay: ["Please wait #{delta} secs"] })
       comments_error_notifier(form, error_msgs)
       return false
 
@@ -53,7 +54,7 @@ $ ->
   $(document).on 'ajax:error', comment_forms, (request, response, status) ->
     form = $ @
     $('input[type=submit]', form).show()
-    error_msgs = comments_errors_builder(["Server Error: #{response.status}"])
+    error_msgs = comments_errors_builder({ "Server Error: ": [response.status] })
     comments_error_notifier(form, error_msgs)
 
   # SUCCESS
@@ -86,7 +87,7 @@ $ ->
   $(document).on 'click', '.reply_link', ->
     link    = $ @
     comment = link.parent().parent().parent()
-  
+
     $(comment_forms).hide()
     form = $('#new_comment').clone().removeAttr('id').addClass('reply_comments_form')
 
@@ -104,4 +105,4 @@ $ ->
 
   $(window).on 'hashchange', ->
     $('.comment.highlighted').removeClass 'highlighted'
-    highlight_anchor()
+    highlight_anchor()

data/app/assets/stylesheets/the_comments.css.scss

@@ -22,17 +22,19 @@
   }
 }
 
+.action_btns a{ margin-right: 15px; }
+
 .comments, .comments_tree{
   font-family: Arial;
   font-size: 13px;
 
   h3{ font-size: 1.6em; }
 
-  .error_notifier{    
+  .error_notifier{
     background-color: #F2DEDE;
     border: 1px solid #B94A48;
     color: #B94A48;
-    
+
     border-radius: 4px;
     margin: 0 0 15px 0;
     padding: 10px 10px 0 10px;
@@ -41,13 +43,13 @@
     p{ margin: 0 0 10px 0; }
   }
   form{
-    
+
     background: #e0e4f5;
 
     border: 1px solid #c6cff5;
     border-radius: 5px;
     padding: 10px;
-    
+
     p{ margin: 0 0 10px 0; }
 
     input[type=text]{
@@ -88,7 +90,7 @@
   }
 
   .form_holder{ margin-left: 40px; }
-  
+
   .edit, .delete{
     margin-bottom: 3px;
     text-align:center;
@@ -142,6 +144,7 @@
   .controls{
     position: absolute;
     top: 53px; left: 5px;
+
     a{
       font-size:11px;
       display:block;
@@ -161,7 +164,7 @@
   }
 
   .form_holder{
-    form{ margin: 10px 0; } 
+    form{ margin: 10px 0; }
   }
 }
 
@@ -187,7 +190,7 @@
       border-left: 5px solid orange;
 
       .controls{
-        a.to_draft{ display: none }   
+        a.to_draft{ display: none }
       }
     }
     .published{
@@ -242,4 +245,4 @@
       }
     }
   }
-}
+}

data/app/controllers/concerns/{controller.rb → the_comments/controller.rb}

@@ -1,25 +1,4 @@
 module TheComments
-  COMMENTS_COOKIES_TOKEN = 'JustTheCommentsCookies'
-
-  # Cookies and View token for spam protection
-  # include TheComments::ViewToken
-  module ViewToken
-    extend ActiveSupport::Concern
-
-    included { before_action :set_the_comments_cookies }
-
-    def comments_view_token
-      cookies[:comments_view_token]
-    end
-
-    private
-
-    def set_the_comments_cookies
-      cookies[:the_comment_cookies] = { value: TheComments::COMMENTS_COOKIES_TOKEN, expires: 1.year.from_now }
-      cookies[:comments_view_token] = { value: SecureRandom.hex, expires: 7.days.from_now } unless cookies[:comments_view_token]
-    end
-  end
-
   # Base functionality of Comments Controller
   # class CommentsController < ApplicationController
   #   include TheComments::Controller
@@ -50,23 +29,14 @@ module TheComments
     end
 
     # App side methods (you can overwrite them)
-    def index
-      @comments = ::Comment.with_state(:published).recent.page(params[:page])
-      render comment_template(:index)
-    end
 
     def manage
-      @comments = current_user.comcoms.active.recent.page(params[:page])
+      @comments = current_user.comcoms.with_users.active.recent.page(params[:page])
       render comment_template(:manage)
     end
 
     def my_comments
-      @comments = current_user.my_comments.active.recent.page(params[:page])
-      render comment_template(:my_comments)
-    end
-
-    def edit
-      @comments = current_user.comcoms.where(id: params[:id]).page(params[:page])
+      @comments = current_user.my_comments.with_users.active.recent.page(params[:page])
       render comment_template(:manage)
     end
 
@@ -74,40 +44,39 @@ module TheComments
     # Methods for admin
     %w[draft published deleted].each do |state|
       define_method "#{state}" do
-        @comments = current_user.comcoms.with_state(state).recent.page(params[:page])
+        @comments = current_user.comcoms.with_users.with_state(state).recent.page(params[:page])
         render comment_template(:manage)
       end
 
       define_method "total_#{state}" do
-        @comments = ::Comment.with_state(state).recent.page(params[:page])
+        @comments = ::Comment.with_state(state).with_users.recent.page(params[:page])
         render comment_template(:manage)
       end
 
-      unless state == 'deleted'
-        define_method "my_#{state}" do
-          @comments = current_user.my_comments.with_state(state).recent.page(params[:page])
-          render comment_template(:my_comments)
-        end
+      define_method "my_#{state}" do
+        @comments = current_user.my_comments.with_users.with_state(state).recent.page(params[:page])
+        render comment_template(:manage)
       end
     end
 
     def spam
-      @comments = current_user.comcoms.where(spam: true).recent.page(params[:page])
+      @comments = current_user.comcoms.with_users.where(spam: true).recent.page(params[:page])
+      render comment_template(:manage)
+    end
+
+    def my_spam
+      @comments = current_user.my_comments.with_users.where(spam: true).recent.page(params[:page])
       render comment_template(:manage)
     end
 
     def total_spam
-      @comments = ::Comment.where(spam: true).recent.page(params[:page])
+      @comments = ::Comment.where(spam: true).with_users.recent.page(params[:page])
       render comment_template(:manage)
     end
 
     # BASE METHODS
+
     # Public methods
-    def update
-      comment = ::Comment.find(params[:id])
-      comment.update_attributes!(patch_comment_params)
-      render(layout: false, partial: comment_partial(:comment_body), locals: { comment: comment })
-    end
 
     def create
       @comment = @commentable.comments.new comment_params
@@ -115,10 +84,22 @@ module TheComments
         @comment.save
         return render layout: false, partial: comment_partial(:comment), locals: { tree: @comment }
       end
-      render json: { errors: @comment.errors.full_messages }
+      render json: { errors: @comment.errors }
     end
 
     # Restricted area
+
+    def edit
+      @comments = current_user.comcoms.where(id: params[:id]).page(params[:page])
+      render comment_template(:manage)
+    end
+
+    def update
+      comment = ::Comment.find(params[:id])
+      comment.update_attributes!(patch_comment_params)
+      render(layout: false, partial: comment_partial(:comment_body), locals: { comment: comment })
+    end
+
     %w[draft published deleted].each do |state|
       define_method "to_#{state}" do
         ::Comment.find(params[:id]).try "to_#{state}"
@@ -213,4 +194,4 @@ module TheComments
       end
     end
   end
-end
+end