decidim-decidim_awesome 0.6.7 → 0.8.1

data/db/migrate/20210628150825_change_awesome_config_var_type.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class ChangeAwesomeConfigVarType < ActiveRecord::Migration[5.2]
+  def change
+    change_column :decidim_awesome_config, :var, :string
+
+    Decidim::DecidimAwesome::AwesomeConfig.find_each do |config|
+      config.var.gsub!('"', "")
+      config.save!
+    end
+  end
+end

data/lib/decidim/decidim_awesome/admin_engine.rb

@@ -1,9 +1,13 @@
 # frozen_string_literal: true
 
+require "decidim/decidim_awesome/awesome_helpers"
+
 module Decidim
   module DecidimAwesome
     # This is the engine that runs on the public interface of `DecidimAwesome`.
     class AdminEngine < ::Rails::Engine
+      include AwesomeHelpers
+
       isolate_namespace Decidim::DecidimAwesome::Admin
 
       paths["db/migrate"] = nil
@@ -13,15 +17,16 @@ module Decidim
         # Add admin engine routes here
         resources :constraints
         resources :menu_hacks, except: [:show]
+        resources :custom_redirects, except: [:show]
         resources :config, param: :var, only: [:show, :update]
-        post :new_scoped_style, to: "config#new_scoped_style"
-        post :destroy_scoped_style, param: :key, to: "config#destroy_scoped_style"
+        resources :scoped_styles, param: :var, only: [:create, :destroy]
+        resources :proposal_custom_fields, param: :var, only: [:create, :destroy]
+        resources :scoped_admins, param: :var, only: [:create, :destroy]
+        get :users, to: "config#users"
+        post :rename_scope_label, to: "config#rename_scope_label"
         get :checks, to: "checks#index"
-        root to: "config#show", var: :editors
-      end
-
-      initializer "decidim_admin_awesome.assets" do |app|
-        app.config.assets.precompile += %w(decidim_admin_decidim_awesome_manifest.js decidim_admin_decidim_awesome_manifest.css)
+        post :migrate_images, to: "checks#migrate_images"
+        root to: "config#show"
       end
 
       initializer "decidim_decidim_awesome.admin_mount_routes" do
@@ -32,11 +37,13 @@ module Decidim
 
       initializer "decidim_awesome.admin_menu" do
         Decidim.menu :admin_menu do |menu|
-          menu.item I18n.t("menu.decidim_awesome", scope: "decidim.admin", default: "Decidim Awesome"),
-                    decidim_admin_decidim_awesome.config_path(:editors),
-                    icon_name: "fire",
-                    position: 7.5,
-                    active: is_active_link?(decidim_admin_decidim_awesome.config_path(:editors), :inclusive)
+          menu.add_item :awesome_menu,
+                        I18n.t("menu.decidim_awesome", scope: "decidim.admin", default: "Decidim Awesome"),
+                        decidim_admin_decidim_awesome.config_path(:editors),
+                        icon_name: "fire",
+                        position: 7.5,
+                        active: is_active_link?(decidim_admin_decidim_awesome.config_path(:editors), :inclusive),
+                        if: defined?(current_user) && current_user&.read_attribute("admin")
         end
       end
 

data/lib/decidim/decidim_awesome/awesome.rb

@@ -0,0 +1,214 @@
+# frozen_string_literal: true
+
+module Decidim
+  module DecidimAwesome
+    include ActiveSupport::Configurable
+
+    autoload :Config, "decidim/decidim_awesome/config"
+    autoload :SystemChecker, "decidim/decidim_awesome/system_checker"
+    autoload :ContextAnalyzers, "decidim/decidim_awesome/context_analyzers"
+    autoload :MenuHacker, "decidim/decidim_awesome/menu_hacker"
+    autoload :CustomFields, "decidim/decidim_awesome/custom_fields"
+
+    # Awesome coms with some components for participatory spaces
+    # Currently :awesome_map and :awesome_iframe, list them here
+    # if you wan to disable them
+    # NOTE if you have spaces with some of these components already configured
+    # and then they are deactivated, it will break you application as there will be
+    # references in the database
+    #
+    # use only symbols here
+    config_accessor :disabled_components do
+      [
+        # :awesome_map,
+        # :awesome_iframe
+      ]
+    end
+
+    # Boolean configuration options
+    #
+    # Default values for configuration options:
+    #   true  => always true but admins can still restrict its scope
+    #   false => default false, admins can turn it true
+    #   :disabled => false and non available, hidden from admins
+    config_accessor :allow_images_in_full_editor do
+      false
+    end
+
+    config_accessor :allow_images_in_small_editor do
+      false
+    end
+
+    config_accessor :allow_images_in_proposals do
+      false
+    end
+
+    config_accessor :use_markdown_editor do
+      false
+    end
+
+    config_accessor :allow_images_in_markdown_editor do
+      false
+    end
+
+    # used to save forms in localstorage
+    config_accessor :auto_save_forms do
+      false
+    end
+
+    # Live chat widget linked to Telegram account or group
+    config_accessor :intergram_for_admins do
+      false
+    end
+
+    config_accessor :intergram_for_public do
+      false
+    end
+
+    # allows admins to created specific CSS snippets affecting only some specific parts
+    # Valid values differ a little from the previous convention:
+    #   :disabled => false and non available, hidden from admins
+    #   Hash => hash of different css text, each key will be used for the contraints
+    # Admins create this hash dynamically but some pre-defined css boxes can be created here as:
+    #   {
+    #      some_identifier: ".wrapper { background: red; }"
+    #   }
+    config_accessor :scoped_styles do
+      {}
+    end
+
+    # custom fields for proposals using JSON specification:
+    # https://github.com/jsonform/jsonform/wiki
+    # Valid values uses the same structure as :scoped_styles
+    #   :disabled => false and non available, hidden from admins
+    #   Hash => hash of different JSON texts, each key will be used for the contraints
+    # Admins can create this hash dynamically but some pre-defined css boxes can be created here as:
+    #   {
+    #      some_identifier: "{ ... some definition... }"
+    #   }
+    config_accessor :proposal_custom_fields do
+      {}
+    end
+
+    # allows to keep modifications for the main menu
+    # can return :disabled to completly remove this feature
+    # otherwise it should be an array (some overrides can be specified by default):
+    # [
+    #    {
+    #       url: "/a-new-link",
+    #       label: { "en" => "The label to show in the menu" },
+    #       position: 10
+    #    }
+    # ]
+    config_accessor :menu do
+      []
+    end
+
+    # Allows admins to assignate "fake" admins scoped to some admin zones using the
+    # same scope editor as :scoped_styles, valid values uses the same convention:
+    #   :disabled => false and non available, hidden from admins
+    #   Hash => hash of different admin ids, each key will be used for the contraints
+    # Admins create this hash dynamically but some pre-defined admin boxes can be created here as:
+    #   {
+    #      some_identifier: [1234, 5678, 90123]
+    #   }
+    #
+    # To test this feature in development, ensure that config/environmnets/development.rb is configured as:
+    #   config.action_dispatch.show_exceptions = true
+    #   config.action_dispatch.show_detailed_exceptions = false
+    #   config.consider_all_requests_local = false
+    config_accessor :scoped_admins do
+      {}
+    end
+
+    # Allow to configure custom redirections
+    # can return :disabled to completly remove this feature
+    # You can initialize some default redirection if desired as follows:
+    #  {
+    #    "/decidim-docs" => { destination: "http://docs.decidim.org", active: true }
+    #  }
+    #
+    # To test this feature in development, ensure that config/environmnets/development.rb is configured as:
+    #   config.action_dispatch.show_exceptions = true
+    #   config.action_dispatch.show_detailed_exceptions = false
+    #   config.consider_all_requests_local = false
+
+    config_accessor :custom_redirects do
+      {}
+    end
+
+    # these settings do not follow the :disabled convention but
+    # depends on the previous intergram configurations
+    config_accessor :intergram_url do
+      "https://www.intergram.xyz/js/widget.js"
+    end
+
+    # no need to override these settings, there admin-configurable
+    config_accessor :intergram_for_admins_settings do
+      {
+        chat_id: nil,
+        color: nil,
+        use_floating_button: false,
+        title_closed: nil,
+        title_open: nil,
+        intro_message: nil,
+        auto_response: nil,
+        auto_no_response: nil
+      }
+    end
+
+    config_accessor :intergram_for_public_settings do
+      {
+        chat_id: nil,
+        require_login: true,
+        color: nil,
+        use_floating_button: false,
+        title_closed: nil,
+        title_open: nil,
+        intro_message: nil,
+        auto_response: nil,
+        auto_no_response: nil
+      }
+    end
+
+    # additional correspondences between participatory spaces manifests and routes
+    # ie: /admin/assemblies and /admin/assemblies_types are both treated as a "assembly" participatory space in terms of permission scoping
+    # This can be tuned in a initialized if some other hacks over routes are applied
+    # if a registered participatory space is not listed here then the name manifest will be used as a default route /manifest_name /admin/manifes_name
+    config_accessor :participatory_spaces_routes_context do
+      {
+        # route in admin is diferent than in the frontend: /processes, /admin/participatory_processes
+        participatory_processes: [:participatory_processes, :processes],
+        # both /admin/assemblies and /admin/assemblies_types are considered assemblies
+        assemblies: [:assemblies, :assemblies_types],
+        # route in admin is diferent than in the frontend: /process_groups, /admin/participatory_process_groups
+        process_groups: [:processes_groups, :participatory_process_groups]
+      }
+    end
+
+    #
+    # HELPERS
+    #
+    # pass a single config var or an array of them
+    # any non disabled match will return as true
+    def self.enabled?(config_vars)
+      config_vars = [config_vars] unless config_vars.respond_to?(:detect)
+
+      config_vars.detect do |item|
+        next unless config.has_key?(item.to_sym)
+
+        config.send(item) != :disabled
+      end
+    end
+
+    def self.registered_components
+      @registered_components ||= []
+    end
+
+    # Wrapp component registering to register component later, after initializer
+    # so we can honor disabled_components config
+    def self.register_component(manifest, &block)
+      registered_components << [manifest, block]
+    end
+  end
+end

