the_comments 0.9.0

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

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

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

@@ -0,0 +1,19 @@
+= paginate @comments
+
+%ol.comments_list
+  - @comments.each do |comment|
+    %li
+      .item{ class: comment.state }
+        .body
+          .commentable
+            = comment.commentable_type
+            \:
+            = link_to comment.commentable_title, comment.commentable_url
+          .comment
+            .title
+              %b from:
+              = comment.title.blank? ? t('the_comments.guest_name') : comment.title
+            .content
+              = comment.content
+
+= paginate @comments

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

@@ -0,0 +1,29 @@
+= paginate @comments
+
+%ol.comments_list
+  - @comments.each do |comment|
+    %li
+      .item{ class: comment.state }
+        .body
+          = render partial: 'the_comments/comment_body', locals: { comment: comment }
+        .form.comment{ style: 'display:none' }
+          = form_for comment, remote: true do |f|
+            .commentable
+              = comment.commentable_type
+              →
+              = link_to comment.commentable_title, comment.commentable_url
+            .title
+              %label from:
+              = f.text_field :title
+            .contacts
+              %label contacts:
+              = f.text_field :contacts
+            .content
+              = f.text_area  :raw_content
+            .submit
+              = f.submit
+          .controls
+            = link_to :View, '#', class: :view
+            = render partial: 'the_comments/manage_controls', locals: { comment: comment }
+
+= paginate @comments

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

@@ -0,0 +1,17 @@
+- unless @ip_black_lists.blank?
+  %ol.black_list
+    - @ip_black_lists.each do |black|
+      %li{ class: black.state }
+        %p
+          %b user_agent:
+          = black.user_agent
+          %b count:
+          = black.count
+          %b state:
+          %span.state= black.state
+        %p
+          %b action: 
+          = link_to :warning, user_agent_black_list_to_state_path(black, state: :warning), remote: true, method: :patch, class: :to_warning
+          = link_to :banned,  user_agent_black_list_to_state_path(black, state: :banned),  remote: true, method: :patch, class: :to_banned
+- else
+  %p= t('the_comments.item_not_found')

data/config/locales/en.yml

@@ -0,0 +1,43 @@
+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:
+    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"
+
+    cookies: Cookies
+    cookies_required: 'Please enable cookies and try to reload page'
+
+    ajax_requests_required: 'Sorry, JavaScript/Ajax Requests required'
+
+    black_ip: Black IP adress
+    black_ip_message: Sorry! Your IP banned
+
+    black_user_agent: Black User Agent
+    black_user_agent_message: Sorry! Your User Agent banned
+
+    guest_name: Guest
+    reply: Reply to this comment
+    edit: Edit
+    to_spam: Spam!
+    to_draft: Draft
+    to_published: Publicate
+    to_deleted:   Delete
+
+    delete_confirm: Are you sure?
+
+    waiting_for_moderation: Waiting for moderation
+    item_not_found: Black list Item not found

data/config/routes.rb

@@ -0,0 +1,24 @@
+Rails.application.routes.draw do
+  resources :ip_black_lists do
+    patch :to_state
+  end
+
+  resources :user_agent_black_lists do 
+    patch :to_state
+  end
+
+  resources :comments do
+    collection do
+      get :my
+      get :incoming
+      get :trash
+    end
+
+    member do
+      post   :to_spam
+      post   :to_draft
+      post   :to_published
+      delete :to_trash
+    end
+  end
+end

data/db/migrate/20130101010101_create_comments.rb

@@ -0,0 +1,81 @@
+# null: false => de-facto db-level validation
+class CreateComments < 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
+
+      # nested set
+      t.integer :parent_id
+      t.integer :lft
+      t.integer :rgt
+      t.integer :depth, default: 0
+
+      t.timestamps
+    end
+
+    # Black Lists
+    create_table :ip_black_lists do |t|
+      t.string  :ip
+      t.integer :count, default: 0
+      t.string  :state, default: :warning
+    end
+
+    create_table :user_agent_black_lists do |t|
+      t.string  :user_agent
+      t.integer :count, default: 0
+      t.string  :state, default: :warning
+    end
+
+    # Add fields to User and Commentable Object
+    change_table :users do |t|
+      # commentable's comments => comcoms (cache)
+      # 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
+    end
+
+    # Uncomment this. Add fields to User model and Commentable models
+    #
+    # [:users, :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

data/lib/generators/the_comments/USAGE

@@ -0,0 +1,29 @@
+Description:
+  TheComments generator will copy files for organize comment's tree in your web project
+
+This text:
+  bundle exec rails g the_comments --help
+
+Generators:
+  bundle exec rails g the_comments install
+
+  This will create:
+   config/initializers/the_comments.rb
+   app/controllers/comments_controller.rb
+   app/controllers/ip_black_lists_controller.rb
+   app/controllers/user_agent_black_lists_controller.rb
+
+  bundle exec rails g the_comments controllers
+
+  This will create:
+    app/controllers/comments_controller.rb
+    app/controllers/ip_black_lists_controller.rb
+    app/controllers/user_agent_black_lists_controller.rb
+
+View Generators:
+  bundle exec rails g the_comments:views assets
+  bundle exec rails g the_comments:views helper
+  bundle exec rails g the_comments:views views
+
+Migrations:
+  bundle exec rake the_comments_engine:install:migrations

data/lib/generators/the_comments/templates/comments_controller.rb

@@ -0,0 +1,25 @@
+class CommentsController < ApplicationController
+  # Define your restrict methods and use them like this:
+  #
+  # before_action :user_required,      except: [:index, :create]
+  # 
+  # before_action :owner_required,     only: [:my, :incoming, :edit, :trash]
+  # before_action :moderator_required, only: [:update, :to_published, :to_draft, :to_spam, :to_trash]
+
+  include TheCommentsController::Base
+
+  # Public methods:
+  #
+  # [:index, :create]
+
+  # Application side methods:
+  # Overwrite following default methods if it's need
+  # Following methods based on *current_user* helper method
+  #
+  # [:my, :incoming, :edit, :trash]
+
+  # You must protect following methods
+  # Only comments moderator (holder or admin) can invoke following actions
+  #
+  # [:update, :to_published, :to_draft, :to_spam, :to_trash]
+end

data/lib/generators/the_comments/templates/ip_black_lists_controller.rb

@@ -0,0 +1,10 @@
+class IpBlackListsController < ApplicationController
+  # Define your restrict methods and use them like this:
+  # 
+  # before_action :user_required
+  # before_action :admin_required
+  # 
+  # Only Admin should have an access to following methods
+  # Methods: [:index, :to_state]
+  include TheCommentsIpController
+end

data/lib/generators/the_comments/templates/the_comments.rb

@@ -0,0 +1,7 @@
+# TheComments.config.param_name => value
+
+TheComments.configure do |config|
+  config.max_reply_depth = 3
+  config.tolerance_time  = 5
+  config.empty_inputs    = [:commentBody]
+end

data/lib/generators/the_comments/templates/user_agent_black_lists_controller.rb

@@ -0,0 +1,10 @@
+class UserAgentBlackListsController < ApplicationController
+  # Define your restrict methods and use them like this:
+  # 
+  # before_action :user_required
+  # before_action :admin_required
+  # 
+  # Only Admin should have an access to following methods
+  # Methods: [:index, :to_state]
+  include TheCommentsUserAgentController
+end

data/lib/generators/the_comments/the_comments_generator.rb

@@ -0,0 +1,32 @@
+class TheCommentsGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+  # argument :xname, type: :string, default: :xname
+
+  def generate_controllers
+    if gen_name == 'install'
+      cp_setup
+      cp_controllers
+    elsif gen_name == 'controllers'
+      cp_controllers
+    else
+      puts 'TheComments Generator - wrong Name'
+      puts 'Try to use [install|controllers]'
+    end
+  end
+
+  private
+
+  def gen_name
+    name.to_s.downcase
+  end
+
+  def cp_setup
+    copy_file 'the_comments.rb', 'config/initializers/the_comments.rb'
+  end
+
+  def cp_controllers
+    copy_file 'comments_controller.rb',               'app/controllers/comments_controller.rb'
+    copy_file 'ip_black_lists_controller.rb',         'app/controllers/ip_black_lists_controller.rb'
+    copy_file 'user_agent_black_lists_controller.rb', 'app/controllers/user_agent_black_lists_controller.rb'
+  end
+end

data/lib/generators/the_comments/views_generator.rb

@@ -0,0 +1,41 @@
+module TheComments
+  module Generators
+    class ViewsGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path('../../../../app/views', __FILE__)
+
+      def self.banner
+<<-BANNER.chomp
+
+bundle exec rails g the_comments:views assets
+bundle exec rails g the_comments:views views
+bundle exec rails g the_comments:views helper
+
+BANNER
+      end
+
+      def copy_sortable_tree_files
+        copy_gem_files
+      end
+
+      private
+
+      def param_name
+        name.downcase
+      end
+
+      def copy_gem_files
+        if param_name == 'assets'
+          copy_file "../assets/javascripts/the_comments", "app/assets/javascripts/the_comments"
+          copy_file "../assets/stylesheets/the_comments", "app/assets/stylesheets/the_comments"
+        elsif param_name == 'views'
+          directory "../views/the_comments", "app/views/the_comments"
+        elsif param_name == 'helper'
+          copy_file "../helpers/render_comments_tree_helper.rb", "app/helpers/render_comments_tree_helper.rb"
+        else
+          puts "Wrong params - use only [assets | views | helper] values"
+        end
+      end
+
+    end
+  end
+end

data/lib/the_comments/config.rb

@@ -0,0 +1,21 @@
+module TheComments
+  def self.configure(&block)
+    yield @config ||= TheComments::Configuration.new
+  end
+
+  def self.config
+    @config
+  end
+
+  # Configuration class
+  class Configuration
+    include ActiveSupport::Configurable
+    config_accessor :tolerance_time, :empty_inputs, :max_reply_depth
+  end
+
+  configure do |config|
+    config.max_reply_depth = 3
+    config.tolerance_time  = 5
+    config.empty_inputs    = [:message]
+  end
+end

data/lib/the_comments/version.rb

@@ -0,0 +1,3 @@
+module TheComments
+  VERSION = "0.9.0"
+end

data/lib/the_comments.rb

@@ -0,0 +1,10 @@
+require 'haml'
+require 'state_machine'
+require 'the_sortable_tree'
+
+require 'the_comments/config'
+require 'the_comments/version'
+
+module TheComments
+  class Engine < Rails::Engine; end
+end

data/the_comments.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'the_comments/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "the_comments"
+  gem.version       = TheComments::VERSION
+  gem.authors       = ["Ilya N. Zykin"]
+  gem.email         = ["zykin-ilya@ya.ru"]
+  gem.description   = %q{ Nested Comments }
+  gem.summary       = %q{ Nested Comments form TheTeacher }
+  gem.homepage      = "https://github.com/open-cook/the_comments"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'haml'
+  gem.add_dependency 'state_machine'
+  gem.add_dependency 'the_sortable_tree'
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: the_comments
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+  prerelease: 
+platform: ruby
+authors:
+- Ilya N. Zykin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: &80817540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *80817540
+- !ruby/object:Gem::Dependency
+  name: state_machine
+  requirement: &80817330 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *80817330
+- !ruby/object:Gem::Dependency
+  name: the_sortable_tree
+  requirement: &80817120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *80817120
+description: ! ' Nested Comments '
+email:
+- zykin-ilya@ya.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/assets/javascripts/the_comments.js.coffee
+- app/assets/javascripts/the_comments_manage.js.coffee
+- app/assets/stylesheets/the_comments.css.scss
+- app/controllers/concerns/the_comments_controller.rb
+- app/controllers/concerns/the_comments_ip_controller.rb
+- app/controllers/concerns/the_comments_user_agent_controller.rb
+- app/helpers/render_comments_tree_helper.rb
+- app/models/concerns/the_comments_base.rb
+- app/models/concerns/the_comments_black_ip.rb
+- app/models/concerns/the_comments_black_user_agent.rb
+- app/models/concerns/the_comments_commentable.rb
+- app/models/concerns/the_comments_states.rb
+- app/models/concerns/the_comments_user.rb
+- app/views/ip_black_lists/index.html.haml
+- app/views/the_comments/_comment.html.haml
+- app/views/the_comments/_comment_body.html.haml
+- app/views/the_comments/_form.html.haml
+- app/views/the_comments/_manage_controls.html.haml
+- app/views/the_comments/_tree.html.haml
+- app/views/the_comments/index.html.haml
+- app/views/the_comments/manage.html.haml
+- app/views/user_agent_black_lists/index.html.haml
+- config/locales/en.yml
+- config/routes.rb
+- db/migrate/20130101010101_create_comments.rb
+- lib/generators/the_comments/USAGE
+- lib/generators/the_comments/templates/comments_controller.rb
+- lib/generators/the_comments/templates/ip_black_lists_controller.rb
+- lib/generators/the_comments/templates/the_comments.rb
+- lib/generators/the_comments/templates/user_agent_black_lists_controller.rb
+- lib/generators/the_comments/the_comments_generator.rb
+- lib/generators/the_comments/views_generator.rb
+- lib/the_comments.rb
+- lib/the_comments/config.rb
+- lib/the_comments/version.rb
+- the_comments.gemspec
+- the_comments.jpg
+homepage: https://github.com/open-cook/the_comments
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Nested Comments form TheTeacher
+test_files: []