rubocop-view_component 0.5.1 → 0.7.0

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

@@ -16,26 +16,26 @@ module RuboCop
           base_path = component_path.sub(/\.rb$/, "")
           component_dir = File.dirname(component_path)
           component_name = File.basename(component_path, ".rb")
+          sidecar_dir = File.join(component_dir, component_name)
 
-          paths = []
-
-          # Check for sibling template: same_name.html.erb
-          sibling_template = "#{base_path}.html.erb"
-          paths << sibling_template if File.exist?(sibling_template)
-
-          # Check for sidecar template: same_name/same_name.html.erb
-          sidecar_template = File.join(component_dir, component_name, "#{component_name}.html.erb")
-          paths << sidecar_template if File.exist?(sidecar_template)
-
-          # Check for variants: same_name.*.html.erb
-          variant_pattern = "#{base_path}.*.html.erb"
-          paths.concat(Dir.glob(variant_pattern))
+          paths = sibling_templates(base_path) + sidecar_templates(sidecar_dir, component_name)
+          paths.uniq
+        end
 
-          # Check for sidecar variants: same_name/same_name.*.html.erb
-          sidecar_variant_pattern = File.join(component_dir, component_name, "#{component_name}.*.html.erb")
-          paths.concat(Dir.glob(sidecar_variant_pattern))
+        def sibling_templates(base_path)
+          paths = []
+          sibling = "#{base_path}.html.erb"
+          paths << sibling if File.exist?(sibling)
+          paths.concat(Dir.glob("#{base_path}.*.html.erb"))
+          paths
+        end
 
-          paths.uniq
+        def sidecar_templates(sidecar_dir, component_name)
+          paths = []
+          sidecar = File.join(sidecar_dir, "#{component_name}.html.erb")
+          paths << sidecar if File.exist?(sidecar)
+          paths.concat(Dir.glob(File.join(sidecar_dir, "#{component_name}.*.html.erb")))
+          paths
         end
 
         # Extract method calls from an ERB template
@@ -49,7 +49,7 @@ module RuboCop
 
           # Parse the extracted Ruby code
           parse_ruby_for_method_calls(ruby_code)
-        rescue => e
+        rescue StandardError => e
           # Graceful degradation on parse errors
           warn "Warning: Failed to parse template #{template_path}: #{e.message}" if ENV["RUBOCOP_DEBUG"]
           Set.new
@@ -78,7 +78,7 @@ module RuboCop
           return unless node.respond_to?(:type)
 
           # Look for send nodes with nil receiver (local method calls)
-          if node.type == :send && node.receiver.nil?
+          if node.send_type? && node.receiver.nil?
             method_name = node.method_name
             method_calls.add(method_name)
           end

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

@@ -28,6 +28,7 @@ module RuboCop
         # Check Minitest-style test methods
         def on_def(node)
           return unless within_test_paths?
+
           method_name = node.method_name.to_s
           return unless method_name.start_with?("test_")
           return unless instantiates_component?(node)
@@ -45,6 +46,8 @@ module RuboCop
 
           add_offense(node)
         end
+        alias on_numblock on_block
+        alias on_itblock on_block
 
         private
 
@@ -58,7 +61,7 @@ module RuboCop
 
         def instantiates_component?(node)
           node.each_descendant(:send).any? do |send_node|
-            next unless send_node.method_name == :new
+            next unless send_node.method?(:new)
 
             send_node.receiver&.const_type?
           end

data/lib/rubocop/view_component/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module ViewComponent
-    VERSION = "0.5.1"
+    VERSION = "0.7.0"
   end
 end

data/script/verify

@@ -68,8 +68,8 @@ def parse_library_arg(libraries)
   library_arg = ARGV.find { |arg| !arg.start_with?("--") }
 
   if library_arg.nil?
-    abort "Usage: #{$PROGRAM_NAME} <library> [--regenerate] [--update]\n" \
-          "  library: #{libraries.keys.join(", ")}"
+    abort "Usage: #{$PROGRAM_NAME} <library> [--regenerate] [--update]\n  " \
+          "library: #{libraries.keys.join(", ")}"
   end
 
   unless libraries.key?(library_arg)
