commontator 4.3.0 → 4.4.1

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

@@ -4,5 +4,5 @@
 
 <%= simple_format comment.is_deleted? ? \
       t('commontator.comment.status.deleted_by',
-        :deleter_name => commontator_name(comment.editor)) : \
+        :deleter_name => comment.editor.commontator_name) : \
       comment.body %>

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

@@ -2,15 +2,16 @@
    # comment
    # user
 %>
-  
+
+<% creator = comment.creator
+   name = creator.commontator_name
+   link = creator.commontator_link(main_app)
+   avatar = creator.commontator_avatar(self) %>
+
 <div id="comment_<%= comment.id.to_s %>_div" class="comment">
   <div id="comment_<%= comment.id.to_s %>_top_div" class="comment_div">
     <span id="comment_<%= comment.id.to_s %>_commontator_span" class="comment_commontator">
-      <% if user && user.commontator_config.user_name_clickable %>
-        <%= link_to commontator_name(comment.creator), main_app.polymorphic_path(comment.creator) %>
-      <% else %>
-        <%= commontator_name comment.creator %>
-      <% end %>
+      <%= link.blank? ? name : link_to(name, link) %>
     </span>
     <span id="comment_<%= comment.id.to_s %>_actions_span" class="comment_actions">
       <%= render :partial => 'commontator/comments/actions',
@@ -20,7 +21,7 @@
   </div>
   <div id="comment_<%= comment.id.to_s %>_middle_div" class="comment_div">
     <span id="comment_<%= comment.id.to_s %>_avatar_span" class="comment_avatar">
-      <%= commontator_avatar comment.creator %>
+      <%= avatar %>
     </span>
     <span id="comment_<%= comment.id.to_s %>_votes_span" class="comment_votes">
       <%= render :partial => 'commontator/comments/votes',
@@ -34,12 +35,12 @@
   </div>
   <div id="comment_<%= comment.id.to_s %>_bottom_div" class="comment_div">
     <span id="comment_<%= comment.id.to_s %>_created_timestamp_span" class="comment_timestamp">
-      <%= created_timestamp comment %>
+      <%= comment.created_timestamp %>
     </span>
     <br/>
     <span id="comment_<%= comment.id.to_s %>_updated_timestamp_span" class="comment_timestamp">
     <% if comment.is_modified? %>
-      <%= updated_timestamp comment %>
+      <%= comment.updated_timestamp %>
     <% end %>
     </span>
   </div>

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

@@ -6,8 +6,12 @@
 <% if comment.can_be_voted_on? %>
   <% can_vote = comment.can_be_voted_on_by?(user) %>
   <% vote = comment.get_vote_by(user) %>
+  <% comment_voting = comment.thread.config.comment_voting.to_sym %>
 
-  <span id="comment_<%= comment.id %>_upvote_span" class="comment_upvote">
+  <% if comment_voting == :ld || comment_voting == :l %>
+  <% vtype = (comment_voting == :ld) ? 'upvote' : 'like' %>
+  <span id="comment_<%= comment.id %>_<%= vtype %>_span"
+        class="comment_<%= vtype %>">
     <% if can_vote && (vote.blank? || !vote.vote_flag) %>
       <%= form_tag commontator.upvote_comment_path(comment),
             :method => :put,
@@ -28,15 +32,15 @@
       <%= image_tag "commontator/upvote_hover.png" %>
     <% end %>
   </span>
+  <% end %>
 
   <span id="comment_<%= comment.id %>_vote_count_span" class="comment_vote_count">
-    <% if comment.thread.config.combine_upvotes_and_downvotes %>
-      <p><%= "%+d" % (comment.upvotes.size - comment.downvotes.size) %></p>
-    <% else %>
-      <p>+<%= comment.upvotes.size %>/-<%= comment.downvotes.size %></p>
-    <% end %>
+    <% config = comment.thread.config %>
+    <%= config.voting_text_proc.call(config.comment_voting,
+          comment.upvotes.size, comment.downvotes.size) %>
   </span>
 
