rubocop-openproject 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6399b37d75f31159de26fc061439ab6107f3621da14770ab2e3f4a263e4748e
-  data.tar.gz: c0bc045863a214c19a10fe29e4b23edd6d60f3598158f665fdfb4fefba851946
+  metadata.gz: 773446caa5319de0f293fec551495d72a218b7613cf7ec376eb1c24197bd7fa9
+  data.tar.gz: e9e120a7042a5ea1030132e5cf1061b49d5e63d90745bd6bf7ba45eab3ceef12
 SHA512:
-  metadata.gz: 5089a09294d79954f16b4fe511fd6b3aabe57b9272ebf41fa4a376feb7a6fcf8c2872b072fd6e3c7eb8493484e0e5b3eb2dc88f2bbfb964fa5fb67f0cdd8e5d8
-  data.tar.gz: 46759bc28c398aeefb4fb18305dd9494056a5296a859bb7789d4c37548b785a935a254f0cfcc98442cccceeb70fc5a788113316b3c58707dc0172506ab6462e0
+  metadata.gz: a953526a473bf41eb3bc64dea310dee30a82afadc8a161a682b5fefe220586d7ebc95c824298ba04394fed90602b0c02f2348b7a82655c0f27c6fed5222a24b8
+  data.tar.gz: 3a7d2453f0b72a95dbbd67d5da315774fc4fd877b091ddb3e28d407f66ef413f5c16467d91b8b6c96440e51f14fb6eec4992ad61ac96f5176a68ade1161a59e3

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 # rubocop-openproject
 
+## 0.8.0
+
+### Minor Changes
+
+- cb825c6: Add `OpenProject/NoConditionalPatchGemVersion` cop to catch `patch_gem_version` calls wrapped in a
+  condition. The version check inside `patch_gem_version` is what makes the application fail to boot
+  on CI when a patched gem is upgraded. The OpenTelemetry grape patch was guarded by
+  `defined?(OpenTelemetry::Instrumentation::Grape::EventHandler)`, which is only defined when
+  OpenTelemetry is enabled, so CI skipped the check and the gem upgrade went unnoticed. Conditions
+  belong inside the block, around the patch itself.
+
+## 0.7.1
+
+### Patch Changes
+
+- 2e41102: Widen `OpenProject/UseEffectiveTypeForConfiguration` to catch safe navigation and the derived
+  pattern readers. The cop only defined `on_send`, so `represented.type&.attribute_groups` parsed
+  as a `csend` and slipped through entirely — which is how the whole work package schema
+  representer read its form configuration off the root while the cop was enabled. Both sides of
+  the call are now matched as `send` or `csend`. `enabled_patterns` and
+  `replacement_pattern_defined_for?` join `CONFIGURATION_METHODS`: both resolve through
+  `patterns`, which a variant can own independently, so they are as variant-specific as the
+  aspect readers already listed.
+
+  Expect new offenses in consumers wherever a configuration aspect was read off `type` with `&.`.
+
 ## 0.7.0
 
 ### Minor Changes

data/config/default.yml

@@ -8,6 +8,11 @@ OpenProject/NoDoEndBlockWithRSpecCapybaraMatcherInExpect:
   Enabled: true
   VersionAdded: '0.1.0'
 
+OpenProject/NoConditionalPatchGemVersion:
+  Description: 'Call `patch_gem_version` unconditionally so its version check runs on CI.'
+  Enabled: true
+  VersionAdded: '0.8.0'
+
 OpenProject/NoNotImplementedError:
   Description: 'Do not raise `NotImplementedError` to signal an unimplemented abstract method.'
   Enabled: true

