decidim-dev 0.27.8 → 0.28.0.rc4

data/lib/decidim/dev/assets/import_participatory_space_private_users.csv

@@ -1,2 +1,2 @@
-my_user@example.org,My User Name
-my_private_user@example.org,My Private User Name
+john.doe@example.org;John Doe
+jane.doe@example.org;Jane Doe

data/lib/decidim/dev/assets/import_participatory_space_private_users_invalid_col_sep.csv

@@ -0,0 +1,2 @@
+john.doe@example.org,John Doe
+jane.doe@example.org,Jane Doe

data/lib/decidim/dev/assets/import_participatory_space_private_users_nok.csv

@@ -1,2 +1,2 @@
-my_user@example.org,My User (Name)
-my_private_user@example.org,My Private User Name
+john.doe@example.org;John Doe (Roe)
+jane.doe@example.org;Jane Doe

data/lib/decidim/dev/assets/import_participatory_space_private_users_with_bom.csv

@@ -1 +1 @@
-my_user@example.org,My User Name
+john.doe@example.org;John Doe

data/lib/decidim/dev/assets/iso-8859-15.md

@@ -1,4 +1,4 @@
 This file is saved in ISO-8859-1 encoding and contains the following non ASCII characters:
+
 - ca: can��, cami�, votar�, seg�ent
 - es: espa�a
-

data/lib/decidim/dev/assets/participatory_text.md

@@ -1,3 +1,5 @@
+<!-- markdown-lint-disable-file single-h1 -->
+
 # The great title for a new law
 
 ## A co-creation process to create creative creations
@@ -27,8 +29,8 @@ When an organization finishes a co-creation process, the accountability process
 blah, blah, blah...
 
 1. one
-2. two
-3. three
+1. two
+1. three
 
 ### Following up accounted results
 

data/lib/decidim/dev/assets/verify_user_groups.csv

@@ -1,22 +1,22 @@
-Email,,,,,,
-my_usergroup@example.org,,,,,,
-,,,,,,
-,,,,,,
-,,,,,,
-,,,,,,
-,,,,,,
-,,,,,,
-,,,,,,
-,,,,,,
-,,,,,,
-,,,,,,
-,,,,,,
-,,,,,,
-,,,,,,
-,,,,,,
-,,,,,,
-,,,,,,
-,,,,,,
-,,,,,,
-,,,,,,
-,,,,,,
+Email;;;;;;
+acme@example.org;;;;;;
+;;;;;;
+;;;;;;
+;;;;;;
+;;;;;;
+;;;;;;
+;;;;;;
+;;;;;;
+;;;;;;
+;;;;;;
+;;;;;;
+;;;;;;
+;;;;;;
+;;;;;;
+;;;;;;
+;;;;;;
+;;;;;;
+;;;;;;
+;;;;;;
+;;;;;;
+;;;;;;

data/lib/decidim/dev/engine.rb

@@ -8,9 +8,10 @@ module Decidim
       engine_name "decidim_dev"
 
       initializer "decidim_dev.tools" do
-        ActiveSupport.on_load :action_controller do
-          ActionController::Base.include Decidim::Dev::NeedsDevelopmentTools
-        end
+        # Disable if the boost performance mode is enabled
+        next if Rails.application.config.try(:boost_performance)
+
+        ActiveSupport.on_load(:action_controller) { include Decidim::Dev::NeedsDevelopmentTools }
       end
 
       initializer "decidim_dev.webpacker.assets_path" do

data/lib/decidim/dev/test/factories.rb

@@ -1,12 +1,10 @@
 # frozen_string_literal: true
 
+require "decidim/components/namer"
+
 FactoryBot.define do
   factory :dummy_component, parent: :component do
-    transient do
-      skip_injection { false }
-    end
-
-    name { generate_component_name(participatory_space.organization.available_locales, :dummy, skip_injection: skip_injection) }
+    name { Decidim::Components::Namer.new(participatory_space.organization.available_locales, :surveys).i18n_name }
     manifest_name { :dummy }
   end
 end

data/lib/decidim/dev/test/form_to_param_shared_examples.rb

@@ -4,7 +4,7 @@ shared_examples "form to param" do |options|
   method_name = options[:method_name] || :to_param
 
   describe "##{method_name}" do
