commontator 4.0.2 → 4.1.1

data/spec/dummy/config/application.rb

@@ -3,7 +3,7 @@ require File.expand_path('../boot', __FILE__)
 require 'rails/all'
 
 Bundler.require(*Rails.groups)
-require "commontator"
+require 'commontator'
 
 module Dummy
   class Application < Rails::Application

data/spec/dummy/config/application.rb~

@@ -0,0 +1,27 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "commontator"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    config.generators do |g|
+      g.test_framework :mini_test, :spec => true, :fixture => false
+    end
+  end
+end
+

data/spec/dummy/config/initializers/commontator.rb

@@ -1,12 +1,12 @@
 # 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 passed the current controller as argument
+  # Returns the current user
+  # Default: lambda { |controller| controller.current_user }
+  config.current_user_proc = lambda { |controller| controller.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
@@ -14,36 +14,35 @@ Commontator.configure do |config|
   # 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| 'Dummy Javascript' }
+  config.javascript_proc = lambda { |view| '' }
 
 
   # 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
+  # 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'
+  # Proc called with user as argument
+  # Returns the user's name
+  # Default: lambda { |user| 'Anonymous' } (all users are Anonymous)
+  config.user_name_proc = lambda { |user| 'Anonymous' }
 
-  # The method that returns the user's name
-  # Default: '' (use user_missing_name)
-  config.user_name_method = ''
+  # Proc called with user as argument
+  # Returns the user's email address
+  # Used in the subscription mailer
+  # Default: lambda { |user| user.email }
+  config.user_email_proc = lambda { |user| user.email }
 
-  # 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
+  # Proc called with user as argument
+  # Returns true iif the user is an admin
+  # Admins can delete other users' comments and close threads
   # Default: lambda { |user| false } (no admins)
-  config.user_admin_proc = lambda { |user| user.try(:is_admin) }
+  config.user_admin_proc = lambda { |user| user.is_admin }
   
-  # Proc called with user as argument that returns true
-  # if the user should receive subscription emails
+  # Proc called with user as argument
+  # Returns true iif the user should receive subscription emails
   # Default: lambda { |user| true } (always receive subscription emails)
   config.subscription_email_enable_proc = lambda { |user| true }
 
@@ -62,16 +61,17 @@ Commontator.configure do |config|
   # Default: 'posted'
   config.comment_create_verb_past = 'posted'
 
-  # What a commontable is called in your application
-  # If you have multiple commontable models,
-  # you might want to pass this configuration value
-  # as an argument to acts_as_commontable in each one
-  # Default: 'commontable'
-  config.commontable_name = 'dummy model'
+  # 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'
 
   # The format of the timestamps used by Commontator
-  # Default: '%b %d %Y, %I:%M %p'
-  config.timestamp_format = '%b %d %Y, %I:%M %p'
+  # Default: '%b %d %Y at %I:%M %p'
+  config.timestamp_format = '%b %d %Y at %I:%M %p'
 
   # Whether admins can edit other users' comments
   # Default: false
@@ -109,56 +109,68 @@ Commontator.configure do |config|
   # Default: false
   config.can_vote_on_comments = true
 
+  # Whether to display upvotes and downvotes
+  # combined or separately
+  # Default: true
+  config.combine_upvotes_and_downvotes = true
+
   # 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 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
-  # (the content will still be hidden)
+  # Whether to show that comments deleted by a moderator actually existed
+  # (the content will be hidden either way)
   # 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| user.try(:can_edit) }
+  # Returns true iif the user should be allowed to read that thread
+  # Note: can be called with a user object that is false or nil if not logged in
+  # Default: lambda { |thread, user| true } (anyone can read threads even if not logged in)
+  config.can_read_thread_proc = lambda { |thread, user| user && user.can_read }
 
   # 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| user.try(:can_read) }
-
-  # 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
+  # Returns true iif the user is a moderator for that particular thread
+  # and can delete users' comments in the thread or close it
+  # Default: lambda { |thread, user| false } (no thread-specific moderators)
+  config.can_edit_thread_proc = lambda { |thread, user| user.can_edit }
+
+  # Proc called with the commontable object as argument
+  # Returns the name by which the commontable object will be called in email messages
+  # If you have multiple commontable models, you may want to pass this
+  # configuration value as an argument to acts_as_commontable in each one
+  # Default: lambda { |commontable| "#{commontable.class.name} ##{commontable.id}" }
+  config.commontable_name_proc = lambda { |commontable| "#{commontable.class.name} ##{commontable.id}" }
+
+  # Proc called with main_app and commontable objects as arguments
+  # Return the url that contains the commontable's thread to be used in the subscription email
+  # The application's routes can be accessed using the main_app object
   # Default: lambda { |main_app, commontable| main_app.polymorphic_url(commontable) }
+  # (defaults to the commontable's show url)
   config.commontable_url_proc = lambda { |main_app, commontable| main_app.polymorphic_url(commontable) }
-
-  # Proc that returns the subscription email 'from' address
+  
+  # Proc called with params from the subscription mailer as arguments
+  # Returns the subscription email 'from' address
+  # Available params can be seen in the subscription mailer
   # 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
+  # Proc called with params from the subscription mailer as arguments
+  # Returns the subscription email 'subject' string
+  # Available params can be seen in the subscription mailer
   # 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]}"
+  #   "#{params[:config].comment_name} on #{params[:commontable_name]}"
   # 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]}"
+    "#{params[:config].comment_name} on #{params[:commontable_name]}"
   end
 end

data/spec/dummy/config/initializers/commontator.rb~

@@ -0,0 +1,176 @@
+# Change the settings below to suit your needs
+# All settings are initially set to their default values
+Commontator.configure do |config|
+  # Engine Configuration
+
+  # Proc that is passed the current controller as argument
+  # Returns the current user
+  # Default: lambda { |controller| controller.current_user }
+  config.current_user_proc = lambda { |controller| controller.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| 'DummyJS' }
+
+
+  # User (acts_as_commontator) Configuration
+
+  # 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
+
+  # Proc called with user as argument
+  # Returns the user's name
+  # Default: lambda { |user| 'Anonymous' } (all users are Anonymous)
+  config.user_name_proc = lambda { |user| 'Anonymous' }
+
+  # Proc called with user as argument
+  # Returns the user's email address
+  # Used in the subscription mailer
+  # Default: lambda { |user| user.email }
+  config.user_email_proc = lambda { |user| user.email }
+
+  # Proc called with user as argument
+  # Returns true iif the user is an admin
+  # Admins can delete other users' comments and close threads
+  # Default: lambda { |user| false } (no admins)
+  config.user_admin_proc = lambda { |user| user.is_admin }
+  
+  # Proc called with user as argument
+  # Returns true iif 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 = 'dummy 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: 'modify'
+  config.comment_edit_verb_present = 'modify'
+
+  # Verb used when editing comments (past)
+  # Default: 'modified'
+  config.comment_edit_verb_past = 'modified'
+
+  # The format of the timestamps used by Commontator
+  # Default: '%b %d %Y at %I:%M %p'
+  config.timestamp_format = '%b %d %Y at %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 = true
+
+  # Whether to display upvotes and downvotes
+  # combined or separately
+  # Default: true
+  config.combine_upvotes_and_downvotes = true
+
+  # 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 to show that comments deleted by a moderator actually existed
+  # (the content will be hidden either way)
+  # Default: true
+  config.deleted_comments_are_visible = true
+
+  # Proc called with thread and user as arguments
+  # Returns true iif the user should be allowed to read that thread
+  # Note: can be called with a user object that is false or nil if not logged in
+  # Default: lambda { |thread, user| true } (anyone can read threads even if not logged in)
+  config.can_read_thread_proc = lambda { |thread, user| user && user.can_read }
+
+  # Proc called with thread and user as arguments
+  # Returns true iif the user is a moderator for that particular thread
+  # and can delete users' comments in the thread or close it
+  # Default: lambda { |thread, user| false } (no thread-specific moderators)
+  config.can_edit_thread_proc = lambda { |thread, user| user.can_edit }
+
+  # Proc called with the commontable object as argument
+  # Returns the name by which the commontable object will be called in email messages
+  # If you have multiple commontable models, you may want to pass this
+  # configuration value as an argument to acts_as_commontable in each one
+  # Default: lambda { |commontable| "#{commontable.class.name} ##{commontable.id}" }
+  config.commontable_name_proc = lambda { |commontable| "#{commontable.class.name} ##{commontable.id}" }
+
+  # Proc called with main_app and commontable objects as arguments
+  # Return the url that contains the commontable's thread to be used in the subscription email
+  # The application's routes can be accessed using the main_app object
+  # Default: lambda { |main_app, commontable| main_app.polymorphic_url(commontable) }
+  # (defaults to the commontable's show url)
+  config.commontable_url_proc = lambda { |main_app, commontable| main_app.polymorphic_url(commontable) }
+  
+  # Proc called with params from the subscription mailer as arguments
+  # Returns the subscription email 'from' address
+  # Available params can be seen in the subscription mailer
+  # Default:
+  # lambda { |params| 'no-reply@example.com' }
+  config.subscription_email_from_proc = lambda { |params| 'no-reply@example.com' }
+
+  # Proc called with params from the subscription mailer as arguments
+  # Returns the subscription email 'subject' string
+  # Available params can be seen in the subscription mailer
+  # Default:
+  # lambda do |params|
+  #   "#{params[:creator_name]} #{params[:config].comment_create_verb_past} a " + \
+  #   "#{params[:config].comment_name} on #{params[:commontable_name]}"
+  # 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]}"
+  end
+end

data/spec/dummy/config/initializers/commontator2.rb~

@@ -0,0 +1,169 @@
+# 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| 'Dummy Javascript' }
+
+
+  # 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 delete other users' comments and close threads
+  # Default: lambda { |user| false } (no admins)
+  config.user_admin_proc = lambda { |user| user.try(:is_admin) }
+  
+  # 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 = 'dummy 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: '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 will want to pass this configuration value
+  # as an argument to acts_as_commontable in each one
+  # Default: 'commontable'
+  config.commontable_name = 'dummy model'
+
+  # 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 = true
+
+  # 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 to show that comments deleted by a moderator actually existed
+  # (the content will be hidden either way)
+  # 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 can delete users' comments in the thread or close it
+  # 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 false or nil
+  # Default: lambda { |thread, user| true } (anyone can read threads even if not logged in)
+  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