decidim-dev 0.19.1 → 0.23.0

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

@@ -19,8 +19,7 @@ shared_context "with a component" do
            participatory_space: participatory_space)
   end
 
-  let!(:category) { create :category, participatory_space: participatory_process }
-
+  let!(:category) { create :category, participatory_space: participatory_space }
   let!(:scope) { create :scope, organization: organization }
 
   before do

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# Helpers that get automatically included in component specs.
+module ConfirmationHelpers
+  # Overrides the Capybara default accept_confirm because we have replaced the
+  # system's own confirmation modal with foundation based modal.
+  #
+  # See:
+  # https://github.com/teamcapybara/capybara/blob/44621209496fe4dd352709799a0061a80d97d562/lib/capybara/session.rb#L647
+  def accept_confirm(_text = nil, **_options)
+    yield if block_given?
+
+    # The test can already be "within", so find the body using xpath
+    message = nil
+    body = find(:xpath, "/html/body")
+    within(body.find(".confirm-reveal")) do
+      message = find(".confirm-modal-content").text
+      find("a.button[data-confirm-ok]").click
+    end
+
+    message
+  end
+
+  # Overrides the Capybara default dismiss_confirm because we have replaced the
+  # system's own confirmation modal with foundation based modal.
+  #
+  # See:
+  # https://github.com/teamcapybara/capybara/blob/44621209496fe4dd352709799a0061a80d97d562/lib/capybara/session.rb#L657
+  def dismiss_confirm(_text = nil, **_options)
+    yield if block_given?
+
+    # The test can already be "within", so find the body using xpath
+    message = nil
+    body = find(:xpath, "/html/body")
+    within(body.find(".confirm-reveal")) do
+      message = find(".confirm-modal-content").text
+      find("a.button[data-confirm-cancel]").click
+    end
+
+    message
+  end
+
+  # Used to accept the "onbeforeunload" event's normal browser confirm modal
+  # as this cannot be overridden. Original confirm dismiss implementation in
+  # Capybara.
+  def accept_page_unload(text = nil, **options, &blk)
+    page.send(:accept_modal, :confirm, text, options, &blk)
+  end
+
+  # Used to dismiss the "onbeforeunload" event's normal browser confirm modal
+  # as this cannot be overridden. Original confirm dismiss implementation in
+  # Capybara.
+  def dismiss_page_unload(text = nil, **options, &blk)
+    page.send(:dismiss_modal, :confirm, text, options, &blk)
+  end
+end
+
+RSpec.configure do |config|
+  config.include ConfirmationHelpers, type: :system
+end

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

@@ -3,7 +3,7 @@
 module Decidim
   class ContentParsers::DummyFooParser < ContentParsers::BaseParser
     def rewrite
-      content.gsub("foo", "*lorem*")
+      content.gsub("foo", "%lorem%")
     end
 
     def metadata
@@ -12,8 +12,8 @@ module Decidim
   end
 
   class ContentRenderers::DummyFooRenderer < ContentRenderers::BaseRenderer
-    def render
-      content.gsub("*lorem*", "<em>neque dicta enim quasi</em>")
+    def render(_options = nil)
+      content.gsub("%lorem%", "<em>neque dicta enim quasi</em>")
     end
   end
 
@@ -28,7 +28,7 @@ module Decidim
   end
 
   class ContentRenderers::DummyBarRenderer < ContentRenderers::BaseRenderer
-    def render
+    def render(_options = nil)
       content.gsub("*ipsum*", "<em>illo qui voluptas</em>")
     end
   end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module FrontendHelpers
+  # Thanks to:
+  # https://medium.com/@coorasse/catch-javascript-errors-in-your-system-tests-89c2fe6773b1
+  def expect_no_js_errors
+    errors = page.driver.browser.manage.logs.get(:browser)
+    return if errors.blank?
+
+    aggregate_failures "javascript errors" do
+      errors.each do |error|
+        expect(error.level).not_to eq("SEVERE"), error.message
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include FrontendHelpers, type: :system
+end

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

@@ -8,6 +8,69 @@ module GeocoderHelpers
       address,
       result
     )
+    Decidim::Map::Provider::Autocomplete::Test.add_stub(
+      address,
+      coordinates
+    )
+  end
+
+  # Waits for the front-end geocoding request to finish in order to ensure there
+  # are no pending requests when proceeding.
+  def fill_in_geocoding(attribute, options = {})
+    fill_in attribute, options
+    expect(page).to have_selector(".tribute-container ul#results", count: 1)
+  end
+
+  module_function
+
+  public def configure_maps
+    # Set maps configuration in test mode
+    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
+    }
+  end
+end
+
+module Decidim::Map::Provider
+  module Geocoding
+    class Test < ::Decidim::Map::Geocoding; end
+  end
+  module Autocomplete
+    class Test < ::Decidim::Map::Autocomplete
+      def self.stubs
+        @stubs ||= []
+      end
+
+      def self.add_stub(address, coordinates)
+        stubs.push(
+          properties: address.is_a?(Hash) ? address : { street: address },
+          geometry: { coordinates: coordinates }
+        )
+      end
+
+      def self.clear_stubs
+        @stubs = []
+      end
+
+      def builder_options
+        { url: configuration.fetch(:url, nil) }.compact
+      end
+
+      class Builder < Decidim::Map::Autocomplete::Builder
+        def javascript_snippets
+          template.javascript_include_tag("decidim/geocoding/provider/photon")
+        end
+      end
+    end
+  end
+  module DynamicMap
+    class Test < ::Decidim::Map::DynamicMap; end
+  end
+  module StaticMap
+    class Test < ::Decidim::Map::StaticMap; end
   end
 end
 
