commenteux 1.1.5 → 1.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0288f4275ce3ba72ee01e92d29080061a3873e90
-  data.tar.gz: 54bbf5ab8bc73d47fbbf7526f5a6f8a24f1f59fa
+  metadata.gz: 807c2eb92b935d1de6dc7117237114e6cee6d769
+  data.tar.gz: fe25e73bd9a16cd6c8712234989b35f1e5530665
 SHA512:
-  metadata.gz: c878f429c2a58fabcd8d5a7db49cb62bb6c1f38a1d831a7878950ecbc58cc24b6e528410a6190188d57f187d889771c9e032e35a037aa9dccba76ef443fcf1ce
-  data.tar.gz: d2586eb868442e13aec8cf359869f0933ca251b352f9ee7b1fe9d99693412bfc4c26a178412dc41a9e1bed886a219b86eac7ef910bc221a61bcd175d3b533803
+  metadata.gz: dafbc3acda121503f9d438efe9ab38c22f55fa9ca3eebe4ec854667b86e466665020aa5de4ec6c042d91083cfb6c2bcb768ca4d8c6a2ff0787d1f64909fde33c
+  data.tar.gz: 6c71163ab626e03768e6e7e84915189c99f3426b1aa155f4b2d1b11575ebbf0673886eccdde126462e76354d4ca7402dbd2608617f916d1bb39c4e5bded611c6

data/README.rdoc

@@ -26,9 +26,12 @@ Mount the commenteux gem in your routes:
 
 The routes that will be available are :
 
-       GET  /commenteux/:resource/:resource_id(.:format)     commenteux/notes#index
-       GET  /commenteux/:resource/:resource_id/new(.:format) commenteux/notes#new
-       POST /commenteux/:resource/:resource_id(.:format)     commenteux/notes#create
+       GET  /commenteux/:resource/:resource_id(.:format)            commenteux/notes#index
+       GET  /commenteux/:resource/:resource_id/new(.:format)        commenteux/notes#new
+       POST /commenteux/:resource/:resource_id(.:format)            commenteux/notes#create
+       GET    /commenteux/:resource/:resource_id/:id/edit(.:format) commenteux/notes#edit
+       PATCH  /commenteux/:resource/:resource_id/:id(.:format)      commenteux/notes#update
+       DELETE /commenteux/:resource/:resource_id(.:format)          commenteux/notes#destroy {:format=>:js}
 
 where :resource is the name of your model (you can use namespace)
 
@@ -40,6 +43,13 @@ Add acts_as_commentable in your model who will have comments
 
 :private, :public are a example if specific role needed.
 
+==== Model - Ability
+By default, only the user with admin role can modify or delete a comment. You can add others rights into your ability class.
+
+  if @user.has_role?(:admin_shipment)
+    can :manage, Comment
+  end
+
 ====Include the needed javascript file in your application.js or application.js.coffee
 
 ==== Javascript

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

@@ -1,11 +1,13 @@
 $(document).on 'click', '#new_notes_link', (e) ->
   e.stopPropagation()
   e.preventDefault()
-  parent = $(@).data('parent')
+
   resource = $(@).data('resource')
   id = $(@).data('id')
+  parent = $(@).data('parent')
   roles = $(@).data('roles')
   display_list_notes = $(@).data('display-list-notes')
+
   $.ajax
     url: "/commenteux/" + resource + "/" + id + "/new"
     type: "get"
@@ -28,7 +30,21 @@ $(document).on 'click', '#new_notes_link', (e) ->
 $(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).on 'ajax:success', '#edit_comments', (e, data, status, xhr) ->
+  e.stopPropagation()
+  e.preventDefault()
+
+  parent = $('#edit_comments').attr('data-parent')
+
   if parent and parent != 'null'
     $("#" + parent).html(xhr.responseText)
   else
@@ -38,13 +54,15 @@ $(document).on 'ajax:success', '#new_comments', (e, data, status, xhr) ->
 $(document).on 'click', '#new_notes_cancelled', (e) ->
   e.stopPropagation()
   e.preventDefault()
-  parent = $(@).data('parent')
+
   resource = $(@).data('resource')
   id = $(@).data('id')
+  parent = $(@).data('parent')
   roles = $(@).data('roles')
   display_list_notes = $(@).data('display-list-notes')
+
   $.ajax
-    url: "/commenteux/" + resource + "/" + id + "?parent_div=" + parent
+    url: "/commenteux/" + resource + "/" + id
     type: "get"
     dataType: "html"
     data:
@@ -61,3 +79,55 @@ $(document).on 'click', '#new_notes_cancelled', (e) ->
       alert(e)
       @
   @
