decidim-comments 0.29.2 → 0.30.0.rc1

data/lib/decidim/api/comment_type.rb

@@ -4,37 +4,24 @@ module Decidim
   module Comments
     # This type represents a comment on a commentable object.
     class CommentType < Decidim::Api::Types::BaseObject
-      description "A comment"
-
+      implements Decidim::Core::TimestampsInterface
       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
+      description "A comment"
 
       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 :already_reported, GraphQL::Types::Boolean, "Check if the current user has reported the comment", null: false
+      field :author, Decidim::Core::AuthorInterface, "The resource author", null: false
+      field :body, GraphQL::Types::String, "The comment message", null: false, method: :translated_body
       field :down_voted, GraphQL::Types::Boolean, "Check if the current user has downvoted the comment", null: false
-
+      field :down_votes, GraphQL::Types::Int, "The number of comment's downVotes", null: false, method: :down_votes_count
+      field :formatted_body, GraphQL::Types::String, "The comment message ready to display (it is expected to include HTML)", null: false
+      field :formatted_created_at, GraphQL::Types::String, "The creation date of the comment in relative format", null: false, method: :friendly_created_at
       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 :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 :up_voted, GraphQL::Types::Boolean, "Check if the current user has upvoted the comment", null: false
+      field :up_votes, GraphQL::Types::Int, "The number of comment's upVotes", null: false, method: :up_votes_count
       field :user_allowed_to_comment, GraphQL::Types::Boolean, "Check if the current user can comment", null: false
 
       def author
@@ -45,30 +32,10 @@ module Decidim
         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_count
-      end
-
       def up_voted
         object.up_voted_by?(context[:current_user])
       end
 
-      def down_votes
-        object.down_votes_count
-      end
-
       def down_voted
         object.down_voted_by?(context[:current_user])
       end

data/lib/decidim/api/commentable_interface.rb

@@ -8,40 +8,28 @@ module Decidim
       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 }], null: false do
+      field :total_comments_count, GraphQL::Types::Int, description: "The number of comments in all levels this resource holds", method: :comments_count, null: false
+      field :has_comments, GraphQL::Types::Boolean, "Check if the commentable has comments", null: false
+      field :user_allowed_to_comment, GraphQL::Types::Boolean, "Check if the current user can comment", null: false
+      field :comments, [Decidim::Comments::CommentType, { null: false }], "The list of replies in this comment", 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:, id: single_comment_id).not_hidden
       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.not_hidden.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

data/lib/decidim/api/commentable_mutation_type.rb

@@ -5,13 +5,12 @@ module Decidim
     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 :body, GraphQL::Types::String, "The comments's body", required: true
         argument :user_group_id, GraphQL::Types::ID, "The comment's user group id. Replaces the author.", required: false
       end
+      field :id, GraphQL::Types::ID, "The Commentable's unique ID", null: false
 
       def add_comment(body:, alignment: nil, user_group_id: nil)
         params = { "comment" => { "body" => body, "alignment" => alignment, "user_group_id" => user_group_id, "commentable" => object } }

data/lib/decidim/comments/commentable.rb

@@ -67,6 +67,17 @@ module Decidim
           update_columns(comments_count:, updated_at: Time.current)
         end
         # rubocop:enable Rails/SkipsModelValidations
+
+        # Public: Returns an array with extra actions available for a comment and a user.
+        # Returns an array of hashes with the following keys:
+        #   - label: The label to be displayed in the UI.
+        #   - url: The action to be performed when the user clicks the label.
+        #   - method: The HTTP method to be used when performing the action (optional).
+        #   - icon: The icon to be displayed next to the label (optional).
+        #   - data: Any "data-*" attributes to be included in the link (optional).
+        def actions_for_comment(_comment, _current_user)
+          []
+        end
       end
     end
   end

data/lib/decidim/comments/engine.rb

@@ -4,7 +4,6 @@ require "rails"
 require "active_support/all"
 
 require "decidim/core"
-require "foundation_rails_helper"
 
 require "decidim/comments/query_extensions"
 require "decidim/comments/mutation_extensions"
@@ -21,6 +20,12 @@ module Decidim
         end
       end
 
+      initializer "decidim_comments.mount_routes" do
+        Decidim::Core::Engine.routes do
+          mount Decidim::Comments::Engine, at: "/", as: "decidim_comments"
+        end
+      end
+
       initializer "decidim_comments.query_extensions" do
         Decidim::Api::QueryType.include QueryExtensions
       end
@@ -42,6 +47,7 @@ module Decidim
 
         Decidim.icons.register(name: "Decidim::Comments::Comment", icon: "chat-1-line", description: "Comment", category: "activity", engine: :comments)
         Decidim.icons.register(name: "comments_count", icon: "wechat-line", description: "Comments Count", category: "activity", engine: :comments)
+        Decidim.icons.register(name: "star-s-line", icon: "star-s-line", description: "Most upvoted comment", category: "activity", engine: :comments)
 
         Decidim.icons.register(name: "thumb-up-line", icon: "thumb-up-line", description: "Upvote comment button", **common_parameters)
         Decidim.icons.register(name: "thumb-up-fill", icon: "thumb-up-fill", description: "User upvoted comment", **common_parameters)

data/lib/decidim/comments/test/factories.rb

