decidim-comments 0.27.4 → 0.28.0.rc5

data/app/cells/decidim/comments/comments/order_control.erb

@@ -1,36 +1,12 @@
-<div class="order-by__dropdown order-by__dropdown--right">
-  <span class="order-by__text"><%= t("decidim.components.comment_order_selector.title") %></span>
-  <ul id="comments-order-menu"
-    class="dropdown menu"
-    data-dropdown-menu="data-dropdown-menu"
-    data-autoclose="false"
-    data-disable-hover="true"
-    data-click-open="true"
-    data-close-on-click="true"
-    role="menubar">
-    <li class="is-dropdown-submenu-parent opens-right" role="presentation">
-      <a href="#" id="comments-order-menu-control"
-        aria-label="<%= t("decidim.components.comment_order_selector.title") %>"
-        aria-controls="comments-order-menu"
-        aria-haspopup="menu"
-        role="menuitem"><%= t("decidim.components.comment_order_selector.order.#{order}") %></a>
-      <ul class="menu is-dropdown-submenu submenu first-sub vertical"
-        id="comments-order-chooser-menu"
-        role="menu"
-        aria-labelledby="comments-order-menu-control"
-        data-submenu="">
-        <% available_orders.each do |order_value| %>
-          <li role="presentation" class="is-submenu-item is-dropdown-submenu-item">
-            <%= link_to(
-              t("decidim.components.comment_order_selector.order.#{order_value}"),
-              decidim_comments.comments_path(commentable_gid: model.to_signed_global_id.to_s, order: order_value, reload: 1),
-              tabindex: -1,
-              role: "menuitem",
-              remote: true
-            ) %>
-          </li>
-        <% end %>
-      </ul>
-    </li>
-  </ul>
+<div class="comment-order-by">
+  <% available_orders.each do | order_value| %>
+    <div class="text-center">
+      <%= link_to(
+        t("decidim.components.comment_order_selector.order.#{order_value}"),
+        decidim_comments.comments_path(commentable_gid: model.to_signed_global_id.to_s, order: order_value, reload: 1),
+        class: "button button__sm button__text-secondary only:m-auto comment-order-by__item inline-block #{order_value == order ? "underline font-bold" : ""}",
+        remote: true
+      ) %>
+    </div>
+  <% end %>
 </div>

data/app/cells/decidim/comments/comments/show.erb

@@ -1,16 +1,17 @@
 <%= content_tag :div, id: node_id, data: { decidim_comments: comments_data } do %>
-  <div class="columns large-9 comments-container" id="comments">
+  <div id="comments">
     <div class="comments">
-      <div class="row collapse order-by">
-        <h3 class="order-by__text section-heading">
+      <div class="comments__header">
+        <h2 class="h4">
           <% if single_comment? %>
             <%= t("decidim.components.comments.comment_details_title") %>
           <% else %>
-            <span class="comments-count">
+            <%= icon "chat-1-line", class: "fill-tertiary w-6 h-6 inline-block align-middle" %>
+            <span class="comments-count inline-block align-middle">
               <%= t("decidim.components.comments.title", count: comments_count) %>
             </span>
           <% end %>
-        </h3>
+        </h2>
         <%= render :order_control %>
       </div>
       <%= single_comment_warning %>
@@ -18,14 +19,12 @@
       <div class="comment-threads">
         <%= comments_loading %>
         <% comments.each do |comment| %>
-          <%= cell("decidim/comments/comment_thread", comment, order: order) %>
+          <%= cell("decidim/comments/comment_thread", comment, order:) %>
         <% end %>
       </div>
       <%= add_comment %>
       <%= user_comments_blocked_warning %>
     </div>
-    <div class="callout primary loading-comments hide">
-      <p><%= t("decidim.components.comments.loading") %></p>
-    </div>
+    <%= cell("decidim/announcement", t("decidim.components.comments.loading"), callout_class: "primary loading-comments hidden") %>
   </div>
 <% end %>

