commontator 1.0.6 → 1.1.0

data/app/controllers/commontator/application_controller.rb

@@ -2,6 +2,8 @@ module Commontator
   class ApplicationController < ActionController::Base
     before_filter :get_user
     
+    cattr_accessor :commontable_url
+    
     rescue_from SecurityTransgression, :with => lambda { head(:forbidden) }
     
     protected
@@ -15,10 +17,11 @@ module Commontator
       @thread = params[:thread_id].blank? ? \
         Commontator::Thread.find(params[:id]) : \
         Commontator::Thread.find(params[:thread_id])
+      raise SecurityTransgression if @thread.commontable.nil?
     end
     
-    def get_commontable_url
-      @commontable_url = @thread.config.commontable_url_proc.call(main_app, @thread.commontable)
+    def set_commontable_url
+      self.commontable_url = @thread.config.commontable_url_proc.call(main_app, @thread.commontable)
     end
   end
 end

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

@@ -2,7 +2,7 @@ module Commontator
   class ApplicationController < ActionController::Base
     before_filter :get_user
     
-    class SecurityTransgression < StandardError; end
+    cattr_accessor :commontable_url
     
     rescue_from SecurityTransgression, :with => lambda { head(:forbidden) }
     
@@ -17,10 +17,12 @@ module Commontator
       @thread = params[:thread_id].blank? ? \
         Commontator::Thread.find(params[:id]) : \
         Commontator::Thread.find(params[:thread_id])
+      raise SecurityTransgression if @thread.commontable.nil?
+      set_commontable_url
     end
     
-    def get_commontable_url
-      @commontable_url = @thread.config.commontable_url_proc.call(main_app, @thread.commontable)
+    def set_commontable_url
+      self.commontable_url = @thread.config.commontable_url_proc.call(main_app, @thread.commontable)
     end
   end
 end

data/app/controllers/commontator/comments_controller.rb

@@ -2,7 +2,7 @@ module Commontator
   class CommentsController < ApplicationController
     before_filter :get_thread, :only => [:new, :create]
     before_filter :get_comment_and_thread, :except => [:new, :create]
-    before_filter :get_commontable_url, :only => :create
+    before_filter :set_commontable_url, :only => :create
 
     # GET /1/comments/new
     def new
@@ -29,9 +29,6 @@ module Commontator
       
       respond_to do |format|
         if @comment.save
-          @thread.subscribe(@user) if @thread.config.auto_subscribe_on_comment
-          @thread.add_unread_except_for(@user)
-          SubscriptionsMailer.comment_created_email(@comment, @commontable_url)
           format.html { redirect_to @thread }
           format.js
         else

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

@@ -2,7 +2,7 @@ module Commontator
   class CommentsController < ApplicationController
     before_filter :get_thread, :only => [:new, :create]
     before_filter :get_comment_and_thread, :except => [:new, :create]
-    before_filter :get_commontable_url, :only => :create
+    before_filter :set_commontable_url, :only => :show
 
     # GET /1/comments/new
     def new
@@ -21,6 +21,7 @@ module Commontator
 
     # POST /1/comments
     def create
+      set_commontable_url
       @comment = Comment.new(params[:comment])
       @comment.thread = @thread
       @comment.creator = @user
@@ -29,9 +30,6 @@ module Commontator
       
       respond_to do |format|
         if @comment.save
-          @thread.subscribe(@user) if @thread.config.auto_subscribe_on_comment
-          @thread.add_unread_except_for(@user)
-          SubscriptionsMailer.comment_created_email(@comment, @commontable_url)
           format.html { redirect_to @thread }
           format.js
         else
@@ -60,7 +58,8 @@ module Commontator
           format.html { redirect_to @thread }
           format.js
         else
-          format.html { render action: "edit" }
+          format.html { redirect_to @thread }
+          format.js { render :edit }
         end
       end
     end

data/app/controllers/commontator/subscriptions_controller.rb

@@ -1,7 +1,6 @@
 module Commontator
   class SubscriptionsController < ApplicationController
     before_filter :get_thread
-    before_filter :get_commontable_url
 
     # POST /1/subscribe
     def create

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

@@ -21,7 +21,7 @@ module Commontator
     def destroy
       raise SecurityTransgression unless @thread.can_subscribe?(@user)
 
-      @thread.errors.add(:base, "You are not subscribed to this thread") \
+      @thread.errors.add(:subscription, "You are not subscribed to this thread") \
         unless @thread.unsubscribe(@user)
 
       respond_to do |format|

data/app/controllers/commontator/threads_controller.rb

@@ -1,14 +1,14 @@
 module Commontator
   class ThreadsController < ApplicationController
     before_filter :get_thread
-    before_filter :get_commontable_url, :only => :show
+    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.html { redirect_to commontable_url }
         format.js
       end
     end

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

@@ -1,14 +1,13 @@
 module Commontator
   class ThreadsController < ApplicationController
     before_filter :get_thread
-    before_filter :get_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.html { redirect_to commontable_url }
         format.js
       end
     end
@@ -17,7 +16,7 @@ module Commontator
     def close
       raise SecurityTransgression unless @thread.can_be_edited_by?(@user)
 
-      @thread.errors.add(:base, "This thread has already been closed") \
+      @thread.errors.add(:base, 'This thread has already been closed.') \
         unless @thread.close(@user)
 
       respond_to do |format|
@@ -30,7 +29,7 @@ module Commontator
     def reopen
       raise SecurityTransgression unless @thread.can_be_edited_by?(@user)
 
-      @thread.errors.add(:base, "This thread is not closed") \
+      @thread.errors.add(:base, 'This thread is not closed.') \
         unless @thread.reopen
 
       respond_to do |format|

data/app/mailers/commontator/subscriptions_mailer.rb

@@ -3,27 +3,21 @@ module Commontator
     include SharedHelper
     include ThreadsHelper
   
-    def comment_created_email(comment, commontable_url) 
-      setup_variables(comment, commontable_url)
+    def comment_created(comment, recipients)
+      setup_variables(comment, recipients)
 
-      mail(:bcc => @bcc, :subject => @subject) \
-        unless @bcc.empty?
+      mail :bcc => @bcc,
+           :from => @from,
+           :subject => @subject
     end
 
 protected
 
-    def setup_variables(comment, commontable_url)
-      
+    def setup_variables(comment, recipients)
       @comment = comment
       @thread = @comment.thread
       @creator = @comment.creator
       
-      @bcc = @thread.subscribers.reject{|s| !s.commontator_config.subscription_emails || \
-                                            s == @creator} \
-                                .collect{|s| commontator_email(s)}
-      
-      return if @bcc.empty?
-      
       @commontable = @thread.commontable
       @config = @thread.config
       
@@ -33,7 +27,7 @@ protected
       @commontable_name = commontable_name(@thread)
       @commontable_id = commontable_id(@thread).to_s
       
-      @commontable_url = commontable_url
+      @commontable_url = ApplicationController.commontable_url
       
       params = Hash.new
       params[:comment] = @comment
@@ -47,6 +41,8 @@ protected
       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

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

@@ -3,27 +3,21 @@ module Commontator
     include SharedHelper
     include ThreadsHelper
   
-    def comment_created_email(comment, commontable_url) 
-      setup_variables(comment, commontable_url)
+    def comment_created(comment, recipients)
+      setup_variables(comment, recipients)
 
-      mail(:bcc => @bcc, :subject => @subject) \
-        unless @bcc.empty?
+      mail :bcc => @bcc,
+           :from => @from,
+           :subject => @subject)
     end
 
 protected
 
-    def setup_variables(comment, commontable_url)
-      
+    def setup_variables(comment, recipients)
       @comment = comment
       @thread = @comment.thread
       @creator = @comment.creator
       
-      @bcc = @thread.subscribers.reject{|s| s == @creator || \
-                                            !s.commontator_config.subscription_emails} \
-                                .collect{|s| commontator_email(s)}
-      
-      return if @bcc.empty?
-      
       @commontable = @thread.commontable
       @config = @thread.config
       
@@ -33,7 +27,7 @@ protected
       @commontable_name = commontable_name(@thread)
       @commontable_id = commontable_id(@thread).to_s
       
-      @commontable_url = commontable_url
+      @commontable_url = ApplicationController.commontable_url
       
       params = Hash.new
       params[:comment] = @comment
@@ -47,6 +41,8 @@ protected
       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

data/app/models/commontator/comment_observer.rb

@@ -0,0 +1,12 @@
+module Commontator
+  class CommentObserver < ActiveRecord::Observer
+    def after_create(comment)
+      thread = comment.thread
+      thread.subscribe(comment.creator) if thread.config.auto_subscribe_on_comment
+      thread.add_unread_except_for(comment.creator)
+      recipients = thread.active_subscribers.reject{|s| s == comment.creator}
+      SubscriptionsMailer.comment_created(comment, recipients).deliver \
+        unless recipients.empty?
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Commontator
+  class CommentObserver < ActiveRecord::Observer
+    def after_create(comment)
+      thread = comment.thread
+      thread.subscribe(comment.creator) if thread.config.auto_subscribe_on_comment
+      thread.add_unread_except_for(comment.creator)
+      recipients = thread.active_subscribers.reject{|s| s == comment.creator}
+      pp recipients
+      SubscriptionsMailer.comment_created(comment, recipients).deliver \
+        unless recipients.empty?
+    end
+  end
+end

data/app/models/commontator/thread.rb

@@ -23,6 +23,10 @@ module Commontator
       subscriptions.collect{|s| s.subscriber}
     end
     
+    def active_subscribers
+      subscribers.select{|s| s.commontator_config.subscription_email_enable_proc.call(s)}
+    end
+    
     def subscription_for(subscriber)
       return nil if subscriber.nil?
       Subscription.find_by_thread_id_and_subscriber_id_and_subscriber_type(self.id, subscriber.id, subscriber.class.name)

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

@@ -15,7 +15,7 @@ module Commontator
     end
     
     def ordered_comments
-      (!commontable.blank? && config.comments_can_be_voted_on && config.comments_ordered_by_votes) ? \
+      (!commontable.blank? && config.can_vote_on_comments && config.comments_ordered_by_votes) ? \
         comments.order("cached_votes_down - cached_votes_up") : comments
     end
     
@@ -23,6 +23,10 @@ module Commontator
       subscriptions.collect{|s| s.subscriber}
     end
     
+    def active_subscribers
+      subscribers.select{|s| s.commontator_config.subscription_emails}
+    end
+    
     def subscription_for(subscriber)
       return nil if subscriber.nil?
       Subscription.find_by_thread_id_and_subscriber_id_and_subscriber_type(self.id, subscriber.id, subscriber.class.name)

data/config/initializers/commontator.rb

@@ -8,14 +8,12 @@ Commontator.configure do |config|
   # Default: 'current_user'
   config.current_user_method = 'current_user'
 
-  # Proc that is called after any javascript runs (e.g. to clear flash)
-  # It is passed the 'self' object from the view template, so you should be able to
+  # 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)
   # 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| '$("#attention").html("' + \
-                                    escape_javascript(render(:partial => 'shared/attention')) + \
-                                    '");' }
+  # Default: lambda { |view| '$("#error_explanation").hide();' }
+  config.javascript_proc = lambda { |view| '$("#error_explanation").hide();' }
 
 
   # User (acts_as_commontator) Configuration
@@ -28,11 +26,6 @@ Commontator.configure do |config|
   # If enabled, the link will point to the comment creator's show page
   # Default: false
   config.user_name_clickable = false
-  
-  # Whether automated emails are sent to the user whenever
-  # a comment is posted on a thread they subscribe to
-  # Default: true
-  config.subscription_emails = true
 
   # The method that returns the user's email address
   # Default: 'email'
@@ -47,6 +40,11 @@ Commontator.configure do |config|
   # Note: user can be nil
   # Default: lambda { |user| false } (no admins)
   config.user_admin_proc = lambda { |user| false }
+  
+  # Proc called with user as argument that returns true
+  # if the user should receive subscription emails
+  # Default: lambda { |user| true } (always receive subscription emails)
+  config.subscription_email_enable_proc = lambda { |user| true }
 
 
   # Commontable (acts_as_commontable) Configuration
@@ -146,8 +144,13 @@ Commontator.configure do |config|
   # Main application's routes can be accessed using main_app object
   # Default: lambda { |main_app, commontable| main_app.polymorphic_url(commontable) }
   config.commontable_url_proc = lambda { |main_app, commontable| main_app.polymorphic_url(commontable) }
+  
+  # Proc that returns the subscription email 'from' address
+  # Default:
+  # lambda { |params| 'no-reply@example.com' }
+  config.subscription_email_from_proc = lambda { |params| 'no-reply@example.com' }
 
-  # Proc that returns the subscription email subject string
+  # Proc that returns the subscription email 'subject' string
   # Default:
   # lambda do |params|
   #   "#{params[:creator_name]} #{params[:config].comment_create_verb_past} a " + \

data/config/initializers/commontator.rb~

@@ -8,14 +8,12 @@ Commontator.configure do |config|
   # Default: 'current_user'
   config.current_user_method = 'current_user'
 
-  # Proc that is called after any javascript runs (e.g. to clear flash)
-  # It is passed the 'self' object from the view template, so you should be able to
+  # 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)
   # 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| '$("#attention").html("' + \
-                                    escape_javascript(render(:partial => 'shared/attention')) + \
-                                    '");' }
+  config.javascript_proc = lambda { |view| '$("#error_explanation").hide();' }
 
 
   # User (acts_as_commontator) Configuration
@@ -24,15 +22,10 @@ Commontator.configure do |config|
   # Default: 'Anonymous'
   config.user_missing_name = 'Anonymous'
 
-  # Whether the user's name is clickable in the comment view
+  # Whether the comment creator's name is clickable in the comment view
   # If enabled, the link will point to the comment creator's show page
   # Default: false
   config.user_name_clickable = false
-  
-  # Whether automated emails are sent to the user whenever
-  # a comment is posted on a thread they subscribe to
-  # Default: true
-  config.subscription_emails = true
 
   # The method that returns the user's email address
   # Default: 'email'
@@ -47,6 +40,11 @@ Commontator.configure do |config|
   # Note: user can be nil
   # Default: lambda { |user| false } (no admins)
   config.user_admin_proc = lambda { |user| false }
+  
+  # Proc called with user as argument that returns true
+  # if the user should receive subscription emails
+  # Default: lambda { |user| true } (always receive subscription emails)
+  config.subscription_email_enable_proc = lambda { |user| true }
 
 
   # Commontable (acts_as_commontable) Configuration
@@ -146,8 +144,13 @@ Commontator.configure do |config|
   # Main application's routes can be accessed using main_app object
   # Default: lambda { |main_app, commontable| main_app.polymorphic_url(commontable) }
   config.commontable_url_proc = lambda { |main_app, commontable| main_app.polymorphic_url(commontable) }
+  
+  # Proc that returns the subscription email 'from' address
+  # Default:
+  # lambda { |params| 'no-reply@example.com' }
+  config.subscription_email_from_proc = lambda { |params| 'no-reply@example.com' }
 
-  # Proc that returns the subscription email subject string
+  # Proc that returns the subscription email 'subject' string
   # Default:
   # lambda do |params|
   #   "#{params[:creator_name]} #{params[:config].comment_create_verb_past} a " + \