commontator 2.0.2 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e80641594c9354508803c783181a053cadf8d5b
-  data.tar.gz: 656bda25be213ff0f5186c363d02ac8f63667e07
+  metadata.gz: 407651f272db411b6547f9e0a48b8dff5b1bfe23
+  data.tar.gz: 69bee372a89c33f4bb4c2e696391f4f73376eea1
 SHA512:
-  metadata.gz: afe7369d598e62151110282f724582724e261e44814bf57582ad86221c0a8b3d25b8f530a95023526f8529fc4fb284debafd38c24dcf8e8db7d09b5a33af88cb
-  data.tar.gz: 295d8301ae86ad273f2604dafcf257f88b44593dc74e105dcb32461c14ee856aa56faf4a5cf99c28743c64ac80fcb919592556e835422f25fc8c0fa0a2f8c581
+  metadata.gz: 6a09b58656b2ea37d063e42b88d70289d929a5e07b3b6afec7312f10e6082d006907791b479ff991505ff81a6f3914e81b4380c2def1c0ef92686a8f4dbf3c1e
+  data.tar.gz: 9f13d4b9d2eec2fcbed8d96136d28682ae85b5c8fc43bd964bcb7b6dc8c6131eb6c9a04b2cd222ac56f8c3eb4acb11c893f922cf1bcb99edec83ca0a68876745

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2012 Rice University
+Copyright 2012-13 Rice University
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -10,12 +10,14 @@ There are 4 steps you must follow to install commontator:
 
 1. Gem
 
-  Add this line to your application's Gemfile:
+  Add this line to your application's Gemfile (for Rails 4+):
 
   ```ruby
-  gem 'commontator', '~> 2.0.2'
+  gem 'commontator', '~> 4.0.0'
   ```
 
+  If you are still using rails 3, use Commontator version 2.0.1 instead.
+
   And then execute:
 
   ```sh
@@ -113,6 +115,22 @@ Follow the steps below to add commontator to your models and views:
 
 That's it! Commontator is now ready for use.
 
+## Voting
+
+You can allow users to vote on each others' comments by adding the acts_as_votable gem to your gemfile:
+
+```ruby
+gem 'acts_as_votable'
+```
+
+And enabling the relevant option in commontator's initializer:
+
+```ruby
+config.can_vote_on_comments = true
+```
+
+Note that acts_as_votable is currently incompatible with the protected_attributes gem if config.active_record.whitelist_attributes is set to true.
+
 ## Browser Support
 
 No incompatibilities are currently known with any of the major browsers.

data/app/controllers/commontator/comments_controller.rb

@@ -1,10 +1,10 @@
 module Commontator
-  class CommentsController < ApplicationController
+  class CommentsController < Commontator::ApplicationController
     before_filter :get_thread, :only => [:new, :create]
     before_filter :get_comment_and_thread, :except => [:new, :create]
     before_filter :set_commontable_url, :only => :create
 
-    # GET /1/comments/new
+    # GET /threads/1/comments/new
     def new
       @comment = Comment.new
       @comment.thread = @thread
@@ -19,9 +19,10 @@ module Commontator
      
     end
 
-    # POST /1/comments
+    # POST /threads/1/comments
     def create
-      @comment = Comment.new(params[:comment])
+      @comment = Comment.new
+      @comment.body = params[:comment].nil? ? nil : params[:comment][:body]
       @comment.thread = @thread
       @comment.creator = @user
       
@@ -29,6 +30,12 @@ module Commontator
       
       respond_to do |format|
         if @comment.save
+          @thread.subscribe(@user) if @thread.config.auto_subscribe_on_comment
+          @thread.add_unread_except_for(@user)
+          recipients = @thread.active_subscribers.reject{|s| s == @user}
+          SubscriptionsMailer.comment_created(@comment, recipients).deliver \
+            unless recipients.empty?
+
           format.html { redirect_to @thread }
           format.js
         else
@@ -48,13 +55,14 @@ module Commontator
       end
     end
 
-    # PUT /comments/1
+    # PATCH /comments/1
     def update
       raise SecurityTransgression unless @comment.can_be_edited_by?(@user)
+      @comment.body = params[:comment].nil? ? nil : params[:comment][:body]
       @comment.editor = @user
 
       respond_to do |format|
-        if @comment.update_attributes(params[:comment])
+        if @comment.save
           format.html { redirect_to @thread }
           format.js
         else
@@ -64,7 +72,7 @@ module Commontator
       end
     end
 
-    # PUT /comments/1/delete
+    # PATCH /comments/1/delete
     def delete
       raise SecurityTransgression unless @comment.can_be_deleted_by?(@user)
 
@@ -77,7 +85,7 @@ module Commontator
       end
     end
     
-    # PUT /comments/1/undelete
+    # PATCH /comments/1/undelete
     def undelete
       raise SecurityTransgression unless @comment.can_be_deleted_by?(@user)
 
@@ -90,7 +98,7 @@ module Commontator
       end
     end
     
-    # PUT /comments/1/upvote
+    # PATCH /comments/1/upvote
     def upvote
       raise SecurityTransgression unless @comment.can_be_voted_on_by?(@user)
       
@@ -102,7 +110,7 @@ module Commontator
       end
     end
     
-    # PUT /comments/1/downvote
+    # PATCH /comments/1/downvote
     def downvote
       raise SecurityTransgression unless @comment.can_be_voted_on_by?(@user)
       
@@ -114,7 +122,7 @@ module Commontator
       end
     end
     
-    # PUT /comments/1/unvote
+    # PATCH /comments/1/unvote
     def unvote
       raise SecurityTransgression unless @comment.can_be_voted_on_by?(@user)
       

data/app/controllers/commontator/subscriptions_controller.rb

@@ -1,9 +1,9 @@
 module Commontator
-  class SubscriptionsController < ApplicationController
+  class SubscriptionsController < Commontator::ApplicationController
     before_filter :get_thread
 
-    # POST /1/subscribe
-    def create
+    # PATCH /threads/1/subscribe
+    def subscribe
       raise SecurityTransgression unless @thread.can_subscribe?(@user)
 
       @thread.errors.add(:subscription, "You are already subscribed to this thread") \
@@ -16,8 +16,8 @@ module Commontator
 
     end
 
-    # POST /1/unsubscribe
-    def destroy
+    # PATCH /threads/1/unsubscribe
+    def unsubscribe
       raise SecurityTransgression unless @thread.can_subscribe?(@user)
 
       @thread.errors.add(:subscription, "You are not subscribed to this thread") \

data/app/controllers/commontator/threads_controller.rb

@@ -1,5 +1,5 @@
 module Commontator
-  class ThreadsController < ApplicationController
+  class ThreadsController < Commontator::ApplicationController
     before_filter :get_thread
     before_filter :set_commontable_url, :only => :show
 
@@ -13,7 +13,7 @@ module Commontator
       end
     end
     
-    # PUT /threads/1/close
+    # PATCH /threads/1/close
     def close
       raise SecurityTransgression unless @thread.can_be_edited_by?(@user)
 
@@ -26,7 +26,7 @@ module Commontator
       end
     end
     
-    # PUT /threads/1/reopen
+    # PATCH /threads/1/reopen
     def reopen
       raise SecurityTransgression unless @thread.can_be_edited_by?(@user)
 

data/app/mailers/commontator/subscriptions_mailer.rb

@@ -6,12 +6,13 @@ module Commontator
     def comment_created(comment, recipients)
       setup_variables(comment, recipients)
 
-      mail :bcc => @bcc,
+      mail :to => 'Undisclosed Recipients',
+           :bcc => @bcc,
            :from => @from,
            :subject => @subject
     end
 
-protected
+    protected
 
     def setup_variables(comment, recipients)
       @comment = comment

data/app/models/commontator/comment.rb

@@ -2,16 +2,12 @@ module Commontator
   class Comment < ActiveRecord::Base
     belongs_to :creator, :polymorphic => true
     belongs_to :editor, :polymorphic => true
-
     belongs_to :thread
 
     has_one :commontable, :through => :thread
 
-    attr_accessible :body
-
     validates_presence_of :creator, :on => :create
     validates_presence_of :editor, :on => :update
-
     validates_presence_of :thread
     validates_presence_of :body
 
@@ -103,6 +99,4 @@ module Commontator
       can_be_voted_on? && thread.can_be_read_by?(user) && user != creator
     end
   end
-
-  CommentObserver.instance
 end

data/app/models/commontator/subscription.rb

@@ -1,13 +1,9 @@
 module Commontator
   class Subscription < ActiveRecord::Base
     belongs_to :subscriber, :polymorphic => true
-
     belongs_to :thread
 
-    attr_accessible :subscriber, :thread
-
     validates_presence_of :subscriber, :thread
-
     validates_uniqueness_of :thread_id, :scope => [:subscriber_type, :subscriber_id]
 
     def mark_as_read

data/app/models/commontator/thread.rb

@@ -1,17 +1,12 @@
 module Commontator
   class Thread < ActiveRecord::Base
     belongs_to :closer, :polymorphic => true
-
     belongs_to :commontable, :polymorphic => true
 
     has_many :comments, :dependent => :destroy
-
     has_many :subscriptions, :dependent => :destroy
 
-    attr_accessible :is_closed
-
     validates_presence_of :commontable, :unless => :is_closed?
-
     validates_uniqueness_of :commontable_id, :scope => :commontable_type, :allow_nil => true
 
     def config
@@ -46,8 +41,10 @@ module Commontator
 
     def subscribe(subscriber)
       return false if is_subscribed?(subscriber) || !subscriber.is_commontator
-      subscription = Subscription.create(
-        :subscriber => subscriber, :thread => self)
+      subscription = Subscription.new
+      subscription.subscriber = subscriber
+      subscription.thread = self
+      subscription.save
     end
 
     def unsubscribe(subscriber)

data/app/views/commontator/comments/_actions.html.erb

@@ -23,7 +23,7 @@
               :confirm => (!is_deleted ? \
                             "Are you sure you want to delete this " + \
                             "#{comment.thread.config.comment_name}?" : nil),
-              :method => :put,
+              :method => :patch,
               :id => "comment_#{comment.id.to_s}_#{del_string}_link",
               :class => "comment_#{del_string}_link",
               :remote => true %>

data/app/views/commontator/comments/_votes.html.erb

@@ -10,7 +10,7 @@
   <span id="comment_<%= comment.id %>_upvote_span" class="comment_upvote">
     <% if can_vote && (vote.blank? || !vote.vote_flag) %>
       <%= form_tag commontator.upvote_comment_path(comment),
-            :method => :put,
+            :method => :patch,
             :remote => true do %>
         <%= image_submit_tag "commontator/upvote.png",
               :onmouseover => "this.src='/assets/commontator/upvote_hover.png'",
@@ -18,7 +18,7 @@
       <% end %>
     <% elsif can_vote %>
       <%= form_tag commontator.unvote_comment_path(comment),
-            :method => :put,
+            :method => :patch,
             :remote => true do %>
         <%= image_submit_tag "commontator/upvote_hover.png",
               :onmouseover => "this.src='/assets/commontator/upvote.png'",
@@ -36,7 +36,7 @@
   <span id="comment_<%= comment.id %>_downvote_span" class="comment_downvote">
     <% if can_vote && (vote.blank? || vote.vote_flag) %>
       <%= form_tag commontator.downvote_comment_path(comment),
-            :method => :put,
+            :method => :patch,
             :remote => true do %>
         <%= image_submit_tag "commontator/downvote.png",
               :onmouseover => "this.src='/assets/commontator/downvote_hover.png'",
@@ -44,7 +44,7 @@
       <% end %>
     <% elsif can_vote %>
       <%= form_tag commontator.unvote_comment_path(comment),
-            :method => :put,
+            :method => :patch,
             :remote => true do %>
         <%= image_submit_tag "commontator/downvote_hover.png",
               :onmouseover => "this.src='/assets/commontator/downvote.png'",

data/app/views/commontator/shared/_thread.html.erb

@@ -6,7 +6,7 @@
 <% subscription = thread.subscription_for(user) %>
 
 <% if thread.can_be_read_by?(user) %>
-  <%= stylesheet_link_tag "commontator/application", :media => "all" %>
+  <%= stylesheet_link_tag "commontator/application.css", :media => "all" %>
 
   <div id="thread_<%= thread.id %>_div" class="thread" style="display: none;">
     <% if @commontator_thread_show %>

data/app/views/commontator/subscriptions/_link.html.erb

@@ -10,7 +10,7 @@
             :confirm => (is_subscribed ? \
                           "Are you sure you want to unsubscribe from this thread?" : \
                           nil),
-            :method => :put,
+            :method => :patch,
             :id => "thread_#{thread.id.to_s}_#{sub_string}_link",
             :class => "thread_#{sub_string}_link",
             :remote => true %>

data/app/views/commontator/threads/_show.html.erb

@@ -28,7 +28,7 @@
                 commontator.polymorphic_path([close_string, thread]),
                 :confirm => (!is_closed ? \
                               'Are you sure you want to close this thread?' : nil),
-                :method => :put,
+                :method => :patch,
                 :id => "thread_#{thread.id.to_s}_#{close_string}_link",
                 :class => "thread_#{close_string}_link",
                 :remote => true %>

data/config/initializers/commontator.rb

@@ -23,7 +23,7 @@ Commontator.configure do |config|
   config.user_missing_name = 'Anonymous'
 
   # Whether the comment creator's name is clickable in the comment view
-  # If enabled, the link will point to the comment creator's show page
+  # If enabled, the link will point to the comment creator's 'show' page
   # Default: false
   config.user_name_clickable = false
 

data/config/routes.rb

@@ -1,22 +1,22 @@
 Commontator::Engine.routes.draw do
   resources :threads, :only => [:show] 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
+      member do
+        patch 'delete'
+        patch 'undelete'
+        
+        patch 'upvote'
+        patch 'downvote'
+        patch 'unvote'
+      end
     end
     
-    put 'close', :on => :member
-    put 'reopen', :on => :member
-    
-    put 'subscribe', :to => 'subscriptions#create',
-                     :as => 'subscribe',
-                     :on => :member
-    put 'unsubscribe', :to => 'subscriptions#destroy',
-                       :as => 'unsubscribe',
-                       :on => :member
+    member do
+      patch 'close'
+      patch 'reopen'
+      
+      patch 'subscribe', :to => 'subscriptions#subscribe'
+      patch 'unsubscribe', :to => 'subscriptions#unsubscribe'
+    end
   end
 end

data/db/migrate/0_install.rb

@@ -0,0 +1,50 @@
+class Install < ActiveRecord::Migration
+  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'
+      
+      t.integer  'cached_votes_total', :default => 0
+      t.integer  'cached_votes_up', :default => 0
+      t.integer  'cached_votes_down', :default => 0
+
+      t.timestamps
+    end
+
+    add_index :commontator_comments, [:creator_type, :creator_id, :thread_id], :name => 'index_c_c_on_c_type_and_c_id_and_t_id'
+    add_index :commontator_comments, :thread_id
+
+    add_index :commontator_comments, :cached_votes_total
+    add_index :commontator_comments, :cached_votes_up
+    add_index :commontator_comments, :cached_votes_down
+    
+    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  'unread', :null => false, :default => 0
+
+      t.timestamps
+    end
+
+    add_index :commontator_subscriptions, [:subscriber_type, :subscriber_id, :thread_id], :unique => true, :name => 'index_c_s_on_s_type_and_s_id_and_t_id'
+    add_index :commontator_subscriptions, :thread_id
+
+    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'
+
+      t.timestamps
+    end
+
+    add_index :commontator_threads, [:commontable_type, :commontable_id], :unique => true, :name => 'index_c_t_on_c_type_and_c_id'
+  end
+end