decidim-comments 0.19.1 → 0.23.0

data/config/locales/zh-TW.yml

@@ -0,0 +1 @@
+zh-TW:

data/db/migrate/20200320105911_index_foreign_keys_in_decidim_comments_comments.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class IndexForeignKeysInDecidimCommentsComments < ActiveRecord::Migration[5.2]
+  def change
+    add_index :decidim_comments_comments, :decidim_user_group_id
+  end
+end

data/db/migrate/20200706123136_make_comments_handle_i18n.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+class MakeCommentsHandleI18n < ActiveRecord::Migration[5.2]
+  class User < ApplicationRecord
+    self.table_name = :decidim_users
+  end
+
+  class Comment < ApplicationRecord
+    self.table_name = :decidim_comments_comments
+  end
+
+  class Organization < ApplicationRecord
+    self.table_name = :decidim_organizations
+  end
+
+  def change
+    add_column :decidim_comments_comments, :new_body, :jsonb
+
+    User.reset_column_information
+    Comment.reset_column_information
+    Organization.reset_column_information
+
+    Comment.find_each do |comment|
+      locale, org_id = User.where(id: comment.decidim_author_id).pluck(:locale, :decidim_organization_id).first
+      locale = locale.presence || Organization.find(org_id).default_locale
+
+      comment.new_body = {
+        locale => comment.body
+      }
+
+      comment.save!
+    end
+
+    remove_column :decidim_comments_comments, :body
+    rename_column :decidim_comments_comments, :new_body, :body
+
+    User.reset_column_information
+    Comment.reset_column_information
+    Organization.reset_column_information
+  end
+end

data/db/migrate/20200828101910_add_commentable_counter_cache_to_comments.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class AddCommentableCounterCacheToComments < ActiveRecord::Migration[5.2]
+  def change
+    add_column :decidim_comments_comments, :comments_count, :integer, null: false, default: 0, index: true
+    Decidim::Comments::Comment.reset_column_information
+    Decidim::Comments::Comment.find_each(&:update_comments_count)
+  end
+end

data/lib/decidim/comments.rb

@@ -17,6 +17,7 @@ module Decidim
     autoload :CommentSerializer, "decidim/comments/comment_serializer"
     autoload :CommentVoteSerializer, "decidim/comments/comment_vote_serializer"
     autoload :Export, "decidim/comments/export"
+    autoload :Markdown, "decidim/comments/markdown"
 
     def self.data_portable_entities
       ["Decidim::Comments::Comment", "Decidim::Comments::CommentVote"]

data/lib/decidim/comments/api/comment_type.rb

@@ -25,7 +25,11 @@ module Decidim
         }
       end
 
-      field :body, !types.String, "The comment message"
+      field :body, !types.String, "The comment message" do
+        resolve lambda { |obj, _args, _ctx|
+          obj.translated_body
+        }
+      end
 
       field :formattedBody, !types.String, "The comment message ready to display (it is expected to include HTML)", property: :formatted_body
 

data/lib/decidim/comments/comment_serializer.rb

@@ -11,7 +11,8 @@ module Decidim
         {
           id: resource.id,
           created_at: resource.created_at,
-          body: resource.body,
+          body: resource.body.values.first,
+          locale: resource.body.keys.first,
           author: {
             id: resource.author.id,
             name: resource.author.name
@@ -31,7 +32,11 @@ module Decidim
       private
 
       def root_commentable_url
-        @root_commentable_url ||= Decidim::ResourceLocatorPresenter.new(resource.root_commentable).url
+        @root_commentable_url ||= if resource.root_commentable&.respond_to?(:polymorphic_resource_url)
+                                    resource.root_commentable.polymorphic_resource_url
+                                  else
+                                    ResourceLocatorPresenter.new(resource.root_commentable).url
+                                  end
       end
     end
   end

data/lib/decidim/comments/comment_vote_serializer.rb

@@ -37,7 +37,11 @@ module Decidim
       private
 
       def root_commentable_url
-        @root_commentable_url ||= Decidim::ResourceLocatorPresenter.new(resource.comment.root_commentable).url
+        @root_commentable_url ||= if resource.comment.root_commentable&.respond_to?(:polymorphic_resource_url)
+                                    resource.comment.root_commentable.polymorphic_resource_url
+                                  else
+                                    ResourceLocatorPresenter.new(resource.comment.root_commentable).url
+                                  end
       end
     end
   end

data/lib/decidim/comments/commentable.rb

@@ -51,6 +51,17 @@ module Decidim
         def user_allowed_to_comment?(_user)
           true
         end
+
+        # Public: Updates the comments counter cache. We have to do it these
+        # way in order to properly calculate the coutner with hidden
+        # comments.
+        #
+        # rubocop:disable Rails/SkipsModelValidations
+        def update_comments_count
+          comments_count = comments.not_hidden.count
+          update_columns(comments_count: comments_count, updated_at: Time.current)
+        end
+        # rubocop:enable Rails/SkipsModelValidations
       end
     end
   end

data/lib/decidim/comments/comments_helper.rb

@@ -26,9 +26,13 @@ module Decidim
         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,
-                                          locale: I18n.locale)
+        react_comments_component(
+          node_id, commentableType: commentable_type,
+                   commentableId: commentable_id,
+                   locale: I18n.locale,
+                   toggleTranslations: machine_translations_toggled?,
+                   commentsMaxLength: comments_max_length(resource)
+        )
       end
 
       # Private: Render Comments component using inline javascript
@@ -44,11 +48,31 @@ module Decidim
               {
                 commentableType: "#{props[:commentableType]}",
                 commentableId: "#{props[:commentableId]}",
-                locale: "#{props[:locale]}"
+                locale: "#{props[:locale]}",
+                toggleTranslations: #{props[:toggleTranslations]},
+                commentsMaxLength: "#{props[:commentsMaxLength]}"
               }
             );
           })
       end
+
+      def comments_max_length(resource)
+        return 1000 unless resource.respond_to?(:component)
+        return component_comments_max_length(resource) if component_comments_max_length(resource)
+        return organization_comments_max_length(resource) if organization_comments_max_length(resource)
+
+        1000
+      end
+
+      def component_comments_max_length(resource)
+        return unless resource.component&.settings.respond_to?(:comments_max_length)
+
+        resource.component.settings.comments_max_length if resource.component.settings.comments_max_length.positive?
+      end
+
+      def organization_comments_max_length(resource)
+        resource.component.organization.comments_max_length if resource.component.organization.comments_max_length.positive?
+      end
     end
   end
 end

data/lib/decidim/comments/engine.rb

@@ -59,6 +59,19 @@ module Decidim
           metric_operation.manager_class = "Decidim::Comments::Metrics::CommentParticipantsMetricMeasure"
         end
       end
+
+      initializer "decidim_comments.register_resources" do
+        Decidim.register_resource(:comment) do |resource|
+          resource.model_class_name = "Decidim::Comments::Comment"
+          resource.card = "decidim/comments/comment"
+          resource.searchable = true
+        end
+      end
+
+      initializer "decidim_comments.add_cells_view_paths" do
+        Cell::ViewModel.view_paths << File.expand_path("#{Decidim::Comments::Engine.root}/app/cells")
+        Cell::ViewModel.view_paths << File.expand_path("#{Decidim::Comments::Engine.root}/app/views") # for partials
+      end
     end
   end
 end

data/lib/decidim/comments/markdown.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "redcarpet"
+
+module Decidim
+  module Comments
+    # This class parses a string from plain text (markdown) and
+    # renders it as HTML.
+    class Markdown < ::Redcarpet::Render::Base
+      delegate :render, to: :markdown
+
+      private
+
+      def markdown
+        @markdown ||= ::Redcarpet::Markdown.new(renderer)
+      end
+
+      def renderer
+        @renderer ||= Decidim::Comments::MarkdownRender.new
+      end
+    end
+
+    # Custom markdown renderer for Comments
+    class MarkdownRender < ::Redcarpet::Render::Safe
+      def initialize(extensions = {})
+        super({
+          autolink: true,
+          escape_html: false,
+          filter_html: true,
+          hard_wrap: true,
+          lax_spacing: false,
+          no_images: true,
+          no_styles: true
+        }.merge(extensions))
+      end
+
+      # renders quotes with a custom css class
+      def block_quote(quote)
+        %(<blockquote class="comment__quote">#{quote}</blockquote>)
+      end
+
+      # removes header tags in comments
+      def header(title, _level)
+        title
+      end
+
+      # prevents empty <p/> in comments
+      def paragraph(text)
+        return if text.blank?
+
+        "<p>#{text}</p>"
+      end
+    end
+  end
+end

data/lib/decidim/comments/mutation_extensions.rb

@@ -16,8 +16,12 @@ module Decidim
 
           argument :id, !types.String, "The commentable's ID"
           argument :type, !types.String, "The commentable's class name. i.e. `Decidim::ParticipatoryProcess`"
+          argument :locale, !types.String, "The locale for which to get the comments text"
+          argument :toggleTranslations, !types.Boolean, "Whether the user asked to toggle the machine translations or not."
 
           resolve lambda { |_obj, args, _ctx|
+            I18n.locale = args[:locale].presence
+            RequestStore.store[:toggle_machine_translations] = args[:toggleTranslations]
             args[:type].constantize.find(args[:id])
           }
         end
@@ -26,8 +30,12 @@ module Decidim
           description "A comment"
 
           argument :id, !types.ID, "The comment's id"
+          argument :locale, !types.String, "The locale for which to get the comments text"
+          argument :toggleTranslations, !types.Boolean, "Whether the user asked to toggle the machine translations or not."
 
           resolve lambda { |_obj, args, _ctx|
+            I18n.locale = args[:locale].presence
+            RequestStore.store[:toggle_machine_translations] = args[:toggleTranslations]
             Comment.find(args["id"])
           }
         end

data/lib/decidim/comments/query_extensions.rb

@@ -16,8 +16,12 @@ module Decidim
 
           argument :id, !types.String, "The commentable's ID"
           argument :type, !types.String, "The commentable's class name. i.e. `Decidim::ParticipatoryProcess`"
+          argument :locale, !types.String, "The locale for which to get the comments text"
+          argument :toggleTranslations, !types.Boolean, "Whether the user asked to toggle the machine translations or not."
 
           resolve lambda { |_obj, args, _ctx|
+            I18n.locale = args[:locale].presence
+            RequestStore.store[:toggle_machine_translations] = args[:toggleTranslations]
             args[:type].constantize.find(args[:id])
           }
         end

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

@@ -7,7 +7,16 @@ FactoryBot.define do
     author { build(:user, organization: commentable.organization) }
     commentable { build(:dummy_resource) }
     root_commentable { commentable }
-    body { Faker::Lorem.paragraph }
+    body { Decidim::Faker::Localized.paragraph }
+
+    after(:build) do |comment, evaluator|
+      comment.body = if evaluator.body.is_a?(String)
+                       { comment.root_commentable.organization.default_locale || "en" => evaluator.body }
+                     else
+                       evaluator.body
+                     end
+      comment.body = Decidim::ContentProcessor.parse_with_processor(:hashtag, comment.body, current_organization: comment.root_commentable.organization).rewrite
+    end
 
     trait :comment_on_comment do
       author { build(:user, organization: root_commentable.organization) }

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

@@ -12,10 +12,16 @@ shared_context "when it's a comment event" do
 
   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 }
 
   let(:extra) { { comment_id: comment.id } }
-  let(:resource_title) { decidim_html_escape resource.title }
+  let(:resource_title) { decidim_html_escape(translated(resource.title)) }
+  let(:user_group) do
+    user_group = create(:user_group, :verified, organization: organization, users: [comment_author])
+    comment.update!(user_group: user_group)
+    user_group
+  end
 end
 
 shared_examples_for "a comment event" do
@@ -23,7 +29,11 @@ shared_examples_for "a comment event" do
 
   describe "author" do
     it "returns the comment author" do
-      expect(subject.author).to eq(comment_author)
+      if defined? user_group_author
+        expect(subject.author).to eq(user_group_author)
+      else
+        expect(subject.author).to eq(comment_author)
+      end
     end
   end
 

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

@@ -16,7 +16,8 @@ RSpec.shared_context "when creating a comment" do
       "comment" => {
         "body" => body,
         "alignment" => alignment,
-        "user_group_id" => user_group_id
+        "user_group_id" => user_group_id,
+        "commentable" => commentable
       }
     }
   end
@@ -27,5 +28,5 @@ RSpec.shared_context "when creating a comment" do
       current_organization: organization
     )
   end
-  let(:command) { described_class.new(form, author, commentable) }
+  let(:command) { described_class.new(form, author) }
 end

data/lib/decidim/comments/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: decidim-comments
 version: !ruby/object:Gem::Version
-  version: 0.19.1
+  version: 0.23.0
 platform: ruby
 authors:
 - Josep Jaume Rey Peroy
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-13 00:00:00.000000000 Z
+date: 2020-11-05 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.19.1
+        version: 0.23.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: 0.23.0
 - !ruby/object:Gem::Dependency
   name: jquery-rails
   requirement: !ruby/object:Gem::Requirement
@@ -40,34 +40,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: decidim-admin
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: 0.23.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: 0.23.0
 - !ruby/object:Gem::Dependency
   name: decidim-dev
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: 0.23.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: 0.23.0
 description: Pluggable comments system for some components.
 email:
 - josepjaume@gmail.com
@@ -84,12 +98,18 @@ files:
 - app/assets/javascripts/decidim/comments/bundle.js.map
 - app/assets/javascripts/decidim/comments/comments.js.erb
 - app/cells/decidim/comments/comment_activity_cell.rb
+- app/cells/decidim/comments/comment_cell.rb
+- app/cells/decidim/comments/comment_m/footer.erb
+- app/cells/decidim/comments/comment_m/top.erb
+- app/cells/decidim/comments/comment_m_cell.rb
 - app/commands/decidim/comments/create_comment.rb
 - app/commands/decidim/comments/vote_comment.rb
 - app/events/decidim/comments/comment_by_followed_user_event.rb
+- app/events/decidim/comments/comment_by_followed_user_group_event.rb
 - app/events/decidim/comments/comment_created_event.rb
 - app/events/decidim/comments/comment_event.rb
 - app/events/decidim/comments/reply_created_event.rb
+- app/events/decidim/comments/user_group_mentioned_event.rb
 - app/events/decidim/comments/user_mentioned_event.rb
 - app/forms/decidim/comments/comment_form.rb
 - app/frontend/application/apollo_client.ts
@@ -135,6 +155,7 @@ files:
 - app/frontend/support/require_all.ts
 - app/frontend/support/resolve_graphql_query.ts
 - app/frontend/support/schema.ts
+- app/helpers/decidim/comments/comment_cells_helper.rb
 - app/models/decidim/comments/application_record.rb
 - app/models/decidim/comments/comment.rb
 - app/models/decidim/comments/comment_vote.rb
@@ -143,40 +164,78 @@ files:
 - app/queries/decidim/comments/metrics/comments_metric_manage.rb
 - app/queries/decidim/comments/sorted_comments.rb
 - app/resolvers/decidim/comments/vote_comment_resolver.rb
+- app/scrubbers/decidim/comments/user_input_scrubber.rb
 - app/services/decidim/comments/comment_creation.rb
 - app/services/decidim/comments/new_comment_notification_creator.rb
 - app/types/decidim/comments/commentable_interface.rb
 - app/types/decidim/comments/commentable_mutation_type.rb
 - app/types/decidim/comments/commentable_type.rb
+- config/locales/am-ET.yml
 - config/locales/ar-SA.yml
 - config/locales/ar.yml
+- config/locales/bg-BG.yml
+- config/locales/bg.yml
 - config/locales/ca.yml
 - config/locales/cs-CZ.yml
 - config/locales/cs.yml
+- config/locales/da-DK.yml
+- config/locales/da.yml
 - config/locales/de.yml
+- config/locales/el-GR.yml
+- config/locales/el.yml
 - config/locales/en.yml
 - config/locales/eo-UY.yml
+- config/locales/eo.yml
 - config/locales/es-MX.yml
 - config/locales/es-PY.yml
 - config/locales/es.yml
+- config/locales/et-EE.yml
+- config/locales/et.yml
 - config/locales/eu.yml
 - config/locales/fi-pl.yml
 - config/locales/fi-plain.yml
 - config/locales/fi.yml
+- config/locales/fr-CA.yml
 - config/locales/fr.yml
+- config/locales/ga-IE.yml
 - config/locales/gl.yml
+- config/locales/hr-HR.yml
+- config/locales/hr.yml
 - config/locales/hu.yml
 - config/locales/id-ID.yml
+- config/locales/is-IS.yml
+- config/locales/is.yml
 - config/locales/it.yml
+- config/locales/ja-JP.yml
+- config/locales/ja.yml
+- config/locales/ko-KR.yml
+- config/locales/ko.yml
+- config/locales/lt-LT.yml
+- config/locales/lt.yml
+- config/locales/lv.yml
+- config/locales/mt-MT.yml
+- config/locales/mt.yml
 - config/locales/nl.yml
 - config/locales/no.yml
+- config/locales/om-ET.yml
 - config/locales/pl.yml
 - config/locales/pt-BR.yml
 - config/locales/pt.yml
+- config/locales/ro-RO.yml
 - config/locales/ru.yml
+- config/locales/sk-SK.yml
+- config/locales/sk.yml
+- config/locales/sl.yml
+- config/locales/so-SO.yml
+- config/locales/sr-CS.yml
 - config/locales/sv.yml
+- config/locales/ti-ER.yml
 - config/locales/tr-TR.yml
 - config/locales/uk.yml
+- config/locales/vi-VN.yml
+- config/locales/vi.yml
+- config/locales/zh-CN.yml
+- config/locales/zh-TW.yml
 - db/migrate/20161130143508_create_comments.rb
 - db/migrate/20161214082645_add_depth_to_comments.rb
 - db/migrate/20161216102820_add_alignment_to_comments.rb
@@ -188,6 +247,9 @@ files:
 - db/migrate/20181003080320_fix_user_groups_ids_in_comments.rb
 - db/migrate/20181016142511_make_authors_polymorphic_for_comments.rb
 - db/migrate/20181019092928_make_author_polymorphic_for_comment_votes.rb
+- db/migrate/20200320105911_index_foreign_keys_in_decidim_comments_comments.rb
+- db/migrate/20200706123136_make_comments_handle_i18n.rb
+- db/migrate/20200828101910_add_commentable_counter_cache_to_comments.rb
 - db/seeds.rb
 - lib/decidim/comments.rb
 - lib/decidim/comments/admin.rb
@@ -201,6 +263,7 @@ files:
 - lib/decidim/comments/comments_helper.rb
 - lib/decidim/comments/engine.rb
 - lib/decidim/comments/export.rb
+- lib/decidim/comments/markdown.rb
 - lib/decidim/comments/mutation_extensions.rb
 - lib/decidim/comments/query_extensions.rb
 - lib/decidim/comments/test.rb
@@ -220,7 +283,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="