decidim-dev 0.20.1 → 0.23.1

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

@@ -6,15 +6,13 @@ module Capybara
       Struct.new(:data_picker, :global_value).new(find_data_picker(id, multiple: multiple), global_value)
     end
 
-    private
-
     def find_data_picker(id, multiple: nil)
       if multiple.nil?
-        expect(page).to have_selector("div.data-picker##{id}")
+        expect(page).to have_selector("div.data-picker[id$='#{id}']")
       else
-        expect(page).to have_selector("div.data-picker.picker-#{multiple ? "multiple" : "single"}##{id}")
+        expect(page).to have_selector("div.data-picker.picker-#{multiple ? "multiple" : "single"}[id$='#{id}']")
       end
-      find("div.data-picker##{id}")
+      first("div.data-picker[id$='#{id}']")
     end
 
     def data_picker_pick_current
@@ -22,5 +20,17 @@ module Capybara
       expect(body).to have_selector("#data_picker-modal .picker-footer a[data-picker-choose]")
       body.find("#data_picker-modal .picker-footer a[data-picker-choose]").click
     end
+
+    def data_picker_choose_value(value)
+      body = find(:xpath, "//body")
+      expect(body).to have_selector("#data_picker-modal input[data-picker-choose][type=checkbox][value=\"#{value}\"]")
+      body.find("#data_picker-modal input[data-picker-choose][type=checkbox][value=\"#{value}\"]").click
+    end
+
+    def data_picker_close
+      body = find(:xpath, "//body")
+      expect(body).to have_selector("#data_picker-modal .picker-footer a[data-close]")
+      body.find("#data_picker-modal .picker-footer a[data-close]").click
+    end
   end
 end

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

@@ -10,7 +10,7 @@ module Capybara
       match do |scope_picker|
         data_picker = scope_picker.data_picker
         scope_name = expected ? translated(expected.name) : t("decidim.scopes.global")
-        expect(data_picker).to have_selector(".picker-values div input[value='#{expected&.id || scope_picker.global_value}']", visible: false)
+        expect(data_picker).to have_selector(".picker-values div input[value='#{expected&.id || scope_picker.global_value}']", visible: :all)
         expect(data_picker).to have_selector(:xpath, "//div[contains(@class,'picker-values')]/div/a[text()[contains(.,'#{scope_name}')]]")
       end
     end
@@ -19,7 +19,7 @@ module Capybara
       match do |scope_picker|
         data_picker = scope_picker.data_picker
         scope_name = expected ? translated(expected.name) : t("decidim.scopes.global")
-        expect(data_picker).not_to have_selector(".picker-values div input[value='#{expected&.id || scope_picker.global_value}']", visible: false)
+        expect(data_picker).not_to have_selector(".picker-values div input[value='#{expected&.id || scope_picker.global_value}']", visible: :all)
         expect(data_picker).not_to have_selector(:xpath, "//div[contains(@class,'picker-values')]/div/a[text()[contains(.,'#{scope_name}')]]")
       end
     end
@@ -27,7 +27,7 @@ module Capybara
     def scope_pick(scope_picker, scope)
       data_picker = scope_picker.data_picker
       # use scope_repick to change single scope picker selected scope
-      expect(data_picker).to have_selector(".picker-values:empty", visible: false) if data_picker.has_css?(".picker-single")
+      expect(data_picker).to have_selector(".picker-values:empty", visible: :all) if data_picker.has_css?(".picker-single")
 
       expect(data_picker).to have_selector(".picker-prompt")
       data_picker.find(".picker-prompt").click
@@ -41,7 +41,7 @@ module Capybara
     def scope_repick(scope_picker, old_scope, new_scope)
       data_picker = scope_picker.data_picker
 
-      expect(data_picker).to have_selector(".picker-values div input[value='#{old_scope&.id || scope_picker.global_value}']", visible: false)
+      expect(data_picker).to have_selector(".picker-values div input[value='#{old_scope&.id || scope_picker.global_value}']", visible: :all)
       data_picker.find(:xpath, "//div[contains(@class,'picker-values')]/div/input[@value='#{old_scope&.id || scope_picker.global_value}']/../a").click
 
       # browse to lowest common parent between old and new scope
@@ -57,7 +57,7 @@ module Capybara
     def scope_unpick(scope_picker, scope)
       data_picker = scope_picker.data_picker
 
-      expect(data_picker).to have_selector(".picker-values div input[value='#{scope&.id || scope_picker.global_value}']", visible: false)
+      expect(data_picker).to have_selector(".picker-values div input[value='#{scope&.id || scope_picker.global_value}']", visible: :all)
       data_picker.find(".picker-values div input[value='#{scope&.id || scope_picker.global_value}']").click
 
       expect(scope_picker).to have_scope_not_picked(scope)

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

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 module CommentsHelpers
-  def have_comment_from(user, text)
+  def have_comment_from(user, text, opts = {})
     within "#comments" do
-      have_content(user.name) && have_content(text)
+      have_content(user.name, opts) && have_content(text, opts)
     end
   end
 

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

@@ -29,6 +29,7 @@ module Decidim
         root to: proc { [200, {}, ["DUMMY ENGINE"]] }
 
         resources :dummy_resources do
+          resources :nested_dummy_resources
           get :foo, on: :member
         end
       end
@@ -38,6 +39,10 @@ module Decidim
       engine_name "dummy_admin"
 
       routes do
+        resources :dummy_resources do
+          resources :nested_dummy_resources
+        end
+
         root to: proc { [200, {}, ["DUMMY ADMIN ENGINE"]] }
       end
     end
@@ -53,7 +58,7 @@ module Decidim
       include Reportable
       include Authorable
       include HasCategory
-      include ScopableComponent
+      include ScopableResource
       include Decidim::Comments::Commentable
       include Followable
       include Traceable
@@ -63,8 +68,12 @@ module Decidim
       include Paddable
       include Amendable
       include Decidim::NewsletterParticipant
-      include Hashtaggable
+      include ::Decidim::Endorsable
+      include Decidim::HasAttachments
+      include Decidim::ShareableWithToken
+      include Decidim::TranslatableResource
 