@@ -79,8 +79,8 @@ def parse_library_arg(libraries)
   library_arg
 end
 
-def system!(*args)
-  system(*args, exception: true)
+def system!(*)
+  system(*, exception: true)
 end
 
 def download_source(dir, tarball_url, display_name)
@@ -97,10 +97,10 @@ def configure_rubocop(config_file, display_name)
   # Merge the library config into the existing config
   library_config.each do |key, value|
     config[key] = if config[key].is_a?(Hash) && value.is_a?(Hash)
-      config[key].merge(value)
-    else
-      value
-    end
+                    config[key].merge(value)
+                  else
+                    value
+                  end
   end
 
   File.write(".rubocop.yml", YAML.dump(config))
@@ -112,22 +112,23 @@ def add_gem_to_gemfile
 end
 
 def run_rubocop
+  FileUtils.rm_f("Gemfile.lock")
   puts "Running bundle install..."
-  system!("bundle", "install")
+  system!({ "BUNDLE_WITHOUT" => "development" }, "bundle", "install")
+  system!("bundle", "add", "rubocop")
 
   puts "Running RuboCop (ViewComponent cops only)..."
   output, status = Open3.capture2(
     "bundle", "exec", "rubocop",
-    "--require", "rubocop-view_component",
+    "--plugin", "rubocop-view_component",
     "--only", "ViewComponent",
+    "--config", ".rubocop.yml",
     "--format", "json"
   )
 
   puts "RuboCop exit status: #{status.exitstatus}"
 
-  if output.strip.empty?
-    abort "ERROR: RuboCop produced no output (exit status: #{status.exitstatus})"
-  end
+  abort "ERROR: RuboCop produced no output (exit status: #{status.exitstatus})" if output.strip.empty?
 
   output
 end
@@ -166,11 +167,9 @@ def load_expected(results_file)
 end
 
 def verify(offenses, results_file)
-  unless File.exist?(results_file)
-    abort "ERROR: #{results_file} not found. Run '#{$PROGRAM_NAME} --regenerate' first."
-  end
+  abort "ERROR: #{results_file} not found. Run '#{$PROGRAM_NAME} --regenerate' first." unless File.exist?(results_file)
 
-  expected = load_expected(results_file)
+  expected = load_expected(results_file) || {}
 
   if offenses == expected
     puts "Verification passed: output matches #{results_file}"

data/spec/expected_govuk_failures.yml

@@ -7,10 +7,12 @@ ViewComponent/ComponentSuffix:
   - 'app/components/govuk_component/notification_banner_component.rb'
   - 'app/components/govuk_component/pagination_component/adjacent_page.rb'
   - 'app/components/govuk_component/pagination_component/item.rb'
+  - 'app/components/govuk_component/panel_component.rb'
   - 'app/components/govuk_component/tab_component.rb'
 ViewComponent/PreferPrivateMethods:
   - 'app/components/govuk_component/base.rb'
   - 'app/components/govuk_component/notification_banner_component.rb'
+  - 'app/components/govuk_component/panel_component.rb'
   - 'app/components/govuk_component/service_navigation_component.rb'
   - 'app/components/govuk_component/tab_component.rb'
 ViewComponent/TestRenderedOutput:

data/spec/expected_polaris_failures.yml

@@ -22,7 +22,6 @@ ViewComponent/MissingPreview:
   - 'app/components/polaris/placeholder_component.rb'
   - 'app/components/polaris/shopify_navigation_component.rb'
   - 'app/components/polaris/text_field_component.rb'
-  - 'app/components/polaris/toast_component.rb'
 ViewComponent/NoGlobalState:
   - 'app/components/polaris/shopify_navigation_component.rb'
 ViewComponent/PreferPrivateMethods:

data/spec/expected_primer_failures.yml

@@ -15,5 +15,8 @@ ViewComponent/PreferPrivateMethods:
   - 'app/components/primer/alpha/tree_view/node.rb'
   - 'app/components/primer/beta/avatar.rb'
   - 'app/components/primer/beta/nav_list.rb'
+  - 'app/components/primer/beta/nav_list/divider.rb'
+  - 'app/components/primer/beta/nav_list/group.rb'
+  - 'app/components/primer/beta/nav_list/item.rb'
 ViewComponent/TestRenderedOutput:
   - 'test/components/alpha/action_list_test.rb'

data/spec/rubocop/cop/view_component/base_spec.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+RSpec.describe RuboCop::Cop::ViewComponent::Base do
+  let(:cop_class) { RuboCop::Cop::ViewComponent::ComponentSuffix }
+  let(:cop) { cop_class.new(RuboCop::Config.new) }
+
+  before do
+    cop.project_index = nil
+  end
+
+  describe "#view_component_class?" do
+    it "raises when project_index is not set and class is not in ComponentNamespaces" do
+      source = parse_source(<<~RUBY)
+        class Foo < ViewComponent::Base
+        end
+      RUBY
+
+      expect { cop.send(:view_component_class?, source.ast) }.to raise_error(
+        RuntimeError,
+        /UseProjectIndex/
+      )
+    end
+
+    it "does not raise when class matches a ComponentNamespace" do
+      config = RuboCop::Config.new(
+        "ViewComponent/ComponentSuffix" => {
+          "ComponentNamespaces" => ["MyApp::"]
+        }
+      )
+      cop = cop_class.new(config)
+      cop.project_index = nil
+
+      source = parse_source(<<~RUBY)
+        module MyApp
+          class Foo < ViewComponent::Base
+          end
+        end
+      RUBY
+
+      class_node = source.ast.body
+
+      expect(cop.send(:view_component_class?, class_node)).to be true
+    end
+  end
+
+  describe "#view_component_parent?" do
+    it "raises when project_index is not set" do
+      source = parse_source(<<~RUBY)
+        class Foo < ViewComponent::Base
+        end
+      RUBY
+
+      parent = source.ast.parent_class
+
+      expect { cop.send(:view_component_parent?, parent) }.to raise_error(
+        RuntimeError,
+        /UseProjectIndex/
+      )
+    end
+  end
+
+  describe "#view_component_parent_class?" do
+    it "raises when project_index is not set" do
+      source = parse_source(<<~RUBY)
+        class Foo < ViewComponent::Base
+        end
+      RUBY
+
+      expect { cop.send(:view_component_parent_class?, source.ast) }.to raise_error(
+        RuntimeError,
+        /UseProjectIndex/
+      )
+    end
+  end
+
+  describe "#inside_view_component?" do
+    it "raises when project_index is not set" do
+      source = parse_source(<<~RUBY)
+        class Foo < ViewComponent::Base
+          def call; end
+        end
+      RUBY
+
+      method_node = source.ast.body
+
+      expect { cop.send(:inside_view_component?, method_node) }.to raise_error(
+        RuntimeError,
+        /UseProjectIndex/
+      )
+    end
+  end
+end

data/spec/rubocop/cop/view_component/component_suffix_spec.rb

@@ -74,39 +74,6 @@ RSpec.describe RuboCop::Cop::ViewComponent::ComponentSuffix, :config do
     end
   end
 
-  context "when ViewComponentParentClasses is configured" do
-    let(:config) do
-      RuboCop::Config.new(
-        "ViewComponent/ComponentSuffix" => {
-          "ViewComponentParentClasses" => ["Primer::Component"]
-        }
-      )
-    end
-
-    it "registers an offense for classes inheriting from a configured parent" do
-      expect_offense(<<~RUBY)
-        class FooBar < Primer::Component
-              ^^^^^^ ViewComponent class names should end with `Component`.
-        end
-      RUBY
-    end
-
-    it "does not register offense when class name ends with Component" do
-      expect_no_offenses(<<~RUBY)
-        class FooBarComponent < Primer::Component
-        end
-      RUBY
-    end
-
-    it "still recognizes the default parent classes" do
-      expect_offense(<<~RUBY)
-        class FooBar < ViewComponent::Base
-              ^^^^^^ ViewComponent class names should end with `Component`.
-        end
-      RUBY
-    end
-  end
-
   context "with compact nested class syntax" do
     it "registers offense for compact syntax" do
       expect_offense(<<~RUBY)

data/spec/rubocop/cop/view_component/missing_preview_spec.rb

@@ -12,7 +12,8 @@ RSpec.describe RuboCop::Cop::ViewComponent::MissingPreview, :config do
 
   context "when a preview file exists" do
     it "does not register an offense" do
-      allow(File).to receive(:exist?).and_return(true)
+      allow(File).to receive(:exist?).and_return(false)
+      allow(File).to receive(:exist?).with("/previews/user_preview.rb").and_return(true)
 
       expect_no_offenses(<<~RUBY, "/app/components/user_component.rb")
         class UserComponent < ViewComponent::Base
@@ -23,7 +24,8 @@ RSpec.describe RuboCop::Cop::ViewComponent::MissingPreview, :config do
 
   context "when no preview file exists" do
     it "registers an offense" do
-      allow(File).to receive(:exist?).and_return(false)
+      allow(File).to receive(:exist?).with("/previews/user_preview.rb").and_return(false)
+      allow(File).to receive(:exist?).with("/previews/user_component_preview.rb").and_return(false)
 
       expect_offense(<<~RUBY, "/app/components/user_component.rb")
         class UserComponent < ViewComponent::Base
@@ -45,7 +47,10 @@ RSpec.describe RuboCop::Cop::ViewComponent::MissingPreview, :config do
     end
 
     it "registers an offense for a component in a configured namespace" do
-      allow(File).to receive(:exist?).and_return(false)
+      allow(File).to receive(:exist?).with("/previews/v2/table_preview.rb").and_return(false)
+      allow(File).to receive(:exist?).with("/previews/v2/table_component_preview.rb").and_return(false)
+      allow(File).to receive(:exist?).with("/previews/table_preview.rb").and_return(false)
+      allow(File).to receive(:exist?).with("/previews/table_component_preview.rb").and_return(false)
 
       expect_offense(<<~RUBY, "/app/components/v2/table.rb")
         class V2::Table < SomeBase
@@ -82,16 +87,89 @@ RSpec.describe RuboCop::Cop::ViewComponent::MissingPreview, :config do
         end
       RUBY
     end
+
+    it "registers an offense for a component declared with nested module form when no preview exists" do
+      allow(File).to receive(:exist?).and_return(false)
+
+      expect_offense(<<~RUBY, "/app/components/v2/table.rb")
+        module V2
+          class Table < SomeBase
+                ^^^^^ No preview found for V2::Table (looked in: /previews).
+          end
+        end
+      RUBY
+    end
+
+    it "does not register an offense for a component declared with nested module form when preview exists" do
+      allow(File).to receive(:exist?).and_return(false)
+      allow(File).to receive(:exist?).with("/previews/v2/grouped_multi_select_preview.rb").and_return(true)
+
+      expect_no_offenses(<<~RUBY, "/app/components/v2/grouped_multi_select.rb")
+        module V2
+          class GroupedMultiSelect < V2::MultiSelect
+          end
+        end
+      RUBY
+    end
   end
 
-  context "when not a ViewComponent" do
-    it "does not register an offense" do
+  context "when the component is declared with nested module form" do
+    it "does not register an offense when preview exists at the namespaced path" do
+      allow(File).to receive(:exist?).and_return(false)
+      allow(File).to receive(:exist?).with("/previews/admin/page_component_preview.rb").and_return(true)
+
+      expect_no_offenses(<<~RUBY, "/app/components/admin/page_component.rb")
+        module Admin
+          class PageComponent < ApplicationComponent
+          end
+        end
+      RUBY
+    end
+
+    it "registers an offense when no preview exists" do
+      allow(File).to receive(:exist?).and_return(false)
+
+      expect_offense(<<~RUBY, "/app/components/admin/page_component.rb")
+        module Admin
+          class PageComponent < ApplicationComponent
+                ^^^^^^^^^^^^^ No preview found for Admin::PageComponent (looked in: /previews).
+          end
+        end
+      RUBY
+    end
+  end
+
+  context "when the namespace contains an acronym" do
+    it "does not register an offense when preview exists at the correct path" do
+      ActiveSupport::Inflector.inflections(:en) { |i| i.acronym "UI" }
+
       allow(File).to receive(:exist?).and_return(false)
+      allow(File).to receive(:exist?).with("/previews/ui/button_component_preview.rb").and_return(true)
 
+      expect_no_offenses(<<~RUBY, "/app/components/ui/button_component.rb")
+        module UI
+          class ButtonComponent < ViewComponent::Base
+          end
+        end
+      RUBY
+    end
+  end
+
+  context "when not a ViewComponent" do
+    it "does not register an offense" do
       expect_no_offenses(<<~RUBY, "/app/components/user_component.rb")
         class UserComponent
         end
       RUBY
     end
   end
+
+  context "when the class is itself a registered parent class" do
+    it "does not register an offense for a built-in parent class" do
+      expect_no_offenses(<<~RUBY, "/app/components/application_component.rb")
+        class ApplicationComponent < ViewComponent::Base
+        end
+      RUBY
+    end
+  end
 end

data/spec/rubocop/cop/view_component/no_global_state_spec.rb

@@ -105,6 +105,19 @@ RSpec.describe RuboCop::Cop::ViewComponent::NoGlobalState, :config do
     end
   end
 
+  context "with Sorbet signatures" do
+    it "does not register offense for params in sig block" do
+      expect_no_offenses(<<~RUBY)
+        class UserComponent < ViewComponent::Base
+          sig { params(descriptor: String, admin_view: T::Boolean).returns(T.nilable(String)) }
+          def call(descriptor:, admin_view:)
+            @descriptor = descriptor
+          end
+        end
+      RUBY
+    end
+  end
+
   context "when not in a ViewComponent" do
     it "does not register offense in regular classes" do
       expect_no_offenses(<<~RUBY)

data/spec/rubocop/cop/view_component/prefer_composition_spec.rb

@@ -88,21 +88,4 @@ RSpec.describe RuboCop::Cop::ViewComponent::PreferComposition, :config do
       RUBY
     end
   end
-
-  context "when ViewComponentParentClasses is configured" do
-    let(:config) do
-      RuboCop::Config.new(
-        "ViewComponent/PreferComposition" => {
-          "ViewComponentParentClasses" => ["Primer::Component"]
-        }
-      )
-    end
-
-    it "does not register an offense for configured parent classes" do
-      expect_no_offenses(<<~RUBY)
-        class FooBarComponent < Primer::Component
-        end
-      RUBY
-    end
-  end
 end

data/spec/rubocop/cop/view_component/prefer_private_methods_spec.rb