@@ -15,17 +78,97 @@ RSpec.configure do |config|
   config.include GeocoderHelpers
 
   config.before(:suite) do
-    # Set geocoder configuration in test mode
-    Decidim.geocoder = {
-      static_map_url: "https://www.example.org/my_static_map",
-      here_app_id: "1234",
-      here_app_code: "5678"
-    }
-    Geocoder.configure(lookup: :test)
+    GeocoderHelpers.configure_maps
+  end
+
+  config.after(:each, :configures_map) do
+    # Ensure the initializer is always re-run after the examples because
+    # otherwise the utilities could remain unregistered which causes issues with
+    # further tests.
+    Decidim::Core::Engine.initializers.each do |i|
+      next unless i.name == "decidim.maps"
+
+      i.run
+      break
+    end
+
+    # Ensure the utility configuration is reset after each example for it to be
+    # reloaded the next time.
+    Decidim::Map.reset_utility_configuration!
+    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: [1.123, 2.234]
+            }
+          },
+          {
+            properties: {
+              street: "Street2",
+              postcode: "654321",
+              city: "City2",
+              country: "Country2"
+            },
+            geometry: {
+              coordinates: [3.345, 4.456]
+            }
+          },
+          {
+            properties: {
+              street: "Street3",
+              housenumber: "3",
+              postcode: "142536",
+              city: "City3",
+              country: "Country3"
+            },
+            geometry: {
+              coordinates: [5.567, 6.678]
+            }
+          }
+        ]
+      }.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

@@ -10,14 +10,14 @@ module Decidim::ComponentTestHelpers
 
   def within_user_menu
     within ".topbar__user__logged" do
-      find("a", text: user.name).hover
+      find("a", text: user.name).click
       yield
     end
   end
 
   def within_language_menu
     within ".topbar__dropmenu.language-choose" do
-      find("ul.dropdown.menu").hover
+      find("ul.dropdown.menu").click
       yield
     end
   end

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

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+RSpec.configure do |config|
+  config.after do
+    Decidim::OrganizationSettings.reset!
+  end
+end

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+# File: spec/support/tasks.rb
+require "rake"
+
+# Task names should be used in the top-level describe, with an optional
+# "rake "-prefix for better documentation. Both of these will work:
+#
+# 1) describe "foo:bar" do ... end
+#
+# 2) describe "rake foo:bar" do ... end
+#
+# Favor including "rake "-prefix as in the 2nd example above as it produces
+# doc output that makes it clear a rake task is under test and how it is
+# invoked.
+module TaskExampleGroup
+  extend ActiveSupport::Concern
+
+  included do
+    # Make the Rake task available as `task` in your examples:
+    subject(:task) { tasks[task_name] }
+
+    let(:task_name) { self.class.top_level_description.sub(/\Arake /, "") }
+    let(:tasks) { Rake::Task }
+  end
+end
+
+# A collection of methods to help dealing with rake tasks output.
+module RakeTaskOutputHelpers
+  extend ActiveSupport::Concern
+
+  included do
+    let!(:original_stdout) { $stdout }
+
+    # rubocop:disable RSpec/ExpectOutput
+    before do
+      $stdout = StringIO.new
+    end
+
+    after do
+      $stdout = original_stdout
+    end
+    # rubocop:enable RSpec/ExpectOutput
+  end
+
+  def check_no_errors_have_been_printed
+    expect($stdout.string).not_to include("ERROR:")
+  end
+
+  def check_some_errors_have_been_printed
+    expect($stdout.string).to include("ERROR:")
+  end
+
+  def check_error_printed(type)
+    expect($stdout.string).to include("ERROR: [#{type}]")
+  end
+
+  def check_message_printed(message)
+    expect($stdout.string).to include(message)
+  end
+end
+
+RSpec.configure do |config|
+  # Tag Rake specs with `:task` metadata or put them in the spec/tasks dir
+  config.define_derived_metadata(file_path: %r{/spec/tasks/}) do |metadata|
+    metadata[:type] = :task
+  end
+
+  config.include TaskExampleGroup, type: :task
+  config.include RakeTaskOutputHelpers, type: :task
+
+  config.before(:suite) do
+    Rails.application.load_tasks
+  end
+end

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

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+RSpec.configure do |config|
+  config.around :example, :tz do |example|
+    Time.use_zone(example.metadata[:tz]) { example.run }
+  end
+end

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

@@ -13,6 +13,8 @@ module TranslationHelpers
   # It is intended to be used to avoid the implementation details, so that the
   # translated attributes implementation can change more easily.
   def translated(field, locale: I18n.locale)
+    return field if field.is_a?(String)
+
     field.try(:[], locale.to_s)
   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.19.1"
+      "0.23.0"
     end
   end
 end

data/lib/tasks/generators.rake

@@ -44,7 +44,8 @@ namespace :decidim do
         "..",
         "--recreate_db",
         "--seed_db",
-        "--demo"
+        "--demo",
+        "--profiling"
       )
     end
   end

data/lib/tasks/locale_checker.rake

@@ -5,7 +5,7 @@ namespace :decidim do
   task check_locales: :environment do
     FileUtils.remove_dir("tmp/decidim_repo", true)
 
-    branch = ENV["TARGET_BRANCH"] || "master"
+    branch = ENV["TARGET_BRANCH"] || "develop"
     status = system("git clone --depth=1 --single-branch --branch #{branch} https://github.com/decidim/decidim tmp/decidim_repo")
     return unless status