decidim 0.0.4 → 0.0.5

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

@@ -6,6 +6,7 @@ module Decidim
     # to discuss or share their thoughts about the resource.
     class Comment < ApplicationRecord
       include Decidim::Authorable
+      include Decidim::Comments::Commentable
 
       # Limit the max depth of a comment tree. If C is a comment and R is a reply:
       # C          (depth 0)
@@ -16,7 +17,6 @@ module Decidim
       MAX_DEPTH = 3
 
       belongs_to :commentable, foreign_key: "decidim_commentable_id", foreign_type: "decidim_commentable_type", polymorphic: true
-      has_many :replies, as: :commentable, foreign_key: "decidim_commentable_id", foreign_type: "decidim_commentable_type", class_name: Comment
       has_many :up_votes, -> { where(weight: 1) }, foreign_key: "decidim_comment_id", class_name: CommentVote, dependent: :destroy
       has_many :down_votes, -> { where(weight: -1) }, foreign_key: "decidim_comment_id", class_name: CommentVote, dependent: :destroy
 
@@ -24,16 +24,14 @@ module Decidim
       validates :depth, numericality: { greater_than_or_equal_to: 0 }
       validates :alignment, inclusion: { in: [0, 1, -1] }
 
-      validate :commentable_can_have_replies
+      validate :commentable_can_have_comments
 
       before_save :compute_depth
 
       delegate :organization, to: :commentable
 
-      # Public: Define if a comment can have replies or not
-      #
-      # Returns a bool value to indicate if comment can have replies
-      def can_have_replies?
+      # Public: Override Commentable concern method `accepts_new_comments?`
+      def accepts_new_comments?
         depth < MAX_DEPTH
       end
 
@@ -59,10 +57,10 @@ module Decidim
 
       private
 
-      # Private: Check if commentable can have replies and if not adds
+      # Private: Check if commentable can have comments and if not adds
       # a validation error to the model
-      def commentable_can_have_replies
-        errors.add(:commentable, :cannot_have_replies) if commentable.respond_to?(:can_have_replies?) && !commentable.can_have_replies?
+      def commentable_can_have_comments
+        errors.add(:commentable, :cannot_have_comments) unless commentable.accepts_new_comments?
       end
 
       # Private: Compute comment depth inside the current comment tree

data/decidim-comments/app/queries/decidim/comments/{comments_with_replies.rb → sorted_comments.rb}

@@ -2,7 +2,7 @@
 module Decidim
   module Comments
     # A class used to find comments for a commentable resource
-    class CommentsWithReplies < Rectify::Query
+    class SortedComments < Rectify::Query
       attr_reader :commentable
 
       # Syntactic sugar to initialize the class and return the queried objects.
@@ -32,11 +32,6 @@ module Decidim
         scope = Comment
                 .where(commentable: commentable)
                 .includes(:author, :up_votes, :down_votes)
-                .includes(
-                  replies: [:author, :up_votes, :down_votes,
-                            replies: [:author, :up_votes, :down_votes,
-                                      replies: [:author, :up_votes, :down_votes]]]
-                )
 
         scope = case @options[:order_by]
                 when "older"
@@ -77,8 +72,8 @@ module Decidim
       end
 
       def count_replies(comment)
-        if comment.replies.size.positive?
-          comment.replies.size + comment.replies.map { |reply| count_replies(reply) }.sum
+        if comment.comments.size.positive?
+          comment.comments.size + comment.comments.sum { |reply| count_replies(reply) }
         else
           0
         end

data/decidim-comments/app/types/decidim/comments/commentable_interface.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+module Decidim
+  module Comments
+    # This interface represents a commentable object.
+    CommentableInterface = GraphQL::InterfaceType.define do
+      name "CommentableInterface"
+      description "A commentable interface"
+
+      field :id, !types.ID, "The commentable's ID"
+
+      field :type, !types.String, "The commentable's class name. i.e. `Decidim::ParticipatoryProcess`" do
+        property :commentable_type
+      end
+
+      field :acceptsNewComments, !types.Boolean, "Wether the object can have new comments or not" do
+        property :accepts_new_comments?
+      end
+
+      field :commentsHaveAlignment, !types.Boolean, "Wether the object comments have alignment or not" do
+        property :comments_have_alignment?
+      end
+
+      field :commentsHaveVotes, !types.Boolean, "Wether the object comments have votes or not" do
+        property :comments_have_votes?
+      end
+
+      field :comments do
+        type !types[CommentType]
+
+        argument :orderBy, types.String, "Order the comments"
+
+        resolve lambda { |obj, args, _ctx|
+          SortedComments.for(obj, order_by: args[:orderBy])
+        }
+      end
+
+      field :hasComments, !types.Boolean, "Check if the commentable has comments" do
+        resolve lambda { |obj, _args, _ctx|
+          obj.comments.size.positive?
+        }
+      end
+    end
+  end
+end

data/decidim-comments/app/types/decidim/comments/commentable_mutation_type.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+module Decidim
+  module Comments
+    CommentableMutationType = GraphQL::ObjectType.define do
+      name "CommentableMutation"
+      description "A commentable which includes its available mutations"
+
+      field :id, !types.ID, "The Commentable's unique ID"
+
+      field :addComment, Decidim::Comments::CommentType do
+        description "Add a new comment to a commentable"
+
+        argument :body, !types.String, "The comments's body"
+        argument :alignment, types.Int, "The comment's alignment. Can be 0 (neutral), 1 (in favor) or -1 (against)'", default_value: 0
+        argument :userGroupId, types.ID, "The comment's user group id. Replaces the author."
+
+        resolve lambda { |obj, args, ctx|
+          params = { "comment" => { "body" => args[:body], "alignment" => args[:alignment], "user_group_id" => args[:userGroupId] } }
+          form = Decidim::Comments::CommentForm.from_params(params)
+          Decidim::Comments::CreateComment.call(form, ctx[:current_user], obj) do
+            on(:ok) do |comment|
+              return comment
+            end
+          end
+        }
+      end
+    end
+  end
+end

data/decidim-comments/app/types/decidim/comments/commentable_type.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+module Decidim
+  module Comments
+    # This type represents a commentable object.
+    CommentableType = GraphQL::ObjectType.define do
+      name "Commentable"
+      description "A commentable object"
+
+      interfaces [
+        Decidim::Comments::CommentableInterface
+      ]
+    end
+  end
+end

data/decidim-comments/config/locales/ca.yml

@@ -2,7 +2,7 @@ ca:
   activerecord:
     errors:
       messages:
-        cannot_have_replies: no pot tenir respostes
+        cannot_have_comments: no pot tenir comentaris
   decidim:
     comments:
       comment_notification_mailer:
@@ -21,6 +21,7 @@ ca:
             subject: Tens una nova resposta del teu comentari
     components:
       add_comment_form:
+        account_message: "<a href=\"%{sign_in_url}\">Entra amb el teu compte</a> o <a href=\"%{sign_up_url}\">registra't</a> per a deixar un comentari.\n"
         form:
           body:
             label: Comentari
@@ -47,6 +48,7 @@ ca:
       comment_thread:
         title: Conversa amb %{authorName}
       comments:
+        blocked_comments_warning: Els comentaris estan desactivats a la fase actual però pots llegir els comentaris de les fases anteriors.
         loading: Carregant els comentaris ...
         title: "%{count} comentaris"
       featured_comment:

data/decidim-comments/config/locales/en.yml

@@ -3,7 +3,7 @@ en:
   activerecord:
     errors:
       messages:
-        cannot_have_replies: can't have replies
+        cannot_have_comments: can't have comments
   decidim:
     comments:
       comment_notification_mailer:
@@ -22,6 +22,8 @@ en:
             subject: You have a new reply of your comment
     components:
       add_comment_form:
