decidim-comments 0.23.6 → 0.24.0.rc1

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

@@ -23,27 +23,51 @@ module Decidim
       #
       # Returns nothing.
       def call
-        if @weight == 1
-          vote = @comment.up_votes.find_by(author: @author)
-          if vote
-            vote.destroy!
+        case @weight
+        when 1
+          previous_vote = @comment.up_votes.find_by(author: @author)
+          if previous_vote
+            previous_vote.destroy!
           else
-            @comment.up_votes.create!(author: @author)
+            @vote = @comment.up_votes.create!(author: @author)
           end
-        elsif @weight == -1
-          vote = @comment.down_votes.find_by(author: @author)
-          if vote
-            vote.destroy!
+        when -1
+          previous_vote = @comment.down_votes.find_by(author: @author)
+          if previous_vote
+            previous_vote.destroy!
           else
-            @comment.down_votes.create!(author: @author)
+            @vote = @comment.down_votes.create!(author: @author)
           end
         else
           return broadcast(:invalid)
         end
+
+        notify_comment_author if @vote
         broadcast(:ok, @comment)
       rescue ActiveRecord::RecordInvalid, ActiveRecord::RecordNotUnique
         broadcast(:invalid)
       end
+
+      def notify_comment_author
+        Decidim::EventsManager.publish(
+          event: "decidim.events.comments.comment_#{upvote? ? "upvoted" : "downvoted"}",
+          event_class: upvote? ? Decidim::Comments::CommentUpvotedEvent : Decidim::Comments::CommentDownvotedEvent,
+          resource: @comment.commentable,
+          affected_users: [@comment.author],
+          extra: {
+            comment_id: @comment.id,
+            weight: @weight,
+            downvotes: @comment.down_votes.count,
+            upvotes: @comment.up_votes.count
+          }
+        )
+      end
+
+      private
+
+      def upvote?
+        @weight.positive?
+      end
     end
   end
 end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Comments
+    # This controller is the abstract class from which all other controllers of
+    # this engine inherit.
+    class ApplicationController < Decidim::ApplicationController
+      def permission_class_chain
+        [
+          ::Decidim::Comments::Permissions,
+          ::Decidim::Permissions
+        ]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Comments
+    # Controller that manages the comments for a commentable object.
+    #
+    class CommentsController < Decidim::Comments::ApplicationController
+      include Decidim::ResourceHelper
+
+      before_action :authenticate_user!, only: [:create]
+      before_action :set_commentable
+      before_action :ensure_commentable!
+
+      helper_method :root_depth, :commentable, :order, :reply?, :reload?
+
+      def index
+        enforce_permission_to :read, :comment, commentable: commentable
+
+        @comments = SortedComments.for(
+          commentable,
+          order_by: order,
+          after: params.fetch(:after, 0).to_i
+        )
+        @comments_count = commentable.comments.count
+
+        respond_to do |format|
+          format.js do
+            if reload?
+              render :reload
+            else
+              render :index
+            end
+          end
+
+          # This makes sure bots are not causing unnecessary log entries.
+          format.html { redirect_to commentable_path }
+        end
+      end
+
+      def create
+        enforce_permission_to :create, :comment, commentable: commentable
+
+        form = Decidim::Comments::CommentForm.from_params(
+          params.merge(commentable: commentable)
+        ).with_context(
+          current_organization: current_organization,
+          current_component: commentable.component
+        )
+        Decidim::Comments::CreateComment.call(form, current_user) do
+          on(:ok) do |comment|
+            handle_success(comment)
+            respond_to do |format|
+              format.js { render :create }
+            end
+          end
+
+          on(:invalid) do
+            @error = t("create.error", scope: "decidim.comments.comments")
+            respond_to do |format|
+              format.js { render :error }
+            end
+          end
+        end
+      end
+
+      private
+
+      attr_reader :commentable, :comment
+
+      def set_commentable
+        @commentable = GlobalID::Locator.locate_signed(commentable_gid)
+      end
+
+      def ensure_commentable!
+        raise ActionController::RoutingError, "Not Found" unless commentable
+      end
+
+      def handle_success(comment)
+        @comment = comment
+        @comments_count = begin
+          case commentable
+          when Decidim::Comments::Comment
+            commentable.root_commentable.comments.count
+          else
+            commentable.comments.count
+          end
+        end
+      end
+
+      def commentable_gid
+        case action_name
+        when "create"
+          params.require(:comment).fetch(:commentable_gid)
+        else
+          params.fetch(:commentable_gid, nil)
+        end
+      end
+
+      def reply?(comment)
+        comment.root_commentable != comment.commentable
+      end
+
+      def order
+        params.fetch(:order, "older")
+      end
+
+      def reload?
+        params.fetch(:reload, 0).to_i == 1
+      end
+
+      def root_depth
+        params.fetch(:root_depth, 0).to_i
+      end
+
+      def commentable_path
+        return commentable.polymorphic_resource_path({}) if commentable&.respond_to?(:polymorphic_resource_path)
+
+        resource_locator(commentable).path
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Comments
+    # Controller that manages the comment votes.
+    #
+    class VotesController < Decidim::Comments::ApplicationController
+      before_action :authenticate_user!
+      before_action :set_comment
+
+      helper_method :comment
+
+      def create
+        raise ActionController::RoutingError, "Not Found" unless comment
+
+        enforce_permission_to :vote, :comment, comment: comment
+
+        Decidim::Comments::VoteComment.call(comment, current_user, weight: params[:weight].to_i) do
+          on(:ok) do
+            respond_to do |format|
+              format.js { render :create }
+            end
+          end
+          on(:invalid) do
+            respond_to do |format|
+              format.js { render :error }
+            end
+          end
+        end
+      end
+
+      private
+
+      attr_reader :comment
+
+      def set_comment
+        @comment = Decidim::Comments::Comment.find_by(id: params[:comment_id])
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Comments
+    class CommentDownvotedEvent < Decidim::Comments::CommentVotedEvent
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Comments
+    class CommentUpvotedEvent < Decidim::Comments::CommentVotedEvent
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Comments
+    class CommentVotedEvent < Decidim::Events::SimpleEvent
+      include Decidim::Comments::CommentEvent
+
+      i18n_attributes :upvotes
+      i18n_attributes :downvotes
+
+      def upvotes
+        extra[:upvotes]
+      end
+
+      def downvotes
+        extra[:downvotes]
+      end
+
+      private
+
+      def resource_url_params
+        { anchor: "comment_#{comment.id}" }
+      end
+    end
+  end
+end

data/app/forms/decidim/comments/comment_form.rb

@@ -5,10 +5,11 @@ module Decidim
     # A form object used to create comments from the graphql api.
     #
     class CommentForm < Form
-      attribute :body, String
+      attribute :body, Decidim::Attributes::CleanString
       attribute :alignment, Integer
       attribute :user_group_id, Integer
       attribute :commentable
+      attribute :commentable_gid
 
       mimic :comment
 
@@ -18,7 +19,10 @@ module Decidim
       validate :max_depth
 
       def max_length
-        return current_component.settings.comments_max_length if current_component.try { settings.comments_max_length.positive? }
+        if current_component&.settings.respond_to?(:comments_max_length)
+          component_length = current_component.try { settings.comments_max_length.positive? }
+          return current_component.settings.comments_max_length if component_length
+        end
         return current_organization.comments_max_length if current_organization.comments_max_length.positive?
 
         1000

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

@@ -55,11 +55,13 @@ module Decidim
       delegate :organization, to: :commentable
 
       translatable_fields :body
-      searchable_fields(
-        participatory_space: :itself,
-        A: :body,
-        datetime: :created_at
-      )
+      searchable_fields({
+                          participatory_space: :itself,
+                          A: :body,
+                          datetime: :created_at
+                        },
+                        index_on_create: true,
+                        index_on_update: ->(comment) { comment.visible? })
 
       def self.positive
         where(alignment: 1)
@@ -73,6 +75,10 @@ module Decidim
         where(alignment: -1)
       end
 
+      def visible?
+        participatory_space.try(:visible?) && component.try(:published?)
+      end
+
       def participatory_space
         return root_commentable if root_commentable.is_a?(Decidim::Participable)
 
@@ -130,6 +136,16 @@ module Decidim
         end
       end
 
+      # Public: Overrides the `reported_attributes` Reportable concern method.
+      def reported_attributes
+        [:body]
+      end
+
+      # Public: Overrides the `reported_searchable_content_extras` Reportable concern method.
+      def reported_searchable_content_extras
+        [normalized_author.name]
+      end
+
       def self.export_serializer
         Decidim::Comments::CommentSerializer
       end
@@ -144,8 +160,6 @@ module Decidim
                                     .where(decidim_commentable_id: resources.pluck(:id))
                                     .where(decidim_commentable_type: commentable_type)
                                     .where("decidim_author_type" => "Decidim::UserBaseEntity").pluck(:decidim_author_id)
-        else
-          []
         end
       end
 
@@ -171,7 +185,7 @@ module Decidim
       end
 
       def comment_maximum_length
-        return unless commentable.commentable?
+        return 0 unless commentable.commentable?
         return component.settings.comments_max_length if component_settings_comments_max_length?
         return organization.comments_max_length if organization.comments_max_length.positive?
 

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

@@ -25,7 +25,7 @@ module Decidim
           params = {
             commentable: resource,
             root_commentable: resource,
-            body: { en: ::Faker::Lorem.sentence(50) },
+            body: { en: ::Faker::Lorem.sentence(word_count: 50) },
             author: author,
             user_group: user_group
           }

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Comments
+    class Permissions < Decidim::DefaultPermissions
+      def permissions
+        return permission_action if permission_action.subject != :comment
+
+        case permission_action.action
+        when :read
+          can_read_comments?
+        when :create
+          can_create_comment?
+        when :vote
+          can_vote_comment?
+        end
+
+        permission_action
+      end
+
+      private
+
+      def can_read_comments?
+        return disallow! unless commentable.commentable?
+
+        allow!
+      end
+
+      def can_create_comment?
+        return disallow! unless user
+        return disallow! unless commentable.commentable?
+        return disallow! unless commentable&.user_allowed_to_comment?(user)
+
+        allow!
+      end
+
+      def can_vote_comment?
+        return disallow! unless user
+        return disallow! unless commentable&.user_allowed_to_comment?(user)
+
+        allow!
+      end
+
+      def commentable
+        @commentable ||= begin
+          if comment
+            comment.root_commentable
+          else
+            context.fetch(:commentable, nil)
+          end
+        end
+      end
+
+      def comment
+        @comment ||= context.fetch(:comment, nil)
+      end
+    end
+  end
+end

data/app/queries/decidim/comments/metrics/comment_participants_metric_measure.rb

@@ -41,8 +41,8 @@ module Decidim
           user_ids = Decidim::User.where(organization: @resource.organization).pluck(:id)
           Decidim::Comments::Comment.includes(:root_commentable).not_hidden
                                     .where("decidim_comments_comments.created_at <= ?", end_time)
-                                    .where("decidim_comments_comments.decidim_author_id IN (?)", user_ids)
-                                    .where("decidim_comments_comments.decidim_author_type IN (?)", "Decidim::UserBaseEntity")
+                                    .where(decidim_comments_comments: { decidim_author_id: user_ids })
+                                    .where(decidim_comments_comments: { decidim_author_type: "Decidim::UserBaseEntity" })
         end
       end
     end

data/app/queries/decidim/comments/metrics/comments_metric_manage.rb

