decidim-decidim_awesome 0.7.0 → 0.7.2

data/app/commands/decidim/decidim_awesome/admin/rename_scope_label.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Decidim
+  module DecidimAwesome
+    module Admin
+      class RenameScopeLabel < Rectify::Command
+        # Public: Initializes the command.
+        #
+        # params - A constraint params
+        def initialize(params, organization)
+          @text = params[:text]&.strip&.gsub(" ", "_")&.parameterize&.truncate(64)
+          @scope = params[:scope]
+          @key = params[:key]
+          @attribute = params[:attribute]
+          @organization = organization
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid.
+        # - :invalid if we couldn't proceed.
+        #
+        # Returns nothing.
+        def call
+          raise StandardError, "empty value" if @text.blank?
+          raise StandardError, "key already exists" if config.value.keys.include? @text
+
+          transaction do
+            config.value[@text] = config.value.delete @key
+            config.save!
+            if config_scope
+              config_scope.var = scope
+              config_scope.save!
+            end
+          end
+
+          broadcast(:ok, { scope: scope, key: @text })
+        rescue StandardError => e
+          broadcast(:invalid, e.message)
+        end
+
+        private
+
+        def scope
+          @scope.gsub(/_#{@key}$/, "_#{@text}")
+        end
+
+        def config
+          @config ||= Decidim::DecidimAwesome::AwesomeConfig.find_by!(var: @attribute, organization: @organization)
+        end
+
+        def config_scope
+          @config_scope ||= Decidim::DecidimAwesome::AwesomeConfig.find_by(var: @scope, organization: @organization)
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/decidim_awesome/admin/update_config.rb

@@ -20,6 +20,7 @@ module Decidim
         def call
           if form.invalid?
             message = form.errors[:scoped_styles].join("; ") if @form.errors[:scoped_styles].any?
+            message = form.errors[:scoped_admins].join("; ") if @form.errors[:scoped_admins].any?
             return broadcast(:invalid, message, form.errors)
           end
 

data/app/controllers/concerns/decidim/decidim_awesome/admin_not_found_redirect.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Decidim
+  module DecidimAwesome
+    module AdminNotFoundRedirect
+      extend ActiveSupport::Concern
+
+      included do
+        # rubocop:disable Rails/LexicallyScopedActionFilter:
+        before_action :redirect_unallowed_scoped_admins, only: :not_found
+        # rubocop:enable Rails/LexicallyScopedActionFilter
+
+        private
+
+        def redirect_unallowed_scoped_admins
+          return unless request.original_fullpath =~ %r{^(/+)admin}
+          return unless Decidim::User.respond_to? :awesome_potential_admins
+          return unless defined? current_user
+          return unless Decidim::User.awesome_potential_admins.include? current_user.id
+
+          # assiging a flash message here does not work after redirection due the order of middleware in Rails
+          # as a workaround, send a message through a get parameter
+          path = "/admin/?unauthorized"
+          referer = request.headers["Referer"]
+          if referer
+            uri = URI(referer)
+            params = Rack::Utils.parse_query uri.query
+            unless request.params.has_key? "unauthorized"
+              params["unauthorized"] = nil
+              path = "#{uri.path}?#{Rack::Utils.build_query(params)}"
+            end
+          end
+
+          redirect_to path
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/decidim_awesome/admin/config_controller.rb

@@ -11,7 +11,7 @@ module Decidim
 
         layout "decidim/admin/decidim_awesome"
 
-        helper_method :constraints_for
+        helper_method :constraints_for, :users_for
         before_action do
           enforce_permission_to :edit_config, configs
         end
@@ -35,32 +35,37 @@ module Decidim
           end
         end
 
-        def new_scoped_style
-          CreateScopedStyle.call(current_organization) do
-            on(:ok) do |key|
-              flash[:notice] = I18n.t("config.create_scoped_style.success", key: key, scope: "decidim.decidim_awesome.admin")
-            end
-
-            on(:invalid) do |message|
-              flash[:alert] = I18n.t("config.create_scoped_style.error", error: message, scope: "decidim.decidim_awesome.admin")
+        def users
+          respond_to do |format|
+            format.json do
+              if (term = params[:term].to_s).present?
+                query = current_organization.users.order(name: :asc)
+                query = query.where("name ILIKE :term OR nickname ILIKE :term OR email ILIKE :term", term: "%#{term}%")
+
+                render json: query.all.collect { |u| { id: u.id, text: format_user_name(u) } }
+              else
+                render json: []
+              end
             end
           end
-
-          redirect_to decidim_admin_decidim_awesome.config_path(:styles)
         end
 
-        def destroy_scoped_style
-          DestroyScopedStyle.call(params[:key], current_organization) do
-            on(:ok) do |key|
-              flash[:notice] = I18n.t("config.destroy_scoped_style.success", key: key, scope: "decidim.decidim_awesome.admin")
+        def rename_scope_label
+          RenameScopeLabel.call(params, current_organization) do
+            on(:ok) do |result|
+              render json: result.merge({
+                                          html: render_to_string(partial: "decidim/decidim_awesome/admin/config/constraints",
+                                                                 locals: {
+                                                                   key: result[:scope],
+                                                                   constraints: constraints_for(result[:scope])
+                                                                 })
+                                        })
             end
 
             on(:invalid) do |message|
-              flash[:alert] = I18n.t("config.destroy_scoped_style.error", error: message, scope: "decidim.decidim_awesome.admin")
+              render json: { error: message }, status: :unprocessable_entity
             end
           end
-
-          redirect_to decidim_admin_decidim_awesome.config_path(:styles)
         end
 
         private
@@ -74,6 +79,14 @@ module Decidim
 
           DecidimAwesome.config.keys
         end
+
+        def users_for(ids_list)
+          Decidim::User.where(id: ids_list).map { |user| OpenStruct.new(text: format_user_name(user), id: user.id) }
+        end
+
+        def format_user_name(user)
+          "<span class='#{"is-admin" if user.read_attribute("admin")}'>#{user.name} (@#{user.nickname} - #{user.email})</span>"
+        end
       end
     end
   end

data/app/controllers/decidim/decidim_awesome/admin/constraints_controller.rb

@@ -127,6 +127,10 @@ module Decidim
           case key
           when /^scoped_style_/
             :scoped_styles
+          when /^scoped_admin_/
+            :scoped_admins
+          when /^proposal_custom_field_/
+            :proposal_custom_fields
           else
             key
           end

data/app/controllers/decidim/decidim_awesome/admin/proposal_custom_fields_controller.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Decidim
+  module DecidimAwesome
+    module Admin
+      # Global configuration controller
+      class ProposalCustomFieldsController < DecidimAwesome::Admin::ConfigController
+        def create
+          CreateProposalCustomField.call(current_organization) do
+            on(:ok) do |key|
+              flash[:notice] = I18n.t("config.create_proposal_custom_field.success", key: key, scope: "decidim.decidim_awesome.admin")
+            end
+
+            on(:invalid) do |message|
+              flash[:alert] = I18n.t("config.create_proposal_custom_field.error", error: message, scope: "decidim.decidim_awesome.admin")
+            end
+          end
+
+          redirect_to decidim_admin_decidim_awesome.config_path(:proposal_custom_fields)
+        end
+
+        def destroy
+          DestroyProposalCustomField.call(params[:key], current_organization) do
+            on(:ok) do |key|
+              flash[:notice] = I18n.t("config.destroy_proposal_custom_field.success", key: key, scope: "decidim.decidim_awesome.admin")
+            end
+
+            on(:invalid) do |message|
+              flash[:alert] = I18n.t("config.destroy_proposal_custom_field.error", error: message, scope: "decidim.decidim_awesome.admin")
+            end
+          end
+
+          redirect_to decidim_admin_decidim_awesome.config_path(:proposal_custom_fields)
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/decidim_awesome/admin/scoped_admins_controller.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Decidim
+  module DecidimAwesome
+    module Admin
+      # Global configuration controller
+      class ScopedAdminsController < DecidimAwesome::Admin::ConfigController
+        def create
+          CreateScopedAdmin.call(current_organization) do
+            on(:ok) do |key|
+              flash[:notice] = I18n.t("config.create_scoped_admin.success", key: key, scope: "decidim.decidim_awesome.admin")
+            end
+
+            on(:invalid) do |message|
+              flash[:alert] = I18n.t("config.create_scoped_admin.error", error: message, scope: "decidim.decidim_awesome.admin")
+            end
+          end
+
+          redirect_to decidim_admin_decidim_awesome.config_path(:admins)
+        end
+
+        def destroy
+          DestroyScopedAdmin.call(params[:key], current_organization) do
+            on(:ok) do |key|
+              flash[:notice] = I18n.t("config.destroy_scoped_admin.success", key: key, scope: "decidim.decidim_awesome.admin")
+            end
+
+            on(:invalid) do |message|
+              flash[:alert] = I18n.t("config.destroy_scoped_admin.error", error: message, scope: "decidim.decidim_awesome.admin")
+            end
+          end
+
+          redirect_to decidim_admin_decidim_awesome.config_path(:admins)
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/decidim_awesome/admin/scoped_styles_controller.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Decidim
+  module DecidimAwesome
+    module Admin
+      # Global configuration controller
+      class ScopedStylesController < DecidimAwesome::Admin::ConfigController
+        def create
+          CreateScopedStyle.call(current_organization) do
+            on(:ok) do |key|
+              flash[:notice] = I18n.t("config.create_scoped_style.success", key: key, scope: "decidim.decidim_awesome.admin")
+            end
+
+            on(:invalid) do |message|
+              flash[:alert] = I18n.t("config.create_scoped_style.error", error: message, scope: "decidim.decidim_awesome.admin")
+            end
+          end
+
+          redirect_to decidim_admin_decidim_awesome.config_path(:styles)
+        end
+
+        def destroy
+          DestroyScopedStyle.call(params[:key], current_organization) do
+            on(:ok) do |key|
+              flash[:notice] = I18n.t("config.destroy_scoped_style.success", key: key, scope: "decidim.decidim_awesome.admin")
+            end
+
+            on(:invalid) do |message|
+              flash[:alert] = I18n.t("config.destroy_scoped_style.error", error: message, scope: "decidim.decidim_awesome.admin")
+            end
+          end
+
+          redirect_to decidim_admin_decidim_awesome.config_path(:styles)
+        end
+      end
+    end
+  end
+end

data/app/forms/decidim/decidim_awesome/admin/config_form.rb

@@ -4,6 +4,8 @@ module Decidim
   module DecidimAwesome
     module Admin
       class ConfigForm < Decidim::Form
+        include ActionView::Helpers::SanitizeHelper
+
         attribute :allow_images_in_full_editor, Boolean
         attribute :allow_images_in_small_editor, Boolean
         attribute :allow_images_in_proposals, Boolean
@@ -11,6 +13,8 @@ module Decidim
         attribute :allow_images_in_markdown_editor, Boolean
         attribute :auto_save_forms, Boolean
         attribute :scoped_styles, Hash
+        attribute :proposal_custom_fields, Hash
+        attribute :scoped_admins, Hash
         attribute :menu, Array[MenuForm]
         attribute :intergram_for_admins, Boolean
         attribute :intergram_for_admins_settings, IntergramForm
@@ -21,21 +25,56 @@ module Decidim
         attr_accessor :valid_keys
 
         validate :css_syntax, if: ->(form) { form.scoped_styles.present? }
+        validate :json_syntax, if: ->(form) { form.proposal_custom_fields.present? }
+
+        # TODO: validate non general admins are here
 
         def self.from_params(params, additional_params = {})
           instance = super(params, additional_params)
           instance.valid_keys = params.keys.map(&:to_sym) || []
+          instance.sanitize_labels!
           instance
         end
 
         def css_syntax
           scoped_styles.each do |key, code|
+            next unless code
+
             SassC::Engine.new(code).render
           rescue SassC::SyntaxError => e
             errors.add(:scoped_styles, I18n.t("config.form.errors.incorrect_css", key: key, scope: "decidim.decidim_awesome.admin"))
             errors.add(key.to_sym, e.message)
           end
         end
+
+        def json_syntax
+          proposal_custom_fields.each do |key, code|
+            next unless code
+
+            JSON.parse(code)
+          rescue JSON::ParserError => e
+            errors.add(:scoped_styles, I18n.t("config.form.errors.incorrect_json", key: key, scope: "decidim.decidim_awesome.admin"))
+            errors.add(key.to_sym, e.message)
+          end
+        end
+
+        # formBuilder has a bug and do not sanitize text if users copy/paste text with format in the label input
+        def sanitize_labels!
+          return unless proposal_custom_fields
+
+          proposal_custom_fields.transform_values! do |code|
+            next unless code
+
+            json = JSON.parse(code)
+            json.map! do |item|
+              item["label"] = strip_tags(item["label"])
+              item
+            end
+            JSON.generate(json)
+          rescue JSON::ParserError
+            code
+          end
+        end
       end
     end
   end

data/app/forms/decidim/decidim_awesome/admin/constraint_form.rb

@@ -10,7 +10,9 @@ module Decidim
         attribute :component_manifest, String
         attribute :component_id, Integer
 
-        validates :component_manifest, absence: true, if: ->(form) { form.component_id.present? || form.participatory_space_manifest == "system" }
+        validates :component_manifest, absence: true, if: lambda { |form|
+          form.component_id.present? || ConfigConstraintsHelpers::OTHER_MANIFESTS.include?(form.participatory_space_manifest&.to_sym)
+        }
         validates :component_id, absence: true, if: ->(form) { form.component_manifest.present? }
       end
     end

data/app/helpers/decidim/decidim_awesome/admin/config_constraints_helpers.rb

@@ -4,6 +4,8 @@ module Decidim
   module DecidimAwesome
     module Admin
       module ConfigConstraintsHelpers
+        OTHER_MANIFESTS = [:none, :system, :process_groups].freeze
+
         include Decidim::TranslatableAttributes
 
         def check(status)
@@ -28,7 +30,7 @@ module Decidim
         end
 
         def participatory_space_manifests
-          manifests = { system: I18n.t("decidim.decidim_awesome.admin.config.system") }
+          manifests = OTHER_MANIFESTS.map { |m| [m, I18n.t("decidim.decidim_awesome.admin.config.#{m}")] }.to_h
           Decidim.participatory_space_manifests.pluck(:name).each do |name|
             manifests[name.to_sym] = I18n.t("decidim.admin.menu.#{name}")
           end
@@ -36,7 +38,7 @@ module Decidim
         end
 
         def component_manifests(space = nil)
-          return {} if space == "system"
+          return {} if OTHER_MANIFESTS.include?(space)
 
           Decidim.component_manifests.pluck(:name).map do |name|
             [name.to_sym, I18n.t("decidim.components.#{name}.name")]
@@ -44,17 +46,17 @@ module Decidim
         end
 
         def participatory_spaces_list(manifest)
-          space = participatory_space_for_manifest(manifest)
+          space = model_for_manifest(manifest)
           return {} if space.blank?
 
           space.where(organization: current_organization).map do |item|
-            [item.slug, translated_attribute(item.title)]
+            [item.try(:slug) || item.id.to_s, translated_attribute(item.title)]
           end.to_h
         end
 
         def components_list(manifest, slug)
-          space = participatory_space_for_manifest(manifest)
-          return {} if space.blank?
+          space = model_for_manifest(manifest)
+          return {} unless space&.column_names&.include? "slug"
 
           components = Component.where(participatory_space: space.find_by(slug: slug))
           components.map do |item|
@@ -84,9 +86,11 @@ module Decidim
 
         private
 
-        def participatory_space_for_manifest(manifest)
+        def model_for_manifest(manifest)
           return nil if manifest.blank?
 
+          return Decidim::ParticipatoryProcessGroup if manifest == "process_groups"
+
           space = Decidim.find_participatory_space_manifest(manifest)
           return nil unless space
 

data/app/helpers/decidim/decidim_awesome/amendments_helper_override.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Decidim
+  module DecidimAwesome
+    module AmendmentsHelperOverride
+      extend ActiveSupport::Concern
+
+      included do
+        # original method
+        alias_method :decidim_amendments_form_field_for, :amendments_form_field_for
+
+        # override with custom fields if scope applies
+        def amendments_form_field_for(attribute, form, original_resource)
+          custom_fields = awesome_custom_fields(attribute, form)
+          return decidim_amendments_form_field_for(attribute, form, original_resource) if custom_fields.blank?
+
+          render_amendment_custom_fields_override(custom_fields, attribute, form, original_resource)
+        end
+
+        private
+
+        def render_amendment_custom_fields_override(fields, attribute, form, original_resource)
+          custom_fields = Decidim::DecidimAwesome::CustomFields.new(fields)
+          custom_fields.translate!
+          body = amendments_form_fields_value(original_resource, attribute)
+          custom_fields.apply_xml(body) if body.present?
+          # TODO: find a way to add errors as form is not the parent form
+          # form.object.errors.add(attribute, custom_fields.errors) if custom_fields.errors
+          render partial: "decidim/decidim_awesome/custom_fields/form_render", locals: { spec: custom_fields.to_json, form: form, name: attribute }
+        end
+
+        # Amendments don't use a URL specifying participatory space and component
+        # context for awesome config constraints must be obtained from the resource
+        def awesome_custom_fields(attribute, _form)
+          return unless attribute == :body
+
+          component = amendable.try(:component)
+          return unless component
+          return if component.settings.participatory_texts_enabled?
+
+          awesome_config = Decidim::DecidimAwesome::Config.new(component.organization)
+          awesome_config.context_from_component(component)
+          awesome_config.collect_sub_configs_values("proposal_custom_field")
+        end
+      end
+    end
+  end
+end

data/app/helpers/decidim/decidim_awesome/map_helper.rb

@@ -5,11 +5,19 @@ module Decidim
     module MapHelper
       include Decidim::MapHelper
 
+      # rubocop:disable Metrics/CyclomaticComplexity
+      # rubocop:disable Metrics/PerceivedComplexity:
       def awesome_map_for(components, &block)
-        map = dynamic_map_for({}, {}, &block)
-        return unless map
+        return unless map_utility_dynamic
 
-        map_html_options = {
+        map = awesome_builder.map_element({ class: "google-map" }, &block)
+        help = content_tag(:div, class: "map__help") do
+          sr_content = content_tag(:p, t("screen_reader_explanation", scope: "decidim.map.dynamic"), class: "show-for-sr")
+
+          sr_content
+        end
+
+        html_options = {
           "class" => "awesome-map",
           "id" => "awesome-map",
           "data-components" => components.map do |component|
@@ -21,20 +29,40 @@ module Decidim
                                    amendments: component.manifest.name == :proposals ? Decidim::Proposals::Proposal.where(component: component).only_emendations.count : 0
                                  }
                                end.to_json,
-          "data-collapsed" => current_component.settings.collapse,
-          "data-truncate" => current_component.settings.truncate,
-          "data-map-center" => current_component.settings.map_center,
-          "data-map-zoom" => current_component.settings.map_zoom,
-          "data-menu-amendments" => current_component.settings.menu_amendments,
-          "data-menu-meetings" => current_component.settings.menu_meetings,
-          "data-menu-hashtags" => current_component.settings.menu_hashtags,
-          "data-show-not-answered" => current_component.current_settings.show_not_answered,
-          "data-show-accepted" => current_component.current_settings.show_accepted,
-          "data-show-withdrawn" => current_component.current_settings.show_withdrawn,
-          "data-show-evaluating" => current_component.current_settings.show_evaluating,
-          "data-show-rejected" => current_component.current_settings.show_rejected
+          "data-hide-controls" => settings_source.try(:hide_controls),
+          "data-collapsed" => global_settings.collapse,
+          "data-truncate" => global_settings.truncate || 255,
+          "data-map-center" => global_settings.map_center,
+          "data-map-zoom" => global_settings.map_zoom || 8,
+          "data-menu-amendments" => global_settings.menu_amendments,
+          "data-menu-meetings" => global_settings.menu_meetings,
+          "data-menu-hashtags" => global_settings.menu_hashtags,
+          "data-show-not-answered" => step_settings&.show_not_answered,
+          "data-show-accepted" => step_settings&.show_accepted,
+          "data-show-withdrawn" => step_settings&.show_withdrawn,
+          "data-show-evaluating" => step_settings&.show_evaluating,
+          "data-show-rejected" => step_settings&.show_rejected
         }
-        content_tag(:div, map, map_html_options)
+
+        content_tag(:div, html_options) do
+          content_tag :div, class: "row column" do
+            help + map
+          end
+        end
+      end
+      # rubocop:enable Metrics/CyclomaticComplexity
+      # rubocop:enable Metrics/PerceivedComplexity:
+
+      def step_settings
+        settings_source.try(:current_settings)
+      end
+
+      def global_settings
+        settings_source.try(:settings)
+      end
+
+      def settings_source
+        try(:current_component) || self
       end
 
       # rubocop:disable Rails/HelperInstanceVariable
@@ -56,6 +84,29 @@ module Decidim
 
       private
 
+      def awesome_builder
+        options = {
+          popup_template_id: "marker-popup",
+          markers: []
+        }
+        builder = map_utility_dynamic.create_builder(self, options)
+
+        unless snippets.any?(:map)
+          snippets.add(:map, builder.stylesheet_snippets)
+          snippets.add(:map, builder.javascript_snippets)
+          snippets.add(:head, snippets.for(:map))
+        end
+
+        unless snippets.any?(:awesome_map)
+          snippets.add(:awesome_map, stylesheet_link_tag("decidim/decidim_awesome/awesome_map/map"))
+          snippets.add(:awesome_map, javascript_include_tag("decidim/decidim_awesome/awesome_map/map"))
+          snippets.add(:awesome_map, javascript_include_tag("decidim/decidim_awesome/awesome_map/load_map"))
+          snippets.add(:head, snippets.for(:awesome_map))
+        end
+
+        builder
+      end
+
       # rubocop:disable Style/FormatStringToken
       def append_category(category)
         @h += @golden_ratio_conjugate