data/app/cells/decidim/comments/comments/single_comment_warning.erb

@@ -1,9 +1,6 @@
-<div class="callout secondary">
-  <h5><%= t("decidim.components.comments.single_comment_warning_title") %></h5>
-  <p>
-    <%== t(
-    "decidim.components.comments.single_comment_warning",
-    url: "#{commentable_path}##{node_id}"
-    ) %>
-  </p>
-</div>
+<%= cell("decidim/announcement", {
+           title: t("decidim.components.comments.single_comment_warning_title"),
+           body: t("decidim.components.comments.single_comment_warning", url: "#{commentable_path}##{node_id}")
+         },
+         callout_class: "secondary"
+) %>

data/app/cells/decidim/comments/comments/user_comments_blocked_warning.erb

@@ -1,7 +1,10 @@
-<div class="callout warning">
-  <% if comment_permissions? %>
-    <p><%= blocked_comments_for_unauthorized_user_warning_link %></p>
-  <% else %>
-    <p><%= t("decidim.components.comments.blocked_comments_for_user_warning") %></p>
-  <% end %>
+<%# We cannot use the AnnouncementCell directly here as the link is escaped and it would not work %>
+<div class="flash warning" data-announcement="">
+  <span class="flash__message">
+    <% if comment_permissions? %>
+      <p><%= blocked_comments_for_unauthorized_user_warning_link %></p>
+    <% else %>
+      <p><%= t("decidim.components.comments.blocked_comments_for_user_warning") %></p>
+    <% end %>
+  </span>
 </div>

data/app/cells/decidim/comments/comments_cell.rb

@@ -99,7 +99,7 @@ module Decidim
           commentableGid: model.to_signed_global_id.to_s,
           commentsUrl: decidim_comments.comments_path,
           rootDepth: root_depth,
-          order: order
+          order:
         }
       end
 

data/app/cells/decidim/comments/edit_comment_modal_form/show.erb

@@ -1,16 +1,15 @@
-<div class="reveal edit-comment-modal" id="<%= "editCommentModal#{model.id}" %>" data-reveal role="dialog" aria-modal="true" aria-labelledby="<%= "editCommentModal#{model.id}" %>-label">
-  <div class="reveal__header">
-    <h3 id="<%= "editCommentModal#{model.id}" %>-label" class="reveal__title"><%= t("decidim.components.edit_comment_modal_form.title") %></h3>
-    <button class="close-button" data-close aria-label="<%= t("decidim.components.edit_comment_modal_form.close") %>" type="button">
-      <span aria-hidden="true">&times;</span>
-    </button>
-  </div>
-  <%= form_for(form_object, url: decidim_comments.comment_path(comment), method: :put, remote: true, html: { id: form_id }) do |form| %>
-    <div class="field">
-      <label class="show-for-sr" for="<%= form_id %>">
-        <%= t("decidim.components.edit_comment_modal_form.form.body.label") %>
-      </label>
-      <div class="hashtags__container">
+<%= decidim_modal id: "editCommentModal#{model.id}" do %>
+  <%= form_for(form_object, url: decidim_comments.comment_path(comment), method: :put, remote: true, html: { id: nil }) do |form| %>
+    <div data-dialog-container>
+      <%= icon "edit-line" %>
+      <h2 class="h2" id="dialog-title-budget-confirm" data-dialog-title>
+        <%= t("decidim.components.edit_comment_modal_form.title") %>
+      </h2>
+
+      <div class="form__wrapper gap-2">
+        <label class="text-gray-2" for="<%= form_id %>">
+          <%= t("decidim.components.edit_comment_modal_form.form.body.label") %>
+        </label>
         <%= form.text_area(
           :body,
           id: form_id,
@@ -19,11 +18,17 @@
           required: true,
           placeholder: t("decidim.components.edit_comment_modal_form.form.body.placeholder"),
           label: false,
+          class: "w-full rounded border min-h-[160px] border-text-gray-2",
           data: { remaining_characters: "##{form_id}-remaining-characters", input_emoji: true }
         ) %>
       </div>
