decidim-comments 0.26.8 → 0.27.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7c703693e277e548e8ce98c7bc505cd94d228231314b1ce10bd07c13472300c
-  data.tar.gz: af1a1ab54be577a20732a0759f159492e0984152ec9f30e4426ca2fa134e17e9
+  metadata.gz: 15e0e5dd8fbb2fc7171061fa36077e83f956f3ada42b41dfa32cd8e8f60cdd0a
+  data.tar.gz: 6cb4e67d56972f657983cc174806b8766d0916fb55b7ca783ee2e8a684859283
 SHA512:
-  metadata.gz: 476f10c4cafe7e703b0ea8d01cca3af29b4a4f26da954bbafc1d00a4e5b7daedc6965dc94d8bb85cf451dfc81e0fe01c2f816ec44fc194c35b791ed42a46c77e
-  data.tar.gz: 7bca67a880ef726826d302b018557d9ab17678c6f6158239fcd549701cc18a4be400ba6c8861dc651628a92d0ec4da06d547f159289c0dfc95150e4a6042cfa1
+  metadata.gz: a3a7482658e91430342214a3d668979c0450b1203c28725ab083c46773b6c39474f148a4489238c90187cda2407a81edbc1c7a1b9bd26944081ce36261f86e7e
+  data.tar.gz: ee42d7e4922a5cbc826a1a98f73b1d1056d4ce6879a398da32ad6962d9987323f7b37b2e1fc57111251baf2185301cbdc0e370621107778afd2fb47263dc285b

data/app/cells/decidim/comments/comment/actions.erb

@@ -1,9 +1,4 @@
 <div class="comment__actions">
-  <button class="comment__hide muted-link <%= depth.zero? && has_replies_in_children? ? "" : "hide" %>" aria-controls="comment-<%= model.id %>-replies" data-toggle="comment_<%= model.id %>">
-    <%= icon "comment-square", class: "icon--small", role: "img", "aria-hidden": true %>&nbsp;
-    <span class="hide-comment-replies"><%= t("decidim.components.comment.hide_replies") %></span>
-    <span class="show-comment-replies"><%= t("decidim.components.comment.show_replies", count: replies.size, replies_count: replies.size ) %></span>
-  </button>
   <% if can_reply? %>
     <button class="comment__reply muted-link" aria-controls="<%= reply_id %>" data-toggle="<%= reply_id %>">
       <%= icon "pencil", class: "icon--small", role: "img", "aria-hidden": true %>&nbsp;<%= t("decidim.components.comment.reply") %>

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

@@ -1,4 +1,4 @@
-<%= content_tag :div, id: "comment_#{model.id}", class: comment_classes, data: { depth: model.depth, comment_id: model.id, toggler: ".no-comments" } do %>
+<%= content_tag :div, id: "comment_#{model.id}", class: comment_classes, data: { comment_id: model.id } do %>
   <% if model.hidden? %>
     <%= render :moderation_data %>
   <% elsif model.deleted? %>
@@ -31,7 +31,7 @@
       <%= votes %>
     </div>
   <% end %>
-  <div id="comment-<%= model.id %>-replies" class="replies">
+  <div id="comment-<%= model.id %>-replies">
     <% if has_replies_in_children? %>
       <% replies.each do |reply| %>
         <%= cell("decidim/comments/comment", reply, root_depth: root_depth, order: order, reloaded: reloaded?) %>
@@ -39,7 +39,7 @@
     <% end %>
   </div>
   <% if can_reply? %>
-    <div class="comment__additionalreply<%= " hide" unless commentable? %> replies">
+    <div class="comment__additionalreply<%= " hide" unless commentable? %>">
       <button class="comment__reply muted-link" aria-controls="<%= reply_id %>" data-toggle="<%= reply_id %>">
         <%= icon "pencil", class: "icon--small", role: "img", "aria-hidden": true %>&nbsp;<%= t("decidim.components.comment.reply") %>
       </button>

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

@@ -186,11 +186,11 @@ module Decidim
       end
 
       def has_replies?