@@ -80,12 +80,11 @@ module Decidim
 
         # Gets current ParticipatorySpace of a given 'related_object'
         def retrieve_participatory_space(related_object)
-          participatory_space = if related_object.respond_to?(:participatory_space)
-                                  related_object.participatory_space
-                                elsif related_object.is_a?(Decidim::Participable)
-                                  related_object
-                                end
-          participatory_space
+          if related_object.respond_to?(:participatory_space)
+            related_object.participatory_space
+          elsif related_object.is_a?(Decidim::Participable)
+            related_object
+          end
         end
       end
     end

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

@@ -33,21 +33,25 @@ module Decidim
         scope = base_scope
                 .not_hidden
                 .includes(:author, :user_group, :up_votes, :down_votes)
+        if @options[:after]
+          scope = scope.where(
+            "decidim_comments_comments.id > ?",
+            @options[:after]
+          )
+        end
 
-        scope = case @options[:order_by]
-                when "older"
-                  order_by_older(scope)
-                when "recent"
-                  order_by_recent(scope)
-                when "best_rated"
-                  order_by_best_rated(scope)
-                when "most_discussed"
-                  order_by_most_discussed(scope)
-                else
-                  order_by_older(scope)
-                end
-
-        scope
+        case @options[:order_by]
+        when "older"
+          order_by_older(scope)
+        when "recent"
+          order_by_recent(scope)
+        when "best_rated"
+          order_by_best_rated(scope)
+        when "most_discussed"
+          order_by_most_discussed(scope)
+        else
+          order_by_older(scope)
+        end
       end
 
       private

data/app/views/decidim/comments/comments/_comment.html.erb

@@ -0,0 +1,5 @@
+<% if reply?(comment) %>
+  <%= cell("decidim/comments/comment", comment, root_depth: root_depth) %>
+<% else %>
+  <%= cell("decidim/comments/comment_thread", comment) %>
+<% end %>

data/app/views/decidim/comments/comments/_comments.html.erb

@@ -0,0 +1 @@
+<%= inline_comments_for(commentable, order: order) %>

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

@@ -0,0 +1,16 @@
+(function() {
+  var rootCommentableId = <%== "comments-for-#{@comment.root_commentable.commentable_type.demodulize}-#{@comment.root_commentable.id}".to_json %>;
+  var commentHtml = '<%== j(render @comment).strip %>';
+  var inReplyTo = <%== (reply?(@comment) ? @commentable.id : nil).to_json %>;
+
+  var $comments = $("#" + rootCommentableId);
+  var component = $comments.data("comments");
+  if (inReplyTo) {
+    component.addReply(inReplyTo, commentHtml);
+  } else {
+    component.addThread(commentHtml);
+  }
+
+  // Update the comments count
+  $(".comments-count", $comments).text(<%== t("decidim.components.comments.title", count: @comments_count).to_json %>);
+}());

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

@@ -0,0 +1 @@
+alert("Comment creation error");

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

@@ -0,0 +1,24 @@
+(function() {
+  var rootCommentableId = <%== "comments-for-#{commentable.commentable_type.demodulize}-#{commentable.id}".to_json %>;
+
+  var $comments = $("#" + rootCommentableId);
+  var component = $comments.data("comments");
+
+<% @comments.each do |comment| %>
+  var commentId = <%= comment.id.to_json %>;
+  var commentHtml = '<%== j(render comment).strip %>';
+  var inReplyTo = <%== (reply?(comment) ? comment.commentable.id : nil).to_json %>;
+
+  var $comment = $("#comment_" + commentId);
+  if (1 > $comment.length) {
+    if (inReplyTo) {
+      component.addReply(inReplyTo, commentHtml);
+    } else {
+      component.addThread(commentHtml);
+    }
+  }
+<% end %>
+
+  // Update the comments count
+  $(".comments-count", $comments).text(<%== t("decidim.components.comments.title", count: @comments_count).to_json %>);
+}());

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