@@ -144,7 +144,7 @@ RSpec.describe RuboCop::Cop::ViewComponent::PreferPrivateMethods, :config do
     context "with custom patterns" do
       let(:config) do
         RuboCop::Config.new(
-          "AllCops" => {"DisplayCopNames" => true},
+          "AllCops" => { "DisplayCopNames" => true },
           "ViewComponent/PreferPrivateMethods" => {
             "AllowedPublicMethods" => %w[initialize call],
             "AllowedPublicMethodPatterns" => ["^render_", "^with_"]
@@ -186,7 +186,7 @@ RSpec.describe RuboCop::Cop::ViewComponent::PreferPrivateMethods, :config do
   context "with custom AllowedPublicMethods" do
     let(:config) do
       RuboCop::Config.new(
-        "AllCops" => {"DisplayCopNames" => true},
+        "AllCops" => { "DisplayCopNames" => true },
         "ViewComponent/PreferPrivateMethods" => {
           "AllowedPublicMethods" => %w[initialize call custom_public_method],
           "AllowedPublicMethodPatterns" => []
@@ -261,7 +261,7 @@ RSpec.describe RuboCop::Cop::ViewComponent::PreferPrivateMethods, :config do
   context "with template files" do
     let(:component_file) { "spec/fixtures/components/template_method_component.rb" }
 
-    it "does not flag methods called in template, but flags unused methods" do
+    it "registers methods called in template, but flags unused methods" do
       expect_offense(<<~RUBY, component_file)
         # frozen_string_literal: true
 

data/spec/rubocop/cop/view_component/test_rendered_output_spec.rb

@@ -99,7 +99,7 @@ RSpec.describe RuboCop::Cop::ViewComponent::TestRenderedOutput, :config do
   context "with TestPaths configured" do
     let(:config) do
       RuboCop::Config.new(
-        "AllCops" => {"DisplayCopNames" => true},
+        "AllCops" => { "DisplayCopNames" => true },
         "ViewComponent/TestRenderedOutput" => {
           "TestPaths" => ["spec/components/v2/"]
         }

data/spec/spec_helper.rb

@@ -2,6 +2,7 @@
 
 require "rubocop-view_component"
 require "rubocop/rspec/support"
+require_relative "support/project_index_helpers"
 
 RSpec.configure do |config|
   config.disable_monkey_patching!
@@ -11,4 +12,13 @@ RSpec.configure do |config|
 
   config.order = :random
   Kernel.srand config.seed
+
+  config.include ViewComponent::ProjectIndexHelpers
+
+  config.before do |example|
+    next unless example.metadata[:config]
+
+    graph = build_index
+    cop.project_index = ViewComponent::ProjectIndexHelpers::LazyIndex.new(graph, cop)
+  end
 end

data/spec/support/project_index_helpers.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require "rubydex"
+
+module ViewComponent
+  module ProjectIndexHelpers
+    DEFAULT_SOURCES = {
+      "file:///view_component.rb" => <<~RUBY,
+        module ViewComponent
+          class Base
+          end
+        end
+      RUBY
+      "file:///application_component.rb" => <<~RUBY,
+        class ApplicationComponent < ViewComponent::Base
+        end
+      RUBY
+      "file:///user_component.rb" => <<~RUBY
+        class UserComponent < ApplicationComponent
+        end
+      RUBY
+    }.freeze
+
+    def build_index(sources = {})
+      graph = Rubydex::Graph.new
+      DEFAULT_SOURCES.merge(sources).each { |uri, source| graph.index_source(uri, source, "ruby") }
+      graph.resolve
+      graph
+    end
+
+    # Wraps a graph to lazily index the source being inspected when
+    # resolve_constant is called. This mirrors how the real RuboCop runner
+    # indexes all project files, including the one being inspected.
+    class LazyIndex
+      def initialize(base_graph, cop)
+        @base_graph = base_graph
+        @cop = cop
+        @rebuilt = false
+      end
+
+      def resolve_constant(name, nesting)
+        result = @base_graph.resolve_constant(name, nesting)
+        return result if result
+
+        rebuild_once
+        @base_graph.resolve_constant(name, nesting)
+      end
+
+      def method_missing(name, ...)
+        @base_graph.send(name, ...)
+      end
+
+      def respond_to_missing?(name, include_private = false)
+        @base_graph.respond_to?(name, include_private) || super
+      end
+
+      private
+
+      def rebuild_once
+        return if @rebuilt
+
+        @rebuilt = true
+        source = @cop&.processed_source
+        return unless source&.raw_source
+
+        @base_graph.index_source("file:///test_source.rb", source.raw_source, "ruby")
+        @base_graph.resolve
+      end
+    end
+  end
+end

data/verification/govuk_rubocop_config.yml

@@ -1,6 +1,6 @@
-ViewComponent:
-  ViewComponentParentClasses:
-    - GovukComponent::Base
+AllCops:
+  UseProjectIndex: true
+  ProjectIndexIncludesGems: true
 
 # x-govuk components do not use ViewComponent previews
 ViewComponent/MissingPreview:

data/verification/polaris_rubocop_config.yml

@@ -1,7 +1,6 @@
-ViewComponent:
-  ViewComponentParentClasses:
-    - Polaris::Component
-    - Component
+AllCops:
+  UseProjectIndex: true
+  ProjectIndexIncludesGems: true
 
 ViewComponent/MissingPreview:
   PreviewPaths: