decidim-comments 0.23.0 → 0.24.0.rc1

data/app/assets/javascripts/decidim/comments/comments.js.erb

@@ -1,5 +1,5 @@
 // = require_self
-// = require ./bundle
+// = require decidim/comments/comments.component
 
 window.DecidimComments = window.DecidimComments || {};
 

data/app/cells/decidim/comments/comment/actions.erb

@@ -0,0 +1,7 @@
+<div class="comment__actions">
+  <% if can_reply? %>
+    <button class="comment__reply muted-link" aria-controls="<%= reply_id %>" data-toggle="<%= reply_id %>">
+      <%= icon "pencil", class: "icon--small", role: "none presentation" %>&nbsp;<%= t("decidim.components.comment.reply") %>
+    </button>
+  <% end %>
+</div>

data/app/cells/decidim/comments/comment/alignment_badge.erb

@@ -0,0 +1,4 @@
+<span>
+  <span class="<%= alignment_badge_classes %>"><%= alignment_badge_label %></span>
+  &nbsp;
+</span>

data/app/cells/decidim/comments/comment/author.erb

@@ -0,0 +1 @@
+<%== cell("decidim/author", author_presenter).profile %>

data/app/cells/decidim/comments/comment/show.erb

@@ -0,0 +1,40 @@
+<%= content_tag :div, id: "comment_#{model.id}", class: comment_classes, data: { comment_id: model.id } do %>
+  <div class="comment__header">
+    <div class="author-data">
+      <div class="author-data__main">
+        <%= render :author %>
+        <span>
+          <%= time_tag created_at, l(created_at, format: :decidim_short) %>
+        </span>
+      </div>
+      <div class="author-data__extra">
+        <%= render :utilities %>
+      </div>
+    </div>
+  </div>
+  <div class="comment__content">
+    <%= alignment_badge %>
+    <%= comment_body %>
+  </div>
+  <div class="comment__footer">
+    <%= render :actions %>
+    <%= votes %>
+  </div>
+  <div id="comment-<%= model.id %>-replies">
+    <% if has_replies? %>
+      <% replies.each do |reply| %>
+        <%= cell("decidim/comments/comment", reply, root_depth: root_depth, order: order) %>
+      <% end %>
+    <% end %>
+  </div>
+  <% if can_reply? %>
+    <div class="comment__additionalreply<%= " hide" unless has_replies? %>">
+      <button class="comment__reply muted-link" aria-controls="<%= reply_id %>" data-toggle="<%= reply_id %>">
+        <%= icon "pencil", class: "icon--small", role: "none presentation" %>&nbsp;<%= t("decidim.components.comment.reply") %>
+      </button>
+    </div>
+    <div class="add-comment hide" id="<%= reply_id %>" data-toggler=".hide">
+      <%== cell("decidim/comments/comment_form", model, root_depth: root_depth, order: order) %>
+    </div>
+  <% end %>
+<% end %>

data/app/cells/decidim/comments/comment/utilities.erb

@@ -0,0 +1,13 @@
+<button type="button" class="link-alt" data-open="<%= current_user.present? ? "flagModalComment#{model.id}" : "loginModal" %>" title="<%= t("decidim.components.comment.report.title") %>" aria-controls="<%= current_user.present? ? "flagModalComment#{model.id}" : "loginModal" %>" aria-haspopup="true" tabindex="0">
+  <%= icon "flag", aria_hidden: true, class: "icon--small", role: "none presentation", "aria-hidden": true %>
+  <span class="show-for-sr"><%= t("decidim.components.comment.report.title") %></span>
+</button>
+
+<%= link_to "#{commentable_path("commentId" => model.id)}#comment_#{model.id}", title: t("decidim.components.comment.single_comment_link_title") do %>
+  <span class="show-for-sr"><%= t("decidim.components.comment.single_comment_link_title") %></span>
+  <%= icon "link-intact", class: "icon--small", role: "none presentation" %>
+<% end %>
+
+<% if current_user.present? %>
+  <%= cell("decidim/flag_modal", model, modal_id: "flagModalComment#{model.id}") %>
+<% end %>

