carwow_rubocop 6.7.0 → 6.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3188042457455f9b00b2eba182c978d7687a7324c02bf2df68dd72a353e5a72
-  data.tar.gz: 15b8d392add3a85e05b87a6acb705d3c1a8cd54f906d7021a5c5a854387a863a
+  metadata.gz: 9ba532ee22497e6dad682fcd4d4c8f452faf929df1ce5284e3fb5b2a1d3e5ab8
+  data.tar.gz: b54f7cc75cf53f47012ffde9f5253c06c33cc959fe6f38c7aed526aff30f990c
 SHA512:
-  metadata.gz: e156ae2a9536b74791994e18aa3e708c9dc083b6018613e696fb564bfb8b0b7aab64a4611b97ab7d9b8149942a975f6846e6a789c4cfa8d8debe10a2e45b8f74
-  data.tar.gz: 7853d1d241b1d1be66719736a202bfb83a68ebb7677e04b5b4775113c29225a233671cb002b98b5e13e007d50b92b9b89ee5be9eaf0acaf5c8c8e9156c50095d
+  metadata.gz: 7f6d34e7a2768754b1b6171aa09dba55b2a3eff404bc93d6039794630f9440c04304615de5ade41d82e58dcefa8f6ff98396053b68a3dee5da6e104746f49084
+  data.tar.gz: 47a4d2cfd627a6fda855df105eb4e6ccc8b246e602badaf823f253c9ddf3952aa6deca294c90c85e9dd1dc3eb1284846291880663dbce6bead17ffb187fa518d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    carwow_rubocop (6.7.0)
+    carwow_rubocop (6.8.0)
       rubocop (>= 1.75)
       rubocop-factory_bot
       rubocop-performance

data/config/rubocop-carwow.yml

@@ -45,3 +45,11 @@ Carwow/NoChangeMatcherWithBrowserAction:
   Include:
     - "**/*_spec.rb"
     - "**/spec/**/*"
+
+Carwow/ProductAreaRequired:
+  Enabled: true
+  Include:
+    - "app/controllers/**/*.rb"
+    - "app/jobs/**/*.rb"
+  Exclude:
+    - "**/concerns/**/*.rb"

data/lib/rubocop/carwow/version.rb

@@ -1,5 +1,5 @@
 module RuboCop
   module Carwow
-    VERSION = '6.7.0'.freeze
+    VERSION = '6.8.0'.freeze
   end
 end

