rubocop-view_component 0.6.0 → 0.8.0

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

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require "fileutils"
+require "tmpdir"
+
 RSpec.describe RuboCop::Cop::ViewComponent::PreferPrivateMethods, :config do
   let(:config) { RuboCop::Config.new }
 
@@ -54,6 +57,77 @@ RSpec.describe RuboCop::Cop::ViewComponent::PreferPrivateMethods, :config do
     end
   end
 
+  context "when helper methods are made private with an explicit list" do
+    it "does not register offense for the listed methods" do
+      expect_no_offenses(<<~RUBY)
+        class CardComponent < ViewComponent::Base
+          def initialize(title)
+            @title = title
+          end
+
+          def formatted_title
+            @title.upcase
+          end
+
+          def helper
+            "helper"
+          end
+
+          private :formatted_title, :helper
+        end
+      RUBY
+    end
+
+    it "does not change the visibility of methods defined after the list" do
+      expect_offense(<<~RUBY)
+        class CardComponent < ViewComponent::Base
+          def formatted_title
+            "title"
+          end
+
+          private :formatted_title
+
+          def other_helper
+          ^^^^^^^^^^^^^^^^ ViewComponent/PreferPrivateMethods: Consider making `other_helper` private. Only ViewComponent interface methods should be public.
+            "other"
+          end
+        end
+      RUBY
+    end
+
+    it "flags a method made public again with an explicit list" do
+      expect_offense(<<~RUBY)
+        class CardComponent < ViewComponent::Base
+          private
+
+          def formatted_title
+          ^^^^^^^^^^^^^^^^^^^ ViewComponent/PreferPrivateMethods: Consider making `formatted_title` private. Only ViewComponent interface methods should be public.
+            "title"
+          end
+
+          public :formatted_title
+        end
+      RUBY
+    end
+  end
+
+  context "when a method is defined with `private def`" do
+    it "flags later public methods but not the `private def` method" do
+      expect_offense(<<~RUBY)
+        class CardComponent < ViewComponent::Base
+          private def formatted_title
+            "title"
+          end
+
+          def other_helper
+          ^^^^^^^^^^^^^^^^ ViewComponent/PreferPrivateMethods: Consider making `other_helper` private. Only ViewComponent interface methods should be public.
+            "other"
+          end
+        end
+      RUBY
+    end
+  end
+
   context "with allowed public interface methods" do
     it "allows initialize" do
       expect_no_offenses(<<~RUBY)
@@ -147,8 +221,7 @@ RSpec.describe RuboCop::Cop::ViewComponent::PreferPrivateMethods, :config do
           "AllCops" => { "DisplayCopNames" => true },
           "ViewComponent/PreferPrivateMethods" => {
             "AllowedPublicMethods" => %w[initialize call],
-            "AllowedPublicMethodPatterns" => ["^render_", "^with_"],
-            "ViewComponentParentClasses" => %w[ViewComponent::Base ApplicationComponent]
+            "AllowedPublicMethodPatterns" => ["^render_", "^with_"]
           }
         )
       end
@@ -190,8 +263,7 @@ RSpec.describe RuboCop::Cop::ViewComponent::PreferPrivateMethods, :config do
         "AllCops" => { "DisplayCopNames" => true },
         "ViewComponent/PreferPrivateMethods" => {
           "AllowedPublicMethods" => %w[initialize call custom_public_method],
-          "AllowedPublicMethodPatterns" => [],
-          "ViewComponentParentClasses" => %w[ViewComponent::Base ApplicationComponent]
+          "AllowedPublicMethodPatterns" => []
         }
       )
     end
@@ -260,6 +332,56 @@ RSpec.describe RuboCop::Cop::ViewComponent::PreferPrivateMethods, :config do
     end
   end
 