data/lib/rubocop/cop/open_project/no_conditional_patch_gem_version.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module OpenProject
+      # Checks that `patch_gem_version` is not wrapped in a condition.
+      #
+      # `patch_gem_version` raises when the patched gem is newer than the version the
+      # patch was written for, which makes the application fail to boot on CI after a
+      # gem upgrade. A condition around the call (e.g. `defined?` on a constant of a
+      # gem that is only required in production) skips that version check as well,
+      # so an outdated patch goes unnoticed. Move the condition inside the block.
+      #
+      # @example
+      #   # bad
+      #   if defined?(SomeGem::Thing)
+      #     OpenProject::Patches.patch_gem_version "some-gem", "1.2.3" do
+      #       SomeGem::Thing.prepend Patch
+      #     end
+      #   end
+      #
+      #   # bad
+      #   OpenProject::Patches.patch_gem_version("some-gem", "1.2.3") { apply } if Rails.env.local?
+      #
+      #   # good
+      #   OpenProject::Patches.patch_gem_version "some-gem", "1.2.3" do
+      #     SomeGem::Thing.prepend Patch if defined?(SomeGem::Thing)
+      #   end
+      #
+      class NoConditionalPatchGemVersion < Base
+        MSG = "`patch_gem_version` must run unconditionally so CI catches gem upgrades. " \
+              "Move the condition inside the block."
+
+        RESTRICT_ON_SEND = %i[patch_gem_version].freeze
+
+        def on_send(node)
+          return unless node.each_ancestor(:if, :case, :and, :or).any?
+
+          add_offense(node)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/open_project/use_effective_type_for_configuration.rb

@@ -34,6 +34,10 @@ module RuboCop
       #   # bad — inside WorkPackage itself
       #   type.statuses(include_default: true)
       #
+      #   # bad — safe navigation on either side reads the root just the same
+      #   represented.type&.attribute_groups
+      #   model&.type.enabled_patterns
+      #
       #   # good
       #   work_package.effective_type.attribute_groups
       #
@@ -51,7 +55,9 @@ module RuboCop
               "the family's root, so this ignores the variant the project resolves to."
 
         # Configuration aspects, per Type::ConfigurationLink::ASPECTS and the readers
-        # Type::ConfigurationLinkable resolves through the link chain.
+        # Type::ConfigurationLinkable resolves through the link chain, plus the derived readers
+        # that sit on top of one — `enabled_patterns` and `replacement_pattern_defined_for?`
+        # both resolve through `patterns` and are just as variant-specific.
         CONFIGURATION_METHODS = %i[
           artefact_export_enabled?
           artefact_export_mode
@@ -59,18 +65,22 @@ module RuboCop
           custom_field_ids
           custom_fields
           description
+          enabled_patterns
           export_templates_disabled
           export_templates_order
           patterns
           project_custom_field_type_mappings
+          replacement_pattern_defined_for?
           statuses
           workflows
         ].freeze
 
         RESTRICT_ON_SEND = CONFIGURATION_METHODS
 
+        # Both node types on both sides: `type&.attribute_groups` reads the root exactly like
+        # `type.attribute_groups` does, and the mistake is written with `&.` at least as often.
         def_node_matcher :type_call?, <<~PATTERN
-          (send _ :type)
+          ({send csend} _ :type)
         PATTERN
 
         def on_send(node)
@@ -78,6 +88,7 @@ module RuboCop
 
           add_offense(node)
         end
+        alias on_csend on_send
       end
     end
   end

data/lib/rubocop/cop/open_project_cops.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "open_project/add_preview_for_view_component"
+require_relative "open_project/no_conditional_patch_gem_version"
 require_relative "open_project/no_not_implemented_error"
 require_relative "open_project/no_params_in_work_package_where_id"
 require_relative "open_project/use_service_result_factory_methods"

data/lib/rubocop/open_project/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module OpenProject
-    VERSION = "0.7.0"
+    VERSION = "0.8.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-openproject
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - OpenProject GmbH
@@ -40,6 +40,7 @@ files:
 - config/default.yml
 - lib/rubocop-openproject.rb
 - lib/rubocop/cop/open_project/add_preview_for_view_component.rb
+- lib/rubocop/cop/open_project/no_conditional_patch_gem_version.rb
 - lib/rubocop/cop/open_project/no_not_implemented_error.rb
 - lib/rubocop/cop/open_project/no_params_in_work_package_where_id.rb
 - lib/rubocop/cop/open_project/no_sleep_in_feature_specs.rb