commontator 4.10.5 → 4.11.0

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

@@ -6,5 +6,5 @@
            :locals => { :comment => @comment } %>
 
 <p><%= t 'commontator.email.thread_link_html',
-         :commontable_url => @commontable_url,
+         :comment_url => @comment_url,
          :commontable_name => @commontable_name %></p>

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

@@ -0,0 +1,10 @@
+<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.email.thread_link_html',
+         :comment_url => @commontable_url,
+         :commontable_name => @commontable_name %></p>

data/app/views/commontator/threads/_hide_show.js.erb~

@@ -0,0 +1,21 @@
+$("#").replaceWith(<%= ej(
+  link_to t('commontator.thread.actions.show'),
+          '#',
+          :id => "thread_#{thread.id.to_s}_show_link",
+          :class => "thread_show_link",
+          :remote => true
+) %>);
+
+$().replaceWith(<%= ej(
+  link_to t('commontator.thread.actions.hide'),
+          '#',
+          :id => "thread_#{thread.id.to_s}_hide_link",
+          :class => "thread_hide_link",
+          :remote => true
+) %>);
+
+      <%= link_to t('commontator.thread.actions.hide'),
+                  '',
+                  :id => "thread_#{thread.id.to_s}_hide_link",
+                  :class => "thread_hide_link",
+                  :remote => true %>

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

@@ -0,0 +1,17 @@
+<% # Clients of this partial must supply the following variables:
+   # thread
+%>
+
+$("#thread_<%= thread.id %>_hide_link").click(function() {
+  $("#thread_<%= thread.id %>_span").hide();
+
+  $("#thread_<%= thread.id %>_show_span").fadeIn()[0].scrollIntoView();
+});
+
+$("#thread_<%= thread.id %>_show_link").click(function() {
+  $("#thread_<%= thread.id %>_span").fadeIn()[0].scrollIntoView();
+
+  $("#thread_<%= thread.id %>_show_span").hide();
+});
+
+$("#thread_<%= thread.id %>_hide_span").show();

data/app/views/commontator/threads/_hide_show_links.js.erb~

@@ -0,0 +1,17 @@
+<% # Clients of this partial must supply the following variables:
+   # thread
+%>
+
+$("#thread_<%= thread.id %>_hide_link").click(function() {
+  $("#thread_<%= thread.id %>_span").hide();
+
+  $("#thread_<%= thread.id %>_show_span").fadeIn()[0].scrollIntoView();
+});
+
+$("#thread_<%= thread.id %>_show_link").click(function() {
+  $("#thread_<%= thread.id %>_span").fadeIn()[0].scrollIntoView();
+
+  $("#thread_<%= thread.id %>_span").hide();
+});
+
+$("#thread_<%= thread.id %>_hide_span").show();

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

@@ -10,85 +10,109 @@
 <% can_subscribe = thread.can_subscribe?(user)
    can_edit = thread.can_be_edited_by?(user) %>
 
-<span id="thread_<%= thread.id.to_s %>_actions_span" class="thread_actions">
-  <% 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 } %>
+<span id="thread_<%= thread.id.to_s %>_show_span" class="thread_show commontator_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>
-  <% end %>
-  
-  &nbsp;
-
-  <% if can_edit %>
-    <% filter_string = show_all ? 'filter' : 'show_all'
-       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_path(thread, :show_all => (show_all ? nil : true)),
-                  :id => "thread_#{thread.id.to_s}_#{filter_string}_link",
-                  :class => "thread_#{filter_string}_link",
-                  :remote => true %>
 
-      &nbsp;
+    &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 } %>
+      </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 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",
+                    :remote => true %>
+
+        &nbsp;
+      <% end %>
+
+      <%= 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>
 
-    <%= 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 %>
+  <% if thread.config.comment_order == :l %>
+    <%= render :partial => 'commontator/threads/reply',
+               :locals => { :thread => thread, :user => user, :per_page => per_page } %>
   <% 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>
+  <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) %>
+    <%= render :partial => 'commontator/comments/list',
+               :locals => { :comments => comments,
+                            :user => user } %>
+  </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) %>
-  <%= render :partial => 'commontator/comments/list',
-             :locals => { :comments => comments,
-                          :user => user } %>
-</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">
-      <%= page_entries_info comments,
-                        :params => { :controller => 'commontator/threads',
-                                     :action => 'show',
-                                     :id => thread.id,
-                                     :page => page,
-                                     :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">
+        <%= page_entries_info comments,
+                              :params => { :controller => 'commontator/threads',
+                                           :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">
-      <%= 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 } %>
+      <div id="thread_<%= thread.id.to_s %>_will_paginate_div" class="thread_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 } %>
+      </div>
     </div>
-  </div>
-<% end %>
+  <% end %>
+
+  <% if thread.config.comment_order != :l %>
+    <%= render :partial => 'commontator/threads/reply',
+               :locals => { :thread => thread, :user => user, :per_page => per_page } %>
+  <% end %>
+</span>
 
-<% if thread.config.comment_order != :l %>
-  <%= render :partial => 'commontator/threads/reply',
-             :locals => { :thread => thread, :user => user, :per_page => per_page } %>
-<% end %>
+<script type="text/javascript">
+  <%= render partial: 'commontator/threads/hide_show_links.js',
+             locals: { thread: thread } %>
+</script>

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

@@ -0,0 +1,118 @@
+<% # 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
+%>
+
+<% 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">
+  <%= 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 } %>
+      </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 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",
+                    :remote => true %>
+
+        &nbsp;
+      <% end %>
+
+      <%= 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>
+
+  <% 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) %>
+    <%= render :partial => 'commontator/comments/list',
+               :locals => { :comments => comments,
+                            :user => user } %>
+  </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">
+        <%= page_entries_info comments,
+                              :params => { :controller => 'commontator/threads',
+                                           :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">
+        <%= 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 } %>
+      </div>
+    </div>
+  <% end %>
+
+  <% if thread.config.comment_order != :l %>
+    <%= render :partial => 'commontator/threads/reply',
+               :locals => { :thread => thread, :user => user, :per_page => per_page } %>
+  <% end %>
+</span>
+
+<script type="text/javascript">
+  <%= j(render partial: 'commontator/threads/hide_show_links.js',
+               locals: { thread: thread }) %>
+</script>

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

@@ -0,0 +1,18 @@
+<% # 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
+%>
+
+$("#thread_<%= thread.id %>_div").replaceWith(
+  "<%= 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/config/initializers/commontator.rb

@@ -234,16 +234,47 @@ Commontator.configure do |config|
   config.commontable_name_proc = lambda { |thread|
     "#{thread.commontable.class.name} ##{thread.commontable.id}" }
 
-  # commontable_url_proc
+  # comment_url_proc
   # Type: Proc
-  # Arguments: a thread (Commontator::Thread),
+  # Arguments: a comment (Commontator::Comment),
   #            the app_routes (ActionDispatch::Routing::RoutesProxy)
-  # Returns: a String containing the url of the view that displays the given thread
+  # 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: lambda { |commontable, app_routes|
-  #            app_routes.polymorphic_url(commontable) }
-  # (defaults to the commontable's show url)
-  config.commontable_url_proc = lambda { |thread, app_routes|
-    app_routes.polymorphic_url(thread.commontable) }
+  # Default: lambda { |comment, app_routes|
+  #                   app_routes.polymorphic_url(comment.thread.commontable,
+  #                                              anchor: "comment_#{comment.id}_div") }
+  # (defaults to the commontable's show url with an anchor pointing to the comment's div)
+  config.comment_url_proc = lambda { |comment, app_routes|
+    app_routes.polymorphic_url(comment.thread.commontable, anchor: "comment_#{comment.id}_div") }
+
+  # mentions_enabled
+  # Type: Boolean
+  # Whether users can mention other users to subscribe them to the thread
+  # Valid options:
+  #   false (no mentions)
+  #   true  (mentions enabled)
+  # Default: false
+  config.mentions_enabled = false
+
+  # user_mentions_proc
+  # Type: Proc
+  # Arguments:
+  #   the current user (acts_as_commontator)
+  #   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: lambda { |current_user, query|
+  #                   current_user.class.where('username LIKE ?', "#{query}%") }
+  config.user_mentions_proc = lambda { |current_user, query|
+    current_user.class.where('username LIKE ?', "#{query}%") }
 end