-      <button type="submit" data-close class="button button--sc"><%= t("decidim.components.edit_comment_modal_form.form.submit") %></button>
+    </div>
+    <div data-dialog-actions>
+      <button type="submit" data-dialog-close="editCommentModal<%= model.id %>" class="button button__sm md:button__lg button__secondary">
+        <%= t("decidim.components.edit_comment_modal_form.form.submit") %>
+      </button>
+
       <span id="<%= form_id %>-remaining-characters" class="remaining-character-count"></span>
     </div>
   <% end %>
-</div>
+<% end %>

data/app/commands/decidim/comments/create_comment.rb

@@ -15,26 +15,38 @@ module Decidim
       # Executes the command. Broadcasts these events:
       #
       # - :ok when everything is valid.
-      # - :invalid if the form wasn't valid and we couldn't proceed.
+      # - :invalid if the form was not valid and we could not proceed.
       #
       # Returns nothing.
       def call
         return broadcast(:invalid) if form.invalid?
 
-        create_comment
+        with_events do
+          create_comment
+        end
 
         broadcast(:ok, comment)
       end
 
       private
 
-      attr_reader :form, :comment
+      attr_reader :form, :comment, :author
+
+      def event_arguments
+        {
+          resource: comment,
+          extra: {
+            event_author: form.current_user,
+            locale:
+          }
+        }
+      end
 
       def create_comment
         parsed = Decidim::ContentProcessor.parse(form.body, current_organization: form.current_organization)
 
         params = {
-          author: @author,
+          author:,
           commentable: form.commentable,
           root_commentable: root_commentable(form.commentable),
           body: { I18n.locale => parsed.rewrite },
@@ -45,7 +57,7 @@ module Decidim
 
         @comment = Decidim.traceability.create!(
           Comment,
-          @author,
+          author,
           params,
           visibility: "public-only"
         )

data/app/commands/decidim/comments/delete_comment.rb

@@ -16,7 +16,7 @@ module Decidim
       # Executes the command. Broadcasts these events:
       #
       # - :ok when everything is valid.
-      # - :invalid if comment isn't authored by current_user.
+      # - :invalid if comment is not authored by current_user.
       #
       # Returns nothing.
       def call

data/app/commands/decidim/comments/update_comment.rb

@@ -18,13 +18,15 @@ module Decidim
       # Executes the command. Broadcasts these events:
       #
       # - :ok when everything is valid.
-      # - :invalid if the form wasn't valid and we couldn't proceed.
+      # - :invalid if the form was not valid and we could not proceed.
       #
       # Returns nothing.
       def call
         return broadcast(:invalid) if form.invalid? || !comment.authored_by?(current_user)
 
-        update_comment
+        with_events do
+          update_comment
+        end
 
         broadcast(:ok)
       end
@@ -33,6 +35,16 @@ module Decidim
 
       attr_reader :form, :comment, :current_user
 
+      def event_arguments
+        {
+          resource: comment,
+          extra: {
+            event_author: form.current_user,
+            locale:
+          }
+        }
+      end
+
       def update_comment
         parsed = Decidim::ContentProcessor.parse(form.body, current_organization: form.current_organization)
 

data/app/commands/decidim/comments/vote_comment.rb

@@ -19,7 +19,7 @@ module Decidim
       # Executes the command. Broadcasts these events:
       #
       # - :ok when everything is valid.
-      # - :invalid if the vote wasn't create
+      # - :invalid if the vote was not create
       #
       # Returns nothing.
       def call

data/app/controllers/decidim/comments/comments_controller.rb

@@ -16,7 +16,7 @@ module Decidim
       helper_method :root_depth, :commentable, :order, :reply?, :reload?, :root_comment
 
       def index
-        enforce_permission_to :read, :comment, commentable: commentable
+        enforce_permission_to(:read, :comment, commentable:)
 
         @comments = SortedComments.for(
           commentable,
@@ -47,12 +47,13 @@ module Decidim
 
       def update
         set_comment
-        enforce_permission_to :update, :comment, comment: comment
+        set_commentable
+        enforce_permission_to(:update, :comment, comment:)
 
         form = Decidim::Comments::CommentForm.from_params(
           params.merge(commentable: comment.commentable)
         ).with_context(
-          current_organization: current_organization
+          current_organization:
         )
 
         Decidim::Comments::UpdateComment.call(comment, current_user, form) do
@@ -71,13 +72,13 @@ module Decidim
       end
 
       def create
-        enforce_permission_to :create, :comment, commentable: commentable
+        enforce_permission_to(:create, :comment, commentable:)
 
         form = Decidim::Comments::CommentForm.from_params(
-          params.merge(commentable: commentable)
+          params.merge(commentable:)
         ).with_context(
-          current_organization: current_organization,
-          current_component: current_component
+          current_organization:,
+          current_component:
         )
         Decidim::Comments::CreateComment.call(form, current_user) do
           on(:ok) do |comment|
@@ -106,7 +107,7 @@ module Decidim
         set_comment
         @commentable = @comment.commentable
 
-        enforce_permission_to :destroy, :comment, comment: comment
+        enforce_permission_to(:destroy, :comment, comment:)
 
         Decidim::Comments::DeleteComment.call(comment, current_user) do
           on(:ok) do
@@ -129,7 +130,11 @@ module Decidim
       attr_reader :commentable, :comment
 
       def set_commentable
-        @commentable = GlobalID::Locator.locate_signed(commentable_gid)
+        @commentable ||= if commentable_gid
+                           GlobalID::Locator.locate_signed(commentable_gid)
+                         elsif comment
+                           comment.root_commentable
+                         end
       end
 
       def set_comment

data/app/controllers/decidim/comments/votes_controller.rb

@@ -13,7 +13,7 @@ module Decidim
       def create
         raise ActionController::RoutingError, "Not Found" unless comment
 
-        enforce_permission_to :vote, :comment, comment: comment
+        enforce_permission_to(:vote, :comment, comment:)
 
         Decidim::Comments::VoteComment.call(comment, current_user, weight: params[:weight].to_i) do
           on(:ok) do

data/app/events/decidim/comments/comment_by_followed_user_event.rb

@@ -1,4 +1,4 @@
-# frozen-string_literal: true
+# frozen_string_literal: true
 
 module Decidim
   module Comments

data/app/events/decidim/comments/comment_by_followed_user_group_event.rb

@@ -1,4 +1,4 @@
-# frozen-string_literal: true
+# frozen_string_literal: true
 
 module Decidim
   module Comments

data/app/events/decidim/comments/comment_event.rb

@@ -1,4 +1,4 @@
-# frozen-string_literal: true
+# frozen_string_literal: true
 
 module Decidim
   module Comments
@@ -11,8 +11,7 @@ module Decidim
 
       included do
         def resource_text(override_translation = nil)
-          translated_body = translated_attribute(comment.body, comment.organization, override_translation)
-          Decidim::ContentProcessor.render(sanitize_content(render_markdown(translated_body)), "div")
+          comment.formatted_body(override_translation)
         end
 
         def author

data/app/events/decidim/comments/reply_created_event.rb

@@ -1,4 +1,4 @@
-# frozen-string_literal: true
+# frozen_string_literal: true
 
 module Decidim
   module Comments

data/app/events/decidim/comments/user_group_mentioned_event.rb

@@ -1,4 +1,4 @@
-# frozen-string_literal: true
+# frozen_string_literal: true
 
 module Decidim
   module Comments

data/app/events/decidim/comments/user_mentioned_event.rb

@@ -1,4 +1,4 @@
-# frozen-string_literal: true
+# frozen_string_literal: true
 
 module Decidim
   module Comments

data/app/helpers/decidim/comments/comment_cells_helper.rb

@@ -26,7 +26,7 @@ module Decidim
       end
 
       def url_params
-        { commentId: comment.id }
+        { commentId: comment.id, anchor: "comment_#{comment.id}" }
       end
     end
   end

data/app/jobs/decidim/comments/hide_all_created_by_author_job.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Comments
+    class HideAllCreatedByAuthorJob < ::Decidim::HideAllCreatedByAuthorJob
+      protected
+
+      def base_query
+        Decidim::Comments::Comment.not_hidden.where(author:)
+      end
+    end
+  end
+end

data/app/models/decidim/comments/comment.rb

@@ -29,6 +29,7 @@ module Decidim
       translatable_fields :body
 
       parent_item_foreign_key :decidim_commentable_id
+      parent_item_polymorphic_type_key :decidim_commentable_type
 
       belongs_to :commentable, foreign_key: "decidim_commentable_id", foreign_type: "decidim_commentable_type", polymorphic: true
       belongs_to :root_commentable, foreign_key: "decidim_root_commentable_id", foreign_type: "decidim_root_commentable_type", polymorphic: true, touch: true
@@ -179,12 +180,15 @@ module Decidim
         root_commentable.can_participate?(user)
       end
 
-      def formatted_body
-        Decidim::ContentProcessor.render(sanitize_content_for_comment(render_markdown(translated_body)), "div")
+      # The override_translation argument has been added to be able to use this
+      # method from comment event in the resource_text method which requires
+      # the use of this argument in translated_attribute of body
+      def formatted_body(override_translation = nil)
+        Decidim::ContentProcessor.render(sanitize_content_for_comment(render_markdown(translated_body(override_translation))), "div")
       end
 
-      def translated_body
-        translated_attribute(body, organization)
+      def translated_body(override_translation = nil)
+        translated_attribute(body, organization, override_translation)
       end
 
       def delete!

data/app/models/decidim/comments/seed.rb

@@ -6,28 +6,44 @@ module Decidim
     # to Seed those models in order to be able to use them in the development
     # app.
     class Seed
-      # Public: adds a random amount of comments for a given resource.
-      #
-      # resource - the resource to add the coments to.
-      #
-      # Returns nothing.
-      def self.comments_for(resource)
-        return unless resource.accepts_new_comments?
+      class << self
+        # Adds a random amount of comments for a given resource.
+        #
+        # @param resource [Object] - the Decidim resource to add the coments to.
+        #                            examples: Decidim::Proposals::CollaborativeDraft, Decidim::Proposals::Proposal,
+        #
+        # @return nil
+        def comments_for(resource)
+          return unless resource.accepts_new_comments?
 
-        Decidim::Comments::Comment.reset_column_information
+          Decidim::Comments::Comment.reset_column_information
 
-        organization = resource.organization
+          rand(0..6).times do
+            comment = create_comment(resource)
+            create_comment(comment, resource) if [true, false].sample
+          end
+        end
+
+        private
 
-        2.times do
-          author = Decidim::User.where(organization: organization).all.sample
+        # Creates a comment for a given resource.
+        #
+        # @private
+        #
+        # @param resource [Object] - the Decidim resource to add the comments to.
+        # @param root_commentable - the root commentable resource. It is optional, used for making nested comments.
+        #
+        # @return [Decidim::Comments::Comment]
+        def create_comment(resource, root_commentable = nil)
+          author = Decidim::User.where(organization: resource.organization).all.sample
           user_group = [true, false].sample ? Decidim::UserGroups::ManageableUserGroups.for(author).verified.sample : nil
 
           params = {
             commentable: resource,
-            root_commentable: resource,
+            root_commentable: root_commentable || resource,
             body: { en: ::Faker::Lorem.sentence(word_count: 50) },
-            author: author,
-            user_group: user_group
+            author:,
+            user_group:
           }
 
           Decidim.traceability.create!(

data/app/packs/entrypoints/decidim_comments.js

@@ -0,0 +1,5 @@
+// CSS
+import "stylesheets/comments.scss"
+
+// Javacript
+import "src/decidim/comments/comments"