-        model.comment_threads.includes(:moderation).collect { |c| !c.deleted? && !c.hidden? }.any?
+        model.comment_threads.not_hidden.not_deleted.exists?
       end
 
       def has_replies_in_children?
-        has_replies? || model.comment_threads.includes(:moderation).collect { |t| t.comment_threads.includes(:moderation).collect { |c| !c.deleted? && !c.hidden? }.any? }.any?
+        model.descendants.where(decidim_commentable_type: "Decidim::Comments::Comment").not_hidden.not_deleted.exists?
       end
 
       # action_authorization_button expects current_component to be available

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

@@ -0,0 +1,3 @@
+<div class="callout primary loading-comments">
+  <p><%= t("decidim.components.comments.loading") %></p>
+</div>

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

@@ -16,6 +16,7 @@
       <%= single_comment_warning %>
       <%= blocked_comments_warning %>
       <div class="comment-threads">
+        <%= comments_loading %>
         <% comments.each do |comment| %>
           <%= cell("decidim/comments/comment_thread", comment, order: order) %>
         <% end %>

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

@@ -22,6 +22,12 @@ module Decidim
         render :single_comment_warning
       end
 
+      def comments_loading
+        return if single_comment?
+
+        render :comments_loading
+      end
+
       def blocked_comments_warning
         return unless comments_blocked?
         return unless user_comments_blocked?
@@ -43,11 +49,7 @@ module Decidim
       end
 
       def comments
-        if single_comment?
-          [single_comment]
-        else
-          SortedComments.for(model, order_by: order)
-        end
+        single_comment? ? [single_comment] : []
       end
 
       def comments_count
@@ -97,17 +99,10 @@ module Decidim
           commentableGid: model.to_signed_global_id.to_s,
           commentsUrl: decidim_comments.comments_path,
           rootDepth: root_depth,
-          lastCommentId: last_comment_id,
           order: order
         }
       end
 
-      def last_comment_id
-        Decidim::Comments::Comment.where(
-          root_commentable: model
-        ).order(:id).pluck(:id).last
-      end
-
       def single_comment?
         single_comment.present?
       end

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

@@ -2,7 +2,7 @@
 
 module Decidim
   module Comments
-    # A cell to display a form for editing a comment.
+    # A cell to display a form for edditing a comment.
     class EditCommentModalFormCell < Decidim::ViewModel
       delegate :current_user, :user_signed_in?, to: :controller
       alias comment model

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

@@ -3,7 +3,7 @@
 module Decidim
   module Comments
     # A command with all the business logic to create a new comment
-    class CreateComment < Rectify::Command
+    class CreateComment < Decidim::Command
       # Public: Initializes the command.
       #
       # form - A form object with the params.

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

@@ -3,7 +3,7 @@
 module Decidim
   module Comments
     # A command with all the business logic to delete a comment
-    class DeleteComment < Rectify::Command
+    class DeleteComment < Decidim::Command
       # Public: Initializes the command.
       #
       # comment - The comment to delete.

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

@@ -3,7 +3,7 @@
 module Decidim
   module Comments
     # A command with all the business logic to update an existing comment
-    class UpdateComment < Rectify::Command
+    class UpdateComment < Decidim::Command
       # Public: Initializes the command.
       #
       # comment - Decidim::Comments::Comment
@@ -48,7 +48,14 @@ module Decidim
           edit: true
         )
 
+        mentioned_users = parsed.metadata[:user].users
+        mentioned_groups = parsed.metadata[:user_group].groups
         CommentCreation.publish(@comment, parsed.metadata)
+        send_notifications(mentioned_users, mentioned_groups)
+      end
+
+      def send_notifications(mentioned_users, mentioned_groups)
+        NewCommentNotificationCreator.new(comment, mentioned_users, mentioned_groups).create
       end
     end
   end

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

@@ -3,7 +3,7 @@
 module Decidim
   module Comments
     # A command with all the business logic to upvote a comment
-    class VoteComment < Rectify::Command
+    class VoteComment < Decidim::Command
       # Public: Initializes the command.
       #
       # comment - A comment

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

@@ -13,7 +13,7 @@ module Decidim
       before_action :set_commentable, except: [:destroy, :update]
       before_action :ensure_commentable!, except: [:destroy, :update]
 
