decidim 0.3.2 → 0.4.0

data/decidim-comments/app/frontend/comments/down_vote_button.component.tsx

@@ -4,6 +4,7 @@ import { graphql } from "react-apollo";
 import VoteButton from "./vote_button.component";
 
 import {
+  AddCommentFormCommentableFragment,
   AddCommentFormSessionFragment,
   CommentFragment,
   DownVoteButtonFragment,
@@ -17,6 +18,8 @@ interface DownVoteButtonProps {
   } | null;
   comment: DownVoteButtonFragment;
   downVote?: () => void;
+  rootCommentable: AddCommentFormCommentableFragment;
+  orderBy: string;
 }
 
 export const DownVoteButton: React.SFC<DownVoteButtonProps> = ({
@@ -49,49 +52,65 @@ export const DownVoteButton: React.SFC<DownVoteButtonProps> = ({
 };
 
 const downVoteMutation = require("../mutations/down_vote.mutation.graphql");
+const getCommentsQuery = require("../queries/comments.query.graphql");
 
-const DownVoteButtonWithMutation = graphql(downVoteMutation, {
+const DownVoteButtonWithMutation = graphql<DownVoteMutation, DownVoteButtonProps>(downVoteMutation, {
   props: ({ ownProps, mutate }) => ({
-    downVote: () => mutate({
-      variables: {
-        id: ownProps.comment.id,
-      },
-      optimisticResponse: {
-        __typename: "Mutation",
-        comment: {
-          __typename: "CommentMutation",
-          downVote: {
-            __typename: "Comment",
-            ...ownProps.comment,
-            downVotes: ownProps.comment.downVotes + 1,
-            downVoted: true,
+    downVote() {
+      if (mutate) {
+        mutate({
+          variables: {
+            id: ownProps.comment.id,
           },
-        },
-      },
-      updateQueries: {
-        GetComments: (prev: GetCommentsQuery, { mutationResult: { data } }: { mutationResult: { data: DownVoteMutation }}) => {
-          const commentReducer = (comment: CommentFragment): CommentFragment => {
-            const replies = comment.comments || [];
+          optimisticResponse: {
+            __typename: "Mutation",
+            comment: {
+              __typename: "CommentMutation",
+              downVote: {
+                __typename: "Comment",
+                ...ownProps.comment,
+                downVotes: ownProps.comment.downVotes + 1,
+                downVoted: true,
+              },
+            },
+          },
+          update: (store, result: DownVoteMutation) => {
+            const variables = {
+              commentableId: ownProps.rootCommentable.id,
+              commentableType: ownProps.rootCommentable.type,
+              orderBy: ownProps.orderBy,
+            };
+
+            const commentReducer = (comment: CommentFragment): CommentFragment => {
+              const replies = comment.comments || [];
 
-            if (comment.id === ownProps.comment.id && data.comment) {
-              return data.comment.downVote;
-            }
-            return {
-              ...comment,
-              comments: replies.map(commentReducer),
+              if (comment.id === ownProps.comment.id && result.comment) {
+                return result.comment.downVote;
+              }
+
+              return {
+                ...comment,
+                comments: replies.map(commentReducer),
+              };
             };
-          };
 
-          return {
-            ...prev,
-            commentable: {
-              ...prev.commentable,
-              comments: prev.commentable.comments.map(commentReducer),
-            },
-          };
-        },
-      },
-    }),
+            const prev = store.readQuery<GetCommentsQuery>({ query: getCommentsQuery, variables });
+
+            store.writeQuery({
+              query: getCommentsQuery,
+              data: {
+                ...prev,
+                commentable: {
+                  ...prev.commentable,
+                  comments: prev.commentable.comments.map(commentReducer),
+                },
+              },
+              variables,
+            });
+          },
+        });
+      }
+    },
   }),
 })(DownVoteButton);
 

data/decidim-comments/app/frontend/comments/up_vote_button.component.test.tsx

@@ -10,6 +10,11 @@ import generateUserData from "../support/generate_user_data";
 import { UpVoteButtonFragment } from "../support/schema";
 
 describe("<UpVoteButton />", () => {
+  const orderBy = "older";
+  const rootCommentable = {
+    id: "1",
+    type: "Decidim::DummyResource",
+  };
   let comment: UpVoteButtonFragment;
   let session: any = null;
   const upVote = jasmine.createSpy("upVote");
@@ -23,7 +28,7 @@ describe("<UpVoteButton />", () => {
   });
 
   it("should render a VoteButton component with the correct props", () => {
-    const wrapper = shallow(<UpVoteButton session={session} comment={comment} upVote={upVote} />);
+    const wrapper = shallow(<UpVoteButton session={session} comment={comment} upVote={upVote} rootCommentable={rootCommentable} orderBy={orderBy} />);
     expect(wrapper.find(VoteButton).prop("buttonClassName")).toEqual("comment__votes--up");
     expect(wrapper.find(VoteButton).prop("iconName")).toEqual("icon-chevron-top");
     expect(wrapper.find(VoteButton).prop("votes")).toEqual(comment.upVotes);
@@ -31,13 +36,13 @@ describe("<UpVoteButton />", () => {
 
   it("should pass disabled prop as true if comment upVoted is true", () => {
     comment.upVoted = true;
-    const wrapper = shallow(<UpVoteButton session={session} comment={comment} upVote={upVote} />);
+    const wrapper = shallow(<UpVoteButton session={session} comment={comment} upVote={upVote} rootCommentable={rootCommentable} orderBy={orderBy} />);
     expect(wrapper.find(VoteButton).prop("disabled")).toBeTruthy();
   });
 
   it("should pass disabled prop as true if comment downVoted is true", () => {
     comment.downVoted = true;
-    const wrapper = shallow(<UpVoteButton session={session} comment={comment} upVote={upVote} />);
+    const wrapper = shallow(<UpVoteButton session={session} comment={comment} upVote={upVote} rootCommentable={rootCommentable} orderBy={orderBy} />);
     expect(wrapper.find(VoteButton).prop("disabled")).toBeTruthy();
   });
 
@@ -47,7 +52,7 @@ describe("<UpVoteButton />", () => {
     });
 
     it("should pass userLoggedIn as false", () => {
-      const wrapper = shallow(<UpVoteButton session={session} comment={comment} upVote={upVote} />);
+      const wrapper = shallow(<UpVoteButton session={session} comment={comment} upVote={upVote} rootCommentable={rootCommentable} orderBy={orderBy} />);
       expect(wrapper.find(VoteButton).prop("userLoggedIn")).toBeFalsy();
     });
   });

data/decidim-comments/app/frontend/comments/up_vote_button.component.tsx

@@ -1,9 +1,10 @@
 import * as React from "react";
-import { graphql } from "react-apollo";
+import { graphql, MutationFunc } from "react-apollo";
 
 import VoteButton from "./vote_button.component";
 
 import {
+  AddCommentFormCommentableFragment,
   AddCommentFormSessionFragment,
   CommentFragment,
   GetCommentsQuery,
@@ -17,6 +18,8 @@ interface UpVoteButtonProps {
   } | null;
   comment: UpVoteButtonFragment;
   upVote?: () => void;
+  rootCommentable: AddCommentFormCommentableFragment;
+  orderBy: string;
 }
 
 export const UpVoteButton: React.SFC<UpVoteButtonProps> = ({
@@ -49,9 +52,10 @@ export const UpVoteButton: React.SFC<UpVoteButtonProps> = ({
 };
 
 const upVoteMutation = require("../mutations/up_vote.mutation.graphql");
+const getCommentsQuery = require("../queries/comments.query.graphql");
 
 const UpVoteButtonWithMutation = graphql(upVoteMutation, {
-  props: ({ ownProps, mutate }) => ({
+  props: ({ ownProps, mutate }: { ownProps: UpVoteButtonProps, mutate: MutationFunc<UpVoteMutation> }) => ({
     upVote: () => mutate({
       variables: {
         id: ownProps.comment.id,
@@ -68,28 +72,39 @@ const UpVoteButtonWithMutation = graphql(upVoteMutation, {
           },
         },
       },
-      updateQueries: {
-        GetComments: (prev: GetCommentsQuery, { mutationResult: { data } }: { mutationResult: { data: UpVoteMutation}}) => {
-          const commentReducer = (comment: CommentFragment): CommentFragment => {
-            const replies = comment.comments || [];
+      update: (store, result: UpVoteMutation) => {
+        const variables = {
+          commentableId: ownProps.rootCommentable.id,
+          commentableType: ownProps.rootCommentable.type,
+          orderBy: ownProps.orderBy,
+        };
 
-            if (comment.id === ownProps.comment.id && data.comment) {
-              return data.comment.upVote;
-            }
-            return {
-              ...comment,
-              comments: replies.map(commentReducer),
-            };
-          };
+        const commentReducer = (comment: CommentFragment): CommentFragment => {
+          const replies = comment.comments || [];
+
+          if (comment.id === ownProps.comment.id && result.comment) {
+            return result.comment.upVote;
+          }
 
           return {
+            ...comment,
+            comments: replies.map(commentReducer),
+          };
+        };
+
+        const prev = store.readQuery<GetCommentsQuery>({ query: getCommentsQuery, variables });
+
+        store.writeQuery({
+          query: getCommentsQuery,
+          data: {
             ...prev,
             commentable: {
               ...prev.commentable,
               comments: prev.commentable.comments.map(commentReducer),
             },
-          };
-        },
+          },
+          variables,
+        });
       },
     }),
   }),

data/decidim-comments/app/frontend/comments/vote_button.component.tsx

@@ -36,6 +36,9 @@ const VoteButton: React.SFC<VoteButtonProps> = ({
 );
 
 VoteButton.defaultProps = {
+  buttonClassName: "",
+  iconName: "",
+  votes: 0,
   selectedClass: "selected",
   disabled: false,
 };

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

@@ -9,26 +9,28 @@ module Decidim
 
       helper_method :commentable_title
 
-      def comment_created(comment, commentable)
-        with_user(commentable.author) do
+      def comment_created(user, comment, commentable)
+        with_user(user) do
+          @user = user
           @comment = comment
           @commentable = commentable
           @locator = Decidim::ResourceLocatorPresenter.new(@commentable)
           @organization = commentable.organization
           subject = I18n.t("comment_created.subject", scope: "decidim.comments.mailer.comment_notification")
-          mail(to: commentable.author.email, subject: subject)
+          mail(to: user.email, subject: subject)
         end
       end
 
-      def reply_created(reply, comment, commentable)
-        with_user(comment.author) do
+      def reply_created(user, reply, comment, commentable)
+        with_user(user) do
+          @user = user
           @reply = reply
           @comment = comment
           @commentable = commentable
           @locator = Decidim::ResourceLocatorPresenter.new(@commentable)
           @organization = commentable.organization
           subject = I18n.t("reply_created.subject", scope: "decidim.comments.mailer.comment_notification")
-          mail(to: comment.author.email, subject: subject)
+          mail(to: user.email, subject: subject)
         end
       end
 

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

@@ -6,7 +6,7 @@ module Decidim
     # comment on them. The will be able to create conversations between users
     # to discuss or share their thoughts about the resource.
     class Comment < ApplicationRecord
-      include Reportable
+      include Decidim::Reportable
       include Decidim::Authorable
       include Decidim::Comments::Commentable
 
@@ -59,6 +59,18 @@ module Decidim
         ResourceLocatorPresenter.new(root_commentable).url(anchor: "comment_#{id}")
       end
 
+      # Public: Overrides the `notifiable?` Notifiable concern method.
+      # When a comment is commented the comment's author is notified if it is not the same
+      # who has replied the comment and if the comment's author has replied notifiations enabled.
+      def notifiable?(context)
+        context[:author] != author && author.replies_notifications?
+      end
+
+      # Public: Overrides the `users_to_notify` Notifiable concern method.
+      def users_to_notify
+        [author]
+      end
+
       private
 
       # Private: Check if commentable can have comments and if not adds

data/decidim-comments/app/views/decidim/comments/comment_notification_mailer/comment_created.html.erb

@@ -1,4 +1,4 @@
-<p><%= t("decidim.comments.comment_notification_mailer.hello", name: @commentable.author.name) %></p>
+<p><%= t("decidim.comments.comment_notification_mailer.hello", name: @user.name) %></p>
 
 <p>
   <%=

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

@@ -1,4 +1,4 @@
-<p><%= t("decidim.comments.comment_notification_mailer.hello", name: @comment.author.name) %></p>
+<p><%= t("decidim.comments.comment_notification_mailer.hello", name: @user.name) %></p>
 
 <p>
   <%=

data/decidim-comments/bin/rails

@@ -8,8 +8,8 @@ ENGINE_ROOT = File.expand_path("..", __dir__)
 ENGINE_PATH = File.expand_path("../lib/decidim/comments/engine", __dir__)
 
 # Set up gems listed in the Gemfile.
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
-require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"])
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile", __dir__)
+require "bundler/setup"
 
 require "rails/all"
 require "rails/engine/commands"

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

@@ -35,6 +35,8 @@ ca:
             label: Comentar com a
         opinion:
           neutral: Neutral
+        remaining_characters: "Queden %{count} caràcters"
+        remaining_characters_1: "Queda %{count} caràcter"
         title: Deixa el teu comentari
       comment:
         alignment:

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

@@ -36,6 +36,8 @@ en:
             label: Comment as
         opinion:
           neutral: Neutral
+        remaining_characters: "%{count} characters left"
+        remaining_characters_1: "%{count} character left"
         title: Add your comment
       comment:
         alignment:

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

@@ -35,6 +35,8 @@ es:
             label: Comentar como
         opinion:
           neutral: Neutral
+        remaining_characters: "Quedan %{count} caracteres"
+        remaining_characters_1: "Queda %{count} carácter"
         title: Deje su comentario
       comment:
         alignment:

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

@@ -27,7 +27,7 @@ fr:
             label: Commentaire
             placeholder: Que pensez-vous de cela?
           form_error: Le texte est requis et ne peut pas dépasser %{length} caractères.
-          submit: Envoyer
+          submit: Publier
           user_group_id:
             label: Commenter en tant que
         opinion:
@@ -46,7 +46,7 @@ fr:
           details: Commentaires additionnels
           reasons:
             does_not_belong: Contient des activités illégales, des menaces suicidaires, des informations personnelles, ou autre chose que vous pensez ne pas être approprié à %{organization_name}.
-            offensive: Contient des propos racisme, sexiste, des insultes, des attaques personnelles, des menaces de mort, des incitations au suicide ou toute forme de discours de haine.
+            offensive: Contient des propos racistes, sexistes, des insultes, des attaques personnelles, des menaces de mort, des incitations au suicide ou toute forme de discours de haine.
             spam: Contient des piège-à-clic (clickbait), des publicités, des escroqueries ou des robots fonctionnant au script (script bots).
           title: Signaler un problème
       comment_order_selector:

data/decidim-comments/decidim-comments.gemspec

@@ -9,10 +9,10 @@ require_relative "../decidim-core/lib/decidim/core/version"
 Gem::Specification.new do |s|
   Decidim.add_default_gemspec_properties(s)
 
-  s.name        = "decidim-comments"
-  s.summary     = "Pluggable comments system for some components."
+  s.name = "decidim-comments"
+  s.summary = "Pluggable comments system for some components."
   s.description = "Pluggable comments system for some components."
-  s.files       = Dir["{app,config,db,lib}/**/*", "Rakefile", "README.md"]
+  s.files = Dir["{app,config,db,lib}/**/*", "Rakefile", "README.md"]
 
   s.add_dependency "decidim-core", Decidim.version
   s.add_dependency "rails", *Decidim.rails_version

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

@@ -7,6 +7,7 @@ module Decidim
     # Shared behaviour for commentable models.
     module Commentable
       extend ActiveSupport::Concern
+      include Decidim::Notifiable
 
       included do
         has_many :comments, as: :commentable, foreign_key: "decidim_commentable_id", foreign_type: "decidim_commentable_type", class_name: "Decidim::Comments::Comment"

data/decidim-comments/spec/commands/create_comment_spec.rb

@@ -9,6 +9,7 @@ module Decidim
         let(:organization) { create(:organization) }
         let(:participatory_process) { create(:participatory_process, organization: organization) }
         let(:feature) { create(:feature, participatory_process: participatory_process) }
+        let(:user) { create(:user, organization: organization) }
         let(:author) { create(:user, organization: organization) }
         let(:dummy_resource) { create :dummy_resource, feature: feature }
         let(:commentable) { dummy_resource }
@@ -67,9 +68,9 @@ module Decidim
             end.to change { Comment.count }.by(1)
           end
 
-          context "and the commentable doesn't have an author" do
+          context "and the commentable is not notifiable" do
             before do
-              commentable.author = nil
+              expect(commentable).to receive(:notifiable?).and_return(false)
             end
 
             it "doesn't send an email" do
@@ -78,70 +79,37 @@ module Decidim
             end
           end
 
-          context "and the comment is a root comment" do
-            it "sends an email to the author of the commentable" do
-              expect(CommentNotificationMailer)
-                .to receive(:comment_created)
-                .with(an_instance_of(Comment), commentable)
-                .and_call_original
-
-              command.call
-            end
-
-            context "and I am the author of the commentable" do
-              let(:dummy_resource) { create :dummy_resource, feature: feature, author: author }
-
-              it "doesn't send an email" do
-                expect(CommentNotificationMailer).not_to receive(:comment_created)
-                command.call
-              end
+          context "and the commentable is notifiable" do
+            before do
+              expect(commentable).to receive(:notifiable?).and_return(true)
+              expect(commentable).to receive(:users_to_notify).and_return([user])
             end
 
-            context "and the author has comment notifications disabled" do
-              before do
-                commentable.author.update_attributes!(comments_notifications: false)
-              end
+            context "and the comment is a root comment" do
+              it "sends an email to the author of the commentable" do
+                expect(CommentNotificationMailer)
+                  .to receive(:comment_created)
+                  .with(user, an_instance_of(Comment), commentable)
+                  .and_call_original
 
-              it "doesn't send an email" do
-                expect(CommentNotificationMailer).not_to receive(:comment_created)
                 command.call
               end
             end
-          end
-
-          context "and the comment is a reply" do
-            let(:commentable) { create(:comment, commentable: dummy_resource) }
-
-            it "stores the root commentable" do
-              command.call
-              expect(Comment.last.root_commentable).to eq(dummy_resource)
-            end
-
-            it "sends an email to the author of the parent comment" do
-              expect(CommentNotificationMailer)
-                .to receive(:reply_created)
-                .with(an_instance_of(Comment), commentable, commentable.root_commentable)
-                .and_call_original
-
-              command.call
-            end
 
-            context "and I am the author of the parent comment" do
-              let(:commentable) { create(:comment, author: author, commentable: dummy_resource) }
+            context "and the comment is a reply" do
+              let(:commentable) { create(:comment, commentable: dummy_resource) }
 
-              it "doesn't send an email" do
-                expect(CommentNotificationMailer).not_to receive(:reply_created)
+              it "stores the root commentable" do
                 command.call
+                expect(Comment.last.root_commentable).to eq(dummy_resource)
               end
-            end
 
-            context "and the author has reply notifications disabled" do
-              before do
-                commentable.author.update_attribute(:replies_notifications, false)
-              end
+              it "sends an email to the author of the parent comment" do
+                expect(CommentNotificationMailer)
+                  .to receive(:reply_created)
+                  .with(user, an_instance_of(Comment), commentable, commentable.root_commentable)
+                  .and_call_original
 
-              it "doesn't send an email" do
-                expect(CommentNotificationMailer).not_to receive(:reply_created)
                 command.call
               end
             end