decidim-dev 0.27.10 → 0.28.0.rc4

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

@@ -1,55 +1,208 @@
 # frozen_string_literal: true
 
 # Helpers that get automatically included in component specs.
-module Decidim::ComponentTestHelpers
-  def click_submenu_link(text)
-    within ".secondary-nav--subnav" do
-      click_link text
+module Decidim
+  module ComponentTestHelpers
+    def click_submenu_link(text)
+      within ".secondary-nav--subnav" do
+        click_link text
+      end
     end
-  end
 
-  def within_user_menu
-    within ".topbar__user__logged" do
-      find("a", text: user.name).click
-      yield
+    def within_user_menu
+      main_bar_selector = ".main-bar"
+
+      within main_bar_selector do
+        find("#trigger-dropdown-account").click
+
+        yield
+      end
     end
-  end
 
-  def within_language_menu
-    within ".topbar__dropmenu.language-choose" do
-      find("ul.dropdown.menu").click
-      yield
+    def within_admin_sidebar_menu
+      within("[id='admin-sidebar-menu-settings']") do
+        yield
+      end
     end
-  end
 
-  def stripped(text)
-    text.gsub(/^<p>/, "").gsub(%r{</p>$}, "")
-  end
+    def within_admin_menu
+      click_button "Manage"
+      within("[id*='dropdown-menu-settings']") do
+        yield
+      end
+    end
+
+    def within_language_menu(options = {})
+      within(options[:admin] ? ".topbar__dropmenu.language-choose" : "footer") do
+        find(options[:admin] ? "#admin-menu-trigger" : "#trigger-dropdown-language-chooser").click
+        yield
+      end
+    end
+
+    def stripped(text)
+      text.gsub(/^<p>/, "").gsub(%r{</p>$}, "")
+    end
 
-  def within_flash_messages
-    within ".flash" do
-      yield
+    def within_flash_messages
+      within ".flash", match: :first do
+        yield
+      end
+    end
+
+    def expect_user_logged
+      expect(page).to have_css(".main-bar #trigger-dropdown-account")
+    end
+
+    def have_admin_callout(text)
+      within_flash_messages do
+        have_content text
+      end
+    end
+
+    def stub_get_request_with_format(rq_url, rs_format)
+      stub_request(:get, rq_url)
+        .with(
+          headers: {
+            "Accept" => "*/*",
+            "Accept-Encoding" => "gzip;q=1.0,deflate;q=0.6,identity;q=0.3",
+            "User-Agent" => "Ruby"
+          }
+        )
+        .to_return(status: 200, body: "", headers: { content_type: rs_format })
     end
   end
 
