decidim-comments 0.23.6 → 0.24.0.rc1

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>

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

@@ -0,0 +1,3 @@
+<h6 class="comment-thread__title">
+  <%= t("decidim.components.comment_thread.title", authorName: author_name) %>
+</h6>

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Comments
+    # A cell to display a comment thread.
+    class CommentThreadCell < Decidim::ViewModel
+      def title
+        return unless has_threads?
+
+        render :title
+      end
+
+      private
+
+      def has_threads?
+        model.comment_threads.any?
+      end
+
+      def author_name
+        return t("decidim.components.comment.deleted_user") if model.author.deleted?
+
+        model.author.name
+      end
+
+      def order
+        options[:order] || "older"
+      end
+    end
+  end
+end

data/app/cells/decidim/comments/comments/add_comment.erb

@@ -0,0 +1,30 @@
+<div class="add-comment">
+  <h4 class="section-heading"><%= t("decidim.components.add_comment_form.title") %></h4>
+
+  <% if user_signed_in? %>
+    <% if alignment_enabled? %>
+      <div class="opinion-toggle button-group">
+        <button class="button tiny button--muted opinion-toggle--ok">
+          <%= icon "thumb-up", role: "none presentation" %>
+        </button>
+        <button class="button tiny button--muted opinion-toggle--meh is-active">
+          <%= t("decidim.components.add_comment_form.opinion.neutral") %>
+        </button>
+        <button class="button tiny button--muted opinion-toggle--ko">
+          <%= icon "thumb-down", role: "none presentation" %>
+        </button>
+      </div>
+    <% end %>
+    <%== cell("decidim/comments/comment_form", model, root_depth: root_depth) %>
+  <% else %>
+    <p>
+      <span>
+        <%== t(
+          "decidim.components.add_comment_form.account_message",
+          sign_in_url: decidim.new_user_session_path,
+          sign_up_url: decidim.new_user_registration_path
+        ) %>
+      </span>
+    </p>
+  <% end %>
+</div>

data/app/cells/decidim/comments/comments/blocked_comments_warning.erb

@@ -0,0 +1,3 @@
+<div class="callout warning">
+  <p><%= t("decidim.components.comments.blocked_comments_warning") %></p>
+</div>

data/app/cells/decidim/comments/comments/order_control.erb

@@ -0,0 +1,37 @@
+<div class="order-by__dropdown order-by__dropdown--right">
+  <span class="order-by__text"><%= t("decidim.components.comment_order_selector.title") %></span>
+  <ul class="dropdown menu"
+    data-dropdown-menu="data-dropdown-menu"
+    data-autoclose="false"
+    data-disable-hover="true"
+    data-click-open="true"
+    data-close-on-click="true"
+    tabindex="-1"
+    role="menubar">
+    <li class="is-dropdown-submenu-parent opens-right" tabindex="-1" role="none">
+      <a href="#" id="comments-order-menu-control"
+        aria-label="<%= t("decidim.components.comment_order_selector.title") %>"
+        aria-controls="comments-order-menu"
+        aria-haspopup="true"
+        role="menuitem"><%= t("decidim.components.comment_order_selector.order.#{order}") %></a>
+      <ul class="menu is-dropdown-submenu submenu first-sub vertical"
+        id="comments-order-chooser-menu"
+        role="menu"
+        aria-labelledby="comments-order-menu-control"
+        tabindex="-1"
+        data-submenu="">
+        <% available_orders.each do |order_value| %>
+          <li role="none" class="is-submenu-item is-dropdown-submenu-item">
+            <%= link_to(
+              t("decidim.components.comment_order_selector.order.#{order_value}"),
+              decidim_comments.comments_path(commentable_gid: model.to_signed_global_id.to_s, order: order_value, reload: 1),
+              tabindex: -1,
+              role: "menuitem",
+              remote: true
+            ) %>
+          </li>
+        <% end %>
+      </ul>
+    </li>
+  </ul>
+</div>

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

@@ -0,0 +1,32 @@
+<%= content_tag :div, id: node_id, data: { decidim_comments: comments_data } do %>
+  <div class="columns large-9 comments-container" id="comments">
+    <div class="comments">
+      <div class="row collapse order-by">
+        <h2 class="order-by__text section-heading">
+          <% if single_comment? %>
+            <%= t("decidim.components.comments.comment_details_title") %>
+          <% else %>
+            <span class="comments-count">
+              <%= t("decidim.components.comments.title", count: comments_count) %>
+            </span>
+          <% end %>
+        </h2>
+        <%= render :order_control %>
+      </div>
+      <%= single_comment_warning %>
+      <%= blocked_comments_warning %>
+      <div class="comment-threads">
+        <% comments.each do |comment| %>
+          <%= cell("decidim/comments/comment_thread", comment, order: order) %>
+        <% end %>
+      </div>
+      <%= add_comment %>
+      <%= user_comments_blocked_warning %>
+    </div>
+    <div class="callout primary loading-comments hide">
+      <p><%= t("decidim.components.comments.loading") %></p>
+    </div>
+  </div>
+<% end %>
+
+<%= javascript_include_tag("decidim/comments/comments") %>

data/app/cells/decidim/comments/comments/single_comment_warning.erb

@@ -0,0 +1,9 @@
+<div class="callout secondary">
+  <h5><%= t("decidim.components.comments.single_comment_warning_title") %></h5>
+  <p>
+    <%== t(
+    "decidim.components.comments.single_comment_warning",
+    url: "#{commentable_path}##{node_id}"
+    ) %>
+  </p>
+</div>

data/app/cells/decidim/comments/comments/user_comments_blocked_warning.erb

@@ -0,0 +1,3 @@
+<div class="callout warning">
+  <p><%= t("decidim.components.comments.blocked_comments_for_user_warning") %></p>
+</div>

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

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Comments
+    # A cell to display a comments section for a commentable object.
+    class CommentsCell < Decidim::ViewModel
+      include Decidim::IconHelper
+
+      delegate :user_signed_in?, to: :controller
+
+      def add_comment
+        return if single_comment?
+        return if comments_blocked?
+        return if user_comments_blocked?
+
+        render :add_comment
+      end
+
+      def single_comment_warning
+        return unless single_comment?
+
+        render :single_comment_warning
+      end
+
+      def blocked_comments_warning
+        return unless comments_blocked?
+        return unless user_comments_blocked?
+
+        render :blocked_comments_warning
+      end
+
+      def user_comments_blocked_warning
+        return if comments_blocked? # Shows already the general warning
+        return unless user_comments_blocked?
+
+        render :user_comments_blocked_warning
+      end
+
+      private
+
+      def decidim_comments
+        Decidim::Comments::Engine.routes.url_helpers
+      end
+
+      def comments
+        if single_comment?
+          [single_comment]
+        else
+          SortedComments.for(model, order_by: order)
+        end
+      end
+
+      def comments_count
+        model.comments.count
+      end
+
+      def root_depth
+        return 0 unless single_comment?
+
+        single_comment.depth
+      end
+
+      def commentable_path(params = {})
+        resource_locator(model).path(params)
+      end
+
+      def alignment_enabled?
+        model.comments_have_alignment?
+      end
+
+      def available_orders
+        %w(best_rated recent older most_discussed)
+      end
+
+      def order
+        options[:order] || "older"
+      end
+
+      def decidim
+        Decidim::Core::Engine.routes.url_helpers
+      end
+
+      def node_id
+        "comments-for-#{commentable_type.demodulize}-#{model.id}"
+      end
+
+      def commentable_type
+        model.commentable_type
+      end
+
+      def comments_data
+        {
+          singleComment: single_comment?,
+          toggleTranslations: machine_translations_toggled?,
+          commentableGid: model.to_signed_global_id.to_s,
+          commentsUrl: decidim_comments.comments_path,
+          rootDepth: root_depth,
+          lastCommentId: last_comment_id,
+          order: order
+        }
+      end
+
+      def last_comment_id
+        Decidim::Comments::Comment.where(
+          root_commentable: model
+        ).order(:id).pluck(:id).last
+      end
+
+      def single_comment?
+        single_comment.present?
+      end
+
+      def single_comment
+        return if options[:single_comment].blank?
+
+        @single_comment ||= model.comments.find_by(id: options[:single_comment])
+      end
+
+      def machine_translations_toggled?
+        options[:machine_translations] == true
+      end
+
+      def comments_blocked?
+        !model.accepts_new_comments?
+      end
+
+      def user_comments_blocked?
+        return false unless user_signed_in?
+
+        !model.user_allowed_to_comment?(current_user)
+      end
+    end
+  end
+end