commenteux 1.1.2 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 672bf6210823405d610640f2dc6eccb8f553852c
-  data.tar.gz: 32ce16e77690438a15feaf95b9b75ffb099821cf
+  metadata.gz: f1e671df55b878d7fbe5a58b5f44de2a38142503
+  data.tar.gz: 030a6567a0510f321234ab9a424f58244eea358c
 SHA512:
-  metadata.gz: e568cdf055aad06b329395df460d416b05318f2210299a0e12c02bc31c0692fb8da1fa7ae02afd7a69587fd1f4c30d17c78dd06c9d8dc445608da62db774ed1c
-  data.tar.gz: 89380d5ac96129f8131bf35ce917c62312924e25be0e364e7e810a7e5fa8c5d60fe00d438acfcfc1bd7d2fe00f3f5f999bcb784ec77b35fed5e98f1bdd409219
+  metadata.gz: e5ef9c7633f91ad572074481bb8f9e0f28a10cca5e82eed9776ece971bf5c2f410d1727c2cb2395e389f05346d5ee196b9e619e9c20f0ed9476992bf73bc5da6
+  data.tar.gz: 8917b3a7be7a7c277c30193a870fcc9e81aa825a3f8fe179e9764debe52a2977ad2ec73c5330f5790b522e446830561d9e2141e4ba3ec47d725492d83ad8f887

data/README.rdoc

@@ -33,6 +33,13 @@ The routes that will be available are :
 where :resource is the name of your model (you can use namespace)
 
 
+==== Model
+Add acts_as_commentable in your model who will have comments
+
+    acts_as_commentable :private, :public
+
+:private, :public are a example if specific role needed.
+
 ====Include the needed javascript file in your application.js or application.js.coffee
 
 ==== Javascript
@@ -43,9 +50,11 @@ where :resource is the name of your model (you can use namespace)
 Call url of commenteux screens, for exemple, like that:
 
   <%= link_to "<i class='icon-file-text text-blue'></i> Notes".html_safe,
-                "/commenteux/client::contract/#{@contract.id}?parent_div=ajax_target",
+                "/commenteux/client::contract/#{@contract.id}?parent_div=ajax_target&roles=public,private",
                 :id => "notes_tab", :data => {:remote => true} %>
 
+where roles is obligated when specific roles are declared in the model.
+
 With a binding like that in your application.js
 
   $(document).delegate '#notes_tab', 'ajax:success', (e, data, status, xhr) ->
@@ -53,6 +62,13 @@ With a binding like that in your application.js
     $('#notes_tab_header').addClass('active')
     $('#ajax_target').html(xhr.responseText)
 
+==== Rails Internationalization (en.yml)
+If specific roles of acts_as_commentable are declared in model, declare their labels under en: like that:
+
+  en:
+    public: "Administrator"
+    private: "Delivery man"
+
 
 == Credits
 
@@ -64,6 +80,8 @@ With a binding like that in your application.js
 
 {Rémi Gagnon}[http://github.com/rgagnon]
 
+{Nicolas Demers}[http://github.com/nickdemers]
+
 == More
 
 http://www.groupefungo.ca

data/app/assets/javascripts/commenteux/application.js.coffee

@@ -1,13 +1,12 @@
-
 $ () ->
-
   $(document).delegate '#new_notes_link', 'click', (e) ->
     #console.log('new_notes_link click')
-    event.stopPropagation()
-    event.preventDefault()
-    parent= $(@).data('parent')
-    resource =  $(@).data('resource')
+    e.stopPropagation()
+    e.preventDefault()
+    parent = $(@).data('parent')
+    resource = $(@).data('resource')
     id = $(@).data('id')
+    roles = $(@).data('roles')
     #console.log('parent_div = ' + parent)
     #console.log('resource = ' + resource)
     #console.log('resource_id = ' + id)
@@ -17,12 +16,13 @@ $ () ->
       dataType: "html"
       data:
         "parent_div": parent
+        "roles": roles
       success: (returnData) ->
         #console.log('success')
         #console.log("#" + parent)
         #console.log(returnData)
-        if parent
-          $("#" + parent ).html(returnData)
+        if parent and parent != 'null'
+          $("#" + parent).html(returnData)
         else
           #console.log('no parent')
           $('body').html(returnData)
@@ -33,22 +33,23 @@ $ () ->
     @
 
   $(document).delegate '#new_comments', 'ajax:success', (e, data, status, xhr) ->
-    event.stopPropagation()
-    event.preventDefault()
+    e.stopPropagation()
+    e.preventDefault()
     #console.log('new_comments ajax success')
     parent = $('#new_comments').attr('data-parent')
-    if parent
+    if parent and parent != 'null'
       $('#' + parent).html(xhr.responseText)
     else
       $('body').html(xhr.responseText)
 
   $(document).delegate '#new_notes_cancelled', 'click', (e) ->
     #console.log('new_notes_cancelled click')
-    event.stopPropagation()
-    event.preventDefault()
-    parent= $(@).data('parent')
-    resource =  $(@).data('resource')
+    e.stopPropagation()
+    e.preventDefault()
+    parent = $(@).data('parent')
+    resource = $(@).data('resource')
     id = $(@).data('id')
+    roles = $(@).data('roles')
     #console.log('parent_div = ' + parent)
     #console.log('resource = ' + resource)
     #console.log('resource_id = ' + id)
@@ -58,12 +59,13 @@ $ () ->
       dataType: "html"
       data:
         "parent_div": parent
+        "roles": roles
       success: (returnData) ->
         #console.log('success')
         #console.log("#" + parent)
         #console.log(returnData)
         if parent
-          $("#" + parent ).html(returnData)
+          $("#" + parent).html(returnData)
         else
           #console.log('no parent')
           $('body').html(returnData)

data/app/controllers/commenteux/notes_controller.rb

@@ -2,16 +2,30 @@ require_dependency "commenteux/application_controller"
 
 module Commenteux
   class NotesController < ApplicationController
+    helper UsersHelper
+
+    def index
+      resource = fetch_resource
+      @roles = params[:roles]
+      list_roles = manage_roles_parameter(params[:roles])
+      @comments = get_comments(resource, list_roles)
+      @parent_div = params[:parent_div]
+
+      if request.xhr?
+        render :layout => false
+      end
 
-    def comments_params
-      comments_permit_fields = [:title, :comment, :user_id]
-      params.require(:comments).permit(
-          comments_permit_fields)
     end
 
-    def index
+    def new
       resource = fetch_resource
-      @comments = resource.comments.all
+      @roles = params[:roles]
+      @list_roles = manage_roles_parameter(params[:roles])
+      role = nil
+      if @list_roles and @list_roles.length > 0
+       role = @list_roles[0][0]
+      end
+      @comments = get_comment_model_method(resource, role).new
       @parent_div = params[:parent_div]
 
       if request.xhr?
@@ -20,6 +34,25 @@ module Commenteux
 
     end
 
+    def create
+      resource = fetch_resource
+      comments_params
+      get_comment_model_method(resource, params[:comments][:role]).create(comments_params)
+      @parent_div = params[:parent_div]
+      roles = ''
+      if params[:roles]
+        roles = '&roles=' + params[:roles]
+      end
+      redirect_to "/commenteux/#{@resource.downcase}/#{@resource_id}?parent_div=" + @parent_div + roles
+    end
+
+    protected
+    def comments_params
+      comments_permit_fields = [:title, :comment, :user_id, :role, :roles]
+      params.require(:comments).permit(
+          comments_permit_fields)
+    end
+
     def fetch_resource
       @resource = params[:resource]
       @class_name = classify_namespace(params[:resource])
@@ -41,22 +74,37 @@ module Commenteux
       const
     end
 
-    def new
-      resource = fetch_resource
-      @comments = resource.comments.new
-      @parent_div = params[:parent_div]
-
-      if request.xhr?
-        render :layout => false
+    def get_comments(resource, roles)
+      comments = []
+      if roles and roles.length > 0
+        roles.each do |role|
+          comments += get_comment_model_method(resource, role[0]).all
+        end
+      else
+        comments = get_comment_model_method(resource, nil).all
       end
+      comments
+    end
 
+    def get_comment_model_method(resource, role)
+      if role
+        role_comments = role + "_comments"
+      else
+        role_comments = "comments"
+      end
+      resource.send(role_comments)
     end
 
-    def create
-      resource = fetch_resource
-      resource.comments.create(comments_params)
-      @parent_div = params[:parent_div]
-      redirect_to "/commenteux/#{@resource.downcase}/#{@resource_id}?parent_div=" + @parent_div
+    def manage_roles_parameter(roles_parameter)
+      roles = []
+      if roles_parameter and roles_parameter.include?(',')
+        splitted = roles_parameter.split(',')
+        for str in splitted do
+          values = [str, I18n.t(str)]
+          roles << values
+        end
+      end
+      roles
     end
 
   end

data/app/helpers/commenteux/notes_helper.rb

@@ -1,9 +1,11 @@
 module Commenteux
   module NotesHelper
 
-    def user_lookup(user_id)
-      if user_id
-        User.find(user_id).name
+    def display_role?(roles)
+      if roles and roles.length > 0
+        true
+      else
+        false
       end
     end
 

data/app/helpers/commenteux/users_helper.rb

@@ -0,0 +1,11 @@
+module Commenteux
+  module UsersHelper
+
+    def user_lookup(user_id)
+      if user_id
+        User.find(user_id).name
+      end
+    end
+
+  end
+end

data/app/views/commenteux/notes/index.html.erb

@@ -2,9 +2,12 @@
 <table class="table">
   <thead>
   <tr>
-    <th>Commentaire</th>
-    <th>Fait par</th>
-    <th>Date</th>
+    <th class="col-md-6">Commentaire</th>
+    <th class="col-md-2">Fait par</th>
+    <th class="col-md-2">Date</th>
+    <% if display_role?(@roles) %>
+      <th class="col-md-2">Rôle</th>
+    <% end %>
   </tr>
   </thead>
 
@@ -19,6 +22,11 @@
         <td>
           <%= comment.created_at.in_time_zone('Eastern Time (US & Canada)').strftime("%Y-%m-%d %H:%M:%S") %>
         </td>
+        <% if display_role?(@roles) %>
+          <td>
+             <%= I18n.t(comment.role) %>
+          </td>
+        <% end %>
       </tr>
   <% end %>
 </table>
@@ -27,4 +35,5 @@
 <%= link_to "Nouveau", "#", :id => "new_notes_link", :class => 'btn btn-primary',
             :data => {:parent => @parent_div,
                       :resource => @resource.downcase,
-                      :id => @resource_id } %>
+                      :id => @resource_id,
+                      :roles => @roles} %>

data/app/views/commenteux/notes/new.html.erb

@@ -1,4 +1,4 @@
-<%= simple_form_for @comments, as: 'comments', url: "/commenteux/#{@resource.downcase}/#{@resource_id}?parent_div=#{@parent_div}",
+<%= simple_form_for @comments, as: 'comments', url: "/commenteux/#{@resource.downcase}/#{@resource_id}?parent_div=#{@parent_div}&roles=#{@roles.blank? ? '' : @roles}",
                     :remote => true, :data => {:parent => @parent_div}, wrapper: :bootstrap do |c| %>
 
     <div style="display:none">
@@ -11,6 +11,14 @@
         </div>
     <% end %>
 
+    <% unless @list_roles.blank? %>
+
+      <%= c.input :role, collection: @list_roles, as: :radio_buttons, :label_method => :last, :value_method => :first,
+                  :input_html => {:data => {:required => true}}, label: 'Rôle',
+                  :item_wrapper_class => 'inline' %>
+
+    <% end %>
+
     <div class="form-actions form-actions-padding-sm">
       <div class="row">
         <div class="col-md-10 col-md-offset-5">
@@ -22,7 +30,8 @@
           <%= link_to "Annuler", "#", :id => "new_notes_cancelled", :class => 'btn',
                       :data => {:parent => @parent_div,
                                 :resource => @resource.downcase,
-                                :id => @resource_id } %>
+                                :id => @resource_id,
+                                :roles => @roles} %>
 
         </div>
       </div>

