decidim-dev 0.28.3 → 0.29.0.rc1

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

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Dev
+    module Test
+      # The test map server serves all map related requests for the app.
+      #
+      # Works as a rack middleware that is mounted to the Rails app during
+      # tests (at the decidim-dev module's engine).
+      class MapServer
+        def self.host
+          "http://#{hostname}:#{Capybara.server_port}"
+        end
+
+        def self.hostname
+          "maps.lvh.me"
+        end
+
+        def self.url(endpoint)
+          case endpoint
+          when :tiles
+            "#{host}/maptiles/{z}/{x}/{y}.png"
+          when :static
+            "#{host}/static"
+          when :autocomplete
+            "#{host}/photon_api"
+          end
+        end
+
+        def initialize(app)
+          @app = app
+        end
+
+        def call(env)
+          request = Rack::Request.new(env)
+          return @app.call(env) unless request.host == self.class.hostname
+
+          if (match = request.path.match(%r{^/maptiles/([0-9]+)/([0-9]+)/([0-9]+).png$}))
+            return serve_maptiles(request, { z: match[1], x: match[2], y: match[3] })
+          elsif request.path == "/static"
+            return serve_static(request)
+          elsif request.path == "/photon_api"
+            return serve_autocomplete(request)
+          end
+
+          not_found
+        end
+
+        private
+
+        def tile_image_content
+          @tile_image_content ||= File.read(Decidim::Dev.asset("icon.png"))
+        end
+
+        def serve_maptiles(_request, _properties)
+          [200, { "Content-Type" => "image/png" }, [tile_image_content]]
+        end
+
+        def serve_static(_request)
+          [200, { "Content-Type" => "image/png" }, [tile_image_content]]
+        end
+
+        def serve_autocomplete(_request)
+          photon_response = {
+            features: [
+              {
+                properties: {
+                  name: "Park",
+                  street: "Street1",
+                  housenumber: "1",
+                  postcode: "123456",
+                  city: "City1",
+                  state: "State1",
+                  country: "Country1"
+                },
+                geometry: {
+                  coordinates: [2.234, 1.123]
+                }
+              },
+              {
+                properties: {
+                  street: "Street2",
+                  postcode: "654321",
+                  city: "City2",
+                  country: "Country2"
+                },
+                geometry: {
+                  coordinates: [4.456, 3.345]
+                }
+              },
+              {
+                properties: {
+                  street: "Street3",
+                  housenumber: "3",
+                  postcode: "142536",
+                  city: "City3",
+                  country: "Country3"
+                },
+                geometry: {
+                  coordinates: [6.678, 5.567]
+                }
+              }
+            ]
+          }.tap do |response|
+            Decidim::Map::Provider::Autocomplete::Test.stubs.length.positive? &&
+              response[:features] = Decidim::Map::Provider::Autocomplete::Test.stubs
+          end
+
+          [
+            200,
+            {
+              "Content-Type" => "application/json",
+              "Access-Control-Allow-Origin" => "*"
+            },
+            [photon_response.to_json.to_s]
+          ]
+        end
+
+        def not_found
+          [404, { "Content-Type" => "text/plain" }, ["Not found."]]
+        end
+      end
+    end
+  end
+end

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

@@ -9,9 +9,9 @@ module Capybara
         expect(page).to have_css("#autoComplete_list_1") # select should be open now
 
         expect(page).to have_css("#autoComplete_result_0", text: value)
-        find("#autoComplete_result_0", text: value).hover
+        find_by_id("autoComplete_result_0", text: value).hover
         expect(page).to have_css("#autoComplete_result_0", text: value)
-        find("#autoComplete_result_0", text: value).click
+        find_by_id("autoComplete_result_0", text: value).click
         expect(page).to have_css(".autocomplete__selected-item", text: value)
       end
     end

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

@@ -17,6 +17,10 @@ RSpec.configure do |config|
     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?
+
+    # Having a counter cache for this column is too difficult, as this should also work for the Decidim::DummyResource
+    # model, and counter_cache needs a real table in the database.
+    Bullet.add_safelist type: :counter_cache, class_name: "Decidim::Proposals::Proposal", association: :attachments
   end
 
   if Bullet.enable?

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

