commontator 4.10.5 → 4.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 35cb6a59267e1597636ccbd546b34d781ca940ce
-  data.tar.gz: a5d8730f0f7c1bb4835781cacd4a619c928da9db
+  metadata.gz: 060c9423cbec58969dbbf6957a0f186a0bf6c3b5
+  data.tar.gz: 18684e3ebf3d9bfde025154d6e557cf628d123e1
 SHA512:
-  metadata.gz: f321c9fc6ca3c40e739905ddf127290838740ea994274639c1c361f93cddc19fbd12c3c9bc695c55ce525192d0fb1c75a01969d99d3465a3fafac9df9fd04daa
-  data.tar.gz: e666f726a69be8a5dac830cd590fbe4cb6e2bede38f63421c8e90c88a4f467a7659d52c72b19eb85dc6e7f895aa5004e004a133ae6aee49ffc1e9051093f1d46
+  metadata.gz: 189a5502659f64239702c9bd805f479a21a93b57c01aacb7bc50892ddedda693ff4ff1f011bb525d2bdeab04dfd751c36a47f2f522d424c5d4a20b2d32d3de1b
+  data.tar.gz: e256734e04028203d3aee190986678d2254e084ccb6eb69bdbfe063f4c36746d74c4580a5382ce87f4dbe1876f9b72533eec6ac652539882ce98d0ab0148a2a4

data/README.md

@@ -58,7 +58,7 @@ There are 4 steps you must follow to install commontator:
 
 4. Routes
 
-  Add this line to your Rails application's routes file:
+  Add this line to your Rails application's `routes.rb` file:
 
   ```rb
   mount Commontator::Engine => '/commontator'
@@ -66,6 +66,15 @@ There are 4 steps you must follow to install commontator:
 
   You can change the mount path if you would like a different one.
 
+5. Stylesheets
+
+  In order to display comment threads properly,
+  you must add the following to your `application.css`:
+
+  ```css
+  *= require commontator/application
+  ```
+
 ## Usage
 
 Follow the steps below to add commontator to your models and views:
@@ -107,7 +116,7 @@ Follow the steps below to add commontator to your models and views:
   In that case, just add the following method call to the controller action that displays the page in question:
 
   ```rb
-  commontator_thread_show(commontable)
+  commontator_thread_show(@commontable)
   ```
 
   Note that the call to `commontator_thread` in the view is still necessary in either case.
@@ -127,6 +136,8 @@ If sending emails, remember to add your host URL's to your environment files
 config.action_mailer.default_url_options = { :host => "www.example.com" }
 ```
 
+Batch sending through Mailgun is also supported.
+
 ## Voting
 
 You can allow users to vote on each others' comments by adding the `acts_as_votable` gem to your gemfile:
@@ -141,9 +152,44 @@ And enabling the relevant option in commontator's initializer:
 config.comment_voting = :ld # See the initializer for available options
 ```
 
+## Mentions
+
+You can allow users to mention other users in the comments.
+Mentioned users are automatically subscribed to the thread and receive email notifications.
+
+First add the following to your application.js file:
+
+```js
+//= require commontator/application
+```
+
+Then enable mentions in commontator's initializer:
+
+```rb
+config.mentions_enabled = true
+```
+
+Finally configure the user_mentions_proc, which receives the current user
+and the search query inputted by that user and should return a relation
+containing the users that can be mentioned and match the query string:
+ 
+```rb
+config.user_mentions_proc = lambda { |current_user, query| ... }
+```
+
+Please be aware that with mentions enabled, any registered user
+can use the `user_mentions_proc` to search for other users.
+Make sure to properly escape SQL in this proc and to not allow searches on sensitive fields.
+
+Use '@' with at least three other characters to mention someone in a new/edited comment.
+
+The mentions script assumes that commontator is mounted at `/commontator`,
+so make sure that is indeed the case if you plan to use mentions.
+
 ## Browser Support
 
 Commontator should work properly on any of the major browsers.
+The mentions functionality won't work with IE before version 8.
 To function properly, this gem requires that visitors to the site have javascript enabled.
 
 ## Customization

data/Rakefile

@@ -1,23 +1,22 @@
 #!/usr/bin/env rake
-
+# http://viget.com/extend/rails-engine-testing-with-rspec-capybara-and-factorygirl
 begin
   require 'bundler/setup'
 rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+APP_RAKEFILE = File.expand_path('../spec/dummy/Rakefile', __FILE__)
 load 'rails/tasks/engine.rake'
 
 Bundler::GemHelper.install_tasks
 
-begin
-  require 'rspec/core/rake_task'
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
 
-  RSpec::Core::RakeTask.new(:spec)
+require 'rspec/core'
+require 'rspec/core/rake_task'
 
-  task :default => :spec
-rescue LoadError
-  # no rspec available
-end
+desc 'Run all specs in spec directory (excluding plugin specs)'
+RSpec::Core::RakeTask.new(spec: 'app:db:test:prepare')
 
+task default: :spec

data/app/assets/javascripts/commontator/application.js

@@ -0,0 +1,3 @@
+//= require underscore/underscore
+//= require mentionsInput/jquery.mentionsInput
+//= require commontator/mentions

data/app/assets/javascripts/commontator/application.js~

@@ -0,0 +1,3 @@
+//= require underscore/underscore
+//= require jquery.mentionsInput
+//= require commontator/mentions

data/app/assets/javascripts/commontator/mentions.js

@@ -0,0 +1,32 @@
+window.Commontator = {};
+Commontator._ = window._.noConflict();
+Commontator.initMentions = function() {
+    $('.comment_form_field textarea:not(.mentions-added)').each(function(_index, textarea){
+        $textarea = $(textarea);
+        $form = $textarea.parents('form');
+        threadId = $textarea.parents('.thread').attr('id').match(/[\d]+/)[0];
+        $textarea.addClass('mentions-added');
+        currentValue = $textarea.val();
+        $textarea.mentionsInput({
+            elastic: false,
+            showAvatars: false,
+            allowRepeat: true,
+            minChars: 3,
+            onDataRequest:function (mode, query, callback) {
+                $.getJSON('/commontator/threads/'+threadId+'/mentions.json', {q: query}, function(responseData) {
+                    callback.call(this, responseData.mentions);
+                });
+            }
+        });
+        $textarea.val(currentValue);
+        $textarea.on('focusout', function(){
+            $textarea.mentionsInput('getMentions', function(mentions){
+                $form.find('input[name="mentioned_ids[]"]').remove();
+                $(mentions).each(function(_index, mention){
+                    $input = $('<input>', { type: 'hidden', name: 'mentioned_ids[]', value: mention.id });
+                    $form.append($input)
+                });
+            });
+        });
+    });
+};

data/app/assets/javascripts/commontator/mentions.js~

@@ -0,0 +1,31 @@
+window.Commontator = {};
+Commontator._ = window._.noConflict();
+Commontator.initMentions = function() {
+    $('.comment_form_field textarea:not(.mentions-added)').each(function(_index, textarea){
+        $textarea = $(textarea);
+        $form = $textarea.parents('form');
+        threadId = $textarea.parents('.thread').attr('id').match(/[\d]+/)[0];
+        $textarea.addClass('mentions-added');
+        currentValue = $textarea.val();
+        $textarea.mentionsInput({
+            elastic: false,
+            showAvatars: false,
+            allowRepeat: true,
+            onDataRequest:function (mode, query, callback) {
+                $.getJSON('commontator/threads/'+threadId+'/mentions.json', {q: query}, function(responseData) {
+                    callback.call(this, responseData.mentions);
+                });
+            }
+        });
+        $textarea.val(currentValue);
+        $textarea.on('focusout', function(){
+            $textarea.mentionsInput('getMentions', function(mentions){
+                $form.find('input[name="mentioned_ids[]"]').remove();
+                $(mentions).each(function(_index, mention){
+                    $input = $('<input>', { type: 'hidden', name: 'mentioned_ids[]', value: mention.id });
+                    $form.append($input)
+                });
+            });
+        });
+    });
+};

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

@@ -1,13 +1,5 @@
 /*
- * This is a manifest file that'll be compiled into application.css, which will include all the files
- * listed below.
- *
- * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
- * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
- *
- * You're free to add application-wide styles to this file and they'll appear at the top of the
- * compiled file, but it's generally better to create a new file per style scope.
- *
  *= require_self
+ *= require mentionsInput/jquery.mentionsInput
  *= require_tree .
  */

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

@@ -0,0 +1,14 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require mentionsInput/jquery.mentionsInput
+ *= require_tree .
+ */

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

@@ -64,3 +64,8 @@ http://www.strangerstudios.com/sandbox/pagination/diggstyle.php */
 
   color: #DDD;
 }
+
+.thread .mentions-input-box .mentions {
+  left: -2px !important;
+  top: -2px !important;
+}

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

@@ -0,0 +1,71 @@
+.thread {
+  display: block !important;
+}
+
+.thread .commontator_hidden {
+  display: none;
+}
+
+.thread_actions {
+  float: right;
+}
+
+.thread_header {
+  font-size: 16px;
+  font-weight: bold;
+  font-style: normal;
+  margin-top: 5px;
+  margin-bottom: 5px;
+  display: block;
+}
+
+/* Modified from:
+http://www.strangerstudios.com/sandbox/pagination/diggstyle.php */
+.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-right: 4px;
+	border: 1px solid #999;
+	
+	text-decoration: none;
+	color: #666;
+}
+
+.thread_pagination a:hover,
+.thread_pagination a:active {
+	border: 1px solid #555;
+
+	color: #000;
+}
+
+.thread_pagination em {
+	padding: 2px 5px 2px 5px;
+	margin-right: 4px;
+  border: 1px solid #555;
+
+  font-weight: bold;
+  background-color: #555;
+  color: #FFF;
+}
+
+.thread_pagination span {
+  padding: 2px 5px 2px 5px;
+	margin-right: 4px;
+  border: 1px solid #EEE;
+
+  color: #DDD;
+}
+
+.thread .mentions-input-box .mentions {
+    left: -2px !important;
+    top: -2px !important;
+}

data/app/controllers/commontator/comments_controller.rb

@@ -26,6 +26,7 @@ module Commontator
       @comment.creator = @user
       @comment.body = params[:comment].nil? ? nil : params[:comment][:body]
       security_transgression_unless @comment.can_be_created_by?(@user)
+      subscribe_mentioned if Commontator.mentions_enabled
       
       respond_to do |format|
         if  !params[:cancel].nil?
@@ -62,6 +63,7 @@ module Commontator
       security_transgression_unless @comment.can_be_edited_by?(@user)
       @comment.body = params[:comment].nil? ? nil : params[:comment][:body]
       @comment.editor = @user
+      subscribe_mentioned if Commontator.mentions_enabled
 
       respond_to do |format|
         if !params[:cancel].nil?
@@ -147,5 +149,11 @@ module Commontator
       @thread = @comment.thread
       commontator_set_new_comment(@thread, @user)
     end
+
+    def subscribe_mentioned
+      Commontator.commontator_mentions(@user, '').where(id: params[:mentioned_ids]).each do |user|
+        @thread.subscribe(user)
+      end
+    end
   end
 end

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

@@ -0,0 +1,160 @@
+module Commontator
+  class CommentsController < Commontator::ApplicationController
+    before_filter :set_thread, :only => [:new, :create]
+    before_filter :set_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.thread = @thread
+      @comment.creator = @user
+      @comment.body = params[:comment].nil? ? nil : params[:comment][:body]
+      security_transgression_unless @comment.can_be_created_by?(@user)
+      subscribe_mentioned if Commontator.mentions_enabled
+      
+      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
+      subscribe_mentioned if Commontator.mentions_enabled
+
+      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 set_comment_and_thread
+      @comment = Comment.find(params[:id])
+      @thread = @comment.thread
+      commontator_set_new_comment(@thread, @user)
+    end
+
+    def subscribe_mentioned
+      debugger
+      Commontator.commontator_mentions(@user, '').where(id: params[:mentioned_ids]).each do |user|
+        @thread.subscribe(user)
+      end
+    end
+  end
+end