the_comments_ruby 2.3.3

data/app/views/the_comments/slim/_guest_form.html.slim

@@ -0,0 +1,22 @@
+label= t('the_comments.form.title')
+p= f.text_field :title, class: 'form-control'
+
+label= t('the_comments.form.contacts')
+p= f.text_field :contacts, class: 'form-control'
+
+label= t('the_comments.form.content')
+p= f.text_area :raw_content, class: 'form-control'
+
+p.trap
+  - TheComments.config.empty_inputs.each do |name|
+    = text_field_tag name, nil, autocomplete: :off, tabindex: -1, id: nil
+
+= hidden_field_tag :tolerance_time, 0, id: nil, class: :tolerance_time
+
+= f.hidden_field :commentable_type, value: commentable.class
+= f.hidden_field :commentable_id,   value: commentable.id
+= f.hidden_field :parent_id, class: :parent_id
+
+p
+  = f.submit t('the_comments.form.create'), class: :btn
+  = t('the_comments.form.thank_you')

data/app/views/the_comments/slim/_logined_form.html.slim

@@ -0,0 +1,18 @@
+.logined_comment_form
+  .user_data
+    = link_to user_path(current_user), nopin: :nopin do
+      = image_tag current_user.avatar.url(:thumb)
+  .comment_data
+    = hidden_field_tag :tolerance_time, 0, id: nil, class: :tolerance_time
+    = f.hidden_field :commentable_type, value: commentable.class
+    = f.hidden_field :commentable_id,   value: commentable.id
+    = f.hidden_field :parent_id, class: :parent_id
+
+    .user_name
+      b= current_user.username.present? ? current_user.username : current_user.login
+    label= t('the_comments.form.content')
+    p= f.text_area :raw_content
+
+    p
+      = f.submit t('the_comments.form.create'), class: :btn
+      = t('the_comments.form.thank_you')

data/app/views/the_comments/slim/_manage_controls.html.slim

@@ -0,0 +1,30 @@
+- hidden = "display:none"
+
+.row.controls
+  .col-md-9.action_btns
+    = link_to '#', class: "edit btn btn-success" do
+      = t('the_comments.edit')
+
+    = link_to '#', class: "btn btn-warning edit", style: "display:none" do
+      = t('the_comments.cancel')
+
+    - unless to_hide = comment.published? ? hidden : nil
+      - opts    = { remote: true, style: to_hide, method: :post }
+      = link_to [:to_published, comment], opts.merge(class: "btn btn-primary to_published") do
+        = t('the_comments.to_published')
+
+    - unless to_hide = comment.draft? ? hidden : nil
+      - opts    = { remote: true, style: to_hide, method: :post }
+      = link_to [:to_draft, comment], opts.merge(class: "btn btn-warning to_draft") do
+        = t('the_comments.to_draft')
+
+    - unless to_hide = comment.deleted? ? hidden : nil
+      - opts    = { remote: true, style: to_hide, method: :delete, data: { confirm: t('the_comments.delete_confirm') } }
+      = link_to [:to_deleted, comment], opts.merge(class: "btn btn-danger to_deleted") do
+        = t('the_comments.to_deleted')
+
+    - opts = { remote: true, method: :post}
+    = link_to [:to_spam, comment], opts.merge(class: "btn btn-danger to_spam") do
+      = t('the_comments.to_spam')
+  .col-md-3.text-right
+    = link_to t('the_comments.additional_info'), "#", class: "additional_info btn btn-info"

data/app/views/the_comments/slim/_sidebar.html.slim

@@ -0,0 +1,9 @@
+.panel.panel-default
+  .panel-heading= t "the_comments.nav.header"
+  .panel-body
+    = render partial: 'the_comments/slim/sidebar_backlink'
+
+    - if current_user.comments_admin?
+      = render partial: 'the_comments/slim/sidebar_admin'
+    - else
+      = render partial: 'the_comments/slim/sidebar_user'

data/app/views/the_comments/slim/_sidebar_admin.html.slim

@@ -0,0 +1,12 @@
+- cuser = current_user
+
+= render partial: 'the_comments/slim/sidebar_user'
+
+- if cuser.comments_admin?
+  br
+  h5= t 'the_comments.in_system', num: Comment.count
+  p= link_to t("the_comments.published_comments", num: Comment.with_state(:published).count), [:total_published, :comments], class: 'btn btn-success btn-sm'
+  p= link_to t("the_comments.draft_comments",     num: Comment.with_state(:draft).count),     [:total_draft,     :comments], class: 'btn btn-info btn-sm'
+  p
+    = link_to t("the_comments.deleted_comments",   num: Comment.with_state(:deleted).count),   [:total_deleted,   :comments], class: 'btn btn-default btn-sm'
+    = link_to t("the_comments.spam_comments",      num: Comment.where(spam: true).count),      [:total_spam,      :comments], class: 'btn btn-default btn-sm'

data/app/views/the_comments/slim/_sidebar_backlink.html.slim

@@ -0,0 +1,3 @@
+p= link_to t('the_comments.nav.to_root'), root_path
+p= link_to t('the_comments.nav.all_incoming'), manage_comments_url
+hr

data/app/views/the_comments/slim/_sidebar_user.html.slim

@@ -0,0 +1,29 @@
+- cuser = current_user
+
+h5=t 'the_comments.written_by_me', num: cuser.my_comments.count
+
+p= link_to t("the_comments.published_comments", num: cuser.my_published_comments.count), [:my_published, :comments], class: 'btn btn-success btn-sm'
+p= link_to t("the_comments.draft_comments",     num: cuser.my_draft_comments.count),     [:my_draft,     :comments], class: 'btn btn-info btn-sm'
+
+p
+  - if cuser.comments_admin?
+    = link_to t("the_comments.deleted_comments",   num: cuser.my_deleted_comments.count),   [:my_deleted, :comments], class: 'btn btn-default btn-sm'
+    = link_to t("the_comments.spam_comments",      num: cuser.my_spam_comments.count),      [:my_spam,    :comments], class: 'btn btn-default btn-sm'
+  - else
+    span.btn.btn-default.btn-sm= t("the_comments.deleted_comments",   num: cuser.my_deleted_comments.count)
+    span.btn.btn-default.btn-sm= t("the_comments.spam_comments",      num: cuser.my_spam_comments.count)
+
+br
+h5= t 'the_comments.for_my_posts', num: cuser.comcoms.count
+
+p= link_to t("the_comments.published_comments", num: cuser.published_comcoms_count), [:published, :comments], class: 'btn btn-success btn-sm'
+p= link_to t("the_comments.draft_comments",     num: cuser.draft_comcoms_count),     [:draft,     :comments], class: 'btn btn-info btn-sm'
+p
+  - if cuser.comments_admin?
+    = link_to t("the_comments.deleted_comments",   num: cuser.deleted_comcoms_count),   [:deleted,   :comments], class: 'btn btn-default btn-sm'
+    = link_to t("the_comments.spam_comments",      num: cuser.spam_comcoms_count),      [:spam,      :comments], class: 'btn btn-default btn-sm'
+  - else
+    span.btn.btn-default.btn-sm= t("the_comments.deleted_comments",   num: cuser.deleted_comcoms_count)
+    span.btn.btn-default.btn-sm= t("the_comments.spam_comments",      num: cuser.spam_comcoms_count)
+
+

data/app/views/the_comments/slim/_tree.html.slim

@@ -0,0 +1,16 @@
+- if commentable.comments_on?
+  h4.comments_sum
+    - if commentable.comments_sum.zero?
+      | Вы можете стать первым, кто оставит комментарий!
+    - else
+      | Комментариев: #{ commentable.comments_sum }
+
+  - unless current_user
+    .comments_description
+      p &mdash; Комментарий можно оставить <b>без регистрации</b>, для этого достаточно заполнить одно обязательное поле <b class='nobr'>Текст комментария</b>. Анонимные комментарии проходят модерацию и до момента одобрения видны только в браузере автора
+      p &mdash; Комментарии зарегистрированных пользователей публикуются сразу после создания
+
+.comments#comments
+  ol.comments_tree  data: { comments: { tolarance_time: TheComments.config.tolerance_time  } }  
+    = render partial: 'the_comments/slim/comment', locals: { tree: comments_tree }
+  = render partial: 'the_comments/slim/form', locals: { commentable: commentable }

data/app/views/the_comments/slim/index.html.slim

