commontator 0.2.4 → 0.3.10

data/config/initializers/commontator.rb~

@@ -8,13 +8,12 @@ Commontator.configure do |config|
   # Default: 'current_user'
   config.current_user_method = 'current_user'
 
-  # Proc that is called when a view wants to set the page heading.
-  # Default: nil
-  config.heading_proc = Proc.new{|string| }
-
-  # Proc that is called after any javascript runs (e.g. to clear flash notices)
-  # Default: nil
-  config.javascript_proc = Proc.new{}
+  # Proc that is called after any javascript runs (e.g. to clear flash)
+  # It is passed the 'self' object 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)
+  # 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();' }
 
 
   # Commontator (User model) Configuration
@@ -57,14 +56,19 @@ Commontator.configure do |config|
   # as an argument to acts_as_commontable in each one
   # Default: 'commontable'
   config.commontable_name = 'commontable'
+  
+  # Proc that returns the url to the thread's view (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 subject
   # Default:
-  # Proc.new do |params|
+  # lambda do |params|
   #   "#{params[:commontator_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 = Proc.new do |params|
+  config.subscription_email_subject_proc = lambda do |params|
     "#{params[:commontator_name]} #{params[:config].comment_create_verb_past} a " + \
     "#{params[:config].comment_name} on #{params[:commontable_name]} ##{params[:commontable_id]}"
   end
@@ -128,8 +132,9 @@ Commontator.configure do |config|
   config.commontable_id_method = 'id'
 
   # Method called on commontable and passed user as argument
-  # If true, that user is an admin for that particular commontable's thread
-  # Default: '' (no thread-specific admins)
+  # If true, that user is a moderator for that particular commontable's thread
+  # and is given admin-like capabilities for that thread only
+  # Default: '' (no thread-specific moderators)
   config.can_edit_thread_method = ''
 
   # Method called on commontable and passed user as argument

data/config/routes.rb

@@ -12,13 +12,11 @@ Commontator::Engine.routes.draw do
     put 'close', :on => :member
     put 'reopen', :on => :member
     
-    get 'subscribe', :to => 'subscriptions#create',
+    put 'subscribe', :to => 'subscriptions#create',
                      :as => 'subscribe',
                      :on => :member
-    get 'unsubscribe', :to => 'subscriptions#destroy',
+    put 'unsubscribe', :to => 'subscriptions#destroy',
                        :as => 'unsubscribe',
                        :on => :member
   end
-  
-  resources :subscriptions, :only => [:index]
 end

data/config/routes.rb~

@@ -3,6 +3,7 @@ Commontator::Engine.routes.draw do
     resources :comments, :except => [:index, :destroy], :shallow => true do
       put 'delete', :on => :member
       put 'undelete', :on => :member
+      
       put 'upvote', :on => :member
       put 'downvote', :on => :member
       put 'unvote', :on => :member
@@ -10,10 +11,11 @@ Commontator::Engine.routes.draw do
     
     put 'close', :on => :member
     put 'reopen', :on => :member
-    get 'subscribe', :to => 'subscriptions#create',
+    
+    put 'subscribe', :to => 'subscriptions#create',
                      :as => 'subscribe',
                      :on => :member
-    get 'unsubscribe', :to => 'subscriptions#destroy',
+    put 'unsubscribe', :to => 'subscriptions#destroy',
                        :as => 'unsubscribe',
                        :on => :member
   end

data/lib/commontator.rb

@@ -4,7 +4,6 @@ module Commontator
   # Can be set in initializer only
   ENGINE_ATTRIBUTES = [
     :current_user_method,
-    :heading_proc,
     :javascript_proc
   ]
 
@@ -22,6 +21,7 @@ module Commontator
     :comment_create_verb_present,
     :comment_create_verb_past,
     :commontable_name,
+    :commontable_url_proc,
     :subscription_email_subject_proc,
     :timestamp_format,
     :admin_can_edit_comments,

data/lib/commontator.rb~

@@ -4,7 +4,6 @@ module Commontator
   # Can be set in initializer only
   ENGINE_ATTRIBUTES = [
     :current_user_method,
-    :heading_proc,
     :javascript_proc
   ]
 
@@ -22,6 +21,7 @@ module Commontator
     :comment_create_verb_present,
     :comment_create_verb_past,
     :commontable_name,
+    :thread_url_proc,
     :subscription_email_subject_proc,
     :timestamp_format,
     :admin_can_edit_comments,
@@ -32,7 +32,7 @@ module Commontator
     :can_delete_old_comments,
     :can_subscribe_to_thread,
     :comments_can_be_voted_on,
-    :comments_order_by_votes,
+    :comments_ordered_by_votes,
     :closed_threads_are_readable,
     :deleted_comments_are_visible,
     :commontable_id_method,

