commontator 5.1.0 → 6.0.0.pre.1

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

@@ -1,28 +1,29 @@
-<% # Clients of this partial must supply the following variables:
-   # thread
-   # user
-   # per_page
+<%#
+  Views that use this partial must supply the following variables:
+  thread
+  user
+  per_page
+%>
 
-   hidden_class = @new_comment.nil? ? ' commontator_hidden' : '' %>
-
-<div id="thread_<%= thread.id %>_reply" class="thread_reply">
+<div id="commontator-thread-<%= thread.id %>-reply" class="reply">
   <% if thread.is_closed? %>
     <p><%= t 'commontator.thread.status.cannot_post' %></p>
   <% elsif !user %>
     <p><%= t 'commontator.require_login' %>.</p>
   <% else %>
-    <div id="thread_<%= thread.id %>_new_comment_form_div" class="thread_new_comment_form<%=
-    hidden_class %>">
-      <% unless @new_comment.nil? %>
-        <%= render partial: 'commontator/comments/form',
-                   locals: { comment: @new_comment,
-                                thread: thread,
-                                per_page: per_page } %>
+    <div id="commontator-thread-<%= thread.id %>-new-comment" class="new-comment<%=
+    @commontator_new_comment.nil? ? ' hidden' : '' %>">
+      <% unless @commontator_new_comment.nil? %>
+        <%=
+          render partial: 'commontator/comments/form', locals: {
+            comment: @commontator_new_comment, thread: thread, per_page: per_page
+          }
+        %>
       <% end %>
     </div>
 
-    <% if @new_comment.nil? %>
-      <div id="thread_<%= thread.id %>_new_comment_link_div" class="thread_new_comment_link">
+    <% if @commontator_new_comment.nil? %>
+      <div id="commontator-thread-<%= thread.id %>-new-comment-link" class="new-comment">
         <%= link_to t('commontator.comment.actions.new'),
             commontator.new_thread_comment_path(thread, per_page: per_page),
             remote: true %>

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

@@ -1,107 +1,107 @@
-<% # Clients of this partial must supply the following variables:
-   # thread
-   # user
-   # page
-   # per_page
-   # Optionally, they can also supply the following variable:
-   show_all ||= false
+<%#
+  Views that use this partial must supply the following variables:
+  thread
+  user
+  page
+  per_page
+  show_all
 %>
 
 <% can_subscribe = thread.can_subscribe?(user)
    can_edit = thread.can_be_edited_by?(user) %>
 
-<span id="thread_<%= thread.id.to_s %>_show_span" class="thread_show commontator_hidden">
+<div id="commontator-thread-<%= thread.id %>-show" class="show hidden">
   <%= link_to t('commontator.thread.actions.show'),
               '#',
-              id: "thread_#{thread.id.to_s}_show_link",
-              class: "thread_show_link" %>
-</span>
-
-<span id="thread_<%= thread.id %>_span" class="thread_span">
-  <span id="thread_<%= thread.id.to_s %>_actions_span" class="thread_actions">
-    <span id="thread_<%= thread.id.to_s %>_hide_span" class="thread_hide commontator_hidden">
-      <%= link_to t('commontator.thread.actions.hide'),
-                  '#',
-                  id: "thread_#{thread.id.to_s}_hide_link",
-                  class: "thread_hide_link" %>
-    </span>
-
-    &nbsp;
-
-    <% if can_subscribe %>
-      <span id="thread_<%= thread.id.to_s %>_subscription_span" class="thread_subscription">
-        <%= render partial: 'commontator/subscriptions/link',
-                   locals: { thread: thread,
-                                user: user } %>
+              id: "commontator-thread-#{thread.id}-show-link" %>
+</div>
+
+<div id="commontator-thread-<%= thread.id %>-content" class="content">
+  <div id="commontator-thread-<%= thread.id %>-header" class="header">
+    <span id="commontator-thread-<%= thread.id %>-actions" class="actions">
+      <span id="commontator-thread-<%= thread.id %>-hide" class="hide hidden">
+        <%= link_to t('commontator.thread.actions.hide'),
+                    '#',
+                    id: "commontator-thread-#{thread.id}-hide-link" %>
       </span>
-    <% end %>
-
-    &nbsp;
 
-    <% if can_edit %>
-      <% filter_string = show_all ? 'filter' : 'show_all'
-         is_closed = thread.is_closed?
-         close_string = is_closed ? 'reopen' : 'close' %>
+      <% if can_subscribe %>
+        <span id="commontator-thread-<%= thread.id %>-subscription" class="subscription">
+          <%= render partial: 'commontator/subscriptions/link',
+                     locals: { thread: thread, user: user } %>
+        </span>
+      <% end %>
 
-      <% if thread.is_filtered? %>
-        <%= link_to t("commontator.thread.actions.#{filter_string}"),
-                    commontator.thread_path(thread, show_all: (show_all ? nil : true)),
-                    id: "thread_#{thread.id.to_s}_#{filter_string}_link",
-                    class: "thread_#{filter_string}_link",
+      <% if can_edit %>
+        <%
+          if show_all
+            filter_class = filter_string = 'filter'
+          else
+            filter_string = 'show_all'
+            filter_class = 'show-all'
+          end
+          is_closed = thread.is_closed?
+          close_string = is_closed ? 'reopen' : 'close'
+        %>
+
+        <% if thread.is_filtered? %>
+          <%= link_to t("commontator.thread.actions.#{filter_string}"),
+                      commontator.thread_url(thread, show_all: (show_all ? nil : true)),
+                      id: "commontator-thread-#{thread.id}-#{filter_class}-link",
+                      class: filter_class,
+                      remote: true %>
+        <% end %>
+
+        <%= link_to t("commontator.thread.actions.#{close_string}"),
+                    commontator.polymorphic_url([close_string, thread]),
+                    data: is_closed ? {} :
+                                      { confirm: t('commontator.thread.actions.confirm_close') },
+                    method: :put,
+                    id: "commontator-thread-#{thread.id}-#{close_string}-link",
+                    class: close_string,
                     remote: true %>
-
-        &nbsp;
       <% end %>
+    </span>
 
-      <%= link_to t("commontator.thread.actions.#{close_string}"),
-                  commontator.polymorphic_path([close_string, thread]),
-                  confirm: (!is_closed ? t('commontator.thread.actions.confirm_close') : nil),
-                  method: :put,
-                  id: "thread_#{thread.id.to_s}_#{close_string}_link",
-                  class: "thread_#{close_string}_link",
-                  remote: true %>
-    <% end %>
-  </span>
-
-  <span id="thread_<%= thread.id.to_s %>_header_span" class="thread_header">
-    <%= t "commontator.thread.status.#{thread.is_closed? ? 'closed' : 'open'}",
-          closer_name: (thread.is_closed? ? Commontator.commontator_name(thread.closer) : '') %>
-  </span>
+    <span id="commontator-thread-<%= thread.id %>-status" class="status">
+      <%= t "commontator.thread.status.#{thread.is_closed? ? 'closed' : 'open'}",
+            closer_name: (thread.is_closed? ? Commontator.commontator_name(thread.closer) : '') %>
+    </span>
+  </div>
 
   <% if thread.config.comment_order == :l %>
     <%= render partial: 'commontator/threads/reply',
                locals: { thread: thread, user: user, per_page: per_page } %>
   <% end %>
 
-  <div id="thread_<%= thread.id.to_s %>_comment_list_div" class="thread_comment_list">
-    <% comments = show_all ? thread.ordered_comments(true) : \
-                             thread.paginated_comments(page, per_page) %>
+  <div id="commontator-thread-<%= thread.id %>-comment-list" class="comment-list">
+    <% comments = thread.paginated_comments(page, per_page, show_all) %>
+
     <%= render partial: 'commontator/comments/list',
-               locals: { comments: comments,
-                            user: user } %>
+               locals: { comments: comments, user: user, per_page: per_page } %>
   </div>
 
-  <% if thread.will_paginate? && !show_all %>
-    <div id="thread_<%= thread.id.to_s %>_pagination_div" class="thread_pagination">
-      <div id="thread_<%= thread.id.to_s %>_page_entries_info_div" class="thread_page_entries_info">
+  <% if thread.will_paginate? %>
+    <div id="commontator-thread-<%= thread.id %>-pagination" class="pagination">
+      <div id="commontator-thread-<%= thread.id %>-page-entries-info" class="page-entries-info">
         <%= page_entries_info comments,
                               params: { controller: 'commontator/threads',
-                                           action: 'show',
-                                           id: thread.id,
-                                           page: page,
-                                           per_page: per_page } %>.
+                                        action: 'show',
+                                        id: thread.id,
+                                        page: page,
+                                        per_page: per_page } %>.
       </div>
 
-      <div id="thread_<%= thread.id.to_s %>_will_paginate_div" class="thread_will_paginate">
+      <div id="commontator-thread-<%= thread.id %>-will-paginate" class="will-paginate">
         <%= will_paginate comments,
                           renderer: Commontator::LinkRenderer,
                           routes_proxy: commontator,
                           remote: true,
                           params: { controller: 'commontator/threads',
-                                       action: 'show',
-                                       id: thread.id,
-                                       page: page,
-                                       per_page: per_page } %>
+                                    action: 'show',
+                                    id: thread.id,
+                                    page: page,
+                                    per_page: per_page } %>
       </div>
     </div>
   <% end %>
@@ -110,9 +110,8 @@
     <%= render partial: 'commontator/threads/reply',
                locals: { thread: thread, user: user, per_page: per_page } %>
   <% end %>
-</span>
+</div>
 
 <script type="text/javascript">
-  <%= render partial: 'commontator/threads/hide_show_links.js',
-             locals: { thread: thread } %>
+  <%= render partial: 'commontator/threads/hide_show_links.js', locals: { thread: thread } %>
 </script>

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

@@ -1,18 +1,14 @@
-<% # Clients of this partial must supply the following variables:
-   # thread
-   # user
-   # page
-   # per_page
-   # Optionally, they can also supply the following variable:
-   show_all ||= false
+<%#
+  Views that use this partial must supply the following variables:
+  thread
+  user
+  page
+  per_page
+  show_all
 %>
 
-$("#thread_<%= thread.id %>_div").html(
-  "<%= escape_javascript(
-    render partial: 'commontator/threads/show',
-           formats: [:html],
-           locals: { thread: thread,
-                        user: user,
-                        page: page,
-                        per_page: per_page,
-                        show_all: show_all }) %>");
+$("#commontator-thread-<%= thread.id %>").html("<%= escape_javascript(
+  render partial: 'commontator/threads/show',
+         formats: [ :html ],
+         locals: { thread: thread, user: user, page: page, per_page: per_page, show_all: show_all }
+) %>");

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

@@ -1,8 +1,11 @@
-<%= render partial: 'show',
-           locals: { thread: @thread,
-                        user: @user,
-                        page: @commontator_page,
-                        per_page: @commontator_per_page,
-                        show_all: @show_all } %>
+<%=
+  render partial: 'show', locals: {
+    thread: @commontator_thread,
+    user: @commontator_user,
+    page: @commontator_page,
+    per_page: @commontator_per_page,
+    show_all: @commontator_show_all
+  }
+%>
 
 <%= javascript_proc %>

data/config/initializers/commontator.rb

@@ -1,30 +1,28 @@
 # Change the settings below to suit your needs
 # All settings are initially set to their default values
-
-# Note: Do not "return" from a Proc, use "next" instead if necessary
 Commontator.configure do |config|
   # Engine Configuration
 
   # current_user_proc
   # Type: Proc
-  # Arguments: the current controller (ActionController::Base)
+  # Arguments: the current controller (ActionController::Base) or view (ActionView::Base)
   # Returns: the current user (acts_as_commontator)
   # The default works for Devise and similar authentication plugins
-  # Default: ->(controller) { controller.current_user }
-  config.current_user_proc = ->(controller) { controller.current_user }
+  # If you define your own custom method, make sure it is accessible to all controllers and views
+  # by adding the method and a call to helper_method to ActionController::Base
+  # Default: ->(context) { context.current_user }
+  config.current_user_proc = ->(context) { context.current_user }
 
   # javascript_proc
   # Type: Proc
   # Arguments: a view (ActionView::Base)
-  # Returns: a String that is appended to Commontator JS views
-  # Can be used, for example, to display/clear Rails error messages
-  # or to reapply JQuery UI styles after Ajax calls
+  # Returns: a String that is appended to all Commontator JS views
+  # Can be used, for example, to reapply JQuery UI styles after Ajax calls
   # Objects visible in view templates can be accessed
   # through the view object (for example, view.flash)
   # However, the view does not include the main application's helpers
-  # Default: ->(view) { '$("#error_explanation").remove();' }
-  config.javascript_proc = ->(view) { '$("#error_explanation").remove();' }
-
+  # Default: ->(view) { '' }
+  config.javascript_proc = ->(view) { '' }
 
 
   # User (acts_as_commontator) Configuration
@@ -50,21 +48,22 @@ Commontator.configure do |config|
   # user_avatar_proc
   # Type: Proc
   # Arguments: a user (acts_as_commontator), a view (ActionView::Base)
-  # Returns: a String containing a HTML <img> tag pointing to the user's avatar image
-  # The commontator_gravatar_image_tag helper takes a user object,
+  # Returns: a String containing an HTML <img> tag pointing to the user's avatar image
+  # The optional commontator_gravatar_image_tag helper takes a user object,
   # a border size and an options hash for Gravatar, and produces a Gravatar image tag
-  # See available options at http://en.gravatar.com/site/implement/images/)
+  # See available options at https://en.gravatar.com/site/implement/images/)
   # Note: Gravatar has several security implications for your users
   #       It makes your users trackable across different sites and
   #       allows de-anonymization attacks against their email addresses
   #       If you absolutely want to keep users' email addresses or identities secret,
   #       do not use Gravatar or similar services
-  # Default: ->(user, view) {
-  #   view.commontator_gravatar_image_tag(user, 1, s: 60, d: 'mm')
-  # }
-  config.user_avatar_proc = ->(user, view) {
-    view.commontator_gravatar_image_tag(user, 1, s: 60, d: 'mm')
-  }
+  #       If you are sure you want to use Gravatar, uncomment the command inside the block.
+  # Default: ->(user, view) do
+  #   # view.commontator_gravatar_image_tag(user, 1, s: 60, d: 'mm')
+  # end
+  config.user_avatar_proc = ->(user, view) do
+    # view.commontator_gravatar_image_tag(user, 1, s: 60, d: 'mm')
+  end
 
   # user_email_proc
   # Type: Proc
@@ -78,6 +77,29 @@ Commontator.configure do |config|
   # Default: ->(user, mailer) { user.try(:email) || '' }
   config.user_email_proc = ->(user, mailer) { user.try(:email) || '' }
 
+  # user_mentions_proc
+  # Type: Proc
+  # Arguments:
+  #   the current user (acts_as_commontator)
+  #   the current thread (Commontator::Thread)
+  #   the search query inputted by user (String)
+  # Returns: an ActiveRecord Relation object
+  # Important notes:
+  #
+  #  - This proc is only used if you enable mentions (see config below)
+  #
+  #  - The proc will be called internally with an empty search string.
+  #    In that case, it MUST return all users that can be mentioned.
+  #
+  #  - With mentions enabled, any registered user in your app is able
+  #    to call this proc with any search query >= 3 characters.
+  #    Make sure to handle SQL escaping properly and that the
+  #    attribute being searched does not contain sensitive information.
+  #
+  # Default: ->(current_user, query) { current_user.class.where('username LIKE ?', "#{query}%") }
+  config.user_mentions_proc = ->(current_user, thread, query) do
+    current_user.class.where('username LIKE ?', "#{query}%")
+  end
 
 
   # Thread/Commontable (acts_as_commontable) Configuration
@@ -144,24 +166,26 @@ Commontator.configure do |config|
   # comment_voting
   # Type: Symbol
   # Whether users can vote on other users' comments
+  # Any option other than :n requires the acts_as_votable gem
   # 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)
+  #   :l  (likes)
+  #   :ld (likes/dislikes)
   # Default: :n
   config.comment_voting = :n
 
   # vote_count_proc
   # Type: Proc
-  # Arguments: a thread (Commontator::Thread), pos (Fixnum), neg (Fixnum)
+  # Arguments: a thread (Commontator::Thread), pos (Integer), neg (Integer)
   # Returns: vote count to be displayed (String)
   # pos is the number of likes, or the rating, or the reputation
   # neg is the number of dislikes, if applicable, or 0 otherwise
-  # Default: ->(thread, pos, neg) { "%+d" % (pos - neg) }
-  config.vote_count_proc = ->(thread, pos, neg) { "%+d" % (pos - neg) }
+  # Default: ->(thread, pos, neg) do
+  #   ((thread.config.comment_voting == :ld ? '%+d' : '%d') % (pos - neg)).sub('+0', '0')
+  # end
+  config.vote_count_proc = ->(thread, pos, neg) do
+    ((thread.config.comment_voting == :ld ? '%+d' : '%d') % (pos - neg)).sub('+0', '0')
+  end
 
   # comment_order
   # Type: Symbol
@@ -192,8 +216,20 @@ Commontator.configure do |config|
   # Default: :l
   config.new_comment_style = :l
 
+  # comment_reply_style
+  # Type: Symbol
+  # How to handle replies to comments
+  # Valid options:
+  #   :n (no replies, though users can still manually add <blockquote>s)
+  #   :q (copies the comment being replied to into a <blockquote>)
+  # Not yet implemented:
+  #   :i (indents each reply under the comment being replied to)
+  # It might be a good idea to add some CSS to hide <blockquote>s when converting from :q to :i
+  # Default: :n
+  config.comment_reply_style = :n
+
   # comments_per_page
-  # Type: Fixnum or nil
+  # Type: Integer or nil
   # Number of comments to display in each page
   # Set to nil to disable pagination
   # Any other value requires the will_paginate gem
@@ -216,12 +252,12 @@ Commontator.configure do |config|
   # Arguments: a thread (Commontator::Thread)
   # Returns: the address emails are sent "from" (String)
   # Important: If using subscriptions, change this to at least match your domain name
-  # Default: ->(thread) {
+  # Default: ->(thread) do
   #   "no-reply@#{Rails.application.class.parent.to_s.downcase}.com"
-  # }
-  config.email_from_proc = ->(thread) {
+  # end
+  config.email_from_proc = ->(thread) do
     "no-reply@#{Rails.application.class.parent.to_s.downcase}.com"
-  }
+  end
 
   # commontable_name_proc
   # Type: Proc
@@ -229,10 +265,12 @@ Commontator.configure do |config|
   # Returns: a name that refers to the commontable object (String)
   # If you have multiple commontable models, you can also pass this
   # configuration value as an argument to acts_as_commontable for each one
-  # Default: ->(thread) {
-  #                   "#{thread.commontable.class.name} ##{thread.commontable.id}" }
-  config.commontable_name_proc = ->(thread) {
-    "#{thread.commontable.class.name} ##{thread.commontable.id}" }
+  # Default: ->(thread) do
+  #   "#{thread.commontable.class.name} ##{thread.commontable.id}"
+  # end
+  config.commontable_name_proc = ->(thread) do
+    "#{thread.commontable.class.name} ##{thread.commontable.id}"
+  end
 
   # comment_url_proc
   # Type: Proc
@@ -241,13 +279,13 @@ Commontator.configure do |config|
   # Returns: a String containing the url of the view that displays the given comment
   # This usually is the commontable's "show" page
   # The main application's routes can be accessed through the app_routes object
-  # Default: ->(comment, app_routes) {
-  #   app_routes.polymorphic_url(comment.thread.commontable, anchor: "comment_#{comment.id}_div")
-  # }
+  # Default: ->(comment, app_routes) do
+  #   app_routes.polymorphic_url(comment.thread.commontable, anchor: "comment-#{comment.id}-div")
+  # end
   # (defaults to the commontable's show url with an anchor pointing to the comment's div)
-  config.comment_url_proc = ->(comment, app_routes) {
-    app_routes.polymorphic_url(comment.thread.commontable, anchor: "comment_#{comment.id}_div")
-  }
+  config.comment_url_proc = ->(comment, app_routes) do
+    app_routes.polymorphic_url(comment.thread.commontable, anchor: "comment-#{comment.id}-div")
+  end
 
   # mentions_enabled
   # Type: Boolean
@@ -257,28 +295,4 @@ Commontator.configure do |config|
   #   true  (mentions enabled)
   # Default: false
   config.mentions_enabled = false
-
-  # user_mentions_proc
-  # Type: Proc
-  # Arguments:
-  #   the current user (acts_as_commontator)
-  #   the current thread (Commontator::Thread)
-  #   the search query inputted by user (String)
-  # Returns: an ActiveRecord Relation object
-  # Important notes:
-  #
-  #  - The proc will be called internally with an empty search string.
-  #    In that case, it MUST return all users that can be mentioned.
-  #
-  #  - With mentions enabled, any registered user in your app is able
-  #    to call this proc with any search query >= 3 characters.
-  #    Make sure to handle SQL escaping properly and that the
-  #    attribute being searched does not contain sensitive information.
-  #
-  # Default: ->(current_user, query) {
-  #   current_user.class.where('username LIKE ?', "#{query}%")
-  # }
-  config.user_mentions_proc = ->(current_user, thread, query) {
-    current_user.class.where('username LIKE ?', "#{query}%")
-  }
 end