decidim 0.24.3 → 0.25.0.rc4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7503d95371a406035b6bb81ded1ca7b8debf8d5257845430467bee73401cee20
-  data.tar.gz: bd9c485d073ad5a99c5f5b60e61d552823830a17fc92031ad89a15b9d5d2cd71
+  metadata.gz: 669bd9a525ab33dd37ea3b2aa68e644ff34751595edad6c70714f7d73314f3da
+  data.tar.gz: 0dda19b573c625137eac6f17764b75abc0067e87ab3eed8bb824c839829a4620
 SHA512:
-  metadata.gz: 4db1328d71a3edf2917f36cc269af163cf6fc92d8f8d33dc321c930fa467fcee3a03bdc9aacbfcd70ff7881e27090c81ab409984378afd491f06441f748cee5a
-  data.tar.gz: d627d0c55e62a530dfcce0b073a0f879dd38304911bf9784853ff01a4c470df58c8b5e533742dff8d4fc44187fef687540b735147311efba03f55879c3feba27
+  metadata.gz: 386340222687878a528eac94e36d28e0bcdb5c2f6ed9ea0bd0af2b4b490d9eafa6302580170f56b2d8a3e44d7c7a5c843e0e6f7b086d662f2a06be897fc649a3
+  data.tar.gz: e7019090a58beb62bf011681d017ed3c9844b9fbb56a53b5988538e55a096553de478f493e3a0834e8fbccb3d5c69ece06fb874be8af313844898bbef0b2b047

data/Rakefile

@@ -56,9 +56,10 @@ task :uninstall_all do
   Decidim::GemManager.uninstall_all
 end
 
-desc "Pushes a new build for each gem."
-task release_all: [:update_versions, :check_locale_completeness, :webpack] do
+desc "Pushes a new build for each gem and package."
+task release_all: [:update_versions, :check_locale_completeness] do
   Decidim::GemManager.run_all("rake release")
+  Decidim::GemManager.run_packages("npm publish --access public")
 end
 
 desc "Makes sure all official locales are complete and clean."
@@ -74,17 +75,36 @@ task test_app: "decidim:generate_external_test_app"
 desc "Generates a development app."
 task development_app: "decidim:generate_external_development_app"
 
-desc "Build webpack bundle files"
-task :webpack do
-  sh "npm install && npm run build:prod"
-end
-
 desc "Bundle all Gemfiles"
 task :bundle do
   [".", "decidim-generators", "decidim_app-design"].each do |dir|
     Bundler.with_original_env do
       puts "Updating #{dir}...\n"
-      Dir.chdir(dir) { sh "bundle install" }
+      system!("bundle install", dir)
     end
   end
 end
+
+desc "Synchronize npm packages files on the whole repo"
+task :webpack do
+  FileUtils.rm_rf(decidim_app_design_path.join("package-lock.json"))
+  FileUtils.rm_rf(decidim_app_design_path.join("packages"))
+  FileUtils.cp_r(root_folder.join("package.json"), decidim_app_design_path)
+  FileUtils.cp_r(root_folder.join("package-lock.json"), decidim_app_design_path)
+  FileUtils.cp_r(root_folder.join("packages"), decidim_app_design_path)
+
+  system!("npm install", root_folder)
+  system!("npm install", decidim_app_design_path)
+end
+
+def root_folder
+  @root_folder ||= Pathname.new(__dir__)
+end
+
+def decidim_app_design_path
+  @decidim_app_design_path ||= Pathname.new(root_folder.join("decidim_app-design"))
+end
+
+def system!(command, path)
+  system("cd #{path} && #{command}") || abort("\n== Command #{command} failed ==")
+end

data/babel.config.json

@@ -0,0 +1,30 @@
+{
+  "presets": [
+    [
+      "@babel/preset-env", {
+        "forceAllTransforms": true,
+        "useBuiltIns": "entry",
+        "corejs": 3,
+        "modules": false
+      }
+    ],
+    ["@babel/preset-react"]
+  ],
+  "plugins": [
+    "@babel/plugin-transform-classes",
+    [
+      "@babel/plugin-transform-runtime",
+      {
+        "helpers": false,
+        "regenerator": true,
+        "corejs": false
+      }
+    ],
+    [
+      "@babel/plugin-transform-regenerator",
+      {
+        "async": false
+      }
+    ]
+  ]
+}

data/decidim-core/lib/decidim/webpacker/configuration.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Webpacker
+    class Configuration
+      attr_reader :additional_paths, :entrypoints, :stylesheet_imports
+
+      def initialize
+        @additional_paths = []
+        @entrypoints = {}
+        @stylesheet_imports = {}
+      end
+
+      def configuration_file
+        # Before webpacker is installed, the original configuration file may not
+        # be available yet.
+        return unless File.exist?(original_configuration_file_path)
+        return configuration_file_path if configurations_loaded?
+
+        load_asset_configurations
+
+        # Read the original configuration and append the paths
+        config = YAML.load_file(original_configuration_file_path)
+        default = config["default"] || {}
+        all_additional_paths = default["additional_paths"] || []
+        all_additional_paths += additional_paths
+        all_stylesheet_imports = default["stylesheet_imports"] || {}
+        all_stylesheet_imports.merge!(stylesheet_imports)
+        all_entrypoints = default["entrypoints"] || {}
+        all_entrypoints.merge!(entrypoints)
+        config.each do |environment, env_config|
+          config[environment] = env_config.merge(
+            "additional_paths" => all_additional_paths,
+            "entrypoints" => all_entrypoints,
+            "stylesheet_imports" => all_stylesheet_imports
+          )
+        end
+
+        # Write the runtime configuration and override the configuration
+        File.write(configuration_file_path, config.to_yaml)
+
+        self.configurations_loaded = true
+
+        configuration_file_path
+      end
+
+      private
+
+      attr_writer :configurations_loaded
+
+      def configurations_loaded?
+        @configurations_loaded == true
+      end
+
+      def app_path
+        @app_path ||=
+          if defined?(Rails)
+            Rails.application.root
+          else
+            # This is used when Rails is not available from the webpacker binstubs
+            File.expand_path(".", Dir.pwd)
+          end
+      end
+
+      def configuration_file_path
+        @configuration_file_path ||= File.join(app_path, "tmp/webpacker_runtime.yml")
+      end
+
+      def original_configuration_file_path
+        @original_configuration_file_path = File.join(app_path, "config/webpacker.yml")
+      end
+
+      def load_asset_configurations
+        # Decidim gem assets
+        decidim_gems = Bundler.load.specs.select { |spec| spec.name =~ /^decidim-/ }
+        decidim_gems.each do |gem|
+          asset_config_path = File.join(gem.full_gem_path, "config/assets.rb")
+          next unless File.exist?(asset_config_path)
+
+          load asset_config_path
+        end
+
+        # Application assets
+        asset_config_path = File.join(app_path, "config/assets.rb")
+        load asset_config_path if File.exist?(asset_config_path)
+      end
+    end
+  end
+end

data/decidim-core/lib/decidim/webpacker/postcss.config.js

@@ -0,0 +1,16 @@
+/* eslint-disable */
+
+module.exports = {
+  syntax: 'postcss-scss',
+  plugins: [
+    require('autoprefixer'),
+    require('postcss-import'),
+    require('postcss-flexbugs-fixes'),
+    require('postcss-preset-env')({
+      autoprefixer: {
+        flexbox: 'no-2009'
+      },
+      stage: 3
+    })
+  ]
+}

data/decidim-core/lib/decidim/webpacker/runner.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Webpacker
+    module Runner
+      def self.included(base)
+        base.alias_method :original_initialize, :initialize
+        base.send :private, :original_initialize
+
+        base.define_method :initialize do |argv|
+          original_initialize(argv)
+          decidim_initialize(argv)
+        end
+      end
+
+      private
+
+      def decidim_initialize(_argv)
+        # Write the runtime configuration and override the configuration
+        @webpacker_config = Decidim::Webpacker.configuration.configuration_file
+      end
+    end
+  end
+end

data/decidim-core/lib/decidim/webpacker/webpack/base.js

@@ -0,0 +1,6 @@
+/* eslint-disable */
+
+const { webpackConfig, merge } = require("@decidim/webpacker")
+const customConfig = require("./custom")
+
+module.exports = merge(webpackConfig, customConfig)

data/decidim-core/lib/decidim/webpacker/webpack/custom.js

@@ -0,0 +1,97 @@
+/* eslint-disable */
+
+const path = require("path");
+const { config } = require("@rails/webpacker");
+
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: require.resolve("quill"),
+        loader: "expose-loader",
+        options: {
+          exposes: ["Quill"]
+        }
+      },
+      {
+        test: require.resolve("jquery"),
+        loader: "expose-loader",
+        options: {
+          exposes: ["$", "jQuery"]
+        }
+      },
+      {
+        test: /\.(js|jsx)$/,
+        exclude: /node_modules\/(?!tributejs)/,
+        loader: "babel-loader"
+      },
+      {
+        test: /\.(graphql|gql)$/,
+        loader: "graphql-tag/loader"
+      },
+      {
+        test: require.resolve("react"),
+        loader: "expose-loader",
+        options: {
+          exposes: ["React"]
+        }
+      },
+      {
+        test: require.resolve("@rails/ujs"),
+        loader: "expose-loader",
+        options: {
+          exposes: ["Rails"]
+        }
+      },
+      {
+        test: [
+          /\.md$/,
+          /\.odt$/,
+        ],
+        exclude: [/\.(js|mjs|jsx|ts|tsx)$/],
+        type: 'asset/resource',
+        generator: {
+          filename: 'media/documents/[hash][ext][query]'
+        }
+      },
+      // Overwrite webpacker files rule to amend the filename output
+      // and include the name of the file, otherwise some SVGs
+      // are not generated because the hash is the same between them
+      {
+        test: [
+          /\.bmp$/,
+          /\.gif$/,
+          /\.jpe?g$/,
+          /\.png$/,
+          /\.tiff$/,
+          /\.ico$/,
+          /\.avif$/,
+          /\.webp$/,
+          /\.eot$/,
+          /\.otf$/,
+          /\.ttf$/,
+          /\.woff$/,
+          /\.woff2$/,
+          /\.svg$/
+        ],
+        exclude: [/\.(js|mjs|jsx|ts|tsx)$/],
+        type: 'asset/resource',
+        generator: {
+          filename: 'media/images/[name]-[hash][ext][query]'
+        }
+      }
+    ]
+  },
+  resolve: {
+    extensions: [".js", ".jsx", ".gql", ".graphql"],
+    fallback: {
+      crypto: false
+    }
+  },
+  // https://github.com/rails/webpacker/issues/2932
+  // As Decidim uses multiple packs, we need to enforce a single runtime, to prevent duplication
+  optimization: {
+    runtimeChunk: false
+  },
+  entry: config.entrypoints
+}

data/decidim-core/lib/decidim/webpacker/webpack/development.js

@@ -0,0 +1,7 @@
+/* eslint-disable */
+
+process.env.NODE_ENV = process.env.NODE_ENV || "development"
+
+const webpackConfig = require("./base")
+
+module.exports = webpackConfig

data/decidim-core/lib/decidim/webpacker/webpack/production.js

@@ -0,0 +1,7 @@
+/* eslint-disable */
+
+process.env.NODE_ENV = process.env.NODE_ENV || "production"
+
+const webpackConfig = require("./base")
+
+module.exports = webpackConfig

data/decidim-core/lib/decidim/webpacker/webpack/test.js

@@ -0,0 +1,7 @@
+/* eslint-disable */
+
+process.env.NODE_ENV = process.env.NODE_ENV || "development"
+
+const webpackConfig = require("./base")
+
+module.exports = webpackConfig

data/decidim-core/lib/decidim/webpacker/webpacker.yml

@@ -0,0 +1,65 @@
+# File written by Decidim generator
+# Note: You must restart bin/webpack-dev-server for changes to take effect
+
+default: &default
+  source_path: app/packs
+  source_entry_path: entrypoints
+  public_output_path: decidim-packs
+  public_root_path: public
+  webpack_compile_output: true
+  cache_path: tmp/webpacker-cache
+  extract_css: true
+
+  additional_paths:
+    - node_modules
+    - app/packs
+
+  # Reload manifest.json on all requests so we reload latest compiled packs
+  cache_manifest: false
+
+development:
+  <<: *default
+  compile: true
+  # Compile test packs to decidim decidim-packs folder
+
+  # Reference: https://webpack.js.org/configuration/dev-server/
+  dev_server:
+    https: false
+    host: localhost
+    # Notice that we use a different port (to prevent blocking the default one) as
+    # there will be at least two webpack servers running
+    port: 3035
+    # Hot Module Replacement updates modules while the application is running without a full reload
+    hmr: false
+    client:
+      # Should we show a full-screen overlay in the browser when there are compiler errors or warnings?
+      overlay: true
+      # May also be a string
+      # webSocketURL:
+      #  hostname: "0.0.0.0"
+      #  pathname: "/ws"
+      #  port: 8080
+    # Should we use gzip compression?
+    compress: true
+    # Note that apps that do not check the host are vulnerable to DNS rebinding attacks
+    allowed_hosts: "all"
+    pretty: true
+    headers:
+      'Access-Control-Allow-Origin': '*'
+    static:
+      watch:
+        ignored: '**/node_modules/**'
+
+test:
+  <<: *default
+  compile: true
+  public_output_path: packs-test
+
+production:
+  <<: *default
+
+  # Production depends on precompilation of packs prior to booting for performance.
+  compile: false
+
+  # Cache manifest.json for performance
+  cache_manifest: true

data/docs/README.adoc

@@ -43,7 +43,7 @@ In detail each one of these steps are:
 # 1. Clone the repository
 git clone https://github.com/decidim/documentation
 # 2. Install dependencies
-npm install
+npm
 # 3. Change the antora-playbook.yml url key in source
 # 4. Build the antora playbook
 npm run build

data/docs/modules/configure/pages/initializer.adoc

@@ -79,6 +79,22 @@ Whether SSL should be enabled or not. Recommended for extra security.
   config.force_ssl = true
 ....
 
+== CORS enabled
+
+The SVG do not support CORS. When using custom asset host different than root url, set this value to `true`, in order to activate the available workaround.
+
+Please refer to:
+
+- https://github.com/w3c/svgwg/issues/707
+- https://stackoverflow.com/questions/65811142/how-to-allow-external-images-referenced-within-embedded-svg
+- https://groups.google.com/a/chromium.org/g/blink-dev/c/qemQwRpe2so/m/THi81oodSDgJ.
+- https://www.w3.org/Graphics/SVG/WG/track/actions/3781
+
+[source,ruby]
+....
+  config.cors_enabled = true
+....
+
 == Geocoder configuration
 
 Allows to make geographical mapping in some components, like Proposals or Meetings. It must be configured against a OpenStreetMap provider. See xref:services:geocoder.adoc[Geocoder service documentation].
@@ -374,3 +390,18 @@ step setting :amendments_visibility.
 ....
   config.amendments_visibility_options = %w(all participants)
 ....
+
+== Export fields
+
+To customize export fields, you can subscribe to any serialize event. Every serializer event has unique event name in format: decidim.serialize.module_here.class_here
+
+[source,ruby]
+....
+  initializer "decidim_budgets.serializer_listener" do
+    ActiveSupport::Notifications.subscribe("decidim.serialize.budgets.project_serializer") do |_event_name, data|
+      # Implement your custom code for new or existing fields.
+      data[:serialized_data][:column_title] = "Row data #{data[:resource].class}"
+    end
+  end
+....
+

data/docs/modules/customize/pages/code.adoc

@@ -12,7 +12,10 @@ Most of the time, you should work with the generated application. That applicati
 decidim DecidimBarcelona
 ----
 
-If you want to override/change anything (for instance the homepage), you can just do it with the same name of the file, through Monkey Patching.
+If you want to override/change anything, you can just do it with the same name of the file, through Monkey Patching. Some real world examples of this method:
+
+* https://github.com/gencat/participa/blob/master/app/decorators/decidim/admin/selective_newsletter_form_decorator.rb[Decidim::Admin::SelectiveNewsletterForm]. As it's a decorator you also need to make it available in the https://github.com/gencat/participa/blob/3416992ae095f6ab1e826fee961253514c4ff0ef/config/application.rb#L48[application config]
+* https://github.com/barcelonaregional/decidim-premet25/blob/master/config/initializers/etiquette_validator.rb[EtiquetteValidator.class_eval]
 
 If you want to extend Decidim, the prefered way should be by having a Module. This is a Ruby on Rails Engine which provides ruby code (models, views, controllers, assets, etc). You can use it through multiple ways:
 

data/docs/modules/customize/pages/images.adoc

@@ -2,6 +2,6 @@
 
 You can change most of the images (for instance the logo, main banner on homepage, contents of participatory processes, etc) through the Administration panel.
 
-If you want to override the standard images given by Decidim (for instance the initial image for user's avatars) you can do it by naming it the same way as the original image, in this case it should be `app/assets/images/decidim/default-avatar.svg`
+As Decidim uses Webpacker, there's no way to override existing images including in Decidim.
 
-If you want to add a new image you can do it as any Rails application, leaving it on your image's asset folder and using image_tag helper. You can see more documentation on http://guides.rubyonrails.org/asset_pipeline.html[Rails guide].
+If you want to add a new image you can do it as any Rails application, leaving it on your image's asset folder (`app/packs/images`) and using image_pack_tag helper (or asset_pack_path). You can see more documentation on http://guides.rubyonrails.org/webpacker.html[Rails guide].

data/docs/modules/customize/pages/javascript.adoc

@@ -2,9 +2,11 @@
 
 You can add Javascript code by multiple ways in Decidim:
 
-== Asset pipeline
+== Webpacker
 
-Just add it to `app/assets/javascripts/application.js`. For example to create a new alert just add:
+Decidim uses Webpack (via Webpacker) to compile assets, including javascript.
+
+During the generation of a decidim app, the file `app/packs/src/decidim/decidim_application.js` is created and hooked to Decidim packs, so any javascript written there is compiled within Decidim assets. For example to create a new alert just add:
 
 [source,javascript]
 ----
@@ -13,7 +15,10 @@ $(function(){
 });
 ----
 
-More information in https://guides.rubyonrails.org/asset_pipeline.html[Rails Asset Pipeline documentation].
+More information in https://guides.rubyonrails.org/webpacker.html[Rails Webpacker documentation].
+
+If you want to replace a whole file existin in Decidim you can do it by creating a file in your application with the same name and the same path. I.e: to replace `decidim-core/app/packs/src/decidim/editor.js` you should create in your Rails app a file in
+  `app/packs/src/decidim/editor.js` and it will have more priority over the Decidim file.
 
 == Head extra file
 

data/docs/modules/customize/pages/menu.adoc

@@ -19,6 +19,62 @@ Depending in the kind of space and module, then you can see or not some of the s
 - For conferences, you need to enable the module and it appears when there's some published content by an administrator.
 - For initiatives, you need to enable the module. Every participant can see it, as anyone can create one. That's because is a bottom-up kind of mechanism.
 
+Starting with 0.25.dev, Decidim Menu Api has been modified, in order to improve developer and administrators experience.
+The changes on the menu has deprecated the previous `menu.item` call, in favour of `menu.add_item` that has the following structure:
+[source,ruby]
+....
+menu.add_item :identifier, # String or symbol to uniquely define the menu
+              link_caption,
+              link_path or url
+              options: {
+                position: # Optional,
+                if: # Optional,
+                active: # Optional,
+                icon_name: # Optional ,
+                submenu: # Optional,
+              }
+....
+
+
+Additionally, the new menu api will allow to interact with the menu in several ways:
+[source,ruby]
+....
+Decidim.menu :user_menu do |menu|
+  menu.remove_item :identifier
+  menu.move :identifier, after: :anchor_identifier
+  menu.move :identifier, before: :anchor_identifier
+end
+....
+
+
+== Example usage:
+Starting from a default menu like:
+
+image::original_user_menu.png[Decidim Menu]
+
+After applying the below initializer, the menu rendering will be modified to:
+[source,ruby]
+....
+# config/initializers/decidim.user_menu.rb
+
+Decidim.menu :user_menu do |menu|
+  menu.remove_item :user_interests
+  menu.move :own_user_groups, after: :account
+  menu.move :authorizations, before: :notifications_settings
+end
+....
+
+image::modified_user_menu.png[Decidim Menu]
+
+== The menu Structure
+Decidim uses internally a number of menus that are being used in various admin sections.
+Those menus are being defined inside the engine or admin_engine file of a decidim module.
+The menus are being defined as `Decidim.menu :identifier`. In order to render those menus, there are a number of methods that can be used:
+
+- main_menu in admin section
+- sidebar_menu will render the secondary admin section
+- simple_menu will render any submenus
+
 There's also a https://github.com/OpenSourcePolitics/decidim-module-navbar_links[NavBar links module] made by the community that you can use to add your custom links.
 
 Finally if you want to dive in the code that handles this, a good starting point is the https://rubydoc.info/github/decidim/decidim/develop/Decidim/Menu[Menu API].

data/docs/modules/customize/pages/styles.adoc

@@ -50,11 +50,14 @@ image::header-snippet.png[Header snippet]
 
 Notice that you can resize this textarea.
 
-== Asset pipeline
+== Webpacker
 
-You can go to app/assets/stylesheets/application.css.sass on your generated applications. There you can override any class using CSS with SASS.
+Decidim uses Webpacker to compile assets. There are two ways to customize CSS:
 
-In https://github.com/decidim/decidim/blob/develop/decidim-core/app/assets/stylesheets/decidim/_variables.scss[decidim-core/app/assets/stylesheets/decidim/_variables.scss] you can find the `variables` that can be overriden in your `sass`.
+1. if you want to redefine just CSS vars or Foundation settings, use _decidim-settings.scss
+2. if you want to redefine a specific snippet of CSS (let's say a few classes but not a whole file) you can use decidim_application.scss
+3. and of course you can overwrite whole files by copying them into the application i.e: to replace `decidim-core/app/packs/stylesheets/modules/_cookie-bar.scss` you should create in your Rails app a file in
+  `app/packs/stylesheets/modules/_cookie-bar.scss` and it will have more priority over the Decidim file.
 
 We use http://sass-lang.com/guide[SASS, with SCSS syntax] as CSS preprocessor.
 

data/docs/modules/develop/pages/components.adoc

@@ -135,3 +135,33 @@ This sections explains how to add dummy content to a development application.
 
 * Take advantage of the Faker gem, already in decidim.
 * If you need content for i18n fields, you can use https://github.com/decidim/decidim/blob/develop/decidim-core/lib/decidim/faker/localized.rb[Localizaed], which uses `Faker` internally.
+
+== Assets
+
+In order to attach the new component assets to Webpacker configuration, you need to follow a few steps. We are considering two scenarios:
+
+- while the component is being developed, where changes in Webpacker configuration should be done in the development for simplicity
+- once the component has been completed, change the Webpacker templates for the app generators
+
+In both cases, changes are the same:
+
+1. Add the new component `app/packs` folder to webpacker.yml
+2. Add the new entrypoints of the component to `config/webpack/custom.js`
+
+=== Updating the development application
+
+While the component is being developed, it'll be simpler and faster to update Webpacker configuration inside the development app. The new component `app/packs` folder needs to be added to the list of paths that Webpack will use to look for assets.
+
+Also, components might have one or many entrypoints (for CSSs and javascripts) and images. These entrypoints need to be manually added to `config/webpack/custom.js`. **Any change in both files** requires to restart `webpack-dev-server` process.
+
+Take into account that generating a new development application **overwrites** Webpacker configuration so these changes might be overwriten. That's why it's necessary, once the changes are stable enough, to update the generators files.
+
+=== Updating Webpacker configuration for the generators
+
+Decidim webpacker configuration lives in `decidim-core/lib/decidim/webpacker`. Any change performed in the development app should be replicated in these files.
+
+Also, any npm package added to package.json should be replicated in Decidim package.json file.
+
+=== Updating the design app
+
+These changes should also be translated to the design app `config/webpacker.yml` and `config/webpack/custom.js` files. And if there are changes in the npm packages, these should be moved to.