decidim-debates 0.19.1 → 0.23.0

data/app/models/decidim/debates/debate.rb

@@ -11,7 +11,7 @@ module Decidim
       include Decidim::Resourceable
       include Decidim::Followable
       include Decidim::Comments::Commentable
-      include Decidim::ScopableComponent
+      include Decidim::ScopableResource
       include Decidim::Authorable
       include Decidim::Reportable
       include Decidim::HasReference
@@ -19,22 +19,44 @@ module Decidim
       include Decidim::Loggable
       include Decidim::DataPortability
       include Decidim::NewsletterParticipant
+      include Decidim::Searchable
+      include Decidim::TranslatableResource
+      include Decidim::TranslatableAttributes
+      include Decidim::Endorsable
+      include Decidim::Randomable
 
+      belongs_to :last_comment_by, polymorphic: true, foreign_key: "last_comment_by_id", foreign_type: "last_comment_by_type", optional: true
       component_manifest_name "debates"
 
       validates :title, presence: true
 
+      translatable_fields :title, :description, :instructions, :information_updates
+      searchable_fields({
+                          participatory_space: { component: :participatory_space },
+                          A: :title,
+                          D: :description,
+                          datetime: :start_time
+                        },
+                        index_on_create: ->(debate) { debate.visible? },
+                        index_on_update: ->(debate) { debate.visible? })
+
+      scope :open, -> { where(closed_at: nil) }
+      scope :closed, -> { where.not(closed_at: nil) }
+      scope :authored_by, ->(author) { where(author: author) }
+      scope :commented_by, lambda { |author|
+        joins(:comments).where(
+          decidim_comments_comments:
+          {
+            decidim_author_id: author.id,
+            decidim_author_type: author.class.base_class.name
+          }
+        )
+      }
+
       def self.log_presenter_class_for(_log)
         Decidim::Debates::AdminLog::DebatePresenter
       end
 
-      # Public: Checks whether the debate is official or not.
-      #
-      # Returns a boolean.
-      def official?
-        author.is_a?(Decidim::Organization)
-      end
-
       # Public: Overrides the `reported_content_url` Reportable concern method.
       def reported_content_url
         ResourceLocatorPresenter.new(self).url
@@ -72,6 +94,7 @@ module Decidim
       # Public: Overrides the `accepts_new_comments?` Commentable concern method.
       def accepts_new_comments?
         return false unless open?
+        return false if closed?
 
         commentable? && !comments_blocked?
       end
@@ -114,6 +137,45 @@ module Decidim
                                 .pluck(:decidim_author_id).flatten.compact.uniq
       end
 
+      # Checks whether the user can edit the debate.
+      #
+      # user - the user to check for authorship
+      def editable_by?(user)
+        !closed? && authored_by?(user)
+      end
+
+      # Checks whether the debate is closed or not.
+      #
+      def closed?
+        closed_at.present? && conclusions.present?
+      end
+
+      # Checks whether the user can edit the debate.
+      #
+      # user - the user to check for authorship
+      def closeable_by?(user)
+        authored_by?(user)
+      end
+
+      # Public: Updates the comments counter cache. We have to do it these
+      # way in order to properly calculate the counter with hidden
+      # comments.
+      #
+      # rubocop:disable Rails/SkipsModelValidations
+      def update_comments_count
+        comments_count = comments.not_hidden.count
+        last_comment = comments.not_hidden.order("created_at DESC").first
+
+        update_columns(
+          last_comment_at: last_comment&.created_at,
+          last_comment_by_id: last_comment&.decidim_author_id,
+          last_comment_by_type: last_comment&.decidim_author_type,
+          comments_count: comments_count,
+          updated_at: Time.current
+        )
+      end
+      # rubocop:enable Rails/SkipsModelValidations
+
       private
 
       def comments_blocked?

data/app/permissions/decidim/debates/admin/permissions.rb

@@ -12,7 +12,9 @@ module Decidim
           case permission_action.action
           when :create, :read
             allow!
-          when :update, :delete
+          when :update
+            toggle_allow(debate && !debate.closed? && debate.official?)
+          when :delete, :close
             toggle_allow(debate && debate.official?)
           end
 

data/app/permissions/decidim/debates/permissions.rb

@@ -15,6 +15,12 @@ module Decidim
           toggle_allow(can_create_debate?)
         when :report
           allow!
+        when :edit
+          can_edit_debate?
+        when :endorse
+          can_endorse_debate?
+        when :close
+          can_close_debate?
         end
 
         permission_action
@@ -26,6 +32,28 @@ module Decidim
         authorized?(:create) &&
           current_settings&.creation_enabled? && component.participatory_space.can_participate?(user)
       end
+
+      def can_edit_debate?
+        return allow! if debate&.editable_by?(user)
+
+        disallow!
+      end
+
+      def can_close_debate?
+        return allow! if debate&.closeable_by?(user)
+
+        disallow!
+      end
+
+      def can_endorse_debate?
+        return disallow! if debate.closed?
+
+        allow!
+      end
+
+      def debate
+        @debate ||= context.fetch(:debate, nil) || context.fetch(:resource, nil)
+      end
     end
   end
 end

data/app/presenters/decidim/debates/admin_log/debate_presenter.rb

@@ -15,14 +15,18 @@ module Decidim
       class DebatePresenter < Decidim::Log::BasePresenter
         private
 
+        def resource_presenter
+          @resource_presenter ||= Decidim::Debates::Log::ResourcePresenter.new(action_log.resource, h, action_log.extra["resource"])
+        end
+
         def diff_fields_mapping
           {
-            description: :i18n,
+            description: "Decidim::Debates::AdminLog::ValueTypes::DebateTitleDescriptionPresenter",
             end_date: :date,
             information_updates: :i18n,
             instructions: :i18n,
             start_date: :date,
-            title: :i18n
+            title: "Decidim::Debates::AdminLog::ValueTypes::DebateTitleDescriptionPresenter"
           }
         end
 

data/app/presenters/decidim/debates/admin_log/value_types/debate_title_description_presenter.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Debates
+    module AdminLog
+      module ValueTypes
+        # This class presents the given value as a Decidim::Debates::DebateTitleBody. Check
+        # the `DefaultPresenter` for more info on how value presenters work.
+        class DebateTitleDescriptionPresenter < Decidim::Log::ValueTypes::DefaultPresenter
+          def present
+            return unless value
+
+            renderer = Decidim::ContentRenderers::HashtagRenderer.new(h.translated_attribute(value))
+            renderer.render(links: false).html_safe
+          end
+        end
+      end
+    end
+  end
+end

data/app/presenters/decidim/debates/debate_presenter.rb

@@ -6,8 +6,11 @@ module Decidim
     # Decorator for debates
     #
     class DebatePresenter < SimpleDelegator
+      include Decidim::TranslationsHelper
+      include Decidim::ResourceHelper
       include Decidim::SanitizeHelper
       include Decidim::TranslatableAttributes
+      include ActionView::Helpers::DateHelper
 
       def debate
         __getobj__
@@ -23,9 +26,67 @@ module Decidim
                     end
       end
 
-      def title
-        content = translated_attribute(debate.title)
-        decidim_html_escape(content)
+      def title(links: false, all_locales: false)
+        return unless debate
+
+        handle_locales(debate.title, all_locales) do |content|
+          renderer = Decidim::ContentRenderers::HashtagRenderer.new(decidim_html_escape(content))
+          renderer.render(links: links).html_safe
+        end
+      end
+
+      def description(strip_tags: false, links: false, all_locales: false)
+        return unless debate
+
+        handle_locales(debate.description, all_locales) do |content|
+          content = strip_tags(content) if strip_tags
+          renderer = Decidim::ContentRenderers::HashtagRenderer.new(content)
+          content = renderer.render(links: links).html_safe
+          content = Decidim::ContentRenderers::LinkRenderer.new(content).render if links
+          content
+        end
+      end
+
+      def handle_locales(content, all_locales, &block)
+        if all_locales
+          content.each_with_object({}) do |(key, value), parsed_content|
+            parsed_content[key] = if key == "machine_translations"
+                                    handle_locales(value, all_locales, &block)
+                                  else
+                                    block.call(value)
+                                  end
+          end
+        else
+          yield(translated_attribute(content))
+        end
+      end
+
+      def last_comment_at
+        return unless debate.last_comment_at
+
+        time_ago_in_words(debate.last_comment_at)
+      end
+
+      def last_comment_by
+        debate.last_comment_by&.presenter
+      end
+
+      def participants_count
+        comments_authors.count do |author|
+          author.is_a?(Decidim::User)
+        end
+      end
+
+      def groups_count
+        comments_authors.count do |author|
+          author.is_a?(Decidim::UserGroup)
+        end
+      end
+
+      private
+
+      def comments_authors
+        @comments_authors ||= debate.comments.includes(:author, :user_group).map(&:normalized_author).uniq
       end
     end
   end

data/app/presenters/decidim/debates/log/resource_presenter.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Debates
+    module Log
+      class ResourcePresenter < Decidim::Log::ResourcePresenter
+        private
+
+        # Private: Presents resource name.
+        #
+        # Returns an HTML-safe String.
+        def present_resource_name
+          Decidim::Debates::DebatePresenter.new(resource).title
+        end
+      end
+    end
+  end
+end

data/app/presenters/decidim/debates/official_author_presenter.rb

@@ -5,38 +5,10 @@ module Decidim
     #
     # A dummy presenter to abstract out the author of an official debate.
     #
-    class OfficialAuthorPresenter
+    class OfficialAuthorPresenter < Decidim::OfficialAuthorPresenter
       def name
         I18n.t("decidim.debates.models.debate.fields.official_debate")
       end
-
-      def nickname
-        ""
-      end
-
-      def badge
-        ""
-      end
-
-      def profile_path
-        ""
-      end
-
-      def avatar_url
-        ActionController::Base.helpers.asset_path("decidim/default-avatar.svg")
-      end
-
-      def deleted?
-        false
-      end
-
-      def can_be_contacted?
-        false
-      end
-
-      def has_tooltip?
-        false
-      end
     end
   end
 end

data/app/queries/decidim/debates/metrics/debates_metric_manage.rb

@@ -9,9 +9,6 @@ module Decidim
         end
 
         def save
-          return @registry if @registry
-
-          @registry = []
           cumulative.each do |key, cumulative_value|
             next if cumulative_value.zero?
 
@@ -21,10 +18,8 @@ module Decidim
                                                            organization: @organization, decidim_category_id: category_id,
                                                            participatory_space_type: space_type, participatory_space_id: space_id)
             record.assign_attributes(cumulative: cumulative_value, quantity: quantity_value)
-            @registry << record
+            record.save!
           end
-          @registry.each(&:save!)
-          @registry
         end
 
         private
@@ -32,8 +27,7 @@ module Decidim
         def query
           return @query if @query
 
-          components = Decidim::Component.where(participatory_space: retrieve_participatory_spaces).published
-          @query = Decidim::Debates::Debate.where(component: components).joins(:component)
+          @query = Decidim::Debates::Debate.where(component: visible_component_ids_from_spaces(retrieve_participatory_spaces)).joins(:component)
                                            .left_outer_joins(:category)
           @query = @query.where("decidim_debates_debates.start_time <= ?", end_time)
           @query = @query.group("decidim_categorizations.decidim_category_id",

data/app/services/decidim/debates/debate_search.rb

@@ -6,41 +6,31 @@ module Decidim
     # `current_component` param with a `Decidim::Component` in order to
     # find the debates.
     class DebateSearch < ResourceSearch
+      text_search_fields :title, :description
+
       # Public: Initializes the service.
       # component     - A Decidim::Component to get the debates from.
       # page        - The page number to paginate the results.
-      # per_page    - The number of proposals to return per page.
+      # per_page    - The number of debates to return per page.
       def initialize(options = {})
         super(Debate.not_hidden, options)
       end
 
-      # Handle the search_text filter. We have to cast the JSONB columns
-      # into a `text` type so that we can search.
-      def search_search_text
-        query
-          .where("decidim_debates_debates.title::text ILIKE ?", "%#{search_text}%")
-          .or(query.where("decidim_debates_debates.description::text ILIKE ?", "%#{search_text}%"))
-      end
-
-      # Handle the origin filter
-      def search_origin
-        if origin == "official"
-          query.where(author: component.organization)
-        elsif origin == "citizens"
-          query.where.not(decidim_author_type: "Decidim::Organization")
+      # Handle the activity filter
+      def search_activity
+        case activity
+        when "commented"
+          query.commented_by(user)
+        when "my_debates"
+          query.authored_by(user)
         else # Assume 'all'
           query
         end
       end
 
-      def search_order_start_time
-        if order_start_time == "asc"
-          query.order("start_time ASC")
-        elsif order_start_time == "desc"
-          query.order("start_time DESC")
-        else
-          query.order("start_time ASC")
-        end
+      # Handle the state filter
+      def search_state
+        apply_scopes(%w(open closed), state)
       end
     end
   end

data/app/services/decidim/debates/diff_renderer.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Debates
+    class DiffRenderer < BaseDiffRenderer
+      private
+
+      # Lists which attributes will be diffable and how they should be rendered.
+      def attribute_types
+        {
+          title: :i18n,
+          description: :i18n,
+          information_updates: :i18n,
+          instructions: :i18n,
+          start_time: :string,
+          end_time: :string,
+          conclusions: :i18n,
+          closed_at: :string
+        }
+      end
+
+      def debate
+        @debate ||= Debate.find_by(id: version.item_id)
+      end
+    end
+  end
+end