commenteux 1.1.4 → 1.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f5087e20627c65198f5e44ef8b0387f4d9ea095b
-  data.tar.gz: 64a3804ab387a61368011f669b9886382d15582e
+  metadata.gz: 0288f4275ce3ba72ee01e92d29080061a3873e90
+  data.tar.gz: 54bbf5ab8bc73d47fbbf7526f5a6f8a24f1f59fa
 SHA512:
-  metadata.gz: 4784ec12e2ed90185fdf5bf28852025e4a77722c706d733ff85548bb727a959317df35fef87ebc048029c3d2600f8ce1cc03e9673ca4e17efc6ca47a6b3bd490
-  data.tar.gz: 8eb4cd8a82a9b10c49afc068420ae791842ed8d52a443ef34f9b84a1077c9cec9bf9a5d7bd63ed57cd9eb3d5166fc33952c1caf070b0dc71f8db917790619968
+  metadata.gz: c878f429c2a58fabcd8d5a7db49cb62bb6c1f38a1d831a7878950ecbc58cc24b6e528410a6190188d57f187d889771c9e032e35a037aa9dccba76ef443fcf1ce
+  data.tar.gz: d2586eb868442e13aec8cf359869f0933ca251b352f9ee7b1fe9d99693412bfc4c26a178412dc41a9e1bed886a219b86eac7ef910bc221a61bcd175d3b533803

data/README.rdoc

@@ -50,10 +50,12 @@ Add acts_as_commentable in your model who will have comments
 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&roles=public,private",
+                "/commenteux/client::contract/#{@contract.id}?parent_div=ajax_target&roles=public,private&display_list_notes=true",
                 :id => "notes_tab", :data => {:remote => true} %>
 
 where roles is obligated when specific roles are declared in the model.
+Parameter display_list_notes is optional. The gem will set by default to true. Provides the ability to hide the list of
+comments in the index page if the parameter is false.
 
 With a binding like that in your application.js
 
@@ -63,7 +65,7 @@ With a binding like that in your application.js
     $('#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:
+If specific roles of acts_as_commentable are declared in model, declare their labels under en: like
 
   en:
     public: "Administrator"

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

@@ -1,76 +1,63 @@
-$ () ->
-  $(document).delegate '#new_notes_link', 'click', (e) ->
-    #console.log('new_notes_link click')
-    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)
-    $.ajax
-      url: "/commenteux/" + resource + "/" + id + "/new"
-      type: "get"
-      dataType: "html"
-      data:
-        "parent_div": parent
-        "roles": roles
-      success: (returnData) ->
-        #console.log('success')
-        #console.log("#" + parent)
-        #console.log(returnData)
-        if parent and parent != 'null'
-          $("#" + parent).html(returnData)
-        else
-          #console.log('no parent')
-          $('body').html(returnData)
-        @
-      error: (e) ->
-        alert(e)
-        @
-    @
+$(document).on 'click', '#new_notes_link', (e) ->
+  e.stopPropagation()
+  e.preventDefault()
+  parent = $(@).data('parent')
+  resource = $(@).data('resource')
+  id = $(@).data('id')
+  roles = $(@).data('roles')
+  display_list_notes = $(@).data('display-list-notes')
+  $.ajax
+    url: "/commenteux/" + resource + "/" + id + "/new"
+    type: "get"
+    dataType: "html"
+    data:
+      "parent_div": parent
+      "roles": roles
+      "display_list_notes": display_list_notes
+    success: (returnData) ->
+      if parent and parent != 'null'
+        $("#" + parent).html(returnData)
+      else
+        $('body').html(returnData)
+      @
+    error: (e) ->
+      alert(e)
+      @
+  @
 
-  $(document).delegate '#new_comments', 'ajax:success', (e, data, status, xhr) ->
-    e.stopPropagation()
-    e.preventDefault()
-    #console.log('new_comments ajax success')
-    parent = $('#new_comments').attr('data-parent')
-    if parent and parent != 'null'
-      $('#' + parent).html(xhr.responseText)
-    else
-      $('body').html(xhr.responseText)
+$(document).on 'ajax:success', '#new_comments', (e, data, status, xhr) ->
+  e.stopPropagation()
+  e.preventDefault()
+  parent = $('#new_comments').attr('data-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')
-    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)
-    $.ajax
-      url: "/commenteux/" + resource + "/" + id + "?parent_div=" + parent
-      type: "get"
-      dataType: "html"
-      data:
-        "parent_div": parent
-        "roles": roles
-      success: (returnData) ->
-        #console.log('success')
-        #console.log("#" + parent)
-        #console.log(returnData)
-        if parent
-          $("#" + parent).html(returnData)
-        else
-          #console.log('no parent')
-          $('body').html(returnData)
-        @
-      error: (e) ->
-        alert(e)
-        @
-    @
+$(document).on 'click', '#new_notes_cancelled', (e) ->
+  e.stopPropagation()
+  e.preventDefault()
+  parent = $(@).data('parent')
+  resource = $(@).data('resource')
+  id = $(@).data('id')
+  roles = $(@).data('roles')
+  display_list_notes = $(@).data('display-list-notes')
+  $.ajax
+    url: "/commenteux/" + resource + "/" + id + "?parent_div=" + parent
+    type: "get"
+    dataType: "html"
+    data:
+      "parent_div": parent
+      "roles": roles
+      "display_list_notes": display_list_notes
+    success: (returnData) ->
+      if parent
+        $("#" + parent).html(returnData)
+      else
+        $('body').html(returnData)
+      @
+    error: (e) ->
+      alert(e)
+      @
+  @

data/app/controllers/commenteux/notes_controller.rb

@@ -8,30 +8,23 @@ module Commenteux
       resource = fetch_resource
       @roles = params[:roles]
       list_roles = manage_roles_parameter(params[:roles])
-      @comments = get_comments(resource, list_roles)
+      @display_list_notes = params[:display_list_notes] || "true"
+      @comments = get_comments(resource, list_roles) if @display_list_notes == "true"
       @parent_div = params[:parent_div]
 
-      if request.xhr?
-        render :layout => false
-      end
-
+      render :layout => false if request.xhr?
     end
 
     def new
       resource = fetch_resource
       @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
+      role = @list_roles[0][0] if @list_roles and @list_roles.length > 0
       @comments = get_comment_model_method(resource, role).new
       @parent_div = params[:parent_div]
+      @display_list_notes = params[:display_list_notes] || "true"
 
-      if request.xhr?
-        render :layout => false
-      end
-
+      render :layout => false if request.xhr?
     end
 
     def create
@@ -40,10 +33,10 @@ module Commenteux
       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
+      roles = '&roles=' + params[:roles] if params[:roles]
+      display_list_notes = params[:display_list_notes] || "true"
+
+      redirect_to "/commenteux/#{@resource.downcase}/#{@resource_id}?parent_div=" + @parent_div + roles + "&display_list_notes=#{display_list_notes}"
     end
 
     protected
@@ -78,10 +71,10 @@ module Commenteux
       comments = []
       if roles and roles.length > 0
         roles.each do |role|
-          comments += get_comment_model_method(resource, role[0]).all
+          comments += get_comment_model_method(resource, role[0]).to_a
         end
       else
-        comments = get_comment_model_method(resource, nil).all
+        comments = get_comment_model_method(resource, nil).to_a
       end
       comments
     end

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

@@ -1,39 +1,42 @@
+<% if @display_list_notes == "true" %>
+  <table class="table">
+    <thead>
+    <tr>
+      <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>
 
-<table class="table">
-  <thead>
-  <tr>
-    <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>
-
-  <% @comments.each do |comment| %>
-      <tr>
-        <td>
-          <%= comment.comment %>
-        </td>
-        <td>
-          <%= user_lookup(comment.user_id) %>
-        </td>
-        <td>
-          <%= comment.created_at.in_time_zone('Eastern Time (US & Canada)').strftime("%Y-%m-%d %H:%M:%S") %>
-        </td>
-        <% if display_role?(@roles) %>
+    <% @comments.each do |comment| %>
+        <tr>
+          <td>
+            <%= comment.comment %>
+          </td>
           <td>
-             <%= I18n.t(comment.role) %>
+            <%= user_lookup(comment.user_id) %>
           </td>
-        <% end %>
-      </tr>
-  <% end %>
-</table>
-<br/>
+          <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>
+  <br/>
+<% end %>
 
 <%= link_to "Nouveau", "#", :id => "new_notes_link", :class => 'btn btn-primary',
             :data => {:parent => @parent_div,
                       :resource => @resource.downcase,
                       :id => @resource_id,
-                      :roles => @roles} %>
+                      :roles => @roles,
+                      :display_list_notes => @display_list_notes
+            } %>

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}&roles=#{@roles.blank? ? '' : @roles}",
+<%= simple_form_for @comments, as: 'comments', url: "/commenteux/#{@resource.downcase}/#{@resource_id}?parent_div=#{@parent_div}&roles=#{@roles.blank? ? '' : @roles}&display_list_notes=#{@display_list_notes}",
                     :remote => true, :data => {:parent => @parent_div}, wrapper: :bootstrap do |c| %>
 
     <div style="display:none">
@@ -31,7 +31,8 @@
                       :data => {:parent => @parent_div,
                                 :resource => @resource.downcase,
                                 :id => @resource_id,
-                                :roles => @roles} %>
+                                :roles => @roles,
+                                :display_list_notes => @display_list_notes} %>
 
         </div>
       </div>

data/lib/commenteux/version.rb

@@ -1,3 +1,3 @@
 module Commenteux
-  VERSION = "1.1.4"
+  VERSION = "1.1.5"
 end

data/spec/controllers/commenteux/notes_controller_spec.rb

@@ -42,16 +42,29 @@ module Commenteux
       end
 
       it "si l'appel provient d'un call Ajax, on n'affiche pas de layout" do
-
         expect(DummyModel).to receive(:find).with('1') {@dummy_model}
         expect(@dummy_model).to receive(:comments) {@comments}
-        expect(@comments).to receive(:all) {[]}
+        expect(@comments).to receive(:to_a) {[]}
         xhr :get, 'index', 'resource' => 'dummy_model', 'resource_id' => '1'
 
         assert_template layout: false
 
       end
 
+      it "le paramètre display_list_notes est à false alors les notes ne sont pas recherchées" 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}
+
+        expect(subject).to receive(:manage_roles_parameter).with('comments,delivery_man') {list_roles}
+
+        get 'index', resource: 'dummy_model', resource_id: '1', roles: 'comments,delivery_man', display_list_notes: 'false'
+
+        assert_template layout: 'application'
+      end
+
     end
 
     describe "GET 'new'" do
@@ -104,7 +117,7 @@ module Commenteux
 
         post 'create', 'resource' => 'dummy_model', 'resource_id' => '1', 'parent_div' => 'parent_div', 'comments' => { 'title' => 'Titre', 'comment' => 'Commentaire', 'role' => 'delivery_man'}, 'roles' => 'comments,delivery_man'
 
-        expect(subject).to redirect_to("/commenteux/dummy_model/1?parent_div=parent_div&roles=comments,delivery_man")
+        expect(subject).to redirect_to("/commenteux/dummy_model/1?parent_div=parent_div&roles=comments,delivery_man&display_list_notes=true")
 
       end
 
@@ -116,7 +129,18 @@ module Commenteux
 
         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")
+        expect(subject).to redirect_to("/commenteux/dummy_model/1?parent_div=parent_div&display_list_notes=true")
+      end
+
+      it "Doit créer le commentaire saisi sur la ressource en paramètre, rôle non spécifié et display list notes 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'}, display_list_notes: 'false'
+
+        expect(subject).to redirect_to("/commenteux/dummy_model/1?parent_div=parent_div&display_list_notes=false")
       end
     end
 
@@ -147,10 +171,10 @@ module Commenteux
         comments2 = double("comments2")
 
         expect(@dummy_model).to receive(:send).with('comments_comments') {comments1}
-        expect(comments1).to receive(:all) {[comments1]}
+        expect(comments1).to receive(:to_a) {[comments1]}
 
         expect(@dummy_model).to receive(:send).with('delivery_man_comments') {comments2}
-        expect(comments2).to receive(:all) {[comments2]}
+        expect(comments2).to receive(:to_a) {[comments2]}
 
         comments = controller.send(:get_comments, @dummy_model, [['comments','Admin'],['delivery_man','Livreur']])
 
@@ -162,7 +186,7 @@ module Commenteux
         comments1 = double("comments1")
 
         expect(@dummy_model).to receive(:comments) {comments1}
-        expect(comments1).to receive(:all) {[comments1]}
+        expect(comments1).to receive(:to_a) {[comments1]}
 
         comments = controller.send(:get_comments, @dummy_model, nil)