+      translatable_fields :title
       searchable_fields(
         scope_id: { scope: :id },
         participatory_space: { component: :participatory_space },
@@ -103,6 +112,44 @@ module Decidim
                                               .pluck(:decidim_author_id).flatten.compact.uniq
       end
     end
+
+    class NestedDummyResource < ApplicationRecord
+      include Decidim::Resourceable
+      belongs_to :dummy_resource
+    end
+
+    class CoauthorableDummyResource < ApplicationRecord
+      include ::Decidim::Coauthorable
+      include HasComponent
+    end
+
+    class OfficialAuthorPresenter
+      def name
+        self.class.name
+      end
+
+      def nickname
+        UserBaseEntity.nicknamize(name)
+      end
+
+      def deleted?
+        false
+      end
+
+      def respond_to_missing?
+        true
+      end
+
+      def method_missing(method, *args)
+        if method.to_s.ends_with?("?")
+          false
+        elsif [:avatar_url, :profile_path, :badge, :followers_count].include?(method)
+          ""
+        else
+          super
+        end
+      end
+    end
   end
 end
 
@@ -128,10 +175,14 @@ Decidim.register_component(:dummy) do |component|
   component.newsletter_participant_entities = ["Decidim::DummyResources::DummyResource"]
 
   component.settings(:global) do |settings|
+    settings.attribute :scopes_enabled, type: :boolean, default: false
+    settings.attribute :scope_id, type: :scope
     settings.attribute :comments_enabled, type: :boolean, default: true
+    settings.attribute :comments_max_length, type: :integer, required: false
     settings.attribute :resources_permissions_enabled, type: :boolean, default: true
     settings.attribute :dummy_global_attribute_1, type: :boolean
-    settings.attribute :dummy_global_attribute_2, type: :boolean
+    settings.attribute :dummy_global_attribute_2, type: :boolean, readonly: ->(_context) { false }
+    settings.attribute :readonly_attribute, type: :boolean, default: true, readonly: ->(_context) { true }
     settings.attribute :enable_pads_creation, type: :boolean, default: false
     settings.attribute :amendments_enabled, type: :boolean, default: false
     settings.attribute :dummy_global_translatable_text, type: :text, translated: true, editor: true, required: true
@@ -140,12 +191,15 @@ Decidim.register_component(:dummy) do |component|
   component.settings(:step) do |settings|
     settings.attribute :comments_blocked, type: :boolean, default: false
     settings.attribute :dummy_step_attribute_1, type: :boolean
-    settings.attribute :dummy_step_attribute_2, type: :boolean
+    settings.attribute :dummy_step_attribute_2, type: :boolean, readonly: ->(_context) { false }
     settings.attribute :dummy_step_translatable_text, type: :text, translated: true, editor: true, required: true
+    settings.attribute :readonly_step_attribute, type: :boolean, default: true, readonly: ->(_context) { true }
     settings.attribute :amendment_creation_enabled, type: :boolean, default: true
     settings.attribute :amendment_reaction_enabled, type: :boolean, default: true
     settings.attribute :amendment_promotion_enabled, type: :boolean, default: true
     settings.attribute :amendments_visibility, type: :string, default: "all"
+    settings.attribute :endorsements_enabled, type: :boolean, default: false
+    settings.attribute :endorsements_blocked, type: :boolean, default: false
   end
 
   component.register_resource(:dummy_resource) do |resource|
@@ -156,6 +210,19 @@ Decidim.register_component(:dummy) do |component|
     resource.searchable = true
   end
 
+  component.register_resource(:nested_dummy_resource) do |resource|
+    resource.name = :nested_dummy
+    resource.model_class_name = "Decidim::DummyResources::NestedDummyResource"
+  end
+
+  component.register_resource(:coauthorable_dummy_resource) do |resource|
+    resource.name = :coauthorable_dummy
+    resource.model_class_name = "Decidim::DummyResources::CoauthorableDummyResource"
+    resource.template = "decidim/coauthorabledummy_resource/linked_dummys"
+    resource.actions = %w(foo-coauthorable)
+    resource.searchable = false
+  end
+
   component.register_stat :dummies_count_high, primary: true, priority: Decidim::StatsRegistry::HIGH_PRIORITY do |components, _start_at, _end_at|
     components.count * 10
   end
@@ -179,13 +246,15 @@ RSpec.configure do |config|
       unless ActiveRecord::Base.connection.data_source_exists?("decidim_dummy_resources_dummy_resources")
         ActiveRecord::Migration.create_table :decidim_dummy_resources_dummy_resources do |t|
           t.jsonb :translatable_text
-          t.string :title
+          t.jsonb :title
           t.string :body
           t.text :address
           t.float :latitude
           t.float :longitude
           t.datetime :published_at
           t.integer :coauthorships_count, null: false, default: 0
+          t.integer :endorsements_count, null: false, default: 0
+          t.integer :comments_count, null: false, default: 0
 
           t.references :decidim_component, index: false
           t.integer :decidim_author_id, index: false
@@ -195,6 +264,36 @@ RSpec.configure do |config|
           t.references :decidim_scope, index: false
           t.string :reference
 
+          t.timestamps
+        end
+      end
+      unless ActiveRecord::Base.connection.data_source_exists?("decidim_dummy_resources_nested_dummy_resources")
+        ActiveRecord::Migration.create_table :decidim_dummy_resources_nested_dummy_resources do |t|
+          t.jsonb :translatable_text
+          t.string :title
+
+          t.references :dummy_resource, index: false
+          t.timestamps
+        end
+      end
+      unless ActiveRecord::Base.connection.data_source_exists?("decidim_dummy_resources_coauthorable_dummy_resources")
+        ActiveRecord::Migration.create_table :decidim_dummy_resources_coauthorable_dummy_resources do |t|
+          t.jsonb :translatable_text
+          t.string :title
+          t.string :body
+          t.text :address
+          t.float :latitude
+          t.float :longitude
+          t.datetime :published_at
+          t.integer :coauthorships_count, null: false, default: 0
+          t.integer :endorsements_count, null: false, default: 0
+          t.integer :comments_count, null: false, default: 0
+
+          t.references :decidim_component, index: false
+          t.references :decidim_category, index: false
+          t.references :decidim_scope, index: false
+          t.string :reference
+
           t.timestamps
         end
       end

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,16 +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_api_key: "1234123412341234"
-    }
-    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