commontator 4.5.4 → 4.6.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZGE2MjNhMmY3YjIzZTMwZDBiMGYwZDlhYjc3NDg4ZTc2NDQ2ZGYzYg==
-  data.tar.gz: !binary |-
-    ZjdmMjgxN2RmNjFkNDY5MDIxZTQ1NjM1Mjk4NjU0MWVkMGZkMjQwMA==
+SHA1:
+  metadata.gz: 4beac087c18e25ec5801db3cf8d93065820dea56
+  data.tar.gz: c7c24346e146b94fd52d52721249078b6f4da002
 SHA512:
-  metadata.gz: !binary |-
-    MzIwZDlhNGZjYjljNThlNjEyZGM4MzFjYzljOWFmNDg5YzA5ZTU2NTEwZjY2
-    NWNlMDdjNDc4ZTkyZWU1NTQyY2IxODFjYTk1OTkwMDMyOWM2ZjRhMDNmZWJm
-    Y2Q2ZmZmNzZlZjk3MjM1M2NhOGE4MmYzMjgwZWRhOWQwOWQxZTc=
-  data.tar.gz: !binary |-
-    ZjVhOWJiZDI5MzE5YjU0OThkMTY4MmZlMWZhMmE4MTFjOGNhY2U4ZDMxMjEz
-    NmYzYzk1YTdhZDU3NzBjOTU1ZDg2OWRmMWQyODM5MDc3OTVjN2Q4YTYxZjI0
-    OTA3NDM0NjA4NDk1Y2U0ODZkYWI5MTI2YjdiZTdhMTcxYzgyYjg=
+  metadata.gz: d1e5dd9cc40f73bfa294774ed4b08e9262ab7e9d434306e6d44bf5a38647771ebf8ae9553d18935fc265c8630075aa4890672a93ce3fba0ae2118a89c6548afc
+  data.tar.gz: 775b2d53d9da20a6814f6dbcbfbff4c3314f7163120a81a8ee3f8ea95e88be049ac9706e6582b12be403033068409913e817f67397946b1c951616f702259a28

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2012-13 Rice University
+Copyright 2012-14 Rice University
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -18,3 +18,4 @@ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/README.md

@@ -13,43 +13,35 @@ There are 4 steps you must follow to install commontator:
 
   Add this line to your application's Gemfile:
 
-  ```ruby
-  gem 'commontator', '~> 4.5.4'
+  ```rb
+  gem 'commontator', '~> 4.6.0'
   ```
 
   And then execute:
 
   ```sh
-  $ bundle
-  ```
-
-  Or install it yourself as:
-
-  ```sh
-  $ gem install commontator
+  $ bundle install
   ```
 
 2. Initializer and Migration
 
-  Run the following command to copy commontator's initializer and migration to your own app:
+  Run the following command to copy commontator's initializer and migration to your app:
 
   ```sh
   $ rake commontator:install
   ```
 
-  And then execute:
-
-  ```sh
-  $ rake db:migrate
-  ```
-
-  Or run each rake task manually:
+  Or alternatively:
 
   ```sh
   $ rake commontator:install:initializers
 
   $ rake commontator:install:migrations
+  ```
+
+  And then execute:
 
+  ```sh
   $ rake db:migrate
   ```
 
@@ -57,12 +49,13 @@ There are 4 steps you must follow to install commontator:
 
   Change commontator's configurations to suit your needs by editing `config/initializers/commontator.rb`.
   Make sure to check that your configuration file is up to date every time you update the gem, as available options can change with each minor version.
+  If you have deprecated options in your initializer, Commontator will issue warnings (usually printed to your console).
 
 4. Routes
 
-  Add this line to your application's routes file:
+  Add this line to your Rails application's routes file:
 
-  ```ruby
+  ```rb
   mount Commontator::Engine => '/commontator'
   ```
 
@@ -76,43 +69,46 @@ Follow the steps below to add commontator to your models and views:
 
   Add this line to your user model(s) (or any models that should be able to post comments):
 
-  ```ruby
+  ```rb
   acts_as_commontator
   ```
     
-  Add this line to any models you want to be able to comment on:
+  Add this line to any models you want to be able to comment on (i.e. models that have comment threads):
 
-  ```ruby
+  ```rb
   acts_as_commontable
   ```
     
 2. Views
 
-  In the following instructions, `commontable` is an instance of a model that `acts_as_commontable`.
+  In the following instructions, `@commontable` is an instance of a model that `acts_as_commontable`.
+  You must supply this variable to the views that will use Commontator.
 
-  Add the following line to any erb view where you would like to display comments:
+  Wherever you would like to display comments, call `commontator_thread(@commontable)`:
 
   ```erb
-  <%= commontator_thread(commontable) %>
+  <%= commontator_thread(@commontable) %>
   ```
 
-  This will create a link in the view that the user will be able to click to display the comment thread.
+  This will create a link that can be clicked to display the comment thread.
 
-  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` or similar.
+  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 views.
+  We recommend you use this in the model's `show.html.erb` view or the equivalent for your app.
 
 3. Controllers
 
-  By default, the `commontator_thread` method only links to the desired comment thread.
-  If you want, instead, to have the thread display right away when the corresponding view page is loaded, just add the following method call to the controller action that displays the view in question:
+  By default, the `commontator_thread` method only provides a link to the desired comment thread.
+  Sometimes it may be desirable to have the thread display right away when the corresponding page is loaded.
+  In that case, just add the following method call to the controller action that displays the page in question:
   
-  ```ruby
+  ```rb
   commontator_thread_show(commontable)
   ```
 
   Note that the call to `commontator_thread` in the view is still necessary in either case.
 
-  The `commontator_thread_show` method checks the current user's read permission on the thread and will raise an exception if the user is not allowed to read it according to the configuration options in the initializer.
+  The `commontator_thread_show` method checks the current user's read permission on the thread and will raise a
+  Commontator::SecurityTransgression exception if the user is not allowed to read it, according to the options in the initializer.
   It is up to you to ensure that this method is only called if the user is authorized to read the thread.
 
 That's it! Commontator is now ready for use.
@@ -121,13 +117,13 @@ That's it! Commontator is now ready for use.
 
 You can allow users to vote on each others' comments by adding the `acts_as_votable` gem to your gemfile:
 
-```ruby
+```rb
 gem 'acts_as_votable'
 ```
 
 And enabling the relevant option in commontator's initializer:
 
-```ruby
+```rb
 config.can_vote_on_comments = true
 ```
 
@@ -215,3 +211,4 @@ $ bundle exec rake
 
 This gem is distributed under the terms of the MIT license.
 See the MIT-LICENSE file for details.
+

data/Rakefile

@@ -12,11 +12,12 @@ Bundler::GemHelper.install_tasks
 
 require 'rake/testtask'
 
-Rake::TestTask.new(:test => 'app:db:test:prepare') do |t|
+Rake::TestTask.new(:spec => 'app:db:test:prepare') do |t|
   t.libs << 'lib'
   t.libs << 'spec'
   t.pattern = 'spec/**/*_spec.rb'
   t.verbose = false
 end
 
-task :default => :test
+task :default => :spec
+

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

@@ -11,3 +11,4 @@
  *= require_self
  *= require_tree .
  */
+

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

@@ -119,3 +119,4 @@
 .comment_error_explanation ul {
   list-style-position: inside;
 }
+

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

@@ -25,14 +25,19 @@
 
 /* Modified from:
 http://www.strangerstudios.com/sandbox/pagination/diggstyle.php */
-.thread_pagination {
-	padding: 3px;
-	margin: 3px;
+.thread_page_entries_info {
+	margin-top: 10px;
+  margin-bottom: 10px;
+}
+
+.thread_will_paginate {
+	margin-top: 10px;
+  margin-bottom: 10px;
 }
 
 .thread_pagination a {
 	padding: 2px 5px 2px 5px;
-	margin: 2px;
+	margin-right: 4px;
 	border: 1px solid #999;
 	
 	text-decoration: none;
@@ -48,7 +53,7 @@ http://www.strangerstudios.com/sandbox/pagination/diggstyle.php */
 
 .thread_pagination em {
 	padding: 2px 5px 2px 5px;
-	margin: 2px;
+	margin-right: 4px;
   border: 1px solid #555;
 
   font-weight: bold;
@@ -58,8 +63,9 @@ http://www.strangerstudios.com/sandbox/pagination/diggstyle.php */
 
 .thread_pagination span {
   padding: 2px 5px 2px 5px;
-  margin: 2px;
+	margin-right: 4px;
   border: 1px solid #EEE;
 
   color: #DDD;
-}
+}
+

data/app/controllers/commontator/application_controller.rb

@@ -1,35 +1,35 @@
 module Commontator
   class ApplicationController < ActionController::Base
-    before_filter :get_user, :ensure_user
-    
-    cattr_accessor :commontable_url
+    cattr_reader :app_routes
+
+    before_filter :get_user, :ensure_user, :set_app_routes
     
     rescue_from SecurityTransgression, :with => lambda { head(:forbidden) }
     
     protected
-    
+
+    def security_transgression_unless(check)
+      raise SecurityTransgression unless check
+    end
+
     def get_user
-      @user = Commontator.current_user_proc.call(self)	
+      @user = Commontator.current_user_proc.call(self)
     end
 
     def ensure_user
       security_transgression_unless(@user && @user.is_commontator)
     end
-    
+
     def get_thread
       @thread = params[:thread_id].blank? ? \
         Commontator::Thread.find(params[:id]) : \
         Commontator::Thread.find(params[:thread_id])
-      security_transgression_unless !@thread.commontable.nil?
-    end
-    
-    def set_commontable_url
-      self.commontable_url = @thread.config.commontable_url_proc.call(
-                               @thread.commontable, main_app)
+      security_transgression_unless @thread.can_be_read_by? @user
     end
 
-    def security_transgression_unless(check)
-      raise SecurityTransgression unless check
+    def set_app_routes
+      @@app_routes ||= main_app
     end
   end
 end
+

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

@@ -0,0 +1,35 @@
+module Commontator
+  class ApplicationController < ActionController::Base
+    cattr_reader :app_routes
+
+    before_filter :get_user, :ensure_user, :set_app_routes
+    
+    rescue_from SecurityTransgression, :with => lambda { head(:forbidden) }
+    
+    protected
+
+    def security_transgression_unless(check)
+      raise SecurityTransgression unless check
+    end
+
+    def get_user
+      @user = Commontator.current_user_proc.call(self)
+    end
+
+    def ensure_user
+      security_transgression_unless(@user && @user.is_commontator)
+    end
+
+    def get_thread
+      @thread = params[:thread_id].blank? ? \
+        Commontator::Thread.find(params[:id]) : \
+        Commontator::Thread.find(params[:thread_id])
+      security_transgression_unless @thread.can_be_read_by? @user
+    end
+
+    def set_app_routes
+      @@app_routes = main_app
+    end
+  end
+end
+

data/app/controllers/commontator/comments_controller.rb

@@ -2,7 +2,6 @@ module Commontator
   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 /threads/1/comments/new
     def new
@@ -12,6 +11,8 @@ module Commontator
 
       security_transgression_unless @comment.can_be_created_by?(@user)
 
+      @per_page = params[:per_page] || @thread.config.comments_per_page
+
       respond_to do |format|
         format.html { redirect_to @thread }
         format.js
@@ -33,12 +34,11 @@ module Commontator
           format.html { redirect_to @thread }
           format.js { render :cancel }
         elsif @comment.save
-          @thread.subscribe(@user) if @thread.config.thread_subscription == :a ||\
-                                      @thread.config.thread_subscription == :b
-          @thread.add_unread_except_for(@user)
-          recipients = @thread.subscribers.reject{|s| s == @user}
-          SubscriptionsMailer.comment_created(@comment, recipients).deliver \
-            unless recipients.empty?
+          sub = @thread.config.thread_subscription.to_sym
+          @thread.subscribe(@user) if sub == :a || sub == :b
+          Subscription.comment_created(@comment)
+
+          @per_page = params[:per_page] || @thread.config.comments_per_page
 
           format.html { redirect_to @thread }
           format.js
@@ -150,3 +150,4 @@ module Commontator
     end
   end
 end
+

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

@@ -0,0 +1,153 @@
+module Commontator
+  class CommentsController < Commontator::ApplicationController
+    before_filter :get_thread, :only => [:new, :create]
+    before_filter :get_comment_and_thread, :except => [:new, :create]
+
+    # GET /threads/1/comments/new
+    def new
+      @comment = Comment.new
+      @comment.thread = @thread
+      @comment.creator = @user
+
+      security_transgression_unless @comment.can_be_created_by?(@user)
+
+      @per_page = params[:per_page] || thread.config.comments_per_page
+
+      respond_to do |format|
+        format.html { redirect_to @thread }
+        format.js
+      end
+     
+    end
+
+    # POST /threads/1/comments
+    def create
+      @comment = Comment.new
+      @comment.body = params[:comment].nil? ? nil : params[:comment][:body]
+      @comment.thread = @thread
+      @comment.creator = @user
+      
+      security_transgression_unless @comment.can_be_created_by?(@user)
+      
+      respond_to do |format|
+        if  !params[:cancel].nil?
+          format.html { redirect_to @thread }
+          format.js { render :cancel }
+        elsif @comment.save
+          sub = @thread.config.thread_subscription.to_sym
+          @thread.subscribe(@user) if sub == :a || sub == :b
+          Subscription.comment_created(@comment)
+
+          @per_page = params[:per_page] || @thread.config.comments_per_page
+
+          format.html { redirect_to @thread }
+          format.js
+        else
+          format.html { redirect_to @thread }
+          format.js { render :new }
+        end
+      end
+    end
+
+    # GET /comments/1/edit
+    def edit
+      security_transgression_unless @comment.can_be_edited_by?(@user)
+
+      respond_to do |format|
+        format.html { redirect_to @thread }
+        format.js
+      end
+    end
+
+    # PUT /comments/1
+    def update
+      security_transgression_unless @comment.can_be_edited_by?(@user)
+      @comment.body = params[:comment].nil? ? nil : params[:comment][:body]
+      @comment.editor = @user
+
+      respond_to do |format|
+        if !params[:cancel].nil?
+          format.html { redirect_to @thread }
+          format.js { render :cancel }
+        elsif @comment.save
+          format.html { redirect_to @thread }
+          format.js
+        else
+          format.html { redirect_to @thread }
+          format.js { render :edit }
+        end
+      end
+    end
+
+    # PUT /comments/1/delete
+    def delete
+      security_transgression_unless @comment.can_be_deleted_by?(@user)
+
+      @comment.errors.add(:base, t('commontator.comment.errors.already_deleted')) \
+        unless @comment.delete_by(@user)
+
+      respond_to do |format|
+        format.html { redirect_to @thread }
+        format.js { render :delete }
+      end
+    end
+    
+    # PUT /comments/1/undelete
+    def undelete
+      security_transgression_unless @comment.can_be_deleted_by?(@user)
+
+      @comment.errors.add(:base, t('commontator.comment.errors.not_deleted')) \
+        unless @comment.undelete_by(@user)
+
+      respond_to do |format|
+        format.html { redirect_to @thread }
+        format.js { render :delete }
+      end
+    end
+    
+    # PUT /comments/1/upvote
+    def upvote
+      security_transgression_unless @comment.can_be_voted_on_by?(@user)
+      
+      @comment.upvote_from @user
+
+      respond_to do |format|
+        format.html { redirect_to @thread }
+        format.js { render :vote }
+      end
+    end
+    
+    # PUT /comments/1/downvote
+    def downvote
+      security_transgression_unless @comment.can_be_voted_on_by?(@user) &&\
+        @comment.thread.config.comment_voting.to_sym == :ld
+      
+      @comment.downvote_from @user
+
+      respond_to do |format|
+        format.html { redirect_to @thread }
+        format.js { render :vote }
+      end
+    end
+    
+    # PUT /comments/1/unvote
+    def unvote
+      security_transgression_unless @comment.can_be_voted_on_by?(@user)
+      
+      @comment.unvote :voter => @user
+
+      respond_to do |format|
+        format.html { redirect_to @thread }
+        format.js { render :vote }
+      end
+    end
+    
+    protected
+    
+    def get_comment_and_thread
+      @comment = Comment.find(params[:id])
+      @thread = @comment.thread
+    end
+  end
+end
+