@@ -10,6 +10,7 @@ module Decidim
 
       app_host = (host ? "#{protocol}://#{host}" : nil)
       Capybara.app_host = app_host
+      Rails.application.config.action_controller.asset_host = host
     end
 
     def switch_to_default_host
@@ -31,20 +32,29 @@ 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
+    redis = Redis.new
+    reserved_ports = (redis.get("decidim_test_capybara_reserved_ports") || "").split(",").map(&:to_i)
+    unless reserved_ports.include?(port)
+      reserved_ports << port
+      if ParallelTests.last_process?
+        redis.del("decidim_test_capybara_reserved_ports")
+      else
+        redis.set("decidim_test_capybara_reserved_ports", reserved_ports.sort.join(","))
+      end
+      break
+    end
+  rescue Redis::CannotConnectError
+    # Redis is not available
     break
   end
+ensure
+  Capybara.server_port = port
 end
 
 Capybara.register_driver :headless_chrome do |app|
   options = Selenium::WebDriver::Chrome::Options.new
   options.args << "--explicitly-allowed-ports=#{Capybara.server_port}"
   options.args << "--headless=new"
-  options.args << "--disable-search-engine-choice-screen" # Prevents closing the window normally
   # Do not limit browser resources
   options.args << "--disable-dev-shm-usage"
   options.args << "--no-sandbox"
@@ -67,7 +77,7 @@ Capybara.register_driver :pwa_chrome do |app|
   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
+  # so we need to have a headful/recapitated (aka not headless) browser for these specs
   # options.args << "--headless"
   options.args << "--no-sandbox"
   # Do not limit browser resources
@@ -157,7 +167,7 @@ RSpec.configure do |config|
     switch_to_default_host
     domain = (try(:organization) || try(:current_organization))&.host
     if domain
-      # Javascript sets the cookie also for all subdomains but localhost is a
+      # JavaScript sets the cookie also for all subdomains but localhost is a
       # special case.
       domain = ".#{domain}" unless domain == "localhost"
       page.driver.browser.execute_cdp(

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).not_to have_selector("html")
+        expect(actual_value).to have_no_css("html")
       end
 
       diffable

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

@@ -12,7 +12,7 @@ shared_examples "has mandatory config setting" do |mandatory_field|
   end
 
   it "does not allow updating the component" do
-    click_button "Update"
+    click_on "Update"
 
     within ".#{mandatory_field}_container" do
       expect(page).to have_content("There is an error in this field")

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

@@ -7,30 +7,30 @@ module Capybara
       visit decidim.root_path if options[:visit_root]
 
       dialog_present = begin
-        find("#dc-dialog-wrapper")
+        find_by_id("dc-dialog-wrapper")
       rescue Capybara::ElementNotFound => _e
         false
       end
 
       if dialog_present
-        click_button "Settings"
+        click_on "Settings"
       else
         within "footer" do
-          click_link "Cookie settings"
+          click_on "Cookie settings"
         end
       end
 
       if [true, "all"].include?(categories)
-        click_button "Accept all"
+        click_on "Accept all"
       elsif categories.is_a?(Array)
         categories.each do |category|
           within "[data-id='#{category}']" do
             find(".cookies__category-toggle").click
           end
         end
-        click_button "Save settings"
+        click_on "Save settings"
       elsif [false, "essential"].include?(categories)
-        click_button "Accept only essential"
+        click_on "Accept only essential"
       end
     end
   end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Capybara
