commontator 0.5.14 → 1.0.0

data/README.md

@@ -1,8 +1,8 @@
 # Commontator
 
 Commontator is a Rails engine for comments.
-That means it is fully functional as soon as you install and configure its gem, providing models, views and controllers of its own.
-At the same time, it is highly configurable, so you can change anything about it if you would like.
+Being an engine means it is fully functional as soon as you install and configure its gem, providing models, views and controllers of its own.
+At the same time, almost anything about it can be configured or customized to suit your needs.
 
 ## Installation
 
@@ -13,7 +13,8 @@ There are 4 steps you must follow to install commontator:
   Add this line to your application's Gemfile:
 
   ```ruby
-  gem 'commontator', '~> 0.5.0'
+  gem 'commontator', '~> 0.5.0' or
+  gem 'commontator', '~> 1.0.0' (not yet released)
   ```
 
   And then execute:
@@ -93,6 +94,8 @@ Follow the steps below to add commontator to your models and views:
   ```
 
   Where commontable is an instance of some model that acts_as_commontable.
+  Note that model's record must already exist in the database, so do not use this in new.html.erb, _form.html.erb or similar.
+  We recommend you use this in the model's show.html.erb.
 
 3. Controllers
 
@@ -132,17 +135,51 @@ $ rake commontator:copy:models
 
 You are now free to modify them and have any changes made manifest in your application.
 
-## Testing
-
-Soon
-
 ## Contributing
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+3. Write tests for your feature
+4. Implement your new feature
+5. Test your feature (`rake`)
+6. Commit your changes (`git commit -am 'Added some feature'`)
+7. Push to the branch (`git push origin my-new-feature`)
+8. Create new Pull Request
+
+## Development Environment Setup
+
+1. Browse to commontator's spec/dummy folder
+2. Use bundler to install all dependencies:
+
+  ```sh
+  $ bundle install
+  ```
+
+3. Load the schema:
+
+  ```sh
+  $ rake db:schema:load
+  ```
+
+  Or if the above fails:
+
+  ```sh
+  $ bundle exec rake db:schema:load
+  ```
+
+## Testing
+
+To run all existing tests for commontator, simply execute the following from the main folder:
+
+```sh
+$ rake
+```
+
+Or if the above fails:
+
+```sh
+$ bundle exec rake
+```
 
 ## License
 

data/Rakefile

@@ -20,7 +20,7 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
 load 'rails/tasks/engine.rake'
 
 
@@ -29,12 +29,13 @@ Bundler::GemHelper.install_tasks
 
 require 'rake/testtask'
 
-Rake::TestTask.new(:test) do |t|
+Rake::TestTask.new(:spec) do |t|
+  Rake::Task['app:db:test:prepare'].invoke
   t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
+  t.libs << 'spec'
+  t.pattern = 'spec/**/*_spec.rb'
   t.verbose = false
 end
 
 
-task :default => :test
+task :default => :spec

data/app/controllers/commontator/application_controller.rb

@@ -2,10 +2,12 @@ module Commontator
   class ApplicationController < ActionController::Base
     before_filter :get_user
     
+    rescue_from SecurityTransgression, :with => lambda { head(:forbidden) }
+    
     protected
     
     def get_user
-      @user = send Commontator.current_user_method	
+      @user = self.send Commontator.current_user_method	
       raise SecurityTransgression unless (@user.nil? || @user.is_commontator)
     end
     

data/app/controllers/commontator/application_controller.rb~

@@ -2,10 +2,14 @@ module Commontator
   class ApplicationController < ActionController::Base
     before_filter :get_user
     
+    class SecurityTransgression < StandardError; end
+    
+    rescue_from SecurityTransgression, :with => lambda { head(:forbidden) }
+    
     protected
     
     def get_user
-      @user = send Commontator.current_user_method	
+      @user = self.send Commontator.current_user_method	
       raise SecurityTransgression unless (@user.nil? || @user.is_commontator)
     end
     
@@ -13,7 +17,6 @@ module Commontator
       @thread = params[:thread_id].blank? ? \
         Commontator::Thread.find(params[:id]) : \
         Commontator::Thread.find(params[:thread_id])
-      get_commontable_url
     end
     
     def get_commontable_url

data/app/controllers/commontator/comments_controller.rb

@@ -13,7 +13,7 @@ module Commontator
       raise SecurityTransgression unless @comment.can_be_created_by?(@user)
 
       respond_to do |format|
-        #format.html
+        format.html { redirect_to @thread }
         format.js
       end
      
@@ -29,9 +29,8 @@ module Commontator
       
       if @comment.save
         @thread.subscribe(@user) if @thread.config.auto_subscribe_on_comment
-        @thread.mark_as_unread_except_for(@user)
+        @thread.add_unread_except_for(@user)
         SubscriptionsMailer.comment_created_email(@comment, @commontable_url)
-        @thread.comment_created_callback(@user, @comment)
       else
         @errors = @comment.errors
       end
@@ -47,7 +46,7 @@ module Commontator
       raise SecurityTransgression unless @comment.can_be_edited_by?(@user)
 
       respond_to do |format|
-        #format.html
+        format.html { redirect_to @thread }
         format.js
       end
     end
@@ -55,9 +54,8 @@ module Commontator
     # PUT /comments/1
     def update
       raise SecurityTransgression unless @comment.can_be_edited_by?(@user)
-      
-      @thread.comment_edited_callback(@user, @comment) \
-        if @comment.update_attributes(params[:comment])
+
+      @comment.update_attributes(params[:comment])
 
       respond_to do |format|
         format.html { redirect_to @thread }
@@ -69,8 +67,8 @@ module Commontator
     def delete
       raise SecurityTransgression unless @comment.can_be_deleted_by?(@user)
 
-      @comment.delete(@user)
-      @thread.comment_deleted_callback(@user, @comment)
+      @comment.errors.add(:base, 'This comment has already been deleted.') \
+        unless @comment.delete(@user)
 
       respond_to do |format|
         format.html { redirect_to @thread }
@@ -82,7 +80,8 @@ module Commontator
     def undelete
       raise SecurityTransgression unless @comment.can_be_deleted_by?(@user)
 
-      @comment.undelete
+      @comment.errors.add(:base, 'This comment is not deleted.') \
+        unless @comment.undelete
 
       respond_to do |format|
         format.html { redirect_to @thread }

data/app/controllers/commontator/comments_controller.rb~

@@ -13,7 +13,7 @@ module Commontator
       raise SecurityTransgression unless @comment.can_be_created_by?(@user)
 
       respond_to do |format|
-        #format.html
+        format.html { redirect_to @thread }
         format.js
       end
      
@@ -29,9 +29,8 @@ module Commontator
       
       if @comment.save
         @thread.subscribe(@user) if @thread.config.auto_subscribe_on_comment
-        @thread.mark_as_unread_except_for(@user)
+        @thread.add_unread_except_for(@user)
         SubscriptionsMailer.comment_created_email(@comment, @commontable_url)
-        @thread.comment_created_callback(@user, @comment)
       else
         @errors = @comment.errors
       end
@@ -47,7 +46,7 @@ module Commontator
       raise SecurityTransgression unless @comment.can_be_edited_by?(@user)
 
       respond_to do |format|
-        format.html
+        format.html { redirect_to @thread }
         format.js
       end
     end
@@ -55,9 +54,8 @@ module Commontator
     # PUT /comments/1
     def update
       raise SecurityTransgression unless @comment.can_be_edited_by?(@user)
-      
-      @thread.comment_edited_callback(@user, @comment) \
-        if @comment.update_attributes(params[:comment])
+
+      @comment.update_attributes(params[:comment])
 
       respond_to do |format|
         format.html { redirect_to @thread }
@@ -69,8 +67,8 @@ module Commontator
     def delete
       raise SecurityTransgression unless @comment.can_be_deleted_by?(@user)
 
-      @comment.delete(@user)
-      @thread.comment_deleted_callback(@user, @comment)
+      @comment.errors.add(:base, 'This comment has already been deleted.') \
+        unless @comment.delete(@user)
 
       respond_to do |format|
         format.html { redirect_to @thread }
@@ -82,7 +80,8 @@ module Commontator
     def undelete
       raise SecurityTransgression unless @comment.can_be_deleted_by?(@user)
 
-      @comment.undelete
+      @comment.errors.add(:base, 'This comment is not deleted.') \
+        unless @comment.undelete(@user)
 
       respond_to do |format|
         format.html { redirect_to @thread }

data/app/controllers/commontator/commontator_controller.rb~

@@ -0,0 +1,22 @@
+module Commontator
+  class CommontatorController < ActionController::Base
+    before_filter :get_user
+    
+    protected
+    
+    def get_user
+      @user = ApplicationController.send Commontator.current_user_method	
+      raise SecurityTransgression unless (@user.nil? || @user.is_commontator)
+    end
+    
+    def get_thread
+      @thread = params[:thread_id].blank? ? \
+        Commontator::Thread.find(params[:id]) : \
+        Commontator::Thread.find(params[:thread_id])
+    end
+    
+    def get_commontable_url
+      @commontable_url = @thread.config.commontable_url_proc.call(main_app, @thread.commontable)
+    end
+  end
+end

data/app/controllers/commontator/subscriptions_controller.rb

@@ -7,7 +7,7 @@ module Commontator
     def create
       raise SecurityTransgression unless @thread.can_subscribe?(@user)
 
-      @thread.errors.add(:base, "You are already subscribed to this thread") \
+      @thread.errors.add(:subscription, "You are already subscribed to this thread") \
         unless @thread.subscribe(@user)
 
       respond_to do |format|
@@ -21,7 +21,7 @@ module Commontator
     def destroy
       raise SecurityTransgression unless @thread.can_subscribe?(@user)
 
-      @thread.errors.add(:base, "You are not subscribed to this thread") \
+      @thread.errors.add(:subscription, "You are not subscribed to this thread") \
         unless @thread.unsubscribe(@user)
 
       respond_to do |format|

data/app/controllers/commontator/subscriptions_controller.rb~

@@ -7,11 +7,11 @@ module Commontator
     def create
       raise SecurityTransgression unless @thread.can_subscribe?(@user)
 
-      @thread.errors.add(:base, "You are already subscribed to this thread") \
+      @thread.errors.add(:subscription, "You are already subscribed to this thread") \
         unless @thread.subscribe(@user)
 
       respond_to do |format|
-        format.html { redirect_to @commontable_url }
+        format.html { redirect_to @thread }
         format.js { render :subscribe }
       end
 
@@ -25,7 +25,7 @@ module Commontator
         unless @thread.unsubscribe(@user)
 
       respond_to do |format|
-        format.html { redirect_to @commontable_url }
+        format.html { redirect_to @thread }
         format.js { render :subscribe }
       end
     end

data/app/controllers/commontator/threads_controller.rb

@@ -17,8 +17,8 @@ module Commontator
     def close
       raise SecurityTransgression unless @thread.can_be_edited_by?(@user)
 
-      @thread.close(@user)
-      @thread.thread_closed_callback(@user)
+      @thread.errors.add(:base, 'This thread has already been closed.') \
+        unless @thread.close(@user)
 
       respond_to do |format|
         format.html { redirect_to @thread }
@@ -30,7 +30,8 @@ module Commontator
     def reopen
       raise SecurityTransgression unless @thread.can_be_edited_by?(@user)
 
-      @thread.reopen
+      @thread.errors.add(:base, 'This thread is not closed.') \
+        unless @thread.reopen
 
       respond_to do |format|
         format.html { redirect_to @thread }

data/app/controllers/commontator/threads_controller.rb~

@@ -17,8 +17,8 @@ module Commontator
     def close
       raise SecurityTransgression unless @thread.can_be_edited_by?(@user)
 
-      @thread.close(@user)
-      @thread.thread_closed_callback(@user)
+      @thread.errors.add(:base, "This thread has already been closed") \
+        unless @thread.close(@user)
 
       respond_to do |format|
         format.html { redirect_to @thread }
@@ -30,10 +30,12 @@ module Commontator
     def reopen
       raise SecurityTransgression unless @thread.can_be_edited_by?(@user)
 
-      @thread.reopen
+      @thread.errors.add(:base, "This thread is not closed") \
+        unless @thread.reopen
 
       respond_to do |format|
         format.html { redirect_to @thread }
+        format.js { render :show }
       end
     end
   end

data/app/helpers/commontator/commontator_helper.rb~

@@ -0,0 +1,7 @@
+module Commontator
+  module CommontatorHelper
+    def javascript_proc
+      Commontator.javascript_proc.call(self).html_safe
+    end
+  end
+end

data/app/mailers/commontator/subscriptions_mailer.rb

@@ -18,7 +18,8 @@ protected
       @thread = @comment.thread
       @creator = @comment.creator
       
-      @bcc = @thread.subscribers.reject{|s| s == @creator}\
+      @bcc = @thread.subscribers.reject{|s| !s.commontator_config.subscription_emails || \
+                                            s == @creator} \
                                 .collect{|s| commontator_email(s)}
       
       return if @bcc.empty?

data/app/mailers/commontator/subscriptions_mailer.rb~

@@ -1,6 +1,7 @@
 module Commontator
   class SubscriptionsMailer < ActionMailer::Base
     include SharedHelper
+    include ThreadsHelper
   
     def comment_created_email(comment, commontable_url) 
       setup_variables(comment, commontable_url)
@@ -17,7 +18,8 @@ protected
       @thread = @comment.thread
       @creator = @comment.creator
       
-      @bcc = @thread.subscribers.reject{|s| s == @creator}\
+      @bcc = @thread.subscribers.reject{|s| s == @creator || \
+                                            !s.commontator_config.subscription_emails} \
                                 .collect{|s| commontator_email(s)}
       
       return if @bcc.empty?

data/app/models/commontator/comment.rb

@@ -8,15 +8,16 @@ module Commontator
     
     validates_presence_of :creator, :on => :create
     validates_presence_of :thread
+    validates_presence_of :body
 
     attr_accessible :body
     
-    cattr_accessor :is_votable
-    if respond_to?(:acts_as_votable)
-      acts_as_votable if respond_to?(:acts_as_votable)
-      self.is_votable = true
-    else
-      self.is_votable = false
+    cattr_accessor :acts_as_votable_initialized
+    
+    def is_votable?
+      return false unless self.class.respond_to?(:acts_as_votable)
+      self.class.acts_as_votable unless acts_as_votable_initialized
+      self.class.acts_as_votable_initialized = true
     end
     
     def is_modified?
@@ -35,12 +36,14 @@ module Commontator
     end
     
     def delete(user = nil)
+      return false if is_deleted?
       self.deleted_at = Time.now
       self.deleter = user
       self.save!
     end
     
     def undelete
+      return false unless is_deleted?
       self.deleted_at = nil
       self.save!
     end
@@ -61,20 +64,21 @@ module Commontator
 
     def can_be_edited_by?(user)
       !thread.is_closed? && !is_deleted? &&\
-        ((user == creator && thread.config.can_edit_own_comments) ||\
+        ((user == creator && thread.config.can_edit_own_comments && thread.can_be_read_by?(user)) ||\
         (thread.can_be_edited_by?(user) && thread.config.admin_can_edit_comments)) &&\
         (thread.comments.last == self || thread.config.can_edit_old_comments)
     end
 
     def can_be_deleted_by?(user)
       (!thread.is_closed? &&\
-        ((user == creator && thread.config.can_delete_own_comments) &&\
+        ((user == creator && thread.config.can_delete_own_comments && \
+        thread.can_be_read_by?(user) && (!is_deleted? || deleter == user)) &&\
         (thread.comments.last == self || thread.config.can_delete_old_comments))) ||\
         thread.can_be_edited_by?(user)
     end
     
     def can_be_voted_on?
-      is_votable && !is_deleted? && thread.config.comments_can_be_voted_on
+      is_votable? && !is_deleted? && thread.config.can_vote_on_comments
     end
 
     def can_be_voted_on_by?(user)