commontator 4.0.2 → 4.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f96ed4a2b92b92ce20a0ab78422775c3a5ada743
-  data.tar.gz: 1ef5a31ee4e7abd7bf27a873d6827b38203a9fd7
+  metadata.gz: 44192c2ae74567abb05fcbb08a8f9035435f8bd5
+  data.tar.gz: d99e1f12e46fbbbdaeb601b994ed5427d7a1bf7c
 SHA512:
-  metadata.gz: 239ae6a054aaa4f051648a4e9946b903b8d9fa5bca8d7c287edaeee5a34eccfa7bcfe705a844c2ad68ddc0c5e2dc6b9cebb9e9ac13248c34919d3b9c939a6b6e
-  data.tar.gz: f0317ca260ea97798c6d479d3d524f3ee8e859dce1950a4b56d7aad26630a0aaf6c1ae162dcba0d3c569b7548c4183005a305e340542cb46dc3c3670b6fc8435
+  metadata.gz: b5fd3c18561bb75f2fe5590dc462c72efe8931b00a2eea4e6aace1411fa37477f816de90daa881d5248b4aa3b21e62653140ef1853142848ba3980beaa8da97b
+  data.tar.gz: 0833ec342a5393094e9557a142503ac91ae9cf8d4676521fe3321ea0add1c0e5bac3690bdafe714f9fa204009d7e72743285c874cdfa8fc67a238e381554e8ec

data/README.md

@@ -95,12 +95,10 @@ Follow the steps below to add commontator to your models and views:
   Where commontable is an instance of some model that acts_as_commontable.
   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.
-  When you do this, it is up to you to ensure that the user has the proper permission
-  to read the thread or else a SecurityTransgression will be raised.
 
 3. Controllers
 
-  Instead of linking to the thread, you might want to have the thread display right away, when the corresponding view page is loaded.
+  Instead of linking to the thread, you might want to have the thread display right away when the corresponding view page is loaded.
   If that's the case, add the following to the controller action that displays the view where the thread is located:
   
   ```ruby
@@ -109,7 +107,7 @@ Follow the steps below to add commontator to your models and views:
 
   Note that the above method also checks the current user's read permission on the thread.
   It will raise a SecurityTransgression if the user is not allowed to read the thread.
-  You can specify the name of the method that determines which users are allowed to read which threads in the initializer.
+  You can specify the proc that determines which users are allowed to read which threads in the initializer.
 
 That's it! Commontator is now ready for use.
 
@@ -132,7 +130,7 @@ Note that acts_as_votable is currently incompatible with the protected_attribute
 ## Browser Support
 
 No incompatibilities are currently known with any of the major browsers.
-Currently commontator requires javascript enabled to function properly.
+Commontator requires javascript enabled to function properly.
 
 ## Customization
 

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

@@ -25,18 +25,21 @@
 
 .comment_body {
   margin-left: 55px;
-  margin-top: -60px;
   margin-right: 45px;
-   
+
   padding: 8px;
 }
 
 .comment_body p {
 	margin: 0px;
-	
+
 	overflow: hidden;
 }
 
+.comment_div {
+	clear: both;
+}
+
 .comment_form_actions {
   margin-top: 15px;
 }
@@ -48,16 +51,20 @@
 
 .comment_form_field textarea {
   padding: 0px;
-  
+
   width: 100%;
 }
 
-.comment_gravatar_image img {
+.comment_gravatar_image {
+  float: left;
+
   margin-top: 5px;
+  margin-bottom: 5px;
 }
 
 .comment_timestamp {
 	color: #777;
+  display: inline-block;
 }
 
 .comment_votes {
@@ -74,6 +81,10 @@
   margin: 0px;
 }
 
+.comment_votes form {
+  margin: 0px;
+}
+
 .comment_vote_count p {
   margin: 0px;
 }

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

@@ -0,0 +1,98 @@
+.comment {
+  font-size: 12px;
+  font-weight: normal;
+  font-style: normal;
+
+  border-top: 1px solid;
+  border-left: 1px solid;
+  
+  margin-top: 15px;
+  margin-bottom: 15px;
+
+  padding-top: 8px;
+  padding-left: 15px;
+
+  color: #000;
+  border-color: #ddd;
+  background-color: #fff;
+  
+  clear: both;
+}
+
+.comment_actions {
+  float: right;
+}
+
+.comment_body {
+  margin-left: 55px;
+  margin-right: 45px;
+
+  padding: 8px;
+}
+
+.comment_body p {
+	margin: 0px;
+
+	overflow: hidden;
+}
+
+.comment_div {
+	clear: both;
+}
+
+.comment_form_actions {
+  margin-top: 15px;
+}
+
+.comment_form_field > .field_with_errors {
+  display: block;
+  padding-right: 4px;
+}
+
+.comment_form_field textarea {
+  padding: 0px;
+
+  width: 100%;
+}
+
+.comment_gravatar_image {
+  float: left;
+
+  margin-top: 5px;
+  margin-bottom: 5px;
+}
+
+.comment_timestamp {
+	color: #777;
+  display: inline-block;
+}
+
+.comment_votes {
+  float: right;
+  
+  text-align: center;
+}
+
+.comment_votes input,
+.comment_votes img {
+  border: none;
+  background-color: transparent;
+  padding: 0px;
+  margin: 0px;
+}
+
+.comment_votes form {
+  border: none;
+  background-color: transparent;
+  padding: 0px;
+  margin: 0px;
+}
+
+.comment_vote_count p {
+  margin: 0px;
+}
+
+.comment_votes span {
+  padding: 0px;
+  margin: 0px;
+}

data/app/controllers/commontator/application_controller.rb

@@ -1,6 +1,6 @@
 module Commontator
   class ApplicationController < ActionController::Base
-    before_filter :get_user
+    before_filter :get_user, :ensure_user
     
     cattr_accessor :commontable_url
     
@@ -9,8 +9,11 @@ module Commontator
     protected
     
     def get_user
-      @user = self.send Commontator.current_user_method	
-      raise SecurityTransgression unless (@user.nil? || @user.is_commontator)
+      @user = Commontator.current_user_proc.call(self)	
+    end
+
+    def ensure_user
+      raise SecurityTransgression unless (@user && @user.is_commontator)
     end
     
     def get_thread

data/app/controllers/commontator/application_controller.rb~

@@ -0,0 +1,30 @@
+module Commontator
+  class ApplicationController < ActionController::Base
+    before_filter :get_user, :ensure_user
+    
+    cattr_accessor :commontable_url
+    
+    rescue_from SecurityTransgression, :with => lambda { head(:forbidden) }
+    
+    protected
+    
+    def get_user
+      @user = self.send Commontator.current_user_method	
+    end
+
+    def ensure_user
+      raise SecurityTransgression 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?
+    end
+    
+    def set_commontable_url
+      self.commontable_url = @thread.config.commontable_url_proc.call(main_app, @thread.commontable)
+    end
+  end
+end

data/app/controllers/commontator/threads_controller.rb

@@ -1,5 +1,7 @@
 module Commontator
   class ThreadsController < Commontator::ApplicationController
+    skip_before_filter :ensure_user, :only => :show
+
     before_filter :get_thread
     before_filter :set_commontable_url, :only => :show
 

data/app/controllers/commontator/threads_controller.rb~

@@ -0,0 +1,44 @@
+module Commontator
+  class ThreadsController < Commontator::ApplicationController
+    skip_before_filter :ensure_user, :only => :index
+
+    before_filter :get_thread
+    before_filter :set_commontable_url, :only => :show
+
+    # GET /threads/1
+    def show
+      commontator_thread_show(@thread.commontable)
+
+      respond_to do |format|
+        format.html { redirect_to commontable_url }
+        format.js
+      end
+    end
+    
+    # PUT /threads/1/close
+    def close
+      raise SecurityTransgression unless @thread.can_be_edited_by?(@user)
+
+      @thread.errors.add(:base, 'This thread has already been closed.') \
+        unless @thread.close(@user)
+
+      respond_to do |format|
+        format.html { redirect_to @thread }
+        format.js { render :show }
+      end
+    end
+    
+    # PUT /threads/1/reopen
+    def reopen
+      raise SecurityTransgression unless @thread.can_be_edited_by?(@user)
+
+      @thread.errors.add(:base, 'This thread is not closed.') \
+        unless @thread.reopen
+
+      respond_to do |format|
+        format.html { redirect_to @thread }
+        format.js { render :show }
+      end
+    end
+  end
+end

data/app/helpers/commontator/threads_helper.rb

@@ -1,14 +1,7 @@
 module Commontator
   module ThreadsHelper
     def commontable_name(thread)
-      config = thread.config
-      config.commontable_name.blank? ? \
-      thread.commontable.class.name : \
-      config.commontable_name
-    end
-    
-    def commontable_id(thread)
-      thread.commontable.send(thread.config.commontable_id_method)
+      thread.config.commontable_name_proc.call(thread.commontable)
     end
   end
 end

data/app/helpers/commontator/threads_helper.rb~

@@ -0,0 +1,11 @@
+module Commontator
+  module ThreadsHelper
+    def commontable_name(thread)
+      thread.config.commontable_name_proc.call(thread.commontable)
+    end
+    
+    def commontable_id(thread)
+      thread.commontable.send(thread.config.commontable_id_method)
+    end
+  end
+end

data/app/mailers/commontator/subscriptions_mailer.rb

@@ -23,10 +23,9 @@ module Commontator
       @config = @thread.config
       
       @creator_name = commontator_name(@creator)
-      @comment_timestamp = @comment.timestamp
+      @comment_created_timestamp = @comment.created_timestamp
       
       @commontable_name = commontable_name(@thread)
-      @commontable_id = commontable_id(@thread).to_s
       
       @commontable_url = ApplicationController.commontable_url
       
@@ -37,9 +36,8 @@ module Commontator
       params[:commontable] = @commontable
       params[:config] = @config
       params[:creator_name] = @creator_name
-      params[:comment_timestamp] = @comment_timestamp
+      params[:comment_created_timestamp] = @comment_created_timestamp
       params[:commontable_name] = @commontable_name
-      params[:commontable_id] = @commontable_id
       params[:commontable_url] = @commontable_url
       
       @bcc = recipients.collect{|s| commontator_email(s)}

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

@@ -0,0 +1,50 @@
+module Commontator
+  class SubscriptionsMailer < ActionMailer::Base
+    include SharedHelper
+    include ThreadsHelper
+  
+    def comment_created(comment, recipients)
+      setup_variables(comment, recipients)
+
+      mail :to => 'Undisclosed Recipients',
+           :bcc => @bcc,
+           :from => @from,
+           :subject => @subject
+    end
+
+    protected
+
+    def setup_variables(comment, recipients)
+      @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
+      params[:creator] = @creator
+      params[:commontable] = @commontable
+      params[:config] = @config
+      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
+      
+      @bcc = recipients.collect{|s| commontator_email(s)}
+      @from = @config.subscription_email_from_proc.call(params)
+      @subject = @config.subscription_email_subject_proc.call(params)
+    end
+  end
+end

data/app/models/commontator/comment.rb

@@ -28,7 +28,7 @@ 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
 
@@ -54,12 +54,16 @@ module Commontator
       self.save
     end
 
-    def timestamp
+    def created_timestamp
       config = thread.config
       "#{config.comment_create_verb_past.capitalize} on " + \
-        created_at.strftime(config.timestamp_format) + \
-        (is_modified? ? " | Last #{config.comment_edit_verb_past} on " + \
-          updated_at.strftime(config.timestamp_format) : '')
+        created_at.strftime(config.timestamp_format)
+    end
+
+    def updated_timestamp
+      config = thread.config
+      is_modified? ? ("Last #{config.comment_edit_verb_past} on " + \
+        updated_at.strftime(config.timestamp_format)) : ''
     end
 
     ##################
@@ -67,28 +71,28 @@ module Commontator
     ##################
 
     def can_be_read_by?(user)
-      (thread.can_be_read_by?(user) && \
-        (!is_deleted? || thread.config.deleted_comments_are_visible)) ||\
-        thread.can_be_edited_by?(user)
+      ((!is_deleted? || thread.config.deleted_comments_are_visible) &&\
+        thread.can_be_read_by?(user)) ||\
+      thread.can_be_edited_by?(user)
     end
 
     def can_be_created_by?(user)
-      !thread.is_closed? && thread.can_be_read_by?(user) && user == creator
+      !thread.is_closed? && user == creator && thread.can_be_read_by?(user)
     end
 
     def can_be_edited_by?(user)
-      !thread.is_closed? && !is_deleted? &&\
-        ((user == creator && thread.config.can_edit_own_comments && thread.can_be_read_by?(user)) ||\
-        (thread.can_be_edited_by?(user) && thread.config.admin_can_edit_comments)) &&\
-        (thread.comments.last == self || thread.config.can_edit_old_comments)
+      (!thread.is_closed? && !is_deleted? &&\
+        (thread.comments.last == self || 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? &&\
-        ((user == creator && thread.config.can_delete_own_comments && \
-        thread.can_be_read_by?(user) && (!is_deleted? || editor == user)) &&\
-        (thread.comments.last == self || thread.config.can_delete_old_comments))) ||\
-        thread.can_be_edited_by?(user)
+      (!thread.is_closed? && (!is_deleted? || editor == user) &&\
+        (thread.comments.last == self || 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)
     end
 
     def can_be_voted_on?
@@ -96,7 +100,7 @@ module Commontator
     end
 
     def can_be_voted_on_by?(user)
-      can_be_voted_on? && thread.can_be_read_by?(user) && user != creator
+      can_be_voted_on? && user && user.is_commontator && user != creator && thread.can_be_read_by?(user)
     end
   end
 end