-      helper_method :root_depth, :commentable, :order, :reply?, :reload?, :root_comment
+      helper_method :root_depth, :commentable, :order, :reply?, :reload?
 
       def index
         enforce_permission_to :read, :comment, commentable: commentable
@@ -23,6 +23,12 @@ module Decidim
           order_by: order,
           after: params.fetch(:after, 0).to_i
         )
+        @comments = @comments.reject do |comment|
+          next if comment.depth < 1
+          next if !comment.deleted? && !comment.hidden?
+
+          comment.commentable.descendants.where(decidim_commentable_type: "Decidim::Comments::Comment").not_hidden.not_deleted.blank?
+        end
         @comments_count = commentable.comments_count
 
         respond_to do |format|
@@ -135,7 +141,7 @@ module Decidim
       end
 
       def handle_success(comment)
-        @comment = comment.reload
+        @comment = comment
         @comments_count = case commentable
                           when Decidim::Comments::Comment
                             commentable.root_commentable.comments_count
@@ -144,14 +150,6 @@ module Decidim
                           end
       end
 
-      def root_comment
-        @root_comment ||= begin
-          root_comment = comment
-          root_comment = root_comment.commentable while root_comment.commentable.is_a?(Decidim::Comments::Comment)
-          root_comment
-        end
-      end
-
       def commentable_gid
         case action_name
         when "create"
@@ -178,7 +176,7 @@ module Decidim
       end
 
       def commentable_path
-        return commentable.polymorphic_resource_path({}) if commentable&.respond_to?(:polymorphic_resource_path)
+        return commentable.polymorphic_resource_path({}) if commentable.respond_to?(:polymorphic_resource_path)
 
         resource_locator(commentable).path
       end

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

@@ -14,7 +14,7 @@ module Decidim
       end
 
       def resource_link_path
-        return root_commentable.polymorphic_resource_path(url_params) if root_commentable&.respond_to?(:polymorphic_resource_path)
+        return root_commentable.polymorphic_resource_path(url_params) if root_commentable.respond_to?(:polymorphic_resource_path)
 
         resource_locator(root_commentable).path(url_params)
       end

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

@@ -10,12 +10,13 @@ module Decidim
       include Decidim::Authorable
       include Decidim::Comments::Commentable
       include Decidim::FriendlyDates
-      include Decidim::DataPortability
+      include Decidim::DownloadYourData
       include Decidim::Traceable
       include Decidim::Loggable
       include Decidim::Searchable
       include Decidim::TranslatableResource
       include Decidim::TranslatableAttributes
+      include Decidim::ActsAsTree
 
       # Limit the max depth of a comment tree. If C is a comment and R is a reply:
       # C          (depth 0)
@@ -27,6 +28,8 @@ module Decidim
 
       translatable_fields :body
 
+      parent_item_foreign_key :decidim_commentable_id
+
       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
       belongs_to :participatory_space, foreign_key: "decidim_participatory_space_id", foreign_type: "decidim_participatory_space_type", polymorphic: true, optional: true
@@ -53,6 +56,8 @@ module Decidim
       validate :body_length
       validate :commentable_can_have_comments
 
+      delegate :organization, to: :commentable
+
       scope :not_deleted, -> { where(deleted_at: nil) }
 
       translatable_fields :body
@@ -76,10 +81,6 @@ module Decidim
         where(alignment: -1)
       end
 
-      def organization
-        commentable&.organization || participatory_space&.organization
-      end
-
       def visible?
         participatory_space.try(:visible?) && component.try(:published?)
       end
@@ -130,11 +131,9 @@ module Decidim
 
       # Public: Overrides the `reported_content_url` Reportable concern method.
       def reported_content_url
-        return unless root_commentable
-
         url_params = { anchor: "comment_#{id}" }
 
-        if root_commentable&.respond_to?(:polymorphic_resource_url)
+        if root_commentable.respond_to?(:polymorphic_resource_url)
           root_commentable.polymorphic_resource_url(url_params)
         else
           ResourceLocatorPresenter.new(root_commentable).url(url_params)
