commontator 0.4.1 → 0.5.12

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

@@ -1,9 +1,10 @@
-<% # Clients of this partial must supply the following variable:
+<% # Clients of this partial must supply the following variables:
    # thread
+   # user
 %>
 
-<% can_subscribe = thread.can_subscribe?(@commontator) %>
-<% can_edit = thread.can_be_edited_by?(@commontator) %>
+<% can_subscribe = thread.can_subscribe?(user) %>
+<% can_edit = thread.can_be_edited_by?(user) %>
 
 <span id="thread_<%= thread.id.to_s %>_header_span" class="thread_header">
   <%= thread.config.comment_name.capitalize.pluralize %>
@@ -13,7 +14,8 @@
   <% if can_subscribe %>
     <span id="thread_<%= thread.id.to_s %>_subscription_span" class="thread_subscription">
       <%= render :partial => 'commontator/subscriptions/link',
-                 :locals => {:thread => thread} %>
+                 :locals => {:thread => thread,
+                             :user => user} %>
     </span>
   <% end %>
   
@@ -23,9 +25,9 @@
     <% is_closed = thread.is_closed? %>
     <% close_string = is_closed ? "reopen" : "close" %>
     <%= link_to close_string.capitalize,
-                polymorphic_path([close_string, thread]),
+                commontator.polymorphic_path([close_string, thread]),
                 :confirm => (!is_closed ? \
-                              'Are you sure you want to close this thread' : nil),
+                              'Are you sure you want to close this thread?' : nil),
                 :method => :put,
                 :id => "thread_#{thread.id.to_s}_#{close_string}_link",
                 :class => "thread_#{close_string}_link" %>
@@ -34,21 +36,26 @@
 
 <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?(@commontator) %>
+    <% next unless comment.can_be_read_by?(user) %>
     <%= render :partial => 'commontator/comments/show',
-               :locals => {:comment => comment} %>
+               :locals => {:comment => comment,
+                           :user => user} %>
   <% end %>
 </div>
 
-<% unless thread.is_closed? %>
+<br/>
 
-  <br/>
+<% if thread.is_closed? %>
+
+  <p><%= thread.config.comment_name.capitalize.pluralize %> cannot be <%= thread.config.comment_create_verb_past %> at this time.</p>
+
+<% else %>
 
   <div id="thread_<%= thread.id %>_new_comment_div" class="thread_new_comment"></div>
 
   <span id="thread_<%= thread.id %>_new_comment_link_span" class="thread_new_comment_link">
     <%= link_to thread.config.comment_create_verb_present.capitalize + ' ' + thread.config.comment_name,
-        new_thread_comment_path(thread), :remote => true %>
+        commontator.new_thread_comment_path(thread), :remote => true %>
   </span>
   
 <% end %>

data/app/views/commontator/threads/show.js.erb

@@ -1,6 +1,7 @@
 $("#thread_<%= @thread.id %>_div").html(
   "<%= escape_javascript(
     render :partial => 'show',
-           :locals => {:thread => @thread}) %>");
+           :locals => {:thread => @thread,
+                       :user => @user}) %>");
 
 <%= javascript_proc %>

data/config/initializers/commontator.rb

@@ -16,31 +16,31 @@ Commontator.configure do |config|
   config.javascript_proc = lambda { |view| '$("#error_explanation").remove();' }
 
 
-  # Commontator (User model) Configuration
+  # User (acts_as_commontator) Configuration
   
-  # The name used if the commontator's name cannot be retrieved
+  # The name used if the user's name cannot be retrieved
   # Default: 'Anonymous'
-  config.commontator_missing_name = 'Anonymous'
+  config.user_missing_name = 'Anonymous'
 
-  # Whether the commontator's name is clickable in the comment view
+  # Whether the user's name is clickable in the comment view
   # Default: false
-  config.commontator_name_clickable = false
+  config.user_name_clickable = false
 
-  # The method that return the commontator's email address
+  # The method that returns the user's email address
   # Default: 'email'
-  config.commontator_email_method = 'email'
+  config.user_email_method = 'email'
 
-  # The method that return the commontator's name
-  # Default: '' (use missing name)
-  config.commontator_name_method = ''
+  # The method that returns the user's name
+  # Default: '' (use user_missing_name)
+  config.user_name_method = ''
 
-  # Method that returns true if the commontator is an admin for all threads
+  # Method that returns true if the user is an admin for all threads
   # Admins can always delete other users' comments and close threads
   # Default: '' (no admins)
   config.is_admin_method = ''
 
 
-  # Commontable (Commentable model) Configuration
+  # Commontable (acts_as_commontable) Configuration
 
   # What a comment is called in your application
   # Default: 'comment'
@@ -70,11 +70,11 @@ Commontator.configure do |config|
   # Proc that returns the subscription email subject
   # Default:
   # lambda do |params|
-  #   "#{params[:commontator_name]} #{params[:config].comment_create_verb_past} a " + \
+  #   "#{params[:creator_name]} #{params[:config].comment_create_verb_past} a " + \
   #   "#{params[:config].comment_name} on #{params[:commontable_name]} ##{params[:commontable_id]}"
   # end
   config.subscription_email_subject_proc = lambda do |params|
-    "#{params[:commontator_name]} #{params[:config].comment_create_verb_past} a " + \
+    "#{params[:creator_name]} #{params[:config].comment_create_verb_past} a " + \
     "#{params[:config].comment_name} on #{params[:commontable_name]} ##{params[:commontable_id]}"
   end
 

data/db/migrate/0_install_commontator.rb

@@ -2,8 +2,8 @@ class InstallCommontator < ActiveRecord::Migration
   def change
     create_table "commontator_comments" do |t|
       t.text     "body"
-      t.integer  "commontator_id"
-      t.string   "commontator_type"
+      t.integer  "creator_id"
+      t.string   "creator_type"
       t.datetime "deleted_at"
       t.integer  "deleter_id"
       t.string   "deleter_type"
@@ -35,7 +35,7 @@ class InstallCommontator < ActiveRecord::Migration
       t.timestamps
     end
     
-    add_index :commontator_comments, [:commontator_id, :commontator_type, :thread_id], :name => "index_c_c_on_c_id_and_c_type_and_t_id"
+    add_index :commontator_comments, [:creator_id, :creator_type, :thread_id], :name => "index_c_c_on_c_id_and_c_type_and_t_id"
     add_index :commontator_comments, :thread_id
     add_index :commontator_subscriptions, [:subscriber_id, :subscriber_type, :thread_id], :unique => true, :name => "index_c_s_on_s_id_and_s_type_and_t_id"
     add_index :commontator_subscriptions, :thread_id

data/lib/commontator.rb

@@ -9,10 +9,10 @@ module Commontator
 
   # Can be set in initializer or passed as an option to acts_as_commontator
   COMMONTATOR_ATTRIBUTES = [
-    :commontator_missing_name,
-    :commontator_name_clickable,
-    :commontator_email_method,
-    :commontator_name_method,
+    :user_missing_name,
+    :user_name_clickable,
+    :user_email_method,
+    :user_name_method,
     :is_admin_method
   ]
   
@@ -58,7 +58,6 @@ module Commontator
 end
 
 require 'commontator/engine'
-require 'commontator/commontator_config'
-require 'commontator/commontable_config'
 require 'commontator/acts_as_commontator'
 require 'commontator/acts_as_commontable'
+require 'commontator/controller_includes'

data/lib/commontator.rb~

@@ -9,10 +9,10 @@ module Commontator
 
   # Can be set in initializer or passed as an option to acts_as_commontator
   COMMONTATOR_ATTRIBUTES = [
-    :commontator_no_name,
-    :commontator_name_clickable,
-    :commontator_email_method,
-    :commontator_name_method,
+    :user_missing_name,
+    :user_name_clickable,
+    :user_email_method,
+    :user_name_method,
     :is_admin_method
   ]
   
@@ -58,7 +58,6 @@ module Commontator
 end
 
 require 'commontator/engine'
-require 'commontator/commontator_config'
-require 'commontator/commontable_config'
 require 'commontator/acts_as_commontator'
 require 'commontator/acts_as_commontable'
+require 'commontator/shared_methods'

data/lib/commontator/acts_as_commontable.rb

@@ -1,3 +1,5 @@
+require 'commontator/commontable_config'
+
 module Commontator
   module ActsAsCommontable
     def self.included(base)