-    subject { described_class.new(id: id) }
+    subject { described_class.new(id:) }
 
     context "with actual ID" do
       let(:id) { double }

data/lib/decidim/dev/test/promoted_participatory_processes_shared_examples.rb

@@ -9,14 +9,14 @@ shared_examples "with promoted participatory processes and groups" do
     it "includes promoted participatory processes and groups placing groups in first place" do
       create(
         :participatory_process_group,
-        organization: organization
+        organization:
       )
 
       unpromoted_process = create(
         :participatory_process,
         :with_steps,
         :published,
-        organization: organization
+        organization:
       )
       unpromoted_process.active_step.update!(end_date: Time.current.advance(days: 1))
 
@@ -25,14 +25,14 @@ shared_examples "with promoted participatory processes and groups" do
         :with_steps,
         :published,
         :promoted,
-        organization: organization
+        organization:
       )
       promoted_process.active_step.update!(end_date: Time.current.advance(days: 2))
 
       promoted_group = create(
         :participatory_process_group,
         :promoted,
-        organization: organization
+        organization:
       )
 
       _external_promoted_group = create(
@@ -51,14 +51,14 @@ shared_examples "with promoted participatory processes and groups" do
         :with_steps,
         :unpublished,
         :promoted,
-        organization: organization
+        organization:
       )
 
       create(
         :participatory_process,
         :with_steps,
         :unpublished,
-        organization: organization
+        organization:
       )
 
       last =
@@ -67,7 +67,7 @@ shared_examples "with promoted participatory processes and groups" do
           :with_steps,
           :published,
           :promoted,
-          organization: organization
+          organization:
         )
 
       last.active_step.update!(end_date: nil)
@@ -78,7 +78,7 @@ shared_examples "with promoted participatory processes and groups" do
           :with_steps,
           :published,
           :promoted,
-          organization: organization,
+          organization:,
           end_date: Time.current.advance(days: 10)
         )
 
@@ -90,7 +90,7 @@ shared_examples "with promoted participatory processes and groups" do
           :with_steps,
           :published,
           :promoted,
-          organization: organization,
+          organization:,
           end_date: Time.current.advance(days: 8)
         )
 

data/lib/decidim/dev/test/rspec_support/accessibility_examples.rb

@@ -1,5 +1,123 @@
 # frozen_string_literal: true
 
+module AxeMatchers
+  def self.axe_version
+    @axe_version ||= begin
+      package = JSON.load_file(Rails.root.join("node_modules/axe-core/package.json"))
+      package["version"]
+    end
+  end
+
+  def self.axe_mainline_version
+    @axe_mainline_version ||= axe_version.split(".")[0..1].join(".")
+  end
+
+  class ResultFormatter
+    def initialize(result)
+      @result = result
+      @violations = result["violations"]
+    end
+
+    def format
+      <<~MESSAGE
+
+        Found #{violations.count} accessibility #{violations.count == 1 ? "violation" : "violations"}:
+
+        #{violation_messages.join("\n")}
+      MESSAGE
+    end
+
+    def violation_messages
+      violations.each_with_index.map do |violation, index|
+        nodes = violation["nodes"]
+        [
+          "#{index + 1}) #{violation["id"]}: #{violation["help"]} (#{violation["impact"]})",
+          indent_lines(violation["helpUrl"], 1),
+          indent_lines("The following #{nodes.length} #{nodes.length == 1 ? "node" : "nodes"} violate this rule:", 1),
+          "",
+          indent_lines(node_messages_for(nodes), 2),
+          ""
+        ]
+      end.flatten
+    end
+
+    private
+
+    attr_reader :result, :violations
+
+    def indent_lines(lines, indent_level = 1)
+      indent = "    " * indent_level
+      Array(lines).flatten.map { |line| line.length.positive? ? "#{indent}#{line}" : "" }.join("\n")
+    end
+
+    def node_messages_for(nodes)
+      nodes.map do |node|
+        [
+          "Selector: #{Array(node["target"]).join(", ")}",
+          ("HTML: #{node["html"].gsub(/^\s*|\n*/, "")}" unless node["html"].nil?),
+          fix(node["all"], "Fix all of the following:"),
+          fix(node["none"], "Fix all of the following:"),
+          fix(node["any"], "Fix any of the following:")
+        ].compact.presence.tap { |messages| messages&.push("") }
+      end.compact
+    end
+
+    def fix(checks, message)
+      valid_checks = checks.compact
+      [
+        (message unless valid_checks.empty?),
+        *valid_checks.map { |check| "- #{check["message"]}" }
+      ].compact
+    end
+  end
+
+  class BeAxeClean
+    def matches?(page)
+      @results = execute_axe(page)
+      results["violations"].count.zero?
+    end
+
+    def failure_message
+      ResultFormatter.new(results).format
+    end
+
+    def failure_message_when_negated
+      "Expected to find accessibility violations. None were detected."
+    end
+
+    private
+
+    attr_reader :results
+
+    def execute_axe(page)
+      load_axe(page)
+
+      script = <<-JS
+        var callback = arguments[arguments.length - 1];
+        var context = document;
+        var options = {};
+        axe.run(context, options).then(res => JSON.parse(JSON.stringify(res))).then(callback);
+      JS
+      page = page.driver if page.respond_to?("driver")
+      page = page.browser if page.respond_to?("browser") && !page.browser.is_a?(::Symbol)
+      page.execute_async_script(script)
+    end
+
+    def load_axe(page)
+      jslib = Rails.root.join("node_modules/axe-core/axe.min.js")
+      page.execute_script jslib.read
+    end
+  end
+
+  def be_axe_clean
+    BeAxeClean.new
+  end
+end
+
+RSpec.configure do |config|
+  config.include AxeMatchers
+end
+
 shared_examples_for "accessible page" do
   it "passes accessibility tests" do
     expect(page).to be_axe_clean
@@ -7,7 +125,7 @@ shared_examples_for "accessible page" do
 
   it "passes HTML validation" do
     # Capybara is stripping the doctype out of the HTML which is required for
-    # the validation. If it doesn't exist, add it there.
+    # the validation. If it does not exist, add it there.
     html = page.source
     html = "<!DOCTYPE html>\n#{html}" unless html.strip.match?(/^<!DOCTYPE/i)
 

data/lib/decidim/dev/test/rspec_support/attachment_helpers.rb

@@ -18,8 +18,8 @@ module AttachmentHelpers
 
     blob = ActiveStorage::Blob.create_and_upload!(
       io: File.open(file),
-      filename: filename,
-      content_type: content_type
+      filename:,
+      content_type:
     )
     return blob if options[:return_blob]
 

data/lib/decidim/dev/test/rspec_support/bullet.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "bullet"
+
+RSpec.configure do |config|
+  Decidim::ApplicationJob.include(Bullet::ActiveJob) if defined?(Bullet::ActiveJob)
+
+  Rails.application.config.after_initialize do
+    Bullet.enable = Decidim::Env.new("DECIDIM_BULLET_ENABLED", "true").present?
+    Bullet.rails_logger = true
+    Bullet.raise = true
+    Bullet.stacktrace_includes = %w(decidim-)
+
+    # Detect N+1 queries
+    Bullet.n_plus_one_query_enable = Decidim::Env.new("DECIDIM_BULLET_N_PLUS_ONE", "false").present?
+    # Detect eager-loaded associations which are not used
+    Bullet.unused_eager_loading_enable = Decidim::Env.new("DECIDIM_BULLET_UNUSED_EAGER", "false").present?
+    # Detect unnecessary COUNT queries which could be avoided with a counter_cache
+    Bullet.counter_cache_enable = Decidim::Env.new("DECIDIM_BULLET_COUNTER_CACHE", "true").present?
+  end
+
+  if Bullet.enable?
+    config.before(:each) do
+      Bullet.start_request
+    end
+
+    config.after(:each) do
+      Bullet.perform_out_of_channel_notifications if Bullet.notification?
+      Bullet.end_request
+    end
+  end
+end

data/lib/decidim/dev/test/rspec_support/capybara.rb

@@ -6,7 +6,7 @@ module Decidim
   # Helpers meant to be used only during capybara test runs.
   module CapybaraTestHelpers
     def switch_to_host(host = "lvh.me")
-      raise "Can't switch to a custom host unless it really exists. Use `whatever.lvh.me` as a workaround." unless /lvh\.me$/.match?(host)
+      raise "Cannot switch to a custom host unless it really exists. Use `whatever.lvh.me` as a workaround." unless /lvh\.me$/.match?(host)
 
       app_host = (host ? "#{protocol}://#{host}" : nil)
       Capybara.app_host = app_host
@@ -28,12 +28,22 @@ module Decidim
   end
 end
 
+1.step do
+  port = rand(5000..6999)
+  begin
+    Socket.tcp("127.0.0.1", port, connect_timeout: 5).close
+  rescue Errno::ECONNREFUSED
+    # When connection is refused, the port is available for use.
+    Capybara.server_port = port
+    break
+  end
+end
+
 Capybara.register_driver :headless_chrome do |app|
-  options = ::Selenium::WebDriver::Chrome::Options.new
+  options = Selenium::WebDriver::Chrome::Options.new
+  options.args << "--explicitly-allowed-ports=#{Capybara.server_port}"
   options.args << "--headless"
   options.args << "--no-sandbox"
-  # Do not limit browser resources
-  options.args << "--disable-dev-shm-usage"
   options.args << if ENV["BIG_SCREEN_SIZE"].present?
                     "--window-size=1920,3000"
                   else
@@ -43,27 +53,20 @@ Capybara.register_driver :headless_chrome do |app|
   Capybara::Selenium::Driver.new(
     app,
     browser: :chrome,
-    capabilities: [options]
+    options:
   )
 end
 
-1.step do
-  port = rand(5000..6999)
-  begin
-    Socket.tcp("127.0.0.1", port, connect_timeout: 5).close
-    warn "Port #{port} is already in use, trying another one."
-  rescue Errno::ECONNREFUSED
-    # When connection is refused, the port is available for use.
-    Capybara.server_port = port
-    break
-  end
-end
-
+# In order to work with PWA apps, Chrome cannot be run in headless mode, and requires
 # setting up special prefs and flags
 Capybara.register_driver :pwa_chrome do |app|
-  options = ::Selenium::WebDriver::Chrome::Options.new
+  options = Selenium::WebDriver::Chrome::Options.new
+  options.args << "--explicitly-allowed-ports=#{Capybara.server_port}"
+  # If we have a headless browser things like the offline navigation feature stop working,
+  # so we need to have have a headful/recapitated (aka not headless) browser for these specs
+  # options.args << "--headless"
   options.args << "--no-sandbox"
-  # Don't limit browser resources
+  # Do not limit browser resources
   options.args << "--disable-dev-shm-usage"
   # Add pwa.lvh.me host as a secure origin
   options.args << "--unsafely-treat-insecure-origin-as-secure=http://pwa.lvh.me:#{Capybara.server_port}"
@@ -82,22 +85,20 @@ Capybara.register_driver :pwa_chrome do |app|
   Capybara::Selenium::Driver.new(
     app,
     browser: :chrome,
-    capabilities: [options]
+    options:
   )
 end
 
 Capybara.register_driver :iphone do |app|
-  options = ::Selenium::WebDriver::Chrome::Options.new
+  options = Selenium::WebDriver::Chrome::Options.new
   options.args << "--headless"
   options.args << "--no-sandbox"
-  # Do not limit browser resources
-  options.args << "--disable-dev-shm-usage"
   options.add_emulation(device_name: "iPhone 6")
 
   Capybara::Selenium::Driver.new(
     app,
     browser: :chrome,
-    capabilities: [options]
+    options:
   )
 end
 
@@ -129,7 +130,7 @@ RSpec.configure do |config|
       domain = ".#{domain}" unless domain == "localhost"
       page.driver.browser.execute_cdp(
         "Network.setCookie",
-        domain: domain,
+        domain:,
         name: Decidim.consent_cookie_name,
         value: { essential: true }.to_json,
         path: "/",

data/lib/decidim/dev/test/rspec_support/cell_matchers.rb

@@ -4,7 +4,7 @@ module Decidim
   module CellMatchers
     RSpec::Matchers.define :render_nothing do |_expected_value|
       match do |actual_value|
-        expect(actual_value).to have_no_selector("html")
+        expect(actual_value).not_to have_selector("html")
       end
 
       diffable