-  def expect_user_logged
-    expect(page).to have_css(".topbar__user__logged")
+  module FrontEndDataTestHelpers
+    def paste_content(content, target_selector)
+      page.execute_script(
+        <<~JS
+          var dt = new DataTransfer();
+          dt.setData("text/html", #{content.to_json});
+          dt.setData("text/plain", #{content.to_json});
+
+          var element = document.querySelector("#{target_selector}");
+          element.dispatchEvent(new ClipboardEvent("paste", { clipboardData: dt }));
+        JS
+      )
+    end
   end
 
-  def have_admin_callout(text)
-    have_selector(".callout--full", text: text)
+  module FrontEndPointerTestHelpers
+    def drag(selector, mode: "mouse", direction: nil, amount: 0)
+      move =
+        case direction
+        when "left"
+          "x -= #{amount}"
+        when "right"
+          "x += #{amount}"
+        when "top"
+          "y -= #{amount}"
+        when "bottom"
+          "y += #{amount}"
+        end
+
+      events =
+        if mode == "touch"
+          <<~JS
+            var evStart = new Event("touchstart");
+            evStart.touches = [{ pageX: rect.x, pageY: rect.y }];
+            var evMove = new Event("touchmove");
+            evMove.touches = [{ pageX: x, pageY: y }];
+
+            element.dispatchEvent(evStart);
+            document.dispatchEvent(evMove);
+            document.dispatchEvent(new Event("touchend"));
+          JS
+        else
+          <<~JS
+            element.dispatchEvent(new MouseEvent("mousedown", { clientX: rect.x, clientY: rect.y }));
+            document.dispatchEvent(new MouseEvent("mousemove", { clientX: x, clientY: y }));
+            document.dispatchEvent(new MouseEvent("mouseup"));
+          JS
+        end
+
+      page.execute_script(
+        <<~JS
+          var element = document.querySelector("#{selector}");
+          var rect = element.getBoundingClientRect();
+
+          var x = rect.x;
+          var y = rect.y;
+          #{move};
+
+          #{events}
+        JS
+      )
+    end
   end
 
-  def stub_get_request_with_format(rq_url, rs_format)
-    stub_request(:get, rq_url)
-      .with(
-        headers: {
-          "Accept" => "*/*",
-          "Accept-Encoding" => "gzip;q=1.0,deflate;q=0.6,identity;q=0.3",
-          "User-Agent" => "Ruby"
-        }
+  module FrontEndFileTestHelpers
+    def file_to_frontend(filename)
+      filepath = Decidim::Dev.asset(filename)
+      mime = MiniMime.lookup_by_filename(filepath).content_type
+      encoded = Base64.encode64(File.read(filepath))
+
+      {
+        filename:,
+        data_url: "data:application/octet-binary;base64,#{encoded.gsub("\n", "")}",
+        mime_type: mime
+      }
+    end
+
+    def add_file(filename, target_selector, event)
+      file = file_to_frontend(filename)
+
+      page.execute_script(
+        <<~JS
+          var dataUrl = "#{file[:data_url]}";
+          fetch(dataUrl).then(function(res) { return res.arrayBuffer(); }).then(function (buffer) {
+            var file = new File([buffer], "#{filename}", { type: "#{file[:mime_type]}" });
+            var dropzone = document.querySelector("#{target_selector}");
+
+            var dt = new DataTransfer();
+            dt.items.add(file);
+
+            if ("#{event}" === "drop") {
+              var ev = new Event("drop");
+              ev.dataTransfer = dt;
+              dropzone.dispatchEvent(ev);
+            } else {
+              // Simulates selecting the file through the browser's file selector
+              var input = dropzone.querySelector("input[type='file']");
+              input.files = dt.files;
+              input.dispatchEvent(new Event("change", { bubbles: true }));
+            }
+          });
+        JS
+      )
+
+      # Wait for the file to be uploaded
+      within "[data-dropzone-items]" do
+        expect(page).to have_content(filename)
+      end
+    end
+
+    def paste_file(filename, target_selector)
+      file = file_to_frontend(filename)
+
+      page.execute_script(
+        <<~JS
+          var dataUrl = "#{file[:data_url]}";
+          fetch(dataUrl).then(function(res) { return res.arrayBuffer(); }).then(function (buffer) {
+            var file = new File([buffer], "#{filename}", { type: "#{file[:mime_type]}" });
+
+            var dt = new DataTransfer();
+            dt.items.add(file);
+
+            var element = document.querySelector("#{target_selector}");
+            element.dispatchEvent(new ClipboardEvent("paste", { clipboardData: dt }));
+          });
+        JS
       )
-      .to_return(status: 200, body: "", headers: { content_type: rs_format })
+
+      # Wait for the file to be uploaded
+      sleep 1
+    end
   end
 end
 

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

@@ -2,8 +2,8 @@
 
 shared_examples "admin imports controller" do
   let!(:organization) { create(:organization) }
-  let!(:user) { create(:user, :admin, :confirmed, organization: organization) }
-  let!(:component) { create(:component, participatory_space: participatory_space, manifest_name: "dummy") }
+  let!(:user) { create(:user, :admin, :confirmed, organization:) }
+  let!(:component) { create(:component, participatory_space:, manifest_name: "dummy") }
 
   let(:default_params) do
     {
@@ -23,11 +23,11 @@ shared_examples "admin imports controller" do
     # will always create a record for each data row regardless of the data.
     let(:file) { upload_test_file(Decidim::Dev.test_file("import_proposals.csv", "text/csv")) }
     let(:params) do
-      default_params.merge(extra_params).merge(file: file)
+      default_params.merge(extra_params).merge(file:)
     end
 
     it "imports dummies" do
-      post(:create, params: params)
+      post(:create, params:)
       expect(response).to have_http_status(:found)
       expect(flash[:notice]).not_to be_empty
 
@@ -42,14 +42,14 @@ shared_examples "admin imports controller" do
 
   describe "GET example" do
     let(:params) do
-      default_params.merge(extra_params).merge(format: format)
+      default_params.merge(extra_params).merge(format:)
     end
 
     context "with CSV format" do
       let(:format) { "csv" }
 
       it "creates a correct CSV example file" do
-        get(:example, params: params)
+        get(:example, params:)
 
         expect(response).to have_http_status(:ok)
         expect(response.content_type).to eq("text/csv")
@@ -66,7 +66,7 @@ shared_examples "admin imports controller" do
       let(:format) { "json" }
 
       it "creates a correct JSON example file" do
-        get(:example, params: params)
+        get(:example, params:)
 
         expect(response).to have_http_status(:ok)
         expect(response.content_type).to eq("application/json")
@@ -83,7 +83,7 @@ shared_examples "admin imports controller" do
       let(:format) { "xlsx" }
 
       it "creates a correct XLSX example file" do
-        get(:example, params: params)
+        get(:example, params:)
 
         expect(response).to have_http_status(:ok)
         expect(response.content_type).to eq(
@@ -109,7 +109,7 @@ shared_examples "admin imports controller" do
       let(:format) { "foo" }
 
       it "raises ActionController::UnknownFormat" do
-        expect { get(:example, params: params) }.to raise_error(
+        expect { get(:example, params:) }.to raise_error(
           ActionController::UnknownFormat
         )
       end
@@ -124,7 +124,7 @@ shared_examples "admin imports controller" do
 
     describe "POST create" do
       it "raises ActionController::RoutingError" do
-        expect { post(:create, params: params) }.to raise_error(
+        expect { post(:create, params:) }.to raise_error(
           ActionController::RoutingError
         )
       end
@@ -132,7 +132,7 @@ shared_examples "admin imports controller" do
 
     describe "GET example" do
       it "raises ActionController::RoutingError" do
-        expect { get(:example, params: params) }.to raise_error(
+        expect { get(:example, params:) }.to raise_error(
           ActionController::RoutingError
         )
       end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# 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.
+    #
+    # 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,
+    # but we are taking the easy way out for now.
+    #
+    # @param option_id can be the `id` value of an option in the select, OR for select multiple inputs,
+    #   can be an array of such IDs.
+    #
+    # @example tom_select("#select_id", option_id: "2")
+    # @example tom_select("#select_id", option_id: ["2", "10"]) # `multiple` input.
+    def tom_select(select_selector, option_id:)
+      js_str = %(document.querySelector("#{select_selector}").tomselect.setValue(#{option_id.inspect}))
+      execute_script(js_str)
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include Capybara::TomSelect, type: :system
+end

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

@@ -4,7 +4,7 @@
 module TranslationHelpers
   # Allows using the `t` shortcut inside specs just like in views
   def t(key, scope: nil)
-    I18n.t(key, scope: scope, raise: true)
+    I18n.t(key, scope:, raise: true)
   end
 
   # Gives the localized version of the attribute for the given locale. The
@@ -25,16 +25,16 @@ module TranslationHelpers
   # field - the field that holds the translations
   # upcase - a boolean to indicate whether the string must be checked upcased or not.
   def have_i18n_content(field, upcase: false, strip_tags: false)
-    have_content(i18n_content(field, upcase: upcase, strip_tags: strip_tags).strip)
+    have_content(i18n_content(field, upcase:, strip_tags:).strip)
   end
 
-  # Checks that the current page doesn't have some translated content. It strips
+  # Checks that the current page does not have some translated content. It strips
   # the HTML tags from the field (in case there are any).
   #
   # field - the field that holds the translations
   # upcase - a boolean to indicate whether the string must be checked upcased or not.
   def have_no_i18n_content(field, upcase: false)
-    have_no_content(i18n_content(field, upcase: upcase))
+    have_no_content(i18n_content(field, upcase:))
   end
 
   # Handles how to fill in i18n form fields.
@@ -90,8 +90,8 @@ module TranslationHelpers
     raise ArgumentError if params[:with].blank?
 
     page.execute_script <<-SCRIPT
-      $('##{locator}').siblings('.editor-container').find('.ql-editor')[0].innerHTML = "#{params[:with]}";
-      $('##{locator}').val("#{params[:with]}")
+      document.querySelector('##{locator} .editor-container .ProseMirror').innerHTML = `#{params[:with]}`;
+      document.querySelector('##{locator} input').value = `#{params[:with]}`;
     SCRIPT
   end
 
@@ -100,8 +100,8 @@ module TranslationHelpers
   # locator - The input field ID. The DOM element is selected using jQuery.
   def clear_editor(locator)
     page.execute_script <<-SCRIPT
-      $('##{locator}').siblings('.editor-container').find('.ql-editor')[0].innerHTML = "<p><br></p>";
-      $('##{locator}').val("")
+      document.querySelector('##{locator} .editor-container .ProseMirror').innerHTML = '<p><br class="ProseMirror-trailingBreak"></p>';
+      document.querySelector('##{locator} input').value = "";
     SCRIPT
   end
 

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

@@ -11,7 +11,7 @@ module Decidim
     def relogin_as(user, scope: :user)
       logout scope
 
-      login_as user, scope: scope
+      login_as user, scope:
     end
   end
 end

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

@@ -2,4 +2,4 @@
 
 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/})

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

@@ -1,28 +1,10 @@
 # frozen_string_literal: true
 
 RSpec.configure do |config|
-  config.before(:all) do
-    raise "Rails.root directory does not exist" unless Rails.root.exist?
-    raise "package.json file does not exist" unless Rails.root.join("package.json").exist?
-    raise "Node modules directory does not exist" unless Rails.root.join("node_modules").exist?
-
+  config.before(:all, type: :system) do
+    Dir.chdir(Rails.root) { Webpacker.compile }
+  end
+  config.before(:all, type: :mailer) do
     Dir.chdir(Rails.root) { Webpacker.compile }
-  rescue Errno::ENOENT
-    node_modules_contents = `ls #{Rails.root.join("node_modules")}`
-
-    message = <<~ERROR
-      There was an error during the Webpacker compilation
-      #{"=" * 80}
-      Node version: #{`node -v`}
-      #{"=" * 80}
-      NPM version: #{`npm -v`}
-      #{"=" * 80}
-      Node modules packages: #{`npm list`}
-      #{"=" * 80}
-      Node modules contents: #{node_modules_contents}
-      #{"=" * 80}
-    ERROR
-
-    raise message
   end
 end

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

@@ -5,9 +5,7 @@ require "rspec/rails"
 require "rspec/cells"
 require "byebug"
 require "wisper/rspec/stub_wisper_publisher"
-require "db-query-matchers"
 require "action_view/helpers/sanitize_helper"
-require "axe-rspec"
 require "w3c_rspec_validators"
 require "decidim/dev/test/w3c_rspec_validators_overrides"
 
@@ -25,12 +23,25 @@ RSpec.configure do |config|
   config.order = :random
   config.raise_errors_for_deprecations!
   config.example_status_persistence_file_path = ".rspec-failures"
+  config.filter_run_when_matching :focus
+  config.profile_examples = 10
+  config.default_formatter = "doc" if config.files_to_run.one?
 
-  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # If you are not using ActiveRecord, or you'd prefer not to run each of your
   # examples within a transaction, comment the following line or assign false
   # instead of true.
   config.use_transactional_fixtures = true
 
   config.include ActionView::Helpers::SanitizeHelper
   config.include ERB::Util
+
+  config.before :all, type: :system do
+    ActiveStorage.service_urls_expire_in = 24.hours
+  end
+
+  config.before :all do
+    Decidim.content_security_policies_extra = {
+      "img-src": %w(https://via.placeholder.com)
+    }
+  end
 end

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

@@ -3,11 +3,8 @@
 # This is a temporary fix to ignore some HTML/CSS validation issues with the
 # Decidim HTML validation process.
 #
-# See:
-# - https://github.com/decidim/decidim/issues/8596
-# - https://github.com/decidim/decidim/pull/10014
+# See: https://github.com/decidim/decidim/pull/10014
 # Related:
-# - https://github.com/w3c/css-validator/issues/355
 # - https://github.com/rails/rails/issues/46405
 # - https://github.com/foundation/foundation-sites/pull/12496
 module W3CValidators
@@ -22,7 +19,6 @@ module W3CValidators
 
     def ignore_errors
       @ignore_errors ||= [
-        "CSS: “--content-height”: One operand must be a number.",
         "An “input” element with a “type” attribute whose value is “hidden” must not have an “autocomplete” attribute whose value is “on” or “off”.",
         "An “input” element with a “type” attribute whose value is “hidden” must not have any “aria-*” attributes."
       ]

data/lib/decidim/dev/version.rb

@@ -4,7 +4,7 @@ module Decidim
   # This holds the decidim-dev version.
   module Dev
     def self.version
-      "0.27.10"
+      "0.28.0.rc4"
     end
   end
 end

data/lib/decidim/dev.rb

@@ -2,6 +2,15 @@
 
 require "decidim/dev/railtie"
 
+# The next 4 uncommented lines are used to register the Decidim::DummyResources namespace to the autoloader
+# We cannot rely on Rails autoloading because some of the classes that are required within that namespace
+# are needed before Rails is being available (e.g. FactoryBot)
+# After 1 day of various attempts, this is the only way I found to make it work.
+app_paths = %w(commands controllers events forms jobs mailers models presenters serializers)
+app_paths.each do |path|
+  ActiveSupport::Dependencies.autoload_paths += [File.absolute_path("#{__dir__}/../../app/#{path}")]
+end
+
 module Decidim
   # Decidim::Dev holds all the convenience logic and libraries to be able to
   # create external libraries that create test apps and test themselves against

data/lib/decidim/dummy_resources/admin.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Decidim
+  module DummyResources
+    module Admin
+    end
+  end
+end

data/lib/decidim/dummy_resources/admin_engine.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Decidim
+  module DummyResources
+    class AdminEngine < Rails::Engine
+      engine_name "dummy_admin"
+
+      routes do
+        resources :dummy_resources do
+          resources :nested_dummy_resources
+        end
+
+        root to: proc { [200, {}, ["DUMMY ADMIN ENGINE"]] }
+      end
+
+      initializer "dummy_admin.imports" do
+        class ::DummyCreator < Decidim::Admin::Import::Creator
+          def self.resource_klass
+            Decidim::DummyResources::DummyResource
+          end
+
+          def produce
+            resource
+          end
+
+          private
+
+          def resource
+            @resource ||= Decidim::DummyResources::DummyResource.new(
+              title: { en: "Dummy" },
+              author: context[:current_user],
+              component:
+            )
+          end
+
+          def component
+            context[:current_component]
+          end
+        end
+      end
+    end
+  end
+end