data/app/cells/decidim/comments/comment/votes.erb

@@ -0,0 +1,25 @@
+<div class="comment__votes">
+  <% if user_signed_in? %>
+    <%= button_to decidim_comments.comment_votes_path(model, weight: 1), remote: true, disabled: voted_down?, class: votes_up_classes, title: t("decidim.components.up_vote_button.text") do %>
+      <span class="show-for-sr"><%= t("decidim.components.up_vote_button.text") %></span>
+      <%= icon "chevron-top", class: "icon--small", role: "none presentation" %>
+      <span class="comment__votes--count"><%= up_votes_count %></span>
+    <% end %>
+    <%= button_to decidim_comments.comment_votes_path(model, weight: -1), remote: true, disabled: voted_up?, class: votes_down_classes, title: t("decidim.components.down_vote_button.text") do %>
+      <span class="show-for-sr"><%= t("decidim.components.down_vote_button.text") %></span>
+      <%= icon "chevron-bottom", class: "icon--small", role: "none presentation" %>
+      <span class="comment__votes--count"><%= down_votes_count %></span>
+    <% end %>
+  <% else %>
+    <button class="<%= votes_up_classes %> " title="<%= t("decidim.components.up_vote_button.text") %>" data-open="loginModal">
+      <span class="show-for-sr"><%= t("decidim.components.up_vote_button.text") %></span>
+      <%= icon "chevron-top", class: "icon--small", role: "none presentation" %>
+      <span class="comment__votes--count"><%= up_votes_count %></span>
+    </button>
+    <button class="<%= votes_down_classes %> " title="<%= t("decidim.components.down_vote_button.text") %>" data-open="loginModal">
+      <span class="show-for-sr"><%= t("decidim.components.down_vote_button.text") %></span>
+      <%= icon "chevron-bottom", class: "icon--small", role: "none presentation" %>
+      <span class="comment__votes--count"><%= down_votes_count %></span>
+    </button>
+  <% end %>
+</div>

data/app/cells/decidim/comments/comment_card_cell.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Comments
+    # This cell renders the comment card for an instance of a Comment
+    # the default size is the Medium Card (:m)
+    class CommentCardCell < Decidim::ViewModel
+      include CommentCellsHelper
+      include Cell::ViewModel::Partial
+
+      def show
+        cell card_size, model, options
+      end
+
+      private
+
+      def card_size
+        "decidim/comments/comment_m"
+      end
+    end
+  end
+end

data/app/cells/decidim/comments/comment_cell.rb

@@ -2,20 +2,154 @@
 
 module Decidim
   module Comments
-    # This cell renders the comment card for an instance of a Comment
-    # the default size is the Medium Card (:m)
+    # A cell to display a single comment.
     class CommentCell < Decidim::ViewModel
-      include CommentCellsHelper
-      include Cell::ViewModel::Partial
+      include ActionView::Helpers::DateHelper
+      include Decidim::IconHelper
+      include Decidim::ResourceHelper
 
-      def show
-        cell card_size, model, options
+      delegate :current_user, :user_signed_in?, to: :controller
+
+      property :root_commentable
+      property :created_at
+      property :alignment
+      property :translated_body
+      property :comment_threads
+      property :accepts_new_comments?
+
+      def alignment_badge
+        return unless [-1, 1].include?(alignment)
+
+        render :alignment_badge
+      end
+
+      def votes
+        return unless root_commentable.comments_have_votes?
+
+        render :votes
       end
 
       private
 
-      def card_size
-        "decidim/comments/comment_m"
+      def decidim_comments
+        Decidim::Comments::Engine.routes.url_helpers
+      end
+
+      def comment_body
+        Decidim::ContentProcessor.render(translated_body)
+      end
+
+      def replies
+        SortedComments.for(model, order_by: order)
+      end
+
+      def order
+        options[:order] || "older"
+      end
+
+      def reply_id
+        "comment#{model.id}-reply"
+      end
+
+      def can_reply?
+        user_signed_in? && accepts_new_comments? &&
+          root_commentable.user_allowed_to_comment?(current_user)
+      end
+
+      def author_presenter
+        if model.author.respond_to?(:official?) && model.author.official?
+          Decidim::Core::OfficialAuthorPresenter.new
+        elsif model.user_group
+          model.user_group.presenter
+        else
+          model.author.presenter
+        end
+      end
+
+      def comment_classes
+        classes = ["comment"]
+        if nested?
+          classes << "comment--nested"
+          classes << "comment--nested--alt" if nested_level_even?
+        end
+        classes.join(" ")
+      end
+
+      def alignment_badge_classes
+        classes = %w(label alignment)
+        case alignment
+        when 1
+          classes << "success"
+        when -1
+          classes << "alert"
+        end
+        classes.join(" ")
+      end
+
+      def alignment_badge_label
+        if alignment == 1
+          I18n.t("decidim.components.comment.alignment.in_favor")
+        else
+          I18n.t("decidim.components.comment.alignment.against")
+        end
+      end
+
+      def votes_up_classes
+        classes = ["comment__votes--up"]
+        classes << "is-vote-selected" if voted_up?
+        classes << "is-vote-notselected" if voted_down?
+        classes.join(" ")
+      end
+
+      def votes_down_classes
+        classes = ["comment__votes--down"]
+        classes << "is-vote-selected" if voted_down?
+        classes << "is-vote-notselected" if voted_up?
+        classes.join(" ")
+      end
+
+      def commentable_path(params = {})
+        if root_commentable.is_a?(Decidim::Budgets::Project)
+          resource_locator([root_commentable.budget, root_commentable]).path(params)
+        else
+          resource_locator(root_commentable).path(params)
+        end
+      end
+
+      def up_votes_count
+        model.up_votes.count
+      end
+
+      def down_votes_count
+        model.down_votes.count
+      end
+
+      def root_depth
+        options[:root_depth] || 0
+      end
+
+      def depth
+        model.depth - root_depth
+      end
+
+      def voted_up?
+        model.up_voted_by?(current_user)
+      end
+
+      def voted_down?
+        model.down_voted_by?(current_user)
+      end
+
+      def nested?
+        depth.positive?
+      end
+
+      def nested_level_even?
+        depth.even?
+      end
+
+      def has_replies?
+        model.comment_threads.any?
       end
     end
   end

data/app/cells/decidim/comments/comment_form/comment_as.erb

@@ -0,0 +1,10 @@
+<div class="field">
+  <label for="<%= comment_as_id %>">
+    <%= t("decidim.components.add_comment_form.form.user_group_id.label") %>
+  </label>
+  <select id="<%= comment_as_id %>" name="comment[user_group_id]">
+    <% comment_as_options.each do |option| %>
+      <option value="<%= option[1] %>"><%= option[0] %></option>
+    <% end %>
+  </select>
+</div>

data/app/cells/decidim/comments/comment_form/show.erb

@@ -0,0 +1,24 @@
+<%= form_for(form_object, url: decidim_comments.comments_path(order: order), method: :post, remote: true, html: { id: form_id }) do |form| %>
+  <%= form.hidden_field :commentable_gid, id: nil %>
+  <%= form.hidden_field :alignment, id: nil, class: "alignment-input" %>
+  <%= comment_as_for(form) %>
+  <div class="field">
+    <label class="show-for-sr" for="<%= add_comment_id %>">
+      <%= t("decidim.components.add_comment_form.form.body.label") %>
+    </label>
+    <div class="hashtags__container">
+      <%= form.text_area(
+        :body,
+        id: add_comment_id,
+        rows: 4,
+        maxlength: comments_max_length,
+        required: true,
+        placeholder: t("decidim.components.add_comment_form.form.body.placeholder"),
+        label: false,
+        data: { remaining_characters: "##{add_comment_id}-remaining-characters" }
+      ) %>
+    </div>
+    <button type="submit" class="button button--sc" disabled="disabled"><%= t("decidim.components.add_comment_form.form.submit") %></button>
+    <span id="<%= add_comment_id %>-remaining-characters" class="remaining-character-count"></span>
+  </div>
+<% end %>

data/app/cells/decidim/comments/comment_form_cell.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Comments
+    # A cell to display a form for adding a new comment.
+    class CommentFormCell < Decidim::ViewModel
+      delegate :current_user, :user_signed_in?, to: :controller
+
+      def comment_as_for(form)
+        return if verified_user_groups.blank?
+
+        # Note that the form.select does not seem to work correctly in the cell
+        # context. The Rails form builder tries to call @template.select which
+        # is not available for the cell objects.
+        render view: :comment_as, locals: { form: form }
+      end
+
+      private
+
+      def decidim_comments
+        Decidim::Comments::Engine.routes.url_helpers
+      end
+
+      def order
+        options[:order] || "older"
+      end
+
+      def commentable_type
+        model.commentable_type
+      end
+
+      def form_id
+        "new_comment_for_#{commentable_type.demodulize}_#{model.id}"
+      end
+
+      def add_comment_id
+        "add-comment-#{commentable_type.demodulize}-#{model.id}"
+      end
+
+      def comment_as_id
+        "add-comment-#{commentable_type.demodulize}-#{model.id}-user-group-id"
+      end
+
+      def root_depth
+        options[:root_depth] || 0
+      end
+
+      def form_object
+        Decidim::Comments::CommentForm.new(
+          commentable_gid: model.to_signed_global_id.to_s,
+          alignment: 0
+        )
+      end
+
+      def verified_user_groups
+        return [] unless current_user
+
+        @verified_user_groups ||= Decidim::UserGroups::ManageableUserGroups.for(current_user).verified
+      end
+
+      def comment_as_options
+        [[current_user.name, ""]] + verified_user_groups.map do |group|
+          [group.name, group.id]
+        end
+      end
+
+      def comments_max_length
+        return 1000 unless model.respond_to?(:component)
+        return component_comments_max_length if component_comments_max_length
+        return organization_comments_max_length if organization_comments_max_length
+
+        1000
+      end
+
+      def component_comments_max_length
+        return unless model.component&.settings.respond_to?(:comments_max_length)
+
+        model.component.settings.comments_max_length if model.component.settings.comments_max_length.positive?
+      end
+
+      def organization_comments_max_length
+        return unless organization
+
+        organization.comments_max_length if organization.comments_max_length.positive?
+      end
+
+      def organization
+        return model.organization if model.respond_to?(:organization)
+
+        model.component.organization if model.component.organization.comments_max_length.positive?
+      end
+    end
+  end
+end

data/app/cells/decidim/comments/comment_m/top.erb

@@ -1,7 +1,7 @@
 <div class="card__top">
   <% if render_space? %>
     <div class="card__content text-small">
-      <span class="muted"><%= searchable_resource_human_name(model.root_commentable.class) %>:</span>&nbsp;<%= link_to root_commentable_title, resource_link_path, class: "card__link text-ellipsis" %>
+      <span class="muted"><%= searchable_resource_human_name(model.root_commentable.class, count: 1) %>:</span>&nbsp;<%= link_to root_commentable_title, resource_link_path, class: "card__link text-ellipsis" %>
     </div>
   <% end %>
 </div>

data/app/cells/decidim/comments/comment_thread/show.erb

@@ -0,0 +1,6 @@
+<div>
+  <%= title %>
+  <div class="comment-thread">
+    <%= cell("decidim/comments/comment", model, root_depth: model.depth, order: order) %>
+  </div>
+</div>