+
+$(document).on 'click', '.remove_comment', (e) ->
+  e.stopPropagation()
+  e.preventDefault()
+
+  resource = $(@).data('resource')
+  resource_id = $(@).data('resource-id')
+  id = $(@).data('id')
+  comment_role = $(@).data('comment-role')
+
+  $.ajax
+    url: "/commenteux/" + resource + "/" + resource_id + "?id=" + id + "&comment_role=" + comment_role
+    type: "delete"
+    dataType: "html"
+    success:
+      $(".comment[data-id='" + id + "']").remove()
+    error: (e) ->
+      alert(e)
+      @
+  @
+
+$(document).on 'click', '.edit_comment', (e) ->
+  e.stopPropagation()
+  e.preventDefault()
+
+  resource = $(@).data('resource')
+  resource_id = $(@).data('resource-id')
+  id = $(@).data('id')
+  comment_role = $(@).data('comment-role')
+  parent = $(@).data('parent')
+  roles = $(@).data('roles')
+  display_list_notes = $(@).data('display-list-notes')
+
+  $.ajax
+    url: "/commenteux/" + resource + "/" + resource_id + "/" + id + "/edit"
+    type: "get"
+    dataType: "html"
+    data:
+      "comment_role": comment_role
+      "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)
+      @
+  @

data/app/controllers/commenteux/notes_controller.rb

@@ -6,44 +6,89 @@ module Commenteux
 
     def index
       resource = fetch_resource
-      @roles = params[:roles]
+      fetch_params
       list_roles = manage_roles_parameter(params[: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]
 
       render :layout => false if request.xhr?
     end
 
     def new
       resource = fetch_resource
-      @roles = params[:roles]
+      fetch_params
       @list_roles = manage_roles_parameter(params[:roles])
       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"
+      @comment = get_comment_model_method(resource, role).new
 
       render :layout => false if request.xhr?
     end
 
     def create
       resource = fetch_resource
-      comments_params
-      get_comment_model_method(resource, params[:comments][:role]).create(comments_params)
-      @parent_div = params[:parent_div]
+      fetch_params
+      comment_params
       roles = ''
-      roles = '&roles=' + params[:roles] if params[:roles]
-      display_list_notes = params[:display_list_notes] || "true"
+      if @roles
+        roles = '&roles=' + @roles
+        comment_role = params[:comments][:role]
+      end
+      get_comment_model_method(resource, comment_role).create(comment_params)
+
+      redirect_to "/commenteux/#{@resource.downcase}/#{@resource_id}?parent_div=" + @parent_div + roles + "&display_list_notes=#{@display_list_notes}"
+    end
+
+    def edit
+      resource = fetch_resource
+      fetch_params
+      @list_roles = manage_roles_parameter(params[:roles])
+      @comment = get_comment_model_method(resource, params[:comment_role]).find(params[:id])
+
+      render :layout => false if request.xhr?
+    end
+
+    def update
+      begin
+        resource = fetch_resource
+        fetch_params
+        comment_params
+        roles = ''
+        unless @roles.blank?
+          roles = '&roles=' + @roles
+          comment_role = params[:comments][:role]
+        end
+        @comment = get_comment_model_method(resource, comment_role).find(params[:id])
 
-      redirect_to "/commenteux/#{@resource.downcase}/#{@resource_id}?parent_div=" + @parent_div + roles + "&display_list_notes=#{display_list_notes}"
+        if @comment.update(comment_params)
+         #flash[:success] = "Commentaire modifié avec succès"
+         redirect_to "/commenteux/#{@resource.downcase}/#{@resource_id}?parent_div=" + @parent_div + roles + "&display_list_notes=#{@display_list_notes}"
+        else
+          #flash[:danger] = "Impossible de sauvegarder le commentaire"
+          render action: 'edit', :layout => false
+        end
+      rescue ActiveRecord::RecordNotFound
+        #flash[:danger] = "Ce commentaire n'existe plus."
+        redirect_to "/commenteux/#{@resource.downcase}/#{@resource_id}?parent_div=" + @parent_div + roles + "&display_list_notes=#{@display_list_notes}"
+      end
+    end
+
+    def destroy
+      begin
+        resource = fetch_resource
+        @comment = get_comment_model_method(resource, params[:comment_role]).find(params[:id])
+        @comment.destroy!
+        #flash[:success] = "Commentaire supprimé avec succès"
+      rescue ActiveRecord::RecordNotFound
+        #flash[:error] = "Ce commentaire n'existe plus."
+      end
+      respond_to do |format|
+        format.js
+      end
     end
 
     protected
-    def comments_params
-      comments_permit_fields = [:title, :comment, :user_id, :role, :roles]
-      params.require(:comments).permit(
-          comments_permit_fields)
+    def comment_params
+      comment_permit_fields = [:title, :comment, :user_id, :role, :id]
+      params.require(:comments).permit(comment_permit_fields)
     end
 
     def fetch_resource
@@ -54,6 +99,12 @@ module Commenteux
       @resourceKlass.find(@resource_id)
     end
 
+    def fetch_params
+      @roles = params[:roles]
+      @parent_div = params[:parent_div]
+      @display_list_notes = params[:display_list_notes] || "true"
+    end
+
     def classify_namespace(const)
       const = const.classify
       if const.include?('::')
@@ -80,12 +131,12 @@ module Commenteux
     end
 
     def get_comment_model_method(resource, role)
-      if role
-        role_comments = role + "_comments"
+      if role.blank?
+        role_comment = "comments"
       else
-        role_comments = "comments"
+        role_comment = role + "_comments"
       end
-      resource.send(role_comments)
+      resource.send(role_comment)
     end
 
     def manage_roles_parameter(roles_parameter)

data/app/helpers/commenteux/application_helper.rb

@@ -1,4 +1,7 @@
 module Commenteux
   module ApplicationHelper
+    def icon(klass_ending, title='')
+      "<i class='icon-#{klass_ending}'></i> #{title}".html_safe
+    end
   end
 end

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

@@ -0,0 +1,33 @@
+<%= c.input :title, as: 'hidden' %>
+<%= c.input :comment, :label => 'Commentaire' %>
+<% if defined? current_user %>
+  <%= c.input :user_id, input_html: {value: current_user.id}, as: 'hidden' %>
+<% 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: 'Commentaire visible à',
+              :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">
+
+      <button class="btn btn-primary" type="submit" id='save'>
+        <i class="icon-save"></i>
+        Enregistrer
+      </button>
+
+      <%= link_to "Annuler", "#", :id => "new_notes_cancelled", :class => 'btn',
+                  :data => {:parent => @parent_div,
+                            :resource => @resource.downcase,
+                            :id => @resource_id,
+                            :roles => @roles,
+                            :display_list_notes => @display_list_notes} %>
+
+    </div>
+  </div>
+</div>

data/app/views/commenteux/notes/destroy.js.erb

@@ -0,0 +1,3 @@
+<% if !@comment.nil? and @comment.errors.messages.empty? %>
+  $('.comment[data-id="<%= @comment.id %>"]').remove();
+<% end %>

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

@@ -0,0 +1,6 @@
+<%= simple_form_for @comment, as: 'comments', url: "/commenteux/#{@resource.downcase}/#{@resource_id}/#{@comment.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| %>
+
+  <%= render partial: "form", locals: {c: c}  %>
+
+<% end %>

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

@@ -1,33 +1,61 @@
+<% role_current = '' %>
 <% if @display_list_notes == "true" %>
   <table class="table">
     <thead>
     <tr>
-      <th class="col-md-6">Commentaire</th>
+      <th class="col-md-5">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 %>
+      <% if can? :manage, Comment %>
+        <th class="col-md-1">Suppr.</th>
+      <% end %>
     </tr>
     </thead>
 
     <% @comments.each do |comment| %>
-        <tr>
-          <td>
+      <% if display_role?(@roles) %>
+        <% role_current = comment.role %>
+      <% end %>
+      <tr class="comment" data-id="<%= comment.id %>">
+        <td>
+          <% if can? :manage, Comment %>
+            <%= link_to comment.comment, "#", class: 'edit_comment',
+                        :data => {parent: @parent_div,
+                                  resource: @resource.downcase,
+                                  resource_id: @resource_id,
+                                  id: comment.id,
+                                  comment_role: role_current,
+                                  roles: @roles,
+                                  display_list_notes: @display_list_notes
+                        } %>
+          <% else %>
             <%= comment.comment %>
-          </td>
+          <% end %>
+        </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) %>
           <td>
