decidim-dev 0.27.3 → 0.27.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4adab1ecdbf7a4a0c6f468454cf32adcf66fac1206adca9758f3a08d12c0dee2
-  data.tar.gz: 2a24af5908cb4003fe8d8fc974d2a79f9c3fd941e5bf6e692478a3d451d5f57c
+  metadata.gz: a8418d7ae6e85aa4a658a0c52d2e39954b7b8dec097c38b8f071fa4d51b21fa3
+  data.tar.gz: 96bfc08644fb6a5ab4d34eb6d37e222da103d3fb46ed0668acc321b545009ebc
 SHA512:
-  metadata.gz: efaaff6ec51fe371673691569f4a8560dc34635c8101576a717770a342e7da3ad56c675a6ee7494ee21336d70e78a7c66b87fbcb19de1000fe77246867d71d79
-  data.tar.gz: 0f2b37342a8b765a9c7c58161dea1ea64542ba8026873095873b777468c413cc625368c33937070ec68840e98286ffa4d7812b1f89cf1dc9338af685a18d68f2
+  metadata.gz: 240c26feb4ade240648b8ffb1b180d8d1011e994b82da1f470b7a272ca10cfd27627e2d8a5b5927a87f0bcdee2582089b75b8f0cf760aeb257028e2f7e3cc477
+  data.tar.gz: 80e4c51e2e7bbab875f8c39fad8648e4bda54252f5f0045e3eeb297ab1713b2a529f9a76ca83c706297a596797dbb68c17052bd120482c21052d5e7ce9a09b8e

data/app/packs/entrypoints/decidim_dev_test_custom_map.js

@@ -0,0 +1 @@
+import "src/decidim/dev/test/custom_map_factory";

data/app/packs/src/decidim/dev/test/custom_map_factory.js

@@ -0,0 +1,55 @@
+/**
+ * Example of a custom map controller and how to override the
+ * `createMapController` factory method. To use it in the ERB view, add the
+ * following snippet to any view:
+ *
+ * <%= dynamic_map_for type: "custom", markers: [{ title: "Test 1", latitude: 41.385063, longitude: 2.173404 }], popup_template_id: "custom-popup" do %>
+ *  <% javascript_pack_tag("decidim_dev_test_custom_map") %>
+ *  <template id="custom-popup">
+ *    <div>
+ *      <h3>${title}</h3>
+ *    </div>
+ *  </template>
+ * <% end %>
+ */
+
+import MapMarkersController from "src/decidim/map/controller/markers";
+
+const appendToBody = (content) => {
+  const p = document.createElement("p");
+  p.innerHTML = content;
+  document.body.appendChild(p);
+}
+
+class CustomMapController extends MapMarkersController {
+  start() {
+    this.markerClusters = null;
+    this.addMarkers(this.config.markers);
+
+    appendToBody("Custom map started");
+  }
+}
+
+const origCreateMapController = window.Decidim.createMapController;
+
+const createMapController = (mapId, config) => {
+  if (config.type === "custom") {
+    return new CustomMapController(mapId, config);
+  }
+
+  return origCreateMapController(mapId, config);
+}
+
+window.Decidim.createMapController = createMapController;
+
+// Prevent external requests to the Here URLs during tests
+if (L.TileLayer.HERE) {
+  L.TileLayer.HERE.prototype.onAdd = function(map) {};
+}
+
+// Test that the map events are working correctly
+$("[data-decidim-map]").on("ready.decidim", (ev, _map, mapConfig) => {
+  appendToBody("Custom map ready");
+});
+
+appendToBody("LOADED");

data/config/assets.rb

@@ -4,5 +4,6 @@ base_path = File.expand_path("..", __dir__)
 
 Decidim::Webpacker.register_path("#{base_path}/app/packs")
 Decidim::Webpacker.register_entrypoints(
-  decidim_dev: "#{base_path}/app/packs/entrypoints/decidim_dev.js"
+  decidim_dev: "#{base_path}/app/packs/entrypoints/decidim_dev.js",
+  decidim_dev_test_custom_map: "#{base_path}/app/packs/entrypoints/decidim_dev_test_custom_map.js"
 )

data/config/locales/de.yml

@@ -15,6 +15,12 @@ de:
       dummy:
         settings:
           global:
+            guided: Geführte Eingabe
+            guided_help: Hilfetext
+            guided_readonly: Deaktivierte Eingabe
+            guided_rich: Geführte reiche Eingabe
+            guided_rich_help_html: HTML <strong>Hilfe</strong> Text
+            guided_rich_readonly_html: HTML <strong>Hilfe</strong> Text für deaktivierte Eingabe
             readonly_attribute: Attribut schreibgeschützt
             test: Test A
             test_choices:
@@ -23,6 +29,7 @@ de:
               c: Wahl C
             test_options:
               bar: Bar
+              baz: Baz
               foo: Foo
           step:
             endorsements_blocked: Befürwortungen blockiert
@@ -30,6 +37,7 @@ de:
             readonly_step_attribute: Schritt-Attribut schreibgeschützt
             test_options:
               bar: Bar
+              baz: Baz
               foo: Foo
     dummy:
       admin:

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module RSpec::Core
+  module Notifications
+    class SummaryNotification
+      # Override the original method to add the full path to the spec file and the correct rspec command to rerun the failed spec
+      # The goal is to be able to copy-paste the command to rerun the failed spec without having to manually add the full path to the spec file
+      #
+      # So, instead of:
+      # > rspec ./spec/system/registration_spec.rb:27
+      #
+      # We get:
+      # > bin/rspec ./decidim-core/spec/system/registration_spec.rb:27
+      #
+      # Original code in rspec-core: https://github.com/rspec/rspec-core/blob/8caecca0b9b299ccbaa5c7ea5dd885ab42cd57d3/lib/rspec/core/notifications.rb#L365
+      def colorized_rerun_commands(colorizer=::RSpec::Core::Formatters::ConsoleCodes)
+        rspec_command = running_with_rspec_wrapper? ? "bin/rspec" : "rspec"
+        "\nFailed examples:\n\n" +
+          failed_examples.map do |example|
+            colorizer.wrap("#{rspec_command} #{rerun_argument_for(example)}", RSpec.configuration.failure_color) + " " +
+              colorizer.wrap("# #{example.full_description}",   RSpec.configuration.detail_color)
+          end.join("\n")
+      end
+
+      private
+
+      def running_with_rspec_wrapper?
+        $0 == "bin/rspec"
+      end
+
+      def rerun_argument_for(example)
+        if running_with_rspec_wrapper?
+          location = location_rerun_argument_for_decidim(example)
+        else
+          location = example.location_rerun_argument
+        end
+        return location unless duplicate_rerun_locations.include?(location)
+
+        conditionally_quote(example.id)
+      end
+
+      def location_rerun_argument_for_decidim(example)
+        absolute_file_path = example.metadata[:absolute_file_path]
+        file_path = example.metadata[:file_path][1..-1]
+        module_dir = absolute_file_path.gsub(file_path, "").split("/")[-1]
+
+        "./#{module_dir}#{file_path}:#{example.metadata[:line_number]}"
+      end
+    end
+  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.27.3"
+      "0.27.4"
     end
   end
 end

data/lib/rubocop/cop/decidim/hash_shorthand_syntax_backports.rb