+  module DatepickerDateFill
+    # fill datepicker field correctly
+
+    def fill_in_datepicker(locator = nil, with:, currently_with: nil, fill_options: {}, **find_options)
+      find_options[:with] = currently_with if currently_with
+      find_options[:allow_self] = true if locator.nil?
+      with.chars.each do |character|
+        if character == "/"
+          find(:fillable_field, locator, **find_options).send_keys(:divide, **fill_options)
+        elsif character == "."
+          find(:fillable_field, locator, **find_options).send_keys(:decimal, **fill_options)
+        else
+          find(:fillable_field, locator, **find_options).send_keys(character, **fill_options)
+        end
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include Capybara::DatepickerDateFill, type: :system
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Capybara
+  module DatepickerTimeFill
+    # fill datepicker field correctly
+
+    def fill_in_timepicker(locator = nil, with:, currently_with: nil, fill_options: {}, **find_options)
+      find_options[:with] = currently_with if currently_with
+      find_options[:allow_self] = true if locator.nil?
+      with.chars.each do |character|
+        if character == ":"
+          find(:fillable_field, locator, **find_options).send_keys([:alt, ":"], **fill_options)
+        else
+          find(:fillable_field, locator, **find_options).send_keys(character, **fill_options)
+        end
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include Capybara::DatepickerTimeFill, type: :system
+end

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

@@ -23,7 +23,7 @@ module Capybara
           expect(page).to have_content(filename.first(12)) if front_interface
         end
         all(title_input(front_interface)).last.set(options[:title]) if options.has_key?(:title)
-        click_button("Save") unless options[:keep_modal_open]
+        click_on("Save") unless options[:keep_modal_open]
       end
     end
 
@@ -36,7 +36,7 @@ module Capybara
     end
 
     def click_remove(front_interface)
-      front_interface ? click_button("Remove") : find(".remove-upload-item").click
+      front_interface ? click_on("Remove") : find(".remove-upload-item").click
     end
   end
 end

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

@@ -18,7 +18,7 @@ module GeocoderHelpers
   # are no pending requests when proceeding.
   def fill_in_geocoding(attribute, options = {})
     fill_in attribute, **options
-    expect(page).to have_selector(".autoComplete_wrapper ul#autoComplete_list_1", count: 1)
+    expect(page).to have_css(".autoComplete_wrapper ul#autoComplete_list_1", count: 1)
     find("li#autoComplete_result_0").click
   end
 
@@ -29,8 +29,13 @@ module GeocoderHelpers
     Decidim.maps = {
       provider: :test,
       api_key: "1234123412341234",
-      static: { url: "https://www.example.org/my_static_map" },
-      autocomplete: { url: "/photon_api" } # Locally drawn route for the tests
+      dynamic: {
+        tile_layer: {
+          url: Decidim::Dev::Test::MapServer.url(:tiles)
+        }
+      },
+      static: { url: Decidim::Dev::Test::MapServer.url(:static) },
+      autocomplete: { url: Decidim::Dev::Test::MapServer.url(:autocomplete) }
     }
   end
 end
@@ -102,77 +107,8 @@ RSpec.configure do |config|
     configure_maps
   end
 
-  config.before(:each, :serves_map) do
-    stub_request(:get, %r{https://www\.example\.org/my_static_map})
-      .to_return(body: "map_data")
-  end
-
   config.before(:each, :serves_geocoding_autocomplete) do
     # Clear the autocomplete stubs
     Decidim::Map::Provider::Autocomplete::Test.clear_stubs
-
-    photon_response = lambda do
-      {
-        features: [
-          {
-            properties: {
-              name: "Park",
-              street: "Street1",
-              housenumber: "1",
-              postcode: "123456",
-              city: "City1",
-              state: "State1",
-              country: "Country1"
-            },
-            geometry: {
-              coordinates: [2.234, 1.123]
-            }
-          },
-          {
-            properties: {
-              street: "Street2",
-              postcode: "654321",
-              city: "City2",
-              country: "Country2"
-            },
-            geometry: {
-              coordinates: [4.456, 3.345]
-            }
-          },
-          {
-            properties: {
-              street: "Street3",
-              housenumber: "3",
-              postcode: "142536",
-              city: "City3",
-              country: "Country3"
-            },
-            geometry: {
-              coordinates: [6.678, 5.567]
-            }
-          }
-        ]
-      }.tap do |response|
-        Decidim::Map::Provider::Autocomplete::Test.stubs.length.positive? &&
-          response[:features] = Decidim::Map::Provider::Autocomplete::Test.stubs
-      end
-    end
-
-    # The Photon API path needs to be mounted in the application itself because
-    # otherwise we would have to run a separate server for the API itself.
-    # Mocking the request would not work here because the call to the Photon API
-    # is initialized by the front-end to the URL specified for the maps
-    # geocoding autocompletion configuration which is not proxied by the
-    # headless browser running the Capybara tests.
-    Rails.application.routes.disable_clear_and_finalize = true
-    Rails.application.routes.draw do
-      get "photon_api", to: ->(_) { [200, { "Content-Type" => "application/json" }, [photon_response.call.to_json.to_s]] }
-    end
-    Rails.application.routes.disable_clear_and_finalize = false
-  end
-
-  config.after(:each, :serves_geocoding_autocomplete) do
-    # Reset the routes back to original
-    Rails.application.reload_routes!
   end
 end

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

@@ -5,7 +5,7 @@ module Decidim
   module ComponentTestHelpers
     def click_submenu_link(text)
       within ".secondary-nav--subnav" do
-        click_link text
+        click_on text
       end
     end
 
@@ -13,7 +13,7 @@ module Decidim
       main_bar_selector = ".main-bar"
 
       within main_bar_selector do
-        find("#trigger-dropdown-account").click
+        find_by_id("trigger-dropdown-account").click
 
         yield
       end
@@ -26,14 +26,14 @@ module Decidim
     end
 
     def within_admin_menu
-      click_button "Manage"
+      click_on "Manage"
       within("[id*='dropdown-menu-settings']") do
         yield
       end
     end
 
     def within_language_menu(options = {})
-      within(options[:admin] ? ".topbar__dropmenu.language-choose" : "footer") do
+      within(options[:admin] ? ".language-choose" : "footer") do
         find(options[:admin] ? "#admin-menu-trigger" : "#trigger-dropdown-language-chooser").click
         yield
       end

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

@@ -3,7 +3,7 @@
 # https://github.com/orchidjs/tom-select/discussions/71#discussioncomment-641757
 module Capybara
   module TomSelect
-    # A helper for Capyabara tests that need to set values from a tom-select.js input.
+    # A helper for Capybara tests that need to set values from a tom-select.js input.
     #
     # This is a really hacky approach using execute_javascript, but it works. Not sure if there is
     # a better way, we could try actually interacting with the on-screen tom-select-provided UI,

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

@@ -42,7 +42,7 @@ module TranslationHelpers
   # field - the name of the field that should be filled, without the
   #   locale-related part (e.g. `:participatory_process_title`)
   # tab_selector - a String representing the ID of the HTML element that holds
-  #   the tabs for this input. It ususally is `"#<attribute_name>-tabs" (e.g.
+  #   the tabs for this input. It usually is `"#<attribute_name>-tabs" (e.g.
   #   "#title-tabs")
   # localized_values - a Hash where the keys are the locales IDs and the values
   #   are the values that will be entered in the form field.
@@ -57,7 +57,7 @@ module TranslationHelpers
   # field - the name of the field that should be filled, without the
   #   locale-related part (e.g. `:participatory_process_title`)
   # tab_selector - a String representing the ID of the HTML element that holds
-  #   the tabs for this input. It ususally is `"#<attribute_name>-tabs" (e.g.
+  #   the tabs for this input. It usually is `"#<attribute_name>-tabs" (e.g.
   #   "#title-tabs")
   # localized_values - a Hash where the keys are the locales IDs and the values
   #   are the values that will be entered in the form field.
@@ -72,7 +72,7 @@ module TranslationHelpers
   # field - the name of the field that should be cleared, without the
   #   locale-related part (e.g. `:participatory_process_title`)
   # tab_selector - a String representing the ID of the HTML element that holds
-  #   the tabs for this input. It ususally is `"#<attribute_name>-tabs" (e.g.
+  #   the tabs for this input. It usually is `"#<attribute_name>-tabs" (e.g.
   #   "#title-tabs")
   # locales - an Array with the locales IDs.
   def clear_i18n_editor(field, tab_selector, locales)
@@ -113,7 +113,7 @@ module TranslationHelpers
     scroll_to(find(tab_selector))
     localized_values.each do |locale, value|
       within tab_selector do
-        click_link I18n.with_locale(locale) { t("name", scope: "locale") }
+        click_on I18n.with_locale(locale) { t("name", scope: "locale") }
       end
       yield "#{field}_#{locale}", value
     end
@@ -125,7 +125,7 @@ module TranslationHelpers
     scroll_to(find(tab_selector))
     locales.each do |locale|
       within tab_selector do
-        click_link I18n.with_locale(locale) { t("name", scope: "locale") }
+        click_on I18n.with_locale(locale) { t("name", scope: "locale") }
       end
       yield "#{field}_#{locale}"
     end

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

@@ -2,4 +2,10 @@
 
 require "webmock/rspec"
 
-WebMock.disable_net_connect!(allow_localhost: true, allow: %r{https://validator\.w3\.org/})
+WebMock.disable_net_connect!(
+  allow_localhost: true,
+  allow: [
+    %r{https://validator\.w3\.org/},
+    Decidim::Dev::Test::MapServer.host
+  ]
+)

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

@@ -5,8 +5,8 @@ class WickedPdf
     module Assets
       # Force wicked_pdf styles to have a relative path, to prevent fetching
       # them from a host
-      def wicked_pdf_stylesheet_pack_tag(*sources)
-        stylesheet_pack_tag(*sources)
+      def wicked_pdf_stylesheet_pack_tag(*)
+        stylesheet_pack_tag(*)
       end
 
       # Disables the images in the PDFs as those requests would be jamming under

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

@@ -41,14 +41,8 @@ RSpec.configure do |config|
 
   config.before :all do
     Decidim.content_security_policies_extra = {
-      "img-src": %w(https://via.placeholder.com)
+      "img-src": %W(https://via.placeholder.com #{Decidim::Dev::Test::MapServer.host}),
+      "connect-src": %W(#{Decidim::Dev::Test::MapServer.host})
     }
   end
-
-  config.before do
-    # Ensure that the current host is not set for any spec in order to test that
-    # the automatic current host definition is working correctly in all
-    # situations.
-    ActiveStorage::Current.host = ""
-  end
 end

data/lib/decidim/dev/version.rb

@@ -4,7 +4,7 @@ module Decidim
   # This holds the decidim-dev version.
   module Dev
     def self.version
-      "0.28.3"
+      "0.29.0.rc1"
     end
   end
 end

data/lib/decidim/dev.rb

@@ -22,15 +22,6 @@ module Decidim
     include ActiveSupport::Configurable
     autoload :DummyTranslator, "decidim/dev/dummy_translator"
 
-    # Settings needed to compare emendations in Decidim::SimilarEmendations
-    config_accessor :similarity_threshold do
-      0.25
-    end
-
-    config_accessor :similarity_limit do
-      10
-    end
-
     # Public: Finds an asset.
     #
     # Returns a String with the path for a particular asset.

data/lib/decidim-dev.rb

@@ -1,3 +1,5 @@
+# rubocop:disable Naming/FileName
 # frozen_string_literal: true
 
 require "decidim/dev"
+# rubocop:enable Naming/FileName

data/lib/tasks/lighthouse_report.rake

@@ -4,7 +4,7 @@ namespace :decidim do
   namespace :lighthouse do
     desc "Prepares seeds for Lighthouse report"
     task prepare_urls: :environment do
-      # Lighhouse report is executed in CI and should check:
+      # Lighthouse report is executed in CI and should check:
       # - homepage
       # - a participatory process page
       # - a meeting page

data/rubocop-decidim.yml

@@ -5,7 +5,13 @@
 # For further details, see:
 # https://github.com/rubocop/rubocop/issues/4154#issuecomment-316004878
 
+require:
+  - rubocop-rubycw
+  - rubocop-capybara
+  - rubocop-factory_bot
+
 inherit_from:
+  - config/rubocop/performance.yml
   - config/rubocop/ruby.yml
   - config/rubocop/rails.yml
   - config/rubocop/rspec.yml