data/config/cucumber.yml

@@ -2,7 +2,9 @@
 rerun = File.file?('rerun.txt') ? IO.read('rerun.txt') : ""
 rerun_opts = rerun.to_s.strip.empty? ? "--format #{ENV['CUCUMBER_FORMAT'] || 'progress'} features" : "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} #{rerun}"
 std_opts = "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} --strict --tags ~@wip"
+#std_opts = "-r features/support/ -r features/step_definitions --format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} --strict --tags ~@wip"
 %>
 default: <%= std_opts %> features
 wip: --tags @wip:3 --wip features
 rerun: <%= rerun_opts %> --format rerun --out rerun.txt --strict --tags ~@wip
+

data/lib/commenteux/version.rb

@@ -1,3 +1,3 @@
 module Commenteux
-  VERSION = "1.1.2"
+  VERSION = "1.1.3"
 end

data/spec/controllers/commenteux/notes_controller_spec.rb

@@ -1,7 +1,8 @@
 require 'spec_helper'
 
+
 module Commenteux
-  describe NotesController do
+  describe Commenteux::NotesController do
     routes { Commenteux::Engine.routes }
 
     before(:each) do
@@ -11,22 +12,40 @@ module Commenteux
 
     describe "GET 'index'" do
 
-      it "doit fetché la ressource passé en paramètre, le layout de l'application hôte sera utilisé" do
+      it "doit fetché la ressource passé en paramètre, le layout de l'application hôte sera utilisé, avec le paramètre rôle" do
+        comment_comments = double("comment_comments")
+        delivery_man_comments = double("delivery_man_comments")
+        list_roles = [comment_comments, delivery_man_comments]
+
+        expect(DummyModel).to receive(:find).with('1') {@dummy_model}
 
-        DummyModel.should_receive(:find).with('1').and_return(@dummy_model)
-        @dummy_model.stub(:comments) { @comments }
-        @comments.stub(:all) { [] }
-        get 'index', 'resource' => 'dummy_model', 'resource_id' => '1'
+        expect(subject).to receive(:manage_roles_parameter).with('comments,delivery_man') {list_roles}
+        expect(subject).to receive(:get_comments).with(@dummy_model, list_roles) {[comment_comments, delivery_man_comments]}
+
+        get 'index', resource: 'dummy_model', resource_id: '1', roles: 'comments,delivery_man'
 
         assert_template layout: 'application'
+      end
+
+      it "doit fetché la ressource passé en paramètre, le layout de l'application hôte sera utilisé, sans le paramètre rôle" do
+        comment_comments = double("comment_comments")
+        delivery_man_comments = double("delivery_man_comments")
+
+        expect(DummyModel).to receive(:find).with('1') {@dummy_model}
+
+        expect(subject).to receive(:manage_roles_parameter).with(nil) {[]}
+        expect(subject).to receive(:get_comments).with(@dummy_model, []) {[comment_comments, delivery_man_comments]}
 
+        get 'index', resource: 'dummy_model', resource_id: '1'
+
+        assert_template layout: 'application'
       end
 
       it "si l'appel provient d'un call Ajax, on n'affiche pas de layout" do
 
-        DummyModel.should_receive(:find).with('1').and_return(@dummy_model)
-        @dummy_model.stub(:comments) { @comments }
-        @comments.stub(:all) { [] }
+        expect(DummyModel).to receive(:find).with('1') {@dummy_model}
+        expect(@dummy_model).to receive(:comments) {@comments}
+        expect(@comments).to receive(:all) {[]}
         xhr :get, 'index', 'resource' => 'dummy_model', 'resource_id' => '1'
 
         assert_template layout: false
@@ -37,11 +56,11 @@ module Commenteux
 
     describe "GET 'new'" do
 
-      it "doit fetché la ressource en paramètre et préparé le nouveau commentaire a saisir, le layout de l'application hôte sera utilisé" do
+      it "doit fetché la ressource en paramètre et préparé le nouveau commentaire a saisir, le layout de l'application hôte sera utilisé, sans le paramètre rôle" do
 
-        subject.should_receive(:fetch_resource).and_return(@dummy_model)
-        @dummy_model.stub(:comments) { @comments }
-        @comments.should_receive(:new)
+        expect(subject).to receive(:fetch_resource) {@dummy_model}
+        expect(@dummy_model).to receive(:send).with('comments') {@comments}
+        expect(@comments).to receive(:new)
 
         get 'new', 'resource' => 'dummy_model', 'resource_id' => '1'
 