+  <% if comment_voting == :ld %>
   <span id="comment_<%= comment.id %>_downvote_span" class="comment_downvote">
     <% if can_vote && (vote.blank? || vote.vote_flag) %>
       <%= form_tag commontator.downvote_comment_path(comment),
@@ -58,4 +62,5 @@
       <%= image_tag "commontator/downvote_hover.png" %>
     <% end %>
   </span>
+  <% end %>
 <% end %>

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(
-  updated_timestamp(@comment)) %>");
+  @comment.updated_timestamp) %>");
                                                            
 $("#comment_<%= @comment.id.to_s %>_actions_span").html("<%= escape_javascript(
   render :partial => 'actions',

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(
-  updated_timestamp(@comment)) %>");
+  @comment.updated_timestamp) %>");
 
 <%= javascript_proc %>

data/app/views/commontator/subscriptions_mailer/comment_created.html.erb

@@ -1,10 +1,10 @@
-<h4><%= t 'commontator.emails.comment_created.body',
+<h4><%= t 'commontator.email.comment_created.body',
           :creator_name => @creator_name,
           :commontable_name => @commontable_name %></h4>
 
 <%= render :partial => 'commontator/comments/body',
            :locals => { :comment => @comment } %>
 
-<p><%= t 'commontator.emails.thread_link_html',
+<p><%= t 'commontator.email.thread_link_html',
          :commontable_url => @commontable_url,
          :commontable_name => @commontable_name %></p>

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

@@ -7,7 +7,8 @@
 <% can_edit = thread.can_be_edited_by?(user) %>
 
 <span id="thread_<%= thread.id.to_s %>_header_span" class="thread_header">
-  <%= t "commontator.thread.status.#{thread.is_closed? ? 'closed' : 'open'}" %>
+  <%= t "commontator.thread.status.#{thread.is_closed? ? 'closed' : 'open'}",
+        :closer_name => thread.closer.try(:commontator_name) %>
 </span>
 
 <span id="thread_<%= thread.id.to_s %>_actions_span" class="thread_actions">
@@ -41,7 +42,7 @@
 </div>
 
 <% if thread.is_closed? %>
-  <p><%= t 'commontator.thread.status.closed_by' %></p>
+  <p><%= t 'commontator.thread.status.cannot_post' %></p>
 <% elsif !user %>
   <p><%= t 'commontator.require_login' %>.</p>
 <% else %>

data/config/initializers/commontator.rb

@@ -1,5 +1,8 @@
 # Change the settings below to suit your needs
 # All settings are initially set to their default values
+
+# Note: Do not "return" from procs
+#       Use "next" instead
 Commontator.configure do |config|
   # Engine Configuration
 
@@ -8,148 +11,166 @@ Commontator.configure do |config|
   # Default: lambda { |controller| controller.current_user }
   config.current_user_proc = lambda { |controller| controller.current_user }
 
-  # Proc called with the view_context object as argument
+  # Proc called with the current view_context 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();' }
+  config.javascript_proc = lambda { |view_context|
+    '$("#error_explanation").remove();' }
+
 
 
   # User (acts_as_commontator) Configuration
 
   # Proc called with a user as argument
-  # Returns the user's name
-  # Important: change this to return the users' display names
+  # Returns the user's display name
+  # Important: change this to return actual names or usernames
   # Default: lambda { |user| t('commontator.anonymous') } (all users are Anonymous)
   config.user_name_proc = lambda { |user| I18n.t('commontator.anonymous') }
 
-  # 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
-
-  # Proc called with a user as argument
-  # Returns the user's email address
-  # Used in mailers
-  # Default: lambda { |user| user.email }
-  config.user_email_proc = lambda { |user| user.email }
-
-  # Proc called with a user as argument
-  # Returns true iif the user is an admin (a moderator for all threads)
-  # Moderators can delete other users' comments and close threads
-  # Default: lambda { |user| false } (no admins)
-  config.user_admin_proc = lambda { |user| false }
-  
-  # Proc called with a user and the view_context object as arguments
+  # Proc called with a user and the current view_context as arguments
   # Returns an HTML image tag containing the user's avatar image
   # The commontator_gravatar_image_tag helper takes a user object,
   # a border size, and an options hash for gravatar
   # See available options at http://en.gravatar.com/site/implement/images/)
