commontator 0.1.46 → 0.2.0

data/lib/commontator/commontator_config.rb

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

data/lib/commontator/commontator_config.rb~

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

data/lib/commontator/version.rb

@@ -1,3 +1,3 @@
 module Commontator
-  VERSION = "0.1.46"
+  VERSION = "0.2.0"
 end

data/lib/commontator/version.rb~

@@ -1,3 +1,3 @@
 module Commontator
-  VERSION = "0.1.45"
+  VERSION = "0.1.46"
 end

data/lib/tasks/commontator_tasks.rake

@@ -0,0 +1,38 @@
+COPY_TASKS = ['assets/images', 'assets/stylesheets', 'views', 'mailers', 'helpers', 'controllers', 'models']
+
+namespace :commontator do
+  namespace :install do
+    desc "Copy initializers from commontator to application"
+    task :initializers do
+      Dir.glob(File.expand_path('../../../config/initializers/*.rb', __FILE__)) do |file|
+        next if File.exists?(File.expand_path(File.basename(file), 'config/initializers'))
+        cp file, 'config/initializers', :verbose => false
+        print "Copied initializer #{File.basename(file)} from commontator\n"
+      end
+    end
+  end
+  
+  namespace :copy do
+    COPY_TASKS.each do |path|
+      name = File.basename(path)
+      desc "Copy #{name} from commontator to application"
+      task name.to_sym do
+        cp_r File.expand_path("../../../app/#{path}/commontator", __FILE__), "app/#{path}", :verbose => false
+        print "Copied #{name} from commontator\n"
+      end
+    end
+  end
+  
+  desc "Copy initializers and migrations from commontator to application"
+  task :install do
+    Rake::Task["commontator:install:initializers"].invoke
+    Rake::Task["commontator:install:migrations"].invoke
+  end
+  
+  desc "Copy assets, views, mailers, helpers, controllers and models from commontator to application"
+  task :copy do
+    COPY_TASKS.each do |path|
+      Rake::Task["commontator:copy:#{File.basename(path)}"].invoke
+    end
+  end
+end

data/lib/tasks/commontator_tasks.rake~

@@ -0,0 +1,39 @@
+COPY_TASKS = ['assets/images', 'assets/stylesheets', 'views', 'mailers', 'helpers', 'controllers', 'models']
+
+namespace :commontator do
+  namespace :install do
+    desc "Copy initializers from commontator to application"
+    task :initializers do
+      Dir.glob(File.expand_path('../../../config/initializers/*.rb', __FILE__)) do |file|
+        next if File.exists?(File.expand_path(File.basename(file), 'config/initializers'))
+        cp file, 'config/initializers', :verbose => false
+        print "Copied initializer #{File.basename(file)} from commontator\n"
+      end
+    end
+  end
+  
+  namespace :copy do
+    COPY_TASKS.each do |path|
+      name = File.basename(path)
+      desc "Copy #{name} from commontator to application"
+      task name.to_sym do
+        cp_r File.expand_path("../../../app/#{path}/commontator", __FILE__), "app/#{path}", :verbose => false
+        print "Copied #{name} from commontator\n"
+      end
+    end
+  end
+  
+  desc "Copy initializers and migrations from commontator to application"
+  task :install do
+    Rake::Task["commontator:install:initializers"].invoke
+    Rake::Task["commontator:install:migrations"].invoke
+  end
+  
+  desc "Copy assets, views, mailers, helpers, controllers and models from commontator to application"
+  task :copy do
+    COPY_TASKS.each do |path|
+      name = path
+      Rake::Task["commontator:copy:#{File.basename(path)}"].invoke
+    end
+  end
+end

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

@@ -0,0 +1,164 @@
+# 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 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
+
+
+  # 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 subscription email subject
+  # Default: Proc.new {}
+  config.subscription_email_subject_proc = Proc.new {|params| \
+    "#{params[:commontator_name]} #{params[:config].comment_create_verb_past} a " + \
+    "#{params[:config].comment_name} on #{params[:commontable_name]} ##{params[:commontable_id]}"}
+
+  # 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 an admin for that particular commontable's thread
+  # Default: '' (no thread-specific admins)
+  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/db/migrate/1_install.commontator.rb

@@ -0,0 +1,49 @@
+# This migration comes from commontator (originally 0)
+class InstallCommontator < ActiveRecord::Migration
+  def change
+    create_table "commontator_comments" do |t|
+      t.text     "body"
+      t.integer  "commontator_id"
+      t.string   "commontator_type"
+      t.datetime "deleted_at"
+      t.integer  "deleter_id"
+      t.string   "deleter_type"
+      t.integer  "thread_id"
+      
+      t.integer  "cached_votes_total", :default => 0
+      t.integer  "cached_votes_up", :default => 0
+      t.integer  "cached_votes_down", :default => 0
+
+      t.timestamps
+    end
+    
+    create_table "commontator_subscriptions" do |t|
+      t.integer  "subscriber_id"
+      t.string   "subscriber_type"
+      t.integer  "thread_id"
+      t.boolean  "is_unread"
+
+      t.timestamps
+    end
+
+    create_table "commontator_threads" do |t|
+      t.integer  "commontable_id"
+      t.string   "commontable_type"
+      t.datetime "closed_at"
+      t.integer  "closer_id"
+      t.string   "closer_type"
+
+      t.timestamps
+    end
+    
+    add_index :commontator_comments, [:commontator_id, :commontator_type, :thread_id], :name => "index_c_c_on_c_id_and_c_type_and_t_id"
+    add_index :commontator_comments, :thread_id
+    add_index :commontator_subscriptions, [:subscriber_id, :subscriber_type, :thread_id], :unique => true, :name => "index_c_s_on_s_id_and_s_type_and_t_id"
+    add_index :commontator_subscriptions, :thread_id
+    add_index :commontator_threads, [:commontable_id, :commontable_type]
+    
+    add_index :commontator_comments, :cached_votes_total
+    add_index :commontator_comments, :cached_votes_up
+    add_index :commontator_comments, :cached_votes_down
+  end
+end

data/test/dummy/db/schema.rb

@@ -11,6 +11,51 @@
 #
 # It's strongly recommended to check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 0) do
+ActiveRecord::Schema.define(:version => 20120710213148) do
+
+  create_table "commontator_comments", :force => true do |t|
+    t.text     "body"
+    t.integer  "commontator_id"
+    t.string   "commontator_type"
+    t.datetime "deleted_at"
+    t.integer  "deleter_id"
+    t.string   "deleter_type"
+    t.integer  "thread_id"
+    t.integer  "cached_votes_total", :default => 0
+    t.integer  "cached_votes_up",    :default => 0
+    t.integer  "cached_votes_down",  :default => 0
+    t.datetime "created_at",                        :null => false
+    t.datetime "updated_at",                        :null => false
+  end
+
+  add_index "commontator_comments", ["cached_votes_down"], :name => "index_commontator_comments_on_cached_votes_down"
+  add_index "commontator_comments", ["cached_votes_total"], :name => "index_commontator_comments_on_cached_votes_total"
+  add_index "commontator_comments", ["cached_votes_up"], :name => "index_commontator_comments_on_cached_votes_up"
+  add_index "commontator_comments", ["commontator_id", "commontator_type", "thread_id"], :name => "index_c_c_on_c_id_and_c_type_and_t_id"
+  add_index "commontator_comments", ["thread_id"], :name => "index_commontator_comments_on_thread_id"
+
+  create_table "commontator_subscriptions", :force => true do |t|
+    t.integer  "subscriber_id"
+    t.string   "subscriber_type"
+    t.integer  "thread_id"
+    t.boolean  "is_unread"
+    t.datetime "created_at",      :null => false
+    t.datetime "updated_at",      :null => false
+  end
+
+  add_index "commontator_subscriptions", ["subscriber_id", "subscriber_type", "thread_id"], :name => "index_c_s_on_s_id_and_s_type_and_t_id", :unique => true
+  add_index "commontator_subscriptions", ["thread_id"], :name => "index_commontator_subscriptions_on_thread_id"
+
+  create_table "commontator_threads", :force => true do |t|
+    t.integer  "commontable_id"
+    t.string   "commontable_type"
+    t.datetime "closed_at"
+    t.integer  "closer_id"
+    t.string   "closer_type"
+    t.datetime "created_at",       :null => false
+    t.datetime "updated_at",       :null => false
+  end
+
+  add_index "commontator_threads", ["commontable_id", "commontable_type"], :name => "index_commontator_threads_on_commontable_id_and_commontable_type"
 
 end

data/test/dummy/log/development.log

@@ -202,3 +202,75 @@ 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
+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
+Connecting to database specified by database.yml
+Connecting to database specified by database.yml
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+Migrating to InstallCommontator (20120710213148)
+   (0.0ms)  select sqlite_version(*)
+   (0.0ms)  begin transaction
+   (0.6ms)  CREATE TABLE "commontator_comments" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "body" text, "commontator_id" integer, "commontator_type" varchar(255), "deleted_at" datetime, "deleter_id" integer, "deleter_type" varchar(255), "thread_id" integer, "cached_votes_total" integer DEFAULT 0, "cached_votes_up" integer DEFAULT 0, "cached_votes_down" integer DEFAULT 0, "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL) 
+   (0.2ms)  CREATE TABLE "commontator_subscriptions" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "subscriber_id" integer, "subscriber_type" varchar(255), "thread_id" integer, "is_unread" boolean, "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL) 
+   (0.3ms)  CREATE TABLE "commontator_threads" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "commontable_id" integer, "commontable_type" varchar(255), "closed_at" datetime, "closer_id" integer, "closer_type" varchar(255), "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL) 
+   (0.0ms)  PRAGMA index_list("commontator_comments")
+   (0.2ms)  CREATE INDEX "index_c_c_on_c_id_and_c_type_and_t_id" ON "commontator_comments" ("commontator_id", "commontator_type", "thread_id")
+   (0.0ms)  PRAGMA index_list("commontator_comments")
+   (0.0ms)  PRAGMA index_info('index_c_c_on_c_id_and_c_type_and_t_id')
+   (0.1ms)  CREATE INDEX "index_commontator_comments_on_thread_id" ON "commontator_comments" ("thread_id")
+   (0.0ms)  PRAGMA index_list("commontator_subscriptions")
+   (0.3ms)  CREATE UNIQUE INDEX "index_c_s_on_s_id_and_s_type_and_t_id" ON "commontator_subscriptions" ("subscriber_id", "subscriber_type", "thread_id")
+   (0.0ms)  PRAGMA index_list("commontator_subscriptions")
+   (0.0ms)  PRAGMA index_info('index_c_s_on_s_id_and_s_type_and_t_id')
+   (0.1ms)  CREATE INDEX "index_commontator_subscriptions_on_thread_id" ON "commontator_subscriptions" ("thread_id")
+   (0.0ms)  PRAGMA index_list("commontator_threads")
+   (0.2ms)  CREATE INDEX "index_commontator_threads_on_commontable_id_and_commontable_type" ON "commontator_threads" ("commontable_id", "commontable_type")
+   (0.0ms)  PRAGMA index_list("commontator_comments")
+   (0.0ms)  PRAGMA index_info('index_commontator_comments_on_thread_id')
+   (0.0ms)  PRAGMA index_info('index_c_c_on_c_id_and_c_type_and_t_id')
+   (0.1ms)  CREATE INDEX "index_commontator_comments_on_cached_votes_total" ON "commontator_comments" ("cached_votes_total")
+   (0.0ms)  PRAGMA index_list("commontator_comments")
+   (0.0ms)  PRAGMA index_info('index_commontator_comments_on_cached_votes_total')
+   (0.0ms)  PRAGMA index_info('index_commontator_comments_on_thread_id')
+   (0.0ms)  PRAGMA index_info('index_c_c_on_c_id_and_c_type_and_t_id')
+   (0.1ms)  CREATE INDEX "index_commontator_comments_on_cached_votes_up" ON "commontator_comments" ("cached_votes_up")
+   (0.1ms)  PRAGMA index_list("commontator_comments")
+   (0.0ms)  PRAGMA index_info('index_commontator_comments_on_cached_votes_up')
+   (0.0ms)  PRAGMA index_info('index_commontator_comments_on_cached_votes_total')
+   (0.0ms)  PRAGMA index_info('index_commontator_comments_on_thread_id')
+   (0.0ms)  PRAGMA index_info('index_c_c_on_c_id_and_c_type_and_t_id')
+   (0.1ms)  CREATE INDEX "index_commontator_comments_on_cached_votes_down" ON "commontator_comments" ("cached_votes_down")
+   (0.1ms)  INSERT INTO "schema_migrations" ("version") VALUES ('20120710213148')
+   (339.0ms)  commit transaction
+   (0.4ms)  select sqlite_version(*)
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.1ms)  PRAGMA index_list("commontator_comments")
+   (0.0ms)  PRAGMA index_info('index_commontator_comments_on_cached_votes_down')
+   (0.0ms)  PRAGMA index_info('index_commontator_comments_on_cached_votes_up')
+   (0.0ms)  PRAGMA index_info('index_commontator_comments_on_cached_votes_total')
+   (0.0ms)  PRAGMA index_info('index_commontator_comments_on_thread_id')
+   (0.0ms)  PRAGMA index_info('index_c_c_on_c_id_and_c_type_and_t_id')
+   (0.0ms)  PRAGMA index_list("commontator_subscriptions")
+   (0.0ms)  PRAGMA index_info('index_commontator_subscriptions_on_thread_id')
+   (0.0ms)  PRAGMA index_info('index_c_s_on_s_id_and_s_type_and_t_id')
+   (0.0ms)  PRAGMA index_list("commontator_threads")
+   (0.0ms)  PRAGMA index_info('index_commontator_threads_on_commontable_id_and_commontable_type')
+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
+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