@@ -49,11 +68,23 @@ module Commenteux
 
       end
 
+      it "doit fetché la ressource en paramètre et préparé le nouveau commentaire a saisir, le layout de l'application hôte sera utilisé, avec le paramètre rôle" do
+
+        expect(subject).to receive(:fetch_resource) {@dummy_model}
+        expect(@dummy_model).to receive(:send).with('comments_comments') {@comments}
+        expect(@comments).to receive(:new)
+
+        get 'new', 'resource' => 'dummy_model', 'resource_id' => '1', 'roles' => 'comments,delivery_man'
+
+        assert_template layout: 'application'
+
+      end
+
       it "si l'appel provient d'un call Ajax, on n'affiche pas de layout" do
 
-        subject.should_receive(:fetch_resource).and_return(@dummy_model)
-        @dummy_model.stub(:comments) { @comments }
-        @comments.should_receive(:new)
+        expect(subject).to receive(:fetch_resource) {@dummy_model}
+        expect(@dummy_model).to receive(:send).with('comments') {@comments}
+        expect(@comments).to receive(:new)
 
         xhr :get, 'new', 'resource' => 'dummy_model', 'resource_id' => '1'
 
@@ -65,30 +96,109 @@ module Commenteux
 
     describe "POST 'create'" do
 
-      it "Doit créer le commentaire saisi sur la ressource en paramètre" do
+      it "Doit créer le commentaire saisi sur la ressource en paramètre, rôle spécifié en paramètre" do
+
+        expect(DummyModel).to receive(:find).with('1') {@dummy_model}
+        expect(@dummy_model).to receive(:send).with('delivery_man_comments') {@comments}
+        expect(@comments).to receive(:create).with({ 'title' => 'Titre', 'comment' => 'Commentaire', 'role' => 'delivery_man'})
 
-        DummyModel.should_receive(:find).with('1').and_return(@dummy_model)
-        @dummy_model.stub(:comments) { @comments }
-        @comments.should_receive(:create).with( { 'title' => 'Titre', 'comment' => 'Commentaire'} )
+        post 'create', 'resource' => 'dummy_model', 'resource_id' => '1', 'parent_div' => 'parent_div', 'comments' => { 'title' => 'Titre', 'comment' => 'Commentaire', 'role' => 'delivery_man'}, 'roles' => 'comments,delivery_man'
 
-        post 'create', 'resource' => 'dummy_model', 'resource_id' => '1', 'parent_div' => 'parent_div', :comments => { :title => 'Titre', :comment => 'Commentaire'}
+        expect(subject).to redirect_to("/commenteux/dummy_model/1?parent_div=parent_div&roles=comments,delivery_man")
 
       end
 
+      it "Doit créer le commentaire saisi sur la ressource en paramètre, rôle non spécifié en paramètre" do
+
+        expect(DummyModel).to receive(:find).with('1') {@dummy_model}
+        expect(@dummy_model).to receive(:send).with('comments') {@comments}
+        expect(@comments).to receive(:create).with({ 'title' => 'Titre', 'comment' => 'Commentaire'})
+
+        post 'create', 'resource' => 'dummy_model', 'resource_id' => '1', 'parent_div' => 'parent_div', 'comments' => { 'title' => 'Titre', 'comment' => 'Commentaire'}
+
+        expect(subject).to redirect_to("/commenteux/dummy_model/1?parent_div=parent_div")
+      end
     end
 
     describe "Comportement de la méthode 'classify_namespace'" do
 
       it "s'il n'y a pas de namespace, on fait un simple classify" do
-        subject.classify_namespace('dummy_model').should eq 'DummyModel'
-        subject.classify_namespace('customer').should eq 'Customer'
+        dummyModel = controller.send(:classify_namespace, 'dummy_model')
+        expect(dummyModel).to eq 'DummyModel'
+
+        customer = controller.send(:classify_namespace, 'customer')
+        expect(customer).to eq 'Customer'
       end
 
       it "s'il y a un namespace, on fait un classify sur tous les éléments" do
