rubocop-view_component 0.5.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93f6d112da7bf592a3d0a114d492211798067caea8c8286feee1930d2b56810d
-  data.tar.gz: b5bb3fcbf1e270cff0410dd743145130ba1de2089374c6f4c6b0618037e64e92
+  metadata.gz: fa0434208243f306c17f51b681abdf59f6152d6afdd0014c608c5b4e08e893c2
+  data.tar.gz: e709241be864e024f8ce410b6620d62bcdd12cd090e2593b378c0169a628f1e9
 SHA512:
-  metadata.gz: 92322d18a8ced7cb42d053bbd595e926b11059a49162ae7c7b3e01721397d45b61ca4b00715955b808b1699fa4d8d2ecdc05a68f6f0114e62b32081a92e2b174
-  data.tar.gz: d55bb666487e1782dfce9298d78a920c989c58c6c33fc34a7f47f4bddae52543e05741b1f18da1ecbb2fa847345d09cab01c23ef759958204982ac27ee889f8a
+  metadata.gz: 6d0a9815a58ab3326c9366e7abb2d85cd18e1c87216c731c2fccfeba3d70eae2188856b1c619ba9be2d37c776d463d00efe4f2b7d680998e6e7679b582ab22da
+  data.tar.gz: f195f94ca71e89a4f807a8074ddac30a65462faab27dc01b18f1f58f4a29d85df5699a4dcead7a670e7f311b3fe87816cd49ae98b3813540fa2e4c0707273fc8

data/.rubocop.yml

@@ -1,7 +1,40 @@
 plugins:
   - rubocop-internal_affairs
+  - rubocop-rake
+  - rubocop-rspec
   - rubocop-view_component
 
+inherit_mode:
+  merge:
+    - Exclude
+
+AllCops:
+  TargetRubyVersion: 3.2
+  NewCops: enable
+  SuggestExtensions: false
+  Exclude:
+    - 'verification/**/*'
+    - 'script/verify'
+    - 'spec/fixtures/**/*'
+    - 'gemfiles/**/*'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - '*.gemspec'
+
+RSpec/ExampleLength:
+  Max: 20
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+InternalAffairs/RedundantLetRuboCopConfigNew:
+  Enabled: false
+
 Naming/FileName:
   Exclude:
     - lib/rubocop-view_component.rb

data/Appraisals

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+appraise "rubocop-minimum" do
+  gem "rubocop", "= 1.89.0"
+end

data/CLAUDE.md

@@ -11,7 +11,7 @@ This is a RuboCop extension that enforces ViewComponent best practices. It provi
 ### Testing
 - `rake spec` - Run all RSpec tests
 - `bundle exec rspec spec/rubocop/cop/view_component/FILENAME_spec.rb` - Run a specific spec file
-- `rake standard` - Run Standard (RuboCop) linting
+- `rake rubocop` - Run RuboCop linting
 - `rake` - Run both tests and linting (default task)
 
 ### Verification
@@ -40,8 +40,10 @@ All cops inherit from `RuboCop::Cop::Base` and are located in `lib/rubocop/cop/v
 ### Shared Modules
 
 **`ViewComponent::Base`** (`lib/rubocop/cop/view_component/base.rb`)
-- Provides `view_component_class?(node)` - Detects ViewComponent classes
-- Provides `view_component_parent?(node)` - Checks if inheriting from ViewComponent::Base, ApplicationComponent, or configured parent classes
+- Includes `RuboCop::Cop::ProjectIndexHelp` for rubydex integration
+- Provides `view_component_class?(node)` - Detects ViewComponent classes via ancestry resolution
+- Provides `view_component_parent?(node)` - Checks if inheriting from ViewComponent::Base
+- Provides `view_component_parent_class?(node)` - Checks if a class is an abstract parent (has descendants)
 - Provides `inside_view_component?(node)` - Checks if code is within a ViewComponent
 
 **`TemplateAnalyzer`** (`lib/rubocop/cop/view_component/template_analyzer.rb`)
@@ -50,19 +52,9 @@ All cops inherit from `RuboCop::Cop::Base` and are located in `lib/rubocop/cop/v
 - Handles both sibling templates (`component.html.erb`) and sidecar templates (`component/component.html.erb`)
 - Uses the `herb` gem to parse ERB and extract Ruby code
 
-### Configuration
-
-The `AllCops` config supports `ViewComponentParentClasses` to configure additional base classes beyond `ViewComponent::Base` and `ApplicationComponent`:
-
-```yaml
-AllCops:
-  ViewComponentParentClasses:
-    - MyApp::BaseComponent
-```
-
 ### Verification System
 