data/lib/commontator/acts_as_commontator.rb

@@ -1,3 +1,5 @@
+require 'commontator/commontator_config'
+
 module Commontator
   module ActsAsCommontator
     def self.included(base)

data/lib/commontator/controller_includes.rb

@@ -0,0 +1,23 @@
+require 'commontator/shared_helper'
+
+module Commontator
+  module ControllerIncludes
+    def self.included(base)
+      base.helper Commontator::SharedHelper
+    end
+    
+    protected
+    
+    def commontator_thread_show(commontable)
+      user = send Commontator.current_user_method	
+      raise SecurityTransgression unless (user.nil? || user.is_commontator)
+      
+      thread = commontable.thread
+      raise SecurityTransgression unless thread.can_be_read_by?(user)
+      thread.mark_as_read_for(user)
+      @commontator_thread_show = true
+    end
+  end
+end
+
+ActionController::Base.send :include, Commontator::ControllerIncludes

data/lib/commontator/controller_includes.rb~

@@ -0,0 +1,23 @@
+require 'commontator/shared_helper'
+
+module Commontator
+  module ControllerIncludes
+    def self.included(base)
+      base.helper Commontator::SharedHelper
+    end
+    
+    protected
+    
+    def commontator_thread_show(commontable)
+      user = send Commontator.current_user_method	
+      raise SecurityTransgression unless (@user.nil? || @user.is_commontator)
+      
+      thread = commontable.thread
+      raise SecurityTransgression unless thread.can_be_read_by?(user)
+      thread.mark_as_read_for(user)
+      @commontator_thread_show = true
+    end
+  end
+end
+
+ActionController::Base.send :include, Commontator::ControllerIncludes

data/lib/commontator/shared_helper.rb

@@ -0,0 +1,42 @@
+module Commontator
+  module SharedHelper
+    def commontator_thread(commontable)
+      user = send Commontator.current_user_method
+      
+      render(:partial => 'commontator/shared/thread',
+             :locals => {:thread => commontable.thread,
+                         :user => user}).html_safe
+    end
+    
+    def commontator_name(user)
+      return Commontator.user_missing_name if user.nil?
+      config = user.commontator_config
+      config.user_name_method.blank? ? config.user_missing_name : \
+        user.send(config.user_name_method)
+    end
+    
+    def commontator_email(user)
+      return '' if user.nil?
+      config = user.commontator_config
+      config.user_email_method.blank? ? '' : user.send(config.user_email_method)
+    end
+    
+    def commontator_gravatar_url(user, options = {})
+      options[:secure] ||= request.ssl?
+      options[:size] ||= 50
+    
+      hash = Digest::MD5.hexdigest(commontator_email(user))
+      base = options[:secure] ? "s://secure" : "://www"
+      
+      "http#{base}.gravatar.com/avatar/#{hash}?s=#{options[:size]}"
+    end
+  
+    def commontator_gravatar_image(user, options = {})
+      name = commontator_name(user)
+      image_tag(commontator_gravatar_url(user, options), 
+                { :alt => name, 
+                  :title => name,
+                  :border => 1 })
+    end
+  end
+end

data/lib/commontator/shared_helper.rb~

@@ -0,0 +1,42 @@
+module Commontator
+  module SharedHelper
+    def commontator_thread(commontable)
+      user = send Commontator.current_user_method
+      
+      render(:partial => 'commontator/shared/thread',
+             :locals => {:thread => commontable.thread,
+                         :user => user}).html_safe
+    end
+    
+    def commontator_name(user)
+      return Commontator.user_missing_name if user.nil?
+      config = user.commontator_config
+      config.user_name_method.blank? ? config.user_missing_name : \
+        user.send(config.user_name_method)
+    end
+    
+    def commontator_email(user)
+      return '' if user.nil?
+      config = user.commontator_config
+      config.email_method.blank? ? '' : user.send(config.user_email_method)
+    end
+    
+    def commontator_gravatar_url(user, options = {})
+      options[:secure] ||= request.ssl?
+      options[:size] ||= 50
+    
+      hash = Digest::MD5.hexdigest(commontator_email(user))
+      base = options[:secure] ? "s://secure" : "://www"
+      
+      "http#{base}.gravatar.com/avatar/#{hash}?s=#{options[:size]}"
+    end
+  
+    def commontator_gravatar_image(user, options = {})
+      name = commontator_name(user)
+      image_tag(commontator_gravatar_url(user, options), 
+                { :alt => name, 
+                  :title => name,
+                  :border => 1 })
+    end
+  end
+end

