commontator 4.1.2 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 871a16d73340c7eb75bc49f2329432bf6dcbc679
-  data.tar.gz: 13c27ed2620146b5d6d48ef386c723e67d5a2249
+  metadata.gz: 62ff7e0ae14f2179de8ad2f079f27c5647a253bb
+  data.tar.gz: 205e1137acfdea70a5d0ded9c7714b0e85d494dd
 SHA512:
-  metadata.gz: 401a0f8fc62eb0e88c340a96bf7b766bc8be6ac79b551d5944ce1beb1939272a1083b08da5f12e00a50077630515298c7f5dc5b469a73d21fa052d7d824210c3
-  data.tar.gz: 6dd7959ccca36945f04bc219b9f1cf4fc08cc951eacd1e912b8e19dfde7019122f565f087a4ca190980104fd4fefccf05852a9ef0487ce9445970bd500c8cfc8
+  metadata.gz: 60f0a5755fa8b1f143a4e492463d017c37effc7c5d5e3fb7a327d15e78b4f1077df459e04f0e25849a0fbeded4197009f96fc0195c59608e969d0a35afca5be5
+  data.tar.gz: 401709696330a73aba059e47dfc40ca35324ee3a0909ac306f01b819c69bcfea50b37fa4ed5862942585f79b42afed4d7dff59fd78faca02f561a24999f32395

data/README.md

@@ -13,7 +13,7 @@ There are 4 steps you must follow to install commontator:
   Add this line to your application's Gemfile:
 
   ```ruby
-  gem 'commontator', '~> 4.1.2'
+  gem 'commontator', '~> 4.2.0'
   ```
 
   And then execute:

data/app/mailers/commontator/subscriptions_mailer.rb

@@ -6,7 +6,7 @@ module Commontator
     def comment_created(comment, recipients)
       setup_variables(comment, recipients)
 
-      mail :to => 'Undisclosed Recipients',
+      mail :to => @to,
            :bcc => @bcc,
            :from => @from,
            :subject => @subject
@@ -18,17 +18,17 @@ module Commontator
       @comment = comment
       @thread = @comment.thread
       @creator = @comment.creator
-      
+
       @commontable = @thread.commontable
       @config = @thread.config
-      
+
       @creator_name = commontator_name(@creator)
       @comment_created_timestamp = @comment.created_timestamp
-      
+
       @commontable_name = commontable_name(@thread)
-      
+
       @commontable_url = ApplicationController.commontable_url
-      
+
       params = Hash.new
       params[:comment] = @comment
       params[:thread] = @thread
@@ -39,7 +39,8 @@ module Commontator
       params[:comment_created_timestamp] = @comment_created_timestamp
       params[:commontable_name] = @commontable_name
       params[:commontable_url] = @commontable_url
-      
+
+      @to = @config.subscription_email_to_proc.call(params)
       @bcc = recipients.collect{|s| commontator_email(s)}
       @from = @config.subscription_email_from_proc.call(params)
       @subject = @config.subscription_email_subject_proc.call(params)

data/app/mailers/commontator/subscriptions_mailer.rb~

@@ -6,7 +6,7 @@ module Commontator
     def comment_created(comment, recipients)
       setup_variables(comment, recipients)
 
-      mail :to => 'Undisclosed Recipients',
+      mail :to => @to
            :bcc => @bcc,
            :from => @from,
            :subject => @subject
@@ -18,18 +18,17 @@ module Commontator
       @comment = comment
       @thread = @comment.thread
       @creator = @comment.creator
-      
+
       @commontable = @thread.commontable
       @config = @thread.config
-      
+
       @creator_name = commontator_name(@creator)
       @comment_created_timestamp = @comment.created_timestamp
-      
+
       @commontable_name = commontable_name(@thread)
-      @commontable_id = commontable_id(@thread).to_s
-      
+
       @commontable_url = ApplicationController.commontable_url
-      
+
       params = Hash.new
       params[:comment] = @comment
       params[:thread] = @thread
@@ -39,9 +38,9 @@ module Commontator
       params[:creator_name] = @creator_name
       params[:comment_created_timestamp] = @comment_created_timestamp
       params[:commontable_name] = @commontable_name
-      params[:commontable_id] = @commontable_id
       params[:commontable_url] = @commontable_url