+  context "with AdditionalSourcePaths" do
+    let(:engine_dir) { Dir.mktmpdir("engine") }
+
+    before do
+      FileUtils.mkdir_p(File.join(engine_dir, "app", "components"))
+      File.write(
+        File.join(engine_dir, "app", "components", "engine_base_component.rb"),
+        "class EngineBaseComponent < ViewComponent::Base\nend\n"
+      )
+    end
+
+    after { FileUtils.remove_entry(engine_dir) }
+
+    context "when the engine source path is configured" do
+      let(:config) do
+        RuboCop::Config.new(
+          "AllCops" => { "DisplayCopNames" => true },
+          "ViewComponent/PreferPrivateMethods" => {
+            "AdditionalSourcePaths" => [File.join(engine_dir, "app", "components")]
+          }
+        )
+      end
+
+      it "resolves ancestry through the additional source paths" do
+        expect_offense(<<~RUBY)
+          class CardComponent < EngineBaseComponent
+            def helper
+            ^^^^^^^^^^ ViewComponent/PreferPrivateMethods: Consider making `helper` private. Only ViewComponent interface methods should be public.
+              "helper"
+            end
+          end
+        RUBY
+      end
+    end
+
+    context "when the engine source path is not configured" do
+      let(:config) { RuboCop::Config.new }
+
+      it "does not detect the class as a ViewComponent" do
+        expect_no_offenses(<<~RUBY)
+          class CardComponent < EngineBaseComponent
+            def helper
+              "helper"
+            end
+          end
+        RUBY
+      end
+    end
+  end
+
   context "with template files" do
     let(:component_file) { "spec/fixtures/components/template_method_component.rb" }
 

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

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
 RSpec.describe RuboCop::Cop::ViewComponent::TestRenderedOutput, :config do
+  include ViewComponent::ProjectIndexHelpers
+
   let(:config) { RuboCop::Config.new }
+  let(:project_index) { build_index }
 
   context "with Minitest-style tests" do
     context "when test instantiates a component but doesn't render" do
@@ -17,17 +20,37 @@ RSpec.describe RuboCop::Cop::ViewComponent::TestRenderedOutput, :config do
     end
 
     context "when test instantiates a non-Component-suffixed class" do
-      it "registers an offense" do
+      it "registers an offense for an indexed component" do
         expect_offense(<<~RUBY)
           def test_toggle
           ^^^^^^^^^^^^^^^ ViewComponent/TestRenderedOutput: Test instantiates a component but doesn't use `render_inline` or `render_preview`. Test the rendered output instead of component methods directly.
-            component = V2::Toggle.new
+            component = UserComponent.new
             assert component.active?
           end
         RUBY
       end
     end
 
+    context "when test instantiates a non-ViewComponent value object" do
+      let(:project_index) do
+        build_index(
+          "file:///month.rb" => <<~RUBY
+            class Month
+            end
+          RUBY
+        )
+      end
+
+      it "does not register an offense" do
+        expect_no_offenses(<<~RUBY)
+          def test_month
+            month = Month.new
+            assert month.active?
+          end
+        RUBY
+      end
+    end
+
     context "when test instantiates a component and uses render_inline" do
       it "does not register an offense" do
         expect_no_offenses(<<~RUBY)
@@ -50,6 +73,18 @@ RSpec.describe RuboCop::Cop::ViewComponent::TestRenderedOutput, :config do
       end
     end
 
+    context "when test instantiates a component and uses render_in_view_context" do
+      it "does not register an offense" do
+        expect_no_offenses(<<~RUBY)
+          def test_form_input
+            render_in_view_context do
+              render(UserComponent.new("hello"))
+            end
+          end
+        RUBY
+      end
+    end
+
     context "when test doesn't instantiate any constants" do
       it "does not register an offense" do
         expect_no_offenses(<<~RUBY)
@@ -84,16 +119,46 @@ RSpec.describe RuboCop::Cop::ViewComponent::TestRenderedOutput, :config do
     end
 
     context "when test instantiates a namespaced component" do
-      it "registers an offense" do
+      it "registers an offense for an indexed component" do
         expect_offense(<<~RUBY)
           def test_namespaced
           ^^^^^^^^^^^^^^^^^^^ ViewComponent/TestRenderedOutput: Test instantiates a component but doesn't use `render_inline` or `render_preview`. Test the rendered output instead of component methods directly.
-            component = Admin::UserComponent.new("hello")
+            component = UserComponent.new("hello")
             assert_equal "HELLO", component.formatted_title
           end
         RUBY
       end
     end
+
+    context "when the component is built to assert an error" do
+      it "does not register an offense for assert_raises" do
+        expect_no_offenses(<<~RUBY)
+          def test_raises_for_invalid_input
+            assert_raises(ArgumentError) { UserComponent.new(nil) }
+          end
+        RUBY
+      end
+
+      it "does not register an offense for a do/end assert_raises block" do
+        expect_no_offenses(<<~RUBY)
+          def test_raises_for_invalid_input
+            assert_raises(ArgumentError) do
+              UserComponent.new(nil)
+            end
+          end
+        RUBY
+      end
+
+      it "registers an offense when a component is built outside the assertion" do
+        expect_offense(<<~RUBY)
+          def test_mixed
+          ^^^^^^^^^^^^^^ ViewComponent/TestRenderedOutput: Test instantiates a component but doesn't use `render_inline` or `render_preview`. Test the rendered output instead of component methods directly.
+            component = UserComponent.new("hello")
+            assert_raises(ArgumentError) { component.invalid! }
+          end
+        RUBY
+      end
+    end
   end
 
   context "with TestPaths configured" do