-            <%= user_lookup(comment.user_id) %>
+             <%= I18n.t(comment.role) %>
           </td>
+        <% end %>
+        <% if can? :manage, Comment %>
           <td>
-            <%= comment.created_at.in_time_zone('Eastern Time (US & Canada)').strftime("%Y-%m-%d %H:%M:%S") %>
+            <%= link_to "#", class: 'remove_comment',
+                        data: {confirm: 'Êtes-vous certain?', resource: @resource.downcase,
+                               resource_id: @resource_id, id: comment.id, comment_role: role_current} do %>
+              <%= icon 'remove-sign' %>
+            <% end %>
           </td>
-          <% if display_role?(@roles) %>
-            <td>
-               <%= I18n.t(comment.role) %>
-            </td>
-          <% end %>
-        </tr>
+        <% end %>
+      </tr>
     <% end %>
   </table>
   <br/>
@@ -39,4 +67,4 @@
                       :id => @resource_id,
                       :roles => @roles,
                       :display_list_notes => @display_list_notes
-            } %>
+            } %>

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

@@ -1,41 +1,6 @@
-<%= 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}",
+<%= simple_form_for @comment, 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">
-      <%= c.input :title %>
-    </div>
-    <%= c.input :comment, :label => 'Commentaire' %>
-    <% if defined? current_user %>
-        <div style="display:none">
-          <%= c.input :user_id, input_html: {value: current_user.id} %>
-        </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: 'Commentaire visible à',
-                  :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">
-
-          <button class="btn btn-primary" type="submit" id='save'>
-            Enregistrer
-          </button>
-
-          <%= link_to "Annuler", "#", :id => "new_notes_cancelled", :class => 'btn',
-                      :data => {:parent => @parent_div,
-                                :resource => @resource.downcase,
-                                :id => @resource_id,
-                                :roles => @roles,
-                                :display_list_notes => @display_list_notes} %>
-
-        </div>
-      </div>
-    </div>
+  <%= render partial: "form", locals: {c: c}  %>
 
 <% end %>