@@ -46,6 +46,14 @@ FactoryBot.define do
         create(:moderation, reportable: comment, hidden_at: 2.days.ago, skip_injection: evaluator.skip_injection)
       end
     end
+
+    trait :in_favor do
+      alignment { 1 }
+    end
+
+    trait :against do
+      alignment { -1 }
+    end
   end
 
   factory :comment_vote, class: "Decidim::Comments::CommentVote" do

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

@@ -10,7 +10,7 @@ shared_context "when it is a comment event" do
 
   let(:resource) { comment.commentable }
 
-  let(:comment) { create :comment }
+  let(:comment) { create(:comment) }
   let(:comment_author) { comment.author }
   let(:normalized_comment_author) { comment.author }
   let(:comment_author_name) { decidim_html_escape comment.author.name }

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

@@ -7,8 +7,8 @@ shared_examples_for "a comment voted event" do
 
   let(:resource) { comment.commentable }
 
-  let(:comment) { create :comment }
-  let(:comment_vote) { create :comment_vote, comment: }
+  let(:comment) { create(:comment) }
+  let(:comment_vote) { create(:comment_vote, comment:) }
   let(:comment_vote_author) { comment_vote.author }
 
   let(:extra) { { comment_id: comment.id, author_id: comment_vote_author.id, weight:, downvotes: 100, upvotes: 999 } }

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

@@ -7,7 +7,7 @@ RSpec.shared_context "when creating a comment" do
   let(:user) { create(:user, organization:) }
   let(:author) { create(:user, organization:) }
   let(:current_user) { author }
-  let(:dummy_resource) { create :dummy_resource, component: }
+  let(:dummy_resource) { create(:dummy_resource, component:) }
   let(:commentable) { dummy_resource }
   let(:body) { Faker::Lorem.paragraph }
   let(:alignment) { 1 }

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

@@ -6,10 +6,10 @@ shared_examples_for "a translated comment event" do
   describe "translated notifications" do
     let(:en_body) { "This is Sparta!" }
     let(:body) { { en: en_body, machine_translations: { ca: "C'est Sparta!" } } }
-    let(:participatory_process) { create :participatory_process, organization: }
+    let(:participatory_process) { create(:participatory_process, organization:) }
     let(:component) { create(:component, participatory_space: participatory_process) }
     let(:commentable) { create(:dummy_resource, component:) }
-    let(:comment) { create :comment, body:, commentable: }
+    let(:comment) { create(:comment, body:, commentable:) }
     let(:en_version) { "<div><p>#{comment.body["en"]}</p></div>" }
     let(:machine_translated) { "<div><p>#{comment.body["machine_translations"]["ca"]}</p></div>" }
 

data/lib/decidim/comments/version.rb

@@ -4,7 +4,7 @@ module Decidim
   # This holds the decidim-comments version.
   module Comments
     def self.version
-      "0.29.2"
+      "0.30.0.rc1"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: decidim-comments
 version: !ruby/object:Gem::Version
-  version: 0.29.2
+  version: 0.30.0.rc1
 platform: ruby
 authors:
 - Josep Jaume Rey Peroy
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-12 00:00:00.000000000 Z
+date: 2025-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: decidim-core
@@ -18,14 +18,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.29.2
+        version: 0.30.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.29.2
+        version: 0.30.0.rc1
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -52,28 +52,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.29.2
+        version: 0.30.0.rc1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.29.2
+        version: 0.30.0.rc1
 - !ruby/object:Gem::Dependency
   name: decidim-dev
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.29.2
+        version: 0.30.0.rc1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.29.2
+        version: 0.30.0.rc1
 description: Pluggable comments system for some components.
 email:
 - josepjaume@gmail.com
@@ -105,6 +105,7 @@ files:
 - app/cells/decidim/comments/comment_thread_cell.rb
 - app/cells/decidim/comments/comments/add_comment.erb
 - app/cells/decidim/comments/comments/blocked_comments_warning.erb
+- app/cells/decidim/comments/comments/comments_in_single_column.erb
 - app/cells/decidim/comments/comments/comments_loading.erb
 - app/cells/decidim/comments/comments/order_control.erb
 - app/cells/decidim/comments/comments/show.erb
@@ -113,6 +114,9 @@ files:
 - app/cells/decidim/comments/comments_cell.rb
 - app/cells/decidim/comments/edit_comment_modal_form/show.erb
 - app/cells/decidim/comments/edit_comment_modal_form_cell.rb
+- app/cells/decidim/comments/two_columns_comments/column.erb
+- app/cells/decidim/comments/two_columns_comments/show.erb
+- app/cells/decidim/comments/two_columns_comments_cell.rb
 - app/commands/decidim/comments/create_comment.rb
 - app/commands/decidim/comments/delete_comment.rb
 - app/commands/decidim/comments/update_comment.rb
@@ -142,6 +146,8 @@ files:
 - app/packs/src/decidim/comments/comments.component.test.js
 - app/packs/src/decidim/comments/comments.component_for_testing.js
 - app/packs/src/decidim/comments/comments.js
+- app/packs/src/decidim/comments/comments_dropdown.js
+- app/packs/src/decidim/comments/comments_mobile_modal.js
 - app/packs/stylesheets/comments.scss
 - app/permissions/decidim/comments/permissions.rb
 - app/queries/decidim/comments/metrics/comment_participants_metric_measure.rb
@@ -316,14 +322,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: 3.2.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Decidim comments module