rubocop-openproject 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ddc09cf55b857f7ce9d1f944be04ad89fca8733ed2ee571e7a21e61ee0b93531
-  data.tar.gz: 597940571a0def133a1e4c22ba02fc5f277b4e69b43e72be0ae8e63ad2b3959b
+  metadata.gz: 773446caa5319de0f293fec551495d72a218b7613cf7ec376eb1c24197bd7fa9
+  data.tar.gz: e9e120a7042a5ea1030132e5cf1061b49d5e63d90745bd6bf7ba45eab3ceef12
 SHA512:
-  metadata.gz: 7b4b3c182974ae3030781217c2a1c37abdff29b21398a1b9644806c36d55b81ec6ec1d22af6d7e44dead45a5ce3950d394a73ab361d15c15834562a67a443296
-  data.tar.gz: cefcaa216a26645a8ca75e6caedae544462cd411bd5b298d0d80b24e0502680075c5bf3ad4bf4b8e3e8d3054ab416c14408b87af9a841eb3950656e488ef3aef
+  metadata.gz: a953526a473bf41eb3bc64dea310dee30a82afadc8a161a682b5fefe220586d7ebc95c824298ba04394fed90602b0c02f2348b7a82655c0f27c6fed5222a24b8
+  data.tar.gz: 3a7d2453f0b72a95dbbd67d5da315774fc4fd877b091ddb3e28d407f66ef413f5c16467d91b8b6c96440e51f14fb6eec4992ad61ac96f5176a68ade1161a59e3

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # 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

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_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.1"
+    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.1
+  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