+        account_message: "<a href=\"%{sign_in_url}\">Sign in with your account</a> or <a href=\"%{sign_up_url}\">sign up</a> to add your comment.
+"
         form:
           body:
             label: Comment
@@ -32,7 +34,7 @@ en:
             label: Comment as
         opinion:
           neutral: Neutral
-        title: Leave your comment
+        title: Add your comment
       comment:
         alignment:
           against: Against
@@ -48,6 +50,7 @@ en:
       comment_thread:
         title: Conversation with %{authorName}
       comments:
+        blocked_comments_warning: Comments are disabled in the current step, but you can read the comments from previous steps.
         loading: Loading comments ...
         title: "%{count} comments"
       featured_comment:

data/decidim-comments/config/locales/es.yml

@@ -2,7 +2,7 @@ es:
   activerecord:
     errors:
       messages:
-        cannot_have_replies: no pueden tener respuestas
+        cannot_have_comments: no puede tener comentarios
   decidim:
     comments:
       comment_notification_mailer:
@@ -21,6 +21,7 @@ es:
             subject: Uno de tus comentarios ha recibido respuesta
     components:
       add_comment_form:
+        account_message: "<a href=\"%{sign_in_url}\">Entra con tu cuenta</a> o <a href=\"%{sign_up_url}\">regístrate</a> para dejar tu comentario.\n"
         form:
           body:
             label: Comentario
@@ -47,6 +48,7 @@ es:
       comment_thread:
         title: Conversación con %{authorName}
       comments:
+        blocked_comments_warning: Los comentarios estan desactivados en la fase actual pero puedes leer los comentarios de las fases anteriores.
         loading: Cargando los comentarios ...
         title: "%{count} comentarios"
       featured_comment:

data/decidim-comments/lib/decidim/comments.rb

@@ -7,5 +7,9 @@ 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"
   end
 end

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

@@ -6,6 +6,10 @@ module Decidim
       name "Comment"
       description "A comment"
 
+      interfaces [
+        Decidim::Comments::CommentableInterface
+      ]
+
       field :id, !types.ID, "The Comment's unique ID"
 
       field :body, !types.String, "The comment message"
@@ -16,28 +20,12 @@ module Decidim
         }
       end
 
-      field :author, !Decidim::Api::AuthorInterface, "The comment's author" do
+      field :author, !Decidim::AuthorInterface, "The comment's author" do
         resolve lambda { |obj, _args, _ctx|
           obj.user_group || obj.author
         }
       end
 
-      field :replies, !types[CommentType], "The comment's replies" do
-        resolve lambda { |obj, _args, _ctx|
-          obj.replies.sort_by(&:created_at)
-        }
-      end
-
-      field :hasReplies, !types.Boolean, "Check if the comment has replies" do
-        resolve lambda { |obj, _args, _ctx|
-          obj.replies.size.positive?
-        }
-      end
-
-      field :canHaveReplies, !types.Boolean, "Define if a comment can or not have replies" do
-        property :can_have_replies?
-      end
-
       field :alignment, types.Int, "The comment's alignment. Can be 0 (neutral), 1 (in favor) or -1 (against)'"
 
       field :upVotes, !types.Int, "The number of comment's upVotes" do
@@ -63,6 +51,12 @@ module Decidim
           obj.down_voted_by?(ctx[:current_user])
         }
       end
+
+      field :hasComments, !types.Boolean, "Check if the commentable has comments" do
+        resolve lambda { |obj, _args, _ctx|
+          obj.accepts_new_comments? && obj.comments.size.positive?
+        }
+      end
     end
   end
 end