@@ -0,0 +1,18 @@
+- content_for :title do
+  = t "the_comments.management"
+
+- content_for :comments_sidebar do
+  = render partial: 'the_comments/slim/sidebar'
+
+- content_for :comments_main do
+  = paginate @comments
+
+  .comments
+    - @comments.each do |comment|
+      - klass = { published: :success, draft: :info, deleted: :danger }[comment.state.to_sym]
+      .panel  class: "panel-#{klass}"  
+        .panel-heading= comment.header_title
+        .panel-body
+          = render partial: 'the_comments/slim/comment_body', locals: { comment: comment }
+
+  = paginate @comments

data/app/views/the_comments/slim/manage.html.slim

@@ -0,0 +1,26 @@
+- content_for :title do
+  = t "the_comments.management"
+
+- content_for :comments_sidebar do
+  = render partial: 'the_comments/slim/sidebar'
+
+- content_for :comments_main do
+  = paginate @comments
+
+  - if @comments.blank?
+    .alert.alert-info= t 'the_comments.no_comments_here'
+
+  .comments
+    - @comments.each do |comment|
+      - klass = { published: :success, draft: :info, deleted: :danger }[comment.state.to_sym]
+      .panel  class: "panel-#{klass}"  
+        .panel-heading= comment.header_title
+        .panel-body
+          = render partial: 'the_comments/slim/comment_body', locals: { comment: comment }
+
+          - if current_user.comments_admin?
+            = render partial: 'the_comments/slim/comment_edit', locals: { comment: comment }
+            = render partial: 'the_comments/slim/manage_controls', locals: { comment: comment }
+            = render partial: 'the_comments/slim/additional_info', locals: { comment: comment }
+
+  = paginate @comments

data/app/views/the_comments/slim/my_comments.html.slim

@@ -0,0 +1,28 @@
+- cuser = current_user
+
+- content_for :title do
+  = t "the_comments.management"
+
+- content_for :comments_sidebar do
+  = render partial: 'the_comments/slim/sidebar'
+
+- content_for :comments_main do
+  = paginate @comments
+
+  - if @comments.blank?
+    .alert.alert-info= t 'the_comments.no_comments_here'
+
+  .comments
+    - @comments.each do |comment|
+      - klass = { published: :primary, draft: :warning, deleted: :danger }[comment.state.to_sym]
+      .panel  class: "panel-#{klass}"  
+        .panel-heading= comment.title
+        .panel-body
+          = render partial: 'the_comments/slim/comment_body', locals: { comment: comment }
+          
+          - if cuser.comments_admin?
+            = render partial: 'the_comments/slim/comment_edit',    locals: { comment: comment }
+            = render partial: 'the_comments/slim/manage_controls', locals: { comment: comment }
+            = render partial: 'the_comments/slim/additional_info', locals: { comment: comment }
+        
+  = paginate @comments

data/config/initializers/the_comments.rb

@@ -0,0 +1,14 @@
+# TheComments.config.param_name => value
+
+TheComments.configure do |config|
+  config.max_reply_depth     = 3                   # comments tree depth
+  config.tolerance_time      = 10                  # sec - after this delay user can post a comment
+  config.default_state       = :draft              # default state for comment
+  config.default_owner_state = :published          # default state for comment for Moderator
+  config.empty_inputs        = [:commentBody]      # array of spam trap fields
+  config.default_title       = 'Undefined title'   # default commentable_title for denormalization
+  config.template_engine     = :haml
+
+  config.empty_trap_protection     = true
+  config.tolerance_time_protection = true
+end

data/config/locales/en.yml

@@ -0,0 +1,68 @@
+en:
+  activerecord:
+    attributes:
+      comment:
+        raw_content: Content
+    errors:
+      models:
+        comment:
+          attributes:
+            raw_content:
+              blank: 'should not be empty'
+              # blank: '%{attribute} should not be empty'
+
+  the_comments:
+    incoming: "Incoming:"
+    in_system: "In system:"
+    written_by_me: "Written by me:"
+    back_to_root: "← To root"
+
+    my_comments:        "My comments (%{num})"
+    draft_comments:     "New (%{num})"
+    published_comments: "Published (%{num})"
+    deleted_comments:   "Deleted (%{num})"
+    spam_comments:      "Spam (%{num})"
+
+    management: Comments management
+    new: "New comment"
+    update: "Update comment"
+    additional_info: "Additional info"
+    cancel: "Cancel"
+
+    title: "Title on name:"
+    contacts: "Contacts:"
+    content: "Message:"
+
+    guest_name: Guest
+    reply: Reply to this comment
+    edit: Edit
+    to_spam: Spam!
+    to_draft: Draft
+    to_published: Publicate
+    to_deleted:   Delete
+
+    no_comments_here: No comments here
+
+    nav:
+      header: "Navigation"
+
+    form:
+      title: "Your name:"
+      contacts: "Contacts (only admin can see this):"
+      content: "Comment* :"
+      create: "Submit comment"
+      thank_you:  "Thank you!"
+
+    trap: Trap
+    trap_message: should be empty
+
+    tolerance_time: Page view time
+    tolerance_time_message: "Please wait %{time} seconds before send a comment and try again"
+
+    delete_confirm: Are you sure?
+
+    cookies: Cookies
+    cookies_required: 'Please enable cookies and try to reload page'
+    ajax_requests_required: 'Sorry, JavaScript/Ajax Requests required'
+    waiting_for_moderation: Waiting for moderation
+    undefined_commentable: Commentable object is undefined

data/config/locales/ru.yml

@@ -0,0 +1,71 @@
+ru:
+  activerecord:
+    attributes:
+      comment:
+        raw_content: Содержимое
+    errors:
+      models:
+        comment:
+          attributes:
+            raw_content:
+              blank: 'Не может быть пустым'
+
+  the_comments:
+    incoming: "Входящие:"
+    in_system: "Все в системе: %{num}"
+    written_by_me: "Написаны мной: %{num}"
+    for_my_posts:  "К моим постам: %{num}"
+    back_to_root: "← На главную"
+
+    my_comments:        "Мои комментарии %{num}"
+    draft_comments:     "На модерации: %{num}"
+    published_comments: "Опубликованы: %{num}"
+    deleted_comments:   "Удалены: %{num}"
+    spam_comments:      "Спам: %{num}"
+
+    waiting_for_moderation: Комментарий ожидает проверки
+    management: Управление комментариями
+    new: "Написать новый комментарий"
+    update: "Обновить"
+    additional_info: "Подробнее"
+    cancel: "Отмена"
+
+    title: "Имя или тема:"
+    contacts: "Контакты:"
+    content: "Сообщение:"
+
+    guest_name: Гость
+    reply: Ответить на этот комментарий
+    edit: Править
+    to_spam: Спам!
+    to_draft: Черновик
+    to_published: Публиковать
+    to_deleted:   Удалить
+
+    no_comments_here: Здесь нет комментариев
+
+    nav:
+      header: Комментарии
+      to_root: На главную
+      all_incoming: Все входящие
+
+    form:
+      title: "Ваше имя:"
+      contacts: "Контакты (не отображаются на сайте):"
+      content: "Текст комментария* :"
+      create: "Отправить комментарий"
+      thank_you:  "Спaсибо!"
+
+    trap: Ловушка
+    trap_message: Должна быть пустой
+
+    tolerance_time: Просмотр времени
+    tolerance_time_message: "Пожалуйста ожидайте %{time} сек. перед отправкой сообщения"
+
+    cookies: Куки
+    cookies_required: 'Включите куки и перезагрузите страницу'
+
+    delete_confirm: Вы уверены?
+    waiting_for_moderation: Ожидает модерации
+    ajax_requests_required: 'Извините, ожидается JavaScript/Ajax запрос'
+    undefined_commentable: Комментируемый объект не определен

data/config/routes.rb

@@ -0,0 +1,38 @@
+module TheComments
+  class UserRoutes
+    def call mapper, options = {}
+      mapper.collection do
+        mapper.get :manage
+        mapper.get :my_comments
+
+        mapper.get :my_draft
+        mapper.get :my_published
+        mapper.get :my_deleted
+        mapper.get :my_spam
+
+        mapper.get :draft
+        mapper.get :published
+        mapper.get :deleted
+        mapper.get :spam
+      end
+
+      mapper.member do
+        mapper.post   :to_spam
+        mapper.post   :to_draft
+        mapper.post   :to_published
+        mapper.delete :to_deleted
+      end
+    end
+  end
+
+  class AdminRoutes
+    def call mapper, options = {}
+      mapper.collection do
+        mapper.get :total_draft
+        mapper.get :total_published
+        mapper.get :total_deleted
+        mapper.get :total_spam
+      end
+    end
+  end
+end

data/db/migrate/20130101010101_the_comments_change_user.rb

@@ -0,0 +1,18 @@
+# null: false => de-facto db-level validation
+class TheCommentsChangeUser < ActiveRecord::Migration
+  def change
+    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

data/db/migrate/20130101010102_the_comments_create_comments.rb

@@ -0,0 +1,50 @@
+class TheCommentsCreateComments < ActiveRecord::Migration
+  def change
+    create_table :comments do |t|
+      # relations
+      t.integer :user_id
+      t.integer :holder_id
+      
+      # polymorphic, commentable object
+      t.integer :commentable_id
+      t.string  :commentable_type
+
+      # denormalization
+      t.string  :commentable_url
+      t.string  :commentable_title
+      t.string  :commentable_state
+
+      # comment
+      t.string :anchor
+      
+      t.string :title
+      t.string :contacts
+
+      t.text :raw_content
+      t.text :content
+
+      # moderation token
+      t.string :view_token
+
+      # state machine => :draft | :published | :deleted
+      t.string :state, default: :draft
+
+      # base user data (BanHammer power)
+      t.string  :ip,             default: :undefined
+      t.string  :referer,        default: :undefined
+      t.string  :user_agent,     default: :undefined
+      t.integer :tolerance_time
+
+      # unusable: for future versions
+      t.boolean :spam, default: false
+
+      # nested set
+      t.integer :parent_id
+      t.integer :lft
+      t.integer :rgt
+      t.integer :depth, default: 0
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20130101010103_the_comments_change_commentable.rb

@@ -0,0 +1,13 @@
+class TheCommentsChangeCommentable < ActiveRecord::Migration
+  def change
+    # Uncomment this. Add fields to Commentable Models
+    #
+    # [:users, :posts, :blogs, :articles, :pages].each do |table_name|
+    #   change_table table_name do |t|
+    #     t.integer :draft_comments_count,     default: 0
+    #     t.integer :published_comments_count, default: 0
+    #     t.integer :deleted_comments_count,   default: 0
+    #   end
+    # end
+  end
+end

data/docs/admin_ui_installation.md

@@ -0,0 +1,145 @@
+←   [documentation](documentation.md)
+
+## Admin UI installation
+
+### 1. Gems install
+
+**Gemfile**
+
+```ruby
+# TheComments base
+gem 'the_comments', "~> 2.0"
+
+gem 'haml'                # or gem 'slim'
+gem 'awesome_nested_set'  # or same gem
+
+# TheComments Admin UI gems
+
+# pagination
+gem 'kaminari'
+
+# bootstrap 3
+gem 'bootstrap-sass', github: 'thomas-mcdonald/bootstrap-sass'
+```
+
+**Bundle**
+
+```
+bundle
+```
+
+### 2. Assets install
+
+**app/assets/stylesheets/admin_ui.css**
+
+```css
+/*
+*= require bootstrap
+*/
+```
+
+**app/assets/javascripts/admin_ui.js**
+
+```js
+//= require jquery
+//= require jquery_ujs
+
+//= require bootstrap
+//= require the_comments_manage
+```
+
+### 3. Admin layout
+
+You can use following yields to insert TheComments management tools in your Layout.
+
+```haml
+= yield :comments_sidebar
+= yield :comments_main
+```
+
+For example:
+
+```haml
+!!! 5
+%html(lang="en")
+  %head
+    %meta(charset="utf-8")
+    %meta(http-equiv="X-UA-Compatible" content="IE=Edge,chrome=1")
+    %meta(name="viewport" content="width=device-width, initial-scale=1.0")
+    %title= content_for?(:title) ? yield(:title) : "Admin Panel"
+    %link(href="favicon.ico" rel="shortcut icon")
+
+    = stylesheet_link_tag    :admin_ui
+    = javascript_include_tag :admin_ui
+    = csrf_meta_tags
+
+  %body
+    .container
+      .row
+        .col-md-12
+          %h3= content_for?(:title) ? yield(:title) : "Admin Panel"
+      .row
+        .col-md-3= yield :comments_sidebar
+        .col-md-9= yield :comments_main
+
+    = stylesheet_link_tag "//netdna.bootstrapcdn.com/font-awesome/3.2.1/css/font-awesome.min.css"
+```
+
+### 4. Comments controller modifications
+
+by default your comments controller looks like this:
+
+**app/controllers/comments_controller.rb**
+
+```ruby
+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
+```
+
+You must define protection methods to restrict access to Admin UI for regular users.
+
+### 5. Visit Admin UI
+
+**localhost:3000/comments/manage**