decidim-comments 0.0.3 → 0.0.5

data/config/locales/eu.yml

@@ -0,0 +1,5 @@
+eu:
+  decidim:
+    comments:
+      comment_notification_mailer:
+        hello: Kaixo %{name},

data/lib/decidim/comments.rb

@@ -6,5 +6,10 @@ module Decidim
   # It exposes a single entry point as a rails helper method to render
   # 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/{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/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/{app/helpers → 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/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|

data/lib/decidim/comments/query_extensions.rb

@@ -11,17 +11,14 @@ module Decidim
       # Returns nothing.
       def self.extend!(type)
         type.define do
-          field :comments do
-            description "Lists all commentable's comments."
-            type !types[CommentType]
+          field :commentable do
+            type !CommentableType
 
-            argument :commentableId, !types.String, "The commentable's ID"
-            argument :commentableType, !types.String, "The commentable's class name. i.e. `Decidim::ParticipatoryProcess`"
-            argument :orderBy, types.String, "Order the comments"
+            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|
-              commentable = args[:commentableType].constantize.find(args[:commentableId])
-              CommentsWithReplies.for(commentable, order_by: args[:orderBy])
+              args[:type].constantize.find(args[:id])
             }
           end
         end

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

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 FactoryGirl.define do
-  factory :comment, class: Decidim::Comments::Comment do
+  factory :comment, class: "Decidim::Comments::Comment" do
     author { build(:user, organization: commentable.organization) }
-    commentable { build(:participatory_process) }
+    commentable { build(:dummy_resource) }
     body { Faker::Lorem.paragraph }
   end
 
-  factory :comment_vote, class: Decidim::Comments::CommentVote do
+  factory :comment_vote, class: "Decidim::Comments::CommentVote" do
     comment { build(:comment) }
     author { build(:user, organization: comment.organization) }
     weight { [-1, 1].sample }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: decidim-comments
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Josep Jaume Rey Peroy
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-01 00:00:00.000000000 Z
+date: 2017-02-17 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.0.3
+        version: 0.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.3
+        version: 0.0.5
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -66,14 +66,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.3
+        version: 0.0.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.3
+        version: 0.0.5
 description: Pluggable comments system for some components.
 email:
 - josepjaume@gmail.com
@@ -99,8 +99,9 @@ files:
 - app/frontend/application/icon.component.test.jsx
 - app/frontend/comments/add_comment_form.component.jsx
 - app/frontend/comments/add_comment_form.component.test.jsx
-- app/frontend/comments/add_comment_form.fragment.graphql
 - app/frontend/comments/add_comment_form.mutation.graphql
+- app/frontend/comments/add_comment_form_commentable.fragment.graphql
+- app/frontend/comments/add_comment_form_session.fragment.graphql
 - app/frontend/comments/comment.component.jsx
 - app/frontend/comments/comment.component.test.jsx
 - app/frontend/comments/comment.fragment.graphql
@@ -135,20 +136,23 @@ files:
 - app/frontend/support/require_all.js
 - app/frontend/support/resolve_graphql_query.js
 - app/frontend/support/stub_component.js
-- app/helpers/decidim/comments/comments_helper.rb
+- app/mailers/decidim/comments/comment_notification_mailer.rb
 - app/models/decidim/comments/application_record.rb
 - app/models/decidim/comments/comment.rb
 - app/models/decidim/comments/comment_vote.rb
 - app/models/decidim/comments/seed.rb
-- app/queries/decidim/comments/comments_with_replies.rb
+- app/queries/decidim/comments/sorted_comments.rb
 - app/resolvers/decidim/comments/vote_comment_resolver.rb
-- app/types/decidim/comments/add_comment_type.rb
-- app/types/decidim/comments/comment_mutation_type.rb
-- app/types/decidim/comments/comment_type.rb
+- app/types/decidim/comments/commentable_interface.rb
+- app/types/decidim/comments/commentable_mutation_type.rb
+- app/types/decidim/comments/commentable_type.rb
+- app/views/decidim/comments/comment_notification_mailer/comment_created.html.erb
+- app/views/decidim/comments/comment_notification_mailer/reply_created.html.erb
 - config/i18n-tasks.yml
 - config/locales/ca.yml
 - config/locales/en.yml
 - config/locales/es.yml
+- config/locales/eu.yml
 - db/migrate/20161130143508_create_comments.rb
 - db/migrate/20161214082645_add_depth_to_comments.rb
 - db/migrate/20161216102820_add_alignment_to_comments.rb
@@ -156,6 +160,11 @@ files:
 - db/migrate/20170123102043_add_user_group_id_to_comments.rb
 - db/seeds.rb
 - lib/decidim/comments.rb
+- lib/decidim/comments/api/add_comment_type.rb
+- lib/decidim/comments/api/comment_mutation_type.rb
+- lib/decidim/comments/api/comment_type.rb
+- lib/decidim/comments/commentable.rb
+- lib/decidim/comments/comments_helper.rb
 - lib/decidim/comments/engine.rb
 - lib/decidim/comments/mutation_extensions.rb
 - lib/decidim/comments/query_extensions.rb

data/app/frontend/comments/add_comment_form.fragment.graphql

@@ -1,6 +0,0 @@
-fragment AddCommentForm on Session {
-  verifiedUserGroups {
-    id
-    name
-  }
-}