commontator 4.5.4 → 4.6.0

data/lib/commontator.rb

@@ -13,32 +13,35 @@ module Commontator
   # Can be set in initializer or passed as an option to acts_as_commontator
   COMMONTATOR_ATTRIBUTES = [
     :user_name_proc,
+    :user_link_proc,
     :user_avatar_proc,
-    :user_email_proc,
-    :user_link_proc
+    :user_email_proc
   ]
   
   # Can be set in initializer or passed as an option to acts_as_commontable
   COMMONTABLE_ATTRIBUTES = [
-    :email_from_proc,
+    :comment_filter,
     :thread_read_proc,
     :thread_moderator_proc,
-    :thread_subscription,
+    :comment_editing,
+    :comment_deletion,
+    :moderator_permissions,
     :comment_voting,
-    :voting_text_proc,
+    :vote_count_proc,
     :comment_order,
     :comments_per_page,
-    :wp_link_renderer_proc,
-    :comment_editing,
-    :comment_deletion,
-    :moderators_can_edit_comments,
-    :hide_deleted_comments,
-    :hide_closed_threads,
+    :thread_subscription,
+    :email_from_proc,
     :commontable_name_proc,
     :commontable_url_proc
   ]
   
   DEPRECATED_ATTRIBUTES = [
+    [:moderators_can_edit_comments, :moderator_permissions],
+    [:hide_deleted_comments, :comment_filter],
+    [:hide_closed_threads, :thread_read_proc],
+    [:wp_link_renderer_proc],
+    [:voting_text_proc, :vote_count_proc],
     [:user_name_clickable, :user_link_proc],
     [:user_admin_proc, :thread_moderator_proc],
     [:auto_subscribe_on_comment, :thread_subscription],
@@ -48,13 +51,13 @@ module Commontator
     [:can_delete_old_comments, :comment_deletion],
     [:can_subscribe_to_thread, :thread_subscription],
     [:can_vote_on_comments, :comment_voting],
-    [:combine_upvotes_and_downvotes, :voting_text_proc],
+    [:combine_upvotes_and_downvotes, :vote_count_proc],
     [:comments_order, :comment_order],
-    [:closed_threads_are_readable, :hide_closed_threads],
-    [:deleted_comments_are_visible, :hide_deleted_comments],
+    [:closed_threads_are_readable, :thread_read_proc],
+    [:deleted_comments_are_visible, :comment_filter],
     [:can_read_thread_proc, :thread_read_proc],
     [:can_edit_thread_proc, :thread_moderator_proc],
-    [:admin_can_edit_comments, :moderators_can_edit_comments],
+    [:admin_can_edit_comments, :moderator_permissions],
     [:subscription_email_enable_proc, :user_email_proc],
     [:comment_name, 'config/locales'],
     [:comment_create_verb_present, 'config/locales'],
@@ -65,6 +68,7 @@ module Commontator
     [:subscription_email_to_proc, 'config/locales'],
     [:subscription_email_from_proc, :email_from_proc],
     [:subscription_email_subject_proc, 'config/locales'],
+    [:comments_ordered_by_votes, :comment_order],
     [:current_user_method, :current_user_proc],
     [:user_missing_name, 'config/locales'],
     [:user_email_method, :user_email_proc],
@@ -95,7 +99,44 @@ module Commontator
     yield self
     warn "\n[COMMONTATOR] We recommend that you backup the config/initializers/commontator.rb file, rename or remove it, run rake commontator:install:initializers to copy the new default one, then configure it to your liking.\n" if @deprecated_method_called
   end
+
+  def self.commontator_config(user)
+    (user && user.is_commontator) ? user.commontator_config : self
+  end
+
+  def self.commontable_config(user)
+    (user && user.is_commontable) ? user.commontable_config : self
+  end
+
+  def self.app_routes
+    Commontator::ApplicationController.app_routes
+  end
+
+  def self.commontator_name(user)
+    commontator_config(user).user_name_proc.call(user)
+  end
+
+  def self.commontator_link(user, routing_proxy = app_routes)
+    commontator_config(user).user_link_proc.call(user, routing_proxy)
+  end
+
+  def self.commontator_email(user, mailer = nil)
+    commontator_config(user).user_email_proc.call(user, mailer)
+  end
+
+  def self.commontator_avatar(user, view)
+    commontator_config(user).user_avatar_proc.call(user, view)
+  end
+
+  def self.commontable_name(commontable)
+    commontable_config(commontable).commontable_name_proc.call(commontable)
+  end
+
+  def self.commontable_url(commontable, routing_proxy = app_routes)
+    commontable_config(commontable).commontable_url_proc.call(commontable, routing_proxy)
+  end
 end
 
 require 'commontator/acts_as_commontator'
-require 'commontator/acts_as_commontable'
+require 'commontator/acts_as_commontable'
+

data/lib/commontator.rb~

@@ -0,0 +1,142 @@
+require 'commontator/engine'
+require 'commontator/controller_includes'
+
+module Commontator
+  # Attributes
+
+  # Can be set in initializer only
+  ENGINE_ATTRIBUTES = [
+    :current_user_proc,
+    :javascript_proc
+  ]
+
+  # Can be set in initializer or passed as an option to acts_as_commontator
+  COMMONTATOR_ATTRIBUTES = [
+    :user_name_proc,
+    :user_link_proc,
+    :user_avatar_proc,
+    :user_email_proc
+  ]
+  
+  # Can be set in initializer or passed as an option to acts_as_commontable
+  COMMONTABLE_ATTRIBUTES = [
+    :comment_filter,
+    :thread_read_proc,
+    :thread_moderator_proc,
+    :comment_editing,
+    :comment_deletion,
+    :moderator_permissions,
+    :comment_voting,
+    :vote_count_proc,
+    :comment_order,
+    :comments_per_page,
+    :thread_subscription,
+    :email_from_proc,
+    :commontable_name_proc,
+    :commontable_url_proc
+  ]
+  
+  DEPRECATED_ATTRIBUTES = [
+    [:moderators_can_edit_comments, :moderator_permissions],
+    [:hide_deleted_comments, :comment_filter],
+    [:hide_closed_threads, :thread_read_proc],
+    [:wp_link_renderer_proc],
+    [:voting_text_proc, :vote_count_proc],
+    [:user_name_clickable, :user_link_proc],
+    [:user_admin_proc, :thread_moderator_proc],
+    [:auto_subscribe_on_comment, :thread_subscription],
+    [:can_edit_own_comments, :comment_editing],
+    [:can_edit_old_comments, :comment_editing],
+    [:can_delete_own_comments, :comment_deletion],
+    [:can_delete_old_comments, :comment_deletion],
+    [:can_subscribe_to_thread, :thread_subscription],
+    [:can_vote_on_comments, :comment_voting],
+    [:combine_upvotes_and_downvotes, :vote_count_proc],
+    [:comments_order, :comment_order],
+    [:closed_threads_are_readable, :thread_read_proc],
+    [:deleted_comments_are_visible, :comment_filter],
+    [:can_read_thread_proc, :thread_read_proc],
+    [:can_edit_thread_proc, :thread_moderator_proc],
+    [:admin_can_edit_comments, :moderator_permissions],
+    [:subscription_email_enable_proc, :user_email_proc],
+    [:comment_name, 'config/locales'],
+    [:comment_create_verb_present, 'config/locales'],
+    [:comment_create_verb_past, 'config/locales'],
+    [:comment_edit_verb_present, 'config/locales'],
+    [:comment_edit_verb_past, 'config/locales'],
+    [:timestamp_format, 'config/locales'],
+    [:subscription_email_to_proc, 'config/locales'],
+    [:subscription_email_from_proc, :email_from_proc],
+    [:subscription_email_subject_proc, 'config/locales'],
+    [:comments_ordered_by_votes, :comment_order],
+    [:current_user_method, :current_user_proc],
+    [:user_missing_name, 'config/locales'],
+    [:user_email_method, :user_email_proc],
+    [:user_name_method, :user_name_proc],
+    [:commontable_name, :commontable_name_proc],
+    [:commontable_id_method]
+  ]
+  
+  (ENGINE_ATTRIBUTES + COMMONTATOR_ATTRIBUTES + \
+    COMMONTABLE_ATTRIBUTES).each do |attribute|
+    mattr_accessor attribute
+  end
+
+  DEPRECATED_ATTRIBUTES.each do |deprecated, replacement|
+    define_singleton_method(deprecated) do
+      @deprecated_method_called = true
+      replacement_string = (replacement.nil? ? 'No replacement is available. You can safely remove it from your configuration file.' : "Use `#{replacement.to_s}` instead.")
+      warn "\n[COMMONTATOR] Deprecation: `config.#{deprecated.to_s}` is deprecated and has been disabled. #{replacement_string}\n"
+    end
+
+    define_singleton_method("#{deprecated.to_s}=") do |obj|
+      send(deprecated)
+    end
+  end
+  
+  def self.configure
+    @deprecated_method_called = false
+    yield self
+    warn "\n[COMMONTATOR] We recommend that you backup the config/initializers/commontator.rb file, rename or remove it, run rake commontator:install:initializers to copy the new default one, then configure it to your liking.\n" if @deprecated_method_called
+  end
+
+  def self.commontator_config(user)
+    (user && user.is_commontator) ? user.commontator_config : self
+  end
+
+  def self.commontable_config(user)
+    (user && user.is_commontable) ? user.commontable_config : self
+  end
+
+  def self.app_routes
+    Commontator::ApplicationController.app_routes
+  end
+
+  def self.commontator_name(user)
+    commontator_config(user).user_name_proc.call(user)
+  end
+
+  def self.commontator_link(user, routing_proxy = app_routes)
+    commontator_config(user).user_link_proc.call(user, routing_proxy)
+  end
+
+  def self.commontator_email(user, mailer = nil)
+    commontator_config(user).user_email_proc.call(user, mailer)
+  end
+
+  def self.commontator_avatar(user, view)
+    commontator_config(user).user_avatar_proc.call(user, view)
+  end
+
+  def self.commontable_name(commontable)
+    commontable_config(commontable).commontable_name_proc.call(commontable)
+  end
+
+  def self.commontable_url(commontable, routing_proxy = app_routes)
+    commontable_config(commontable).commontable_url_proc.call(commontable, app_routes)
+  end
+end
+
+require 'commontator/acts_as_commontator'
+require 'commontator/acts_as_commontable'
+

data/lib/commontator/acts_as_commontable.rb

@@ -19,23 +19,20 @@ module Commontator
           has_many :comments, :class_name => 'Commontator::Comment', :through => :thread
 
           has_many :subscriptions, :class_name => 'Commontator::Subscription', :through => :thread
-          
+
           validates_presence_of :thread
-          
-          alias_method :thread_raw, :thread
-          
+
+          alias_method :relation_thread, :thread
+
           def thread
-            raw = thread_raw
-            return raw unless raw.nil?
-            return Commontator::Thread.find_or_create_by_commontable_type_and_commontable_id(self.class.name, id) \
-              unless id.nil?
-            self.thread = Commontator::Thread.new
-            self.thread.commontable = self
-            self.thread
-          end
+            @thread ||= relation_thread
+            if !@thread
+              @thread = Commontator::Thread.new
+              @thread.commontable = self
+            end
 
-          def commontable_name
-            commontable_config.commontable_name_proc.call(self)
+            @thread.save if !@thread.persisted? && persisted?
+            @thread
           end
         end
       end
@@ -46,3 +43,4 @@ module Commontator
 end
 
 ActiveRecord::Base.send :include, Commontator::ActsAsCommontable
+

data/lib/commontator/acts_as_commontator.rb

@@ -18,22 +18,6 @@ module Commontator
           has_many :comments, :as => :creator, :class_name => 'Commontator::Comment'
 
           has_many :subscriptions, :as => :subscriber, :class_name => 'Commontator::Subscription', :dependent => :destroy
-
-          def commontator_name
-            commontator_config.user_name_proc.call(self)
-          end
-
-          def commontator_email(mailer = nil)
-            commontator_config.user_email_proc.call(self, mailer)
-          end
-          
-          def commontator_link(main_app)
-            commontator_config.user_link_proc.call(self, main_app)
-          end
-          
-          def commontator_avatar(view_context)
-            commontator_config.user_avatar_proc.call(self, view_context)
-          end
         end
       end
       
@@ -45,3 +29,4 @@ module Commontator
 end
 
 ActiveRecord::Base.send :include, Commontator::ActsAsCommontator
+

data/lib/commontator/commontable_config.rb

@@ -11,3 +11,4 @@ module Commontator
     end
   end
 end
+

data/lib/commontator/commontator_config.rb

@@ -11,3 +11,4 @@ module Commontator
     end
   end
 end
+

data/lib/commontator/controller_includes.rb

@@ -12,14 +12,14 @@ module Commontator
     def commontator_thread_show(commontable)
       user = Commontator.current_user_proc.call(self)	
       thread = commontable.thread
-      raise SecurityTransgression unless thread.can_be_read_by?(user)
+      raise Commontator::SecurityTransgression unless thread.can_be_read_by?(user)
       thread.mark_as_read_for(user)
       @commontator_page = params[:page] || 1
-      @commontator_per_page = params[:per_page] ||\
-                              thread.config.comments_per_page
+      @commontator_per_page = params[:per_page] || thread.config.comments_per_page
       @commontator_thread_show = true
     end
   end
 end
 
 ActionController::Base.send :include, Commontator::ControllerIncludes
+

data/lib/commontator/engine.rb

@@ -6,3 +6,4 @@ module Commontator
     config.i18n.load_path += Dir[root.join('config', 'locales', '**', '*.{rb,yml}')]
   end
 end
+

data/lib/commontator/link_renderer.rb

@@ -0,0 +1,29 @@
+require 'will_paginate/view_helpers/action_view'
+
+module Commontator
+  class LinkRenderer < WillPaginate::ActionView::LinkRenderer
+    protected
+
+    def url(page)
+      @base_url_params ||= begin
+        url_params = merge_get_params(default_url_params)
+        merge_optional_params(url_params)
+      end
+
+      url_params = @base_url_params.dup
+      add_current_page_param(url_params, page)
+
+      routes_proxy = @options[:routes_proxy] || @template
+      routes_proxy.url_for(url_params)
+    end
+
+    private
+
+    def link(text, target, attributes = {})
+      attributes = attributes.merge('data-remote' => true) \
+        if @options[:remote]
+      super
+    end
+  end
+end
+

data/lib/commontator/security_transgression.rb

@@ -2,3 +2,4 @@ module Commontator
   class SecurityTransgression < StandardError
   end
 end
+

data/lib/commontator/shared_helper.rb

@@ -9,15 +9,17 @@ module Commontator
     end
 
     def commontator_gravatar_image_tag(user, border = 1, options = {})
+      email = Commontator.commontator_email(user) || ''
+      name = Commontator.commontator_name(user) || ''
+
       base = request.ssl? ? "s://secure" : "://www"
-      hash = Digest::MD5.hexdigest(user.commontator_email)
+      hash = Digest::MD5.hexdigest(email)
       url = "http#{base}.gravatar.com/avatar/#{hash}?#{options.to_query}"
       
-      name = user.commontator_name
-      
       image_tag(url, { :alt => name,
-                :title => name,
-                :border => border })
+                       :title => name,
+                       :border => border })
     end
   end
 end
+

data/lib/commontator/version.rb

@@ -1,3 +1,4 @@
 module Commontator
-  VERSION = "4.5.4"
+  VERSION = "4.6.0"
 end
+

data/lib/tasks/commontator_tasks.rake

@@ -42,3 +42,4 @@ namespace :commontator do
     end
   end
 end
+

data/spec/app/controllers/commontator/comments_controller_spec.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require 'spec_helper'
 require 'acts_as_votable'
 
 module Commontator
@@ -531,17 +531,17 @@ module Commontator
     end
 
     it "won't send mail if recipients empty" do
-      if defined?(CommentsController::SubscriptionsMailer)
-        CommentsController::SubscriptionsMailer.__send__(:initialize)
+      if defined?(Subscription::SubscriptionsMailer)
+        Subscription::SubscriptionsMailer.__send__(:initialize)
       else
-        CommentsController::SubscriptionsMailer = MiniTest::Mock.new
+        Subscription::SubscriptionsMailer = MiniTest::Mock.new
       end
 
       user2 = DummyUser.create
       user2.can_read = true
 
       email = MiniTest::Mock.new.expect(:deliver, nil)
-      CommentsController::SubscriptionsMailer.expect(:comment_created, email, [Comment, [user2]])
+      Subscription::SubscriptionsMailer.expect(:comment_created, email, [Comment, [user2]])
 
       @user.can_read = true
       sign_in @user
@@ -550,15 +550,15 @@ module Commontator
       post :create, :thread_id => @thread.id, :comment => attributes, :use_route => :commontator
       assigns(:comment).errors.must_be_empty
 
-      proc { CommentsController::SubscriptionsMailer.verify }.must_raise(MockExpectationError)
+      proc { Subscription::SubscriptionsMailer.verify }.must_raise(MockExpectationError)
       proc { email.verify }.must_raise(MockExpectationError)
     end
     
     it 'must send mail if recipients not empty' do
-      if defined?(CommentsController::SubscriptionsMailer)
-        CommentsController::SubscriptionsMailer.__send__(:initialize)
+      if defined?(Subscription::SubscriptionsMailer)
+        Subscription::SubscriptionsMailer.__send__(:initialize)
       else
-        CommentsController::SubscriptionsMailer = MiniTest::Mock.new
+        Subscription::SubscriptionsMailer = MiniTest::Mock.new
       end
 
       user2 = DummyUser.create
@@ -566,7 +566,7 @@ module Commontator
       @thread.subscribe(user2)
 
       email = MiniTest::Mock.new.expect(:deliver, nil)
-      CommentsController::SubscriptionsMailer.expect(:comment_created, email, [Comment, [user2]])
+      Subscription::SubscriptionsMailer.expect(:comment_created, email, [Comment, [user2]])
 
       @user.can_read = true
       sign_in @user
@@ -575,8 +575,9 @@ module Commontator
       post :create, :thread_id => @thread.id, :comment => attributes, :use_route => :commontator
       assigns(:comment).errors.must_be_empty
 
-      CommentsController::SubscriptionsMailer.verify
+      Subscription::SubscriptionsMailer.verify
       email.verify
     end
   end
 end
+