decidim 0.24.0 → 0.25.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5356db255b8750491617116310dfa2fa330630e2d37435e405f19e5691f7912b
-  data.tar.gz: 21230af85bc79b456185b34189fcc88ec8085e58901b43a9c99dfc604e626a4f
+  metadata.gz: 7f0872745142de196217d5e776c6e730a5959c1595dadf21f64a98e9e594341b
+  data.tar.gz: b5c07a3463d76611a9935723b3285861328a184b7f83e9898ae5e19815d7ff2d
 SHA512:
-  metadata.gz: ef1b7cac3b1f9cb65418a971a41144e0871f1b6cbec889a6f79e2daefd8c393e0c376f80c7b51164445a388ab45d9d0e49243177b824caaad156bfe109ce2a0d
-  data.tar.gz: 51ac37d0122f689506d1c94e26c33498047b8a5d16bf793002f823d1d2b5a46b837957b3f08a7dfa8e30f589e27173ab31054983b1b7ef77d1168ce1f0599e64
+  metadata.gz: ec01ba4ce4f74ccf4238cdc74b02a5c718911c427dcdd9a9c74991933c7fdc4b173ca58ae7015343f938f2334f46b71a827604086c1c7da4dfab8cddf0834a44
+  data.tar.gz: 90dbbc1250e18400ee0d5dbdf62193960aaef4dad895b5a3cfa6c6ff7bdef36bc4c00e20d88934e361ec295ef84021c7d836023fa365c0e8cb3ab80a6615e07b

data/Rakefile

@@ -57,7 +57,7 @@ task :uninstall_all do
 end
 
 desc "Pushes a new build for each gem."
-task release_all: [:update_versions, :check_locale_completeness, :webpack] do
+task release_all: [:update_versions, :check_locale_completeness] do
   Decidim::GemManager.run_all("rake release")
 end
 
@@ -74,11 +74,6 @@ 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|

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,68 @@
+# 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
+    public: localhost:3035
+    # Inject browserside javascript that required by both HMR and Live(full) reload
+    inject_client: true
+    # Hot Module Replacement updates modules while the application is running without a full reload
+    hmr: false
+    # Inline should be set to true if using HMR; it inserts a script to take care of live reloading
+    inline: true
+    # Should we show a full-screen overlay in the browser when there are compiler errors or warnings?
+    overlay: true
+    # Should we use gzip compression?
+    compress: true
+    # Note that apps that do not check the host are vulnerable to DNS rebinding attacks
+    disable_host_check: true
+    # This option lets the browser open with your local IP
+    use_local_ip: false
+    # When enabled, nothing except the initial startup information will be written to the console.
+    # This also means that errors or warnings from webpack are not visible.
+    quiet: false
+    pretty: false
+    headers:
+      'Access-Control-Allow-Origin': '*'
+    watch_options:
+      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
+....
+