decidim-comments 0.23.2 → 0.24.0

data/lib/decidim/api/comment_type.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Comments
+    # This type represents a comment on a commentable object.
+    class CommentType < Decidim::Api::Types::BaseObject
+      description "A comment"
+
+      implements Decidim::Comments::CommentableInterface
+      field :author, Decidim::Core::AuthorInterface, "The resource author", null: false
+
+      field :id, GraphQL::Types::ID, "The Comment's unique ID", null: false
+
+      field :sgid, GraphQL::Types::String, "The Comment's signed global id", null: false
+
+      field :body, GraphQL::Types::String, "The comment message", null: false
+
+      field :formatted_body, GraphQL::Types::String, "The comment message ready to display (it is expected to include HTML)", null: false
+
+      field :created_at, GraphQL::Types::String, "The creation date of the comment", null: false
+
+      field :formatted_created_at, GraphQL::Types::String, "The creation date of the comment in relative format", null: false
+
+      field :alignment, GraphQL::Types::Int, "The comment's alignment. Can be 0 (neutral), 1 (in favor) or -1 (against)'", null: true
+
+      field :up_votes, GraphQL::Types::Int, "The number of comment's upVotes", null: false
+
+      field :up_voted, GraphQL::Types::Boolean, "Check if the current user has upvoted the comment", null: false
+
+      field :down_votes, GraphQL::Types::Int, "The number of comment's downVotes", null: false
+
+      field :down_voted, GraphQL::Types::Boolean, "Check if the current user has downvoted the comment", null: false
+
+      field :has_comments, GraphQL::Types::Boolean, "Check if the commentable has comments", method: :has_comments?, null: false
+
+      field :already_reported, GraphQL::Types::Boolean, "Check if the current user has reported the comment", null: false
+
+      field :user_allowed_to_comment, GraphQL::Types::Boolean, "Check if the current user can comment", null: false
+
+      def author
+        object.user_group || object.author
+      end
+
+      def sgid
+        object.to_sgid.to_s
+      end
+
+      def body
+        object.translated_body
+      end
+
+      def created_at
+        object.created_at.iso8601
+      end
+
+      def formatted_created_at
+        object.friendly_created_at
+      end
+
+      def up_votes
+        object.up_votes.size
+      end
+
+      def up_voted
+        object.up_voted_by?(context[:current_user])
+      end
+
+      def down_votes
+        object.down_votes.size
+      end
+
+      def down_voted
+        object.down_voted_by?(context[:current_user])
+      end
+
+      def has_comments?
+        object.comment_threads.size.positive?
+      end
+
+      def already_reported
+        object.reported_by?(context[:current_user])
+      end
+
+      def user_allowed_to_comment
+        object.root_commentable.commentable? && object.root_commentable.user_allowed_to_comment?(context[:current_user])
+      end
+    end
+  end
+end

data/lib/decidim/api/commentable_interface.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Comments
+    # This interface represents a commentable object.
+    module CommentableInterface
+      include Decidim::Api::Types::BaseInterface
+      description "A commentable interface"
+
+      field :id, GraphQL::Types::ID, "The commentable's ID", null: false
+
+      field :type, GraphQL::Types::String, "The commentable's class name. i.e. `Decidim::ParticipatoryProcess`", method: :commentable_type, null: false
+
+      field :accepts_new_comments, GraphQL::Types::Boolean, "Whether the object can have new comments or not", method: :accepts_new_comments?, null: false
+
+      field :comments_have_alignment, GraphQL::Types::Boolean, "Whether the object comments have alignment or not", method: :comments_have_alignment?, null: false
+
+      field :comments_have_votes, GraphQL::Types::Boolean, "Whether the object comments have votes or not", method: :comments_have_votes?, null: false
+
+      field :comments, [Decidim::Comments::CommentType], null: false do
+        argument :order_by, GraphQL::Types::String, "Order the comments", required: false
+        argument :single_comment_id, GraphQL::Types::String, "ID of the single comment to look at", required: false
+      end
+
+      field :total_comments_count, GraphQL::Types::Int, description: "The number of comments in all levels this resource holds", null: false
+
+      def comments(order_by: nil, single_comment_id: nil)
+        SortedComments.for(object, order_by: order_by, id: single_comment_id)
+      end
+
+      def total_comments_count
+        object.comments_count
+      end
+
+      field :has_comments, GraphQL::Types::Boolean, "Check if the commentable has comments", null: false
+
+      # rubocop:disable Naming/PredicateName
+      def has_comments
+        object.comment_threads.size.positive?
+      end
+      # rubocop:enable Naming/PredicateName
+
+      field :user_allowed_to_comment, GraphQL::Types::Boolean, "Check if the current user can comment", null: false
+
+      def user_allowed_to_comment
+        object.commentable? && object.user_allowed_to_comment?(context[:current_user])
+      end
+    end
+  end
+end

data/lib/decidim/api/commentable_mutation_type.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Comments
+    class CommentableMutationType < Decidim::Api::Types::BaseObject
+      description "A commentable which includes its available mutations"
+
+      field :id, GraphQL::Types::ID, "The Commentable's unique ID", null: false
+
+      field :add_comment, Decidim::Comments::CommentType, description: "Add a new comment to a commentable", null: true do
+        argument :body, GraphQL::Types::String, "The comments's body", required: true
+        argument :alignment, GraphQL::Types::Int, "The comment's alignment. Can be 0 (neutral), 1 (in favor) or -1 (against)'", default_value: 0, required: false
+        argument :user_group_id, GraphQL::Types::ID, "The comment's user group id. Replaces the author.", required: false
+      end
+
+      def add_comment(body:, alignment: nil, user_group_id: nil)
+        params = { "comment" => { "body" => body, "alignment" => alignment, "user_group_id" => user_group_id, "commentable" => object } }
+        form = Decidim::Comments::CommentForm.from_params(params).with_context(
+          current_organization: context[:current_organization],
+          current_component: object.component
+        )
+        Decidim::Comments::CreateComment.call(form, context[:current_user]) do
+          on(:ok) do |comment|
+            return comment
+          end
+        end
+      end
+    end
+  end
+end

data/{app/types/decidim/comments → lib/decidim/api}/commentable_type.rb

@@ -3,13 +3,10 @@
 module Decidim
   module Comments
     # This type represents a commentable object.
-    CommentableType = GraphQL::ObjectType.define do
-      name "Commentable"
+    class CommentableType < Decidim::Api::Types::BaseObject
       description "A commentable object"
 
-      interfaces [
-        -> { Decidim::Comments::CommentableInterface }
-      ]
+      implements Decidim::Comments::CommentableInterface
     end
   end
 end

data/lib/decidim/comments.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "decidim/comments/admin"
+require "decidim/comments/api"
 require "decidim/comments/engine"
 require "decidim/comments/admin_engine"
 
@@ -10,9 +11,6 @@ module Decidim
   # a React component which handle all the comments render and logic.
   module Comments
     autoload :CommentsHelper, "decidim/comments/comments_helper"
-    autoload :AddCommentType, "decidim/comments/api/add_comment_type"
-    autoload :CommentMutationType, "decidim/comments/api/comment_mutation_type"
-    autoload :CommentType, "decidim/comments/api/comment_type"
     autoload :Commentable, "decidim/comments/commentable"
     autoload :CommentSerializer, "decidim/comments/comment_serializer"
     autoload :CommentVoteSerializer, "decidim/comments/comment_vote_serializer"

data/lib/decidim/comments/api.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Comments
+    autoload :CommentableInterface, "decidim/api/commentable_interface"
+    autoload :AddCommentType, "decidim/api/add_comment_type"
+    autoload :CommentMutationType, "decidim/api/comment_mutation_type"
+    autoload :CommentType, "decidim/api/comment_type"
+    autoload :CommentableType, "decidim/api/commentable_type"
+    autoload :CommentableMutationType, "decidim/api/commentable_mutation_type"
+  end
+end

data/lib/decidim/comments/comments_helper.rb

@@ -15,63 +15,21 @@ module Decidim
         end
       end
 
-      # Creates a Comments component which is rendered using `ReactDOM`
+      # Creates a Comments component through the comments cell.
       #
       # resource - A commentable resource
       #
-      # Returns a div which contain a RectComponent
-      def inline_comments_for(resource)
+      # Returns the comments cell
+      def inline_comments_for(resource, options = {})
         return unless resource.commentable?
 
-        commentable_type = resource.commentable_type
-        commentable_id = resource.id.to_s
-        node_id = "comments-for-#{commentable_type.demodulize}-#{commentable_id}"
-        react_comments_component(
-          node_id, commentableType: commentable_type,
-                   commentableId: commentable_id,
-                   locale: I18n.locale,
-                   toggleTranslations: machine_translations_toggled?,
-                   commentsMaxLength: comments_max_length(resource)
-        )
-      end
-
-      # Private: Render Comments component using inline javascript
-      #
-      # node_id - The id of the DOMElement to render the React component
-      # props   - A hash corresponding to Comments component props
-      def react_comments_component(node_id, props)
-        content_tag("div", "", id: node_id) +
-          javascript_include_tag("decidim/comments/comments") +
-          javascript_tag(%{
-            window.DecidimComments.renderCommentsComponent(
-              '#{node_id}',
-              {
-                commentableType: "#{props[:commentableType]}",
-                commentableId: "#{props[:commentableId]}",
-                locale: "#{props[:locale]}",
-                toggleTranslations: #{props[:toggleTranslations]},
-                commentsMaxLength: "#{props[:commentsMaxLength]}"
-              }
-            );
-          })
-      end
-
-      def comments_max_length(resource)
-        return 1000 unless resource.respond_to?(:component)
-        return component_comments_max_length(resource) if component_comments_max_length(resource)
-        return organization_comments_max_length(resource) if organization_comments_max_length(resource)
-
-        1000
-      end
-
-      def component_comments_max_length(resource)
-        return unless resource.component&.settings.respond_to?(:comments_max_length)
-
-        resource.component.settings.comments_max_length if resource.component.settings.comments_max_length.positive?
-      end
-
-      def organization_comments_max_length(resource)
-        resource.component.organization.comments_max_length if resource.component.organization.comments_max_length.positive?
+        cell(
+          "decidim/comments/comments",
+          resource,
+          machine_translations: machine_translations_toggled?,
+          single_comment: params.fetch("commentId", nil),
+          order: options[:order]
+        ).to_s
       end
     end
   end

data/lib/decidim/comments/engine.rb

@@ -19,20 +19,22 @@ module Decidim
     class Engine < ::Rails::Engine
       isolate_namespace Decidim::Comments
 
+      routes do
+        resources :comments, only: [:index, :create] do
+          resources :votes, only: [:create]
+        end
+      end
+
       initializer "decidim_comments.assets" do |app|
         app.config.assets.precompile += %w(decidim_comments_manifest.js)
       end
 
       initializer "decidim_comments.query_extensions" do
-        Decidim::Api::QueryType.define do
-          QueryExtensions.define(self)
-        end
+        Decidim::Api::QueryType.include QueryExtensions
       end
 
       initializer "decidim_comments.mutation_extensions" do
-        Decidim::Api::MutationType.define do
-          MutationExtensions.define(self)
-        end
+        Decidim::Api::MutationType.include MutationExtensions
       end
 
       initializer "decidim.stats" do
@@ -63,7 +65,7 @@ module Decidim
       initializer "decidim_comments.register_resources" do
         Decidim.register_resource(:comment) do |resource|
           resource.model_class_name = "Decidim::Comments::Comment"
-          resource.card = "decidim/comments/comment"
+          resource.card = "decidim/comments/comment_card"
           resource.searchable = true
         end
       end

data/lib/decidim/comments/mutation_extensions.rb

@@ -10,36 +10,36 @@ module Decidim
       # type - A GraphQL::BaseType to extend.
       #
       # Returns nothing.
-      def self.define(type)
-        type.field :commentable, Decidim::Comments::CommentableMutationType do
+      def self.included(type)
+        type.field :commentable, Decidim::Comments::CommentableMutationType, null: false do
           description "A commentable"
 
-          argument :id, !types.String, "The commentable's ID"
-          argument :type, !types.String, "The commentable's class name. i.e. `Decidim::ParticipatoryProcess`"
-          argument :locale, !types.String, "The locale for which to get the comments text"
-          argument :toggleTranslations, !types.Boolean, "Whether the user asked to toggle the machine translations or not."
-
-          resolve lambda { |_obj, args, _ctx|
-            I18n.locale = args[:locale].presence
-            RequestStore.store[:toggle_machine_translations] = args[:toggleTranslations]
-            args[:type].constantize.find(args[:id])
-          }
+          argument :id, GraphQL::Types::String, "The commentable's ID", required: true
+          argument :type, GraphQL::Types::String, "The commentable's class name. i.e. `Decidim::ParticipatoryProcess`", required: true
+          argument :locale, GraphQL::Types::String, "The locale for which to get the comments text", required: false
+          argument :toggle_translations, GraphQL::Types::Boolean, "Whether the user asked to toggle the machine translations or not.", required: false
         end
 
-        type.field :comment, Decidim::Comments::CommentMutationType do
+        type.field :comment, Decidim::Comments::CommentMutationType, null: false do
           description "A comment"
 
-          argument :id, !types.ID, "The comment's id"
-          argument :locale, !types.String, "The locale for which to get the comments text"
-          argument :toggleTranslations, !types.Boolean, "Whether the user asked to toggle the machine translations or not."
-
-          resolve lambda { |_obj, args, _ctx|
-            I18n.locale = args[:locale].presence
-            RequestStore.store[:toggle_machine_translations] = args[:toggleTranslations]
-            Comment.find(args["id"])
-          }
+          argument :id, GraphQL::Types::ID, "The comment's id", required: true
+          argument :locale, GraphQL::Types::String, "The locale for which to get the comments text", required: false
+          argument :toggle_translations, GraphQL::Types::Boolean, "Whether the user asked to toggle the machine translations or not.", required: false
         end
       end
+
+      def commentable(id:, type:, locale: Decidim.default_locale, toggle_translations: false)
+        I18n.locale = locale.presence
+        RequestStore.store[:toggle_machine_translations] = toggle_translations
+        type.constantize.find(id)
+      end
+
+      def comment(id:, locale: Decidim.default_locale, toggle_translations: false)
+        I18n.locale = locale.presence
+        RequestStore.store[:toggle_machine_translations] = toggle_translations
+        Comment.find(id)
+      end
     end
   end
 end

data/lib/decidim/comments/query_extensions.rb

@@ -10,22 +10,20 @@ module Decidim
       # type - A GraphQL::BaseType to extend.
       #
       # Returns nothing.
-      def self.define(type)
-        type.field :commentable do
-          type !CommentableType
-
-          argument :id, !types.String, "The commentable's ID"
-          argument :type, !types.String, "The commentable's class name. i.e. `Decidim::ParticipatoryProcess`"
-          argument :locale, !types.String, "The locale for which to get the comments text"
-          argument :toggleTranslations, !types.Boolean, "Whether the user asked to toggle the machine translations or not."
-
-          resolve lambda { |_obj, args, _ctx|
-            I18n.locale = args[:locale].presence
-            RequestStore.store[:toggle_machine_translations] = args[:toggleTranslations]
-            args[:type].constantize.find(args[:id])
-          }
+      def self.included(type)
+        type.field :commentable, CommentableType, null: false do
+          argument :id, GraphQL::Types::String, "The commentable's ID", required: true
+          argument :type, GraphQL::Types::String, "The commentable's class name. i.e. `Decidim::ParticipatoryProcess`", required: true
+          argument :locale, GraphQL::Types::String, "The locale for which to get the comments text", required: true
+          argument :toggle_translations, GraphQL::Types::Boolean, "Whether the user asked to toggle the machine translations or not.", required: true
         end
       end
+
+      def commentable(id:, locale:, toggle_translations:, type:)
+        I18n.locale = locale.presence
+        RequestStore.store[:toggle_machine_translations] = toggle_translations
+        type.constantize.find(id)
+      end
     end
   end
 end

data/lib/decidim/comments/test.rb

@@ -2,3 +2,4 @@
 
 require "decidim/comments/test/shared_examples/create_comment_context"
 require "decidim/comments/test/shared_examples/comment_event"
+require "decidim/comments/test/shared_examples/comment_voted_event"

data/lib/decidim/comments/test/shared_examples/comment_voted_event.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+shared_examples_for "a comment voted event" do
+  include_context "when it's a comment event"
+
+  let(:resource) { comment.commentable }
+
+  let(:comment) { create :comment }
+  let(:comment_vote) { create :comment_vote, comment: comment }
+  let(:comment_vote_author) { comment_vote.author }
+
+  let(:extra) { { comment_id: comment.id, author_id: comment_vote_author.id, weight: weight, downvotes: 100, upvotes: 999 } }
+  let(:resource_title) { decidim_html_escape(translated(resource.title)) }
+  let(:resource_text) { subject.resource_text }
+
+  let(:verb) { weight.positive? ? "upvoted" : "downvoted" }
+
+  describe "downvotes" do
+    it "outputs the total downvotes" do
+      expect(subject.downvotes).to eq(100)
+    end
+  end
+
+  describe "upvotes" do
+    it "outputs the total upvotes" do
+      expect(subject.upvotes).to eq(999)
+    end
+  end
+
+  describe "resource_text" do
+    it "outputs the comment body" do
+      expect(subject.resource_text).to eq comment.formatted_body
+    end
+  end
+
+  describe "email_subject" do
+    it "is generated correctly" do
+      expect(subject.email_subject).to eq("Your comment in \"#{resource_title}\" has been #{verb}.")
+    end
+  end
+
+  describe "email_intro" do
+    it "is generated correctly" do
+      expect(subject.email_intro).to eq("Your comment in \"#{resource_title}\" has been #{verb}. It now has a total of 999 upvotes and 100 downvotes.")
+    end
+  end
+
+  describe "email_outro" do
+    it "is generated correctly" do
+      expect(subject.email_outro)
+        .to eq("You have received this notification because you are the author of this comment.")
+    end
+  end
+
+  describe "notification_title" do
+    it "is generated correctly" do
+      expect(subject.notification_title)
+        .to include("Your <a href=\"#{resource_path}#comment_#{comment.id}\">comment</a> in \"#{resource_title}\" has been #{verb}")
+      expect(subject.notification_title)
+        .to include("It now has a total of 999 upvotes and 100 downvotes.")
+    end
+  end
+end