the_comments 1.1.0 → 2.0.0

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

@@ -1,5 +1,5 @@
 # ERROR MSG BUILDER
-@error_text_builder = (errors) ->
+@comments_errors_builder = (errors) ->
   error_msgs = ''
   for error in errors
     error_msgs += "<p><b>#{ error }</b></p>"
@@ -15,7 +15,7 @@
 @comments_error_notifier = (form, text) ->
   form.children('.error_notifier').empty().hide().append(text).show()
 
-# JUST HELPER
+# TIME HELPER
 @unixsec = (t) -> Math.round(t.getTime() / 1000)
 
 # HIGHTLIGHT ANCHOR
@@ -26,12 +26,11 @@
 
 $ ->
   window.tolerance_time_start = unixsec(new Date)
-
-  comment_forms  = "#new_comment, .reply_comments_form"
   tolerance_time = $('[data-comments-tolarance-time]').first().data('comments-tolarance-time')
 
   # Button Click => AJAX Before Send
   submits = '#new_comment input[type=submit], .reply_comments_form input[type=submit]'
+
   $(document).on 'click', submits, (e) ->
     button    = $ e.target
     form      = button.parents('form').first()
@@ -39,7 +38,7 @@ $ ->
 
     if tolerance_time && (time_diff < tolerance_time)
       delta  = tolerance_time - time_diff
-      error_msgs = error_text_builder(["Please wait #{delta} secs"])
+      error_msgs = comments_errors_builder(["Please wait #{delta} secs"])
       comments_error_notifier(form, error_msgs)
       return false
 
@@ -47,14 +46,17 @@ $ ->
     button.hide()
     true
 
-  # AJAX ERROR
+  ################ COMMENTS FORMS ################
+  comment_forms  = "#new_comment, .reply_comments_form"
+
+  # ERROR
   $(document).on 'ajax:error', comment_forms, (request, response, status) ->
     form = $ @
     $('input[type=submit]', form).show()
-    error_msgs = error_text_builder(["Server Error: #{response.status}"])
+    error_msgs = comments_errors_builder(["Server Error: #{response.status}"])
     comments_error_notifier(form, error_msgs)
 
-  # COMMENT FORMS => SUCCESS
+  # SUCCESS
   $(document).on 'ajax:success', comment_forms, (request, response, status) ->
     form = $ @
     $('input[type=submit]', form).show()
@@ -70,7 +72,7 @@ $ ->
       tree.append(response)
       document.location.hash = anchor
     else
-      error_msgs = error_text_builder(response.errors)
+      error_msgs = comments_errors_builder(response.errors)
       comments_error_notifier(form, error_msgs)
 
   # NEW ROOT BUTTON
@@ -92,6 +94,7 @@ $ ->
     $('.parent_id', form).val comment_id
 
     comment.siblings('.form_holder').html(form)
+    $('.error_notifier', form).empty().hide()
     form.fadeIn()
     false
 

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

@@ -1,57 +1,27 @@
 $ ->
-  # CONTROLS
-  holder = $('.comments_list')
-  
-  holder.on 'ajax:success', '.to_published', (request, response, status) ->
-    link = $ @
-    link.parents('.item').first().attr('class', 'item published')
-
-  holder.on 'ajax:success', '.to_draft', (request, response, status) ->
-    link = $ @
-    link.parents('.item').first().attr('class', 'item draft')
-
-  holder.on 'ajax:success', '.to_spam, .to_deleted', (request, response, status) ->
-    $(@).parents('li').first().hide()
-
-  $('.comments_tree').on 'ajax:success', '.delete', (request, response, status) ->
-    $(@).parents('li').first().hide()
+  hide_comment_panel = (btn) -> $(btn).parents('.panel').slideUp()
 
-  # INPLACE EDIT
-  inplace_forms = '.comments_list .form form'
-  $(document).on 'ajax:success', inplace_forms, (request, response, status) ->
-    form = $ @
-    item = form.parents('.item')
-    item.children('.body').html(response).show()
-    item.children('.form').hide()
+  comments = $ '.comments'
 
-  # FOR MANAGE SECTION
-  list = $('.comments_list')
-
-  list.on 'click', '.controls a.view', ->
-    form = $(@).parents('div.form')
-    body = form.siblings('.body')  
-    body.show()
-    form.hide()
+  # CONTROLS
+  comments.on 'click', 'a.additional_info', ->
+    btn    = $ @
+    holder = btn.parents('.panel-body')
+    holder.find('div.additional_info').slideToggle()
     false
 
-  list.on 'click', '.controls a.edit', ->
-    body = $(@).parents('div.body')
-    form = body.siblings('.form')
-    body.hide()
-    form.show()
+  comments.on 'click', 'a.edit', ->
+    btn    = $ @
+    holder = btn.parents('.panel-body')
+    holder.find('.edit_form, .comment_body, a.edit').toggle()
     false
 
-  # BLACK LIST
-  holder = $('.black_list')
-
-  holder.on 'ajax:success', '.to_warning', (request, response, status) ->
-    link = $ @
-    li = link.parents('li').first()
-    li.attr 'class', 'warning'
-    li.find('.state').html 'warning'
+  comments.on 'ajax:success', '.to_published, .to_draft, .to_spam, .to_deleted', ->
+    hide_comment_panel @
 
-  holder.on 'ajax:success', '.to_banned', (request, response, status) ->
-    link = $ @
-    li = link.parents('li').first()
-    li.attr 'class', 'banned'
-    li.find('.state').html 'banned'
+  # Edit form
+  comments.on 'ajax:success', '.edit_comment', (request, response, status) ->
+    form   = $ @
+    holder = form.parents('.panel-body')
+    holder.find('.edit_form, .comment_body, a.edit').toggle()
+    holder.find('.comment_body').replaceWith response

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

@@ -1,8 +1,11 @@
-.comments_tree, .comments_list, .black_list{  
+.comments_tree, .comments_list{
   font-family: Arial;
 
-  margin:0; padding:0;
-  *{ margin: 0; padding: 0; }
+  margin:0;
+  padding:0;
+  margin-bottom: 30px;
+
+  *{ margin: 0; padding: 0; font-size: inherit; }
 
   a{ text-decoration: none; }
   a:hover{ text-decoration: underline; }
@@ -23,9 +26,11 @@
   font-family: Arial;
   font-size: 13px;
 
+  h3{ font-size: 1.6em; }
+
   .error_notifier{    
     background-color: #F2DEDE;
-    border-color: #EED3D7;
+    border: 1px solid #B94A48;
     color: #B94A48;
     
     border-radius: 4px;
@@ -36,9 +41,11 @@
     p{ margin: 0 0 10px 0; }
   }
   form{
-    background: white;
-    border: 1px solid gray;
-    border-radius: 3px;
+    
+    background: #e0e4f5;
+
+    border: 1px solid #c6cff5;
+    border-radius: 5px;
     padding: 10px;
     
     p{ margin: 0 0 10px 0; }
@@ -48,6 +55,7 @@
       padding: 4px;
       width: 75%;
     }
+    label{ font-size: 15px; }
     textarea{
       border: 1px solid gray;
       font-family: Arial;
@@ -99,7 +107,7 @@
       float: left;
       width: 50px;
 
-      img{ margin-bottom: 10px; }
+      img{ margin-bottom: 10px; width: 42px; height: 42px; }
     }
     .userbar, .cbody{
       margin: 0 0 5px 55px;
@@ -118,10 +126,12 @@
       .to_published{ display: none; }
     }
     .cbody{
-      border-bottom: 1px solid LightGray;
+      font-size: 15px;
+      border-bottom: 1px solid #eee;
       padding-bottom: 10px;
       line-height: 135%;
-      margin-bottom: 0;
+      margin-bottom: 3px;
+      overflow: hidden;
     }
     .reply{
       margin: 0 0 5px 55px;
@@ -230,23 +240,4 @@
       }
     }
   }
-}
-
-.black_list{
-  li{
-    border: 1px solid gray;
-    border-radius: 5px;
-    padding: 10px;
-    &.warning{
-      border-left: 5px solid orange;
-      .to_warning{ display: none; }
-    }
-    &.banned{
-      border-left: 5px solid black;
-      .to_banned{ display: none; }
-    }
-  }
-  p{
-    margin-bottom: 10px;
-  }
 }

data/app/controllers/_templates_/comments_controller.rb

@@ -0,0 +1,44 @@
+class CommentsController < ApplicationController
+  # layout 'admin'
+
+  # Define your restrict methods and use them like this:
+  #
+  # before_action :user_required,  except: %w[index create]
+  # before_action :owner_required, except: %w[index create]
+  # before_action :admin_required, only:   %w[total_draft total_published total_deleted total_spam]
+  
+  include TheComments::Controller
+
+  # >>> include TheComments::Controller <<<
+  # (!) Almost all methods based on *current_user* method
+  #
+  # 1. Controller's public methods list:
+  # You can redifine it for your purposes
+  # public
+  # %w[ manage index create edit update ]
+  # %w[ my_comments my_draft my_published ]
+  # %w[ draft published deleted spam ]
+  # %w[ to_draft to_published to_deleted to_spam ]
+  # %w[ total_draft total_published total_deleted total_spam ]
+  #
+  #
+  # 2. Controller's private methods list:
+  # You can redifine it for your purposes
+  #
+  # private
+  # %w[ comment_template comment_partial ]
+  # %w[ denormalized_fields request_data_for_comment define_commentable ]
+  # %w[ comment_params patch_comment_params ]
+  # %w[ ajax_requests_required cookies_required ]
+  # %w[ empty_trap_required tolerance_time_required ]
+
+  # KAMINARI pagination:
+  # following methods based on gem "kaminari"
+  # You should redefine them if you use something else
+  #
+  # public
+  # %w[ manage index edit ]
+  # %w[ draft published deleted spam ]
+  # %w[ my_comments my_draft my_published ]
+  # %w[ total_draft total_published total_deleted total_spam ]
+end

data/app/controllers/concerns/controller.rb

@@ -0,0 +1,216 @@
+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
+  # end
+  module Controller
+    extend ActiveSupport::Concern
+
+    included do
+      include TheComments::ViewToken
+
+      # Attention! We should not set TheComments cookie before create
+      skip_before_action :set_the_comments_cookies, only: [:create]
+
+      # Spam protection
+      before_action -> { @errors = [] }, only: [:create]
+
+      before_action :ajax_requests_required,  only: [:create]
+      before_action :cookies_required,        only: [:create]
+
+      before_action :empty_trap_required,     only: [:create], if: -> { TheComments.config.empty_trap_protection }
+      before_action :tolerance_time_required, only: [:create], if: -> { TheComments.config.tolerance_time_protection }
+
+      # preparation
+      before_action :define_commentable, only: [:create]
+
+      # raise an errors
+      before_action -> { return render(json: { errors: @errors }) unless @errors.blank? }, only: [:create]
+    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])
+      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])
+      render comment_template(:manage)
+    end
+
+    # Methods based on *current_user* helper
+    # 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])
+        render comment_template(:manage)
+      end
+
+      define_method "total_#{state}" do
+        @comments = ::Comment.with_state(state).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
+      end
+    end
+
+    def spam
+      @comments = current_user.comcoms.where(spam: true).recent.page(params[:page])
+      render comment_template(:manage)
+    end
+
+    def total_spam
+      @comments = ::Comment.where(spam: true).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
+      if @comment.valid?
+        @comment.save
+        return render layout: false, partial: comment_partial(:comment), locals: { tree: @comment }
+      end
+      render json: { errors: @comment.errors.full_messages }
+    end
+
+    # Restricted area
+    %w[draft published deleted].each do |state|
+      define_method "to_#{state}" do
+        ::Comment.find(params[:id]).try "to_#{state}"
+        render nothing: true
+      end
+    end
+
+    def to_spam
+      comment = ::Comment.find(params[:id])
+      comment.to_spam
+      comment.to_deleted
+      render nothing: true
+    end
+
+    private
+
+    def comment_template template
+      { template: "the_comments/#{TheComments.config.template_engine}/#{template}" }
+    end
+
+    def comment_partial partial
+      "the_comments/#{TheComments.config.template_engine}/#{partial}"
+    end
+
+    def denormalized_fields
+      title = @commentable.commentable_title
+      url   = @commentable.commentable_url
+      @commentable ? { commentable_title: title, commentable_url: url } : {}
+    end
+
+    def request_data_for_comment
+      r = request
+      { ip: r.ip, referer: CGI::unescape(r.referer  || 'direct_visit'), user_agent: r.user_agent }
+    end
+
+    def define_commentable
+      commentable_klass = params[:comment][:commentable_type].constantize
+      commentable_id    = params[:comment][:commentable_id]
+
+      @commentable = commentable_klass.find(commentable_id)
+      return render(json: { errors: [t('the_comments.undefined_commentable')] }) unless @commentable
+    end
+
+    def comment_params
+      params
+        .require(:comment)
+        .permit(:title, :contacts, :raw_content, :parent_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
+
+    def patch_comment_params
+      params
+        .require(:comment)
+        .permit(:title, :contacts, :raw_content, :parent_id)
+    end
+
+    # Protection hooks
+    def ajax_requests_required
+      unless request.xhr?
+        return render(text: t('the_comments.ajax_requests_required'))
+      end
+    end
+
+    def cookies_required
+      if cookies[:the_comment_cookies] != TheComments::COMMENTS_COOKIES_TOKEN
+        @errors << [t('the_comments.cookies'), t('the_comments.cookies_required')].join(': ')
+      end
+    end
+
+    # TODO:
+    # 1) inject ?
+    # 2) fields can be removed on client side
+    def empty_trap_required
+      is_human = true
+      params.slice(*TheComments.config.empty_inputs).values.each{|v| is_human = (is_human && v.blank?) }
+
+      if !is_human
+        @errors << [t('the_comments.trap'), t('the_comments.trap_message')].join(': ')
+      end
+    end
+
+    def tolerance_time_required
+      this_time = params[:tolerance_time].to_i
+      min_time  = TheComments.config.tolerance_time.to_i
+
+      if this_time < min_time
+        tdiff   = min_time - this_time
+        @errors << [t('the_comments.tolerance_time'), t('the_comments.tolerance_time_message', time: tdiff )].join(': ')
+      end
+    end
+  end
+end

data/app/helpers/render_comments_tree_helper.rb

@@ -27,7 +27,7 @@ module RenderCommentsTreeHelper
       end
 
       def moderator?
-        controller.try(:current_user).try(:comment_moderator?, @comment)
+        controller.try(:current_user).try(:comments_moderator?, @comment)
       end
 
       # Render Methods
@@ -87,17 +87,14 @@ module RenderCommentsTreeHelper
         "<div class='userbar'>#{ title } #{ anchor }</div>"
       end
 
-      def moderator_controls        
-        t = ''
+      def moderator_controls
         if moderator?
-          t += h.link_to(t('the_comments.edit'), h.edit_comment_url(@comment), class: :edit)
-          t += h.link_to(t('the_comments.to_deleted'), h.to_trash_comment_url(@comment), class: :delete, method: :delete, remote: true, confirm: t('the_comments.delete_confirm'))
+          h.link_to(t('the_comments.edit'), h.comments.edit_comment_url(@comment), class: :edit)
         end
-        t
       end
 
       def reply
-        if @comment.depth < @max_reply_depth
+        if @comment.depth < (@max_reply_depth - 1)
           "<p class='reply'><a href='#' class='reply_link'>#{ t('the_comments.reply') }</a>"
         end
       end

data/app/models/_templates_/comment.rb

@@ -0,0 +1,38 @@
+class Comment < ActiveRecord::Base
+  include TheComments::Comment
+  # ---------------------------------------------------
+  # Define comment's avatar url
+  # Usually we use Comment#user (owner of comment) to define avatar
+  # @blog.comments.includes(:user) <= use includes(:user) to decrease queries count
+  # comment#user.avatar_url
+  # ---------------------------------------------------
+
+  # public
+  # ---------------------------------------------------
+  # Simple way to define avatar url
+  #
+  # def avatar_url
+  #   src = id.to_s
+  #   src = title unless title.blank?
+  #   src = contacts if !contacts.blank? && /@/ =~ contacts
+  #   hash = Digest::MD5.hexdigest(src)
+  #   "https://2.gravatar.com/avatar/#{hash}?s=42&d=https://identicons.github.com/#{hash}.png"
+  # end
+  # ---------------------------------------------------
+
+  # private
+  # ---------------------------------------------------
+  # Define your content filters
+  # gem 'RedCloth'
+  # gem 'sanitize'
+  # gem 'MySmilesProcessor'
+  #
+  # def prepare_content
+  #   text = self.raw_content
+  #   text = RedCloth.new(text).to_html
+  #   text = MySmilesProcessor.new(text)
+  #   text = Sanitize.clean(text, Sanitize::Config::RELAXED)
+  #   self.content = text
+  # end
+  # ---------------------------------------------------
+end

data/app/models/concerns/comment.rb

@@ -0,0 +1,103 @@
+module TheComments
+  module Comment
+    extend ActiveSupport::Concern
+
+    included do
+      scope :active, -> { with_state [:draft, :published] }
+      scope :recent, -> { order('created_at DESC') }
+
+      # Nested Set
+      acts_as_nested_set scope: [:commentable_type, :commentable_id]
+
+      # Comments State Machine
+      include TheComments::CommentStates
+
+      # TheSortableTree
+      include TheSortableTree::Scopes
+
+      validates :raw_content, presence: true
+
+      # relations
+      belongs_to :user
+      belongs_to :holder, class_name: :User
+      belongs_to :commentable, polymorphic: true
+
+      # callbacks
+      before_create :define_holder, :define_default_state, :define_anchor, :denormalize_commentable
+      after_create  :update_cache_counters
+      before_save   :prepare_content
+    end
+
+    def avatar_url
+      src = id.to_s
+      src = title unless title.blank?
+      src = contacts if !contacts.blank? && /@/ =~ contacts
+      hash = Digest::MD5.hexdigest(src)
+      "https://2.gravatar.com/avatar/#{hash}?s=42&d=https://identicons.github.com/#{hash}.png"
+    end
+      
+    def mark_as_spam
+      count = self_and_descendants.update_all({spam: true})
+      update_spam_counter
+      count
+    end
+
+    def mark_as_not_spam
+      count = self_and_descendants.update_all({spam: false})
+      update_spam_counter
+      count
+    end
+
+    def to_spam
+      mark_as_spam
+    end
+
+    private
+
+    def update_spam_counter
+      holder.try :update_comcoms_spam_counter
+    end
+
+    def define_anchor
+      self.anchor = SecureRandom.hex[0..5]
+    end
+
+    def define_holder
+      c = self.commentable
+      self.holder = c.is_a?(User) ? c : c.try(:user)
+    end
+
+    def define_default_state
+      self.state = TheComments.config.default_owner_state if user && user == holder
+    end
+
+    def denormalize_commentable
+      self.commentable_title = commentable.try :commentable_title
+      self.commentable_state = commentable.try :commentable_state
+      self.commentable_url   = commentable.try :commentable_url
+    end
+
+    def prepare_content
+      self.content = self.raw_content
+    end
+
+    # Warn: increment! doesn't call validation =>
+    # before_validation filters doesn't work   =>
+    # We have few unuseful requests
+    # I impressed that I found it and reduce DB requests
+    # Awesome logic pazzl! I'm really pedant :D
+    def update_cache_counters    
+      user.try :recalculate_my_comments_counter!
+
+      if holder
+        holder.send :try, :define_denormalize_flags
+        holder.increment! "#{state}_comcoms_count"
+      end
+
+      if commentable
+        commentable.send :define_denormalize_flags
+        commentable.increment! "#{state}_comments_count"
+      end
+    end
+  end
+end