decidim-comments 0.0.3 → 0.0.5

data/app/frontend/comments/vote_button.component.jsx

@@ -24,4 +24,9 @@ VoteButton.propTypes = {
   disabled: PropTypes.bool
 };
 
+VoteButton.defaultProps = {
+  selectedClass: "selected",
+  disabled: false
+};
+
 export default VoteButton;

data/app/frontend/comments/vote_button_component.test.jsx

@@ -12,7 +12,7 @@ describe("<VoteButton />", () => {
 
   it("should render the number of votes passed as a prop", () => {
     const wrapper = shallow(<VoteButton votes={10} buttonClassName="vote-button" iconName="vote-icon" voteAction={voteAction} />);
-    expect(wrapper.find('button')).to.include.text(10);
+    expect(wrapper.find('button').text()).to.match(/10/);
   });
 
   it("should render a button with the given buttonClassName", () => {

data/app/frontend/entry.test.js

@@ -9,6 +9,8 @@ import chaiEnzyme       from 'chai-enzyme';
 import loadTranslations from './support/load_translations';
 import requireAll       from './support/require_all';
 
+require('jquery');
+
 // 
 chai.use(sinonChai)
 chai.use(chaiAsPromised)

data/app/frontend/support/generate_comments_data.js

@@ -1,6 +1,6 @@
 import { random, name, date, image } from 'faker/locale/en';
 
-/** 
+/**
  * Generate random comment data to emulate a database real content
  * @param {number} num - The number of comments to generate random data
  * @returns {Object[]} - An array of objects representing comments data
@@ -17,9 +17,9 @@ const generateCommentsData = (num = 1) => {
         name: name.findName(),
         avatarUrl: image.imageUrl()
       },
-      hasReplies: false,
-      replies: [],
-      canHaveReplies: true,
+      hasComments: false,
+      comments: [],
+      acceptsNewComments: true,
       alignment: 0,
       upVotes: random.number(),
       upVoted: false,

data/app/mailers/decidim/comments/comment_notification_mailer.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+module Decidim
+  module Comments
+    # A custom mailer for sending notifications to users when
+    # a comment is created.
+    class CommentNotificationMailer < Decidim::ApplicationMailer
+      helper Decidim::ResourceHelper
+
+      def comment_created(user, comment, commentable)
+        with_user(user) do
+          @comment = comment
+          @commentable = commentable
+          @organization = commentable.organization
+          subject = I18n.t("comment_created.subject", scope: "decidim.comments.mailer.comment_notification")
+          mail(to: commentable.author.email, subject: subject)
+        end
+      end
+
+      def reply_created(user, reply, comment, commentable)
+        with_user(user) do
+          @reply = reply
+          @comment = comment
+          @commentable = commentable
+          @organization = commentable.organization
+          subject = I18n.t("reply_created.subject", scope: "decidim.comments.mailer.comment_notification")
+          mail(to: comment.author.email, subject: subject)
+        end
+      end
+    end
+  end
+end

data/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
 
@@ -51,12 +49,18 @@ module Decidim
         down_votes.any? { |vote| vote.author == user }
       end
 
+      # Public: Returns the commentable object of the parent comment
+      def root_commentable
+        return commentable if depth == 0
+        commentable.root_commentable
+      end
+
       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/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/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/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/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/app/views/decidim/comments/comment_notification_mailer/comment_created.html.erb

@@ -0,0 +1,18 @@
+<p><%= t("decidim.comments.comment_notification_mailer.hello", name: @commentable.author.name) %></p>
+
+<p>
+  <%=
+    t(".new_comment_html", {
+      commenter: @comment.author.name,
+      commentable_link: link_to(@commentable.title, decidim_resource_url(@commentable))
+    })
+  %>
+</p>
+
+<blockquote>
+  <%= @comment.body %>
+</blockquote>
+
+<p>
+  <%= t("decidim.comments.comment_notification_mailer.manage_email_subscriptions_html", link: link_to(t("decidim.comments.comment_notification_mailer.notifications_settings_link"), decidim.notifications_settings_url(host: @organization.host))) %>
+</p>

data/app/views/decidim/comments/comment_notification_mailer/reply_created.html.erb

@@ -0,0 +1,18 @@
+<p><%= t("decidim.comments.comment_notification_mailer.hello", name: @comment.author.name) %></p>
+
+<p>
+  <%=
+    t(".new_reply_html", {
+      commenter: @reply.author.name,
+      commentable_link: link_to(@commentable.title, decidim_resource_url(@commentable))
+    })
+  %>
+</p>
+
+<blockquote>
+  <%= @reply.body %>
+</blockquote>
+
+<p>
+  <%= t("decidim.comments.comment_notification_mailer.manage_email_subscriptions_html", link: link_to(t("decidim.comments.comment_notification_mailer.notifications_settings_link"), decidim.notifications_settings_url(host: @organization.host))) %>
+</p>

data/config/locales/ca.yml

@@ -2,21 +2,36 @@ ca:
   activerecord:
     errors:
       messages:
-        cannot_have_replies: no pot tenir respostes
+        cannot_have_comments: no pot tenir comentaris
   decidim:
+    comments:
+      comment_notification_mailer:
+        comment_created:
+          new_comment_html: Hi ha un nou comentari d'<b>%{commenter}</b> a <b>%{commentable_link}</b>
+        hello: Hola %{name},
+        manage_email_subscriptions_html: Pots deixar de rebre aquests correus electrònics canviant la configuració a %{link}.
+        notifications_settings_link: la pàgina de configuració de les notificacions
+        reply_created:
+          new_reply_html: Hi ha una nova resposta del teu comentari de l'<b>%{commenter}</b> a <b>%{commentable_link}</b>
+      mailer:
+        comment_notification:
+          comment_created:
+            subject: Tens un nou comentari
+          reply_created:
+            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
             placeholder: Què en penses d'això?
+          form_error: El text és necessari i no pot ser més llarg de %{length}
           submit: Envia
           user_group_id:
             label: Comentar com a
         opinion:
-          against: Hi estic en contra
-          in_favor: Hi estic a favor
-          neutral: Sóc neutral
+          neutral: Neutral
         title: Deixa el teu comentari
       comment:
         alignment:
@@ -33,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/config/locales/en.yml

@@ -3,22 +3,38 @@ en:
   activerecord:
     errors:
       messages:
-        cannot_have_replies: can't have replies
+        cannot_have_comments: can't have comments
   decidim:
+    comments:
+      comment_notification_mailer:
+        comment_created:
+          new_comment_html: There is a new comment from <b>%{commenter}</b> in <b>%{commentable_link}</b>
+        hello: Hello %{name},
+        manage_email_subscriptions_html: You can stop receiving these emails by changing your settings in %{link}.
+        notifications_settings_link: the notifications settings page
+        reply_created:
+          new_reply_html: There is a new reply of your comment from <b>%{commenter}</b> in <b>%{commentable_link}</b>
+      mailer:
+        comment_notification:
+          comment_created:
+            subject: You have a new comment
+          reply_created:
+            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
             placeholder: What do you think about this?
+          form_error: The text is required and it can't be longer than %{length} characters.
           submit: Send
           user_group_id:
             label: Comment as
         opinion:
-          against: I am against
-          in_favor: I am in favor
-          neutral: I am neutral
-        title: Leave your comment
+          neutral: Neutral
+        title: Add your comment
       comment:
         alignment:
           against: Against
@@ -34,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/config/locales/es.yml

@@ -2,21 +2,36 @@ es:
   activerecord:
     errors:
       messages:
-        cannot_have_replies: no pueden tener respuestas
+        cannot_have_comments: no puede tener comentarios
   decidim:
+    comments:
+      comment_notification_mailer:
+        comment_created:
+          new_comment_html: Hay un nuevo comentario de <b>%{commenter}</b> en <b>%{commentable_link}</b>
+        hello: Hola %{name},
+        manage_email_subscriptions_html: Puedes dejar de recibir estos correos electrónicos cambiando la configuración en %{link}.
+        notifications_settings_link: la página de configuración de las notificaciones
+        reply_created:
+          new_reply_html: Hay una nueva respuesta de tu comentario de <b>%{commenter}</b> en <b>%{commentable_link}</b>
+      mailer:
+        comment_notification:
+          comment_created:
+            subject: Tienes un nuevo comentario
+          reply_created:
+            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
             placeholder: '¿Qué piensas sobre esto?'
+          form_error: El texto es necesario y no puede ser más de caracteres %{length}.
           submit: Enviar
           user_group_id:
             label: Comentar como
         opinion:
-          against: Estoy en contra
-          in_favor: Estoy a favor
-          neutral: Soy neutral
+          neutral: Neutral
         title: Deje su comentario
       comment:
         alignment:
@@ -33,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: