commontator 5.1.0 → 6.0.0.pre.1

data/db/migrate/0_install_commontator.rb

@@ -1,52 +1,47 @@
-class InstallCommontator < ActiveRecord::Migration[5.0]
+class InstallCommontator < ActiveRecord::Migration[5.2]
   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
+    create_table :commontator_threads do |t|
+      t.references :commontable,
+                   polymorphic: true,
+                   index: { unique: true, name: 'index_commontator_threads_on_c_id_and_c_type' }
+      t.references :closer, polymorphic: true
 
-      t.integer :cached_votes_up, default: 0
-      t.integer :cached_votes_down, default: 0
+      t.datetime :closed_at
 
       t.timestamps null: false
     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, :created_at]
+    create_table :commontator_comments do |t|
+      t.references :thread, null: false, index: false, foreign_key: {
+        to_table: :commontator_threads, on_update: :cascade, on_delete: :cascade
+      }
+      t.references :creator, polymorphic: true, null: false, index: false
+      t.references :editor, polymorphic: true
 
-    add_index  :commontator_comments, :cached_votes_up
-    add_index  :commontator_comments, :cached_votes_down
+      t.text     :body, null: false
+      t.datetime :deleted_at
 
-    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 :cached_votes_up, default: 0, index: true
+      t.integer :cached_votes_down, default: 0, index: true
 
       t.timestamps null: false
     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
+    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, :created_at ]
 
-    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
+    create_table :commontator_subscriptions do |t|
+      t.references :thread, null: false, foreign_key: {
+        to_table: :commontator_threads, on_update: :cascade, on_delete: :cascade
+      }
+      t.references :subscriber, polymorphic: true, null: false, index: false
 
       t.timestamps null: false
     end
 
-    add_index :commontator_threads, [:commontable_id, :commontable_type],
+    add_index :commontator_subscriptions, [ :subscriber_id, :subscriber_type, :thread_id ],
               unique: true,
-              name: 'index_commontator_threads_on_c_id_and_c_type'
+              name: 'index_commontator_subscriptions_on_s_id_and_s_type_and_t_id'
   end
 end

data/db/migrate/1_add_replying_to_comments.rb

@@ -0,0 +1,9 @@
+class AddReplyingToComments < ActiveRecord::Migration[5.2]
+  def change
+    add_reference :commontator_comments, :parent, foreign_key: {
+      to_table: :commontator_comments, on_update: :restrict, on_delete: :cascade
+    }
+    add_column :commontator_comments, :ancestor_ids, :text
+    add_column :commontator_comments, :descendant_ids, :text
+  end
+end

data/lib/commontator.rb

@@ -1,145 +1,14 @@
-require 'commontator/engine'
-require 'commontator/controllers'
+require 'commontator/version'
 
 module Commontator
-  # Attributes
+  # These requires need the Commontator module to function properly
+  require 'commontator/engine'
+  require 'commontator/config'
+  require 'commontator/controllers'
+  require 'commontator/acts_as_commontator'
+  require 'commontator/acts_as_commontable'
 
-  # Can be set in initializer only
-  ENGINE_ATTRIBUTES = [
-    :current_user_proc,
-    :javascript_proc,
-    :mentions_enabled
-  ]
+  VERSION = COMMONTATOR_VERSION
 
-  # 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_mentions_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,
-    :new_comment_style,
-    :comments_per_page,
-    :thread_subscription,
-    :email_from_proc,
-    :commontable_name_proc,
-    :comment_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],
-    [:commontable_url_proc, :comment_url_proc]
-  ]
-  
-  (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(obj)
-    (obj && obj.is_commontable) ? obj.commontable_config : self
-  end
-
-  def self.commontator_name(user)
-    commontator_config(user).user_name_proc.call(user)
-  end
-
-  def self.commontator_link(user, routing_proxy)
-    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.commontator_mentions(user, thread, search_phrase)
-    commontator_config(user).user_mentions_proc.call(user, thread, search_phrase)
-  end
-
-  def self.commontable_name(commontable)
-    commontable_config(commontable).commontable_name_proc.call(commontable)
-  end
-
-  def self.comment_url(comment, routing_proxy)
-    commontable_config(comment.thread.commontable).comment_url_proc.call(comment, routing_proxy)
-  end
+  include Commontator::Config
 end
-
-require 'commontator/acts_as_commontator'
-require 'commontator/acts_as_commontable'

data/lib/commontator/acts_as_commontable.rb

@@ -1,44 +1,35 @@
-require 'commontator/commontable_config'
-
-module Commontator
-  module ActsAsCommontable
-    def self.included(base)
-      base.class_attribute :is_commontable
-      base.is_commontable = false
-      base.extend(ClassMethods)
-    end
+require_relative 'commontable_config'
+require_relative 'build_thread'
+
+module Commontator::ActsAsCommontable
+  def self.included(base)
+    base.class_attribute :is_commontable
+    base.is_commontable = false
+    base.extend(ClassMethods)
+  end
 
-    module ClassMethods
-      def acts_as_commontable(options = {})
-        class_eval do
-          cattr_accessor :commontable_config
-          association_options = options.extract!(:dependent)
-          self.commontable_config = Commontator::CommontableConfig.new(options)
-          self.is_commontable = true
+  module ClassMethods
+    def acts_as_commontable(options = {})
+      class_exec do
+        association_options = options.extract!(:dependent)
+        association_options[:dependent] ||= :nullify
 
-          has_one :thread, as: :commontable,
-                           class_name: 'Commontator::Thread',
-                           dependent: association_options[:dependent]
+        cattr_accessor :commontable_config
+        self.commontable_config = Commontator::CommontableConfig.new(options)
 
-          validates_presence_of :thread
+        has_one :commontator_thread, association_options.merge(
+          as: :commontable, class_name: 'Commontator::Thread'
+        )
 
-          prepend ThreadWithCommontator
-        end
-      end
+        validates :commontator_thread, presence: true
 
-      module ThreadWithCommontator
-        def thread
-          @thread ||= super
-          return @thread unless @thread.nil?
+        prepend Commontator::BuildThread
 
-          @thread = build_thread
-          @thread.save if persisted?
-          @thread
-        end
+        self.is_commontable = true
       end
-
-      alias_method :acts_as_commentable, :acts_as_commontable
     end
+
+    alias_method :acts_as_commentable, :acts_as_commontable
   end
 end
 

data/lib/commontator/acts_as_commontator.rb

@@ -1,32 +1,35 @@
-require 'commontator/commontator_config'
+require_relative 'commontator_config'
 
-module Commontator
-  module ActsAsCommontator
-    def self.included(base)
-      base.class_attribute :is_commontator
-      base.is_commontator = false
-      base.extend(ClassMethods)
-    end
-    
-    module ClassMethods
-      def acts_as_commontator(options = {})
-        class_eval do
-          cattr_accessor :commontator_config
-          self.commontator_config = Commontator::CommontatorConfig.new(options)
-          self.is_commontator = true
+module Commontator::ActsAsCommontator
+  def self.included(base)
+    base.class_attribute :is_commontator
+    base.is_commontator = false
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def acts_as_commontator(options = {})
+      class_exec do
+        association_options = options.extract!(:dependent)
+        association_options[:dependent] ||= :destroy
 
-          has_many :comments,      as: :creator,
-                                   class_name: 'Commontator::Comment'
-          has_many :subscriptions, as: :subscriber,
-                                   class_name: 'Commontator::Subscription',
-                                   dependent: :destroy
-        end
+        cattr_accessor :commontator_config
+        self.commontator_config = Commontator::CommontatorConfig.new(options)
+
+        has_many :commontator_comments, association_options.merge(
+          as: :creator, class_name: 'Commontator::Comment'
+        )
+        has_many :commontator_subscriptions, association_options.merge(
+          as: :subscriber, class_name: 'Commontator::Subscription'
+        )
+
+        self.is_commontator = true
       end
-      
-      alias_method :acts_as_commonter, :acts_as_commontator
-      alias_method :acts_as_commentator, :acts_as_commontator
-      alias_method :acts_as_commenter, :acts_as_commontator
     end
+
+    alias_method :acts_as_commonter, :acts_as_commontator
+    alias_method :acts_as_commentator, :acts_as_commontator
+    alias_method :acts_as_commenter, :acts_as_commontator
   end
 end
 

data/lib/commontator/build_thread.rb

@@ -0,0 +1,10 @@
+module Commontator::BuildThread
+  def commontator_thread
+    @commontator_thread ||= super
+    return @commontator_thread unless @commontator_thread.nil?
+
+    @commontator_thread = build_commontator_thread.tap do |thread|
+      thread.save if persisted?
+    end
+  end
+end

data/lib/commontator/commontable_config.rb

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

data/lib/commontator/commontator_config.rb

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

data/lib/{commontator.rb~ → commontator/config.rb}

@@ -1,14 +1,10 @@
-require 'commontator/engine'
-require 'commontator/controller_includes'
-
-module Commontator
+module Commontator::Config
   # Attributes
 
   # Can be set in initializer only
   ENGINE_ATTRIBUTES = [
     :current_user_proc,
-    :javascript_proc,
-    :mentions_enabled
+    :javascript_proc
   ]
 
   # Can be set in initializer or passed as an option to acts_as_commontator
@@ -19,7 +15,7 @@ module Commontator
     :user_email_proc,
     :user_mentions_proc
   ]
-  
+
   # Can be set in initializer or passed as an option to acts_as_commontable
   COMMONTABLE_ATTRIBUTES = [
     :comment_filter,
@@ -36,9 +32,11 @@ module Commontator
     :thread_subscription,
     :email_from_proc,
     :commontable_name_proc,
-    :comment_url_proc
+    :comment_url_proc,
+    :comment_reply_style,
+    :mentions_enabled
   ]
-  
+
   DEPRECATED_ATTRIBUTES = [
     [:moderators_can_edit_comments, :moderator_permissions],
     [:hide_deleted_comments, :comment_filter],
@@ -76,70 +74,72 @@ module Commontator
     [: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],
     [:commontable_url_proc, :comment_url_proc]
   ]
-  
-  (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"
+  def self.included(base)
+    (ENGINE_ATTRIBUTES + COMMONTATOR_ATTRIBUTES + COMMONTABLE_ATTRIBUTES).each do |attribute|
+      base.mattr_accessor attribute
     end
 
-    define_singleton_method("#{deprecated.to_s}=") do |obj|
-      send(deprecated)
+    base.mattr_accessor :show_deprecation_warning
+    DEPRECATED_ATTRIBUTES.each do |deprecated, replacement|
+      base.define_singleton_method(deprecated) do
+        base.show_deprecation_warning = 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
+
+      base.define_singleton_method("#{deprecated.to_s}=") { |obj| base.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
+    base.extend ClassMethods
   end
 
-  def self.commontable_config(obj)
-    (obj && obj.is_commontable) ? obj.commontable_config : self
-  end
+  module ClassMethods
+    def configure
+      self.show_deprecation_warning = false
 
-  def self.commontator_name(user)
-    commontator_config(user).user_name_proc.call(user)
-  end
+      yield self
 
-  def self.commontator_link(user, routing_proxy)
-    commontator_config(user).user_link_proc.call(user, routing_proxy)
-  end
+      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 show_deprecation_warning
+    end
 
-  def self.commontator_email(user, mailer = nil)
-    commontator_config(user).user_email_proc.call(user, mailer)
-  end
+    def commontator_config(user)
+      (user && user.is_commontator) ? user.commontator_config : self
+    end
 
-  def self.commontator_avatar(user, view)
-    commontator_config(user).user_avatar_proc.call(user, view)
-  end
+    def commontable_config(obj)
+      (obj && obj.is_commontable) ? obj.commontable_config : self
+    end
 
-  def self.commontator_mentions(user, search_phrase)
-    commontator_config(user).user_mentions_proc.call(user, search_phrase)
-  end
+    def commontator_name(user)
+      commontator_config(user).user_name_proc.call(user)
+    end
 
-  def self.commontable_name(commontable)
-    commontable_config(commontable).commontable_name_proc.call(commontable)
-  end
+    def commontator_link(user, routing_proxy)
+      commontator_config(user).user_link_proc.call(user, routing_proxy)
+    end
+
+    def commontator_email(user, mailer = nil)
+      commontator_config(user).user_email_proc.call(user, mailer)
+    end
 
-  def self.comment_url(comment, routing_proxy)
-    commontable_config(comment.thread.commontable).comment_url_proc.call(comment, routing_proxy)
+    def commontator_avatar(user, view)
+      commontator_config(user).user_avatar_proc.call(user, view)
+    end
+
+    def commontator_mentions(user, thread, search_phrase)
+      commontator_config(user).user_mentions_proc.call(user, thread, search_phrase)
+    end
+
+    def commontable_name(commontable)
+      commontable_config(commontable).commontable_name_proc.call(commontable)
+    end
+
+    def comment_url(comment, routing_proxy)
+      commontable_config(comment.thread.commontable).comment_url_proc.call(comment, routing_proxy)
+    end
   end
 end
-
-require 'commontator/acts_as_commontator'
-require 'commontator/acts_as_commontable'