the_comments 1.1.0 → 2.0.0

data/lib/generators/the_comments/USAGE

@@ -1,33 +1,44 @@
 Description:
-  TheComments generator will copy files for organize comment's tree in your web project
+  TheComments: generators will copy files for organize comments tree in your web project
 
-This text:
-  bundle exec rails g the_comments --help
+  Usage: [bundle exec] rails g the_comments NAME
+  Usage: [bundle exec] rails g the_comments:views NAME
 
-Generators:
-  bundle exec rails g the_comments install
+# This text:
+  > rails g the_comments --help
+
+# Main generators:
+  > rails g the_comments install
 
   This will create:
    config/initializers/the_comments.rb
-   
-   app/models/ip_black_list.rb
-   app/models/user_agent_black_list.rb
-
    app/controllers/comments_controller.rb
-   app/controllers/ip_black_lists_controller.rb
-   app/controllers/user_agent_black_lists_controller.rb
+   app/models/comment.rb
 
-  bundle exec rails g the_comments controllers
+# Controller generators:
+  > 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
+    
+# Model generators:
+  > rails g the_comments models
+  
+  This will create:
+    app/models/comment.rb
+
+# Config generators:
+  > rails g the_comments config
+
+# Locals generators:
+  > rails g the_comments locales
 
-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
+# View Generators:
+  > rails g the_comments:views js
+  > rails g the_comments:views css
+  > rails g the_comments:views assets
+  > rails g the_comments:views helper
+  > rails g the_comments:views views
 
-Migrations:
-  bundle exec rake the_comments_engine:install:migrations
+# Migrations:
+  > rake the_comments_engine:install:migrations

data/lib/generators/the_comments/the_comments_generator.rb

@@ -2,38 +2,55 @@ class TheCommentsGenerator < Rails::Generators::NamedBase
   source_root File.expand_path('../templates', __FILE__)
   # argument :xname, type: :string, default: :xname
 
+  # > rails g the_comments NAME
   def generate_controllers
-    if gen_name == 'install'
-      cp_setup
-      cp_controllers
-    elsif gen_name == 'controllers'
-      cp_controllers
-    elsif gen_name == 'models'
-      cp_models
-    else
-      puts 'TheComments Generator - wrong Name'
-      puts 'Try to use [install|controllers]'
+    case gen_name
+      when 'locales'
+        cp_locales
+      when 'models'
+        cp_models
+      when 'controllers'
+        cp_controllers
+      when 'config'
+        cp_config
+      when 'install'
+        cp_config
+        cp_models
+        cp_controllers
+      else
+        puts 'TheComments Generator - wrong Name'
+        puts 'Try to use [ install | config | controllers | models ]'
     end
   end
 
   private
 
+  def root_path; TheComments::Engine.root; end
+
   def gen_name
     name.to_s.downcase
   end
 
-  def cp_setup
-    copy_file 'the_comments.rb', 'config/initializers/the_comments.rb'
+  def cp_config
+    copy_file "#{root_path}/config/initializers/the_comments.rb",
+              "config/initializers/the_comments.rb"
   end
 
   def cp_models
-    copy_file 'ip_black_list.rb',         'app/models/ip_black_list.rb'
-    copy_file 'user_agent_black_list.rb', 'app/models/user_agent_black_list.rb'
+    copy_file "#{root_path}/app/models/_templates_/comment.rb",
+              "app/models/comment.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'
+    copy_file "#{root_path}/app/controllers/_templates_/comments_controller.rb",
+              "app/controllers/comments_controller.rb"
+  end
+
+  def cp_locales
+    copy_file "#{root_path}/config/locales/en.yml",
+              "config/locales/en.the_comments.yml"
+
+    copy_file "#{root_path}/config/locales/ru.yml",
+              "config/locales/ru.the_comments.yml"
   end
-end
+end

data/lib/generators/the_comments/views_generator.rb

@@ -1,14 +1,21 @@
 module TheComments
   module Generators
     class ViewsGenerator < Rails::Generators::NamedBase
-      source_root File.expand_path('../../../../app/views', __FILE__)
+      source_root TheComments::Engine.root
 
       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
+USAGE: [bundle exec] rails g the_comments:views NAME
+
+> rails g the_comments:views js
+> rails g the_comments:views css
+> rails g the_comments:views assets
+
+> rails g the_comments:views views
+> rails g the_comments:views helper
+
+> rails g the_comments:views all
 
 BANNER
       end
@@ -24,20 +31,49 @@ BANNER
       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"
-          directory "../views/ip_black_lists",         "app/views/ip_black_lists"
-          directory "../views/user_agent_black_lists", "app/views/user_agent_black_lists"
-        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"
+        case param_name
+          when 'js'
+            js_copy
+          when 'css'
+            css_copy
+          when 'assets'
+            js_copy; css_copy
+          when 'views'
+            views_copy
+          when 'helper'
+            helper_copy
+          when 'all'
+            js_copy
+            css_copy
+            views_copy
+            helper_copy
+          else
+            puts 'TheComments View Generator - wrong Name'
+            puts "Wrong params - use only [ js | css | assets | views | helper | all ] values"
         end
       end
 
+      def js_copy
+        f1 = "app/assets/javascripts/the_comments.js.coffee"
+        f2 = "app/assets/javascripts/the_comments_manage.js.coffee"
+        copy_file f1, f1
+        copy_file f2, f2
+      end
+
+      def css_copy
+        f1 = "app/assets/stylesheets/the_comments.css.scss"
+        copy_file f1, f1
+      end
+
+      def views_copy
+        d1 = "app/views/the_comments"
+        directory d1, d1
+      end
+
+      def helper_copy
+        f1 = "app/helpers/render_comments_tree_helper.rb"
+        copy_file f1, f1
+      end
     end
   end
-end
+end

data/lib/the_comments/config.rb

@@ -10,7 +10,16 @@ module TheComments
   # Configuration class
   class Configuration
     include ActiveSupport::Configurable
-    config_accessor :tolerance_time, :empty_inputs, :max_reply_depth, :default_state, :default_owner_state, :default_title
+
+    config_accessor :max_reply_depth,
+                    :tolerance_time,
+                    :default_state,
+                    :default_owner_state,
+                    :empty_inputs,
+                    :default_title,
+                    :template_engine,
+                    :empty_trap_protection,
+                    :tolerance_time_protection
   end
 
   configure do |config|
@@ -20,5 +29,9 @@ module TheComments
     config.default_owner_state = :published
     config.empty_inputs        = [:message]
     config.default_title       = 'Undefined title'
+    config.template_engine     = :haml
+
+    config.empty_trap_protection     = true
+    config.tolerance_time_protection = true
   end
 end

data/lib/the_comments/version.rb

@@ -1,3 +1 @@
-module TheComments
-  VERSION = "1.1.0"
-end
+require File.expand_path('../../../gem_version', __FILE__)

data/lib/the_comments.rb

@@ -7,3 +7,13 @@ require 'the_comments/version'
 module TheComments
   class Engine < Rails::Engine; end
 end
+
+# Loading of concerns
+
+# controllers
+require "../../app/controllers/concerns/controller"
+
+# models
+%w[ comment_states comment user commentable ].each do |concern|
+  require "../../app/models/concerns/#{concern}"
+end

data/spec/dummy_app/.gitignore

@@ -0,0 +1,17 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.db
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp

data/spec/dummy_app/.rspec

@@ -0,0 +1 @@
+--color

data/spec/dummy_app/.ruby-gemset

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

data/spec/dummy_app/.ruby-version

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

data/spec/dummy_app/Gemfile

@@ -0,0 +1,43 @@
+source 'https://rubygems.org'
+
+# Base gems
+gem 'rails', '4.0.1' #github: 'rails/rails', branch: 'master'
+gem 'sqlite3'
+
+gem 'jquery-rails'
+gem 'jbuilder', '~> 1.2'
+
+gem 'uglifier', '>= 1.3.0'
+gem 'sass-rails', '~> 4.0.0'
+gem 'coffee-rails', '~> 4.0.0'
+
+gem 'thin', group: [:development]
+gem 'therubyracer', platforms: :ruby
+gem 'sdoc', require: false, group: [:doc]
+
+# App gems
+gem 'haml'
+gem 'sorcery'
+gem 'kaminari'
+gem 'haml-rails'
+
+# TheComments requires
+gem 'the_comments',
+  path: '../../'
+
+gem 'bootstrap-sass',
+  github: 'thomas-mcdonald/bootstrap-sass'
+
+gem 'awesome_nested_set',
+  git: 'https://github.com/collectiveidea/awesome_nested_set.git',
+  branch: 'master'
+
+# Test gems
+group :development, :test do
+  gem 'faker'
+  gem 'factory_girl'
+  gem "factory_girl_rails"
+  gem 'rspec-rails', '~> 2.0'
+
+  # gem 'database_cleaner'
+end

data/spec/dummy_app/README.md

@@ -0,0 +1,50 @@
+## TheComments Dummy App
+
+### First step
+
+```
+git clone https://github.com/the-teacher/the_comments.git
+
+cd the_comments/spec/dummy_app/
+
+bundle
+```
+
+### App start
+
+```
+rake db:bootstrap_and_seed
+
+rails s -p 3000 -b localhost
+```
+
+Browser
+
+```
+http://localhost:3000/
+```
+
+### Tests start
+
+```
+rake db:bootstrap RAILS_ENV=test
+
+rspec --format documentation
+```
+
+### Only for me (don't read this)
+
+base install commands
+
+```
+rails g sorcery:install
+rails generate rspec:install
+
+rails g the_comments install
+rails g the_comments:views views
+rails g model post user_id:integer title:string content:text
+
+rake the_comments_engine:install:migrations (EDIT!)
+
+rake db:bootstrap
+```

data/spec/dummy_app/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+App::Application.load_tasks

data/spec/dummy_app/app/assets/javascripts/admin_panel.js

@@ -0,0 +1,5 @@
+//= require jquery
+//= require jquery_ujs
+
+//= require bootstrap
+//= require the_comments_manage

data/spec/dummy_app/app/assets/javascripts/application.js

@@ -0,0 +1,16 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require jquery_ujs
+
+//= require the_comments

data/spec/dummy_app/app/assets/stylesheets/admin_panel.css

@@ -0,0 +1,3 @@
+/* 
+  *= require bootstrap
+*/

data/spec/dummy_app/app/assets/stylesheets/app.css.scss

@@ -0,0 +1,4 @@
+.body{
+  margin: auto;
+  width: 800px;
+}

data/spec/dummy_app/app/assets/stylesheets/application.css

@@ -0,0 +1,16 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+
+ *= require_self
+ *= require app
+ *= require the_comments
+
+ */

data/spec/dummy_app/app/controllers/application_controller.rb

@@ -0,0 +1,7 @@
+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

data/{lib/generators/the_comments/templates → spec/dummy_app/app/controllers}/comments_controller.rb

@@ -6,7 +6,9 @@ class CommentsController < ApplicationController
   # 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
+  layout 'admin'
+
+  include TheComments::Controller
 
   # Public methods:
   #

data/spec/dummy_app/app/controllers/posts_controller.rb

@@ -0,0 +1,13 @@
+class PostsController < ApplicationController
+  def index
+    @posts = Post.all
+    @recent_comments = Comment.with_state(:published)
+                       .where(commentable_state: [:published])
+                       .recent.page(params[:page])
+  end
+
+  def show
+    @post     = Post.find params[:id]
+    @comments = @post.comments.with_state([:draft, :published]).nested_set
+  end
+end

data/spec/dummy_app/app/controllers/users_controller.rb

@@ -0,0 +1,7 @@
+class UsersController < ApplicationController
+  def autologin
+    user = User.find params[:id]
+    auto_login user if user
+    redirect_to request.referrer || root_path
+  end
+end

data/spec/dummy_app/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy_app/app/models/comment.rb

@@ -0,0 +1,32 @@
+class Comment < ActiveRecord::Base
+  include TheComments::Comment
+  # ---------------------------------------------------
+  # 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

data/spec/dummy_app/app/models/post.rb

@@ -0,0 +1,17 @@
+class Post < ActiveRecord::Base
+  include TheComments::Commentable
+
+  belongs_to :user
+
+  def commentable_title
+    title
+  end
+
+  def commentable_url
+    ['', self.class.to_s.tableize, id].join('/')
+  end
+
+  def commentable_state
+    :published.to_s
+  end
+end

data/spec/dummy_app/app/models/user.rb

@@ -0,0 +1,21 @@
+class User < ActiveRecord::Base
+  include TheComments::User
+  include TheComments::Commentable
+
+  authenticates_with_sorcery!
+
+  has_many :posts
+
+  # can be replaced to TheCommentsUser as default
+  def admin?
+    self == User.first
+  end
+
+  def comments_admin?
+    admin?
+  end
+
+  def comments_moderator? comment
+    id == comment.holder_id
+  end
+end

data/spec/dummy_app/app/views/layouts/admin.html.haml

@@ -0,0 +1,25 @@
+!!! 5
+%html(lang="ru")
+  %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_panel
+    = javascript_include_tag :admin_panel
+    = 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"

data/spec/dummy_app/app/views/layouts/application.html.haml

@@ -0,0 +1,20 @@
+!!!
+%html
+%head
+  %title TheComments Dummy App
+  = stylesheet_link_tag    :application, media: :all
+  = javascript_include_tag :application
+  = csrf_meta_tags
+
+%body
+  .body
+    %p
+      = link_to 'Home', root_path
+      \|
+      - if current_user
+        User: #{current_user.username}
+        \|
+        = link_to "Comments Manage (+#{current_user.draft_comcoms_count})", comments.manage_comments_path
+      - else
+        Guest
+    = yield

data/spec/dummy_app/app/views/posts/index.html.haml

@@ -0,0 +1,22 @@
+%h3 Posts:
+%ul
+  - @posts.each do |post|
+    %li
+      = link_to post_url(post) do
+        = "#{post.title} (#{post.comments_sum})"
+
+%h3 Autologin Users:
+%ul
+  - User.all.each do |user|
+    %li
+      = link_to autologin_url(user) do
+        - admin = user.comments_admin? ? '[Admin]' : nil
+        = "#{user.username} (#{user.draft_comcoms_count}) #{admin}"
+
+%h3 Recent Comments:
+%ul
+  - @recent_comments.each do |comment|
+    %p
+      %b= link_to comment.commentable_title, comment.commentable_url
+      %br
+      %i= comment.content