-  # Default: lambda { |user, view_context| view_context.commontator_gravatar_image_tag(user, 1, :s => 60, :d => 'mm') }
-  config.user_avatar_proc = lambda { |user, view_context| view_context.commontator_gravatar_image_tag(user, 1, :s => 60, :d => 'mm') }
-  
-  # Proc called with a user as argument
-  # Returns true iif emails should be sent to this user
-  # Currently, only the subscription email exists
-  # Default: lambda { |user| true } (emails can be sent to all users)
-  config.user_email_enable_proc = lambda { |user| true }
+  # Default: lambda { |user, view_context|
+  #            view_context.commontator_gravatar_image_tag(
+  #              user, 1, :s => 60, :d => 'mm') }
+  config.user_avatar_proc = lambda { |user, view_context|
+                              view_context.commontator_gravatar_image_tag(
+                                user, 1, :s => 60, :d => 'mm') }
+
+  # Proc called with a user and a mailer object as arguments
+  # If the mailer argument is nil, the email is for internal use only and
+  # this method should always return the user's email, no matter what
+  # If the mailer argument is not nil, then an actual email will be sent to the
+  # address returned; you can prevent it from being sent by checking the
+  # arguments and returning a blank string, if appropriate
+  # Default: lambda { |user, mailer| user.email }
+  config.user_email_proc = lambda { |user, mailer| user.email }
+
+  # Proc called with a user and the current view_context as arguments
+  # Returns a link to the user's page
+  # If anything non-blank is returned, the user's name in comments
+  # will become a hyperlink pointing to this
+  # The main application's routes can be accessed through the main_app object
+  # Default: lambda { |user, main_app| '' } (no link)
+  config.user_link_proc = lambda { |user, main_app| '' }
+
 
 
   # Thread/Commontable (acts_as_commontable) Configuration
 
-  # Proc called with a mailer as argument
+  # Proc called with a mailer object as argument
   # Returns the address emails are sent 'from'
   # Important: Change this to at least match your domain name
-  # Default:
-  # lambda { |mailer| 'no-reply@example.com' }
+  # Default: lambda { |mailer| 'no-reply@example.com' }
   config.email_from_proc = lambda { |mailer| 'no-reply@example.com' }
 
-  # Whether moderators can edit other users' comments
-  # Default: false
-  config.moderators_can_edit_comments = false
-
-  # Whether users automatically subscribe to a thread when commenting
-  # Default: false
-  config.auto_subscribe_on_comment = false
-
-  # Whether users can edit their own comments
-  # Default: true
-  config.can_edit_own_comments = true
-
-  # Whether users can edit their own comments
-  # after someone posted a newer comment
-  # Default: false
-  config.can_edit_old_comments = false
-
-  # Whether users can delete their own comments
-  # Default: true
-  config.can_delete_own_comments = true
-
-  # Whether users can delete their own comments
-  # after someone posted a newer comment
-  # Default: false
-  config.can_delete_old_comments = false
+  # Proc called with a thread and a user as arguments
+  # Returns true iif the user should be allowed to read that thread
+  # Note: can be called with a user object that is false or nil if not logged in
+  # Default: lambda { |thread, user| true } (anyone can read any thread)
+  config.thread_read_proc = lambda { |thread, user| true }
 
