the_comments 1.1.0 → 2.0.0

data/app/models/concerns/comment_states.rb

@@ -0,0 +1,80 @@
+module TheComments
+  module CommentStates
+    extend ActiveSupport::Concern
+
+    included do
+      # :draft | :published | :deleted
+      state_machine :state, :initial => TheComments.config.default_state do
+
+        # events
+        event :to_draft do
+          transition all - :draft => :draft
+        end
+
+        event :to_published do
+          transition all - :published => :published
+        end
+
+        event :to_deleted do
+          transition any - :deleted => :deleted
+        end
+
+        # transition callbacks
+        after_transition any => any do |comment|
+          @comment     = comment
+          @owner       = comment.user
+          @holder      = comment.holder
+          @commentable = comment.commentable
+        end
+
+        # between draft and published
+        after_transition [:draft, :published] => [:draft, :published] do |comment, transition|
+          from = transition.from_name
+          to   = transition.to_name
+
+          if @holder
+            @holder.send :try, :define_denormalize_flags
+            @holder.increment! "#{to}_comcoms_count"
+            @holder.decrement! "#{from}_comcoms_count"
+          end
+
+          if @commentable
+            @commentable.send       :define_denormalize_flags
+            @commentable.increment! "#{to}_comments_count"
+            @commentable.decrement! "#{from}_comments_count"
+          end
+        end
+
+        # to deleted (cascade like query)
+        after_transition [:draft, :published] => :deleted do |comment|
+          ids = comment.self_and_descendants.map(&:id)
+          ::Comment.where(id: ids).update_all(state: :deleted)
+
+          @owner.try       :recalculate_my_comments_counter!
+          @holder.try      :recalculate_comcoms_counters!
+          @commentable.try :recalculate_comments_counters!
+        end
+
+        # from deleted
+        after_transition :deleted => [:draft, :published] do |comment, transition|
+          to = transition.to_name
+          comment.mark_as_not_spam
+
+          @owner.try :recalculate_my_comments_counter!
+
+          if @holder
+            @holder.send :try, :define_denormalize_flags
+            @holder.decrement! :deleted_comcoms_count
+            @holder.increment! "#{to}_comcoms_count"
+          end
+
+          if @commentable
+            @commentable.send       :define_denormalize_flags
+            @commentable.decrement! :deleted_comments_count
+            @commentable.increment! "#{to}_comments_count"
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/concerns/commentable.rb

@@ -0,0 +1,69 @@
+module TheComments
+  module Commentable
+
+    extend ActiveSupport::Concern
+    
+    included do
+      has_many :comments, as: :commentable
+
+      # *define_denormalize_flags* - should be placed before title or url builder filters
+      before_validation :define_denormalize_flags
+      after_save        :denormalize_for_comments, if: -> { !id_changed? }
+    end
+
+    # Default Denormalization methods
+    # Overwrite it with your Application
+    def commentable_title
+      # My first blog post
+      try(:title) || TheComments.config.default_title
+    end
+
+    def commentable_url
+      # /posts/1
+      ['', self.class.to_s.tableize, self.to_param].join('/')
+    end
+
+    def commentable_state
+      # 'draft'
+      try(:state)
+    end
+
+    # Helper methods
+    def comments_sum
+      published_comments_count + draft_comments_count
+    end
+
+    def recalculate_comments_counters!
+      update_attributes!({
+        draft_comments_count:     comments.with_state(:draft).count,
+        published_comments_count: comments.with_state(:published).count,
+        deleted_comments_count:   comments.with_state(:deleted).count
+      })
+    end
+
+    private
+
+    def define_denormalize_flags
+      @trackable_commentable_title = commentable_title
+      @trackable_commentable_state = commentable_state
+      @trackable_commentable_url   = commentable_url
+    end
+
+    def denormalization_fields_changed?
+      a = @trackable_commentable_title != commentable_title
+      b = @trackable_commentable_state != commentable_state
+      c = @trackable_commentable_url   != commentable_url
+      a || b || c
+    end
+
+    def denormalize_for_comments
+      if denormalization_fields_changed?
+        comments.update_all({
+          commentable_title: commentable_title,
+          commentable_state: commentable_state,
+          commentable_url:   commentable_url
+        })
+      end 
+    end
+  end
+end

data/app/models/concerns/user.rb

@@ -0,0 +1,52 @@
+module TheComments
+  module User
+    extend ActiveSupport::Concern
+    
+    included do
+      has_many :comcoms, class_name: :Comment, foreign_key: :holder_id
+    end
+
+    def my_comments; ::Comment.where(user: self); end
+
+    %w[draft published deleted].each do |state|
+      define_method "my_#{state}_comments" do
+        my_comments.with_state state
+      end
+
+      define_method "#{state}_comcoms" do
+        comcoms.with_state state
+      end
+    end
+
+    # I think we shouldn't to have my_deleted_comments cache counter
+    def recalculate_my_comments_counter!
+      dcount = my_draft_comments.count
+      pcount = my_published_comments.count
+      update_attributes!({
+        my_draft_comments_count:     dcount,
+        my_published_comments_count: pcount,
+        my_comments_count:           dcount + pcount
+      })
+    end
+
+    def recalculate_comcoms_counters!
+      update_attributes!({
+        draft_comcoms_count:     draft_comcoms.count,
+        published_comcoms_count: published_comcoms.count,
+        deleted_comcoms_count:   deleted_comcoms.count
+      })
+    end
+
+    def update_comcoms_spam_counter
+      update!(spam_comcoms_count: comcoms.where(spam: true).count)
+    end
+
+    def comments_sum
+      published_comments_count + draft_comments_count
+    end
+
+    def comcoms_sum
+      published_comcoms_count + draft_comcoms_count
+    end
+  end
+end

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

@@ -0,0 +1,3 @@
+<%= render partial: "the_comments/#{TheComments.config.template_engine}/tree",
+           locals: { commentable: commentable, comments_tree: comments_tree }
+%>

data/app/views/the_comments/haml/_additional_info.html.haml

@@ -0,0 +1,13 @@
+.additional_info{ style: "display:none" }
+  %br
+  %table.table.table-striped.table-hover
+    %tr
+      %th Tolerance time:
+      %th IP:
+      %th User Agent:
+      %th Referer:
+    %tr
+      %td= comment.tolerance_time || :none
+      %td= comment.ip
+      %td= comment.user_agent
+      %td= comment.referer

data/app/views/the_comments/haml/_comment_body.html.haml

@@ -0,0 +1,20 @@
+%table.comment_body.table.table-striped.table-hover
+  %tr
+    %td{ style: "width: 120px;"}
+      %b= comment.commentable_type
+      →
+    %td
+      = link_to comment.commentable_title, comment.commentable_url
+      (#{comment.try(:commentable_state)})
+  %tr
+    %td
+      %b= t('the_comments.title')
+    %td= comment.title.blank? ? t('the_comments.guest_name') : comment.title
+  %tr
+    %td
+      %b= t('the_comments.contacts')
+    %td= comment.contacts
+  %tr.success
+    %td
+      %b= t('the_comments.content')
+    %td= comment.content

data/app/views/the_comments/haml/_comment_edit.html.haml

@@ -0,0 +1,26 @@
+.edit_form{ style: "display:none" }
+  = form_for [comments, comment], remote: true, html:{ role: :form } do |f|
+    %table.table.table-striped.table-hover
+      %tr{ style: "width: 100px;"}
+        %td
+          %b= comment.commentable_type
+          →
+        %td
+          = link_to comment.commentable_title, comment.commentable_url
+          (#{comment.try(:commentable_state)})
+      %tr
+        %td
+          %b= t('the_comments.title')
+        %td= f.text_field :title, class: "form-control"
+      %tr
+        %td
+          %b= t('the_comments.contacts')
+        %td= f.text_field :contacts, class: "form-control"
+      %tr
+        %td
+          %b= t('the_comments.content')
+        %td= f.text_area  :raw_content, class: "form-control", rows: 7
+      %tr
+        %td
+        %td= f.submit t('the_comments.update'), class: "btn btn-success"
+  %hr

data/app/views/the_comments/{_form.html.haml → haml/_form.html.haml}

@@ -1,15 +1,15 @@
 %h3
-  = link_to 'New Comment', '#', id: :new_root_comment
+  = link_to t('the_comments.new'), '#', id: :new_root_comment
 
-= form_for Comment.new, remote: true, authenticity_token: true do |f|
+= form_for [comments, Comment.new], remote: true, authenticity_token: true do |f|
   .error_notifier{ style: "display:none" }
-  %label title:
+  %label= t('the_comments.form.title')
   %p= f.text_field :title
 
-  %label contacts:
+  %label= t('the_comments.form.contacts')
   %p= f.text_field :contacts
 
-  %label content*:
+  %label= t('the_comments.form.content')
   %p= f.text_area :raw_content
 
   %p.trap
@@ -22,4 +22,6 @@
   = f.hidden_field :commentable_id,   value: commentable.id
   = f.hidden_field :parent_id, class: :parent_id
 
-  %p= f.submit 'Create Comment', class: :btn
+  %p
+    = f.submit t('the_comments.form.create'), class: :btn
+    = t('the_comments.form.thank_you')

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

@@ -0,0 +1,27 @@
+- hidden = "display:none"
+
+.row.controls
+  .col-md-9
+    = link_to t('the_comments.edit'), "#", class: "edit btn btn-success"
+    = link_to t('the_comments.cancel'), "#", class: "btn btn-warning edit", style: "display:none"
+
+    - to_hide = comment.published? ? hidden : nil
+    - opts    = { remote: true, style: to_hide, method: :post }
+    = link_to [comments, :to_published, comment], opts.merge(class: "btn btn-primary to_published") do
+      = t('the_comments.to_published')
+    
+    - to_hide = comment.draft? ? hidden : nil
+    - opts    = { remote: true, style: to_hide, method: :post }
+    = link_to [comments, :to_draft, comment], opts.merge(class: "btn btn-warning to_draft") do
+      = t('the_comments.to_draft')
+
+    - to_hide = comment.deleted? ? hidden : nil
+    - opts    = { remote: true, style: to_hide, method: :delete, data: { confirm: t('the_comments.delete_confirm') } }
+    = link_to [comments, :to_deleted, comment], opts.merge(class: "btn btn-danger to_deleted") do
+      = t('the_comments.to_deleted')
+
+    - opts = { remote: true, method: :post}
+    = link_to [comments, :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/haml/_sidebar.html.haml

@@ -0,0 +1,28 @@
+- cuser = current_user
+
+.panel.panel-primary
+  .panel-heading= t "the_comments.nav.header"
+  .panel-body
+    %p= link_to raw(t('the_comments.back_to_root')), '/'
+    %hr
+
+    %h5= t 'the_comments.incoming'
+    %ul
+      %li= link_to t("the_comments.draft_comments",     num: cuser.draft_comcoms_count),     [comments, :draft,     :comments]
+      %li= link_to t("the_comments.published_comments", num: cuser.published_comcoms_count), [comments, :published, :comments]
+      %li= link_to t("the_comments.deleted_comments",   num: cuser.deleted_comcoms_count),   [comments, :deleted,   :comments]
+      %li= link_to t("the_comments.spam_comments",      num: cuser.spam_comcoms_count),      [comments, :spam,      :comments]
+
+    %h5= t 'the_comments.written_by_me'
+    %ul
+      %li= link_to t("the_comments.draft_comments",     num: cuser.my_draft_comments.count),     [comments, :my_draft,     :comments]
+      %li= link_to t("the_comments.published_comments", num: cuser.my_published_comments.count), [comments, :my_published, :comments]
+      %li= link_to t("the_comments.my_comments",        num: cuser.my_comments_count),           [comments, :my_comments,  :comments]
+
+    - if cuser.comments_admin?
+      %h5= t 'the_comments.in_system'
+      %ul
+        %li= link_to t("the_comments.draft_comments",     num: Comment.with_state(:draft).count),     [comments, :total_draft,     :comments]
+        %li= link_to t("the_comments.published_comments", num: Comment.with_state(:published).count), [comments, :total_published, :comments]
+        %li= link_to t("the_comments.deleted_comments",   num: Comment.with_state(:deleted).count),   [comments, :total_deleted,   :comments]
+        %li= link_to t("the_comments.spam_comments",      num: Comment.where(spam: true).count),      [comments, :total_spam,      :comments]

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

@@ -0,0 +1,4 @@
+.comments#comments
+  %ol.comments_tree{ data: { comments: { tolarance_time: TheComments.config.tolerance_time  } } }
+    = render partial: 'the_comments/haml/comment', locals: { tree: comments_tree }
+  = render partial: 'the_comments/haml/form', locals: { commentable: commentable }

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

@@ -0,0 +1,18 @@
+- content_for :title do
+  = t "the_comments.management"
+
+- content_for :comments_sidebar do
+  = render partial: 'the_comments/haml/sidebar'
+
+- content_for :comments_main do
+  = paginate @comments
+
+  .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/haml/comment_body', locals: { comment: comment }
+
+  = paginate @comments

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

@@ -0,0 +1,25 @@
+- content_for :title do
+  = t "the_comments.management"
+
+- content_for :comments_sidebar do
+  = render partial: 'the_comments/haml/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/haml/comment_edit', locals: { comment: comment }
+          = render partial: 'the_comments/haml/comment_body', locals: { comment: comment }
+
+          = render partial: 'the_comments/haml/manage_controls', locals: { comment: comment }
+          = render partial: 'the_comments/haml/additional_info', locals: { comment: comment }
+        
+  = paginate @comments

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

@@ -0,0 +1,28 @@
+- cuser = current_user
+
+- content_for :title do
+  = t "the_comments.management"
+
+- content_for :comments_sidebar do
+  = render partial: 'the_comments/haml/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/haml/comment_body', locals: { comment: comment }
+          
+          - if cuser.comments_admin?
+            = render partial: 'the_comments/haml/comment_edit',    locals: { comment: comment }
+            = render partial: 'the_comments/haml/manage_controls', locals: { comment: comment }
+            = render partial: 'the_comments/haml/additional_info', locals: { comment: comment }
+        
+  = paginate @comments

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

@@ -0,0 +1,13 @@
+.additional_info  style: "display:none"  
+  br
+  table.table.table-striped.table-hover
+    tr
+      th Tolerance time:
+      th IP:
+      th User Agent:
+      th Referer:
+    tr
+      td= comment.tolerance_time || :none
+      td= comment.ip
+      td= comment.user_agent
+      td= comment.referer

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

@@ -0,0 +1 @@
+= build_server_tree(tree, render_module: RenderCommentsTreeHelper, controller: controller)

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

@@ -0,0 +1,20 @@
+table.comment_body.table.table-striped.table-hover
+  tr
+    td  style: "width: 120px;" 
+      b= comment.commentable_type
+      | →
+    td
+      = link_to comment.commentable_title, comment.commentable_url
+      | (#{comment.try(:commentable_state)})
+  tr
+    td
+      b= t('the_comments.title')
+    td= comment.title.blank? ? t('the_comments.guest_name') : comment.title
+  tr
+    td
+      b= t('the_comments.contacts')
+    td= comment.contacts
+  tr.success
+    td
+      b= t('the_comments.content')
+    td= comment.content

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

@@ -0,0 +1,26 @@
+.edit_form  style: "display:none"  
+  = form_for [comments, comment], remote: true, html:{ role: :form } do |f|
+    table.table.table-striped.table-hover
+      tr  style: "width: 100px;" 
+        td
+          b= comment.commentable_type
+          | →
+        td
+          = link_to comment.commentable_title, comment.commentable_url
+          | (#{comment.try(:commentable_state)})
+      tr
+        td
+          b= t('the_comments.title')
+        td= f.text_field :title, class: "form-control"
+      tr
+        td
+          b= t('the_comments.contacts')
+        td= f.text_field :contacts, class: "form-control"
+      tr
+        td
+          b= t('the_comments.content')
+        td= f.text_area  :raw_content, class: "form-control", rows: 7
+      tr
+        td
+        td= f.submit t('the_comments.update'), class: "btn btn-success"
+  hr

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

@@ -0,0 +1,27 @@
+h3
+  = link_to t('the_comments.new'), '#', id: :new_root_comment
+
+= form_for [comments, Comment.new], remote: true, authenticity_token: true do |f|
+  .error_notifier  style: "display:none"  
+  label= t('the_comments.form.title')
+  p= f.text_field :title
+
+  label= t('the_comments.form.contacts')
+  p= f.text_field :contacts
+
+  label= t('the_comments.form.content')
+  p= f.text_area :raw_content
+
+  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/_manage_controls.html.slim

@@ -0,0 +1,27 @@
+- hidden = "display:none"
+
+.row.controls
+  .col-md-9
+    = link_to t('the_comments.edit'), "#", class: "edit btn btn-success"
+    = link_to t('the_comments.cancel'), "#", class: "btn btn-warning edit", style: "display:none"
+
+    - to_hide = comment.published? ? hidden : nil
+    - opts    = { remote: true, style: to_hide, method: :post }
+    = link_to [comments, :to_published, comment], opts.merge(class: "btn btn-primary to_published") do
+      = t('the_comments.to_published')
+    
+    - to_hide = comment.draft? ? hidden : nil
+    - opts    = { remote: true, style: to_hide, method: :post }
+    = link_to [comments, :to_draft, comment], opts.merge(class: "btn btn-warning to_draft") do
+      = t('the_comments.to_draft')
+
+    - to_hide = comment.deleted? ? hidden : nil
+    - opts    = { remote: true, style: to_hide, method: :delete, data: { confirm: t('the_comments.delete_confirm') } }
+    = link_to [comments, :to_deleted, comment], opts.merge(class: "btn btn-danger to_deleted") do
+      = t('the_comments.to_deleted')
+
+    - opts = { remote: true, method: :post}
+    = link_to [comments, :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,28 @@
+- cuser = current_user
+
+.panel.panel-primary
+  .panel-heading= t "the_comments.nav.header"
+  .panel-body
+    p= link_to raw(t('the_comments.back_to_root')), '/'
+    hr
+
+    h5= t 'the_comments.incoming'
+    ul
+      li= link_to t("the_comments.draft_comments",     num: cuser.draft_comcoms_count),     [comments, :draft,     :comments]
+      li= link_to t("the_comments.published_comments", num: cuser.published_comcoms_count), [comments, :published, :comments]
+      li= link_to t("the_comments.deleted_comments",   num: cuser.deleted_comcoms_count),   [comments, :deleted,   :comments]
+      li= link_to t("the_comments.spam_comments",      num: cuser.spam_comcoms_count),      [comments, :spam,      :comments]
+
+    h5= t 'the_comments.written_by_me'
+    ul
+      li= link_to t("the_comments.draft_comments",     num: cuser.my_draft_comments.count),     [comments, :my_draft,     :comments]
+      li= link_to t("the_comments.published_comments", num: cuser.my_published_comments.count), [comments, :my_published, :comments]
+      li= link_to t("the_comments.my_comments",        num: cuser.my_comments_count),           [comments, :my_comments,  :comments]
+
+    - if cuser.comments_admin?
+      h5= t 'the_comments.in_system'
+      ul
+        li= link_to t("the_comments.draft_comments",     num: Comment.with_state(:draft).count),     [comments, :total_draft,     :comments]
+        li= link_to t("the_comments.published_comments", num: Comment.with_state(:published).count), [comments, :total_published, :comments]
+        li= link_to t("the_comments.deleted_comments",   num: Comment.with_state(:deleted).count),   [comments, :total_deleted,   :comments]
+        li= link_to t("the_comments.spam_comments",      num: Comment.where(spam: true).count),      [comments, :total_spam,      :comments]

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

@@ -0,0 +1,4 @@
+.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: :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 }
+
+  = paginate @comments

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

@@ -0,0 +1,25 @@
+- 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_edit', locals: { comment: comment }
+          = render partial: 'the_comments/slim/comment_body', 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