the_comments 0.9.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.rvmrc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in the_comments.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ilya N. Zykin
+
+MIT License
+
+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,248 @@
+# TheComments 0.9.0
+
+TheComments - probably, best solution for comments for Ruby on Rails.
+
+### What's wrong with other gems?
+
+Just look at [Ruby-Toolbox](https://www.ruby-toolbox.com/categories/rails_comments). What we can see?
+
+* [Acts as commentable with threading](https://github.com/elight/acts_as_commentable_with_threading) - so, guys, where is the render helper for the tree? There is no helper! Should  I make render helper for tree by myself? Nooooo!!! I'm so sorry, but I can't use this gem. 
+* [acts_as_commentable](https://github.com/jackdempsey/acts_as_commentable) - so, I can see code for models. But I can't see code for controllers and views. Unfortunately, there is no threading. It's not enough for me.
+* [opinio](https://github.com/Draiken/opinio) - looks better, but there is no threading. I want to have more!
+* [has_threaded_comments](https://github.com/aarongough/has_threaded_comments) - Nice work! Nice gem! Models, controllers, views, view helper for tree rendering! **But**, last activity 2 years ago, I need few features, I think - I can make it better.
+
+### In sum
+
+![TheComments](https://raw.github.com/open-cook/the_comments/master/the_comments.jpg)
+
+### My hopes about comments system
+
+* Open comments for everybody (by default). *I hate user registration*
+* Moderation for comments and simple Admin UI
+* Spam traps instead Captcha. *I hate Captcha*
+* Blacklists for IP and UserAgent
+* Comment counters for commentable objects and User
+* Denormalization for fast and Request-free comment list building
+* Ready for external content filters ( **sanitize**, **RedCloth**, **Markdown**)
+* Ready for Rails4 (and Rails::Engine)
+* Delete without destroy
+
+### Requires
+
+```ruby
+gem 'awesome_nested_set'
+gem 'the_sortable_tree'
+gem 'state_machine'
+```
+
+### Anti Spam system
+
+User agent must have:
+
+* Cookies support
+* JavaScript and Ajax support
+
+_Usually spambot not support Cookies and JavaScript_
+
+Comment form has:
+
+* fake (hidden) fields
+
+_Usually spam bot puts data in fake inputs_
+
+Trap via time:
+
+* User should be few seconds on page, before comment sending (by default 5 sec)
+
+_Usually spam bots works faster, than human. We can try to use this feature of behavior_
+
+## Installation
+
+```ruby
+gem 'the_comments'
+```
+
+**bundle**
+
+```ruby
+bundle exec rails g the_comment install
+```
+
+### Assets
+
+**app/assets/javascripts/application.js**
+
+```js
+//= require the_comments
+```
+
+**app/assets/stylesheets/application.css**
+
+```css
+/*
+ *= require the_comments
+*/
+```
+
+### User Model
+
+```ruby
+class User < ActiveRecord::Base
+  # Your implementation of role policy
+  def admin?
+    self == User.first
+  end
+
+  # include TheComments methods
+  include TheCommentsUser
+  
+  # denormalization for commentable objects
+  def commentable_title
+    login
+  end
+
+  def commentable_url
+    [class.to_s.tableize, login].join('/')
+  end
+
+  # Comments moderator checking (simple example)
+  # Usually comment's holder should be moderator
+  def comment_moderator? comment
+    admin? || id == comment.holder_id
+  end
+
+end
+```
+
+**User#coments** - comments. Set of all created comments
+
+```ruby
+User.first.comments
+# => Array of comments, where User is creator (owner)
+```
+
+**User#comcoms** - commentable comments. Set of all comments of all owned commentable objects of this user.
+
+```ruby
+User.first.comcoms
+# => Array of all comments of all owned commentable objects, where User is holder
+# Usually comment's holder should be moderator of this comments
+# because this user should maintain cleaness of his commentable objects
+```
+
+**Attention!** You should be sure that you understand who is owner, and who is holder of comments!
+
+### Commentable Model (Page, Blog, Article, User ...)
+
+**Attention!** User model can be commentable object also.
+
+```ruby
+class Blog < ActiveRecord::Base
+  # include TheComments methods
+  include TheCommentsCommentable
+
+  # (!) Every commentable Model must have next 2 methods
+  # denormalization for commentable objects
+  def commentable_title
+    # "My first blog post"
+    title
+  end
+
+  def commentable_url
+    # blogs/1-my-first-blog-post
+    [self.class.to_s.tableize, slug_id].join('/')
+  end
+end
+```
+
+### Comment Model
+
+```ruby
+class Comment < ActiveRecord::Base
+  # include TheComments methods
+  include TheCommentsBase
+
+  # 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
+
+  # Simple way to define avatar url
+  def avatar_url
+    hash = Digest::MD5.hexdigest self.id.to_s
+    "http://www.gravatar.com/avatar/#{hash}?s=30&d=identicon"
+  end
+
+  # Define your filters for content
+  # Expample for: gem 'RedCloth', gem 'sanitize'
+  # your personal SmilesProcessor
+  def prepare_content
+    text = self.raw_content
+    text = RedCloth.new(text).to_html
+    text = SmilesProcessor.new(text)
+    text = Sanitize.clean(text, Sanitize::Config::RELAXED)
+    self.content = text
+  end
+end
+```
+
+### IP, User Agent black lists
+
+Models must looks like this:
+
+```ruby
+class IpBlackList < ActiveRecord::Base
+  include TheCommentsBlackUserAgent
+end
+
+class UserAgentBlackList < ActiveRecord::Base
+  include TheCommentsBlackIp
+end
+```
+
+### Commentable controller
+
+```ruby
+class BlogsController < ApplicationController
+  include TheCommentsController::Cookies
+  include TheCommentsController::ViewToken
+
+  def show
+    @blog     = Blog.where(id: params[:id]).with_states(:published).first
+    @comments = @blog.comments.with_state([:draft, :published]).nested_set
+  end
+end
+```
+
+### View
+
+```ruby
+%h1= @blog.title
+%p=  @blog.content
+
+= render partial: 'comments/tree', locals: { comments_tree: @comments, commentable: @blog }
+```
+
+## Configuration
+
+**config/initializers/the_comments.rb**
+
+```ruby
+TheComments.configure do |config|
+  config.max_reply_depth = 3                                # 3 by default
+  config.tolerance_time  = 15                               # 5 (sec) by default
+  config.empty_inputs    = [:email, :message, :commentBody] # [:message] by default
+end
+```
+
+* **max_reply_depth** - comments tree nesting by default
+* **tolerance_time** - how many seconds user should spend on page, before comment send
+* **empty_inputs** - names of hidden (via css) fields for spam detecting
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

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

@@ -0,0 +1,104 @@
+# ERROR MSG BUILDER
+@error_text_builder = (errors) ->
+  error_msgs = ''
+  for error in errors
+    error_msgs += "<p><b>#{ error }</b></p>"
+  error_msgs
+
+# FORM CLEANER
+@clear_comment_form = ->
+  $('.error_notifier', '#new_comment, .comments_tree').hide()
+  $("input[name='comment[title]']").val('')
+  $("textarea[name='comment[raw_content]']").val('')
+
+# NOTIFIER
+@comments_error_notifier = (form, text) ->
+  form.children('.error_notifier').empty().hide().append(text).show()
+
+# JUST HELPER
+@unixsec = (t) -> Math.round(t.getTime() / 1000)
+
+# HIGHTLIGHT ANCHOR
+@highlight_anchor = ->
+  hash = document.location.hash
+  if hash.match('#comment_')
+    $(hash).addClass 'highlighted'
+
+$ ->
+  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()
+    time_diff = unixsec(new Date) - window.tolerance_time_start
+
+    if tolerance_time && (time_diff < tolerance_time)
+      delta  = tolerance_time - time_diff
+      error_msgs = error_text_builder(["Please wait #{delta} secs"])
+      comments_error_notifier(form, error_msgs)
+      return false
+
+    $('.tolerance_time').val time_diff
+    button.prop 'disabled', true
+    true
+
+  # AJAX ERROR
+  $(document).on 'ajax:error', comment_forms, (request, response, status) ->
+    form = $ @
+    $('input[type=submit]', form).prop 'disabled', false
+    error_msgs = error_text_builder(["Server Error: #{response.status}"])
+    comments_error_notifier(form, error_msgs)
+
+  # COMMENT FORMS => SUCCESS
+  $(document).on 'ajax:success', comment_forms, (request, response, status) ->
+    form = $ @
+    $('input[type=submit]', form).prop 'disabled', false
+
+    if typeof(response) is 'string'
+      anchor = $(response).find('.comment').attr('id')
+      clear_comment_form()
+      form.hide()
+      $('.parent_id').val('')
+      $('#new_comment').fadeIn()
+      tree = form.parent().siblings('.nested_set')
+      tree = $('ol.comments_tree') if tree.length is 0
+      tree.append(response)
+      document.location.hash = anchor
+    else
+      error_msgs = error_text_builder(response.errors)
+      comments_error_notifier(form, error_msgs)
+
+  # NEW ROOT BUTTON
+  $(document).on 'click', '#new_root_comment', ->
+    $('.reply_comments_form').hide()
+    $('.parent_id').val('')
+    $('#new_comment').fadeIn()
+    false
+
+  # REPLY BUTTON
+  $(document).on 'click', '.reply_link', ->
+    link    = $ @
+    comment = link.parent().parent().parent()
+  
+    $(comment_forms).hide()
+    form = $('#new_comment').clone().removeAttr('id').addClass('reply_comments_form')
+
+    comment_id = comment.data('comment-id')
+    $('.parent_id', form).val comment_id
+
+    comment.siblings('.form_holder').html(form)
+    form.fadeIn()
+    false
+
+$ ->
+  # ANCHOR HIGHLIGHT
+  highlight_anchor()
+
+  $(window).on 'hashchange', ->
+    $('.comment.highlighted').removeClass 'highlighted'
+    highlight_anchor()

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

@@ -0,0 +1,59 @@
+$ ->
+  # CONTROLS
+  holder = $('.comments_list')
+  
+  holder.on 'ajax:success', '.to_published', (request, response, status) ->
+    link = $ @
+    log link.parents('.item')
+    link.parents('.item').first().attr('class', 'item published')
+
+  holder.on 'ajax:success', '.to_draft', (request, response, status) ->
+    link = $ @
+    log link.parents('.item')
+    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()
+
+  # 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()
+
+  # FOR MANAGE SECTION
+  list = $('.comments_list')
+
+  list.on 'click', '.controls a.view', ->
+    form = $(@).parents('div.form')
+    body = form.siblings('.body')  
+    body.show()
+    form.hide()
+    false
+
+  list.on 'click', '.controls a.edit', ->
+    body = $(@).parents('div.body')
+    form = body.siblings('.form')
+    body.hide()
+    form.show()
+    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'
+
+  holder.on 'ajax:success', '.to_banned', (request, response, status) ->
+    link = $ @
+    li = link.parents('li').first()
+    li.attr 'class', 'banned'
+    li.find('.state').html 'banned'

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

@@ -0,0 +1,251 @@
+.comments_tree, .comments_list, .black_list{  
+  font-family: Arial;
+
+  margin:0; padding:0;
+  *{ margin: 0; padding: 0; }
+
+  a{ text-decoration: none; }
+  a:hover{ text-decoration: underline; }
+
+  ol{
+    margin: 0;
+    padding: 0 0 0 20px;
+    list-style: none outside none;
+  }
+  li{
+    margin-bottom: 5px;
+    position: relative;
+    list-style: none outside none;
+  }
+}
+
+.comments, .comments_tree{
+  font-family: Arial;
+  font-size: 13px;
+
+  .error_notifier{    
+    background-color: #F2DEDE;
+    border-color: #EED3D7;
+    color: #B94A48;
+    
+    border-radius: 4px;
+    margin: 0 0 15px 0;
+    padding: 10px 10px 0 10px;
+    overflow: hidden;
+
+    p{ margin: 0 0 10px 0; }
+  }
+  form{
+    background: white;
+    border: 1px solid gray;
+    border-radius: 3px;
+    padding: 10px;
+    
+    p{ margin: 0 0 10px 0; }
+
+    input[type=text]{
+      border: 1px solid gray;
+      padding: 4px;
+      width: 75%;
+    }
+    textarea{
+      border: 1px solid gray;
+      font-family: Arial;
+      font-size: 13px;
+      height: 150px;
+      padding: 4px;
+      width: 75%;
+    }
+    .trap{
+      margin: 0; padding: 0;
+      filter: alpha(opacity=0.001);
+      height: 0.1px;
+      opacity: 0.001;
+      overflow: hidden;
+    }
+  }
+}
+
+.comments_tree{
+  .nested_set{
+    border-left: 1px dotted lightGray;
+  }
+
+  li{
+    .comment.draft{
+      border: 1px solid gray;
+      background: lightGray;
+      padding: 10px;
+    }
+  }
+
+  .form_holder{ margin-left: 40px; }
+  
+  .edit{
+    margin-bottom: 3px;
+    text-align:center;
+    line-height: 130%;
+    background: #336;
+    color: white;
+    padding: 1px;
+  }
+
+  .comment{
+    overflow: hidden; zoom: 1;
+
+    .userpic{
+      overflow: hidden; zoom: 1;
+      float: left;
+      width: 50px;
+
+      img{ margin-bottom: 10px; }
+    }
+    .userbar, .cbody{
+      margin: 0 0 5px 55px;
+      padding: 3px;
+    }
+    .userbar{
+      background: #ddd;
+      border-radius: 3px;
+      padding-left: 7px;
+    }
+    &.draft{
+      .userbar{ background: #EED3D7; }
+      .to_draft{ display: none; }
+    }
+    &.published{
+      .to_published{ display: none; }
+    }
+    .cbody{
+      border-bottom: 1px solid LightGray;
+      padding-bottom: 10px;
+      line-height: 135%;
+      margin-bottom: 0;
+    }
+    .reply{
+      margin: 0 0 5px 55px;
+      font-size: 12px;
+    }
+  }
+
+  .controls{
+    a{
+      font-size:11px;
+      display:block;
+    }
+  }
+
+  .comment{
+    margin-bottom: 10px;
+
+    &.published, &.draft{
+      margin-bottom: 10px;
+      border-radius: 3px;
+      padding: 5px;
+    }
+    &.highlighted{ border: 1px dashed #ff6633; }
+
+  }
+
+  .form_holder{
+    form{ margin: 10px 0; } 
+  }
+}
+
+.new_comment{
+  .btn{
+    padding: 7px;
+    margin-top: 5px;
+    cursor: pointer;
+  }
+}
+
+.comments_list{
+  li{
+    margin-bottom: 20px;
+
+    .item{
+      border: 1px solid gray;
+      border-radius: 5px;
+      padding: 10px;
+    }
+
+    .draft{
+      border-left: 5px solid orange;
+
+      .controls{
+        a.to_draft{ display: none }   
+      }
+    }
+    .published{
+      border-left: 5px solid green;
+
+      .controls{
+        a.to_published{ display: none; }
+      }
+    }
+
+    .deleted{
+      border-left: 5px solid red;
+
+      .controls{
+        a.to_deleted, a.to_spam{ display: none; }
+      }
+    }
+
+    .comment{
+      div{ margin: 0 0 10px 0; }
+
+      label{
+        width: 75px;
+        font-weight: bold;
+        display: inline-block;
+      }
+      input[type=text]{
+        width: 70%;
+        padding: 4px;
+      }
+      input[type=submit]{
+        padding: 5px;
+        cursor: pointer;
+      }
+      textarea{
+        width: 70%;
+        padding: 4px;
+        height: 150px;
+      }
+      .content{
+        line-height: 130%;
+        background: #ddd;
+        padding: 10px;
+      }
+      .commentable{
+        margin-bottom: 10px;
+      }
+      .controls{
+        background: lightgray;
+        padding: 3px;
+        a{ margin-right: 15px; }
+      }
+    }
+  }
+}
+
+.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;
+  }
+}