@@ -0,0 +1,175 @@
+# frozen_string_literal: true
+
+#
+# Originally copied from https://github.com/koic/rubocop/blob/master/lib/rubocop/cop/mixin/hash_shorthand_syntax.rb
+# Copyright (c) 2012-22 Bozhidar Batsov
+# MIT License
+#
+
+module RuboCop
+  module Cop
+    # This module checks for Ruby 3.1's hash value omission syntax.
+    #
+    # For using this on Decidim, we have added the Decidim namespace and also the Backports prefix
+    # to the module name
+    module Decidim
+      module HashShorthandSyntaxBackports
+        OMIT_HASH_VALUE_MSG = "Omit the hash value."
+        EXPLICIT_HASH_VALUE_MSG = "Include the hash value."
+        DO_NOT_MIX_MSG_PREFIX = "Do not mix explicit and implicit hash values."
+        DO_NOT_MIX_OMIT_VALUE_MSG = "#{DO_NOT_MIX_MSG_PREFIX} #{OMIT_HASH_VALUE_MSG}".freeze
+        DO_NOT_MIX_EXPLICIT_VALUE_MSG = "#{DO_NOT_MIX_MSG_PREFIX} #{EXPLICIT_HASH_VALUE_MSG}".freeze
+
+        def on_hash_for_mixed_shorthand(hash_node)
+          return if ignore_mixed_hash_shorthand_syntax?(hash_node)
+
+          hash_value_type_breakdown = breakdown_value_types_of_hash(hash_node)
+
+          if hash_with_mixed_shorthand_syntax?(hash_value_type_breakdown)
+            mixed_shorthand_syntax_check(hash_value_type_breakdown)
+          else
+            no_mixed_shorthand_syntax_check(hash_value_type_breakdown)
+          end
+        end
+
+        def on_pair(node)
+          return if ignore_hash_shorthand_syntax?(node)
+
+          hash_key_source = node.key.source
+
+          if enforced_shorthand_syntax == "always"
+            return if node.value_omission? || require_hash_value?(hash_key_source, node)
+
+            message = OMIT_HASH_VALUE_MSG
+            replacement = "#{hash_key_source}:"
+            self.config_to_allow_offenses = { "Enabled" => false }
+          else
+            return unless node.value_omission?
+
+            message = EXPLICIT_HASH_VALUE_MSG
+            replacement = "#{hash_key_source}: #{hash_key_source}"
+          end
+
+          register_offense(node, message, replacement)
+        end
+
+        private
+
+        def register_offense(node, message, replacement)
+          add_offense(node.value, message:) do |corrector|
+            corrector.replace(node, replacement)
+          end
+        end
+
+        def ignore_mixed_hash_shorthand_syntax?(hash_node)
+          target_ruby_version <= 3.0 || enforced_shorthand_syntax != "consistent" ||
+            !hash_node.hash_type?
+        end
+
+        def ignore_hash_shorthand_syntax?(pair_node)
+          target_ruby_version <= 3.0 || enforced_shorthand_syntax == "either" ||
+            enforced_shorthand_syntax == "consistent" ||
+            !pair_node.parent.hash_type?
+        end
+
+        def enforced_shorthand_syntax
+          cop_config.fetch("EnforcedShorthandSyntax", "always")
+        end
+
+        def require_hash_value?(hash_key_source, node)
+          return true if !node.key.sym_type? || require_hash_value_for_around_hash_literal?(node)
+
+          hash_value = node.value
+          return true unless hash_value.send_type? || hash_value.lvar_type?
+
+          hash_key_source != hash_value.source || hash_key_source.end_with?("!", "?")
+        end
+
+        def require_hash_value_for_around_hash_literal?(node)
+          return false unless (ancestor = node.parent.parent)
+          return false if ancestor.send_type? && ancestor.method?(:[])
+
+          !node.parent.braces? && !use_element_of_hash_literal_as_receiver?(ancestor, node.parent) &&
+            (use_modifier_form_without_parenthesized_method_call?(ancestor) ||
+             without_parentheses_call_expr_follows?(ancestor))
+        end
+
+        def use_element_of_hash_literal_as_receiver?(ancestor, parent)
+          # `{value:}.do_something` is a valid syntax.
+          ancestor.send_type? && ancestor.receiver == parent
+        end
+
+        def use_modifier_form_without_parenthesized_method_call?(ancestor)
+          return false if ancestor.respond_to?(:parenthesized?) && ancestor.parenthesized?
+
+          ancestor.ancestors.any? { |node| node.respond_to?(:modifier_form?) && node.modifier_form? }
+        end
+
+        def without_parentheses_call_expr_follows?(ancestor)
+          return false unless ancestor.respond_to?(:parenthesized?) && !ancestor.parenthesized?
+
+          right_sibling = ancestor.right_sibling
+          right_sibling ||= ancestor.each_ancestor.find do |node|
+            node.assignment? || node.send_type?
+          end&.right_sibling
+
+          !!right_sibling
+        end
+
+        def breakdown_value_types_of_hash(hash_node)
+          hash_node.pairs.group_by do |pair_node|
+            if pair_node.value_omission?
+              :value_omitted
+            elsif require_hash_value?(pair_node.key.source, pair_node)
+              :value_needed
+            else
+              :value_omittable
+            end
+          end
+        end
+
+        def hash_with_mixed_shorthand_syntax?(hash_value_type_breakdown)
+          hash_value_type_breakdown.keys.size > 1
+        end
+
+        def hash_with_values_that_cant_be_omitted?(hash_value_type_breakdown)
+          hash_value_type_breakdown[:value_needed]&.any?
+        end
+
+        def each_omitted_value_pair(hash_value_type_breakdown, &)
+          hash_value_type_breakdown[:value_omitted]&.each(&)
+        end
+
+        def each_omittable_value_pair(hash_value_type_breakdown, &)
+          hash_value_type_breakdown[:value_omittable]&.each(&)
+        end
+
+        def mixed_shorthand_syntax_check(hash_value_type_breakdown)
+          if hash_with_values_that_cant_be_omitted?(hash_value_type_breakdown)
+            each_omitted_value_pair(hash_value_type_breakdown) do |pair_node|
+              hash_key_source = pair_node.key.source
+              replacement = "#{hash_key_source}: #{hash_key_source}"
+              register_offense(pair_node, DO_NOT_MIX_EXPLICIT_VALUE_MSG, replacement)
+            end
+          else
+            each_omittable_value_pair(hash_value_type_breakdown) do |pair_node|
+              hash_key_source = pair_node.key.source
+              replacement = "#{hash_key_source}:"
+              register_offense(pair_node, DO_NOT_MIX_OMIT_VALUE_MSG, replacement)
+            end
+          end
+        end
+
+        def no_mixed_shorthand_syntax_check(hash_value_type_breakdown)
+          return if hash_with_values_that_cant_be_omitted?(hash_value_type_breakdown)
+
+          each_omittable_value_pair(hash_value_type_breakdown) do |pair_node|
+            hash_key_source = pair_node.key.source
+            replacement = "#{hash_key_source}:"
+            register_offense(pair_node, OMIT_HASH_VALUE_MSG, replacement)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/decidim.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Rubocop
+  module Cop
+    class Decidim < Base
+      include HashShortandSyntaxBacports
+    end
+  end
+end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: decidim-dev
 version: !ruby/object:Gem::Version
-  version: 0.27.3
+  version: 0.27.4
 platform: ruby
 authors:
 - Josep Jaume Rey Peroy
 - Marc Riera Casals
 - Oriol Gual Oliva
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-11 00:00:00.000000000 Z
+date: 2023-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -32,14 +32,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.27.3
+        version: 0.27.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.27.3
+        version: 0.27.4
 - !ruby/object:Gem::Dependency
   name: factory_bot_rails
   requirement: !ruby/object:Gem::Requirement
@@ -408,15 +408,18 @@ files:
 - app/mailers/decidim/dummy_resources/dummy_resource_mailer.rb
 - app/packs/entrypoints/decidim_dev.js
 - app/packs/entrypoints/decidim_dev.scss
+- app/packs/entrypoints/decidim_dev_test_custom_map.js
 - app/packs/images/decidim/decidim_dev_dummy.svg
 - app/packs/images/decidim/gamification/badges/decidim_gamification_badges_test.svg
 - app/packs/src/decidim/dev/accessibility.js
+- app/packs/src/decidim/dev/test/custom_map_factory.js
 - app/packs/stylesheets/decidim/dev.scss
 - app/packs/stylesheets/decidim/dev/_accessibility.scss
 - app/views/decidim/dummy_resource/_linked_dummys.html.erb
 - app/views/decidim/dummy_resources/dummy_resources/foo.html.erb
 - app/views/decidim/dummy_resources/dummy_resources/show.html.erb
 - config/assets.rb
+- config/environment.rb
 - config/locales/am-ET.yml
 - config/locales/ar-SA.yml
 - config/locales/ar.yml
@@ -588,6 +591,7 @@ files:
 - lib/decidim/dev/test/rspec_support/rake_tasks.rb
 - lib/decidim/dev/test/rspec_support/route_helpers.rb
 - lib/decidim/dev/test/rspec_support/screenshot_helper.rb
+- lib/decidim/dev/test/rspec_support/summary_notification.rb
 - lib/decidim/dev/test/rspec_support/time_helpers.rb
 - lib/decidim/dev/test/rspec_support/timezone.rb
 - lib/decidim/dev/test/rspec_support/translation_helpers.rb
@@ -599,6 +603,8 @@ files:
 - lib/decidim/dev/test/spec_helper.rb
 - lib/decidim/dev/test/w3c_rspec_validators_overrides.rb
 - lib/decidim/dev/version.rb
+- lib/rubocop/cop/decidim.rb
+- lib/rubocop/cop/decidim/hash_shorthand_syntax_backports.rb
 - lib/tasks/generators.rake
 - lib/tasks/lighthouse_report.rake
 - lib/tasks/locale_checker.rake
@@ -606,7 +612,7 @@ homepage: https://github.com/decidim/decidim
 licenses:
 - AGPL-3.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -622,7 +628,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.2.22
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Decidim dev tools
 test_files: []