commontator 0.5.14 → 1.0.0

data/{test/dummy/config/initializers/commontator.rb → config/initializers/commontator.rb~}

@@ -4,7 +4,7 @@ Commontator.configure do |config|
 
   # Engine Configuration
 
-  # Method called on ApplicationController to return the current user
+  # Name of the ApplicationController helper method that returns the current user
   # Default: 'current_user'
   config.current_user_method = 'current_user'
 
@@ -25,6 +25,11 @@ Commontator.configure do |config|
   # Whether the user's name is clickable in the comment view
   # Default: false
   config.user_name_clickable = false
+  
+  # Whether automated emails are sent to the user whenever
+  # a comment is posted on a thread they subscribe to
+  # Default: true
+  config.subscription_emails = true
 
   # The method that returns the user's email address
   # Default: 'email'
@@ -34,10 +39,11 @@ Commontator.configure do |config|
   # Default: '' (use user_missing_name)
   config.user_name_method = ''
 
-  # Method that returns true if the user is an admin for all threads
+  # 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
-  # Default: '' (no admins)
-  config.is_admin_method = ''
+  # Note: user can be nil
+  # Default: lambda { |user| false } (no admins)
+  config.user_admin_proc = lambda { |user| false }
 
 
   # Commontable (acts_as_commontable) Configuration
@@ -60,23 +66,6 @@ Commontator.configure do |config|
   # as an argument to acts_as_commontable in each one
   # 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:
-  # 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
 
   # The format of the timestamps used by Commontator
   # Default: '%b %d %Y, %I:%M %p'
@@ -100,8 +89,8 @@ Commontator.configure do |config|
   config.can_edit_old_comments = false
 
   # Whether users can delete their own comments
-  # Default: false
-  config.can_delete_own_comments = false
+  # Default: true
+  config.can_delete_own_comments = true
 
   # Whether users can delete their own comments
   # after someone posted a newer comment
@@ -116,7 +105,7 @@ Commontator.configure do |config|
   # Note: requires acts_as_votable gem installed
   # and configured for your application
   # Default: false
-  config.comments_can_be_voted_on = false
+  config.can_vote_on_comments = false
 
   # Whether comments should be ordered by vote score
   # instead of by order posted
@@ -132,48 +121,37 @@ Commontator.configure do |config|
   # Default: true
   config.deleted_comments_are_visible = true
 
-  # Method called on commontable to return its id
+  # The method returns the commontable's id which is sent to users in email messages
   # 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
+  # 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
-  # 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 = ''
+  # 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 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_commontator.rb

@@ -20,7 +20,7 @@ class InstallCommontator < ActiveRecord::Migration
       t.integer  "subscriber_id"
       t.string   "subscriber_type"
       t.integer  "thread_id"
-      t.boolean  "is_unread"
+      t.integer  "unread", :default => 0
 
       t.timestamps
     end

data/{test/dummy/db/migrate/1_install_commontator.commontator.rb → db/migrate/0_install_commontator.rb~}

@@ -1,4 +1,3 @@
-# This migration comes from commontator (originally 0)
 class InstallCommontator < ActiveRecord::Migration
   def change
     create_table "commontator_comments" do |t|
@@ -21,7 +20,7 @@ class InstallCommontator < ActiveRecord::Migration
       t.integer  "subscriber_id"
       t.string   "subscriber_type"
       t.integer  "thread_id"
-      t.boolean  "is_unread"
+      t.integer  "unread"
 
       t.timestamps
     end

data/lib/commontator.rb

@@ -11,9 +11,10 @@ module Commontator
   COMMONTATOR_ATTRIBUTES = [
     :user_missing_name,
     :user_name_clickable,
+    :subscription_emails,
     :user_email_method,
     :user_name_method,
-    :is_admin_method
+    :user_admin_proc
   ]
   
   # Can be set in initializer or passed as an option to acts_as_commontable
@@ -22,8 +23,6 @@ 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,
     :auto_subscribe_on_comment,
@@ -32,19 +31,15 @@ module Commontator
     :can_delete_own_comments,
     :can_delete_old_comments,
     :can_subscribe_to_thread,
-    :comments_can_be_voted_on,
+    :can_vote_on_comments,
     :comments_ordered_by_votes,
     :closed_threads_are_readable,
     :deleted_comments_are_visible,
     :commontable_id_method,