@@ -0,0 +1,21 @@
+(function() {
+  var rootCommentableId = <%== "comments-for-#{commentable.commentable_type.demodulize}-#{commentable.id}".to_json %>;
+
+  var $comments = $("#" + rootCommentableId);
+  var component = $comments.data("comments");
+  component.unmountComponent();
+
+  var commentsHtml = '<%== j(render partial: "comments").strip %>';
+  $comments.replaceWith(commentsHtml);
+
+  $comments = $("#" + rootCommentableId);
+  $comments.foundation();
+
+  // Re-create the component
+  component = new Decidim.CommentsComponent($comments, $comments.data("decidim-comments"));
+  component.mountComponent();
+  $comments.data("comments", component);
+
+  // Update the comments count
+  $(".comments-count", $comments).text(<%== t("decidim.components.comments.title", count: @comments_count).to_json %>);
+}());

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

@@ -0,0 +1,23 @@
+(function() {
+  var commentId = <%= comment.id.to_json %>;
+  var upVotes = <%= comment.up_votes.count.to_json %>;
+  var downVotes = <%= comment.down_votes.count.to_json %>;
+  var $comment = $("#comment_" + commentId);
+  var $votes = $("> .comment__footer .comment__votes", $comment);
+  var $upVote = $(".comment__votes--up", $votes);
+  var $downVote = $(".comment__votes--down", $votes);
+
+  $(".comment__votes--count", $upVote).text(upVotes);
+  $(".comment__votes--count", $downVote).text(downVotes);
+
+  $upVote.removeClass("is-vote-selected is-vote-notselected").removeAttr("disabled");
+  $downVote.removeClass("is-vote-selected is-vote-notselected").removeAttr("disabled");
+
+<% if comment.up_voted_by?(current_user) %>
+  $upVote.addClass("is-vote-selected");
+  $downVote.addClass("is-vote-notselected").attr("disabled", "disabled");
+<% elsif comment.down_voted_by?(current_user) %>
+  $upVote.addClass("is-vote-notselected").attr("disabled", "disabled");
+  $downVote.addClass("is-vote-selected");
+<% end %>
+}());

data/app/views/decidim/comments/votes/error.js.erb

@@ -0,0 +1 @@
+alert(<%== I18n.t("votes.create.error", scope: "decidim.comments").to_json %>);

data/config/locales/ar.yml

@@ -24,7 +24,6 @@ ar:
         other: الأصوات
   decidim:
     comments:
-      comments: تعليقات
       last_activity:
         new_comment_at_html: "<span>تعليق جديد على %{link}</span>"
       votes:
@@ -81,7 +80,6 @@ ar:
         loading: جارٍ تحميل التعليقات ...
         single_comment_warning: يمكنك الإطلاع على التعليقات المتبقية الأخرى <a href="%{url}">هنا</a>.
         single_comment_warning_title: إنك ترى تعليقا واحدا
-        title: "%{count} تعليقات"
     events:
       comments:
         comment_by_followed_user:

data/config/locales/ca.yml

@@ -16,8 +16,11 @@ ca:
         other: Vots
   decidim:
     comments:
-      comments: Comentaris
+      comments:
+        create:
+          error: S'ha produït un error en crear el comentari.
       comments_count: Número de comentaris
+      comments_title: Comentaris
       last_activity:
         new_comment_at_html: "<span>Nou comentari a %{link}</span>"
       view: Mostrar
@@ -76,7 +79,9 @@ ca:
         loading: Carregant els comentaris ...
         single_comment_warning: Pots revisar la resta de comentaris <a href="%{url}">aquí</a>.
         single_comment_warning_title: Estàs veient un sol comentari
-        title: "%{count} comentaris"
+        title:
+          one: "%{count} comentari"
+          other: "%{count} comentaris"
       down_vote_button:
         text: No estic d'acord amb aquest comentari
       up_vote_button: