commontator 4.5.4 → 4.6.0

data/config/initializers/commontator.rb~

@@ -0,0 +1,238 @@
+# 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
+#       "return" in a lambda is OK
+Commontator.configure do |config|
+  # Engine Configuration
+
+  # current_user_proc
+  # Type: Proc
+  # Arguments: the current controller (ActionController::Base)
+  # Returns: the current user (acts_as_commontator)
+  # The default works for Devise and similar authentication plugins
+  # Default: lambda { |controller| controller.current_user }
+  config.current_user_proc = lambda { |controller| controller.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
+  # 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: lambda { |view| '$("#error_explanation").remove();' }
+  config.javascript_proc = lambda { |view|
+                                    '$("#error_explanation").remove();' }
+
+
+
+  # User (acts_as_commontator) Configuration
+
+  # user_name_proc
+  # Type: Proc
+  # Arguments: a user (acts_as_commontator)
+  # Returns: the user's name (String)
+  # Default: lambda { |user| I18n.t('commontator.anonymous') } (all users are anonymous)
+  config.user_name_proc = lambda { |user| I18n.t('commontator.anonymous') }
+
+  # user_link_proc
+  # Type: Proc
+  # Arguments: a user (acts_as_commontator),
+  #            the app_routes (ActionDispatch::Routing::RoutesProxy)
+  # Returns: a path to the user's `show` page (String)
+  # If anything non-blank is returned, the user's name in comments
+  # comments will become a hyperlink pointing to this path
+  # The main application's routes can be accessed through the app_routes object
+  # Default: lambda { |user, app_routes| '' } (no link)
+  config.user_link_proc = lambda { |user, app_routes| '' }
+
+  # 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,
+  # 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/)
+  # 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: lambda { |user, view|
+  #            view.commontator_gravatar_image_tag(
+  #              user, 1, :s => 60, :d => 'mm') }
+  config.user_avatar_proc = lambda { |user, view|
+                                     view.commontator_gravatar_image_tag(
+                                       user, 1, :s => 60, :d => 'mm') }
+
+  # user_email_proc
+  # Type: Proc
+  # Arguments: a user (acts_as_commontator), a mailer (ActionMailer::Base)
+  # Returns: the user's email address (String)
+  # The default works for Devise's defaults
+  # If the mailer argument is nil, Commontator intends to hash the email and send the hash
+  # to Gravatar, so you should always return the user's email address (if using Gravatar)
+  # If the mailer argument is not nil, then Commontator intends to send an email to
+  # the address returned; you can prevent it from being sent by returning a blank String
+  # Default: lambda { |user, mailer| user.email }
+  config.user_email_proc = lambda { |user, mailer| user.try(:email) || '' }
+
+
+
+  # Thread/Commontable (acts_as_commontable) Configuration
+
+  # comment_filter
+  # Type: Arel node (Arel::Nodes::Node) or nil
+  # Arel that filters visible comments
+  # If specified, visible comments will be filtered according to this Arel node
+  # A value of nil will cause no filtering to be done
+  # Moderators can manually override this filter for themselves
+  # Example: Commontator::Comment.arel_table[:deleted_at].eq(nil) (hides deleted comments)
+  #          This is not recommended, as it can cause confusion over deleted comments
+  #          If using pagination, it can also cause comments to change pages
+  # Default: nil (no filtering - all comments are visible)
+  config.comment_filter = nil
+
+  # thread_read_proc
+  # Type: Proc
+  # Arguments: a thread (Commontator::Thread), a user (acts_as_commontator)
+  # Returns: a Boolean, true iif the user should be allowed to read that thread
+  # Note: can be called with a user object that is nil (if they are not logged in)
+  # Default: lambda { |thread, user| true } (anyone can read any thread)
+  config.thread_read_proc = lambda { |thread, user| true }
+
+  # thread_moderator_proc
+  # Type: Proc
+  # Arguments: a thread (Commontator::Thread), a user (acts_as_commontator)
+  # Returns: a Boolean, true iif the user is a moderator for that thread
+  # If you want global moderators, make this proc true for them regardless of thread
+  # Default: lambda { |thread, user| false } (no moderators)
+  config.thread_moderator_proc = lambda { |thread, user| false }
+
+  # comment_editing
+  # Type: Symbol
+  # 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
+
+  # comment_deletion
+  # Type: Symbol
+  # Whether users can delete their own comments
+  # Valid options:
+  #   :a (always)
+  #   :l (only if it's the latest comment)
+  #   :n (never)
+  # Note: For moderators, see the next option
+  # Default: :l
+  config.comment_deletion = :l
+
+  # moderator_permissions
+  # Type: Symbol
+  # What permissions moderators have
+  # Valid options:
+  #   :e (delete and edit comments and close threads)
+  #   :d (delete comments and close threads)
+  #   :c (close threads only)
+  # Default: :d
+  config.moderator_permissions = :d
+
+  # comment_voting
+  # Type: Symbol
+  # Whether users can vote on other users' comments
+  # 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)
+  # Default: :n
+  config.comment_voting = :n
+
+  # vote_count_proc
+  # Type: Proc
+  # Arguments: a thread (Commontator::Thread), pos (Fixnum), neg (Fixnum)
+  # 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: lambda { |thread, pos, neg| "%+d" % (pos - neg) }
+  config.vote_count_proc = lambda { |thread, pos, neg| "%+d" % (pos - neg) }
+
+  # comment_order
+  # Type: Symbol
+  # What order to use for comments
+  # 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)
+  # 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
+
+  # comments_per_page
+  # Type: Fixnum or nil
+  # 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
+
+  # thread_subscription
+  # Type: Symbol
+  # 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: :n
+  config.thread_subscription = :n
+
+  # email_from_proc
+  # Type: Proc
+  # 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: lambda { |thread|
+  #                   "no-reply@#{Rails.application.class.parent.to_s.downcase}.com" }
+  config.email_from_proc = lambda { |thread|
+    "no-reply@#{Rails.application.class.parent.to_s.downcase}.com" }
+
+  # commontable_name_proc
+  # Type: Proc
+  # Arguments: a thread (Commontator::Thread)
+  # 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: lambda { |thread|
+  #                   "#{thread.commontable.class.name} ##{thread.commontable.id}" }
+  config.commontable_name_proc = lambda { |thread|
+    "#{thread.commontable.class.name} ##{thread.commontable.id}" }
+
+  # commontable_url_proc
+  # Type: Proc
+  # Arguments: a thread (Commontator::Thread),
+  #            the app_routes (ActionDispatch::Routing::RoutesProxy)
+  # Returns: a String containing the url of the view that displays the given thread
+  # 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) }
+end
+

data/config/locales/commontator/en.yml

@@ -34,9 +34,15 @@ en:
       commontator/thread: 
         commontable: Commontable
     models: 
-      commontator/comment: Comment
-      commontator/subscription: Subscription
-      commontator/thread: Discussion
+      commontator/comment: 
+        one: comment
+        other: comments
+      commontator/subscription: 
+        one: subscription
+        other: subscriptions
+      commontator/thread: 
+        one: thread
+        other: threads
   commontator: 
     anonymous: Anonymous
     comment: 
@@ -76,6 +82,8 @@ en:
         not_subscribed: "You are not subscribed to this discussion."
     thread: 
       actions: 
+        show_all: "Show All Comments"
+        filter: "Filter Comments"
         close: "Close Discussion"
         confirm_close: "Are you sure you want to close this discussion?"
         reopen: "Reopen Discussion"
@@ -90,3 +98,4 @@ en:
   time: 
     formats: 
       commontator: "%b %d %Y at %I:%M%p %Z"
+

data/config/locales/commontator/en.yml~

@@ -0,0 +1,104 @@
+# Files in the config/locales directory are used for internationalization
+# and are automatically loaded by Rails. If you want to use locales other
+# than English, add the necessary files in this directory.
+#
+# To use the locales, use `I18n.t`:
+#
+#     I18n.t 'hello'
+#
+# In views, this is aliased to just `t`:
+#
+#     <%= t('hello') %>
+#
+# To use a different locale, set it with `I18n.locale`:
+#
+#     I18n.locale = :es
+#
+# This would use the information in config/locales/es.yml.
+#
+# To learn more, please read the Rails Internationalization guide
+# available at http://guides.rubyonrails.org/i18n.html.
+
+--- 
+en: 
+  activerecord: 
+    attributes: 
+      commontator/comment: 
+        body: Comment
+        creator: Creator
+        editor: Editor
+        thread: Discussion
+      commontator/subscription: 
+        subscriber: Subscriber
+        thread: Discussion
+      commontator/thread: 
+        commontable: Commontable
+    models: 
+      commontator/comment: 
+        zero: comments
+        one: comment
+        other: comments
+      commontator/subscription: 
+        zero: subscriptions
+        one: subscription
+        other: subscriptions
+      commontator/thread: 
+        zero: threads
+        one: thread
+        other: threads
+  commontator: 
+    anonymous: Anonymous
+    comment: 
+      actions: 
+        cancel: Cancel
+        confirm_delete: "Are you sure you want to delete this comment?"
+        create: "Post Comment"
+        delete: Delete
+        edit: Edit
+        new: "New Comment"
+        undelete: Undelete
+        update: "Modify Comment"
+      errors: 
+        already_deleted: "This comment has already been deleted."
+        create: "This comment could not be posted because:"
+        double_posted: "is a duplicate of another comment."
+        not_deleted: "This comment is not deleted."
+        update: "This comment could not be modified because:"
+      status: 
+        created_at: "Posted on %{created_at}."
+        deleted_by: "Comment deleted by %{deleter_name}."
+        updated_at: "Last modified by %{editor_name} on %{updated_at}."
+    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}."
+      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?"
+        subscribe: Subscribe
+        unsubscribe: Unsubscribe
+      errors: 
+        already_subscribed: "You are already subscribed to this discussion."
+        not_subscribed: "You are not subscribed to this discussion."
+    thread: 
+      actions: 
+        show_all: "Show All Comments"
+        filter: "Filter Comments"
+        close: "Close Discussion"
+        confirm_close: "Are you sure you want to close this discussion?"
+        reopen: "Reopen Discussion"
+        show: "Show Comments"
+      errors: 
+        already_closed: "This discussion has already been closed."
+        not_closed: "This discussion is not closed."
+      status: 
+        cannot_post: "New comments cannot be posted at this time."
+        closed: "Comments (Closed by %{closer_name})"
+        open: Comments
+  time: 
+    formats: 
+      commontator: "%b %d %Y at %I:%M%p %Z"
+

data/config/routes.rb

@@ -20,3 +20,4 @@ Commontator::Engine.routes.draw do
     end
   end
 end
+

data/db/migrate/0_install_commontator.rb

@@ -8,31 +8,28 @@ class InstallCommontator < ActiveRecord::Migration
       t.integer  'thread_id', :null => false
       t.text     'body', :null => false
       t.datetime 'deleted_at'
-      
-      t.integer  'cached_votes_total', :default => 0
-      t.integer  'cached_votes_up', :default => 0
-      t.integer  'cached_votes_down', :default => 0
+
+      t.integer :cached_votes_up, :default => 0
+      t.integer :cached_votes_down, :default => 0
 
       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, [:creator_id, :creator_type, :thread_id], :name => 'index_commontator_comments_on_c_id_and_c_type_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
+    add_index  :commontator_comments, :cached_votes_up
+    add_index  :commontator_comments, :cached_votes_down
     
     create_table 'commontator_subscriptions' do |t|
       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_id, :subscriber_type, :thread_id], :unique => true, :name => 'index_c_s_on_s_id_and_s_type_and_t_id'
+    add_index :commontator_subscriptions, [:subscriber_id, :subscriber_type, :thread_id], :unique => true, :name => 'index_commontator_subscriptions_on_s_id_and_s_type_and_t_id'
     add_index :commontator_subscriptions, :thread_id
 
     create_table 'commontator_threads' do |t|
@@ -45,6 +42,7 @@ class InstallCommontator < ActiveRecord::Migration
       t.timestamps
     end
 
-    add_index :commontator_threads, [:commontable_id, :commontable_type], :unique => true, :name => 'index_c_t_on_c_id_and_c_type'
+    add_index :commontator_threads, [:commontable_id, :commontable_type], :unique => true, :name => 'index_commontator_threads_on_c_id_and_c_type'
   end
 end
+

data/db/migrate/0_install_commontator.rb~

@@ -0,0 +1,54 @@
+class InstallCommontator < ActiveRecord::Migration
+  def change
+    create_table 'commontator_comments' do |t|
+      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
+      t.datetime 'deleted_at'
+      
+      t.integer :cached_votes_total, :default => 0
+      t.integer :cached_votes_score, :default => 0
+      t.integer :cached_votes_up, :default => 0
+      t.integer :cached_votes_down, :default => 0
+      t.integer :cached_weighted_score, :default => 0
+
+      t.timestamps
+    end
+
+    add_index :commontator_comments, [:creator_id, :creator_type, :thread_id], :name => 'index_commontator_comments_on_c_id_and_c_type_and_t_id'
+    add_index :commontator_comments, :thread_id
+
+    add_index  :commontator_comments, :cached_votes_total
+    add_index  :commontator_comments, :cached_votes_score
+    add_index  :commontator_comments, :cached_votes_up
+    add_index  :commontator_comments, :cached_votes_down
+    add_index  :commontator_comments, :cached_weighted_score
+    
+    create_table 'commontator_subscriptions' do |t|
+      t.string   'subscriber_type', :null => false
+      t.integer  'subscriber_id', :null => false
+      t.integer  'thread_id', :null => false
+
+      t.timestamps
+    end
+
+    add_index :commontator_subscriptions, [:subscriber_id, :subscriber_type, :thread_id], :unique => true, :name => 'index_commontator_subscriptions_on_s_id_and_s_type_and_t_id'
+    add_index :commontator_subscriptions, :thread_id
+
+    create_table 'commontator_threads' do |t|
+      t.string   'commontable_type'
+      t.integer  'commontable_id'
+      t.datetime 'closed_at'
+      t.string   'closer_type'
+      t.integer  'closer_id'
+
+      t.timestamps
+    end
+
+    add_index :commontator_threads, [:commontable_id, :commontable_type], :unique => true, :name => 'index_commontator_threads_on_c_id_and_c_type'
+  end
+end
+