decidim-decidim_awesome 0.6.5 → 0.7.2

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Decidim
+  module DecidimAwesome
+    module Admin
+      class CreateProposalCustomField < Rectify::Command
+        include NeedsConstraintHelpers
+
+        # Public: Initializes the command.
+        #
+        def initialize(organization)
+          @organization = organization
+          @ident = rand(36**8).to_s(36)
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid.
+        # - :invalid if we couldn't proceed.
+        #
+        # Returns nothing.
+        def call
+          fields = AwesomeConfig.find_or_initialize_by(var: :proposal_custom_fields, organization: @organization)
+          fields.value = {} unless fields.value.is_a? Hash
+          # TODO: prevent (unlikely) colisions with exisiting values
+          fields.value[@ident] = default_definition
+          fields.save!
+
+          create_constraint_never(:proposal_custom_field)
+
+          broadcast(:ok, @ident)
+        rescue StandardError => e
+          broadcast(:invalid, e.message)
+        end
+
+        private
+
+        def default_definition
+          # '[{"type":"textarea","required":true,"label":"Body","className":"form-control","name":"body","subtype":"textarea"}]'
+          "[]"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Decidim
+  module DecidimAwesome
+    module Admin
+      class CreateScopedAdmin < Rectify::Command
+        include NeedsConstraintHelpers
+
+        # Public: Initializes the command.
+        #
+        def initialize(organization)
+          @organization = organization
+          @ident = rand(36**8).to_s(36)
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid.
+        # - :invalid if we couldn't proceed.
+        #
+        # Returns nothing.
+        def call
+          admins = AwesomeConfig.find_or_initialize_by(var: :scoped_admins, organization: @organization)
+          admins.value = {} unless admins.value.is_a? Hash
+          # TODO: prevent (unlikely) colisions with exisiting values
+          admins.value[@ident] = []
+          admins.save!
+
+          create_constraint_never(:scoped_admin)
+
+          broadcast(:ok, @ident)
+        rescue StandardError => e
+          broadcast(:invalid, e.message)
+        end
+      end
+    end
+  end
+end

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

@@ -4,6 +4,8 @@ module Decidim
   module DecidimAwesome
     module Admin
       class DestroyConstraint < Rectify::Command
+        include NeedsConstraintHelpers
+
         # Public: Initializes the command.
         #
         # constraint - A constraint constraint
@@ -18,6 +20,8 @@ module Decidim
         #
         # Returns nothing.
         def call
+          return broadcast(:invalid, I18n.t("cannot_be_destroyed", scope: "decidim.decidim_awesome.admin.config.constraints")) unless constraint_can_be_destroyed?(constraint)
+
           constraint.destroy!
           broadcast(:ok)
         rescue StandardError => e

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Decidim
+  module DecidimAwesome
+    module Admin
+      class DestroyProposalCustomField < Rectify::Command
+        # Public: Initializes the command.
+        #
+        # key - the key to destroy inise proposal_custom_fields
+        # organization
+        def initialize(key, organization)
+          @key = key
+          @organization = organization
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid.
+        # - :invalid if we couldn't proceed.
+        #
+        # Returns nothing.
+        def call
+          fields = AwesomeConfig.find_by(var: :proposal_custom_fields, organization: @organization)
+          return broadcast(:invalid, "Not a hash") unless fields&.value.is_a? Hash
+          return broadcast(:invalid, "#{key} key invalid") unless fields.value.has_key?(@key)
+
+          fields.value.except!(@key)
+          fields.save!
+          # remove constrains associated (a new config var is generated automatically, by removing it, it will trigger destroy on dependents)
+          constraint = AwesomeConfig.find_by(var: "proposal_custom_field_#{@key}", organization: @organization)
+          constraint.destroy! if constraint.present?
+
+          broadcast(:ok, @key)
+        rescue StandardError => e
+          broadcast(:invalid, e.message)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Decidim
+  module DecidimAwesome
+    module Admin
+      class DestroyScopedAdmin < Rectify::Command
+        # Public: Initializes the command.
+        #
+        # key - the key to destroy inside scoped_admins
+        # organization
+        def initialize(key, organization)
+          @key = key
+          @organization = organization
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid.
+        # - :invalid if we couldn't proceed.
+        #
+        # Returns nothing.
+        def call
+          admins = AwesomeConfig.find_by(var: :scoped_admins, organization: @organization)
+          return broadcast(:invalid, "Not a hash") unless admins&.value.is_a? Hash
+          return broadcast(:invalid, "#{key} key invalid") unless admins.value.has_key?(@key)
+
+          admins.value.except!(@key)
+          admins.save!
+          # remove constrains associated (a new config var is generated automatically, by removing it, it will trigger destroy on dependents)
+          constraint = AwesomeConfig.find_by(var: "scoped_admin_#{@key}", organization: @organization)
+          constraint.destroy! if constraint.present?
+
+          broadcast(:ok, @key)
+        rescue StandardError => e
+          broadcast(:invalid, e.message)
+        end
+      end
+    end
+  end
+end

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

@@ -6,7 +6,7 @@ module Decidim
       class DestroyScopedStyle < Rectify::Command
         # Public: Initializes the command.
         #
-        # key - the key to destroy inise scoped_styles
+        # key - the key to destroy inside scoped_styles
         # organization
         def initialize(key, organization)
           @key = key

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

@@ -18,7 +18,11 @@ module Decidim
         #
         # Returns nothing.
         def call
-          return broadcast(:invalid) if form.invalid?
+          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
 
           begin
             form.attributes.each do |key, val|

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/checks_controller.rb

@@ -37,7 +37,7 @@ module Decidim
         end
 
         def decidim_version_valid?
-          Gem::Dependency.new("", DecidimAwesome::COMPAT_DECIDIM_VERSION).match?("", decidim_version)
+          Gem::Dependency.new("", DecidimAwesome::COMPAT_DECIDIM_VERSION).match?("", decidim_version, true)
         end
 
         def head_addons(part)

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
@@ -28,39 +28,44 @@ module Decidim
               redirect_to decidim_admin_decidim_awesome.config_path
             end
 
-            on(:invalid) do |message|
+            on(:invalid) do |message, err|
               flash.now[:alert] = I18n.t("config.update.error", error: message, scope: "decidim.decidim_awesome.admin")
-              render :show
+              render :show, locals: { errors: err.presence }
             end
           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/menu_hacks_controller.rb

@@ -85,7 +85,7 @@ module Decidim
         end
 
         def current_items
-          @current_items ||= current_menu.items(true)
+          @current_items ||= current_menu.items(include_invisible: true)
         end
 
         def current_menu
@@ -101,7 +101,7 @@ module Decidim
         end
 
         def visibility_options
-          MenuForm::VISIBILITY_STATES.map { |key| [I18n.t(".menu_hacks.form.visibility.#{key}", scope: "decidim.decidim_awesome.admin"), key] }.to_h
+          MenuForm::VISIBILITY_STATES.index_by { |key| I18n.t(".menu_hacks.form.visibility.#{key}", scope: "decidim.decidim_awesome.admin") }
         end
 
         def target_options

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/controllers/decidim/decidim_awesome/map_component/map_controller.rb

@@ -14,10 +14,7 @@ module Decidim
         private
 
         def maps_enabled?
-          return Decidim::Map.configured? if defined?(Decidim::Map)
-
-          # TODO: remove when 0.22 support is diched
-          Decidim.geocoder.present?
+          Decidim::Map.configured?
         end
 
         def map_components

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
@@ -20,11 +24,57 @@ module Decidim
         # collect all keys anything not specified in the params (UpdateConfig command ignores it)
         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