the_comments_ruby 2.3.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 416d9f10942340f874cbe6ed2492774421cc2289
+  data.tar.gz: cc690194ff545305a7ebc455acccd3f5bac96168
+SHA512:
+  metadata.gz: 624ea547016b3b7a23e7aa9934ac6194f348134caabb28c694521ae652c19b16956972d69fa95a3e91b20b9de1851acb9ced1ad280d89b73e7630dbc150dc327
+  data.tar.gz: 752e3865a7e80f19f535d9ef4a094591536e6e77ffe8623dd2a6a1a63dd6b6bd61a7ce0e8e1d94e6320eb1f683691b6e4f2b10957f75a4eaf9f6d5b1df09c694

data/.gitignore

@@ -0,0 +1,30 @@
+*.gem
+*.rbc
+
+.bundle
+.config
+.yardoc
+.idea
+.rvmrc
+.ruby-gemset
+.ruby-version
+
+_yardoc
+coverage
+Gemfile.lock
+InstalledFiles
+lib/bundler/man
+spec/dummy_app/public/assets
+
+tmp
+doc
+pkg
+rdoc
+
+test/tmp
+spec/reports
+test/version_tmp
+
+.DS_Store
+.LSOverride
+.AppleDouble

data/.ruby-gemset.example

@@ -0,0 +1 @@
+the_comments

data/.ruby-version.example

@@ -0,0 +1 @@
+ruby-2.0.0-p353

data/.rvmrc.example

@@ -0,0 +1 @@
+rvm use ruby-2.0.0-p353@the_comments --create

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+gemfile: spec/dummy_app/Gemfile
+script: "cd spec/dummy_app && rake db:bootstrap RAILS_ENV=test && rspec --format documentation"

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,338 @@
+# TheComments
+
+[![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 - The best Rails gem for blog-style comments
+
+:question:   [Why is TheComments better than other gems?](docs/whats_wrong_with_other_gems.md#why-thecomments-is-better-than-others-gems)
+
+### 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
+* Production-ready commenting system for Rails 4+
+* Designed for preprocessors such as Sanitize, Textile, Markdown etc.
+
+### :books:   [Documentation](docs/documentation.md)
+
+## If you have any questions
+
+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 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
+
+**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**
+
+```ruby
+gem "the_comments", "~> 2.2.1"
+
+gem 'haml'                # or gem 'slim'
+gem 'awesome_nested_set'  # or same gem
+```
+
+**Bundle**
+
+```
+bundle
+```
+
+Don't forget to restart your server!
+
+### 2. Add migrations
+
+```
+rake the_comments_engine:install:migrations
+```
+
+Will create:
+
+* xxxxx_change_user.rb
+* xxxxx_create_comments.rb
+* xxxxx_change_commentable.rb
+
+:warning:   **Open and change xxxxx_change_commentable.rb migration**
+
+```ruby
+class ChangeCommentable < ActiveRecord::Migration
+  def change
+    # Additional fields to Commentable Models
+    # [:posts, :articles, ... ]
+
+    # There is only Post model is commentable
+    [:posts].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
+```
+
+: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 installation
+
+```ruby
+rails g the_comments install
+```
+
+Will create:
+
+* config/initializers/the_comments.rb
+* app/controllers/comments_controller.rb
+* app/models/comment.rb
+ 
+:warning: &nbsp; **Open each file and follow the instructions**
+
+### 4. Models modifictions
+
+**app/models/user.rb**
+
+```ruby
+class User < ActiveRecord::Base
+  include TheComments::User
+
+  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
+
+  def comments_moderator? comment
+    id == comment.holder_id
+  end
+end
+```
+
+**app/models/post.rb**
+
+```ruby
+class Post < ActiveRecord::Base
+  include TheComments::Commentable
+
+  belongs_to :user
+
+  # Denormalization methods
+  # Check the documentation for information on advanced usage
+  def commentable_title
+    "Undefined Post Title"
+  end
+
+  def commentable_url
+    "#"
+  end
+
+  def commentable_state
+    "published"
+  end
+end
+```
+
+### 5. Add routes
+
+**config/routes.rb**
+
+```ruby
+MyApp::Application.routes.draw do
+  root 'posts#index'
+  resources :posts
+
+  # ...
+
+  # TheComments routes
+  concern   :user_comments,  TheComments::UserRoutes.new
+  concern   :admin_comments, TheComments::AdminRoutes.new
+  resources :comments, concerns:  [:user_comments, :admin_comments]
+end
+```
+
+Refer to the [documentation](docs/documentation.md) for more information
+
+### 6. Add to Application Controller
+
+**app/controllers/application_controller.rb**
+
+```ruby
+class ApplicationController < ActionController::Base
+  include TheComments::ViewToken
+
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end
+```
+
+### 7. Install assets
+
+**app/assets/stylesheets/application.css**
+
+```css
+/*
+ *= require the_comments
+*/
+```
+
+**app/assets/javascripts/application.js**
+
+```js
+//= require the_comments
+```
+
+### 8. Example controller code
+
+**app/controllers/posts_controller.rb**
+
+```ruby
+def show
+  @post     = Post.find params[:id]
+  @comments = @post.comments.with_state([:draft, :published])
+end
+```
+
+### 9. Example view code
+
+**app/views/posts/show.html.haml**
+
+```haml
+= render partial: 'the_comments/tree', locals: { commentable: @post, comments_tree: @comments }
+```
+
+<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**
+
+### Acknowledgments
+
+* Anna Nechaeva (my wife) - for love and my happy life
+* @tanraya (Andrew Kozlov) - for code review
+* @solenko (Anton Petrunich) - for mountable routes
+* @pyromaniac (Arkadiy Zabazhanov) - for consulting
+
+<hr>
+
+### MIT License
+
+Copyright (c) 2013 Ilya N. Zykin
+
+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/Rakefile

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

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

@@ -0,0 +1,108 @@
+# ERROR MSG BUILDER
+@comments_errors_builder = (errors) ->
+  error_msgs = ''
+  for field, errs of errors
+    for err in errs
+      error_msgs += "<p><b>#{ field }:</b> #{ err }</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()
+
+# TIME 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)
+  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 = comments_errors_builder({ delay: ["Please wait #{delta} secs"] })
+      comments_error_notifier(form, error_msgs)
+      return false
+
+    $('.tolerance_time').val time_diff
+    button.hide()
+    true
+
+  ################ 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 = comments_errors_builder({ "Server Error: ": [response.status] })
+    comments_error_notifier(form, error_msgs)
+
+  # SUCCESS
+  $(document).on 'ajax:success', comment_forms, (request, response, status) ->
+    form = $ @
+    $('input[type=submit]', form).show()
+
+    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 = comments_errors_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)
+    $('.error_notifier', form).empty().hide()
+    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,27 @@
+$ ->
+  hide_comment_panel = (btn) -> $(btn).parents('.panel').slideUp()
+
+  comments = $ '.comments'
+
+  # CONTROLS
+  comments.on 'click', 'a.additional_info', ->
+    btn    = $ @
+    holder = btn.parents('.panel-body')
+    holder.find('div.additional_info').slideToggle()
+    false
+
+  comments.on 'click', 'a.edit', ->
+    btn    = $ @
+    holder = btn.parents('.panel-body')
+    holder.find('.edit_form, .comment_body, a.edit').toggle()
+    false
+
+  comments.on 'ajax:success', '.to_published, .to_draft, .to_spam, .to_deleted', ->
+    hide_comment_panel @
+
+  # 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