data/decidim-comments/lib/decidim/comments/commentable.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Decidim
+  module Comments
+    # Shared behaviour for commentable models.
+    module Commentable
+      extend ActiveSupport::Concern
+
+      included do
+        include Decidim::Authorable
+
+        has_many :comments, as: :commentable, foreign_key: "decidim_commentable_id", foreign_type: "decidim_commentable_type", class_name: "Decidim::Comments::Comment"
+
+        # Public: Wether the object's comments are visible or not.
+        def commentable?
+          true
+        end
+
+        # Public: Wether the object can have new comments or not.
+        def accepts_new_comments?
+          true
+        end
+
+        # Public: Wether the object's comments can have alignment or not. It enables the
+        # alignment selector in the add new comment form.
+        def comments_have_alignment?
+          false
+        end
+
+        # Public: Wether the object's comments can have have votes or not. It enables the
+        # upvote and downvote buttons for comments.
+        def comments_have_votes?
+          false
+        end
+
+        # Public: Identifies the commentable type in the API.
+        def commentable_type
+          self.class.name
+        end
+      end
+    end
+  end
+end

data/decidim-comments/lib/decidim/comments/comments_helper.rb

@@ -3,22 +3,28 @@ module Decidim
   module Comments
     # A helper to expose the comments component for a commentable
     module CommentsHelper
-      # Creates a Comments component which is rendered using `react_ujs`
-      # from react-rails gem
+      # Render commentable comments inside the `expanded` template content.
       #
       # resource - A commentable resource
-      # options - A hash of options (default: {})
-      #           :arguable - A boolean value to indicate if tihs option is available
+      def comments_for(resource)
+        return unless resource.commentable?
+        content_for :expanded do
+          inline_comments_for(resource)
+        end
+      end
+
+      # Creates a Comments component which is rendered using `ReactDOM`
       #
-      # Returns a div which contain a RectComponent to be rendered by `react_ujs`
-      def comments_for(resource, options = {})
-        commentable_type = resource.class.name
+      # resource - A commentable resource
+      #
+      # Returns a div which contain a RectComponent
+      def inline_comments_for(resource)
+        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,
-                                          options: options.slice(:arguable, :votable),
                                           locale: I18n.locale)
       end
 
@@ -35,7 +41,6 @@ module Decidim
               {
                 commentableType: "#{props[:commentableType]}",
                 commentableId: "#{props[:commentableId]}",
-                options: JSON.parse("#{j(props[:options].to_json)}"),
                 locale: "#{props[:locale]}"
               }
             );

data/decidim-comments/lib/decidim/comments/mutation_extensions.rb

@@ -11,28 +11,20 @@ module Decidim
       # Returns nothing.
       def self.extend!(type)
         type.define do
-          field :addComment, Decidim::Comments::CommentType do
-            description "Add a new comment to a commentable"
-            argument :commentableId, !types.String, "The commentable's ID"
-            argument :commentableType, !types.String, "The commentable's class name. i.e. `Decidim::ParticipatoryProcess`"
-            argument :body, !types.String, "The comments's body"
-            argument :alignment, types.Int, "The comment's alignment. Can be 0 (neutral), 1 (in favor) or -1 (against)'", default_value: 0
-            argument :userGroupId, types.ID, "The comment's user group id. Replaces the author."
+          field :commentable, Decidim::Comments::CommentableMutationType do
+            description "A commentable"
 
-            resolve lambda { |_obj, args, ctx|
-              params = { "comment" => { "body" => args[:body], "alignment" => args[:alignment], "user_group_id" => args[:userGroupId] } }
-              form = Decidim::Comments::CommentForm.from_params(params)
-              commentable = args[:commentableType].constantize.find(args[:commentableId])
-              Decidim::Comments::CreateComment.call(form, ctx[:current_user], commentable) do
-                on(:ok) do |comment|
-                  return comment
-                end
-              end
+            argument :id, !types.String, "The commentable's ID"
+            argument :type, !types.String, "The commentable's class name. i.e. `Decidim::ParticipatoryProcess`"
+
+            resolve lambda { |_obj, args, _ctx|
+              args[:type].constantize.find(args[:id])
             }
           end
 
           field :comment, Decidim::Comments::CommentMutationType do
             description "A comment"
+
             argument :id, !types.ID, "The comment's id"
 
             resolve lambda { |_obj, args, _ctx|