-        subject.classify_namespace('client::customers').should eq 'Client::Customer'
-        subject.classify_namespace('namespace::dummy_model').should eq 'Namespace::DummyModel'
+        customer = controller.send(:classify_namespace, 'client::customers')
+        expect(customer).to eq 'Client::Customer'
+
+        dummyModel = controller.send(:classify_namespace, 'namespace::dummy_model')
+        expect(dummyModel).to eq 'Namespace::DummyModel'
+      end
+
+    end
+
+    describe "Comportement de la méthode 'get_comments'" do
+
+      it "s'il y a plusieurs roles de spécifiés" do
+        comments1 = double("comments1")
+        comments2 = double("comments2")
+
+        expect(@dummy_model).to receive(:send).with('comments_comments') {comments1}
+        expect(comments1).to receive(:all) {[comments1]}
+
+        expect(@dummy_model).to receive(:send).with('delivery_man_comments') {comments2}
+        expect(comments2).to receive(:all) {[comments2]}
+
+        comments = controller.send(:get_comments, @dummy_model, [['comments','Admin'],['delivery_man','Livreur']])
+
+        expect(comments[0]).to eq comments1
+        expect(comments[1]).to eq comments2
+      end
+
+      it "s'il y a aucun role de spécifié" do
+        comments1 = double("comments1")
+
+        expect(@dummy_model).to receive(:comments) {comments1}
+        expect(comments1).to receive(:all) {[comments1]}
+
+        comments = controller.send(:get_comments, @dummy_model, nil)
+
+        expect(comments[0]).to eq comments1
+      end
+
+    end
+
+    describe "Comportement de la méthode 'get_comment_method'" do
+
+      it "s'il y a un rôle spécifié" do
+        expect(@dummy_model).to receive(:send).with("delivery_man_comments") {@comments}
+        controller.send(:get_comment_model_method, @dummy_model, "delivery_man")
       end
 
+      it "s'il n'y a pas de rôle spécifié" do
+        expect(@dummy_model).to receive(:send).with("comments") {@comments}
+        controller.send(:get_comment_model_method, @dummy_model, nil)
+      end
+
+    end
+
+    describe "Comportement de la méthode 'manage_roles_parameter'" do
+     it "avec paramètres" do
+       list_roles = controller.send(:manage_roles_parameter, 'comments,delivery_man')
+
+       expect(list_roles).to eq [['comments','Administrateur'],['delivery_man','Livreur']]
+      end
+    end
+
+    describe "Comportement de la méthode 'manage_roles_parameter'" do
+      it "sans paramètre" do
+        list_roles = controller.send(:manage_roles_parameter, nil)
+
+        expect(list_roles).to eq []
+      end
     end
 
   end

data/spec/dummy/app/models/dummy_model.rb

@@ -1,3 +1,3 @@
 class DummyModel < ActiveRecord::Base
-  acts_as_commentable
+  acts_as_commentable :delivery_man, :comments
 end

data/spec/dummy/app/models/dummy_no_role_model.rb

@@ -0,0 +1,3 @@
+class DummyNoRoleModel < ActiveRecord::Base
+  acts_as_commentable
+end

data/spec/dummy/config/locales/en.yml

@@ -21,3 +21,5 @@
 
 en:
   hello: "Hello world"
+  comments: "Administrateur"
+  delivery_man: "Livreur"

data/spec/dummy/db/migrate/20150612102101_create_dummy_no_role_models.rb

@@ -0,0 +1,10 @@
+class CreateDummyNoRoleModels < ActiveRecord::Migration
+  def change
+    create_table :dummy_no_role_models do |t|
+
+      t.text :text
+
+      t.timestamps
+    end
+  end
+end

data/spec/dummy/db/schema.rb

@@ -11,7 +11,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20140312000846) do
+ActiveRecord::Schema.define(version: 20150612102101) do
 
   create_table "comments", force: true do |t|
     t.string   "title",            limit: 50, default: ""
@@ -34,4 +34,10 @@ ActiveRecord::Schema.define(version: 20140312000846) do
     t.datetime "updated_at"
   end
 
+  create_table "dummy_no_role_models", force: true do |t|
+    t.text     "text"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
 end