-The `script/verify` script downloads real component libraries, runs all ViewComponent cops, and compares results to checked-in snapshots. This catches regressions when cop behavior changes. Libraries are configured in `verification/libraries.yml`, downloaded to `verification/LIBRARY/`, and expected results stored in `spec/expected_LIBRARY_failures.json`.
+The `script/verify` script downloads real component libraries, runs all ViewComponent cops, and compares results to checked-in snapshots. This catches regressions when cop behavior changes. Libraries are configured in `verification/libraries.yml`, downloaded to `verification/LIBRARY/`, and expected results stored in `spec/expected_LIBRARY_failures.yml`.
 
 ## Implementation Notes
 

data/README.md

@@ -16,6 +16,16 @@ Add to your `.rubocop.yml`:
 require:
   - rubocop-view_component
 ```
+**Note:** From v0.7.0 onwards, this gem makes use of [rubydex](https://github.com/Shopify/rubydex) to discover which classes inherit from `ViewComponent::Base`. `UseProjectIndex` is required. Without it, cops that depend on ancestry detection will raise an error.
+
+```yaml
+AllCops:
+  UseProjectIndex: true
+```
+
+If you use a ViewComponent library such as [primer](https://github.com/primer/view_components) then you'll also need to set `ProjectIndexIncludesGems: true` so the cops can resolve ancestry chains that pass through gem classes.
+
+For more background on how RuboCop uses rubydex for cross-file analysis, see [RuboCop 1.89: Project-Wide Analysis with Rubydex](https://metaredux.com/posts/2026/08/05/rubocop-1-89.html).
 
 ## Cops
 
@@ -27,24 +37,25 @@ This gem provides several cops to enforce ViewComponent best practices:
 - **ViewComponent/PreferSlots** - Detect HTML parameters that should be slots
 - **ViewComponent/PreferComposition** - Avoid inheriting one ViewComponent from another (prefer composition)
 - **ViewComponent/TestRenderedOutput** - Encourage testing rendered output over private methods
-- **ViewComponent/MissingPreview** - Ensure every ViewComponent has a corresponding preview file (requires `PreviewPaths` configuration)
+- **ViewComponent/MissingPreview** - Ensure every ViewComponent has a corresponding preview file (requires `PreviewPaths` configuration). Abstract base classes with descendants are automatically exempt.
 
 ## Optional Configuration
 
-### Base Class
+### Components Directory
 
-By default, the cops detect classes that inherit from `ViewComponent::Base` or `ApplicationComponent`. If your project uses a different base class (e.g. `Primer::Component`), you can configure additional parent classes under `AllCops`, for example:
+Several cops (`ComponentSuffix`, `PreferComposition`, `MissingPreview`, `TestRenderedOutput`) default to running only on files under `app/components/`. If your project uses a different path, override `Include` in your `.rubocop.yml`:
 
 ```yaml
 # .rubocop.yml
-AllCops:
-  ViewComponentParentClasses:
-    - MyApp::BaseComponent
+ViewComponent/ComponentSuffix:
+  Include:
+    - 'app/components/**/*.rb'
+    - 'engines/*/app/components/**/*.rb'
 ```
 
 ### No Super
 
-View Component convention is to not calling `super` in component initializers, but that may cause `Lint/MissingSuper` failures from RuboCop. We suggest disabling that rule for your view components directory, for example:
+ViewComponent convention is to not call `super` in component initializers, but that may cause `Lint/MissingSuper` failures from RuboCop. We suggest disabling that rule for your view components directory, for example:
 
 ```yaml
 # .rubocop.yml

data/Rakefile

@@ -1,13 +1,11 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
-require "minitest/test_task"
+require "rubocop/rake_task"
 
-Minitest::TestTask.create
+RuboCop::RakeTask.new
 
-require "standard/rake"
-
-task default: %i[spec standard]
+task default: %i[spec rubocop]
 
 require "rspec/core/rake_task"
 

data/config/default.yml

@@ -1,5 +1,4 @@
 ViewComponent:
-  ViewComponentParentClasses: []
   ComponentNamespaces: []
 
 ViewComponent/ComponentSuffix:
@@ -8,6 +7,8 @@ ViewComponent/ComponentSuffix:
   VersionAdded: '0.1'
   Severity: convention
   StyleGuide: 'https://viewcomponent.org/best_practices.html'
+  Include:
+    - 'app/components/**/*.rb'
 
 ViewComponent/MissingPreview:
   Description: 'Ensure every ViewComponent has a corresponding preview file.'
@@ -52,6 +53,8 @@ ViewComponent/PreferComposition:
   VersionAdded: '0.3'
   Severity: convention
   StyleGuide: 'https://viewcomponent.org/best_practices.html#avoid-inheritance'
+  Include:
+    - 'app/components/**/*.rb'
   ComponentNamespaces: []
 
 ViewComponent/PreferSlots:

data/gemfiles/rubocop_minimum.gemfile

@@ -0,0 +1,13 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "irb"
+gem "rake", "~> 13.4"
+gem "rspec"
+gem "rubocop", "= 1.89.0"
+gem "rubocop-rake"
+gem "rubocop-rspec"
+
+gemspec path: "../"

data/gemfiles/rubocop_minimum.gemfile.lock

@@ -0,0 +1,162 @@
+PATH
+  remote: ..
+  specs:
+    rubocop-view_component (0.6.0)
+      activesupport
+      herb
+      lint_roller (~> 1.1)
+      parser
+      rubocop (>= 1.89.0)
+      rubydex
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (8.1.3.1)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      json
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
+    appraisal (2.5.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    ast (2.4.3)
+    base64 (0.3.0)
+    bigdecimal (4.1.2)
+    concurrent-ruby (1.3.8)
+    connection_pool (3.0.2)
+    diff-lcs (1.6.2)
+    drb (2.2.3)
+    erb (6.0.7)
+    herb (0.10.3)
+    herb (0.10.3-aarch64-linux-gnu)
+    herb (0.10.3-aarch64-linux-musl)
+    herb (0.10.3-arm-linux-gnu)
+    herb (0.10.3-arm-linux-musl)
+    herb (0.10.3-arm64-darwin)
+    herb (0.10.3-x86-linux-gnu)
+    herb (0.10.3-x86-linux-musl)
+    herb (0.10.3-x86_64-darwin)
+    herb (0.10.3-x86_64-linux-gnu)
+    herb (0.10.3-x86_64-linux-musl)
+    i18n (1.15.2)
+      concurrent-ruby (~> 1.0)
+    io-console (0.9.1)
+    irb (1.18.0)
+      pp (>= 0.6.0)
+      prism (>= 1.3.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    json (2.21.2)
+    language_server-protocol (3.17.0.6)
+    lint_roller (1.1.0)
+    logger (1.7.0)
+    minitest (6.0.6)
+      drb (~> 2.0)
+      prism (~> 1.5)
+    parallel (1.28.0)
+    parser (3.3.12.0)
+      ast (~> 2.4.1)
+      racc
+    pp (0.6.4)
+      prettyprint
+    prettyprint (0.2.0)
+    prism (1.9.0)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.4.2)
+    rbs (4.1.2)
+      logger
+      prism (>= 1.6.0)
+      tsort
+    rdoc (8.0.0)
+      erb
+      prism (>= 1.6.0)
+      rbs (>= 4.0.0)
+      tsort
+    regexp_parser (2.12.0)
+    reline (0.7.0)
+      io-console (~> 0.5)
+    rspec (3.13.2)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.6)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.8)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.7)
+    rubocop (1.89.0)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (>= 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.49.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.50.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.7)
+    rubocop-rake (0.7.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.72.1)
+    rubocop-rspec (3.7.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+    ruby-progressbar (1.13.0)
+    rubydex (0.3.0)
+    rubydex (0.3.0-aarch64-linux)
+    rubydex (0.3.0-arm64-darwin)
+    rubydex (0.3.0-x86_64-darwin)
+    rubydex (0.3.0-x86_64-linux)
+    securerandom (0.4.1)
+    thor (1.5.0)
+    tsort (0.2.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.2.0)
+    uri (1.1.1)
+
+PLATFORMS
+  aarch64-linux-gnu
+  aarch64-linux-musl
+  arm-linux-gnu
+  arm-linux-musl
+  arm64-darwin
+  ruby
+  x86-linux-gnu
+  x86-linux-musl
+  x86_64-darwin
+  x86_64-linux-gnu
+  x86_64-linux-musl
+
+DEPENDENCIES
+  appraisal
+  irb
+  rake (~> 13.4)
+  rspec
+  rubocop (= 1.89.0)
+  rubocop-rake
+  rubocop-rspec
+  rubocop-view_component!
+
+BUNDLED WITH
+   2.7.2

data/lib/rubocop/cop/view_component/base.rb

@@ -1,33 +1,64 @@
 # frozen_string_literal: true
 
+require "rubydex"
+
 module RuboCop
   module Cop
     module ViewComponent
-      # Shared helper methods for ViewComponent cops
+      # Shared helper methods for ViewComponent cops.
+      # Requires rubydex with UseProjectIndex: true for ancestry resolution.
       module Base
-        # Check if a class node inherits from ViewComponent::Base or ApplicationComponent
+        include ProjectIndexHelp
+
+        VC_BASE = "ViewComponent::Base"
+
+        # Check if a class node inherits from ViewComponent::Base
         def view_component_class?(node)
           return false unless node&.class_type?
 
-          class_source = node.identifier.source
+          class_source = fully_qualified_name(node)
           return true if component_namespaces.any? { |ns| class_source.start_with?(ns) }
 
+          require_project_index!
+
           parent_class = node.parent_class
           return false unless parent_class
 
           view_component_parent?(parent_class)
         end
 
-        # Check if node represents ViewComponent::Base, ApplicationComponent,
-        # or a configured additional parent class
+        # Check if a constant node resolves to a class with ViewComponent::Base as ancestor
         def view_component_parent?(node)
           return false unless node.const_type?
 
-          source = node.source
-          return true if source == "ViewComponent::Base" || source == "ApplicationComponent"
+          require_project_index!
+
+          declaration = resolve_constant_in_index(node)
+          return false unless declaration.respond_to?(:has_ancestor?)
+
+          declaration.name == VC_BASE || declaration.has_ancestor?(VC_BASE)
+        end
+
+        # Check if a class node is itself an abstract parent class
+        # (has ViewComponent::Base as ancestor and has descendants in the project)
+        def view_component_parent_class?(node)
+          return false unless node&.class_type?
+
+          require_project_index!
+
+          declaration = resolve_constant_in_index(node.identifier)
+          return false unless declaration.respond_to?(:has_ancestor?)
+
+          declaration.has_ancestor?(VC_BASE) &&
+            declaration.descendants.any? { |d| d.name != declaration.name }
+        end
+
+        def fully_qualified_name(node)
+          namespace = node.parent_module_name
+          short_name = node.identifier.source
+          return short_name if namespace.nil? || namespace == "Object"
 
-          additional = cop_config["ViewComponentParentClasses"] || []
-          additional.include?(source)
+          "#{namespace}::#{short_name}"
         end
 
         def component_namespaces
@@ -41,11 +72,22 @@ module RuboCop
 
         # Check if node is within a ViewComponent class
         def inside_view_component?(node)
+          require_project_index!
+
           klass = enclosing_class(node)
           return false unless klass
 
           view_component_class?(klass)
         end
+
+        def require_project_index!
+          return if project_index
+
+          raise <<~MSG
+            ViewComponent cops require `AllCops/UseProjectIndex: true` in your .rubocop.yml
+            for ancestry-based class detection.
+          MSG
+        end
       end
     end
   end

data/lib/rubocop/cop/view_component/missing_preview.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "active_support/inflector"
+
 module RuboCop
   module Cop
     module ViewComponent
@@ -15,8 +17,9 @@ module RuboCop
 
         def on_class(node)
           return unless view_component_class?(node)
+          return if view_component_parent_class?(node)
 
-          class_name = node.identifier.source
+          class_name = fully_qualified_name(node)
           return if preview_exists?(class_name)
 
           add_offense(node.identifier, message: format(MSG, component: class_name, paths: preview_paths.join(", ")))
@@ -33,12 +36,11 @@ module RuboCop
         end
 
         def candidate_filenames(class_name)
-          base = class_name.gsub(/Component$/, "").gsub("::", "/").gsub(/([A-Z])/, '_\1').downcase.gsub("/_", "/")
-          base = base.delete_prefix("_").delete_prefix("/")
-          [
-            "#{base}_preview.rb",
-            "#{base}_component_preview.rb"
-          ]
+          bases = [ActiveSupport::Inflector.underscore(class_name.delete_suffix("Component"))]
+          short_name = class_name.split("::").last
+          short_base = ActiveSupport::Inflector.underscore(short_name.delete_suffix("Component"))
+          bases << short_base if short_base != bases.first
+          bases.flat_map { |base| ["#{base}_preview.rb", "#{base}_component_preview.rb"] }
         end
 
         def preview_paths

data/lib/rubocop/cop/view_component/no_global_state.rb

@@ -45,18 +45,32 @@ module RuboCop
 
         RESTRICT_ON_SEND = GLOBAL_STATE_METHODS
 
+        # @!method global_state_access?(node)
         def_node_matcher :global_state_access?, <<~PATTERN
           (send nil? ${:params :request :session :cookies :flash} ...)
         PATTERN
 
+        # @!method sorbet_sig_block?(node)
+        def_node_matcher :sorbet_sig_block?, <<~PATTERN
+          (block (send nil? :sig) ...)
+        PATTERN
+
         def on_send(node)
           return unless inside_view_component?(node)
 
           method_name = global_state_access?(node)
           return unless method_name
+          return if sorbet_signature?(node)
 
           add_offense(node, message: format(MSG, method: method_name))
         end
+        alias on_csend on_send
+
+        private
+
+        def sorbet_signature?(node)
+          node.each_ancestor(:block).any? { |ancestor| sorbet_sig_block?(ancestor) }
+        end
       end
     end
   end

data/lib/rubocop/cop/view_component/prefer_private_methods.rb

@@ -40,29 +40,32 @@ module RuboCop
         private
 
         def check_public_methods(class_node)
-          current_visibility = :public
-          template_method_calls = methods_called_in_templates
-
           body = class_node.body
           return unless body
 
           children = body.begin_type? ? body.children : [body]
+          check_children(children, methods_called_in_templates)
+        end
+
+        def check_children(children, template_method_calls)
+          current_visibility = :public
 
           children.each do |child|
             if visibility_modifier?(child)
               current_visibility = child.method_name
-              next
+            elsif should_flag?(child, current_visibility, template_method_calls)
+              add_offense(child, message: format(MSG, method_name: child.method_name))
             end
-
-            next unless child.def_type?
-            next unless current_visibility == :public
-            next if allowed_public_method?(child.method_name)
-            next if template_method_calls.include?(child.method_name)
-
-            add_offense(child, message: format(MSG, method_name: child.method_name))
           end
         end
 
+        def should_flag?(child, visibility, template_method_calls)
+          child.def_type? &&
+            visibility == :public &&
+            !allowed_public_method?(child.method_name) &&
+            !template_method_calls.include?(child.method_name)
+        end
+
         def allowed_public_method?(method_name)
           allowed_public_methods.include?(method_name.to_s) ||
             allowed_public_method_patterns.any? { |pattern| method_name.to_s.match?(pattern) }
@@ -84,8 +87,7 @@ module RuboCop
           template_paths.each_with_object(Set.new) do |path, methods|
             methods.merge(extract_method_calls(path))
           end
-        rescue => e
-          # Graceful degradation on errors
+        rescue StandardError => e
           warn "Warning: Failed to analyze templates: #{e.message}" if ENV["RUBOCOP_DEBUG"]
           Set.new
         end

data/lib/rubocop/cop/view_component/prefer_slots.rb

@@ -31,6 +31,7 @@ module RuboCop
 
         HTML_PARAM_PATTERN = /_html$/
 
+        # @!method html_safe_call?(node)
         def_node_search :html_safe_call?, "(send _ :html_safe)"
 
         def on_class(node)
@@ -46,29 +47,23 @@ module RuboCop
 
         def find_initialize(class_node)
           class_node.each_descendant(:def).find do |def_node|
-            def_node.method_name == :initialize
+            def_node.method?(:initialize)
           end
         end
 
         def check_initialize_params(initialize_node)
           initialize_node.arguments.each do |arg|
-            next unless arg.kwoptarg_type? || arg.kwarg_type?
+            next unless arg.type?(:kwoptarg, :kwarg)
 
-            param_name = arg.children[0]
+            check_param(arg)
+          end
+        end
 
-            # Check parameter name patterns
-            if html_param_name?(param_name)
-              suggested_slot = suggest_slot_name(param_name)
-              add_offense(arg, message: format(MSG, slot_method: suggested_slot))
-              next
-            end
+        def check_param(arg)
+          param_name = arg.children[0]
+          return unless html_param_name?(param_name) || (arg.kwoptarg_type? && html_safe_call?(arg))
 
-            # Check for html_safe in default value
-            if arg.kwoptarg_type? && html_safe_call?(arg)
-              suggested_slot = suggest_slot_name(param_name)
-              add_offense(arg, message: format(MSG, slot_method: suggested_slot))
-            end
-          end
+          add_offense(arg, message: format(MSG, slot_method: suggest_slot_name(param_name)))
         end
 
         def html_param_name?(name)