commontator 4.11.1 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba13938d041038942002c5071726bcc5ed4c440a
-  data.tar.gz: 30ce7ec6b5a1837ac7330402ccad880de3cc4a00
+  metadata.gz: fcd57c56f76291406b85f24de5a0ad2235c350ca
+  data.tar.gz: 8af611ffdae4c578f9a784b39f10a1d4a9860503
 SHA512:
-  metadata.gz: 86dadff77fd7beffe86f9e396f3913e38ad36a05b9401b5e8bea02c2256feec3221cf784e4a79a54efbabd7762d613e28b63241ec442c32e445981b9ee6b3329
-  data.tar.gz: f6dc996037639730d9567a4fd1133c4a7a93615fefbad780f45bc122761dcd886161fe3f5e172ee0c5ff7b99545ecff7a964f7c52271c9a2ab6b861a93f4e445
+  metadata.gz: 328b21764347f350e0bbef130ab82bf5d26bb5866d8e864261e6080fc9a1052368f505d1a5ff2fbd947c5bc9fe123fe95fd7f6d321e9809ad199f21e7d898681
+  data.tar.gz: 9db4ba13a3576b3629239496012bdf92c096aa0f5f6377919a249026da2097ceb9519ac3a55c25990c0539482fc40c0a903ee6d51e3d3a8f47a8e0bd9e9b4db5

data/README.md

@@ -132,7 +132,7 @@ That's it! Commontator is now ready for use.
 When you enable subscriptions, emails are sent automatically by Commontator. If sending emails, remember to add your host URL's to your environment files (test.rb, development.rb and production.rb):
 
 ```rb
-config.action_mailer.default_url_options = { :host => "www.example.com" }
+config.action_mailer.default_url_options = { host: "www.example.com" }
 ```
 
 Batch sending through Mailgun is also supported and automatically detected.
@@ -172,12 +172,13 @@ Then enable mentions in commontator's initializer:
 config.mentions_enabled = true
 ```
 
-Finally configure the user_mentions_proc, which receives the current user
-and the search query inputted by that user and should return a relation
-containing the users that can be mentioned and match the query string:
+Finally configure the user_mentions_proc, which receives the current user,
+the current thread, and the search query inputted by that user and should
+return a relation containing the users that can be mentioned and match the
+query string:
 
 ```rb
-config.user_mentions_proc = lambda { |current_user, query| ... }
+config.user_mentions_proc = ->(current_user, thread, query) { ... }
 ```
 
 Please be aware that with mentions enabled, any registered user

data/app/controllers/commontator/application_controller.rb

@@ -1,9 +1,9 @@
 module Commontator
   class ApplicationController < ActionController::Base
-    before_filter :set_user, :ensure_user
-    
-    rescue_from SecurityTransgression, :with => lambda { head(:forbidden) }
-    
+    before_action :set_user, :ensure_user
+
+    rescue_from SecurityTransgression, with: -> { head(:forbidden) }
+
     protected
 
     def security_transgression_unless(check)

data/app/controllers/commontator/comments_controller.rb

@@ -1,7 +1,7 @@
 module Commontator
   class CommentsController < Commontator::ApplicationController
-    before_filter :set_thread, :only => [:new, :create]
-    before_filter :set_comment_and_thread, :except => [:new, :create]
+    before_action :set_thread, only: [:new, :create]
+    before_action :set_comment_and_thread, except: [:new, :create]
 
     # GET /threads/1/comments/new
     def new
@@ -16,7 +16,7 @@ module Commontator
         format.html { redirect_to @thread }
         format.js
       end
-     
+
     end
 
     # POST /threads/1/comments
@@ -27,7 +27,7 @@ module Commontator
       @comment.body = params[:comment].nil? ? nil : params[:comment][:body]
       security_transgression_unless @comment.can_be_created_by?(@user)
       subscribe_mentioned if Commontator.mentions_enabled
-      
+
       respond_to do |format|
         if  !params[:cancel].nil?
           format.html { redirect_to @thread }
@@ -91,7 +91,7 @@ module Commontator
         format.js { render :delete }
       end
     end
-    
+
     # PUT /comments/1/undelete
     def undelete
       security_transgression_unless @comment.can_be_deleted_by?(@user)
@@ -104,11 +104,11 @@ module Commontator
         format.js { render :delete }
       end
     end
-    
+
     # PUT /comments/1/upvote
     def upvote
       security_transgression_unless @comment.can_be_voted_on_by?(@user)
-      
+
       @comment.upvote_from @user
 
       respond_to do |format|
@@ -116,12 +116,12 @@ module Commontator
         format.js { render :vote }
       end
     end
-    
+
     # PUT /comments/1/downvote
     def downvote
       security_transgression_unless @comment.can_be_voted_on_by?(@user) &&\
         @comment.thread.config.comment_voting.to_sym == :ld
-      
+
       @comment.downvote_from @user
 
       respond_to do |format|
@@ -129,21 +129,21 @@ module Commontator
         format.js { render :vote }
       end
     end
-    
+
     # PUT /comments/1/unvote
     def unvote
       security_transgression_unless @comment.can_be_voted_on_by?(@user)
-      
-      @comment.unvote :voter => @user
+
+      @comment.unvote voter: @user
 
       respond_to do |format|
         format.html { redirect_to @thread }
         format.js { render :vote }
       end
     end
-    
+
     protected
-    
+
     def set_comment_and_thread
       @comment = Comment.find(params[:id])
       @thread = @comment.thread
@@ -151,7 +151,7 @@ module Commontator
     end
 
     def subscribe_mentioned
-      Commontator.commontator_mentions(@user, '').where(id: params[:mentioned_ids]).each do |user|
+      Commontator.commontator_mentions(@user, @thread, '').where(id: params[:mentioned_ids]).each do |user|
         @thread.subscribe(user)
       end
     end

data/app/controllers/commontator/subscriptions_controller.rb

@@ -1,6 +1,6 @@
 module Commontator
   class SubscriptionsController < Commontator::ApplicationController
-    before_filter :set_thread
+    before_action :set_thread
 
     # PUT /threads/1/subscribe
     def subscribe

data/app/controllers/commontator/threads_controller.rb

@@ -1,7 +1,7 @@
 module Commontator
   class ThreadsController < Commontator::ApplicationController
-    skip_before_filter :ensure_user, :only => :show
-    before_filter :set_thread
+    skip_before_action :ensure_user, only: :show
+    before_action :set_thread
 
     # GET /threads/1
     def show
@@ -13,7 +13,7 @@ module Commontator
         format.js
       end
     end
-    
+
     # PUT /threads/1/close
     def close
       security_transgression_unless @thread.can_be_edited_by?(@user)
@@ -28,7 +28,7 @@ module Commontator
         format.js { render :show }
       end
     end
-    
+
     # PUT /threads/1/reopen
     def reopen
       security_transgression_unless @thread.can_be_edited_by?(@user)
@@ -60,7 +60,7 @@ module Commontator
     protected
 
     def serialized_mentions(query)
-      { mentions: Commontator.commontator_mentions(@user, query).map do |user|
+      { mentions: Commontator.commontator_mentions(@user, @thread, query).map do |user|
         { id: user.id, name: Commontator.commontator_name(user), type: 'user' }
       end }
     end

data/app/mailers/commontator/subscriptions_mailer.rb

@@ -2,15 +2,10 @@ module Commontator
   class SubscriptionsMailer < ActionMailer::Base
     def comment_created(comment, recipients)
       setup_variables(comment, recipients)
-      message = mail :to => @to,
-                     :bcc => @bcc,
-                     :from => @from,
-                     :subject => t('commontator.email.comment_created.subject',
-                                   :creator_name => @creator_name,
-                                   :commontable_name => @commontable_name,
-                                   :comment_url => @comment_url)
-
-      message.mailgun_recipient_variables = mailgun_recipient_variables(recipients) if uses_mailgun?
+
+      mail(@mail_params).tap do |message|
+        message.mailgun_recipient_variables = @mailgun_recipient_variables if @using_mailgun
+      end
     end
 
     protected
@@ -20,42 +15,35 @@ module Commontator
       @thread = @comment.thread
       @creator = @comment.creator
 
-      @creator_name = Commontator.commontator_name(@creator)
-
-      @commontable_name = Commontator.commontable_name(@thread)
+      @mail_params = { from: @thread.config.email_from_proc.call(@thread) }
 
-      @comment_url = Commontator.comment_url(@comment, main_app)
+      @recipient_emails = recipients.map do |recipient|
+        Commontator.commontator_email(recipient, self)
+      end
 
-      params = Hash.new
-      params[:comment] = @comment
-      params[:thread] = @thread
-      params[:creator] = @creator
-      params[:creator_name] = @creator_name
-      params[:commontable_name] = @commontable_name
-      params[:comment_url] = @comment_url
+      @using_mailgun = Rails.application.config.action_mailer.delivery_method == :mailgun
 
-      if uses_mailgun?
-        @to = recipient_emails(recipients)
+      if @using_mailgun
+        @recipients_header = :to
+        @mailgun_recipient_variables = {}.tap do |mailgun_recipient_variables|
+          @recipient_emails.each { |email| mailgun_recipient_variables[email] = {} }
+        end
       else
-        @to = t('commontator.email.undisclosed_recipients')
-        @bcc = recipient_emails(recipients)
+        @recipients_header = :bcc
       end
 
-      @from = @thread.config.email_from_proc.call(@thread)
-    end
+      @mail_params[@recipients_header] = @recipient_emails
 
-    def recipient_emails(recipients)
-      recipients.collect{ |s| Commontator.commontator_email(s, self) }
-    end
-
-    def mailgun_recipient_variables(recipients)
-      recipient_emails(recipients).each_with_object({}) do |user_email, memo|
-        memo[user_email] = {}
-      end
-    end
+      @creator_name = Commontator.commontator_name(@creator)
+      @commontable_name = Commontator.commontable_name(@thread)
+      @comment_url = Commontator.comment_url(@comment, main_app)
 
-    def uses_mailgun?
-      Rails.application.config.action_mailer.delivery_method == :mailgun
+      @mail_params[:subject] = t(
+        'commontator.email.comment_created.subject',
+        creator_name: @creator_name,
+        commontable_name: @commontable_name,
+        comment_url: @comment_url
+      )
     end
   end
 end

data/app/models/commontator/comment.rb

@@ -1,17 +1,17 @@
 module Commontator
   class Comment < ActiveRecord::Base
-    belongs_to :creator, :polymorphic => true
-    belongs_to :editor, :polymorphic => true
+    belongs_to :creator, polymorphic: true
+    belongs_to :editor, polymorphic: true, optional: true
     belongs_to :thread
 
-    validates_presence_of :creator, :on => :create
-    validates_presence_of :editor, :on => :update
+    validates_presence_of :creator, on: :create
+    validates_presence_of :editor, on: :update
     validates_presence_of :thread
     validates_presence_of :body
 
     validates_uniqueness_of :body,
-      :scope => [:creator_type, :creator_id, :thread_id, :deleted_at],
-      :message => I18n.t('commontator.comment.errors.double_posted')
+      scope: [:creator_type, :creator_id, :thread_id, :deleted_at],
+      message: I18n.t('commontator.comment.errors.double_posted')
 
     protected
 
@@ -36,7 +36,7 @@ module Commontator
 
     def get_vote_by(user)
       return nil unless is_votable? && !user.nil? && user.is_commontator
-      votes_for.where(:voter_type => user.class.name, :voter_id => user.id).first
+      votes_for.where(voter_type: user.class.name, voter_id: user.id).first
     end
 
     def update_cached_votes(vote_scope = nil)
@@ -64,13 +64,13 @@ module Commontator
 
     def created_timestamp
       I18n.t 'commontator.comment.status.created_at',
-             :created_at => I18n.l(created_at, :format => :commontator)
+             created_at: I18n.l(created_at, format: :commontator)
     end
-    
+
     def updated_timestamp
       I18n.t 'commontator.comment.status.updated_at',
-             :editor_name => Commontator.commontator_name(editor || creator),
-             :updated_at => I18n.l(updated_at, :format => :commontator)
+             editor_name: Commontator.commontator_name(editor || creator),
+             updated_at: I18n.l(updated_at, format: :commontator)
     end
 
     ##################

data/app/models/commontator/subscription.rb

@@ -1,10 +1,10 @@
 module Commontator
   class Subscription < ActiveRecord::Base
-    belongs_to :subscriber, :polymorphic => true
+    belongs_to :subscriber, polymorphic: true
     belongs_to :thread
 
     validates_presence_of :subscriber, :thread
-    validates_uniqueness_of :thread_id, :scope => [:subscriber_type, :subscriber_id]
+    validates_uniqueness_of :thread_id, scope: [:subscriber_type, :subscriber_id]
 
     def self.comment_created(comment)
       recipients = comment.thread.subscribers.reject{|s| s == comment.creator}

data/app/models/commontator/thread.rb

@@ -1,15 +1,15 @@
 module Commontator
   class Thread < ActiveRecord::Base
-    belongs_to :closer, :polymorphic => true
-    belongs_to :commontable, :polymorphic => true
+    belongs_to :closer, polymorphic: true, optional: true
+    belongs_to :commontable, polymorphic: true, optional: true
 
-    has_many :comments, :dependent => :destroy
-    has_many :subscriptions, :dependent => :destroy
+    has_many :comments, dependent: :destroy
+    has_many :subscriptions, dependent: :destroy
 
-    validates_presence_of :commontable, :unless => :is_closed?
+    validates_presence_of :commontable, unless: :is_closed?
     validates_uniqueness_of :commontable_id,
-                            :scope => :commontable_type,
-                            :allow_nil => true
+                            scope: :commontable_type,
+                            allow_nil: true
 
     def config
       @config ||= commontable.try(:commontable_config) || Commontator
@@ -45,7 +45,7 @@ module Commontator
     def paginated_comments(page = 1, per_page = config.comments_per_page)
       oc = ordered_comments
       return oc unless will_paginate?
-      oc.paginate(:page => page, :per_page => per_page)
+      oc.paginate(page: page, per_page: per_page)
     end
 
     def new_comment_page(per_page = config.comments_per_page)
@@ -91,7 +91,7 @@ module Commontator
 
     def subscription_for(subscriber)
       return nil if !subscriber || !subscriber.is_commontator
-      subscriber.subscriptions.where(:thread_id => self.id).first
+      subscriber.subscriptions.where(thread_id: self.id).first
     end
 
     def subscribe(subscriber)

data/app/views/commontator/comments/_actions.html.erb

@@ -9,9 +9,9 @@
 <% if can_edit %>
   <%= link_to t('commontator.comment.actions.edit'),
               commontator.edit_comment_path(comment),
-              :id => "comment_#{comment.id.to_s}_edit_link",
-              :class => "comment_edit_link",
-              :remote => true %>
+              id: "comment_#{comment.id.to_s}_edit_link",
+              class: "comment_edit_link",
+              remote: true %>
 <% end %>
 
 &nbsp;
@@ -21,9 +21,9 @@
   <% del_string = is_deleted ? 'undelete' : 'delete' %>
   <%= link_to t("commontator.comment.actions.#{del_string}"),
               commontator.polymorphic_path([del_string, comment]),
-              :confirm => (!is_deleted ? t('commontator.comment.actions.confirm_delete') : nil),
-              :method => :put,
-              :id => "comment_#{comment.id.to_s}_#{del_string}_link",
-              :class => "comment_#{del_string}_link",
-              :remote => true %>
+              confirm: (!is_deleted ? t('commontator.comment.actions.confirm_delete') : nil),
+              method: :put,
+              id: "comment_#{comment.id.to_s}_#{del_string}_link",
+              class: "comment_#{del_string}_link",
+              remote: true %>
 <% end %>

data/app/views/commontator/comments/_body.html.erb

@@ -4,5 +4,5 @@
 
 <%= simple_format comment.is_deleted? ? \
       t('commontator.comment.status.deleted_by',
-        :deleter_name => Commontator.commontator_name(comment.editor)) : \
+        deleter_name: Commontator.commontator_name(comment.editor)) : \
       comment.body %>

data/app/views/commontator/comments/_form.html.erb

@@ -22,18 +22,18 @@
 <% end %>
 
 <%= form_for([commontator, thread, comment],
-             :remote => !no_remote) do |f| %>
+             remote: !no_remote) do |f| %>
 
   <%= hidden_field_tag :per_page, per_page %>
   
   <div class="comment_form_field">
-    <%= f.text_area :body, :rows => '7' %>
+    <%= f.text_area :body, rows: '7' %>
     <%= javascript_tag('Commontator.initMentions()') if Commontator.mentions_enabled %>
   </div>
   
   <div class="comment_form_actions">
     <%= f.submit t("commontator.comment.actions.#{comment.id.blank? ? 'create' : 'update'}") %>
-    <%= f.submit t('commontator.comment.actions.cancel'), :name => 'cancel' %>
+    <%= f.submit t('commontator.comment.actions.cancel'), name: 'cancel' %>
   </div>
   
 <% end %>