-    :can_edit_thread_method,
-    :can_read_thread_method,
-    :comment_created_callback,
-    :comment_edited_callback,
-    :comment_deleted_callback,
-    :thread_closed_callback,
-    :subscribe_callback,
-    :unsubscribe_callback
+    :can_edit_thread_proc,
+    :can_read_thread_proc,
+    :commontable_url_proc,
+    :subscription_email_subject_proc
   ]
   
   (ENGINE_ATTRIBUTES + COMMONTATOR_ATTRIBUTES + \

data/lib/commontator.rb~

@@ -11,9 +11,10 @@ module Commontator
   COMMONTATOR_ATTRIBUTES = [
     :user_missing_name,
     :user_name_clickable,
+    :subscription_emails,
     :user_email_method,
     :user_name_method,
-    :is_admin_method
+    :user_admin_proc
   ]
   
   # Can be set in initializer or passed as an option to acts_as_commontable
@@ -22,8 +23,6 @@ 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,
     :auto_subscribe_on_comment,
@@ -37,14 +36,10 @@ module Commontator
     :closed_threads_are_readable,
     :deleted_comments_are_visible,
     :commontable_id_method,
-    :can_edit_thread_method,
-    :can_read_thread_method,
-    :comment_created_callback,
-    :comment_edited_callback,
-    :comment_deleted_callback,
-    :thread_closed_callback,
-    :subscribe_callback,
-    :unsubscribe_callback
+    :can_edit_thread_proc,
+    :can_read_thread_proc,
+    :commontable_url_proc,
+    :subscription_email_subject_proc
   ]
   
   (ENGINE_ATTRIBUTES + COMMONTATOR_ATTRIBUTES + \
@@ -60,4 +55,4 @@ end
 require 'commontator/engine'
 require 'commontator/acts_as_commontator'
 require 'commontator/acts_as_commontable'
-require 'commontator/shared_methods'
+require 'commontator/controller_includes'

data/lib/commontator/commontable_config.rb

@@ -1,7 +1,7 @@
 module Commontator
   class CommontableConfig
     Commontator::COMMONTABLE_ATTRIBUTES.each do |attribute|
-      cattr_accessor attribute
+      attr_accessor attribute
     end
   
     def initialize(options = {})

data/lib/commontator/commontable_config.rb~

@@ -0,0 +1,13 @@
+module Commontator
+  class CommontableConfig
+    Commontator::COMMONTABLE_ATTRIBUTES.each do |attribute|
+      cattr_accessor attribute
+    end
+  
+    def initialize(options = {})
+      Commontator::COMMONTABLE_ATTRIBUTES.each do |attribute|
+        self.send attribute.to_s + '=', options[attribute] || Commontator.send(attribute)
+      end
+    end
+  end
+end

data/lib/commontator/commontator_config.rb

@@ -1,7 +1,7 @@
 module Commontator
   class CommontatorConfig
     Commontator::COMMONTATOR_ATTRIBUTES.each do |attribute|
-      cattr_accessor attribute
+      attr_accessor attribute
     end
   
     def initialize(options = {})

data/lib/commontator/commontator_config.rb~

@@ -0,0 +1,13 @@
+module Commontator
+  class CommontatorConfig
+    Commontator::COMMONTATOR_ATTRIBUTES.each do |attribute|
+      cattr_accessor attribute
+    end
+  
+    def initialize(options = {})
+      Commontator::COMMONTATOR_ATTRIBUTES.each do |attribute|
+        self.send attribute.to_s + '=', options[attribute] || Commontator.send(attribute)
+      end
+    end
+  end
+end

data/lib/commontator/controller_includes.rb

@@ -1,4 +1,5 @@
 require 'commontator/shared_helper'
+require 'commontator/security_transgression'
 
 module Commontator
   module ControllerIncludes

data/lib/commontator/controller_includes.rb~

@@ -10,7 +10,7 @@ module Commontator
     
     def commontator_thread_show(commontable)
       user = send Commontator.current_user_method	
-      raise SecurityTransgression unless (@user.nil? || @user.is_commontator)
+      raise SecurityTransgression unless (user.nil? || user.is_commontator)
       
       thread = commontable.thread
       raise SecurityTransgression unless thread.can_be_read_by?(user)

data/lib/commontator/security_transgression.rb

@@ -0,0 +1,3 @@
+module Commontator
+  class SecurityTransgression < StandardError; end
+end

data/lib/commontator/shared_helper.rb

@@ -1,7 +1,7 @@
 module Commontator
   module SharedHelper
     def commontator_thread(commontable)
-      user = send Commontator.current_user_method
+      user = self.send Commontator.current_user_method
       
       render(:partial => 'commontator/shared/thread',
              :locals => {:thread => commontable.thread,

data/lib/commontator/shared_helper.rb~

@@ -1,7 +1,7 @@
 module Commontator
   module SharedHelper
     def commontator_thread(commontable)
-      user = send Commontator.current_user_method
+      user = Commontator.current_user_proc.call
       
       render(:partial => 'commontator/shared/thread',
              :locals => {:thread => commontable.thread,
@@ -18,7 +18,7 @@ module Commontator
     def commontator_email(user)
       return '' if user.nil?
       config = user.commontator_config
-      config.email_method.blank? ? '' : user.send(config.user_email_method)
+      config.user_email_method.blank? ? '' : user.send(config.user_email_method)
     end
     
     def commontator_gravatar_url(user, options = {})

data/lib/commontator/version.rb

@@ -1,3 +1,3 @@
 module Commontator
-  VERSION = "0.5.14"
+  VERSION = "1.0.0"
 end

data/lib/commontator/version.rb~

@@ -1,3 +1,3 @@
 module Commontator
-  VERSION = "0.5.13"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: commontator
 version: !ruby/object:Gem::Version
-  version: 0.5.14
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-13 00:00:00.000000000 Z
+date: 2012-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -59,6 +59,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: acts_as_votable
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A Rails engine for comments.
 email:
 - dms3@rice.edu
@@ -80,6 +112,7 @@ files:
 - app/controllers/commontator/subscriptions_controller.rb
 - app/controllers/commontator/comments_controller.rb~
 - app/controllers/commontator/application_controller.rb~
+- app/controllers/commontator/commontator_controller.rb~
 - app/controllers/commontator/threads_controller.rb
 - app/controllers/commontator/comments_controller.rb
 - app/controllers/commontator/subscriptions_controller.rb~
@@ -103,6 +136,7 @@ files:
 - app/views/commontator/comments/create.js.erb
 - app/views/commontator/comments/new.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/_link.html.erb
 - app/views/commontator/shared/_thread.html.erb~
@@ -114,19 +148,25 @@ files:
 - app/models/commontator/comment.rb
 - app/models/commontator/subscription.rb
 - app/models/commontator/comment.rb~
+- app/models/commontator/subscription.rb~
+- app/models/commontator/thread.rb~
 - app/models/commontator/thread.rb
 - app/helpers/commontator/comments_helper.rb~
 - app/helpers/commontator/threads_helper.rb
 - app/helpers/commontator/subscriptions_helper.rb~
 - app/helpers/commontator/threads_helper.rb~
+- app/helpers/commontator/commontator_helper.rb~
 - app/helpers/commontator/application_helper.rb
 - config/initializers/commontator.rb
+- config/initializers/commontator.rb~
 - config/routes.rb
+- db/migrate/0_install_commontator.rb~
 - db/migrate/0_install_commontator.rb
 - lib/commontator.rb
 - lib/commontator.rb~
 - lib/tasks/commontator_tasks.rake
 - lib/commontator/acts_as_commontable.rb
+- lib/commontator/commontator_config.rb~
 - lib/commontator/controller_includes.rb
 - lib/commontator/version.rb
 - lib/commontator/engine.rb
@@ -136,55 +176,15 @@ files:
 - lib/commontator/commontable_config.rb
 - lib/commontator/version.rb~
 - lib/commontator/shared_helper.rb
+- lib/commontator/security_transgression.rb~
+- lib/commontator/security_transgression.rb
 - lib/commontator/acts_as_commontator.rb
+- lib/commontator/commontable_config.rb~
 - lib/commontator/commontator_config.rb
 - lib/commontator/controller_includes.rb~
 - MIT-LICENSE
 - Rakefile
 - README.md
-- test/test_helper.rb
-- test/integration/navigation_test.rb
-- test/unit/subscription_test.rb
-- test/unit/comment_test.rb
-- test/unit/thread_test.rb
-- test/unit/helpers/subscriptions_helper_test.rb
-- test/unit/helpers/comments_helper_test.rb
-- test/functional/comments_controller_test.rb
-- test/functional/subscriptions_controller_test.rb
-- test/dummy/README.rdoc
-- test/dummy/log/development.log
-- test/dummy/db/development.sqlite3
-- test/dummy/db/schema.rb
-- test/dummy/db/migrate/1_install_commontator.commontator.rb
-- test/dummy/Rakefile
-- test/dummy/script/rails
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/assets/javascripts/application.js
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/config.ru
-- test/dummy/public/500.html
-- test/dummy/public/favicon.ico
-- test/dummy/public/422.html
-- test/dummy/public/404.html
-- test/dummy/config/database.yml
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/initializers/commontator.rb
-- test/dummy/config/initializers/secret_token.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/boot.rb
-- test/dummy/config/application.rb
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/routes.rb
-- test/commontator_test.rb
 homepage: http://rubygems.org/gems/commontator
 licenses: []
 post_install_message: 
@@ -209,47 +209,4 @@ rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Common Tator
-test_files:
-- test/test_helper.rb
-- test/integration/navigation_test.rb
-- test/unit/subscription_test.rb
-- test/unit/comment_test.rb
-- test/unit/thread_test.rb
-- test/unit/helpers/subscriptions_helper_test.rb
-- test/unit/helpers/comments_helper_test.rb
-- test/functional/comments_controller_test.rb
-- test/functional/subscriptions_controller_test.rb
-- test/dummy/README.rdoc
-- test/dummy/log/development.log
-- test/dummy/db/development.sqlite3
-- test/dummy/db/schema.rb
-- test/dummy/db/migrate/1_install_commontator.commontator.rb
-- test/dummy/Rakefile
-- test/dummy/script/rails
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/assets/javascripts/application.js
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/config.ru
-- test/dummy/public/500.html
-- test/dummy/public/favicon.ico
-- test/dummy/public/422.html
-- test/dummy/public/404.html
-- test/dummy/config/database.yml
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/initializers/commontator.rb
-- test/dummy/config/initializers/secret_token.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/boot.rb
-- test/dummy/config/application.rb
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/routes.rb
-- test/commontator_test.rb
+test_files: []