-  # Whether users can manually subscribe or unsubscribe to threads
-  # Default: true
-  config.can_subscribe_to_thread = true
+  # Proc called with a thread and a user as arguments
+  # Returns true iif the user is a moderator for that thread
+  # Moderators can delete other users' comments and close threads
+  # If you want global moderators, make this proc true for them
+  # Note: moderators must "acts_as_commontator" too (like other users)
+  # Default: lambda { |thread, user| false } (no moderators)
+  config.thread_moderator_proc = lambda { |thread, user| false }
+
+  # Whether users can subscribe to threads to receive activity email notifications
+  # Valid options:
+  #   :n (no subscriptions)
+  #   :a (automatically subscribe when you comment; cannot do it manually)
+  #   :m (manual subscriptions only)
+  #   :b (both automatic, when commenting, and manual)
+  # Default: :m
+  config.thread_subscription = :m
 
   # Whether users can vote on other users' comments
-  # Note: requires acts_as_votable gem installed
-  # and configured for your application
-  # Default: false
-  config.can_vote_on_comments = false
-  
-  # Whether to display upvotes and downvotes separately, as two numbers,
-  # or together, as their difference
-  # Default: false (display as two numbers)
-  config.combine_upvotes_and_downvotes = false
+  # Valid options:
+  #   :n (no voting)
+  #   :l (likes - requires acts_as_votable gem)
+  #   :ld (likes/dislikes - requires acts_as_votable gem)
+  # Not yet implemented:
+  #   :s (star ratings)
+  #   :r (reputation system)
+  # Note: you can format how the votes are displayed by modifying the locale file
+  # Default: :n
+  config.comment_voting = :n
+
+  # This proc is called with the value of config.comment_voting as an argument,
+  # as well as pos and neg
+  # pos is the number of likes or the rating or the reputation
+  # neg is the number of dislikes, if applicable, or 0 otherwise
+  # Returns the text to be displayed in between the voting buttons
+  # Default: lambda { |comment_voting, pos, neg| "%+d" % (pos - neg) }
+  config.voting_text_proc = lambda { |comment_voting, pos, neg|
+                              "%+d" % (pos - neg) }
 
   # What order to use for comments
-  # Valid values:
+  # Valid options:
   #   :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
+  # Default: :e
+  config.comment_order = :e
 
-  # Whether users can read threads closed by moderators
-  # Default: true
-  config.closed_threads_are_readable = true
+  # Whether users can edit their own comments
+  # Valid options:
+  #   :a (always)
+  #   :l (only if it's the latest comment)
+  #   :n (never)
+  # Default: :l
+  config.comment_editing = :l
 
-  # Whether to show that comments deleted by a moderator actually existed
-  # (the content will be hidden either way)
-  # Default: true
-  config.deleted_comments_are_visible = true
+  # Whether users can delete their own comments
+  # Valid options:
+  #   :a (always)
+  #   :l (only if it's the latest comment)
+  #   :n (never)
+  # Note: moderators can always delete any comment
+  # Default: :l
+  config.comment_deletion = :l
 
-  # Proc called with a thread and a user as arguments
-  # Returns true iif the user should be allowed to read that thread
-  # Note: can be called with a user object that is false or nil if not logged in
-  # Default: lambda { |thread, user| true } (anyone can read threads even if not logged in)
-  config.can_read_thread_proc = lambda { |thread, user| true }
+  # Whether moderators can edit other users' comments
+  # Default: false
+  config.moderators_can_edit_comments = false
 
-  # Proc called with a thread and a user as arguments
-  # Returns true iif the user is a moderator for that particular thread
-  # and can delete users' comments in the thread or close it
-  # Default: lambda { |thread, user| false }
-  #            (no thread-specific moderators, but there can still be admins)
-  config.can_edit_thread_proc = lambda { |thread, user| false }
+  # Whether to hide deleted comments completely or show a placeholder message
+  # that indicates when a comment was deleted in a thread
+  # (moderators will always see the placeholder;
+  # the content of the comment will be hidden from all users with either option)
+  # Default: false (show placeholder message)
+  config.hide_deleted_comments = false
+
+  # If set to true, threads closed by moderators will be invisible to normal users
+  # (moderators can still see them)
+  # Default: false (normal users can still read closed threads)
+  config.hide_closed_threads = false
 
   # Proc called with the commontable object as argument
   # Returns the name by which the commontable object will be called in email messages
   # If you have multiple commontable models, you may want to pass this
   # configuration value as an argument to acts_as_commontable in each one
-  # Default: lambda { |commontable| "#{commontable.class.name} ##{commontable.id}" }
-  config.commontable_name_proc = lambda { |commontable| "#{commontable.class.name} ##{commontable.id}" }
+  # Default: lambda { |commontable|
+  #            "#{commontable.class.name} ##{commontable.id}" }
+  config.commontable_name_proc = lambda { |commontable|
+    "#{commontable.class.name} ##{commontable.id}" }
 
   # Proc called with main_app and a commontable object as arguments
   # Return the url that contains the commontable's thread (to be used in the subscription email)
-  # The application's routes can be accessed using the main_app object
-  # Default: lambda { |main_app, commontable| main_app.polymorphic_url(commontable) }
+  # The main application's routes can be accessed through the main_app object
+  # Default: lambda { |commontable, main_app|
+  #            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) }
+  config.commontable_url_proc = lambda { |commontable, main_app|
+    main_app.polymorphic_url(commontable) }
 end

data/config/locales/{en.yml → commontator/en.yml}

@@ -19,29 +19,29 @@
 # To learn more, please read the Rails Internationalization guide
 # available at http://guides.rubyonrails.org/i18n.html.
 
+--- 
 en: 
   activerecord: 
     attributes: 
-      commontator/comment:
+      commontator/comment: 
         body: Comment
         creator: Creator
         editor: Editor
         thread: Discussion
-      commontator/subscription:
+      commontator/subscription: 
         subscriber: Subscriber
         thread: Discussion
-      commontator/thread:
+      commontator/thread: 
         commontable: Commontable
-    models:
+    models: 
       commontator/comment: Comment
       commontator/subscription: Subscription
       commontator/thread: Discussion
-  time:
-    formats:
-      commontator: "%b %d %Y at %I:%M%p %Z"
   commontator: 
+    anonymous: Anonymous
     comment: 
       actions: 
+        cancel: Cancel
         confirm_delete: "Are you sure you want to delete this comment?"
         create: "Post Comment"
         delete: Delete
@@ -49,7 +49,6 @@ en:
         new: "New Comment"
         undelete: Undelete
         update: "Modify Comment"
-        cancel: Cancel
       errors: 
         already_deleted: "This comment has already been deleted."
         create: "This comment could not be posted because:"
@@ -60,12 +59,13 @@ en:
         created_at: "Posted on %{created_at}."
         deleted_by: "Comment deleted by %{deleter_name}."
         updated_at: "Last modified by %{editor_name} on %{updated_at}."
-    emails: 
+    email: 
       comment_created: 
         body: "%{creator_name} commented on %{commontable_name}:"
         subject: "%{creator_name} posted a comment on %{commontable_name}"
-      thread_link_html: "<a href=%{commontable_url}>Click here</a> to view all comments on %{commontable_name}."
+      thread_link_html: "<a href=\"%{commontable_url}\">Click here</a> to view all comments on %{commontable_name}."
       undisclosed_recipients: "Undisclosed Recipients"
+    require_login: "You must login before you can post a comment."
     subscription: 
       actions: 
         confirm_unsubscribe: "Are you sure you want to unsubscribe from this discussion?"
@@ -84,8 +84,9 @@ en:
         already_closed: "This discussion has already been closed."
         not_closed: "This discussion is not closed."
       status: 
-        closed: "Comments (Closed)"
-        closed_by: "This discussion has been closed by a moderator."
+        cannot_post: "New comments cannot be posted at this time."
+        closed: "Comments (Closed by %{closer_name})"
         open: Comments
-    anonymous: Anonymous
-    require_login: "You must login before you can post a comment."
+  time: 
+    formats: 
+      commontator: "%b %d %Y at %I:%M%p %Z"