data/lib/decidim/decidim_awesome/awesome_helpers.rb

@@ -10,8 +10,12 @@ module Decidim
       def awesome_config_instance
         return @awesome_config_instance if @awesome_config_instance
 
-        @awesome_config_instance = Config.new request.env["decidim.current_organization"]
-        @awesome_config_instance.context_from_request request
+        # if already created in the middleware, reuse it as it might have additional constraints
+        @awesome_config_instance = request.env["decidim_awesome.current_config"]
+        unless @awesome_config_instance.is_a? Config
+          @awesome_config_instance = Config.new request.env["decidim.current_organization"]
+          @awesome_config_instance.context_from_request request
+        end
         @awesome_config_instance
       end
 
@@ -20,7 +24,7 @@ module Decidim
       end
 
       def javascript_config_vars
-        awesome_config.except(:scoped_styles).to_json.html_safe
+        awesome_config.except(:scoped_styles, :proposal_custom_fields, :scoped_admins).to_json.html_safe
       end
 
       def show_public_intergram?
@@ -42,23 +46,19 @@ module Decidim
         ::Decidim::DecidimAwesome::VERSION
       end
 
-      def tenant_stylesheets
-        return @tenant_stylesheets if @tenant_stylesheets
-
-        prefix = Rails.root.join("app", "assets", "themes", current_organization.host)
-        return @tenant_stylesheets = current_organization.host.to_s if File.exist?("#{prefix}.css") || File.exist?("#{prefix}.scss") || File.exist?("#{prefix}.scss.erb")
-      end
-
       # Collects all CSS that is applied in the current URL context
       def awesome_custom_styles