@@ -159,7 +158,7 @@ module Decidim
       # Expects all +resources+ to be of the same "commentable_type".
       # If the result is not `Decidim::Comments::Commentable` returns `nil`.
       def self.user_commentators_ids_in(resources)
-        if resources.first&.kind_of?(Decidim::Comments::Commentable)
+        if resources.first.is_a?(Decidim::Comments::Commentable)
           commentable_type = resources.first.class.name
           Decidim::Comments::Comment.select("DISTINCT decidim_author_id").not_hidden.not_deleted
                                     .where(decidim_commentable_id: resources.pluck(:id))
@@ -171,7 +170,7 @@ module Decidim
       end
 
       def can_participate?(user)
-        return true unless root_commentable&.respond_to?(:can_participate?)
+        return true unless root_commentable.respond_to?(:can_participate?)
 
         root_commentable.can_participate?(user)
       end

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

@@ -5,7 +5,7 @@ module Decidim
     # A comment can include user votes. A user should be able to upVote, votes with
     # weight 1 and downVote, votes with weight -1.
     class CommentVote < ApplicationRecord
-      include Decidim::DataPortability
+      include Decidim::DownloadYourData
 
       belongs_to :comment, foreign_key: "decidim_comment_id", class_name: "Comment"
       belongs_to :author, foreign_key: "decidim_author_id", foreign_type: "decidim_author_type", polymorphic: true

data/app/packs/src/decidim/comments/comments.component.js

@@ -1,4 +1,6 @@
 /* eslint id-length: ["error", { "exceptions": ["$"] }] */
+/* eslint max-lines: ["error", {"max": 350, "skipBlankLines": true}] */
+
 
 /**
  * A plain Javascript component that handles the comments.
@@ -10,6 +12,8 @@
 // This is necessary for testing purposes
 const $ = window.$;
 
+import Rails from "@rails/ujs";
+
 import { createCharacterCounter } from "src/decidim/input_character_counter"
 import ExternalLink from "src/decidim/external_link"
 import updateExternalDomainLinks from "src/decidim/external_domain_warning"
@@ -23,6 +27,8 @@ export default class CommentsComponent {
     this.order = config.order;
     this.lastCommentId = config.lastCommentId;
     this.pollingInterval = config.pollingInterval || 15000;
+    this.singleComment = config.singleComment;
+    this.toggleTranslations = config.toggleTranslations;
     this.id = this.$element.attr("id") || this._getUID();
     this.mounted = false;
   }
@@ -36,6 +42,9 @@ export default class CommentsComponent {
     if (this.$element.length > 0 && !this.mounted) {
       this.mounted = true;
       this._initializeComments(this.$element);
+      if (!this.singleComment) {
+        this._fetchComments();
+      }
 
       $(".order-by__dropdown .is-submenu-item a", this.$element).on("click.decidim-comments", () => this._onInitOrder());
     }
@@ -133,8 +142,6 @@ export default class CommentsComponent {
         $text.get(0).addEventListener("emoji.added", this._onTextInput);
       }
     });
-
-    this._pollComments();
   }
 
   /**
@@ -200,20 +207,32 @@ export default class CommentsComponent {
     this._stopPolling();
 
     this.pollTimeout = setTimeout(() => {
-      Rails.ajax({
-        url: this.commentsUrl,
-        type: "GET",
-        data: new URLSearchParams({
-          "commentable_gid": this.commentableGid,
-          "root_depth": this.rootDepth,
-          "order": this.order,
-          "after": this.lastCommentId
-        }),
-        success: this._pollComments()
-      })
+      this._fetchComments();
     }, this.pollingInterval);
   }
 
+  /**
+   * Sends an ajax request based on current
+   * params to get comments for the component
+   * @private
+   * @returns {Void} - Returns nothing
+   */
+  _fetchComments() {
+    Rails.ajax({
+      url: this.commentsUrl,
+      type: "GET",
+      data: new URLSearchParams({
+        "commentable_gid": this.commentableGid,
+        "root_depth": this.rootDepth,
+        "order": this.order,
+        "after": this.lastCommentId,
+        ...(this.toggleTranslations && { "toggle_translations": this.toggleTranslations }),
+        ...(this.lastCommentId && { "after": this.lastCommentId })
+      }),
+      success: this._pollComments()
+    })
+  }
+
   /**
    * Stops polling for new comments.
    * @private

data/app/packs/src/decidim/comments/comments.component.test.js

@@ -13,6 +13,10 @@ window.$.ajax = jest.fn().mockImplementation((...args) => $.ajax(...args));
 import Quill from "quill"
 window.Quill = Quill
 
+// Rails.ajax is used by the fetching/polling of the comments
+import Rails from "@rails/ujs";
+jest.mock("@rails/ujs");
+
 // Fake timers for testing polling
 jest.useFakeTimers();
 
@@ -383,16 +387,16 @@ describe("CommentsComponent", () => {
 
     jest.advanceTimersByTime(1000);
 
-    expect(window.$.ajax).toHaveBeenCalledWith({
+    expect(Rails.ajax).toHaveBeenCalledWith({
       url: "/comments",
-      method: "GET",
-      contentType: "application/javascript",
-      data: {
+      type: "GET",
+      data: new URLSearchParams({
         "commentable_gid": "commentable-gid",
         "root_depth": 0,
         order: "older",
         after: 456
-      }
+      }),
+      success: window.undefined
     });
   });
 

data/app/permissions/decidim/comments/permissions.rb

@@ -51,13 +51,11 @@ module Decidim
       end
 
       def commentable
-        @commentable ||= begin
-          if comment
-            comment.root_commentable
-          else
-            context.fetch(:commentable, nil)
-          end
-        end
+        @commentable ||= if comment
+                           comment.root_commentable
+                         else
+                           context.fetch(:commentable, nil)
+                         end
       end
 
       def comment

data/app/queries/decidim/comments/sorted_comments.rb

@@ -3,7 +3,7 @@
 module Decidim
   module Comments
     # A class used to find comments for a commentable resource
-    class SortedComments < Rectify::Query
+    class SortedComments < Decidim::Query
       attr_reader :commentable
 
       # Syntactic sugar to initialize the class and return the queried objects.
@@ -34,8 +34,6 @@ module Decidim
                 .includes(:author, :user_group, :up_votes, :down_votes)
 
         case @options[:order_by]
-        when "older"
-          order_by_older(scope)
         when "recent"
           order_by_recent(scope)
         when "best_rated"

data/app/services/decidim/comments/new_comment_notification_creator.rb

@@ -117,7 +117,7 @@ module Decidim
           }
         }.deep_merge(users)
 
-        Decidim::EventsManager.publish(data)
+        Decidim::EventsManager.publish(**data)
       end
     end
   end

data/app/views/decidim/comments/comments/create.js.erb

@@ -7,10 +7,6 @@
   var component = $comments.data("comments");
   if (inReplyTo) {
     component.addReply(inReplyTo, commentHtml, true);
-
-    var hideButton = $("#comment_" + <%= root_comment.id %>).find(".comment__hide").first();
-    hideButton.find(".show-comment-replies").first().html('<%= t("decidim.components.comment.show_replies", count: Decidim::Comments::SortedComments.for(root_comment.reload).size) %>');
-    hideButton.removeClass("hide");
   } else {
     component.addThread(commentHtml, true);
   }

data/app/views/decidim/comments/comments/index.js.erb

@@ -4,6 +4,7 @@
   var $comments = $("#" + rootCommentableId);
   var component = $comments.data("comments");
 
+  $(".loading-comments").addClass("hide");
 <% @comments.each do |comment| %>
   var commentId = <%= comment.id.to_json %>;
   var commentHtml = '<%== j(render comment).strip %>';

data/app/views/decidim/comments/comments/reload.js.erb

@@ -6,6 +6,7 @@
   component.unmountComponent();
 
   var commentsHtml = '<%== j(render partial: "comments").strip %>';
+  $(".loading-comments").addClass("hide");
   $comments.replaceWith(commentsHtml);
 
   $comments = $("#" + rootCommentableId);

data/config/locales/am-ET.yml

@@ -1 +1,2 @@
+---
 am: