decidim-comments 0.24.2 → 0.25.0.rc3

data/db/migrate/20210529095942_add_deleted_at_column_to_comments.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddDeletedAtColumnToComments < ActiveRecord::Migration[6.0]
+  def change
+    add_column :decidim_comments_comments, :deleted_at, :datetime
+  end
+end

data/lib/decidim/comments/commentable.rb

@@ -52,13 +52,18 @@ module Decidim
           true
         end
 
+        # Public: Whether the object can have new comment votes or not.
+        def user_allowed_to_vote_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
+          comments_count = comments.not_hidden.not_deleted.count
           update_columns(comments_count: comments_count, updated_at: Time.current)
         end
         # rubocop:enable Rails/SkipsModelValidations

data/lib/decidim/comments/commentable_with_component.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Decidim
+  module Comments
+    # Commentable overriding some methods to include settings and
+    # authorizations given by a component the resource belongs to
+    module CommentableWithComponent
+      extend ActiveSupport::Concern
+      include Decidim::Comments::Commentable
+
+      included do
+        # Public: Overrides the `commentable?` Commentable concern method.
+        def commentable?
+          component.settings.comments_enabled?
+        end
+
+        # Public: Overrides the `accepts_new_comments?` Commentable concern method.
+        def accepts_new_comments?
+          commentable? && !component.current_settings.comments_blocked
+        end
+
+        # Public: Whether the object can have new comments or not.
+        def user_allowed_to_comment?(user)
+          return unless can_participate?(user)
+
+          ActionAuthorizer.new(user, "comment", component, self).authorize.ok?
+        end
+      end
+    end
+  end
+end

data/lib/decidim/comments/engine.rb

@@ -4,11 +4,7 @@ require "rails"
 require "active_support/all"
 
 require "decidim/core"
-require "jquery-rails"
-require "sassc-rails"
-require "foundation-rails"
 require "foundation_rails_helper"
-require "autoprefixer-rails"
 
 require "decidim/comments/query_extensions"
 require "decidim/comments/mutation_extensions"
@@ -20,15 +16,11 @@ module Decidim
       isolate_namespace Decidim::Comments
 
       routes do
-        resources :comments, only: [:index, :create] do
+        resources :comments, except: [:new, :edit] do
           resources :votes, only: [:create]
         end
       end
 
-      initializer "decidim_comments.assets" do |app|
-        app.config.assets.precompile += %w(decidim_comments_manifest.js)
-      end
-
       initializer "decidim_comments.query_extensions" do
         Decidim::Api::QueryType.include QueryExtensions
       end

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

@@ -8,6 +8,7 @@ FactoryBot.define do
     commentable { build(:dummy_resource) }
     root_commentable { commentable }
     body { Decidim::Faker::Localized.paragraph }
+    participatory_space { commentable.try(:participatory_space) }
 
     after(:build) do |comment, evaluator|
       comment.body = if evaluator.body.is_a?(String)

data/lib/decidim/comments/version.rb

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

data/lib/decidim/comments.rb

@@ -12,6 +12,7 @@ module Decidim
   module Comments
     autoload :CommentsHelper, "decidim/comments/comments_helper"
     autoload :Commentable, "decidim/comments/commentable"
+    autoload :CommentableWithComponent, "decidim/comments/commentable_with_component"
     autoload :CommentSerializer, "decidim/comments/comment_serializer"
     autoload :CommentVoteSerializer, "decidim/comments/comment_vote_serializer"
     autoload :Export, "decidim/comments/export"

data/lib/tasks/decidim_comments.rake

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+namespace :decidim_comments do
+  desc "Adds participatory_process_id to comments if they are associated with a participatory process"
+  task update_participatory_process_in_comments: :environment do
+    Decidim::Comments::Comment.find_each do |c|
+      c.participatory_space = if c.root_commentable.is_a?(Decidim::Participable)
+                                c.root_commentable
+                              else
+                                c.commentable.try(:participatory_space)
+                              end
+      c.save(validate: false)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: decidim-comments
 version: !ruby/object:Gem::Version
-  version: 0.24.2
+  version: 0.25.0.rc3
 platform: ruby
 authors:
 - Josep Jaume Rey Peroy
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-07 00:00:00.000000000 Z
+date: 2021-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: decidim-core
@@ -18,28 +18,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.24.2
+        version: 0.25.0.rc3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.24.2
-- !ruby/object:Gem::Dependency
-  name: jquery-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.4'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.4'
+        version: 0.25.0.rc3
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -66,28 +52,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.24.2
+        version: 0.25.0.rc3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.24.2
+        version: 0.25.0.rc3
 - !ruby/object:Gem::Dependency
   name: decidim-dev
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.24.2
+        version: 0.25.0.rc3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.24.2
+        version: 0.25.0.rc3
 description: Pluggable comments system for some components.
 email:
 - josepjaume@gmail.com
@@ -99,14 +85,11 @@ extra_rdoc_files: []
 files:
 - README.md
 - Rakefile
-- app/assets/config/decidim_comments_manifest.js
 - app/assets/javascripts/decidim/comments/bundle.js.map
-- app/assets/javascripts/decidim/comments/comments.component.js.es6
-- app/assets/javascripts/decidim/comments/comments.component.test.js
-- app/assets/javascripts/decidim/comments/comments.js.erb
 - app/cells/decidim/comments/comment/actions.erb
 - app/cells/decidim/comments/comment/alignment_badge.erb
 - app/cells/decidim/comments/comment/author.erb
+- app/cells/decidim/comments/comment/deletion_data.erb
 - app/cells/decidim/comments/comment/show.erb
 - app/cells/decidim/comments/comment/utilities.erb
 - app/cells/decidim/comments/comment/votes.erb
@@ -129,7 +112,11 @@ files:
 - app/cells/decidim/comments/comments/single_comment_warning.erb
 - app/cells/decidim/comments/comments/user_comments_blocked_warning.erb
 - app/cells/decidim/comments/comments_cell.rb
+- app/cells/decidim/comments/edit_comment_modal_form/show.erb
+- app/cells/decidim/comments/edit_comment_modal_form_cell.rb
 - app/commands/decidim/comments/create_comment.rb
+- app/commands/decidim/comments/delete_comment.rb
+- app/commands/decidim/comments/update_comment.rb
 - app/commands/decidim/comments/vote_comment.rb
 - app/controllers/decidim/comments/application_controller.rb
 - app/controllers/decidim/comments/comments_controller.rb
@@ -150,6 +137,10 @@ files:
 - app/models/decidim/comments/comment.rb
 - app/models/decidim/comments/comment_vote.rb
 - app/models/decidim/comments/seed.rb
+- app/packs/src/decidim/comments/comments.component.js
+- app/packs/src/decidim/comments/comments.component.test.js
+- app/packs/src/decidim/comments/comments.component_for_testing.js
+- app/packs/src/decidim/comments/comments.js
 - app/permissions/decidim/comments/permissions.rb
 - app/queries/decidim/comments/metrics/comment_participants_metric_measure.rb
 - app/queries/decidim/comments/metrics/comments_metric_manage.rb
@@ -160,12 +151,19 @@ files:
 - app/services/decidim/comments/new_comment_notification_creator.rb
 - app/views/decidim/comments/comments/_comment.html.erb
 - app/views/decidim/comments/comments/_comments.html.erb
+- app/views/decidim/comments/comments/_delete.html.erb
+- app/views/decidim/comments/comments/_edited_comment.html.erb
 - app/views/decidim/comments/comments/create.js.erb
+- app/views/decidim/comments/comments/delete.js.erb
+- app/views/decidim/comments/comments/deletion_error.js.erb
 - app/views/decidim/comments/comments/error.js.erb
 - app/views/decidim/comments/comments/index.js.erb
 - app/views/decidim/comments/comments/reload.js.erb
+- app/views/decidim/comments/comments/update.js.erb
+- app/views/decidim/comments/comments/update_error.js.erb
 - app/views/decidim/comments/votes/create.js.erb
 - app/views/decidim/comments/votes/error.js.erb
+- config/assets.rb
 - config/locales/am-ET.yml
 - config/locales/ar-SA.yml
 - config/locales/ar.yml
@@ -192,6 +190,7 @@ files:
 - config/locales/fi-plain.yml
 - config/locales/fi.yml
 - config/locales/fr-CA.yml
+- config/locales/fr-LU.yml
 - config/locales/fr.yml
 - config/locales/ga-IE.yml
 - config/locales/gl.yml
@@ -202,10 +201,10 @@ files:
 - 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/lb-LU.yml
 - config/locales/lt-LT.yml
 - config/locales/lt.yml
 - config/locales/lv.yml
@@ -248,6 +247,8 @@ files:
 - 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/migrate/20210402124534_add_participatory_process_to_comments.rb
+- db/migrate/20210529095942_add_deleted_at_column_to_comments.rb
 - db/seeds.rb
 - lib/decidim/api/add_comment_type.rb
 - lib/decidim/api/comment_mutation_type.rb
@@ -262,6 +263,7 @@ files:
 - lib/decidim/comments/comment_serializer.rb
 - lib/decidim/comments/comment_vote_serializer.rb
 - lib/decidim/comments/commentable.rb
+- lib/decidim/comments/commentable_with_component.rb
 - lib/decidim/comments/comments_helper.rb
 - lib/decidim/comments/engine.rb
 - lib/decidim/comments/export.rb
@@ -274,6 +276,7 @@ files:
 - lib/decidim/comments/test/shared_examples/comment_voted_event.rb
 - lib/decidim/comments/test/shared_examples/create_comment_context.rb
 - lib/decidim/comments/version.rb
+- lib/tasks/decidim_comments.rake
 homepage: https://github.com/decidim/decidim
 licenses:
 - AGPL-3.0
@@ -289,9 +292,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.1.2
 signing_key:

data/app/assets/config/decidim_comments_manifest.js

@@ -1 +0,0 @@
-//= link decidim/comments/comments.js

data/app/assets/javascripts/decidim/comments/comments.component.js.es6

@@ -1,292 +0,0 @@
-/**
- * A plain Javascript component that handles the comments.
- *
- * @class
- * @augments Component
- */
-((exports) => {
-  const $ = exports.$; // eslint-disable-line
-
-  class CommentsComponent {
-    constructor($element, config) {
-      this.$element = $element;
-      this.commentableGid = config.commentableGid;
-      this.commentsUrl = config.commentsUrl;
-      this.rootDepth = config.rootDepth;
-      this.order = config.order;
-      this.lastCommentId = config.lastCommentId;
-      this.pollingInterval = config.pollingInterval || 15000;
-      this.id = this.$element.attr("id") || this._getUID();
-      this.mounted = false;
-    }
-
-    /**
-     * Handles the logic for mounting the component
-     * @public
-     * @returns {Void} - Returns nothing
-     */
-    mountComponent() {
-      if (this.$element.length > 0 && !this.mounted) {
-        this.mounted = true;
-        this._initializeComments(this.$element);
-
-        $(".order-by__dropdown .is-submenu-item a", this.$element).on(
-          "click.decidim-comments",
-          () => {
-            this._onInitOrder();
-          }
-        );
-      }
-    }
-
-    /**
-     * Handles the logic for unmounting the component
-     * @public
-     * @returns {Void} - Returns nothing
-     */
-    unmountComponent() {
-      if (this.mounted) {
-        this.mounted = false;
-        this._stopPolling();
-
-        $(".add-comment .opinion-toggle .button", this.$element).off("click.decidim-comments");
-        $(".add-comment textarea", this.$element).off("input.decidim-comments");
-        $(".order-by__dropdown .is-submenu-item a", this.$element).off("click.decidim-comments");
-        $(".add-comment form", this.$element).off("submit.decidim-comments");
-      }
-    }
-
-    /**
-     * Adds a new thread to the comments section.
-     * @public
-     * @param {String} threadHtml - The HTML content for the thread.
-     * @returns {Void} - Returns nothing
-     */
-    addThread(threadHtml) {
-      const $parent = $(".comments:first", this.$element);
-      const $comment = $(threadHtml);
-      const $threads = $(".comment-threads", this.$element);
-      this._addComment($threads, $comment);
-      this._finalizeCommentCreation($parent);
-    }
-
-    /**
-     * Adds a new reply to an existing comment.
-     * @public
-     * @param {Number} commentId - The ID of the comment for which to add the
-     *   reply to.
-     * @param {String} replyHtml - The HTML content for the reply.
-     * @returns {Void} - Returns nothing
-     */
-    addReply(commentId, replyHtml) {
-      const $parent = $(`#comment_${commentId}`);
-      const $comment = $(replyHtml);
-      const $replies = $(`#comment-${commentId}-replies`);
-      this._addComment($replies, $comment);
-      $replies.siblings(".comment__additionalreply").removeClass("hide");
-      this._finalizeCommentCreation($parent);
-    }
-
-    /**
-     * Generates a unique identifier for the form.
-     * @private
-     * @returns {String} - Returns a unique identifier
-     */
-    _getUID() {
-      return `comments-${new Date().setUTCMilliseconds()}-${Math.floor(Math.random() * 10000000)}`;
-    }
-
-    /**
-     * Initializes the comments for the given parent element.
-     * @private
-     * @param {jQuery} $parent The parent element to initialize.
-     * @returns {Void} - Returns nothing
-     */
-    _initializeComments($parent) {
-      $(".add-comment", $parent).each((_i, el) => {
-        const $add = $(el);
-        const $form = $("form", $add);
-        const $opinionButtons = $(".opinion-toggle .button", $add);
-        const $text = $("textarea", $form);
-
-        $opinionButtons.on("click.decidim-comments", this._onToggleOpinion);
-        $text.on("input.decidim-comments", this._onTextInput);
-
-        $(document).trigger("attach-mentions-element", [$text.get(0)]);
-
-        $form.on("submit.decidim-comments", () => {
-          const $submit = $("button[type='submit']", $form);
-
-          $submit.attr("disabled", "disabled");
-          this._stopPolling();
-        });
-      });
-
-      this._pollComments();
-    }
-
-    /**
-     * Adds the given comment element to the given target element and
-     * initializes it.
-     * @private
-     * @param {jQuery} $target - The target element to add the comment to.
-     * @param {jQuery} $container - The comment container element to add.
-     * @returns {Void} - Returns nothing
-     */
-    _addComment($target, $container) {
-      let $comment = $(".comment", $container);
-      if ($comment.length < 1) {
-        // In case of a reply
-        $comment = $container;
-      }
-      this.lastCommentId = parseInt($comment.data("comment-id"), 10);
-
-      $target.append($container);
-      $container.foundation();
-      this._initializeComments($container);
-      if (exports.Decidim.createCharacterCounter) {
-        exports.Decidim.createCharacterCounter($(".add-comment textarea", $container));
-      }
-    }
-
-    /**
-     * Finalizes the new comment creation after the comment adding finishes
-     * successfully.
-     * @private
-     * @param {jQuery} $parent - The parent comment element to finalize.
-     * @returns {Void} - Returns nothing
-     */
-    _finalizeCommentCreation($parent) {
-      const $add = $("> .add-comment", $parent);
-      const $text = $("textarea", $add);
-      const characterCounter = $text.data("remaining-characters-counter");
-      $text.val("");
-      if (characterCounter) {
-        characterCounter.updateStatus();
-      }
-      if (!$add.parent().is(".comments")) {
-        $add.addClass("hide");
-      }
-
-      // Restart the polling
-      this._pollComments();
-    }
-
-    /**
-     * Sets a timeout to poll new comments.
-     * @private
-     * @returns {Void} - Returns nothing
-     */
-    _pollComments() {
-      this._stopPolling();
-
-      this.pollTimeout = setTimeout(() => {
-        $.ajax({
-          url: this.commentsUrl,
-          method: "GET",
-          contentType: "application/javascript",
-          data: {
-            "commentable_gid": this.commentableGid,
-            "root_depth": this.rootDepth,
-            order: this.order,
-            after: this.lastCommentId
-          }
-        }).done(() => {
-          this._pollComments();
-        });
-      }, this.pollingInterval);
-    }
-
-    /**
-     * Stops polling for new comments.
-     * @private
-     * @returns {Void} - Returns nothing
-     */
-    _stopPolling() {
-      if (this.pollTimeout) {
-        clearTimeout(this.pollTimeout);
-      }
-    }
-
-    /**
-     * Sets the loading comments element visible in the view.
-     * @private
-     * @returns {Void} - Returns nothing
-     */
-    _setLoading() {
-      const $container = $("> .comments-container", this.$element);
-      $("> .comments", $container).addClass("hide");
-      $("> .loading-comments", $container).removeClass("hide");
-    }
-
-    /**
-     * Event listener for the ordering links.
-     * @private
-     * @returns {Void} - Returns nothing
-     */
-    _onInitOrder() {
-      this._stopPolling();
-      this._setLoading();
-    }
-
-    /**
-     * Event listener for the opinion toggle buttons.
-     * @private
-     * @param {Event} ev - The event object.
-     * @returns {Void} - Returns nothing
-     */
-    _onToggleOpinion(ev) {
-      let $btn = $(ev.target);
-      if (!$btn.is(".button")) {
-        $btn = $btn.parents(".button");
-      }
-
-      const $add = $btn.closest(".add-comment");
-      const $form = $("form", $add);
-      const $opinionButtons = $(".opinion-toggle .button", $add);
-      const $alignment = $(".alignment-input", $form);
-
-      $opinionButtons.removeClass("is-active");
-      $btn.addClass("is-active");
-
-      if ($btn.is(".opinion-toggle--ok")) {
-        $alignment.val(1);
-      } else if ($btn.is(".opinion-toggle--meh")) {
-        $alignment.val(0);
-      } else if ($btn.is(".opinion-toggle--ko")) {
-        $alignment.val(-1);
-      }
-    }
-
-    /**
-     * Event listener for the comment field text input.
-     * @private
-     * @param {Event} ev - The event object.
-     * @returns {Void} - Returns nothing
-     */
-    _onTextInput(ev) {
-      const $text = $(ev.target);
-      const $add = $text.closest(".add-comment");
-      const $form = $("form", $add);
-      const $submit = $("button[type='submit']", $form);
-
-      if ($text.val().length > 0) {
-        $submit.removeAttr("disabled");
-      } else {
-        $submit.attr("disabled", "disabled");
-      }
-    }
-  }
-
-  exports.Decidim = exports.Decidim || {};
-  exports.Decidim.CommentsComponent = CommentsComponent;
-
-  $(() => {
-    $("[data-decidim-comments]").each((_i, el) => {
-      const $el = $(el);
-      const comments = new CommentsComponent($el, $el.data("decidim-comments"));
-      comments.mountComponent();
-      $(el).data("comments", comments);
-    });
-  });
-})(window);