rubocop-openproject 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 821ee2f0425e32049c380dd582471e37feb47c8565b1a8b05e2746809e498993
-  data.tar.gz: b8c1b464b25dbb3f0c07dcd5d7f20fd8bd331b91565f31782c7d27920a6148be
+  metadata.gz: b6399b37d75f31159de26fc061439ab6107f3621da14770ab2e3f4a263e4748e
+  data.tar.gz: c0bc045863a214c19a10fe29e4b23edd6d60f3598158f665fdfb4fefba851946
 SHA512:
-  metadata.gz: 20ea7aec95cb84472a6e145dfc71e31a542a3cda8e6a126ea5f6adf8832c6852aff30d506c624bb930fca6ef4a2fb324ecf777b88a2afb3d7d9e2e227c7a436e
-  data.tar.gz: 240bcf2a89496e23e73ca909171b754eb92e417bb86d67c07cf3dc2415ca1404879d59fabff2c829bec58d40484b8c49e833a719749c95a2b1b1828b5b0de294
+  metadata.gz: 5089a09294d79954f16b4fe511fd6b3aabe57b9272ebf41fa4a376feb7a6fcf8c2872b072fd6e3c7eb8493484e0e5b3eb2dc88f2bbfb964fa5fb67f0cdd8e5d8
+  data.tar.gz: 46759bc28c398aeefb4fb18305dd9494056a5296a859bb7789d4c37548b785a935a254f0cfcc98442cccceeb70fc5a788113316b3c58707dc0172506ab6462e0

data/.ruby-version

@@ -1 +1 @@
-4.0.2
+4.0.6

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # rubocop-openproject
 
+## 0.7.0
+
+### Minor Changes
+
+- ad3ff98: Add `OpenProject/UseEffectiveTypeForConfiguration` cop to catch reading a type's
+  configuration off `#type` instead of `#effective_type`. A work package stores the root of its
+  type family while its project may resolve that family to a variant configured differently, so
+  reading an aspect (form configuration, workflows, custom fields, defaults, export templates)
+  off the stored type silently answers with the root's configuration. The failure is quiet — a
+  project running the root behaves correctly, so a spec written without a variant passes while
+  the feature is broken wherever a variant is resolved. Inherited core settings (`name`,
+  `color`, `is_milestone`, `is_in_roadmap`) are read from the root by design and are not flagged.
+
 ## 0.6.0
 
 ### Minor Changes

data/config/default.yml

@@ -23,6 +23,11 @@ OpenProject/NoSleepInFeatureSpecs:
   Enabled: true
   VersionAdded: '0.1.0'
 
+OpenProject/UseEffectiveTypeForConfiguration:
+  Description: 'Read a type''s configuration through `effective_type`, not `type`, so the project''s variant is honoured.'
+  Enabled: true
+  VersionAdded: '0.7.0'
+
 OpenProject/UseRenderModeInsteadOfPrimitives:
   Description: 'Use `render_mode:` instead of `static_html:`/`plain_text:`/`only_path:` on `format_text`.'
   Enabled: true

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

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module OpenProject
+      # Flags reading a type's configuration off `#type` rather than `#effective_type`.
+      #
+      # A work package stores the root of its type family, while the project it lives in may
+      # resolve that family to a variant configured differently — a different form
+      # configuration, workflow, set of custom fields, defaults or export templates. Reading a
+      # configuration aspect off the stored type therefore answers with the root's
+      # configuration and silently ignores the variant.
+      #
+      # The failure mode is quiet: a project running the root behaves correctly, so a spec
+      # written without a variant passes while the feature is broken for every project that
+      # resolves one. That is what this cop is here to catch.
+      #
+      # Only configuration aspects are flagged. `name`, `color`, `is_milestone` and
+      # `is_in_roadmap` are inherited from the root by design, so reading those off `#type` is
+      # correct and left alone.
+      #
+      # Deliberately narrow: it fires when the receiver is literally a `type` call, which is
+      # the shape the mistake takes in practice. Administration code holding an explicit type
+      # (`@type.attribute_groups`) is reading that member's own configuration on purpose and is
+      # not flagged, and neither is a type held in a local variable.
+      #
+      # @example
+      #   # bad
+      #   work_package.type.attribute_groups
+      #
+      #   # bad
+      #   work_package.type.custom_fields
+      #
+      #   # bad — inside WorkPackage itself
+      #   type.statuses(include_default: true)
+      #
+      #   # good
+      #   work_package.effective_type.attribute_groups
+      #
+      #   # good — when there is no work package to ask
+      #   project.effective_type(type).attribute_groups
+      #
+      #   # good — inherited from the root by design
+      #   work_package.type.name
+      #   work_package.type.is_milestone?
+      #
+      #   # good — administration reads a specific member's own configuration
+      #   @type.attribute_groups
+      class UseEffectiveTypeForConfiguration < Base
+        MSG = "Read configuration through `effective_type`, not `type` — the stored type is " \
+              "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.
+        CONFIGURATION_METHODS = %i[
+          artefact_export_enabled?
+          artefact_export_mode
+          attribute_groups
+          custom_field_ids
+          custom_fields
+          description
+          export_templates_disabled
+          export_templates_order
+          patterns
+          project_custom_field_type_mappings
+          statuses
+          workflows
+        ].freeze
+
+        RESTRICT_ON_SEND = CONFIGURATION_METHODS
+
+        def_node_matcher :type_call?, <<~PATTERN
+          (send _ :type)
+        PATTERN
+
+        def on_send(node)
+          return unless type_call?(node.receiver)
+
+          add_offense(node)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/open_project_cops.rb

@@ -5,4 +5,5 @@ 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"
 require_relative "open_project/no_sleep_in_feature_specs"
+require_relative "open_project/use_effective_type_for_configuration"
 require_relative "open_project/use_render_mode_instead_of_primitives"

data/lib/rubocop/open_project/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-openproject
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - OpenProject GmbH
@@ -43,6 +43,7 @@ files:
 - 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
+- lib/rubocop/cop/open_project/use_effective_type_for_configuration.rb
 - lib/rubocop/cop/open_project/use_render_mode_instead_of_primitives.rb
 - lib/rubocop/cop/open_project/use_service_result_factory_methods.rb
 - lib/rubocop/cop/open_project_cops.rb
@@ -71,7 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.6
+rubygems_version: 4.0.16
 specification_version: 4
 summary: RuboCop cops for OpenProject
 test_files: []