commontator 4.3.0 → 4.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5f1da2a02197f163447acc16e100cd68dcf5d9ca
-  data.tar.gz: d1acf36d536120df6da263a90a6d93af3f9b0e97
+  metadata.gz: 95f7d24f572a92460e3feb574f48e3abfe55cf51
+  data.tar.gz: 80d83a831ca9d26f9aaec72e98611aa10e1c2778
 SHA512:
-  metadata.gz: 292fc0ce3e1321498e859a86b69b508902b8ff842622173455ef2c6b7be6d57bacf1f67c5836e31837f4d219bb49d009ffce6db542dd600c49f69bf08f77054c
-  data.tar.gz: a5a1b93033172c2f3e7390c6b15962be3b457f79dd8b46ba671f4bc9d74ac4aea1b0e8e716cf72a939131405d77960a17636eadeb02e9e3494c3c59c55026834
+  metadata.gz: c3cef85703c6ea3fe65f317e96404be9f6e55cfcdb7e27d4dec3b3da7aaceafe3bf504ccffe14b959ef5516d09a07669efcb948cd9f18ea9e8d188ec6ad533f3
+  data.tar.gz: 66e364a7b162b8223bea6a9ac97b08beb6977ed902a481ac50d1da490dcc127fc874a58ced12becd58c1a6534ab927d637ea1390ffe4ae78634a6e28a759b0cf

data/README.md

@@ -14,7 +14,7 @@ There are 4 steps you must follow to install commontator:
   Add this line to your application's Gemfile:
 
   ```ruby
-  gem 'commontator', '~> 4.3.0'
+  gem 'commontator', '~> 4.4.1'
   ```
 
   And then execute:
@@ -55,7 +55,8 @@ There are 4 steps you must follow to install commontator:
 
 3. Configuration
 
-  Change commontator's configurations to suit your needs by editing config/intializers/commontator.rb.
+  Change commontator's configurations to suit your needs by editing `config/initializers/commontator.rb`.
+  Make sure to check that your configuration file is up to date every time you update the gem, as available options can change with each minor version.
 
 4. Routes
 
@@ -97,14 +98,13 @@ Follow the steps below to add commontator to your models and views:
 
   This will create a link in the view that the user will be able to click to display the comment thread.
 
-  Note that model's record must already exist in the database, so do not use this in new.html.erb, _form.html.erb or similar.
-  We recommend you use this in the model's show.html.erb.
+  Note that model's record must already exist in the database, so do not use this in `new.html.erb`, `_form.html.erb` or similar.
+  We recommend you use this in the model's `show.html.erb` or similar.
 
 3. Controllers
 
   By default, the `commontator_thread` method only links to the desired comment thread.
-  If you want, instead, to have the thread display right away when the corresponding view page is loaded,
-  just add the following method call to the controller action that displays the view in question:
+  If you want, instead, to have the thread display right away when the corresponding view page is loaded, just add the following method call to the controller action that displays the view in question:
   
   ```ruby
   commontator_thread_show(commontable)
@@ -112,15 +112,14 @@ Follow the steps below to add commontator to your models and views:
 
   Note that the call to `commontator_thread` in the view is still necessary in either case.
 
-  The `commontator_thread_show` method checks the current user's read permission on the thread and will raise an
-  exception if the user is not allowed to read it according to the configuration options in the initializer.
+  The `commontator_thread_show` method checks the current user's read permission on the thread and will raise an exception if the user is not allowed to read it according to the configuration options in the initializer.
   It is up to you to ensure that this method is only called if the user is authorized to read the thread.
 
 That's it! Commontator is now ready for use.
 
 ## Voting
 
-You can allow users to vote on each others' comments by adding the acts_as_votable gem to your gemfile:
+You can allow users to vote on each others' comments by adding the `acts_as_votable` gem to your gemfile:
 
 ```ruby
 gem 'acts_as_votable'
@@ -132,8 +131,8 @@ And enabling the relevant option in commontator's initializer:
 config.can_vote_on_comments = true
 ```
 
-Note that acts_as_votable is currently incompatible with the protected_attributes
-gem if config.active_record.whitelist_attributes is set to true.
+Note that `acts_as_votable` is currently incompatible with the `protected_attributes`
+gem if `config.active_record.whitelist_attributes` is true.
 
 ## Browser Support
 
@@ -145,6 +144,8 @@ To function properly, this gem requires that visitors to the site have javascrip
 Copy commontator's files to your app using any of the following commands:
 
 ```sh
+$ rake commontator:copy:locales
+
 $ rake commontator:copy:images
 $ rake commontator:copy:stylesheets
 
@@ -158,6 +159,12 @@ $ rake commontator:copy:models
 
 You are now free to modify them and have any changes made manifest in your application.
 
+If copying commontator's locales, please note that by default Rails will not autoload locales in subfolders of `config/locales` (like ours) unless you add the following to your application's configuration file:
+
+```rb
+config.i18n.load_path += Dir[root.join('config', 'locales', '**', '*.{rb,yml}')]
+```
+
 ## Contributing
 
 1. Fork it

data/app/assets/stylesheets/commontator/comments.css

@@ -64,7 +64,9 @@
 
 .comment_votes {
   float: right;
-  
+  margin-top: 5px;
+  margin-bottom: 5px;
+
   text-align: center;
 }
 
@@ -80,8 +82,27 @@
   margin: 0px;
 }
 
-.comment_vote_count p {
-  margin: 0px;
+.comment_vote_count {
+  margin-top: 7px;
+  margin-bottom: 7px;
+}
+
+.comment_upvote {
+  display: block;
+  height: 32px;
+}
+
+.comment_downvote {
+  display: block;
+  height: 32px;
+}
+
+.comment_like {
+  float: left;
+}
+
+.comment_like + .comment_vote_count {
+  float: right;
 }
 
 .comment_error_explanation {

data/app/controllers/commontator/application_controller.rb

@@ -13,18 +13,23 @@ module Commontator
     end
 
     def ensure_user
-      raise SecurityTransgression unless (@user && @user.is_commontator)
+      security_transgression_unless(@user && @user.is_commontator)
     end
     
     def get_thread
       @thread = params[:thread_id].blank? ? \
         Commontator::Thread.find(params[:id]) : \
         Commontator::Thread.find(params[:thread_id])
-      raise SecurityTransgression if @thread.commontable.nil?
+      security_transgression_unless !@thread.commontable.nil?
     end
     
     def set_commontable_url
-      self.commontable_url = @thread.config.commontable_url_proc.call(main_app, @thread.commontable)
+      self.commontable_url = @thread.config.commontable_url_proc.call(
+                               @thread.commontable, main_app)
+    end
+
+    def security_transgression_unless(check)
+      raise SecurityTransgression unless check
     end
   end
 end

data/app/controllers/commontator/comments_controller.rb

@@ -10,7 +10,7 @@ module Commontator
       @comment.thread = @thread
       @comment.creator = @user
 
-      raise SecurityTransgression unless @comment.can_be_created_by?(@user)
+      security_transgression_unless @comment.can_be_created_by?(@user)
 
       respond_to do |format|
         format.html { redirect_to @thread }
@@ -26,16 +26,17 @@ module Commontator
       @comment.thread = @thread
       @comment.creator = @user
       
-      raise SecurityTransgression unless @comment.can_be_created_by?(@user)
+      security_transgression_unless @comment.can_be_created_by?(@user)
       
       respond_to do |format|
         if  !params[:cancel].nil?
           format.html { redirect_to @thread }
           format.js { render :cancel }
         elsif @comment.save
-          @thread.subscribe(@user) if @thread.config.auto_subscribe_on_comment
+          @thread.subscribe(@user) if @thread.config.thread_subscription == :a ||\
+                                      @thread.config.thread_subscription == :b
           @thread.add_unread_except_for(@user)
-          recipients = @thread.active_subscribers.reject{|s| s == @user}
+          recipients = @thread.subscribers.reject{|s| s == @user}
           SubscriptionsMailer.comment_created(@comment, recipients).deliver \
             unless recipients.empty?
 
@@ -50,7 +51,7 @@ module Commontator
 
     # GET /comments/1/edit
     def edit
-      raise SecurityTransgression unless @comment.can_be_edited_by?(@user)
+      security_transgression_unless @comment.can_be_edited_by?(@user)
 
       respond_to do |format|
         format.html { redirect_to @thread }
@@ -60,7 +61,7 @@ module Commontator
 
     # PUT /comments/1
     def update
-      raise SecurityTransgression unless @comment.can_be_edited_by?(@user)
+      security_transgression_unless @comment.can_be_edited_by?(@user)
       @comment.body = params[:comment].nil? ? nil : params[:comment][:body]
       @comment.editor = @user
 
@@ -80,7 +81,7 @@ module Commontator
 
     # PUT /comments/1/delete
     def delete
-      raise SecurityTransgression unless @comment.can_be_deleted_by?(@user)
+      security_transgression_unless @comment.can_be_deleted_by?(@user)
 
       @comment.errors.add(:base, t('commontator.comment.errors.already_deleted')) \
         unless @comment.delete_by(@user)
@@ -93,7 +94,7 @@ module Commontator
     
     # PUT /comments/1/undelete
     def undelete
-      raise SecurityTransgression unless @comment.can_be_deleted_by?(@user)
+      security_transgression_unless @comment.can_be_deleted_by?(@user)
 
       @comment.errors.add(:base, t('commontator.comment.errors.not_deleted')) \
         unless @comment.undelete_by(@user)
@@ -106,7 +107,7 @@ module Commontator
     
     # PUT /comments/1/upvote
     def upvote
-      raise SecurityTransgression unless @comment.can_be_voted_on_by?(@user)
+      security_transgression_unless @comment.can_be_voted_on_by?(@user)
       
       @comment.upvote_from @user
 
@@ -118,7 +119,8 @@ module Commontator
     
     # PUT /comments/1/downvote
     def downvote
-      raise SecurityTransgression unless @comment.can_be_voted_on_by?(@user)
+      security_transgression_unless @comment.can_be_voted_on_by?(@user) &&\
+        @comment.thread.config.comment_voting.to_sym == :ld
       
       @comment.downvote_from @user
 
@@ -130,7 +132,7 @@ module Commontator
     
     # PUT /comments/1/unvote
     def unvote
-      raise SecurityTransgression unless @comment.can_be_voted_on_by?(@user)
+      security_transgression_unless @comment.can_be_voted_on_by?(@user)
       
       @comment.unvote :voter => @user
 

data/app/controllers/commontator/subscriptions_controller.rb

@@ -4,7 +4,7 @@ module Commontator
 
     # PUT /threads/1/subscribe
     def subscribe
-      raise SecurityTransgression unless @thread.can_subscribe?(@user)
+      security_transgression_unless @thread.can_subscribe?(@user)
 
       @thread.errors.add(:base, t('commontator.subscription.errors.already_subscribed')) \
         unless @thread.subscribe(@user)
@@ -18,7 +18,7 @@ module Commontator
 
     # PUT /threads/1/unsubscribe
     def unsubscribe
-      raise SecurityTransgression unless @thread.can_subscribe?(@user)
+      security_transgression_unless @thread.can_subscribe?(@user)
 
       @thread.errors.add(:base, t('commontator.subscription.errors.not_subscribed')) \
         unless @thread.unsubscribe(@user)

data/app/controllers/commontator/threads_controller.rb

@@ -17,7 +17,7 @@ module Commontator
     
     # PUT /threads/1/close
     def close
-      raise SecurityTransgression unless @thread.can_be_edited_by?(@user)
+      security_transgression_unless @thread.can_be_edited_by?(@user)
 
       @thread.errors.add(:base, t('commontator.thread.errors.already_closed')) \
         unless @thread.close(@user)
@@ -30,7 +30,7 @@ module Commontator
     
     # PUT /threads/1/reopen
     def reopen
-      raise SecurityTransgression unless @thread.can_be_edited_by?(@user)
+      security_transgression_unless @thread.can_be_edited_by?(@user)
 
       @thread.errors.add(:base, t('commontator.thread.errors.not_closed')) \
         unless @thread.reopen

data/app/mailers/commontator/subscriptions_mailer.rb

@@ -1,15 +1,12 @@
 module Commontator
   class SubscriptionsMailer < ActionMailer::Base
-    include SharedHelper
-    include ThreadsHelper
-  
     def comment_created(comment, recipients)
       setup_variables(comment, recipients)
 
       mail :to => @to,
            :bcc => @bcc,
            :from => @from,
-           :subject => t('commontator.emails.comment_created.subject',
+           :subject => t('commontator.email.comment_created.subject',
                          :creator_name => @creator_name,
                          :commontable_name => @commontable_name,
                          :commontable_url => @commontable_url)
@@ -25,9 +22,9 @@ module Commontator
       @commontable = @thread.commontable
       @config = @thread.config
 
-      @creator_name = commontator_name(@creator)
+      @creator_name = @creator.commontator_name
 
-      @commontable_name = commontable_name(@thread)
+      @commontable_name = @commontable.commontable_name
 
       @commontable_url = ApplicationController.commontable_url
 
@@ -41,8 +38,8 @@ module Commontator
       params[:commontable_name] = @commontable_name
       params[:commontable_url] = @commontable_url
 
-      @to = t('commontator.emails.undisclosed_recipients')
-      @bcc = recipients.collect{|s| commontator_email(s)}
+      @to = t('commontator.email.undisclosed_recipients')
+      @bcc = recipients.collect{|s| s.commontator_email(self)}
       @from = @config.email_from_proc.call(self)
     end
   end

data/app/models/commontator/comment.rb

@@ -11,8 +11,9 @@ module Commontator
     validates_presence_of :thread
     validates_presence_of :body
 
-    validates_uniqueness_of :body, :scope => [:creator_type, :creator_id, :thread_id],
-                                   :message => I18n.t('commontator.comment.errors.double_posted')
+    validates_uniqueness_of :body,
+      :scope => [:creator_type, :creator_id, :thread_id],
+      :message => I18n.t('commontator.comment.errors.double_posted')
 
     protected
 
@@ -58,43 +59,60 @@ module Commontator
       self.save
     end
 
+    def created_timestamp
+      I18n.t 'commontator.comment.status.created_at',
+             :created_at => I18n.l(created_at, :format => :commontator)
+    end
+    
+    def updated_timestamp
+      return '' if editor.nil?
+      
+      I18n.t 'commontator.comment.status.updated_at',
+             :editor_name => editor.commontator_name,
+             :updated_at => I18n.l(updated_at, :format => :commontator)
+    end
+
     ##################
     # Access Control #
     ##################
 
     def can_be_read_by?(user)
-      ((!is_deleted? || thread.config.deleted_comments_are_visible) &&\
-        thread.can_be_read_by?(user)) ||\
-      thread.can_be_edited_by?(user)
+      return true if thread.can_be_edited_by?(user)
+      (!is_deleted? || !thread.config.hide_deleted_comments) &&\
+      thread.can_be_read_by?(user)
     end
 
     def can_be_created_by?(user)
-      !thread.is_closed? && user == creator && thread.can_be_read_by?(user)
+      user == creator && user.is_commontator &&\
+      !thread.is_closed? && thread.can_be_read_by?(user)
     end
 
     def can_be_edited_by?(user)
-      (!thread.is_closed? && !is_deleted? &&\
-        (is_latest? || thread.config.can_edit_old_comments) &&\
-          user == creator && thread.config.can_edit_own_comments &&\
-          thread.can_be_read_by?(user)) ||\
-        (thread.config.moderators_can_edit_comments &&\
-          thread.can_be_edited_by?(user))
+      return true if thread.config.moderators_can_edit_comments &&\
+                     thread.can_be_edited_by?(user)
+      comment_edit = thread.config.comment_editing.to_sym
+      !thread.is_closed? && !is_deleted? && user == creator &&\
+      comment_edit != :n && (is_latest? || comment_edit == :a) &&\
+      thread.can_be_read_by?(user)
     end
 
     def can_be_deleted_by?(user)
-      (!thread.is_closed? && (!is_deleted? || editor == user) &&\
-        (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)
+      return true if thread.can_be_edited_by?(user)
+      comment_del = thread.config.comment_deletion.to_sym
+      !thread.is_closed? && (!is_deleted? || editor == user) &&\
+      user == creator && comment_del != :n &&\
+      (is_latest? || comment_del == :a) &&\
+      thread.can_be_read_by?(user)
     end
 
     def can_be_voted_on?
-      !thread.is_closed? && is_votable? && !is_deleted? && thread.config.can_vote_on_comments
+      !thread.is_closed? && !is_deleted? &&\
+      thread.config.comment_voting != :n && is_votable?
     end
 
     def can_be_voted_on_by?(user)
-      can_be_voted_on? && user && user.is_commontator && user != creator && thread.can_be_read_by?(user)
+      !user.nil? && user.is_commontator && user != creator &&\
+      thread.can_be_read_by?(user) && can_be_voted_on?
     end
   end
 end

data/app/models/commontator/thread.rb

@@ -7,18 +7,20 @@ module Commontator
     has_many :subscriptions, :dependent => :destroy
 
     validates_presence_of :commontable, :unless => :is_closed?
-    validates_uniqueness_of :commontable_id, :scope => :commontable_type, :allow_nil => true
+    validates_uniqueness_of :commontable_id,
+                            :scope => :commontable_type,
+                            :allow_nil => true
 
     def config
       commontable.try(:commontable_config) || Commontator
     end
 
     def ordered_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
+      case config.comment_order.to_sym
+      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
 
@@ -30,10 +32,6 @@ module Commontator
       subscriptions.collect{|s| s.subscriber}
     end
 
-    def active_subscribers
-      subscribers.select{|s| s.is_commontator && s.commontator_config.user_email_enable_proc.call(s)}
-    end
-
     def subscription_for(subscriber)
       return nil if !subscriber || !subscriber.is_commontator
       subscriber.subscriptions.where(:thread_id => self.id).first
@@ -105,24 +103,24 @@ module Commontator
     # Access Control #
     ##################
 
-    # Reader capabilities (user can be nil or false)
+    # Reader capabilities (remember: user can be nil or false)
     def can_be_read_by?(user)
-      (!commontable.nil? &&\
-        (!is_closed? || config.closed_threads_are_readable) &&\
-        config.can_read_thread_proc.call(self, user)) ||\
-      can_be_edited_by?(user)
+      return true if can_be_edited_by?(user)
+      !commontable.nil? && (!is_closed? || !config.hide_closed_threads) &&\
+      config.thread_read_proc.call(self, user)
     end
 
     # Thread moderator capabilities
     def can_be_edited_by?(user)
-      !commontable.nil? && user && user.is_commontator &&\
-      (user.commontator_config.user_admin_proc.call(user) ||\
-        config.can_edit_thread_proc.call(self, user))
+      !commontable.nil? && !user.nil? && user.is_commontator &&\
+      config.thread_moderator_proc.call(self, user)
     end
 
     def can_subscribe?(user)
-      !is_closed? && user && user.is_commontator &&\
-      config.can_subscribe_to_thread && can_be_read_by?(user)
+      thread_sub = config.thread_subscription.to_sym
+      !is_closed? && !user.nil? && user.is_commontator &&\
+      thread_sub != :n && thread_sub != :a &&\
+      can_be_read_by?(user)
     end
   end
 end