data/lib/rubocop/cop/carwow/product_area_required.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+module RuboCop
+  module Cop
+    module Carwow
+      # Controllers and jobs are attributed to a team via the `product_area` DSL
+      # (CarwowCore::ProductArea::Taggable) so their Honeycomb spans and Bugsnag
+      # errors route to the owning team automatically. A class with no declared
+      # area falls back to manual triage.
+      #
+      # This only checks that `product_area` is called somewhere in the class's
+      # own body — it cannot verify, statically, that a superclass declared in
+      # another file already sets one. Shared base classes that are
+      # intentionally left untagged (e.g. ApplicationController, ApplicationJob,
+      # or a namespaced API base controller) should be added to this cop's
+      # `Exclude` in the consuming app's .rubocop.yml rather than tagged.
+      #
+      # A class nested inside another class (rather than merely inside a
+      # namespacing module) is assumed to be a helper — e.g. a custom error
+      # raised by the enclosing job — not an entry point of its own, so it is
+      # not checked. Only the enclosing class needs the tag.
+      #
+      # A class that subclasses a known Ruby exception (StandardError,
+      # RuntimeError, ...) or whose superclass name ends in `Error`/`Exception`
+      # is never checked, wherever it's defined: exceptions are raised inside
+      # an entry point, not routed to one of their own.
+      #
+      # A class that doesn't look like a controller/job entry point itself (no
+      # Controller/Job-ish superclass, no `include Sidekiq::Worker`/`Sidekiq::Job`,
+      # no `perform` method) is skipped if it sits alongside a sibling class in
+      # the same file/module that already declares `product_area` — a common
+      # pattern for small POROs colocated with the controller/job that uses
+      # them. Two genuinely independent entry points defined in the same file
+      # still both need their own tag.
+      #
+      # @example
+      #   # bad
+      #   class PaymentsController < ApplicationController
+      #   end
+      #
+      #   # good
+      #   class PaymentsController < ApplicationController
+      #     product_area 'smc-payments'
+      #   end
+      #
+      #   # good - nested error class does not need its own tag
+      #   class SyncListing < ApplicationJob
+      #     product_area 'salesforce'
+      #
+      #     class UnknownReference < StandardError; end
+      #   end
+      #
+      #   # good - sibling error class, and sibling PORO helper, do not need their own tag
+      #   module Payments
+      #     class RefundFailed < StandardError; end
+      #
+      #     class RefundsController < ApplicationController
+      #       product_area 'smc-payments'
+      #     end
+      #
+      #     class RefundPresenter
+      #       def initialize(refund); end
+      #     end
+      #   end
+      #
+      class ProductAreaRequired < ::RuboCop::Cop::Base
+        MSG = 'Declare a `product_area` for this class so its Honeycomb spans ' \
+              'and Bugsnag errors route to the owning team.'
+
+        KNOWN_ERROR_SUPERCLASSES = %w[StandardError RuntimeError Exception ScriptError].freeze
+        ERROR_NAME_PATTERN = /Error\z|Exception\z/
+        ENTRY_POINT_SUPERCLASS_PATTERN = /Controller|Job/
+
+        def_node_matcher :product_area_declaration?, <<~PATTERN
+          (send nil? :product_area _)
+        PATTERN
+
+        def_node_matcher :sidekiq_worker_include?, <<~PATTERN
+          (send nil? :include (const (const nil? :Sidekiq) {:Worker :Job}))
+        PATTERN
+
+        def_node_search :defines_perform_method?, <<~PATTERN
+          (def :perform ...)
+        PATTERN
+
+        def on_class(node)
+          return if nested_in_class?(node)
+          return if subclasses_known_error?(node)
+          return if declares_product_area?(node)
+          return if !looks_like_entry_point?(node) && sibling_already_tagged?(node)
+
+          class_node, = *node
+          add_offense(class_node)
+        end
+
+        private
+
+        def nested_in_class?(node)
+          node.each_ancestor(:class).any?
+        end
+
+        def subclasses_known_error?(class_node)
+          _name, superclass, = *class_node
+          return false unless superclass
+
+          superclass_name = superclass.source
+
+          KNOWN_ERROR_SUPERCLASSES.include?(superclass_name) || superclass_name.match?(ERROR_NAME_PATTERN)
+        end
+
+        def declares_product_area?(class_node)
+          top_level_statements(class_node).any? { |stmt| product_area_declaration?(stmt) }
+        end
+
+        def looks_like_entry_point?(class_node)
+          _name, superclass, body = *class_node
+
+          return true if superclass&.source&.match?(ENTRY_POINT_SUPERCLASS_PATTERN)
+
+          statements = top_level_statements(class_node)
+          statements.any? { |stmt| sidekiq_worker_include?(stmt) } || (body && defines_perform_method?(body))
+        end
+
+        def sibling_already_tagged?(class_node)
+          siblings_scope = class_node.each_ancestor(:module, :class, :begin).first || class_node.parent
+          return false unless siblings_scope
+
+          sibling_classes(siblings_scope, class_node).any? { |sibling| declares_product_area?(sibling) }
+        end
+
+        def sibling_classes(scope, exclude)
+          statements = scope.begin_type? ? scope.children : [scope]
+          statements.select { |stmt| stmt&.class_type? && stmt != exclude }
+        end
+
+        def top_level_statements(class_node)
+          body = class_node.body
+          return [] unless body
+
+          body.begin_type? ? body.children : [body]
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: carwow_rubocop
 version: !ruby/object:Gem::Version
-  version: 6.7.0
+  version: 6.8.0
 platform: ruby
 authors:
 - carwow Developers
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-05-15 00:00:00.000000000 Z
+date: 2026-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -172,6 +172,7 @@ files:
 - lib/rubocop/cop/carwow/no_change_matcher_with_browser_action.rb
 - lib/rubocop/cop/carwow/no_stubbing_business_event.rb
 - lib/rubocop/cop/carwow/no_vehicle_brand_model_sideload.rb
+- lib/rubocop/cop/carwow/product_area_required.rb
 homepage: https://github.com/carwow/carwow_rubocop
 licenses:
 - MIT
@@ -192,7 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.5.20
 signing_key:
 specification_version: 4
 summary: carwow's rubocop configuration