-      
+
+      @to = @config.subscription_email_to_proc.call(params)
       @bcc = recipients.collect{|s| commontator_email(s)}
       @from = @config.subscription_email_from_proc.call(params)
       @subject = @config.subscription_email_subject_proc.call(params)

data/app/models/commontator/comment.rb

@@ -20,6 +20,14 @@ module Commontator
 
     public
 
+    def is_modified?
+      !editor.nil?
+    end
+
+    def is_latest?
+      thread.comments.last == self
+    end
+
     def is_votable?
       return true if acts_as_votable_initialized
       return false unless self.class.respond_to?(:acts_as_votable)
@@ -32,10 +40,6 @@ module Commontator
       votes.where(:voter_type => user.class.name, :voter_id => user.id).first
     end
 
-    def is_modified?
-      !editor.nil?
-    end
-
     def is_deleted?
       !deleted_at.blank?
     end
@@ -82,14 +86,14 @@ module Commontator
 
     def can_be_edited_by?(user)
       (!thread.is_closed? && !is_deleted? &&\
-        (thread.comments.last == self || thread.config.can_edit_old_comments) &&\
+        (is_latest? || thread.config.can_edit_old_comments) &&\
         user == creator && thread.config.can_edit_own_comments && thread.can_be_read_by?(user)) ||\
       (thread.config.admin_can_edit_comments && thread.can_be_edited_by?(user))
     end
 
     def can_be_deleted_by?(user)
       (!thread.is_closed? && (!is_deleted? || editor == user) &&\
-        (thread.comments.last == self || thread.config.can_delete_old_comments) &&\
+        (is_latest? || thread.config.can_delete_old_comments) &&\
         user == creator && thread.config.can_delete_own_comments &&\
         thread.can_be_read_by?(user)) ||\
       thread.can_be_edited_by?(user)

data/app/models/commontator/comment.rb~

@@ -20,6 +20,14 @@ module Commontator
 
     public
 
+    def is_modified?
+      !editor.nil?
+    end
+
+    def is_latest?
+      thread.comments.last == self
+    end
+
     def is_votable?
       return true if acts_as_votable_initialized
       return false unless self.class.respond_to?(:acts_as_votable)
@@ -28,14 +36,10 @@ module Commontator
     end
 
     def get_vote_by(user)
-      return nil unless is_votable?
+      return nil unless is_votable? && user && user.is_commontator
       votes.where(:voter_type => user.class.name, :voter_id => user.id).first
     end
 
-    def is_modified?
-      !editor.nil?
-    end
-
     def is_deleted?
       !deleted_at.blank?
     end
@@ -82,7 +86,7 @@ module Commontator
 
     def can_be_edited_by?(user)
       (!thread.is_closed? && !is_deleted? &&\
-        (thread.comments.last == self || thread.config.can_edit_old_comments) &&\
+        (is_latest? || thread.config.can_edit_old_comments) &&\
         user == creator && thread.config.can_edit_own_comments && thread.can_be_read_by?(user)) ||\
       (thread.config.admin_can_edit_comments && thread.can_be_edited_by?(user))
     end

data/app/models/commontator/thread.rb

@@ -14,8 +14,12 @@ module Commontator
     end
 
     def ordered_comments
-      (config.can_vote_on_comments && config.comments_ordered_by_votes) ? \
-        comments.order("cached_votes_down - cached_votes_up") : comments
+      case config.comments_order
+        when :l then comments.order('id DESC')
+        when :ve then comments.order('cached_votes_down - cached_votes_up')
+        when :vl then comments.order('cached_votes_down - cached_votes_up', 'id DESC')
+        else comments
+      end
     end
 
     def is_closed?

data/app/models/commontator/thread.rb~

@@ -14,8 +14,12 @@ module Commontator
     end
 
     def ordered_comments
-      (config.can_vote_on_comments && config.comments_ordered_by_votes) ? \
-        comments.order("cached_votes_down - cached_votes_up") : comments
+      case config.comments_order
+        when :l then comments.order('id DESC')
+        when :ve then comments.order('cached_votes_down - cached_votes_up')
+        when :vl then comments.order('cached_votes_down - cached_votes_up', '')
+        else comments
+      end
     end
 
     def is_closed?
@@ -32,7 +36,6 @@ module Commontator
 
     def subscription_for(subscriber)
       return nil if !subscriber || !subscriber.is_commontator
-      return nil if !subscriber.is_commontator
       subscriber.subscriptions.where(:thread_id => self.id).first
     end
 

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

@@ -0,0 +1,11 @@
+<% # Clients of this partial must supply the following variables:
+   # comments
+   # user
+%>
+
+<% comments.each do |comment| %>
+  <% next unless comment.can_be_read_by?(user) %>
+  <%= render :partial => 'commontator/comments/show',
+             :locals => {:comment => comment,
+                         :user => user} %>
+<% end %>

data/app/views/commontator/comments/_list.html.erb~

@@ -0,0 +1,11 @@
+<% # Clients of this partial must supply the following variables:
+   # comments
+   # user
+%>
+
+<% thread.ordered_comments.each do |comment| %>
+  <% next unless comment.can_be_read_by?(user) %>
+  <%= render :partial => 'commontator/comments/show',
+             :locals => {:comment => comment,
+                         :user => user} %>
+<% end %>

data/app/views/commontator/comments/create.js.erb

@@ -1,17 +1,12 @@
-<% @thread.comments.each do |comment| %>
-  $("#comment_<%= comment.id.to_s %>_actions_span").html("<%= escape_javascript(
-    render :partial => 'actions',
-           :locals => {:comment => comment,
+$("#thread_<%= @thread.id %>_comment_list_div").html("<%= escape_javascript(
+    render :partial => 'list',
+           :locals => {:comments => @thread.ordered_comments,
                        :user => @user}) %>");
-<% end %>
-
-$("#thread_<%= @thread.id %>_comment_list_div").append("<%= escape_javascript(
-  render :partial => 'show',
-         :locals => {:comment => @comment,
-                     :user => @user}) %>");
 
 $("#thread_<%= @thread.id %>_new_comment_div").hide();
 
-$("#thread_<%= @thread.id %>_new_comment_link_span").show();
+$("#thread_<%= @thread.id %>_new_comment_link_span").fadeIn();
+
+$("#comment_<%= @comment.id.to_s %>_div").hide().fadeIn()[0].scrollIntoView();
 
 <%= javascript_proc %>

data/app/views/commontator/comments/create.js.erb~

@@ -0,0 +1,12 @@
+$("#thread_<%= @thread.id %>_comment_list_div").html("<%= escape_javascript(
+    render :partial => 'list',
+           :locals => {:comments => @thread.ordered_comments,
+                       :user => @user}) %>");
+
+$("#thread_<%= @thread.id %>_new_comment_div").hide();
+
+$("#thread_<%= @thread.id %>_new_comment_link_span").fadeIn();
+
+$("#comment_<%= @comment.id.to_s %>_div").hide().fadeIn()[0].scrollIntoView();
+
+$("#error_explanation").remove();

data/app/views/commontator/comments/delete.js.erb~

@@ -2,7 +2,7 @@ $("#comment_<%= @comment.id.to_s %>_body_div").html("<%= escape_javascript(
   render :partial => 'body', :locals => {:comment => @comment}) %>");
 
 $("#comment_<%= @comment.id.to_s %>_updated_timestamp_span").html("<%= escape_javascript(
-  "#{@comment.updated_timestamp} by #{commontator_name(comment.editor)}") %>");
+  "#{@comment.updated_timestamp} by #{commontator_name(@comment.editor)}") %>");
                                                            
 $("#comment_<%= @comment.id.to_s %>_actions_span").html("<%= escape_javascript(
   render :partial => 'actions',
@@ -14,4 +14,4 @@ $("#comment_<%= @comment.id %>_votes_span").html("<%= escape_javascript(
          :locals => {:comment => @comment,
                      :user => @user}) %>");
 
-<%= javascript_proc %>
+$("#error_explanation").remove();

data/app/views/commontator/comments/edit.js.erb~

@@ -0,0 +1,5 @@
+$("#comment_<%= @comment.id.to_s %>_body_div").html("<%= escape_javascript(
+  render :partial => 'form',
+         :locals => {:comment => @comment}) %>");
+         
+$("#error_explanation").remove();

data/app/views/commontator/comments/new.js.erb

@@ -5,7 +5,7 @@ $("#thread_<%= @thread.id %>_new_comment_div").html("<%= escape_javascript(
                        :thread => @thread
                     }) %>");
                     
-$("#thread_<%= @thread.id %>_new_comment_div").show();
+$("#thread_<%= @thread.id %>_new_comment_div").fadeIn()[0].scrollIntoView();
 
 $("#thread_<%= @thread.id %>_new_comment_link_span").hide();
 

data/app/views/commontator/comments/new.js.erb~

@@ -0,0 +1,12 @@
+$("#thread_<%= @thread.id %>_new_comment_div").html("<%= escape_javascript(
+  render :partial => 'form',
+         :locals => {
+                       :comment => @comment,
+                       :thread => @thread
+                    }) %>");
+                    
+$("#thread_<%= @thread.id %>_new_comment_div").fadeIn()[0].scrollIntoView();
+
+$("#thread_<%= @thread.id %>_new_comment_link_span").hide();
+
+$("#error_explanation").remove();

data/app/views/commontator/comments/update.js.erb~

@@ -2,6 +2,6 @@ $("#comment_<%= @comment.id.to_s %>_body_div").html("<%= escape_javascript(
   render :partial => 'body', :locals => {:comment => @comment}) %>");
 
 $("#comment_<%= @comment.id.to_s %>_updated_timestamp_span").html("<%= escape_javascript(
-                                                           @comment.updated_timestamp) %>");
+  "#{@comment.updated_timestamp} by #{commontator_name(@comment.editor)}") %>");
 
-<%= javascript_proc %>
+$("#error_explanation").remove();

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

@@ -36,12 +36,9 @@
 </span>
 
 <div id="thread_<%= thread.id.to_s %>_comment_list_div" class="thread_comment_list">
-  <% thread.ordered_comments.each do |comment| %>
-    <% next unless comment.can_be_read_by?(user) %>
-    <%= render :partial => 'commontator/comments/show',
-               :locals => {:comment => comment,
-                           :user => user} %>
-  <% end %>
+  <%= render :partial => 'commontator/comments/list',
+             :locals => {:comments => thread.ordered_comments,
+                         :user => user} %>
 </div>
 
 <% if thread.is_closed? %>

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

@@ -36,6 +36,9 @@
 </span>
 
 <div id="thread_<%= thread.id.to_s %>_comment_list_div" class="thread_comment_list">
+  <%= render :partial => 'commontator/comments/list',
+             :locals => {:comments => thread.ordered_comments,
+                         :user => user} %>
   <% thread.ordered_comments.each do |comment| %>
     <% next unless comment.can_be_read_by?(user) %>
     <%= render :partial => 'commontator/comments/show',
@@ -47,7 +50,7 @@
 <% if thread.is_closed? %>
   <p><%= thread.config.comment_name.capitalize.pluralize %> cannot be <%= thread.config.comment_create_verb_past %> at this time.</p>
 <% elsif !user %>
-  <p>You must log in before you can <%= thread.config.comment_create_verb_present %> a <%= thread.config.comment_name %> to this thread.</p>
+  <p>You must log in before you can <%= thread.config.comment_create_verb_present %> a <%= thread.config.comment_name %>.</p>
 <% else %>
   <div id="thread_<%= thread.id %>_new_comment_div" class="thread_new_comment"></div>
 

data/config/initializers/commontator.rb

@@ -8,13 +8,14 @@ Commontator.configure do |config|
   # Default: lambda { |controller| controller.current_user }
   config.current_user_proc = lambda { |controller| controller.current_user }
 
-  # Proc that is called after any javascript runs (e.g. to display/clear flash messages)
-  # It is passed the view_context object (self from the view template), so you should be able to
-  # access anything you normally could in a view template (by using, e.g. view.flash)
-  # However, be aware that it does not have access to the main application's helpers
-  # Should return a string containing JS to be appended to all Commontator JS responses
-  # Default: lambda { |view| '$("#error_explanation").remove();' }
-  config.javascript_proc = lambda { |view| '$("#error_explanation").remove();' }
+  # Proc called with the view_context object as argument
+  # Returns a string to be appended to all JavaScript responses from commontator
+  # Can be used, for example, to display/clear Rails error messages
+  # Objects visible in view templates can be accessed through
+  # the view_context object (for example, view_context.flash)
+  # However, the view_context does not include the main application's helpers
+  # Default: lambda { |view_context| '$("#error_explanation").remove();' }
+  config.javascript_proc = lambda { |view_context| '$("#error_explanation").remove();' }
 
 
   # User (acts_as_commontator) Configuration
@@ -109,15 +110,14 @@ Commontator.configure do |config|
   # Default: false
   config.can_vote_on_comments = false
 
-  # Whether to display upvotes and downvotes
-  # combined or separately
-  # Default: true
-  config.combine_upvotes_and_downvotes = true
-
-  # Whether comments should be ordered by vote score
-  # instead of by order posted
-  # Default: false
-  config.comments_ordered_by_votes = false
+  # What order to use for comments
+  # Valid values:
+  #   :e (earliest comment first)
+  #   :l (latest comment first)
+  #   :ve (highest voted first; earliest first if tied)
+  #   :vl (highest voted first; latest first if tied)
+  # Default: :e (earliest comment first)
+  config.comments_order = :e
 
   # Whether users can read threads closed by moderators
   # Default: true
@@ -153,6 +153,14 @@ Commontator.configure do |config|
   # Default: lambda { |main_app, commontable| main_app.polymorphic_url(commontable) }
   # (defaults to the commontable's show url)
   config.commontable_url_proc = lambda { |main_app, commontable| main_app.polymorphic_url(commontable) }
+
+  # Proc called with params from the subscription mailer as arguments
+  # Returns the subscription email 'to' addresses
+  # Available params can be seen in the subscription mailer
+  # Note that the actual addresses are already set in the BCC field
+  # Default:
+  # lambda { |params| 'Undisclosed Recipients' }
+  config.subscription_email_to_proc = lambda { |params| 'Undisclosed Recipients' }
   
   # Proc called with params from the subscription mailer as arguments
   # Returns the subscription email 'from' address

data/config/initializers/commontator.rb~

@@ -5,14 +5,14 @@ Commontator.configure do |config|
 
   # Proc that is passed the current controller as argument
   # Returns the current user
-  # Default: 'current_user'
+  # Default: lambda { |controller| controller.current_user }
   config.current_user_proc = lambda { |controller| controller.current_user }
 
-  # Proc that is called after any javascript runs (e.g. to display/clear flash messages)
-  # It is passed the view_context object (self from the view template), so you should be able to
-  # access anything you normally could in a view template (by using, e.g. view.flash)
-  # However, be aware that it does not have access to the main application's helpers
-  # Should return a string containing JS to be appended to all Commontator JS responses
+  # Proc called with the view_context object as argument
+  # Returns a string to be appended to all JavaScript responses from commontator
+  # Can be used, for example, to display/clear Rails error messages
+  # Objects visible in view templates can be accessed through the view_context object
+  # However, the view_context does not include the main application's helpers
   # Default: lambda { |view| '$("#error_explanation").remove();' }
   config.javascript_proc = lambda { |view| '$("#error_explanation").remove();' }
 
@@ -109,15 +109,14 @@ Commontator.configure do |config|
   # Default: false
   config.can_vote_on_comments = false
 
-  # Whether to display upvotes and downvotes
-  # combined or separately
-  # Default: true
-  config.combine_upvotes_and_downvotes = true
-
-  # Whether comments should be ordered by vote score
-  # instead of by order posted
-  # Default: false
-  config.comments_ordered_by_votes = false
+  # What order to use for comments
+  # Valid values:
+  #   :e (earliest comment first)
+  #   :l (latest comment first)
+  #   :ve (highest voted first; earliest first if tied)
+  #   :vl (highest voted first; latest first if tied)
+  # Default: :e (earliest comment first)
+  config.comments_order = :e
 
   # Whether users can read threads closed by moderators
   # Default: true
@@ -153,6 +152,14 @@ Commontator.configure do |config|
   # Default: lambda { |main_app, commontable| main_app.polymorphic_url(commontable) }
   # (defaults to the commontable's show url)
   config.commontable_url_proc = lambda { |main_app, commontable| main_app.polymorphic_url(commontable) }
+
+  # Proc called with params from the subscription mailer as arguments
+  # Returns the subscription email 'to' addresses
+  # Available params can be seen in the subscription mailer
+  # Note that the actual addresses are already set in the BCC field
+  # Default:
+  # lambda { |params| 'Undisclosed Recipients' }
+  config.subscription_email_to_proc = lambda { |params| 'Undisclosed Recipients' }
   
   # Proc called with params from the subscription mailer as arguments
   # Returns the subscription email 'from' address