@@ -154,6 +219,18 @@ RSpec.describe RuboCop::Cop::ViewComponent::TestRenderedOutput, :config do
       end
     end
 
+    context "when it block instantiates a component and uses render_in_view_context" do
+      it "does not register an offense" do
+        expect_no_offenses(<<~RUBY)
+          it "renders a form" do
+            render_in_view_context do
+              render(UserComponent.new("hello"))
+            end
+          end
+        RUBY
+      end
+    end
+
     context "when it block doesn't instantiate components" do
       it "does not register an offense" do
         expect_no_offenses(<<~RUBY)
@@ -164,5 +241,211 @@ RSpec.describe RuboCop::Cop::ViewComponent::TestRenderedOutput, :config do
         RUBY
       end
     end
+
+    context "when it block uses described_class inside a describe block" do
+      it "registers an offense" do
+        expect_offense(<<~RUBY)
+          describe UserComponent do
+            it "formats the title" do
+            ^^^^^^^^^^^^^^^^^^^^^^^^^ ViewComponent/TestRenderedOutput: Test instantiates a component but doesn't use `render_inline` or `render_preview`. Test the rendered output instead of component methods directly.
+              component = described_class.new("hello")
+              expect(component.formatted_title).to eq("HELLO")
+            end
+          end
+        RUBY
+      end
+
+      it "registers an offense for RSpec.describe" do
+        expect_offense(<<~RUBY)
+          RSpec.describe UserComponent do
+            it "formats the title" do
+            ^^^^^^^^^^^^^^^^^^^^^^^^^ ViewComponent/TestRenderedOutput: Test instantiates a component but doesn't use `render_inline` or `render_preview`. Test the rendered output instead of component methods directly.
+              expect(described_class.new("hello").formatted_title).to eq("HELLO")
+            end
+          end
+        RUBY
+      end
+
+      it "registers an offense inside a nested context" do
+        expect_offense(<<~RUBY)
+          describe UserComponent do
+            context "when rendered" do
+              it "formats the title" do
+              ^^^^^^^^^^^^^^^^^^^^^^^^^ ViewComponent/TestRenderedOutput: Test instantiates a component but doesn't use `render_inline` or `render_preview`. Test the rendered output instead of component methods directly.
+                component = described_class.new("hello")
+                expect(component.formatted_title).to eq("HELLO")
+              end
+            end
+          end
+        RUBY
+      end
+
+      it "does not register an offense when using render_inline" do
+        expect_no_offenses(<<~RUBY)
+          describe UserComponent do
+            it "formats the title" do
+              render_inline described_class.new("hello")
+              expect(page).to have_text("HELLO")
+            end
+          end
+        RUBY
+      end
+    end
+
+    context "when the component is built to assert an error" do
+      it "does not register an offense for described_class" do
+        expect_no_offenses(<<~RUBY)
+          describe UserComponent do
+            it "raises for invalid input" do
+              expect { described_class.new(nil) }.to raise_error(ArgumentError)
+            end
+          end
+        RUBY
+      end
+
+      it "does not register an offense for a component constant" do
+        expect_no_offenses(<<~RUBY)
+          it "raises for invalid input" do
+            expect { UserComponent.new(nil) }.to raise_error(ArgumentError)
+          end
+        RUBY
+      end
+
+      it "does not register an offense for not_to raise_error" do
+        expect_no_offenses(<<~RUBY)
+          it "does not raise for valid input" do
+            expect { UserComponent.new("hello") }.not_to raise_error
+          end
+        RUBY
+      end
+
+      it "does not register an offense when raise_error takes a block" do
+        expect_no_offenses(<<~RUBY)
+          it "raises with a message" do
+            expect { UserComponent.new(nil) }.to raise_error(ArgumentError) do |error|
+              expect(error.message).to eq("invalid")
+            end
+          end
+        RUBY
+      end
+    end
+
+    context "when a component is built by a let helper" do
+      it "registers an offense" do
+        expect_offense(<<~RUBY)
+          describe UserComponent do
+            let(:component) { UserComponent.new("hello") }
+
+            it "formats the title" do
+            ^^^^^^^^^^^^^^^^^^^^^^^^^ ViewComponent/TestRenderedOutput: Test instantiates a component but doesn't use `render_inline` or `render_preview`. Test the rendered output instead of component methods directly.
+              expect(component.formatted_title).to eq("HELLO")
+            end
+          end
+        RUBY
+      end
+
+      it "registers an offense for a subject using described_class" do
+        expect_offense(<<~RUBY)
+          describe UserComponent do
+            subject(:component) { described_class.new("hello") }
+
+            it "formats the title" do
+            ^^^^^^^^^^^^^^^^^^^^^^^^^ ViewComponent/TestRenderedOutput: Test instantiates a component but doesn't use `render_inline` or `render_preview`. Test the rendered output instead of component methods directly.
+              expect(component.formatted_title).to eq("HELLO")
+            end
+          end
+        RUBY
+      end
+
+      it "registers an offense when the let is defined in an outer group" do
+        expect_offense(<<~RUBY)
+          describe UserComponent do
+            let(:component) { UserComponent.new("hello") }
+
+            context "when rendered" do
+              it "formats the title" do
+              ^^^^^^^^^^^^^^^^^^^^^^^^^ ViewComponent/TestRenderedOutput: Test instantiates a component but doesn't use `render_inline` or `render_preview`. Test the rendered output instead of component methods directly.
+                expect(component.formatted_title).to eq("HELLO")
+              end
+            end
+          end
+        RUBY
+      end
+
+      it "does not register an offense when the helper renders output" do
+        expect_no_offenses(<<~RUBY)
+          describe UserComponent do
+            let(:rendered) { render_inline(UserComponent.new("hello")) }
+
+            it "formats the title" do
+              expect(rendered).to have_text("HELLO")
+            end
+          end
+        RUBY
+      end
+
+      it "does not register an offense when the helper builds another object" do
+        expect_no_offenses(<<~RUBY)
+          describe UserComponent do
+            let(:component) { double("component") }
+
+            it "formats the title" do
+              expect(component.formatted_title).to eq("HELLO")
+            end
+          end
+        RUBY
+      end
+
+      it "does not register an offense when the helper is rendered with render_inline" do
+        expect_no_offenses(<<~RUBY)
+          describe UserComponent do
+            let(:component) { UserComponent.new("hello") }
+
+            it "formats the title" do
+              render_inline(component)
+              expect(page).to have_text("HELLO")
+            end
+          end
+        RUBY
+      end
+
+      it "prefers the innermost helper definition" do
+        expect_no_offenses(<<~RUBY)
+          describe UserComponent do
+            let(:component) { UserComponent.new("hello") }
+
+            context "with a stub" do
+              let(:component) { double("component") }
+
+              it "formats the title" do
+                expect(component).to be_present
+              end
+            end
+          end
+        RUBY
+      end
+    end
+  end
+
+  context "when the described class is not a ViewComponent" do
+    let(:project_index) do
+      build_index(
+        "file:///month.rb" => <<~RUBY
+          class Month
+          end
+        RUBY
+      )
+    end
+
+    it "does not register an offense" do
+      expect_no_offenses(<<~RUBY)
+        describe Month do
+          it "formats the month" do
+            month = described_class.new
+            expect(month.active?).to be(true)
+          end
+        end
+      RUBY
+    end
   end
 end

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/flowbite_rubocop_config.yml

@@ -0,0 +1,12 @@
+AllCops:
+  UseProjectIndex: true
+  ProjectIndexIncludesGems: true
+  Exclude:
+    - demo/**/*
+
+ViewComponent/ComponentSuffix:
+  Enabled: false
+
+ViewComponent/MissingPreview:
+  PreviewPaths:
+    - demo/test/components/previews

data/verification/govuk_rubocop_config.yml

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

data/verification/libraries.yml

@@ -9,3 +9,7 @@ govuk:
 polaris:
   tarball_url: https://github.com/baoagency/polaris_view_components/archive/refs/heads/main.tar.gz
   display_name: baoagency/polaris_view_components
+
+flowbite:
+  tarball_url: https://github.com/substancelab/flowbite-components/archive/refs/heads/main.tar.gz
+  display_name: substancelab/flowbite-components

data/verification/polaris_rubocop_config.yml

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

data/verification/primer_rubocop_config.yml

@@ -1,10 +1,6 @@
-ViewComponent:
-  inherit_mode:
-    merge:
-      - ViewComponentParentClasses
-  ViewComponentParentClasses:
-    - Primer::Component
-    - Primer::BaseComponent
+AllCops:
+  UseProjectIndex: true
+  ProjectIndexIncludesGems: true
 
 # Primer seems to intentionally omit the Component suffix from most class names
 # (116 out of 131 components), so this cop is not useful here.
@@ -31,3 +27,5 @@ ViewComponent/MissingPreview:
     - previews
   Exclude:
     - app/components/primer/base_component.rb
+    # Deprecated wrapper with no preview
+    - app/components/primer/navigation/tab_component.rb