data/lib/commontator/shared_methods.rb~

@@ -0,0 +1,24 @@
+require 'commontator/shared_helper'
+
+module Commontator
+  module SharedMethods
+    def self.included(base)
+      base.helper Commontator::SharedHelper
+    end
+    
+    protected
+    
+    def commontator_thread_show(commontable)
+      user = send Commontator.current_user_method	
+      raise SecurityTransgression unless (user.nil? || user.is_commontator)
+      
+      thread = commontable.thread
+      raise SecurityTransgression unless thread.can_be_read_by?(user)
+      thread.mark_as_read_for(user)
+      @commontator_thread_show = true
+    end
+  end
+end
+
+ActionController::Base.send :include, Commontator::SharedMethods
+ActionMailer::Base.send :include, Commontator::SharedMethods

data/lib/commontator/version.rb

@@ -1,3 +1,3 @@
 module Commontator
-  VERSION = "0.4.1"
+  VERSION = "0.5.12"
 end

data/lib/commontator/version.rb~

@@ -1,3 +1,3 @@
 module Commontator
-  VERSION = "0.4.0"
+  VERSION = "0.5.11"
 end

data/test/dummy/config/initializers/commontator.rb

@@ -16,31 +16,31 @@ Commontator.configure do |config|
   config.javascript_proc = lambda { |view| '$("#error_explanation").remove();' }
 
 
-  # Commontator (User model) Configuration
+  # User (acts_as_commontator) Configuration
   
-  # The name used if the commontator's name cannot be retrieved
+  # The name used if the user's name cannot be retrieved
   # Default: 'Anonymous'
-  config.commontator_missing_name = 'Anonymous'
+  config.user_missing_name = 'Anonymous'
 
-  # Whether the commontator's name is clickable in the comment view
+  # Whether the user's name is clickable in the comment view
   # Default: false
-  config.commontator_name_clickable = false
+  config.user_name_clickable = false
 
-  # The method that return the commontator's email address
+  # The method that returns the user's email address
   # Default: 'email'
-  config.commontator_email_method = 'email'
+  config.user_email_method = 'email'
 
-  # The method that return the commontator's name
-  # Default: '' (use missing name)
-  config.commontator_name_method = ''
+  # The method that returns the user's name
+  # Default: '' (use user_missing_name)
+  config.user_name_method = ''
 
-  # Method that returns true if the commontator is an admin for all threads
+  # Method that returns true if the user is an admin for all threads
   # Admins can always delete other users' comments and close threads
   # Default: '' (no admins)
   config.is_admin_method = ''
 
 
-  # Commontable (Commentable model) Configuration
+  # Commontable (acts_as_commontable) Configuration
 
   # What a comment is called in your application
   # Default: 'comment'
@@ -60,7 +60,7 @@ Commontator.configure do |config|
   # as an argument to acts_as_commontable in each one
   # Default: 'commontable'
   config.commontable_name = 'commontable'
-
+  
   # Proc that returns the commontable url that contains the thread
   # (defaults to the commontable show url)
   # Main application's routes can be accessed using main_app object
@@ -70,11 +70,11 @@ Commontator.configure do |config|
   # Proc that returns the subscription email subject
   # Default:
   # lambda do |params|
-  #   "#{params[:commontator_name]} #{params[:config].comment_create_verb_past} a " + \
+  #   "#{params[:creator_name]} #{params[:config].comment_create_verb_past} a " + \
   #   "#{params[:config].comment_name} on #{params[:commontable_name]} ##{params[:commontable_id]}"
   # end
   config.subscription_email_subject_proc = lambda do |params|
-    "#{params[:commontator_name]} #{params[:config].comment_create_verb_past} a " + \
+    "#{params[:creator_name]} #{params[:config].comment_create_verb_past} a " + \
     "#{params[:config].comment_name} on #{params[:commontable_name]} ##{params[:commontable_id]}"
   end