commontator 0.4.1 → 0.5.12

data/README.md

@@ -1,6 +1,8 @@
-# Common Tator
+# Commontator
 
-A Rails engine for comments
+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.
 
 ## Installation
 
@@ -11,7 +13,7 @@ There are 4 steps you must follow to install commontator:
   Add this line to your application's Gemfile:
 
   ```ruby
-  gem 'commontator', '~> 0.4.0'
+  gem 'commontator', '~> 0.5.0'
   ```
 
   And then execute:
@@ -59,7 +61,7 @@ There are 4 steps you must follow to install commontator:
   Add this line to your application's routes file:
 
   ```ruby
-  mount Commontator::Engine => "/commontator"
+  mount Commontator::Engine => '/commontator'
   ```
 
   You can change the mount path if you would like a different one.
@@ -81,41 +83,51 @@ Follow the steps below to add commontator to your models and views:
   ```ruby
   acts_as_commontable
   ```
-
-2. Controllers
-
-  Add the following line to the controller(s) that handle the views where you want to display comments:
-
-  ```ruby
-  helper Commontator::CommontatorHelper
-  ```
     
-3. Views
+2. Views
 
-  Add the following line to any view where you would like to display comments:
+  Add the following line to any erb view where you would like to display comments:
 
   ```erb
-  <%= commontator_thread_link(commontable) %>
+  <%= commontator_thread(commontable) %>
   ```
-    
+
   Where commontable is an instance of some model that acts_as_commontable.
 
+3. Controllers
+
+  Instead of linking to the thread, you might want to have the thread display right away, when the corresponding view page is loaded.
+  If that's the case, add the following to the controller action that displays the view where the thread is located:
+  
+  ```ruby
+  commontator_thread_show(commontable)
+  ```
+
+  Note that the above method also checks the current user's read permission on the thread.
+  It will raise a SecurityTransgression if the user is not allowed to read the thread.
+  You can specify the name of the method that determines which users are allowed to read which threads in the initializer.
+
 That's it! Commontator is now ready for use.
 
+## Browser Support
+
+No incompatibilities are currently known with any of the major browsers.
+Currently commontator requires javascript to be enabled to function properly.
+
 ## Customization
 
 Copy commontator's files to your app using any of the following commands:
 
 ```sh
-rake commontator:copy:images
-rake commontator:copy:stylesheets
+$ rake commontator:copy:images
+$ rake commontator:copy:stylesheets
 
-rake commontator:copy:views
-rake commontator:copy:mailers
-rake commontator:copy:helpers
+$ rake commontator:copy:views
+$ rake commontator:copy:mailers
+$ rake commontator:copy:helpers
 
-rake commontator:copy:controllers
-rake commontator:copy:models
+$ rake commontator:copy:controllers
+$ rake commontator:copy:models
 ```
 
 You are now free to modify them and have any changes made manifest in your application.

data/app/assets/stylesheets/commontator/comments.css

@@ -35,7 +35,7 @@
   padding: 8px;
 }
 
-.comment_profile_picture img {
+.comment_gravatar_image img {
   margin-top: 5px;
 }
 

data/app/assets/stylesheets/commontator/comments.css~

@@ -84,7 +84,3 @@
   
   padding-bottom: 7px;
 }
-
-.thread_new_comment textarea {
-	width: 100%;
-}

data/app/controllers/commontator/application_controller.rb

@@ -1,19 +1,18 @@
 module Commontator
   class ApplicationController < ActionController::Base
-    before_filter :get_commontator
+    before_filter :get_user
     
     protected
     
-    def get_commontator
-      @commontator = send Commontator.current_user_method
-      raise SecurityTransgression unless (@commontator.nil? || @commontator.is_commontator)
+    def get_user
+      @user = 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])
-      get_commontable_url
     end
     
     def get_commontable_url

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

@@ -1,12 +1,12 @@
 module Commontator
   class ApplicationController < ActionController::Base
-    before_filter :get_commontator
+    before_filter :get_user
     
     protected
     
-    def get_commontator
-      @commontator = send Commontator.current_user_method
-      raise SecurityTransgression unless (@commontator.nil? || @commontator.is_commontator)
+    def get_user
+      @user = send Commontator.current_user_method	
+      raise SecurityTransgression unless (@user.nil? || @user.is_commontator)
     end
     
     def get_thread
@@ -17,7 +17,7 @@ module Commontator
     end
     
     def get_commontable_url
-      @thread.config.commontable_url_proc.call(main_app, @thread.commontable)
+      @commontable_url = @thread.config.commontable_url_proc.call(main_app, @thread.commontable)
     end
   end
 end

data/app/controllers/commontator/comments_controller.rb

@@ -2,17 +2,18 @@ module Commontator
   class CommentsController < ApplicationController
     before_filter :get_thread, :only => [:new, :create]
     before_filter :get_comment_and_thread, :except => [:new, :create]
+    before_filter :get_commontable_url, :only => :create
 
     # GET /1/comments/new
     def new
       @comment = Comment.new
       @comment.thread = @thread
-      @comment.commontator = @commontator
+      @comment.creator = @user
 
-      raise SecurityTransgression unless @comment.can_be_created_by?(@commontator)
+      raise SecurityTransgression unless @comment.can_be_created_by?(@user)
 
       respond_to do |format|
-        format.html { redirect_to @commontable_url }
+        #format.html
         format.js
       end
      
@@ -22,105 +23,105 @@ module Commontator
     def create
       @comment = Comment.new(params[:comment])
       @comment.thread = @thread
-      @comment.commontator = @commontator
+      @comment.creator = @user
       
-      raise SecurityTransgression unless @comment.can_be_created_by?(@commontator)
+      raise SecurityTransgression unless @comment.can_be_created_by?(@user)
       
       if @comment.save
-        @thread.subscribe(@commontator) if @thread.config.auto_subscribe_on_comment
-        @thread.mark_as_unread_except_for(@commontator)
+        @thread.subscribe(@user) if @thread.config.auto_subscribe_on_comment
+        @thread.mark_as_unread_except_for(@user)
         SubscriptionsMailer.comment_created_email(@comment, @commontable_url)
-        @thread.comment_created_callback(@commontator, @comment)
+        @thread.comment_created_callback(@user, @comment)
       else
         @errors = @comment.errors
       end
 
       respond_to do |format|
-        format.html { redirect_to @commontable_url }
+        format.html { redirect_to @thread }
         format.js
       end
     end
 
     # GET /comments/1/edit
     def edit
-      raise SecurityTransgression unless @comment.can_be_edited_by?(@commontator)
+      raise SecurityTransgression unless @comment.can_be_edited_by?(@user)
 
       respond_to do |format|
-        format.html { redirect_to @commontable_url }
+        #format.html
         format.js
       end
     end
 
     # PUT /comments/1
     def update
-      raise SecurityTransgression unless @comment.can_be_edited_by?(@commontator)
+      raise SecurityTransgression unless @comment.can_be_edited_by?(@user)
       
-      @thread.comment_edited_callback(@commontator, @comment) \
+      @thread.comment_edited_callback(@user, @comment) \
         if @comment.update_attributes(params[:comment])
 
       respond_to do |format|
-        format.html { redirect_to @commontable_url }
+        format.html { redirect_to @thread }
         format.js
       end
     end
 
     # PUT /comments/1/delete
     def delete
-      raise SecurityTransgression unless @comment.can_be_deleted_by?(@commontator)
+      raise SecurityTransgression unless @comment.can_be_deleted_by?(@user)
 
-      @comment.delete(@commontator)
-      @thread.comment_deleted_callback(@commontator, @comment)
+      @comment.delete(@user)
+      @thread.comment_deleted_callback(@user, @comment)
 
       respond_to do |format|
-        format.html { redirect_to @commontable_url }
+        format.html { redirect_to @thread }
         format.js { render :delete }
       end
     end
     
     # PUT /comments/1/undelete
     def undelete
-      raise SecurityTransgression unless @comment.can_be_deleted_by?(@commontator)
+      raise SecurityTransgression unless @comment.can_be_deleted_by?(@user)
 
       @comment.undelete
 
       respond_to do |format|
-        format.html { redirect_to @commontable_url }
+        format.html { redirect_to @thread }
         format.js { render :delete }
       end
     end
     
     # PUT /comments/1/upvote
     def upvote
-      raise SecurityTransgression unless @comment.can_be_voted_on_by?(@commontator)
+      raise SecurityTransgression unless @comment.can_be_voted_on_by?(@user)
       
-      @comment.upvote_from @commontator
+      @comment.upvote_from @user
 
       respond_to do |format|
-        format.html { redirect_to @commontable_url }
+        format.html { redirect_to @thread }
         format.js { render :vote }
       end
     end
     
     # PUT /comments/1/downvote
     def downvote
-      raise SecurityTransgression unless @comment.can_be_voted_on_by?(@commontator)
+      raise SecurityTransgression unless @comment.can_be_voted_on_by?(@user)
       
-      @comment.downvote_from @commontator
+      @comment.downvote_from @user
 
       respond_to do |format|
-        format.html { redirect_to @commontable_url }
+        format.html { redirect_to @thread }
         format.js { render :vote }
       end
     end
     
     # PUT /comments/1/unvote
     def unvote
-      raise SecurityTransgression unless @comment.can_be_voted_on_by?(@commontator)
+      raise SecurityTransgression unless @comment.can_be_voted_on_by?(@user)
       
-      @comment.unvote :voter => @commontator
+      @comment.unvote :voter => @user
 
       respond_to do |format|
-        format.html { redirect_to @commontable_url }
+        format.html { redirect_to @thread }
         format.js { render :vote }
       end
     end
@@ -130,7 +131,6 @@ module Commontator
     def get_comment_and_thread
       @comment = Comment.find(params[:id])
       @thread = @comment.thread
-      get_commontable_url
     end
   end
 end

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

@@ -2,17 +2,18 @@ module Commontator
   class CommentsController < ApplicationController
     before_filter :get_thread, :only => [:new, :create]
     before_filter :get_comment_and_thread, :except => [:new, :create]
+    before_filter :get_commontable_url, :only => :create
 
     # GET /1/comments/new
     def new
       @comment = Comment.new
       @comment.thread = @thread
-      @comment.commontator = @commontator
+      @comment.creator = @user
 
-      raise SecurityTransgression unless @comment.can_be_created_by?(@commontator)
+      raise SecurityTransgression unless @comment.can_be_created_by?(@user)
 
       respond_to do |format|
-        format.html { redirect_to @commontable_url }
+        #format.html
         format.js
       end
      
@@ -22,105 +23,105 @@ module Commontator
     def create
       @comment = Comment.new(params[:comment])
       @comment.thread = @thread
-      @comment.commontator = @commontator
+      @comment.creator = @user
       
-      raise SecurityTransgression unless @comment.can_be_created_by?(@commontator)
+      raise SecurityTransgression unless @comment.can_be_created_by?(@user)
       
       if @comment.save
-        @thread.subscribe(@commontator) if @thread.config.auto_subscribe_on_comment
-        @thread.mark_as_unread_except_for(@commontator)
-        SubscriptionsMailer.comment_created_email(@comment)
-        @thread.comment_created_callback(@commontator, @comment)
+        @thread.subscribe(@user) if @thread.config.auto_subscribe_on_comment
+        @thread.mark_as_unread_except_for(@user)
+        SubscriptionsMailer.comment_created_email(@comment, @commontable_url)
+        @thread.comment_created_callback(@user, @comment)
       else
         @errors = @comment.errors
       end
 
       respond_to do |format|
-        format.html { redirect_to @commontable_url }
+        format.html { redirect_to @thread }
         format.js
       end
     end
 
     # GET /comments/1/edit
     def edit
-      raise SecurityTransgression unless @comment.can_be_edited_by?(@commontator)
+      raise SecurityTransgression unless @comment.can_be_edited_by?(@user)
 
       respond_to do |format|
-        format.html { redirect_to @commontable_url }
+        format.html
         format.js
       end
     end
 
     # PUT /comments/1
     def update
-      raise SecurityTransgression unless @comment.can_be_edited_by?(@commontator)
+      raise SecurityTransgression unless @comment.can_be_edited_by?(@user)
       
-      @thread.comment_edited_callback(@commontator, @comment) \
+      @thread.comment_edited_callback(@user, @comment) \
         if @comment.update_attributes(params[:comment])
 
       respond_to do |format|
-        format.html { redirect_to @commontable_url }
+        format.html { redirect_to @thread }
         format.js
       end
     end
 
     # PUT /comments/1/delete
     def delete
-      raise SecurityTransgression unless @comment.can_be_deleted_by?(@commontator)
+      raise SecurityTransgression unless @comment.can_be_deleted_by?(@user)
 
-      @comment.delete(@commontator)
-      @thread.comment_deleted_callback(@commontator, @comment)
+      @comment.delete(@user)
+      @thread.comment_deleted_callback(@user, @comment)
 
       respond_to do |format|
-        format.html { redirect_to @commontable_url }
+        format.html { redirect_to @thread }
         format.js { render :delete }
       end
     end
     
     # PUT /comments/1/undelete
     def undelete
-      raise SecurityTransgression unless @comment.can_be_deleted_by?(@commontator)
+      raise SecurityTransgression unless @comment.can_be_deleted_by?(@user)
 
       @comment.undelete
 
       respond_to do |format|
-        format.html { redirect_to @commontable_url }
+        format.html { redirect_to @thread }
         format.js { render :delete }
       end
     end
     
     # PUT /comments/1/upvote
     def upvote
-      raise SecurityTransgression unless @comment.can_be_voted_on_by?(@commontator)
+      raise SecurityTransgression unless @comment.can_be_voted_on_by?(@user)
       
-      @comment.upvote_from @commontator
+      @comment.upvote_from @user
 
       respond_to do |format|
-        format.html { redirect_to @commontable_url }
+        format.html { redirect_to @thread }
         format.js { render :vote }
       end
     end
     
     # PUT /comments/1/downvote
     def downvote
-      raise SecurityTransgression unless @comment.can_be_voted_on_by?(@commontator)
+      raise SecurityTransgression unless @comment.can_be_voted_on_by?(@user)
       
-      @comment.downvote_from @commontator
+      @comment.downvote_from @user
 
       respond_to do |format|
-        format.html { redirect_to @commontable_url }
+        format.html { redirect_to @thread }
         format.js { render :vote }
       end
     end
     
     # PUT /comments/1/unvote
     def unvote
-      raise SecurityTransgression unless @comment.can_be_voted_on_by?(@commontator)
+      raise SecurityTransgression unless @comment.can_be_voted_on_by?(@user)
       
-      @comment.unvote :voter => @commontator
+      @comment.unvote :voter => @user
 
       respond_to do |format|
-        format.html { redirect_to @commontable_url }
+        format.html { redirect_to @thread }
         format.js { render :vote }
       end
     end
@@ -130,7 +131,6 @@ module Commontator
     def get_comment_and_thread
       @comment = Comment.find(params[:id])
       @thread = @comment.thread
-      get_commontable_url
     end
   end
 end