commontator 1.1.3 → 2.0.0

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

@@ -5,7 +5,7 @@
 
 <% if comment.can_be_voted_on? %>
   <% can_vote = comment.can_be_voted_on_by?(user) %>
-  <% vote = comment.votes.find_by_voter_id_and_voter_type(user.id, user.class.name) %>
+  <% vote = comment.get_vote_by(user) %>
 
   <span id="comment_<%= comment.id %>_upvote_span" class="comment_upvote">
     <% if can_vote && (vote.blank? || !vote.vote_flag) %>

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

@@ -0,0 +1,57 @@
+<% # Clients of this partial must provide the following variable:
+   # comment
+   # user
+%>
+
+<% if comment.can_be_voted_on? %>
+  <% can_vote = comment.can_be_voted_on_by?(user) %>
+  <% vote = comment.get_vote_from(user) %>
+
+  <span id="comment_<%= comment.id %>_upvote_span" class="comment_upvote">
+    <% if can_vote && (vote.blank? || !vote.vote_flag) %>
+      <%= form_tag commontator.upvote_comment_path(comment),
+            :method => :put,
+            :remote => true do %>
+        <%= image_submit_tag "commontator/upvote.png",
+              :onmouseover => "this.src='/assets/commontator/upvote_hover.png'",
+              :onmouseout => "this.src='/assets/commontator/upvote.png'" %>
+      <% end %>
+    <% elsif can_vote %>
+      <%= form_tag commontator.unvote_comment_path(comment),
+            :method => :put,
+            :remote => true do %>
+        <%= image_submit_tag "commontator/upvote_hover.png",
+              :onmouseover => "this.src='/assets/commontator/upvote.png'",
+              :onmouseout => "this.src='/assets/commontator/upvote_hover.png'" %>
+      <% end %>
+    <% else %>
+      <%= image_tag "commontator/upvote_hover.png" %>
+    <% end %>
+  </span>
+
+  <span id="comment_<%= comment.id %>_vote_count_span" class="comment_vote_count">
+    <p>+ <%= comment.upvotes.size %><br><br>- <%= comment.downvotes.size %></p>
+  </span>
+
+  <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),
+            :method => :put,
+            :remote => true do %>
+        <%= image_submit_tag "commontator/downvote.png",
+              :onmouseover => "this.src='/assets/commontator/downvote_hover.png'",
+              :onmouseout => "this.src='/assets/commontator/downvote.png'" %>
+      <% end %>
+    <% elsif can_vote %>
+      <%= form_tag commontator.unvote_comment_path(comment),
+            :method => :put,
+            :remote => true do %>
+        <%= image_submit_tag "commontator/downvote_hover.png",
+              :onmouseover => "this.src='/assets/commontator/downvote.png'",
+              :onmouseout => "this.src='/assets/commontator/downvote_hover.png'" %>
+      <% end %>
+    <% else %>
+      <%= image_tag "commontator/downvote_hover.png" %>
+    <% end %>
+  </span>
+<% 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 %>_timestamp_span").html("<%= escape_javascript(
-                                                           @comment.timestamp) %>");
+  @comment.timestamp + (@comment.is_modified? ? " by #{commontator_name(@comment.editor)}" : '')) %>");
                                                            
 $("#comment_<%= @comment.id.to_s %>_actions_span").html("<%= escape_javascript(
   render :partial => 'actions',

data/app/views/commontator/comments/delete.js.erb~

@@ -0,0 +1,17 @@
+$("#comment_<%= @comment.id.to_s %>_body_div").html("<%= escape_javascript(
+  render :partial => 'body', :locals => {:comment => @comment}) %>");
+
+$("#comment_<%= @comment.id.to_s %>_timestamp_span").html("<%= escape_javascript(
+  @comment.timestamp + (@comment.is_modified? ? " by #{commontator_name(comment.editor)}" : '')) %>");
+                                                           
+$("#comment_<%= @comment.id.to_s %>_actions_span").html("<%= escape_javascript(
+  render :partial => 'actions',
+         :locals => {:comment => @comment,
+                     :user => @user}) %>");
+         
+$("#comment_<%= @comment.id %>_votes_span").html("<%= escape_javascript(
+  render :partial => 'votes',
+         :locals => {:comment => @comment,
+                     :user => @user}) %>");
+
+<%= javascript_proc %>

data/config/initializers/commontator.rb

@@ -1,7 +1,6 @@
 # Change the settings below to suit your needs
 # All settings are initially set to their default values
 Commontator.configure do |config|
-
   # Engine Configuration
 
   # Name of the ApplicationController helper method that returns the current user
@@ -62,9 +61,17 @@ Commontator.configure do |config|
   # Default: 'posted'
   config.comment_create_verb_past = 'posted'
 
+  # Verb used when editing comments (present)
+  # Default: 'modify'
+  config.comment_edit_verb_present = 'modify'
+
+  # Verb used when editing comments (past)
+  # Default: 'modified'
+  config.comment_edit_verb_past = 'modified'
+
   # What a commontable is called in your application
   # If you have multiple commontable models,
-  # you might want to pass this configuration value
+  # you will want to pass this configuration value
   # as an argument to acts_as_commontable in each one
   # Default: 'commontable'
   config.commontable_name = 'commontable'
@@ -114,11 +121,11 @@ Commontator.configure do |config|
   # Default: false
   config.comments_ordered_by_votes = false
 
-  # Whether users can read threads closed by admins
+  # Whether users can read threads closed by moderators
   # Default: true
   config.closed_threads_are_readable = true
 
-  # Whether comments deleted by admins can be seen
+  # Whether comments deleted by moderators can be seen
   # (the content will still be hidden)
   # Default: true
   config.deleted_comments_are_visible = true

data/config/initializers/commontator.rb~

@@ -0,0 +1,171 @@
+# Change the settings below to suit your needs
+# All settings are initially set to their default values
+Commontator.configure do |config|
+  # Engine Configuration
+
+  # Name of the ApplicationController helper method that returns the current user
+  # Default: 'current_user'
+  config.current_user_method = 'current_user'
+
+  # Proc that is called after any javascript runs (e.g. to display/clear flash messages)
+  # It is passed the view_context object (self from the view template), so you should be able to
+  # access anything you normally could in a view template (by using, e.g. view.flash)
+  # However, be aware that it does not have access to the main application's helpers
+  # Should return a string containing JS to be appended to all Commontator JS responses
+  # Default: lambda { |view| '$("#error_explanation").remove();' }
+  config.javascript_proc = lambda { |view| '$("#error_explanation").remove();' }
+
+
+  # User (acts_as_commontator) Configuration
+  
+  # The name used if the user's name cannot be retrieved
+  # Default: 'Anonymous'
+  config.user_missing_name = '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
+
+  # The method that returns the user's email address
+  # Default: 'email'
+  config.user_email_method = 'email'
+
+  # The method that returns the user's name
+  # Default: '' (use user_missing_name)
+  config.user_name_method = ''
+
+  # Proc called with user as argument that returns true if the user is an admin
+  # Admins can always delete other users' comments and close threads
+  # Note: user can be nil
+  # Default: lambda { |user| false } (no admins)
+  config.user_admin_proc = lambda { |user| false }
+  
+  # Proc called with user as argument that returns true
+  # if the user should receive subscription emails
+  # Default: lambda { |user| true } (always receive subscription emails)
+  config.subscription_email_enable_proc = lambda { |user| true }
+
+
+  # Commontable (acts_as_commontable) Configuration
+
+  # What a comment is called in your application
+  # Default: 'comment'
+  config.comment_name = 'comment'
+
+  # Verb used when creating comments (present)
+  # Default: 'post'
+  config.comment_create_verb_present = 'post'
+
+  # Verb used when creating comments (past)
+  # Default: 'posted'
+  config.comment_create_verb_past = 'posted'
+
+  # Verb used when editing comments (present)
+  # Default: 'edit'
+  config.comment_edit_verb_present = 'modify'
+
+  # Verb used when editing comments (past)
+  # Default: 'modified'
+  config.comment_edit_verb_past = 'modified'
+
+  # What a commontable is called in your application
+  # If you have multiple commontable models,
+  # you will want to pass this configuration value
+  # as an argument to acts_as_commontable in each one
+  # Default: 'commontable'
+  config.commontable_name = 'commontable'
+
+  # The format of the timestamps used by Commontator
+  # Default: '%b %d %Y, %I:%M %p'
+  config.timestamp_format = '%b %d %Y, %I:%M %p'
+
+  # Whether admins can edit other users' comments
+  # Default: false
+  config.admin_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
+
+  # Whether users can manually subscribe or unsubscribe to threads
+  # Default: true
+  config.can_subscribe_to_thread = true
+
+  # 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 comments should be ordered by vote score
+  # instead of by order posted
+  # Default: false
+  config.comments_ordered_by_votes = false
+
+  # Whether users can read threads closed by moderators
+  # Default: true
+  config.closed_threads_are_readable = true
+
+  # Whether comments deleted by moderators can be seen
+  # (the content will still be hidden)
+  # Default: true
+  config.deleted_comments_are_visible = true
+
+  # The method which returns the commontable's id, sent to users in email messages
+  # Default: 'id'
+  config.commontable_id_method = 'id'
+
+  # Proc called with thread and user as arguments
+  # If it returns true, that user is a moderator for that particular thread
+  # and is given admin-like capabilities for that thread only
+  # Note: user can be nil
+  # Default: lambda { |thread, user| false } (no thread-specific moderators)
+  config.can_edit_thread_proc = lambda { |thread, user| false }
+
+  # Proc called with thread and user as arguments
+  # If it returns true, that user is allowed to read that thread
+  # Note: user can be nil
+  # Default: lambda { |thread, user| true } (no read restrictions)
+  config.can_read_thread_proc = lambda { |thread, user| true }
+
+  # 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
+  # Default: lambda { |main_app, commontable| main_app.polymorphic_url(commontable) }
+  config.commontable_url_proc = lambda { |main_app, commontable| main_app.polymorphic_url(commontable) }
+  
+  # Proc that returns the subscription email 'from' address
+  # Default:
+  # lambda { |params| 'no-reply@example.com' }
+  config.subscription_email_from_proc = lambda { |params| 'no-reply@example.com' }
+
+  # Proc that returns the subscription email 'subject' string
+  # Default:
+  # lambda do |params|
+  #   "#{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[:creator_name]} #{params[:config].comment_create_verb_past} a " + \
+    "#{params[:config].comment_name} on #{params[:commontable_name]} #{params[:commontable_id]}"
+  end
+end

data/db/migrate/0_install.rb

@@ -1,13 +1,13 @@
 class Install < ActiveRecord::Migration
   def change
     create_table "commontator_comments" do |t|
-      t.text     "body"
-      t.integer  "creator_id"
       t.string   "creator_type"
+      t.integer  "creator_id"
+      t.string   "editor_type"
+      t.integer  "editor_id"
+      t.integer  "thread_id", :null => false
+      t.text     "body", :null => false, :default => ''
       t.datetime "deleted_at"
-      t.integer  "deleter_id"
-      t.string   "deleter_type"
-      t.integer  "thread_id"
       
       t.integer  "cached_votes_total", :default => 0
       t.integer  "cached_votes_up", :default => 0
@@ -15,34 +15,36 @@ class Install < ActiveRecord::Migration
 
       t.timestamps
     end
+
+    add_index :commontator_comments, [:creator_type, :creator_id, :thread_id], :name => "index_c_c_on_c_type_and_c_id_and_t_id"
+    add_index :commontator_comments, :thread_id
+
+    add_index :commontator_comments, :cached_votes_total
+    add_index :commontator_comments, :cached_votes_up
+    add_index :commontator_comments, :cached_votes_down
     
     create_table "commontator_subscriptions" do |t|
-      t.integer  "subscriber_id"
-      t.string   "subscriber_type"
-      t.integer  "thread_id"
-      t.integer  "unread", :default => 0
+      t.string   "subscriber_type", :null => false
+      t.integer  "subscriber_id", :null => false
+      t.integer  "thread_id", :null => false
+      t.integer  "unread", :null => false, :default => 0
 
       t.timestamps
     end
 
+    add_index :commontator_subscriptions, [:subscriber_type, :subscriber_id, :thread_id], :unique => true, :name => "index_c_s_on_s_type_and_s_id_and_t_id"
+    add_index :commontator_subscriptions, :thread_id
+
     create_table "commontator_threads" do |t|
-      t.integer  "commontable_id"
       t.string   "commontable_type"
+      t.integer  "commontable_id"
       t.datetime "closed_at"
-      t.integer  "closer_id"
       t.string   "closer_type"
+      t.integer  "closer_id"
 
       t.timestamps
     end
-    
-    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
-    add_index :commontator_threads, [:commontable_id, :commontable_type]
-    
-    add_index :commontator_comments, :cached_votes_total
-    add_index :commontator_comments, :cached_votes_up
-    add_index :commontator_comments, :cached_votes_down
+
+    add_index :commontator_threads, [:commontable_type, :commontable_id], :unique => true
   end
 end

data/db/migrate/0_install.rb~

@@ -1,13 +1,13 @@
-class InstallCommontator < ActiveRecord::Migration
+class Install < ActiveRecord::Migration
   def change
     create_table "commontator_comments" do |t|
-      t.text     "body"
-      t.integer  "creator_id"
       t.string   "creator_type"
+      t.integer  "creator_id"
+      t.string   "editor_type"
+      t.integer  "editor_id"
+      t.integer  "thread_id", :null => false
+      t.text     "body", :null => false, :default => ''
       t.datetime "deleted_at"
-      t.integer  "deleter_id"
-      t.string   "deleter_type"
-      t.integer  "thread_id"
       
       t.integer  "cached_votes_total", :default => 0
       t.integer  "cached_votes_up", :default => 0
@@ -15,34 +15,36 @@ class InstallCommontator < ActiveRecord::Migration
 
       t.timestamps
     end
+
+    add_index :commontator_comments, [:creator_type, :creator_id, :thread_id], :name => "index_c_c_on_c_type_and_c_id_and_t_id"
+    add_index :commontator_comments, :thread_id
+
+    add_index :commontator_comments, :cached_votes_total
+    add_index :commontator_comments, :cached_votes_up
+    add_index :commontator_comments, :cached_votes_down
     
     create_table "commontator_subscriptions" do |t|
-      t.integer  "subscriber_id"
-      t.string   "subscriber_type"
-      t.integer  "thread_id"
+      t.string   "subscriber_type", :null => false
+      t.integer  "subscriber_id", :null => false
+      t.integer  "thread_id", :null => false
       t.integer  "unread", :default => 0
 
       t.timestamps
     end
 
+    add_index :commontator_subscriptions, [:subscriber_type, :subscriber_id, :thread_id], :unique => true, :name => "index_c_s_on_s_type_and_s_id_and_t_id"
+    add_index :commontator_subscriptions, :thread_id
+
     create_table "commontator_threads" do |t|
-      t.integer  "commontable_id"
       t.string   "commontable_type"
+      t.integer  "commontable_id"
       t.datetime "closed_at"
-      t.integer  "closer_id"
       t.string   "closer_type"
+      t.integer  "closer_id"
 
       t.timestamps
     end
-    
-    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
-    add_index :commontator_threads, [:commontable_id, :commontable_type]
-    
-    add_index :commontator_comments, :cached_votes_total
-    add_index :commontator_comments, :cached_votes_up
-    add_index :commontator_comments, :cached_votes_down
+
+    add_index :commontator_threads, [:commontable_type, :commontable_id], :unique => true
   end
 end