-        return unless awesome_config[:scoped_styles]
-        return @awesome_custom_styles if @awesome_custom_styles
+        @awesome_custom_styles ||= awesome_config_instance.collect_sub_configs_values("scoped_style")
+      end
 
-        styles = awesome_config[:scoped_styles]&.filter do |key, _value|
-          config = AwesomeConfig.find_by(var: "scoped_style_#{key}", organization: current_organization)
-          @awesome_config_instance.valid_in_context?(config&.constraints)
-        end
-        @awesome_custom_styles = styles.values.join("\n")
+      # Collects all proposal custom fields that is applied in the current URL context
+      def awesome_scoped_admins
+        @awesome_scoped_admins ||= awesome_config_instance.collect_sub_configs_values("scoped_admin")
+      end
+
+      # Collects all proposal custom fields that is applied in the current URL context
+      def awesome_proposal_custom_fields
+        @awesome_proposal_custom_fields ||= awesome_config_instance.collect_sub_configs_values("proposal_custom_field")
       end
 
       def version_prefix

data/lib/decidim/decidim_awesome/checksums.yml

@@ -1,23 +1,30 @@
 decidim-admin:
   /app/views/layouts/decidim/admin/_header.html.erb:
-    decidim-0.22: 6af51ec6b8a760b0ee6e00a7834f5f9a
-    decidim-0.23: 45f0e15f1b02a1c1a73b1a2184fd55af
+    decidim-0.25: 1aff077428830b12306d6c42e6b37216
 decidim-core:
   /app/views/layouts/decidim/_head.html.erb:
-    decidim-0.22: bf16a58cd9e6d3f73e6875ff3d0b1e48
-    decidim-0.23: e7f5eea07e884665474948ea750fc720
-  /app/assets/javascripts/decidim/editor.js.es6:
-    decidim-0.22: 797d0ec1c9e79453cf6718f82d2fdd27
-    decidim-0.23: cb059b8ff0ffc62c67eb99d8d7a6637b
-    decidim-0.23.1: 4787f73f0f33661e3897404f10019d26
+    decidim-0.25: eb490aa482477ff70f541d20cddec773
+    decidim-0.26: 0927fc81123addec70853c2e7986c538
+  /app/packs/src/decidim/editor.js:
+    decidim-0.25: 742698903a30034094c01aecaca6de84
+    decidim-0.26: 651830d87aeeeff39316a787fc70d461
   /app/presenters/decidim/menu_presenter.rb:
-    decidim-0.22: 042743c44a2aff284b493c7bebbccbb3
-    decidim-0.23: 042743c44a2aff284b493c7bebbccbb3
+    decidim-0.25: f3b05daf279f909f8b3b628658dd5810
   /app/presenters/decidim/menu_item_presenter.rb:
-    decidim-0.22: 70db39954b5840924530bf94d2a0a73a
-    decidim-0.23: 70db39954b5840924530bf94d2a0a73a
+    decidim-0.25: 860ffb160ec5f8552cc2855a6a47851b
+  /app/helpers/decidim/amendments_helper.rb:
+    decidim-0.25: 63532a04fcf07cf92b789833a9421416
+    decidim-0.26: 636943ccb2e994fe0124dc87e72e49e9
 decidim-proposals:
-  /app/presenters/decidim/proposals/proposal_presenter.rb:
-    decidim-0.22: 7d60c8310d7fa4e38d9a27080c22b12c
-    decidim-0.23: 437c0c25151f605401a4f14d090ba5ea
-    decidim-0.23.1: 892021b2ce9ac10c2e1b738e6948cde0
+  /app/forms/decidim/proposals/proposal_wizard_create_step_form.rb:
+    decidim-0.24: db69edd0ba8ffa3965a5c44a6bfaba8d
+  /app/helpers/decidim/proposals/application_helper.rb:
+    decidim-0.24: c5f99f5fa7de9a6e45776983330e9d73
+    decidim-0.26: 216c974bc425393c18b01bfc4eed4f0b
+  /app/views/decidim/proposals/collaborative_drafts/show.html.erb:
+    decidim-0.24: 2a7e0a4c65361f238fd1b917f39c8642
+  /app/views/decidim/proposals/collaborative_drafts/_edit_form_fields.html.erb:
+    decidim-0.24: 6f717555a20e2ab3f555003c337d3003
+    decidim-0.26: 97fa28043a26fc2940d30d38d9a7369b
+  /app/views/decidim/proposals/admin/proposals/_form.html.erb:
+    decidim-0.25: 90a04984d4269398b7cd21aa33763a1f

data/lib/decidim/decidim_awesome/config.rb

@@ -9,13 +9,14 @@ module Decidim
         @vars = AwesomeConfig.for_organization(organization).includes(:constraints)
         @context = {
           participatory_space_manifest: nil,
-          participatory_slug: nil,
+          participatory_space_slug: nil,
           component_id: nil,
           component_manifest: nil
         }
+        @sub_configs = {}
       end
 
-      attr_reader :context
+      attr_reader :context, :organization, :vars
       attr_writer :defaults
 
       def defaults
@@ -84,12 +85,59 @@ module Decidim
         # if no constraints defined, applies to everything
         return true if constraints.blank?
 
+        # if containts the "none" constraints, deactivate everything else
+        return false if constraints.detect { |c| c.settings["participatory_space_manifest"] == "none" }
+
         # check if current context matches some constraint
         constraints.detect do |constraint|
-          # if some setting is different, rejects
-          invalid = constraint.settings.detect { |key, val| context[key.to_sym].to_s != val.to_s }
-          invalid.blank?
+          settings = constraint.settings.symbolize_keys
+          match_method = settings.delete(:match)
+          if match_method == "exclusive"
+            # all keys must match
+            settings == context
+          else
+            # constraints keys can match the context partially (ie: if slug is not specified, any space matches in the same manifest)
+            # if some setting is different, rejects
+            invalid = constraint.settings.detect { |key, val| context[key.to_sym].to_s != val.to_s }
+            invalid.blank?
+          end
+        end
+      end
+
+      # adds some custom constraints for the instance that can be generated dynamically
+      def inject_sub_config_constraints(singular_key, subkey, constraints)
+        sub_configs_for(singular_key)[subkey.to_sym]&.add_constraints constraints
+      end
+
+      # Merges all subconfigs values for custom_styles or any other scoped confs
+      # by default filtered according to the current scope, a block can be passed for custom filtering
+      # ie, collect everything:
+      #    collect_sub_configs_values("scoped_style") { true }
+      def collect_sub_configs_values(singular_key)
+        plural_key = singular_key.pluralize.to_sym
+        return [] unless config[plural_key].respond_to?(:filter)
+
+        fields = config[plural_key]&.filter do |key, _value|
+          subconfig = sub_configs_for(singular_key)[key]
+          # allow custom filtering if block given
+          if block_given?
+            yield subconfig
+          else
+            valid_in_context?(subconfig&.all_constraints)
+          end
         end
+        fields.values
+      end
+
+      def sub_configs_for(singular_key)
+        return @sub_configs[singular_key] if @sub_configs[singular_key]
+
+        plural_key = singular_key.pluralize.to_sym
+        return {} unless config[plural_key]
+
+        @sub_configs[singular_key] = config[plural_key].map do |key, _value|
+          [key, AwesomeConfig.find_by(var: "#{singular_key}_#{key}", organization: @organization)]
+        end.to_h
       end
 
       private
@@ -107,7 +155,7 @@ module Decidim
 
       def calculate_config
         # filter vars compliant with current context
-        valid = @vars.filter { |item| enabled_for_organization?(item.var) && valid_in_context?(item.constraints) }
+        valid = @vars.filter { |item| enabled_for_organization?(item.var) && valid_in_context?(item.all_constraints) }
                      .map { |v| [v.var.to_sym, v.value] }.to_h
 
         map_defaults do |key|
@@ -119,9 +167,7 @@ module Decidim
       def enabled_for_organization?(key)
         case key.to_sym
         when :allow_images_in_proposals
-          if @organization.respond_to? :rich_text_editor_in_public_views
-            return false if @organization.rich_text_editor_in_public_views
-          end
+          return false if @organization.rich_text_editor_in_public_views
         end
         true
       end

data/lib/decidim/decidim_awesome/content_parsers/editor_images_parser.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Decidim
+  module DecidimAwesome
+    module ContentParsers
+      # A parser that searches for editor images from CarrierWave in html
+      # contents and replaces them with migrated images to ActiveStorage
+      #
+      # @see BaseParser Examples of how to use a content parser
+      class EditorImagesParser < Decidim::ContentParsers::BaseParser
+        # @return [String] the content with the CarrierWave images replaced.
+        def rewrite
+          return content if editor_images.blank?
+
+          replace_editor_images
+          parsed_content.to_html
+        end
+
+        def editor_images
+          @editor_images ||= parsed_content.search(:img).index_with do |image|
+            context[:routes_mappings].find { |mapping| image.attr(:src).end_with?(mapping[:origin_path]) }
+          end.compact
+        end
+
+        private
+
+        def parsed_content
+          @parsed_content ||= Nokogiri::HTML(content)
+        end
+
+        def replace_editor_images
+          editor_images.each do |image, mapping|
+            image.set_attribute(:src, mapping[:instance].attached_uploader(:file).path)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/decidim/decidim_awesome/context_analyzers/request_analyzer.rb

@@ -5,17 +5,32 @@ module Decidim
     module ContextAnalyzers
       # Translates some Decidim URL path to detected participatory spaces and components
       class RequestAnalyzer
+        class << self
+          def context_for(request)
+            analyzer = new request
+            analyzer.extract_context!
+            analyzer.context
+          end
+
+          # In the frontend there's no a 100% correspondence between url and manifest name
+          def participatory_spaces_routes
+            spaces = Decidim.participatory_space_manifests \
+                            .filter { |space| !DecidimAwesome.config.participatory_spaces_routes_context.has_key?(space.name) } \
+                            .map { |space| [space.name.to_s, space.name.to_s] }.to_h
+            DecidimAwesome.config.participatory_spaces_routes_context.each do |manifest, routes|
+              routes.each do |route|
+                spaces[route.to_s] = manifest.to_s
+              end
+            end
+            spaces
+          end
+        end
+
         def initialize(request)
           @request = request
           @context = {}
         end
 
-        def self.context_for(request)
-          analyzer = new request
-          analyzer.extract_context!
-          analyzer.context
-        end
-
         attr_reader :request, :context
 
         def extract_context!
@@ -25,20 +40,8 @@ module Decidim
 
         private
 
-        # In the frontend there's no a 100% correspondence between url and manifest name
-        def participatory_spaces
-          spaces = Decidim.participatory_space_manifests.map do |space|
-            [space.name.to_s, space.name.to_s]
-          end.to_h
-          spaces.merge(
-            "processes" => "participatory_processes",
-            "participatory_process_groups" => "participatory_processes",
-            "assemblies_types" => "assemblies"
-          )
-        end
-
         def process_admin_segments(segments)
-          spaces = participatory_spaces
+          spaces = RequestAnalyzer.participatory_spaces_routes
           return unless spaces[segments[0]]
 
           @context[:participatory_space_manifest] = spaces[segments[0]]
@@ -53,7 +56,7 @@ module Decidim
         end
 
         def process_front_segments(segments)
-          spaces = participatory_spaces
+          spaces = RequestAnalyzer.participatory_spaces_routes
           return unless spaces[segments[0]]
 
           @context[:participatory_space_manifest] = spaces[segments[0]]
@@ -70,8 +73,11 @@ module Decidim
         def system_manifest?(path)
           patterns = [
             %r{^/admin/newsletters},
+            %r{^/admin/moderations},
+            %r{^/admin/users},
             %r{^/admin/organization},
-            %r{^/admin/static_pages}
+            %r{^/admin/static_pages},
+            %r{^/admin/logs}
           ]
           path.match(Regexp.union(patterns))
         end