decidim-dev 0.27.4 → 0.28.0.rc5

data/lib/decidim/dev/admin.rb

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

data/lib/decidim/dev/admin_engine.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Dev
+    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::Dev::DummyResource
+          end
+
+          def produce
+            resource
+          end
+
+          private
+
+          def resource
+            @resource ||= Decidim::Dev::DummyResource.new(
+              title: { en: "Dummy" },
+              author: context[:current_user],
+              component:
+            )
+          end
+
+          def component
+            context[:current_component]
+          end
+        end
+      end
+    end
+  end
+end

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/component.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+Decidim.register_component(:dummy) do |component|
+  component.engine = Decidim::Dev::Engine
+  component.admin_engine = Decidim::Dev::AdminEngine
+  component.icon = "media/images/decidim_dev_dummy.svg"
+
+  component.actions = %w(foo bar)
+
+  component.newsletter_participant_entities = ["Decidim::Dev::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_attribute1, type: :boolean
+    settings.attribute :dummy_global_attribute2, 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
+  end
+
+  component.settings(:step) do |settings|
+    settings.attribute :comments_blocked, type: :boolean, default: false
+    settings.attribute :dummy_step_attribute1, type: :boolean
+    settings.attribute :dummy_step_attribute2, 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|
+    resource.name = :dummy
+    resource.model_class_name = "Decidim::Dev::DummyResource"
+    resource.template = "decidim/dummy_resource/linked_dummys"
+    resource.actions = %w(foo)
+    resource.searchable = true
+  end
+
+  component.register_resource(:nested_dummy_resource) do |resource|
+    resource.name = :nested_dummy
+    resource.model_class_name = "Decidim::Dev::NestedDummyResource"
+  end
+
+  component.register_resource(:coauthorable_dummy_resource) do |resource|
+    resource.name = :coauthorable_dummy
+    resource.model_class_name = "Decidim::Dev::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
+
+  component.register_stat :dummies_count_medium, primary: true, priority: Decidim::StatsRegistry::MEDIUM_PRIORITY do |components, _start_at, _end_at|
+    components.count * 100
+  end
+
+  component.exports :dummies do |exports|
+    exports.collection do
+      [1, 2, 3]
+    end
+
+    exports.serializer Decidim::Dev::DummySerializer
+  end
+
+  component.imports :dummies do |imports|
+    imports.messages do |msg|
+      msg.set(:resource_name) { |count: 1| count == 1 ? "Dummy" : "Dummies" }
+      msg.set(:title) { "Import dummies" }
+      msg.set(:label) { "Import dummies from a file" }
+    end
+
+    imports.creator DummyCreator
+    imports.example do |import_component|
+      locales = import_component.organization.available_locales
+      translated = ->(name) { locales.map { |l| "#{name}/#{l}" } }
+      [
+        translated.call("title") + %w(body) + translated.call("translatable_text") + %w(address latitude longitude),
+        locales.map { "Title text" } + ["Body text"] + locales.map { "Translatable text" } + ["Fake street 1", 1.0, 1.0]
+      ]
+    end
+  end
+end

data/lib/decidim/dev/engine.rb

@@ -7,15 +7,33 @@ module Decidim
       isolate_namespace Decidim::Dev
       engine_name "decidim_dev"
 
-      initializer "decidim_dev.tools" do
-        ActiveSupport.on_load :action_controller do
-          ActionController::Base.include Decidim::Dev::NeedsDevelopmentTools
+      routes do
+        root to: proc { [200, {}, ["DUMMY ENGINE"]] }
+
+        resources :dummy_resources do
+          resources :nested_dummy_resources
+          get :foo, on: :member
         end
       end
 
+      initializer "decidim_dev.tools" do
+        # 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 } if Rails.env.development? || ENV.fetch("DECIDIM_DEV_ENGINE", nil)
+      end
+
       initializer "decidim_dev.webpacker.assets_path" do
         Decidim.register_assets_path File.expand_path("app/packs", root)
       end
+
+      initializer "decidim_dev.moderation_content" do
+        config.to_prepare do
+          ActiveSupport::Notifications.subscribe("decidim.admin.block_user:after") do |_event_name, data|
+            Decidim::Dev::HideAllCreatedByAuthorJob.perform_later(**data)
+          end
+        end
+      end
     end
   end
 end

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

@@ -10,6 +10,7 @@ engine_spec_dir = File.join(Dir.pwd, "spec")
 require "simplecov" if ENV["SIMPLECOV"]
 
 require "decidim/core"
+require "decidim/dev/component"
 require "decidim/core/test"
 require "decidim/admin/test"
 require "decidim/api/test"

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

@@ -1,8 +1,58 @@
 # frozen_string_literal: true
 
+require "decidim/components/namer"
+
 FactoryBot.define do
   factory :dummy_component, parent: :component do
     name { Decidim::Components::Namer.new(participatory_space.organization.available_locales, :surveys).i18n_name }
     manifest_name { :dummy }
   end
+
+  factory :dummy_resource, class: "Decidim::Dev::DummyResource" do
+    transient do
+      users { nil }
+      # user_groups correspondence to users is by sorting order
+      user_groups { [] }
+    end
+    title { Decidim::Faker::Localized.localized { generate(:name) } }
+    component { create(:component, manifest_name: "dummy") }
+    author { create(:user, :confirmed, organization: component.organization) }
+    scope { create(:scope, organization: component.organization) }
+
+    trait :published do
+      published_at { Time.current }
+    end
+
+    trait :with_endorsements do
+      after :create do |resource|
+        5.times.collect do
+          create(:endorsement, resource:, author: build(:user, organization: resource.component.organization))
+        end
+      end
+    end
+  end
+
+  factory :nested_dummy_resource, class: "Decidim::Dev::NestedDummyResource" do
+    title { generate(:name) }
+    dummy_resource { create(:dummy_resource) }
+  end
+
+  factory :coauthorable_dummy_resource, class: "Decidim::Dev::CoauthorableDummyResource" do
+    title { generate(:name) }
+    component { create(:component, manifest_name: "dummy") }
+
+    transient do
+      authors_list { [create(:user, organization: component.organization)] }
+    end
+
+    after :build do |resource, evaluator|
+      evaluator.authors_list.each do |coauthor|
+        resource.coauthorships << if coauthor.is_a?(Decidim::UserGroup)
+                                    build(:coauthorship, author: coauthor.users.first, user_group: coauthor, coauthorable: resource, organization: evaluator.component.organization)
+                                  else
+                                    build(:coauthorship, author: coauthor, coauthorable: resource, organization: evaluator.component.organization)
+                                  end
+      end
+    end
+  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