decidim-core 0.24.3 → 0.25.0.rc1

data/lib/decidim/rails.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# This is an override for:
+# https://github.com/rails/rails/blob/main/railties/lib/rails/all.rb
+
+# This file is needed because of two reasons:
+# 1. To remove the sprockets dependency from Rails
+# 2. To remove the railtie includes that are not necessary for running Decidim
+
+require "rails"
+
+%w(
+  active_record/railtie
+  active_storage/engine
+  action_controller/railtie
+  action_view/railtie
+  action_mailer/railtie
+  active_job/railtie
+).each do |railtie|
+  require railtie
+end

data/lib/decidim/resource_manifest.rb

@@ -53,6 +53,10 @@ module Decidim
     # as well that allows checking for those permissions.
     attribute :actions, Array[String]
 
+    # The name of the class that handles the permissions for this resource. It will
+    # probably have the form of `Decidim::<MyComponent>::Permissions`.
+    attribute :permissions_class_name, String, default: "Decidim::DefaultPermissions"
+
     validates :model_class_name, :route_name, :name, presence: true
 
     # Finds an ActiveRecord::Relation of the resource `model_class`, scoped to the
@@ -80,6 +84,15 @@ module Decidim
       model_class_name.constantize
     end
 
+    # Public: Finds the permission class from its name, using the
+    # `permissions_class_name` attribute. If the class does not exist,
+    # it raises an exception. If the class name is not set, it returns nil.
+    #
+    # Returns a Class.
+    def permissions_class
+      permissions_class_name&.constantize
+    end
+
     # The name of the named Rails route to create the url to the resource.
     #
     # Returns a String.

data/lib/decidim/resourceable.rb

@@ -93,6 +93,8 @@ module Decidim
       # - the visibility of its participatory space.
       # - the visibility of the resource itself.
       def visible?
+        return resource_visible? if participatory_space?
+
         component.participatory_space.try(:visible?) && component.published? && resource_visible?
       end
 
@@ -109,6 +111,12 @@ module Decidim
         true
       end
 
+      def participatory_space?
+        return if component.present?
+
+        Decidim.participatory_space_manifests.find { |manifest| manifest.model_class_name == self.class.name }
+      end
+
       # Public: Whether the permissions for this object actions can be set at resource level.
       def allow_resource_permissions?
         false

data/lib/decidim/searchable.rb

@@ -27,7 +27,7 @@ module Decidim
     end
 
     def self.searchable_resources_of_type_participant
-      searchable_resources.select { |r| r == "Decidim::User" }
+      searchable_resources.slice("Decidim::User", "Decidim::UserGroup")
     end
 
     def self.searchable_resources_of_type_participatory_space

data/lib/decidim/traceable.rb

@@ -1,9 +1,8 @@
 # frozen_string_literal: true
 
+require "paper_trail/frameworks/active_record"
 require "active_support/concern"
 
-require_dependency "paper_trail/frameworks/active_record"
-
 module Decidim
   # A concern that adds traceabilty capability to the given model. Including this
   # allows you the keep track of changes in the model attributes and changes authorship.
@@ -17,7 +16,7 @@ module Decidim
     extend ActiveSupport::Concern
 
     included do
-      has_paper_trail
+      has_paper_trail on: [:create, :destroy, :update]
 
       delegate :count, to: :versions, prefix: true
 

data/lib/decidim/translatable_resource.rb

@@ -54,7 +54,7 @@ module Decidim
         return if organization && !organization.enable_machine_translations
         return if try(:enable_machine_translations) == false
 
-        Decidim::MachineTranslationResourceJob.perform_later(
+        Decidim::MachineTranslationResourceJob.set(wait: Decidim.config.machine_translation_delay).perform_later(
           self,
           translatable_previous_changes,
           I18n.locale.to_s

data/lib/decidim/view_model.rb

@@ -16,6 +16,7 @@ module Decidim
     include Cell::Caching::Notifications
     include Decidim::MarkupHelper
     include Decidim::FilterParamsHelper
+    include ::Webpacker::Helper
 
     delegate :current_organization, to: :controller
 

data/lib/decidim/webpacker.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Webpacker
+    autoload :Configuration, "decidim/webpacker/configuration"
+    autoload :Runner, "decidim/webpacker/runner"
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    def self.register_path(path, prepend: false)
+      if prepend
+        configuration.additional_paths.unshift(path)
+      else
+        configuration.additional_paths.push(path)
+      end
+    end
+
+    def self.register_entrypoints(entrypoints)
+      configuration.entrypoints.merge!(entrypoints.stringify_keys)
+    end
+
+    def self.register_stylesheet_import(import, type: :imports, group: :app)
+      type = type.to_s
+      key = group.to_s
+      configuration.stylesheet_imports[type] ||= {}
+      configuration.stylesheet_imports[type][key] ||= []
+      configuration.stylesheet_imports[type][key].push(import)
+    end
+  end
+end

data/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/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/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/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/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/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/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/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/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