data/lib/commontator/version.rb

@@ -1,3 +1,3 @@
 module Commontator
-  VERSION = "0.2.4"
+  VERSION = "0.3.10"
 end

data/lib/commontator/version.rb~

@@ -1,3 +1,3 @@
 module Commontator
-  VERSION = "0.3.0"
+  VERSION = "0.3.9"
 end

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

@@ -8,13 +8,12 @@ Commontator.configure do |config|
   # Default: 'current_user'
   config.current_user_method = 'current_user'
 
-  # Proc that is called when a view wants to set the page heading.
-  # Default: Proc.new {}
-  config.heading_proc = nil
-
-  # Proc that is called after any javascript runs (e.g. to clear flash notices)
-  # Default: Proc.new {}
-  config.javascript_proc = nil
+  # Proc that is called after any javascript runs (e.g. to clear flash)
+  # It is passed the 'self' object 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)
+  # 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();' }
 
 
   # Commontator (User model) Configuration
@@ -58,11 +57,22 @@ Commontator.configure do |config|
   # Default: 'commontable'
   config.commontable_name = 'commontable'
 
+  # 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 subject
-  # Default: Proc.new {}
-  config.subscription_email_subject_proc = Proc.new {|params| \
+  # Default:
+  # lambda do |params|
+  #   "#{params[:commontator_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[:commontator_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]} ##{params[:commontable_id]}"
+  end
 
   # The format of the timestamps used by Commontator
   # Default: '%b %d %Y, %I:%M %p'
@@ -123,8 +133,9 @@ Commontator.configure do |config|
   config.commontable_id_method = 'id'
 
   # Method called on commontable and passed user as argument
-  # If true, that user is an admin for that particular commontable's thread
-  # Default: '' (no thread-specific admins)
+  # If true, that user is a moderator for that particular commontable's thread
+  # and is given admin-like capabilities for that thread only
+  # Default: '' (no thread-specific moderators)
   config.can_edit_thread_method = ''
 
   # Method called on commontable and passed user as argument

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

@@ -0,0 +1,174 @@
+# Change the settings below to suit your needs
+# All settings are initially set to their default values
+Commontator.configure do |config|
+
+  # Engine Configuration
+
+  # Method called on ApplicationController to return the current user
+  # Default: 'current_user'
+  config.current_user_method = 'current_user'
+
+  # Proc that is called after any javascript runs (e.g. to clear flash)
+  # It is passed the 'self' object 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)
+  # 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();' }
+
+
+  # Commontator (User model) Configuration
+
+  # Whether the commontator's name is clickable in the comment view
+  # Default: false
+  config.commontator_name_clickable = false
+
+  # The method that return the commontator's email address
+  # Default: 'email'
+  config.commontator_email_method = 'email'
+
+  # The method that return the commontator's name
+  # Default: '' (Anonymous)
+  config.commontator_name_method = ''
+
+  # Method that returns true if the commontator is an admin for all threads
+  # Admins can always delete other users' comments and close threads
+  # Default: '' (no admins)
+  config.is_admin_method = ''
+
+
+  # Commontable (Commentable model) 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'
+
+  # 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 = 'commontable'
+
+  # Proc that returns the url to the thread's view (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 subject
+  # Default:
+  # lambda do |params|
+  #   "#{params[:commontator_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[:commontator_name]} #{params[:config].comment_create_verb_past} a " + \
+    "#{params[:config].comment_name} on #{params[:commontable_name]} ##{params[:commontable_id]}"
+  end
+
+  # 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: false
+  config.can_delete_own_comments = false
+
+  # 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.comments_can_be_voted_on = 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 admins
+  # Default: true
+  config.closed_threads_are_readable = true
+
+  # Whether comments deleted by admins can be seen
+  # (the content will still be hidden)
+  # Default: true
+  config.deleted_comments_are_visible = true
+
+  # Method called on commontable to return its id
+  # Default: 'id'
+  config.commontable_id_method = 'id'
+
+  # Method called on commontable and passed user as argument
+  # If true, that user is a moderator for that particular commontable's thread
+  # and is given admin-like capabilities for that thread only
+  # Default: '' (no thread-specific moderators)
+  config.can_edit_thread_method = ''
+
+  # Method called on commontable and passed user as argument
+  # If true, that user is allowed to read that commontable's thread
+  # Default: '' (no read restrictions)
+  config.can_read_thread_method = ''
+
+  # Method called on commontable when a comment is created
+  # Passed user, comment as arguments
+  # Default: '' (no callback)
+  config.comment_created_callback = ''
+
+  # Method called on commontable when a comment is edited
+  # Passed user, comment as arguments
+  # Default: '' (no callback)
+  config.comment_edited_callback = ''
+
+  # Method called on commontable when a comment is deleted
+  # Passed user, comment as arguments
+  # Default: '' (no callback)
+  config.comment_deleted_callback = ''
+
+  # Method called on commontable when a thread is closed
+  # Passed user as argument
+  # Default: '' (no callback)
+  config.thread_closed_callback = ''
+
+  # Method called on commontable when a thread is subscribed to
+  # Passed user as argument
+  # Default: '' (no callback)
+  config.subscribe_callback = ''
+
+  # Method called on commontable when a thread is unsubscribed to
+  # Passed user as argument
+  # Default: '' (no callback)
+  config.unsubscribe_callback = ''
+end

data/test/dummy/log/development.log

@@ -342,3 +342,9 @@ Connecting to database specified by database.yml
 Connecting to database specified by database.yml
 SQLite3::SQLException: no such column: a: SELECT "commontator_comments".* FROM "commontator_comments"  WHERE "commontator_comments"."thread_id" = 1 ORDER BY a
 Connecting to database specified by database.yml
+Connecting to database specified by database.yml
+Connecting to database specified by database.yml
+Connecting to database specified by database.yml
+Connecting to database specified by database.yml
+Connecting to database specified by database.yml
+Connecting to database specified by database.yml

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: commontator
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.10
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-11 00:00:00.000000000 Z
+date: 2012-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -99,10 +99,8 @@ files:
 - app/views/commontator/comments/new.html.erb~
 - app/views/commontator/comments/update.js.erb
 - app/views/commontator/comments/_actions.html.erb~
-- app/views/commontator/comments/edit.html.erb
 - app/views/commontator/comments/update.js.erb~
 - app/views/commontator/comments/new.js.erb~
-- app/views/commontator/comments/new.html.erb
 - app/views/commontator/comments/_show.html.erb
 - app/views/commontator/comments/_form.html.erb~
 - app/views/commontator/comments/delete.js.erb~
@@ -116,20 +114,24 @@ files:
 - app/views/commontator/comments/create.js.erb~
 - app/views/commontator/subscriptions_mailer/comment_created_email.html.erb
 - app/views/commontator/subscriptions_mailer/comment_created_email.html.erb~
+- app/views/commontator/subscriptions/subscribe.js.erb
 - app/views/commontator/subscriptions/_subscription_link.html.erb~
-- app/views/commontator/subscriptions/_subscription_link.html.erb
+- app/views/commontator/subscriptions/_link.html.erb~
 - app/views/commontator/subscriptions/destroy.js.erb~
+- app/views/commontator/subscriptions/_link.html.erb
 - app/views/commontator/subscriptions/index.html.erb~
-- app/views/commontator/subscriptions/destroy.js.erb
-- app/views/commontator/subscriptions/index.html.erb
-- app/views/commontator/subscriptions/create.js.erb
+- app/views/commontator/subscriptions/_index.html.erb~
 - app/views/commontator/subscriptions/create.js.erb~
-- app/views/commontator/commontator/_thread.html.erb~
-- app/views/commontator/commontator/_thread.html.erb
+- app/views/commontator/subscriptions/subscribe.js.erb~
+- app/views/commontator/shared/_thread_link.html.erb
+- app/views/commontator/threads/show.js.erb~
 - app/views/commontator/threads/_show.html.erb~
+- app/views/commontator/threads/_link.html.erb~
 - app/views/commontator/threads/show.js.erb
-- app/views/commontator/threads/show.html.erb
+- app/views/commontator/threads/close.js.erb~
+- app/views/commontator/threads/_actions.html.erb~
 - app/views/commontator/threads/_show.html.erb
+- app/views/commontator/threads/show.html.erb~
 - app/models/commontator/comment.rb
 - app/models/commontator/subscription.rb
 - app/models/commontator/comment.rb~
@@ -215,6 +217,7 @@ files:
 - test/dummy/config/initializers/wrap_parameters.rb
 - test/dummy/config/initializers/commontator.rb
 - test/dummy/config/initializers/secret_token.rb
+- test/dummy/config/initializers/commontator.rb~
 - test/dummy/config/initializers/session_store.rb
 - test/dummy/config/initializers/inflections.rb
 - test/dummy/config/locales/en.yml
@@ -295,6 +298,7 @@ test_files:
 - test/dummy/config/initializers/wrap_parameters.rb
 - test/dummy/config/initializers/commontator.rb
 - test/dummy/config/initializers/secret_token.rb
+- test/dummy/config/initializers/commontator.rb~
 - test/dummy/config/initializers/session_store.rb
 - test/dummy/config/initializers/inflections.rb
 - test/dummy/config/locales/en.yml