commontator 6.1.0 → 6.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c63a6212f25d57ea206e1cfb23f4c8dff604ce26f6fb1a5d1ddb0088b030a4a5
-  data.tar.gz: 23ecd8f13e5af29e8968882361b2e87506d80ac23a209e4116c638a63514f46e
+  metadata.gz: 8bee013bb63d8967e048c353d6f71de9fe0ac5cfd4b40530e065d9cb11f8a14e
+  data.tar.gz: 9fb7f5b8d45b8264235cb77ced85d07dbda0667a2f3aaf03053f67abe0aa75fc
 SHA512:
-  metadata.gz: 04c523c45acc09a1062fbeeefbe1e328ee439b7f929f9fdb5d00a7d510d547434d2648cfbb1326d6ad0e7c182d91e2c745839434ac948af297fce964cb2c0724
-  data.tar.gz: 64b8731da68531908d2230936f21d647a5b2567d044490ebdbce8d85aa2dcdddff84ae68f31bd88b282df59f5ca7df19d2bf9d657a644715a0f6324c3e8ae548
+  metadata.gz: 3ad713e82c9db2b3b64f53ef3baa0b1143ff9fc45f79a8b5964ecfd7c7ce3c4e0f19308e3b234e9dbfcae439d520bb056472d9415bf149831c313d231d4f447f
+  data.tar.gz: b3e80f26aeccdf66161cd509e48f4f78f5c74f2cf9f78dddb387b7c9e37270d124a4e5183ce883912472ab452efc6907a795f80a02e59481da94494b01746c40

data/README.md

@@ -5,7 +5,7 @@
 [![Code Climate](https://codeclimate.com/github/lml/commontator/badges/gpa.svg)](https://codeclimate.com/github/lml/commontator)
 [![Code Coverage](https://codeclimate.com/github/lml/commontator/badges/coverage.svg)](https://codeclimate.com/github/lml/commontator)
 
-Commontator is a Rails engine for comments. It is compatible with Rails 5.
+Commontator is a Rails engine for comments. It is compatible with Rails 5.2+.
 Being an engine means it is fully functional as soon as you install and
 configure the gem, providing models, views and controllers of its own.
 At the same time, almost anything about it can be configured or customized to suit your needs.
@@ -22,7 +22,7 @@ Follow the steps below to install Commontator:
   gem 'commontator'
   ```
 
-  You will also need jquery-ujs and a sass compiler, which can be either be installed through
+  You will also need jquery and a sass compiler, which can be either be installed through
   the webpacker gem and yarn/npm/bower or through the jquery-rails and sass[c]-rails gems:
 
   ```rb
@@ -79,10 +79,19 @@ Follow the steps below to install Commontator:
 
   You can change the mount path if you would like a different one.
 
-5. Javascripts
+### Assets
 
-  Make sure your application.js requires jquery and jquery-ujs:
+1. Javascripts
 
+  Make sure your application.js requires jquery and rails-ujs or jquery-ujs:
+
+  Rails 5.1+:
+  ```js
+  //= require jquery
+  //= require rails-ujs
+  ```
+
+  Rails 5.0:
   ```js
   //= require jquery
   // If jquery-ujs was installed through jquery-rails
@@ -97,7 +106,7 @@ Follow the steps below to install Commontator:
   //= require commontator/application
   ```
 
-6. Stylesheets
+2. Stylesheets
 
   In order to display comment threads properly, you must
   require Commontator's application.scss in your `application.[s]css`:
@@ -106,6 +115,18 @@ Follow the steps below to install Commontator:
   *= require commontator/application
   ```
 
+#### Sprockets 4+
+
+  You must require Commontator's manifest.js in your app's manifest.js for images to work properly:
+
+  ```js
+  //= link commontator/manifest.js
+  ```
+
+  You also need to either add the necessary link tag commands to your layout to load
+  commontator/application.js and commontator/application.css or require them in your app's
+  application.js and application.css like in Sprockets 3.
+
 ## Usage
 
 Follow the steps below to add Commontator to your models and views:

data/app/assets/config/commontator/manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../../images
+//= link_directory ../../javascripts .js
+//= link_directory ../../stylesheets .css

data/app/assets/stylesheets/commontator/application.scss

@@ -11,7 +11,7 @@
     padding: 0;
   }
 
-  .hidden {
+  .commontator-hidden {
     display: none;
   }
 

data/app/models/commontator/thread.rb

@@ -60,7 +60,17 @@ class Commontator::Thread < ActiveRecord::Base
 
   def comments_with_parent_id(parent_id, show_all)
     oc = ordered_comments(show_all)
-    [ :i, :b ].include?(config.comment_reply_style) ? oc.where(parent_id: parent_id) : oc
+
+    if [ :i, :b ].include?(config.comment_reply_style)
+      # Filter comments by parent_id so we display nested comments
+      oc.where(parent_id: parent_id)
+    elsif parent_id.nil?
+      # Parent is the thread itself and nesting is disabled, so include all comments
+      oc
+    else
+      # Parent is some comment and nesting is disabled, so return nothing
+      oc.none
+    end
   end
 
   def paginated_comments(page, parent_id, show_all)

data/app/views/commontator/threads/_reply.html.erb

@@ -8,7 +8,7 @@
   <% if thread.is_closed? %>
     <p><%= t 'commontator.thread.status.cannot_post' %></p>
   <% elsif !user %>
-    <p><%= t 'commontator.require_login' %>.</p>
+    <p><%= t 'commontator.require_login' %></p>
   <% else %>
     <% if @commontator_new_comment.nil? %>
       <div id="commontator-thread-<%= thread.id %>-new-comment-link" class="new-comment">
@@ -19,7 +19,7 @@
     <% end %>
 
     <div id="commontator-thread-<%= thread.id %>-new-comment" class="new-comment<%=
-    @commontator_new_comment.nil? ? ' hidden' : '' %>">
+    @commontator_new_comment.nil? ? ' commontator-hidden' : '' %>">
       <% unless @commontator_new_comment.nil? %>
         <%=
           render partial: 'commontator/comments/form', locals: {

data/app/views/commontator/threads/_show.html.erb

@@ -11,7 +11,7 @@
   nested_comments = thread.nested_comments_for(user, comments, show_all)
 %>
 
-<div id="commontator-thread-<%= thread.id %>-show" class="show hidden">
+<div id="commontator-thread-<%= thread.id %>-show" class="show commontator-hidden">
   <%= link_to t('commontator.thread.actions.show'),
               '#',
               id: "commontator-thread-#{thread.id}-show-link" %>
@@ -20,7 +20,7 @@
 <div id="commontator-thread-<%= thread.id %>-content" class="content">
   <div id="commontator-thread-<%= thread.id %>-header" class="header">
     <span id="commontator-thread-<%= thread.id %>-actions" class="actions">
-      <span id="commontator-thread-<%= thread.id %>-hide" class="hide hidden">
+      <span id="commontator-thread-<%= thread.id %>-hide" class="hide commontator-hidden">
         <%= link_to t('commontator.thread.actions.hide'),
                     '#',
                     id: "commontator-thread-#{thread.id}-hide-link" %>

data/config/initializers/commontator.rb

@@ -254,10 +254,10 @@ Commontator.configure do |config|
   # Returns: the address emails are sent "from" (String)
   # Important: If using subscriptions, change this to at least match your domain name
   # Default: ->(thread) do
-  #   "no-reply@#{Rails.application.class.parent.to_s.downcase}.com"
+  #   "no-reply@#{Rails.application.class.module_parent.to_s.downcase}.com"
   # end
   config.email_from_proc = ->(thread) do
-    "no-reply@#{Rails.application.class.parent.to_s.downcase}.com"
+    "no-reply@#{Rails.application.class.module_parent.to_s.downcase}.com"
   end
 
   # commontable_name_proc

data/db/migrate/{0_install_commontator.rb → 10_install_commontator.rb}

@@ -1,4 +1,4 @@
-class InstallCommontator < ActiveRecord::Migration[5.2]
+class InstallCommontator < ActiveRecord::Migration[6.0]
   def change
     create_table :commontator_threads do |t|
       t.references :commontable,
@@ -8,7 +8,7 @@ class InstallCommontator < ActiveRecord::Migration[5.2]
 
       t.datetime :closed_at
 
-      t.timestamps null: false
+      t.timestamps
     end
 
     create_table :commontator_comments do |t|
@@ -24,7 +24,7 @@ class InstallCommontator < ActiveRecord::Migration[5.2]
       t.integer :cached_votes_up, default: 0, index: true
       t.integer :cached_votes_down, default: 0, index: true
 
-      t.timestamps null: false
+      t.timestamps
     end
 
     add_index :commontator_comments, [ :creator_id, :creator_type, :thread_id ],
@@ -37,7 +37,7 @@ class InstallCommontator < ActiveRecord::Migration[5.2]
       }
       t.references :subscriber, polymorphic: true, null: false, index: false
 
-      t.timestamps null: false
+      t.timestamps
     end
 
     add_index :commontator_subscriptions, [ :subscriber_id, :subscriber_type, :thread_id ],

data/db/migrate/{1_add_replying_to_comments.rb → 11_add_replying_to_comments.rb}

@@ -1,4 +1,4 @@
-class AddReplyingToComments < ActiveRecord::Migration[5.2]
+class AddReplyingToComments < ActiveRecord::Migration[6.0]
   def change
     add_reference :commontator_comments, :parent, foreign_key: {
       to_table: :commontator_comments, on_update: :restrict, on_delete: :cascade

data/lib/commontator/acts_as_commontable.rb

@@ -17,14 +17,15 @@ module Commontator::ActsAsCommontable
         cattr_accessor :commontable_config
         self.commontable_config = Commontator::CommontableConfig.new(options)
 
-        has_one :commontator_thread, association_options.merge(
+        has_one :commontator_thread, **association_options.merge(
           as: :commontable, class_name: 'Commontator::Thread'
         )
 
-        validates :commontator_thread, presence: true
-
         prepend Commontator::BuildThread
 
+        # Support creating acts_as_commontable records without a commontator_thread when migrating
+        validates :commontator_thread, presence: true, if: -> { Commontator::Thread.table_exists? }
+
         self.is_commontable = true
       end
     end
@@ -33,4 +34,6 @@ module Commontator::ActsAsCommontable
   end
 end
 
-ActiveRecord::Base.send :include, Commontator::ActsAsCommontable
+ActiveSupport.on_load :active_record do
+  include Commontator::ActsAsCommontable
+end

data/lib/commontator/acts_as_commontator.rb

@@ -16,10 +16,10 @@ module Commontator::ActsAsCommontator
         cattr_accessor :commontator_config
         self.commontator_config = Commontator::CommontatorConfig.new(options)
 
-        has_many :commontator_comments, association_options.merge(
+        has_many :commontator_comments, **association_options.merge(
           as: :creator, class_name: 'Commontator::Comment'
         )
-        has_many :commontator_subscriptions, association_options.merge(
+        has_many :commontator_subscriptions, **association_options.merge(
           as: :subscriber, class_name: 'Commontator::Subscription'
         )
 
@@ -33,4 +33,6 @@ module Commontator::ActsAsCommontator
   end
 end
 
-ActiveRecord::Base.send :include, Commontator::ActsAsCommontator
+ActiveSupport.on_load :active_record do
+  include Commontator::ActsAsCommontator
+end

data/lib/commontator/controllers.rb

@@ -1,10 +1,6 @@
 require_relative 'shared_helper'
 
 module Commontator::Controllers
-  def self.included(base)
-    base.helper Commontator::SharedHelper
-  end
-
   def commontator_set_thread_variables
     return if @commontator_thread.nil? || !@commontator_thread.can_be_read_by?(@commontator_user)
 
@@ -31,4 +27,6 @@ module Commontator::Controllers
   end
 end
 
-ActionController::Base.send :include, Commontator::Controllers
+ActiveSupport.on_load :action_controller do
+  include Commontator::Controllers
+end

data/lib/commontator/shared_helper.rb

@@ -57,5 +57,10 @@ module Commontator::SharedHelper
   end
 end
 
-ActionController::Base.send :include, Commontator::SharedHelper
-ActionController::Base.helper Commontator::SharedHelper
+ActiveSupport.on_load :action_controller do
+  include Commontator::SharedHelper
+end
+
+ActiveSupport.on_load :action_controller_base do
+  helper Commontator::SharedHelper
+end

data/lib/commontator/version.rb

@@ -1 +1 @@
-COMMONTATOR_VERSION = '6.1.0'
+COMMONTATOR_VERSION = '6.3.1'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: commontator
 version: !ruby/object:Gem::Version
-  version: 6.1.0
+  version: 6.3.1
 platform: ruby
 authors:
 - Dante Soares
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-20 00:00:00.000000000 Z
+date: 2021-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: will_paginate
   requirement: !ruby/object:Gem::Requirement
@@ -159,6 +159,7 @@ extra_rdoc_files: []
 files:
 - MIT-LICENSE
 - README.md
+- app/assets/config/commontator/manifest.js
 - app/assets/images/commontator/downvote.png
 - app/assets/images/commontator/downvote_active.png
 - app/assets/images/commontator/downvote_disabled.png
@@ -214,8 +215,8 @@ files:
 - config/locales/ru.yml
 - config/locales/zh.yml
 - config/routes.rb
-- db/migrate/0_install_commontator.rb
-- db/migrate/1_add_replying_to_comments.rb
+- db/migrate/10_install_commontator.rb
+- db/migrate/11_add_replying_to_comments.rb
 - lib/commontator.rb
 - lib/commontator/acts_as_commontable.rb
 - lib/commontator/acts_as_commontator.rb
@@ -250,7 +251,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.2.7
 signing_key: 
 specification_version: 4
 summary: Allows users to comment on any model in your application.