decidim-debates 0.19.1 → 0.23.0

data/app/controllers/decidim/debates/admin/debates_controller.rb

@@ -5,6 +5,8 @@ module Decidim
     module Admin
       # This controller allows an admin to manage debates from a Participatory Space
       class DebatesController < Decidim::Debates::Admin::ApplicationController
+        helper Decidim::ApplicationHelper
+
         helper_method :debates
 
         def index
@@ -38,13 +40,13 @@ module Decidim
         def edit
           enforce_permission_to :update, :debate, debate: debate
 
-          @form = form(DebateForm).from_model(debate)
+          @form = form(Decidim::Debates::Admin::DebateForm).from_model(debate)
         end
 
         def update
           enforce_permission_to :update, :debate, debate: debate
 
-          @form = form(DebateForm).from_params(params, current_component: current_component)
+          @form = form(Decidim::Debates::Admin::DebateForm).from_params(params, current_component: current_component)
 
           UpdateDebate.call(@form, debate) do
             on(:ok) do

data/app/controllers/decidim/debates/debates_controller.rb

@@ -6,11 +6,14 @@ module Decidim
     class DebatesController < Decidim::Debates::ApplicationController
       helper Decidim::ApplicationHelper
       helper Decidim::Messaging::ConversationHelper
+      helper Decidim::WidgetUrlsHelper
       include FormFactory
       include FilterResource
       include Paginable
+      include Flaggable
+      include Decidim::Debates::Orderable
 
-      helper_method :debates, :debate, :paginated_debates, :report_form
+      helper_method :debates, :debate, :form_presenter, :paginated_debates, :report_form, :close_debate_form
 
       def new
         enforce_permission_to :create, :debate
@@ -21,7 +24,7 @@ module Decidim
       def create
         enforce_permission_to :create, :debate
 
-        @form = form(DebateForm).from_params(params, current_component: current_component)
+        @form = form(DebateForm).from_params(params)
 
         CreateDebate.call(@form) do
           on(:ok) do |debate|
@@ -36,25 +39,80 @@ module Decidim
         end
       end
 
+      def show
+        raise ActionController::RoutingError, "Not Found" if debate.blank?
+      end
+
+      def edit
+        enforce_permission_to :edit, :debate, debate: debate
+
+        @form = form(DebateForm).from_model(debate)
+      end
+
+      def update
+        enforce_permission_to :edit, :debate, debate: debate
+
+        @form = form(DebateForm).from_params(params)
+        @form.debate = debate
+
+        UpdateDebate.call(@form) do
+          on(:ok) do |debate|
+            flash[:notice] = I18n.t("debates.update.success", scope: "decidim.debates")
+            redirect_to Decidim::ResourceLocatorPresenter.new(debate).path
+          end
+
+          on(:invalid) do
+            flash.now[:alert] = I18n.t("debates.update.invalid", scope: "decidim.debates")
+            render :edit
+          end
+        end
+      end
+
+      def close
+        enforce_permission_to :close, :debate, debate: debate
+
+        @form = form(CloseDebateForm).from_params(params)
+        @form.debate = debate
+
+        CloseDebate.call(@form) do
+          on(:ok) do |debate|
+            flash[:notice] = I18n.t("debates.close.success", scope: "decidim.debates")
+            redirect_back fallback_location: Decidim::ResourceLocatorPresenter.new(debate).path
+          end
+
+          on(:invalid) do
+            flash[:alert] = I18n.t("debates.close.invalid", scope: "decidim.debates")
+            redirect_back fallback_location: Decidim::ResourceLocatorPresenter.new(debate).path
+          end
+        end
+      end
+
       private
 
+      def form_presenter
+        @form_presenter ||= present(@form, presenter_class: Decidim::Debates::DebatePresenter)
+      end
+
       def paginated_debates
-        @paginated_debates ||= paginate(debates)
-                               .includes(:category)
+        @paginated_debates ||= paginate(debates).includes(:category)
       end
 
       def debates
-        @debates ||= search.results
+        @debates ||= reorder(search.results)
       end
 
       def debate
-        @debate ||= debates.find(params[:id])
+        @debate ||= debates.find_by(id: params[:id])
       end
 
       def report_form
         @report_form ||= form(Decidim::ReportForm).from_params(reason: "spam")
       end
 
+      def close_debate_form
+        @close_debate_form ||= form(CloseDebateForm).from_model(debate)
+      end
+
       def search_klass
         DebateSearch
       end
@@ -69,9 +127,12 @@ module Decidim
       def default_filter_params
         {
           search_text: "",
-          order_start_time: "asc",
-          origin: "all",
-          category_id: ""
+          origin: %w(official citizens user_group),
+          activity: "all",
+          category_id: default_filter_category_params,
+          scope_id: default_filter_scope_params,
+          status: "all",
+          state: %w(open closed)
         }
       end
     end

data/app/controllers/decidim/debates/orderable.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Decidim
+  module Debates
+    # Common logic to sorting resources
+    module Orderable
+      extend ActiveSupport::Concern
+
+      included do
+        include Decidim::Orderable
+
+        private
+
+        def available_orders
+          @available_orders ||= %w(random recent commented updated)
+        end
+
+        def default_order
+          "updated"
+        end
+
+        def reorder(debates)
+          case order
+          when "recent"
+            debates.order("created_at DESC")
+          when "commented"
+            debates.order("comments_count DESC")
+          when "updated"
+            debates.order("updated_at DESC")
+          when "random"
+            debates.order_randomly(random_seed)
+          else
+            debates
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/debates/versions_controller.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Debates
+    # Exposes Debates versions so users can see how a Debate has been updated
+    # through time.
+    class VersionsController < Decidim::Proposals::ApplicationController
+      include Decidim::ApplicationHelper
+      include Decidim::ResourceVersionsConcern
+
+      def versioned_resource
+        @versioned_resource ||= present(Debate.where(component: current_component).find(params[:debate_id]))
+      end
+    end
+  end
+end

data/app/controllers/decidim/debates/widgets_controller.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Debates
+    class WidgetsController < Decidim::WidgetsController
+      helper Debates::ApplicationHelper
+
+      private
+
+      def model
+        @model ||= Debate.where(component: params[:component_id]).find(params[:debate_id])
+      end
+
+      def iframe_url
+        @iframe_url ||= debate_widget_url(model)
+      end
+    end
+  end
+end

data/app/events/decidim/debates/close_debate_event.rb

@@ -0,0 +1,15 @@
+# frozen-string_literal: true
+
+module Decidim
+  module Debates
+    class CloseDebateEvent < Decidim::Events::SimpleEvent
+      def resource_text
+        translated_attribute(resource.conclusions)
+      end
+
+      def event_has_roles?
+        true
+      end
+    end
+  end
+end

data/app/events/decidim/debates/create_debate_event.rb

@@ -14,8 +14,6 @@ module Decidim
 
       i18n_attributes :space_title, :space_path
 
-      delegate :author, to: :resource
-
       def resource_text
         translated_attribute(resource.description)
       end

data/app/forms/decidim/debates/admin/close_debate_form.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Debates
+    module Admin
+      # This class holds a Form to close debates from Decidim's admin views.
+      class CloseDebateForm < Decidim::Form
+        include TranslatableAttributes
+
+        mimic :debate
+
+        translatable_attribute :conclusions, String do |translated_attribute, locale|
+          validates translated_attribute, presence: true, if: ->(record) { record.default_locale?(locale) }
+          validates translated_attribute, length: { minimum: 10, maximum: 10_000 }, if: ->(record) { record.default_locale?(locale) }
+        end
+
+        attribute :debate, Debate
+
+        validates :debate, presence: true
+        validate :user_can_close_debate
+
+        def closed_at
+          debate&.closed_at || Time.current
+        end
+
+        private
+
+        def user_can_close_debate
+          errors.add(:debate, :invalid) unless debate.official?
+        end
+      end
+    end
+  end
+end

data/app/forms/decidim/debates/admin/debate_form.rb

@@ -24,7 +24,11 @@ module Decidim
         validates :category, presence: true, if: ->(form) { form.decidim_category_id.present? }
 
         def map_model(model)
-          self.decidim_category_id = model.category.try(:id)
+          self.decidim_category_id = model.categorization.decidim_category_id if model.categorization
+          presenter = DebatePresenter.new(model)
+
+          self.title = presenter.title(all_locales: title.is_a?(Hash))
+          self.description = presenter.description(all_locales: description.is_a?(Hash))
         end
 
         def category

data/app/forms/decidim/debates/close_debate_form.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Debates
+    # This class holds a Form to close debates from Decidim's public views.
+    class CloseDebateForm < Decidim::Form
+      mimic :debate
+
+      attribute :conclusions, String
+      attribute :debate, Debate
+
+      validates :debate, presence: true
+      validates :conclusions, presence: true, length: { minimum: 10, maximum: 10_000 }
+      validate :user_can_close_debate
+
+      def closed_at
+        debate&.closed_at || Time.current
+      end
+
+      def map_model(debate)
+        super
+        self.debate = debate
+
+        # Debates can be translated in different languages from the admin but
+        # the public form doesn't allow it. When a user closes a debate the
+        # user locale is taken as the text locale.
+        self.conclusions = debate.conclusions&.values&.first
+      end
+
+      private
+
+      def user_can_close_debate
+        return if !debate || !debate.respond_to?(:closeable_by?)
+
+        errors.add(:debate, :invalid) unless debate.closeable_by?(current_user)
+      end
+    end
+  end
+end

data/app/forms/decidim/debates/debate_form.rb

@@ -10,15 +10,41 @@ module Decidim
       attribute :description, String
       attribute :category_id, Integer
       attribute :user_group_id, Integer
+      attribute :debate, Debate
 
       validates :title, presence: true
       validates :description, presence: true
-
       validates :category, presence: true, if: ->(form) { form.category_id.present? }
+      validate :editable_by_user
+
+      def map_model(debate)
+        super
+        self.debate = debate
+
+        # Debates can be translated in different languages from the admin but
+        # the public form doesn't allow it. When a user creates a debate the
+        # user locale is taken as the text locale.
+        self.title = debate.title.values.first
+        self.description = debate.description.values.first
+        self.user_group_id = debate.decidim_user_group_id
+
+        if debate.category.present?
+          self.category_id = debate.category.id
+          @category = debate.category
+        end
+      end
 
       def category
         @category ||= current_component.categories.find_by(id: category_id)
       end
+
+      private
+
+      def editable_by_user
+        return unless debate.respond_to?(:editable_by?)
+
+        errors.add(:debate, :invalid) unless debate.editable_by?(current_user)
+      end
     end
   end
 end

data/app/helpers/decidim/debates/admin/application_helper.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Debates
+    module Admin
+      # Custom helpers, scoped to the debates admin engine.
+      #
+      module ApplicationHelper
+        include Decidim::Admin::ResourceScopeHelper
+      end
+    end
+  end
+end

data/app/helpers/decidim/debates/application_helper.rb

@@ -7,6 +7,61 @@ module Decidim
     module ApplicationHelper
       include PaginateHelper
       include Decidim::Comments::CommentsHelper
+      include Decidim::RichTextEditorHelper
+      include Decidim::EndorsableHelper
+      include Decidim::FollowableHelper
+      include Decidim::CheckBoxesTreeHelper
+
+      # If the debate is official or the rich text editor is enabled on the
+      # frontend, the debate description is considered as safe content.
+      def safe_content?
+        debate&.official? || rich_text_editor_in_public_views?
+      end
+
+      # If the content is safe, HTML tags are sanitized, otherwise, they are stripped.
+      def render_debate_description(debate)
+        description = present(debate).description(strip_tags: !safe_content?, links: true)
+
+        safe_content? ? decidim_sanitize(description) : simple_format(description)
+      end
+
+      # Returns :text_area or :editor based on current_component settings.
+      def text_editor_for_debate_description(form)
+        text_editor_for(form, :description)
+      end
+
+      # Returns a TreeNode to be used in the list filters to filter debates by
+      # its origin.
+      def filter_origin_values
+        origin_values = []
+        origin_values << TreePoint.new("official", t("decidim.debates.debates.filters.official"))
+        origin_values << TreePoint.new("citizens", t("decidim.debates.debates.filters.citizens"))
+        origin_values << TreePoint.new("user_group", t("decidim.debates.debates.filters.user_groups")) if current_organization.user_groups_enabled?
+
+        TreeNode.new(TreePoint.new("", t("decidim.debates.debates.filters.all")), origin_values)
+      end
+
+      # Options to filter Debates by activity.
+      def activity_filter_values
+        base = [
+          ["all", t("decidim.debates.debates.filters.all")],
+          ["my_debates", t("decidim.debates.debates.filters.my_debates")]
+        ]
+        base += [["commented", t("decidim.debates.debates.filters.commented")]]
+        base
+      end
+
+      # Returns a TreeNode to be used in the list filters to filter debates by
+      # its state.
+      def filter_debates_state_values
+        Decidim::CheckBoxesTreeHelper::TreeNode.new(
+          Decidim::CheckBoxesTreeHelper::TreePoint.new("", t("decidim.debates.debates.filters.all")),
+          [
+            Decidim::CheckBoxesTreeHelper::TreePoint.new("open", t("decidim.debates.debates.filters.state_values.open")),
+            Decidim::CheckBoxesTreeHelper::TreePoint.new("closed", t("decidim.debates.debates.filters.state_values.closed"))
+          ]
+        )
+      end
     end
   end
 end