commontator 4.4.1 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 95f7d24f572a92460e3feb574f48e3abfe55cf51
-  data.tar.gz: 80d83a831ca9d26f9aaec72e98611aa10e1c2778
+  metadata.gz: a273f377e74d4449ebd729e1865c6dcbc9e4c0c5
+  data.tar.gz: c8c70279649288314df84db409d04835dee64d42
 SHA512:
-  metadata.gz: c3cef85703c6ea3fe65f317e96404be9f6e55cfcdb7e27d4dec3b3da7aaceafe3bf504ccffe14b959ef5516d09a07669efcb948cd9f18ea9e8d188ec6ad533f3
-  data.tar.gz: 66e364a7b162b8223bea6a9ac97b08beb6977ed902a481ac50d1da490dcc127fc874a58ced12becd58c1a6534ab927d637ea1390ffe4ae78634a6e28a759b0cf
+  metadata.gz: c73e175a971bd4d7618a42681d0559f612668fa8ea1e7e3ec6f84eb786420e990ef8f47b42528dbf0c64e21bff66958829ea68972c2739483d798c3583358eed
+  data.tar.gz: 52ba09e55c25a169190e25d85b60279f26f7febe15fa9253ac06d41e6699a4af9f59e7ea3fef0a2a01509f3bf0c13c332221dbc4df8a26afd1bad57e68ddb246

data/README.md

@@ -14,7 +14,7 @@ There are 4 steps you must follow to install commontator:
   Add this line to your application's Gemfile:
 
   ```ruby
-  gem 'commontator', '~> 4.4.1'
+  gem 'commontator', '~> 4.5.0'
   ```
 
   And then execute:

data/app/assets/stylesheets/commontator/comments.css

@@ -9,14 +9,14 @@
   margin-top: 15px;
   margin-bottom: 15px;
 
-  padding-top: 8px;
-  padding-bottom: 8px;
-  padding-left: 13px;
-  padding-right: 13px;
+  padding-top: 5px;
+  padding-bottom: 5px;
+  padding-left: 10px;
+  padding-right: 10px;
 
   color: #000;
-  border-color: #ddd;
-  background-color: #fff;
+  border-color: #DDD;
+  background-color: #FFF;
   
   clear: both;
 }
@@ -59,7 +59,7 @@
 }
 
 .comment_timestamp {
-  color: #777;
+  color: #666;
 }
 
 .comment_votes {
@@ -82,19 +82,22 @@
   margin: 0px;
 }
 
-.comment_vote_count {
-  margin-top: 7px;
-  margin-bottom: 7px;
-}
-
 .comment_upvote {
   display: block;
-  height: 32px;
+  height: 18px;
+  margin-top: 7px;
+  margin-bottom: 7px;
+  margin-left: 5px;
+  margin-right: 5px;
 }
 
 .comment_downvote {
   display: block;
-  height: 32px;
+  height: 18px;
+  margin-top: 7px;
+  margin-bottom: 7px;
+  margin-left: 5px;
+  margin-right: 5px;
 }
 
 .comment_like {

data/app/assets/stylesheets/commontator/threads.css

@@ -10,8 +10,56 @@
   font-size: 16px;
   font-weight: bold;
   font-style: normal;
+  margin-top: 5px;
+  margin-bottom: 5px;
+  display: block;
 }
 
 .thread_new_comment {
   display: none;
+}
+
+.thread_new_comment_link {
+  display: block;
+}
+
+/* Modified from:
+http://www.strangerstudios.com/sandbox/pagination/diggstyle.php */
+.thread_pagination {
+	padding: 3px;
+	margin: 3px;
+}
+
+.thread_pagination a {
+	padding: 2px 5px 2px 5px;
+	margin: 2px;
+	border: 1px solid #999;
+	
+	text-decoration: none;
+	color: #666;
+}
+
+.thread_pagination a:hover,
+.thread_pagination a:active {
+	border: 1px solid #555;
+
+	color: #000;
+}
+
+.thread_pagination em {
+	padding: 2px 5px 2px 5px;
+	margin: 2px;
+  border: 1px solid #555;
+
+  font-weight: bold;
+  background-color: #555;
+  color: #FFF;
+}
+
+.thread_pagination span {
+  padding: 2px 5px 2px 5px;
+  margin: 2px;
+  border: 1px solid #EEE;
+
+  color: #DDD;
 }

data/app/models/commontator/thread.rb

@@ -15,6 +15,12 @@ module Commontator
       commontable.try(:commontable_config) || Commontator
     end
 
+    def will_paginate?
+      return false if config.comments_per_page.nil? || !comments.respond_to?(:paginate)
+      require 'commontator/remote_link_renderer'
+      true
+    end
+
     def ordered_comments
       case config.comment_order.to_sym
       when :l then comments.order('id DESC')
@@ -24,6 +30,12 @@ module Commontator
       end
     end
 
+    def paginated_comments(page, per_page)
+      oc = ordered_comments
+      return oc unless will_paginate?
+      oc.paginate(:page => page, :per_page => per_page)
+    end
+
     def is_closed?
       !closed_at.blank?
     end

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

@@ -24,12 +24,13 @@
       <%= form_tag commontator.unvote_comment_path(comment),
             :method => :put,
             :remote => true do %>
-        <%= image_submit_tag "commontator/upvote_hover.png",
+        <%= image_submit_tag "commontator/upvote_active.png",
               :onmouseover => "this.src='/assets/commontator/upvote.png'",
-              :onmouseout => "this.src='/assets/commontator/upvote_hover.png'" %>
+              :onmouseout => "this.src='/assets/commontator/upvote_active.png'"
+        %>
       <% end %>
     <% else %>
-      <%= image_tag "commontator/upvote_hover.png" %>
+      <%= image_tag "commontator/upvote_disabled.png" %>
     <% end %>
   </span>
   <% end %>
@@ -54,12 +55,13 @@
       <%= form_tag commontator.unvote_comment_path(comment),
             :method => :put,
             :remote => true do %>
-        <%= image_submit_tag "commontator/downvote_hover.png",
+        <%= image_submit_tag "commontator/downvote_active.png",
               :onmouseover => "this.src='/assets/commontator/downvote.png'",
-              :onmouseout => "this.src='/assets/commontator/downvote_hover.png'" %>
+              :onmouseout => "this.src='/assets/commontator/downvote_active.png'"
+        %>
       <% end %>
     <% else %>
-      <%= image_tag "commontator/downvote_hover.png" %>
+      <%= image_tag "commontator/downvote_disabled.png" %>
     <% end %>
   </span>
   <% end %>

data/app/views/commontator/shared/_thread.html.erb

@@ -10,11 +10,16 @@
 
   <div id="thread_<%= thread.id %>_div" class="thread" style="display: none;">
     <% if @commontator_thread_show %>
-      <%= render :partial => 'commontator/threads/show', :locals => {:thread => thread,
-                                                                     :user => user} %>
+      <%= render :partial => 'commontator/threads/show',
+                 :locals => {:thread => thread,
+                             :user => user,
+                             :page => @commontator_page,
+                             :per_page => @commontator_per_page} %>
     <% else %>
-      <%= link_to "#{t 'commontator.thread.actions.show'} (#{subscription ? (subscription.unread.to_s + '/' + thread.comments.count.to_s) : thread.comments.count.to_s})", \
-                  commontator.thread_path(thread), :remote => true %>
+      <%= link_to "#{t 'commontator.thread.actions.show'} (#{subscription ?
+                  (subscription.unread.to_s + '/' + thread.comments.count.to_s) :
+                  thread.comments.count.to_s})", commontator.thread_path(thread),
+                  :remote => true %>
     <% end %>
   </div>
 <% end %>

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

@@ -0,0 +1,17 @@
+<% # Clients of this partial must supply the following variables:
+   # thread
+   # user
+%>
+
+<% if thread.is_closed? %>
+  <p><%= t 'commontator.thread.status.closed_by' %></p>
+<% elsif !user %>
+  <p><%= t 'commontator.require_login' %>.</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 t('commontator.comment.actions.new'),
+        commontator.new_thread_comment_path(thread), :remote => true %>
+  </span>
+<% end %>

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

@@ -1,16 +1,13 @@
 <% # Clients of this partial must supply the following variables:
    # thread
    # user
+   # page
+   # per_page
 %>
 
 <% 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">
-  <%= 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">
   <% if can_subscribe %>
     <span id="thread_<%= thread.id.to_s %>_subscription_span" class="thread_subscription">
@@ -35,21 +32,29 @@
   <% 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.closer.try(:commontator_name) %>
+</span>
+
+<% if thread.config.comment_order == :l %>
+  <%= render :partial => 'reply', :locals => {:thread => thread, :user => user} %>
+<% end %>
+
 <div id="thread_<%= thread.id.to_s %>_comment_list_div" class="thread_comment_list">
+  <% comments = thread.paginated_comments(page, per_page) %>
   <%= render :partial => 'commontator/comments/list',
-             :locals => {:comments => thread.ordered_comments,
+             :locals => {:comments => comments,
                          :user => user} %>
 </div>
 
-<% 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_div" class="thread_new_comment"></div>
-
-  <span id="thread_<%= thread.id %>_new_comment_link_span" class="thread_new_comment_link">
-    <%= link_to t('commontator.comment.actions.new'),
-        commontator.new_thread_comment_path(thread), :remote => true %>
-  </span>
+<% if thread.will_paginate? %>
+  <div id="thread_<%= thread.id.to_s %>_pagination_div" class="thread_pagination">
+    <%= will_paginate comments,
+                      :renderer => thread.config.wp_link_renderer_proc.call(thread) %>
+  </div>
+<% end %>
+
+<% if thread.config.comment_order != :l %>
+  <%= render :partial => 'reply', :locals => {:thread => thread, :user => user} %>
 <% end %>

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

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

data/config/initializers/commontator.rb

@@ -19,7 +19,7 @@ Commontator.configure do |config|
   # 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();' }
+                                    '$("#error_explanation").remove();' }
 
 
 
@@ -40,8 +40,8 @@ Commontator.configure do |config|
   #            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') }
+                                     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
@@ -65,7 +65,7 @@ Commontator.configure do |config|
   # Thread/Commontable (acts_as_commontable) Configuration
 
   # Proc called with a mailer object as argument
-  # Returns the address emails are sent 'from'
+  # Returns the address emails are sent "from"
   # Important: Change this to at least match your domain name
   # Default: lambda { |mailer| 'no-reply@example.com' }
   config.email_from_proc = lambda { |mailer| 'no-reply@example.com' }
@@ -112,7 +112,7 @@ Commontator.configure do |config|
   # 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) }
+                                     "%+d" % (pos - neg) }
 
   # What order to use for comments
   # Valid options:
@@ -120,9 +120,33 @@ Commontator.configure do |config|
   #   :l (latest comment first)
   #   :ve (highest voted first; earliest first if tied)
   #   :vl (highest voted first; latest first if tied)
+  # Notes:
+  #   :e is usually used in forums (discussions)
+  #   :l is usually used in blogs (opinions)
+  #   :ve and :vl are usually used where it makes sense to rate comments
+  #     based on usefulness (q&a, reviews, guides, etc.)
+  # If :l is selected, the "reply to thread" form will appear before the comments
+  # Otherwise, it will appear after the comments
   # Default: :e
   config.comment_order = :e
 
+  # Number of comments to display in each page
+  # Set to nil to disable pagination
+  # Any other value requires the will_paginate gem
+  # Default: nil (no pagination)
+  config.comments_per_page = nil
+
+  # Proc called with a thread as argument
+  # Returns a LinkRenderer to be used with will_paginate for that thread,
+  # assuming pagination is enabled
+  # Commontator supplies its own RemoteLinkRenderer,
+  # which is exactly like will_paginate's default, except it returns remote links
+  # For more information, see:
+  # https://github.com/mislav/will_paginate/wiki/Link-renderer
+  # Default: lambda { |thread| Commontator::RemoteLinkRenderer }
+  config.wp_link_renderer_proc = lambda { |thread|
+                                          Commontator::RemoteLinkRenderer }
+
   # Whether users can edit their own comments
   # Valid options:
   #   :a (always)
@@ -166,7 +190,8 @@ Commontator.configure do |config|
     "#{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)
+  # Return the url that contains the commontable's thread
+  # This usually is the commontable's "show" page
   # The main application's routes can be accessed through the main_app object
   # Default: lambda { |commontable, main_app|
   #            main_app.polymorphic_url(commontable) }

data/lib/commontator.rb

@@ -27,6 +27,8 @@ module Commontator
     :comment_voting,
     :voting_text_proc,
     :comment_order,
+    :comments_per_page,
+    :wp_link_renderer_proc,
     :comment_editing,
     :comment_deletion,
     :moderators_can_edit_comments,
@@ -96,4 +98,4 @@ module Commontator
 end
 
 require 'commontator/acts_as_commontator'
-require 'commontator/acts_as_commontable'
+require 'commontator/acts_as_commontable'

data/lib/commontator/controller_includes.rb

@@ -14,6 +14,9 @@ module Commontator
       thread = commontable.thread
       raise SecurityTransgression unless thread.can_be_read_by?(user)
       thread.mark_as_read_for(user)
+      @commontator_page = params[:page] || 1
+      @commontator_per_page = params[:per_page] ||\
+                              thread.config.comments_per_page
       @commontator_thread_show = true
     end
   end

data/lib/commontator/remote_link_renderer.rb

@@ -0,0 +1,10 @@
+require 'will_paginate/view_helpers/action_view'
+
+module Commontator
+  class RemoteLinkRenderer < WillPaginate::ActionView::LinkRenderer
+    def link(text, target, attributes = {})
+      attributes = attributes.merge('data-remote' => true)
+      super(text, target, attributes)
+    end
+  end
+end

data/lib/commontator/shared_helper.rb

@@ -5,7 +5,7 @@ module Commontator
       
       render(:partial => 'commontator/shared/thread',
              :locals => {:thread => commontable.thread,
-             :user => user}).html_safe
+                         :user => user}).html_safe
     end
 
     def commontator_gravatar_image_tag(user, border = 1, options = {})