rubocop-view_component 0.6.0 → 0.8.0

data/spec/expected_flowbite_failures.yml

@@ -0,0 +1,64 @@
+# This file is auto-generated by `script/verify --regenerate`.
+# It captures known offenses in the library source.
+---
+ViewComponent/MissingPreview:
+  - 'app/components/flowbite/badge/dot.rb'
+  - 'app/components/flowbite/badge/pill.rb'
+  - 'app/components/flowbite/breadcrumb/home_icon.rb'
+  - 'app/components/flowbite/breadcrumb/item/current.rb'
+  - 'app/components/flowbite/breadcrumb/item/first.rb'
+  - 'app/components/flowbite/breadcrumb/separator_icon.rb'
+  - 'app/components/flowbite/button/outline.rb'
+  - 'app/components/flowbite/button/pill.rb'
+  - 'app/components/flowbite/card/title.rb'
+  - 'app/components/flowbite/input/date.rb'
+  - 'app/components/flowbite/input/date_time.rb'
+  - 'app/components/flowbite/input/email.rb'
+  - 'app/components/flowbite/input/file.rb'
+  - 'app/components/flowbite/input/hint.rb'
+  - 'app/components/flowbite/input/label.rb'
+  - 'app/components/flowbite/input/number.rb'
+  - 'app/components/flowbite/input/password.rb'
+  - 'app/components/flowbite/input/phone.rb'
+  - 'app/components/flowbite/input/textarea.rb'
+  - 'app/components/flowbite/input/url.rb'
+  - 'app/components/flowbite/input/validation_error.rb'
+  - 'app/components/flowbite/input_field/date.rb'
+  - 'app/components/flowbite/input_field/date_time.rb'
+  - 'app/components/flowbite/input_field/email.rb'
+  - 'app/components/flowbite/input_field/file.rb'
+  - 'app/components/flowbite/input_field/number.rb'
+  - 'app/components/flowbite/input_field/password.rb'
+  - 'app/components/flowbite/input_field/phone.rb'
+  - 'app/components/flowbite/input_field/text.rb'
+  - 'app/components/flowbite/input_field/textarea.rb'
+  - 'app/components/flowbite/input_field/url.rb'
+  - 'app/components/flowbite/pagination/chevron_left_icon.rb'
+  - 'app/components/flowbite/pagination/chevron_right_icon.rb'
+  - 'app/components/flowbite/pagination/gap.rb'
+  - 'app/components/flowbite/pagination/next_link.rb'
+  - 'app/components/flowbite/pagination/previous_link.rb'
+  - 'app/components/flowbite/sidebar/item.rb'
+  - 'app/components/flowbite/sidebar/navigation.rb'
+  - 'app/components/flowbite/toast/icon.rb'
+ViewComponent/PreferPrivateMethods:
+  - 'app/components/flowbite/badge.rb'
+  - 'app/components/flowbite/input.rb'
+  - 'app/components/flowbite/input/checkbox.rb'
+  - 'app/components/flowbite/input/date.rb'
+  - 'app/components/flowbite/input/date_time.rb'
+  - 'app/components/flowbite/input/email.rb'
+  - 'app/components/flowbite/input/file.rb'
+  - 'app/components/flowbite/input/hint.rb'
+  - 'app/components/flowbite/input/label.rb'
+  - 'app/components/flowbite/input/number.rb'
+  - 'app/components/flowbite/input/password.rb'
+  - 'app/components/flowbite/input/phone.rb'
+  - 'app/components/flowbite/input/radio_button.rb'
+  - 'app/components/flowbite/input/select.rb'
+  - 'app/components/flowbite/input/url.rb'
+  - 'app/components/flowbite/input_field.rb'
+  - 'app/components/flowbite/input_field/select.rb'
+  - 'app/components/flowbite/pagination/link.rb'
+  - 'app/components/flowbite/pagination/next_link.rb'
+  - 'app/components/flowbite/pagination/previous_link.rb'

data/spec/expected_govuk_failures.yml

@@ -3,22 +3,20 @@
 ---
 ViewComponent/ComponentSuffix:
   - 'app/components/govuk_component/base.rb'
-  - 'app/components/govuk_component/header_component.rb'
-  - 'app/components/govuk_component/notification_banner_component.rb'
+  - 'app/components/govuk_component/header_component.rb' # due to nested class
+  - 'app/components/govuk_component/language_navigation_component.rb' # due to nested class
+  - 'app/components/govuk_component/notification_banner_component.rb' # due to nested class
   - 'app/components/govuk_component/pagination_component/adjacent_page.rb'
   - 'app/components/govuk_component/pagination_component/item.rb'
-  - 'app/components/govuk_component/tab_component.rb'
+  - 'app/components/govuk_component/pagination_component/next_page.rb'
+  - 'app/components/govuk_component/pagination_component/previous_page.rb'
+  - 'app/components/govuk_component/panel_component.rb' # due to nested class
+  - 'app/components/govuk_component/tab_component.rb' # due to nested class
 ViewComponent/PreferPrivateMethods:
   - 'app/components/govuk_component/base.rb'
+  - 'app/components/govuk_component/language_navigation_component.rb'
   - 'app/components/govuk_component/notification_banner_component.rb'
+  - 'app/components/govuk_component/pagination_component/next_page.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:
-  - 'spec/components/govuk_component/accordion_component_spec.rb'
-  - 'spec/components/govuk_component/breadcrumbs_component_spec.rb'
-  - 'spec/components/govuk_component/configuration/footer_component_configuration_spec.rb'
-  - 'spec/components/govuk_component/footer_component_spec.rb'
-  - 'spec/components/govuk_component/notification_banner_component_spec.rb'
-  - 'spec/components/govuk_component/pagination_component_spec.rb'
-  - 'spec/components/govuk_component/task_list_component_spec.rb'
-  - 'spec/components/govuk_component/warning_text_component_spec.rb'

data/spec/expected_polaris_failures.yml

@@ -17,6 +17,8 @@ ViewComponent/MissingPreview:
   - 'app/components/polaris/inline_code_component.rb'
   - 'app/components/polaris/label_component.rb'
   - 'app/components/polaris/labelled_component.rb'
+  - 'app/components/polaris/layout/annotated_section.rb'
+  - 'app/components/polaris/layout/section.rb'
   - 'app/components/polaris/list_component.rb'
   - 'app/components/polaris/page_component.rb'
   - 'app/components/polaris/placeholder_component.rb'

data/spec/expected_primer_failures.yml

@@ -2,9 +2,66 @@
 # It captures known offenses in the library source.
 ---
 ViewComponent/MissingPreview:
+  - 'app/components/primer/alpha/action_bar/divider.rb'
+  - 'app/components/primer/alpha/action_bar/item.rb'
+  - 'app/components/primer/alpha/action_list/form_wrapper.rb'
+  - 'app/components/primer/alpha/action_menu/group.rb'
+  - 'app/components/primer/alpha/action_menu/heading.rb'
+  - 'app/components/primer/alpha/action_menu/list.rb'
+  - 'app/components/primer/alpha/action_menu/list_wrapper.rb'
+  - 'app/components/primer/alpha/auto_complete/item.rb'
+  - 'app/components/primer/alpha/dialog/body.rb'
+  - 'app/components/primer/alpha/dialog/footer.rb'
+  - 'app/components/primer/alpha/dialog/header.rb'
+  - 'app/components/primer/alpha/dropdown/menu.rb'
+  - 'app/components/primer/alpha/file_tree_view/directory_node.rb'
+  - 'app/components/primer/alpha/file_tree_view/file_node.rb'
+  - 'app/components/primer/alpha/form_button.rb'
+  - 'app/components/primer/alpha/image.rb'
+  - 'app/components/primer/alpha/layout.rb'
+  - 'app/components/primer/alpha/nav_list.rb'
+  - 'app/components/primer/alpha/nav_list/divider.rb'
+  - 'app/components/primer/alpha/nav_list/group.rb'
+  - 'app/components/primer/alpha/nav_list/heading.rb'
+  - 'app/components/primer/alpha/nav_list/item.rb'
+  - 'app/components/primer/alpha/overlay/body.rb'
+  - 'app/components/primer/alpha/overlay/footer.rb'
+  - 'app/components/primer/alpha/overlay/header.rb'
+  - 'app/components/primer/alpha/segmented_control/item.rb'
+  - 'app/components/primer/alpha/select_panel.rb'
+  - 'app/components/primer/alpha/submit_button.rb'
+  - 'app/components/primer/alpha/tab_container.rb'
+  - 'app/components/primer/alpha/tree_view/icon.rb'
+  - 'app/components/primer/alpha/tree_view/icon_pair.rb'
+  - 'app/components/primer/alpha/tree_view/leading_action.rb'
+  - 'app/components/primer/alpha/tree_view/loading_failure_message.rb'
+  - 'app/components/primer/alpha/tree_view/node.rb'
+  - 'app/components/primer/alpha/tree_view/skeleton_loader.rb'
+  - 'app/components/primer/alpha/tree_view/spinner_loader.rb'
+  - 'app/components/primer/alpha/tree_view/sub_tree.rb'
+  - 'app/components/primer/alpha/tree_view/sub_tree_container.rb'
+  - 'app/components/primer/alpha/tree_view/visual.rb'
+  - 'app/components/primer/beta/auto_complete/item.rb'
+  - 'app/components/primer/beta/auto_complete/no_result_item.rb'
+  - 'app/components/primer/beta/border_box/header.rb'
+  - 'app/components/primer/beta/breadcrumbs.rb'
+  - 'app/components/primer/beta/button_group.rb'
+  - 'app/components/primer/beta/clipboard_copy_button.rb'
+  - 'app/components/primer/beta/timeline_item.rb'
+  - 'app/components/primer/beta/truncate.rb'
   - 'app/components/primer/blankslate_component.rb'
   - 'app/components/primer/button_component.rb'
+  - 'app/components/primer/conditional_wrapper.rb'
+  - 'app/components/primer/content.rb'
+  - 'app/components/primer/icon_button.rb'
   - 'app/components/primer/layout_component.rb'
+  - 'app/components/primer/tooltip.rb'
+  - 'app/components/primer/truncate.rb'
+  - 'test/components/beta/nav_list_test.rb'
+  - 'test/lib/primer/audited/dsl_test.rb'
+  - 'test/lib/primer/forms/form_test_component.rb'
+  - 'test/lib/primer/status/dsl_test.rb'
+  - 'test/test_helpers/components/primer/deny_component.rb'
 ViewComponent/PreferPrivateMethods:
   - 'app/components/primer/alpha/action_list.rb'
   - 'app/components/primer/alpha/action_list/divider.rb'
@@ -15,5 +72,6 @@ ViewComponent/PreferPrivateMethods:
   - 'app/components/primer/alpha/tree_view/node.rb'
   - 'app/components/primer/beta/avatar.rb'
   - 'app/components/primer/beta/nav_list.rb'
-ViewComponent/TestRenderedOutput:
-  - 'test/components/alpha/action_list_test.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'

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

@@ -0,0 +1,108 @@
+# 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
+
+  describe "#resolved_index_declaration" 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(:resolved_index_declaration, parent) }.to raise_error(
+        RuntimeError,
+        /UseProjectIndex/
+      )
+    end
+  end
+end

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

@@ -74,64 +74,6 @@ RSpec.describe RuboCop::Cop::ViewComponent::ComponentSuffix, :config do
     end
   end
 
-  context "when ViewComponentParentClasses is configured with merge" do
-    let(:config) do
-      RuboCop::Config.new(
-        "ViewComponent/ComponentSuffix" => {
-          "ViewComponentParentClasses" => ["ViewComponent::Base", "ApplicationComponent", "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 "when ViewComponentParentClasses is configured replacing defaults" 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 recognize default parent classes that were replaced" do
-      expect_no_offenses(<<~RUBY)
-        class FooBar < ViewComponent::Base
-        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

@@ -5,8 +5,7 @@ RSpec.describe RuboCop::Cop::ViewComponent::MissingPreview, :config do
     RuboCop::Config.new(
       "ViewComponent/MissingPreview" => {
         "Enabled" => true,
-        "PreviewPaths" => ["/previews"],
-        "ViewComponentParentClasses" => %w[ViewComponent::Base ApplicationComponent]
+        "PreviewPaths" => ["/previews"]
       }
     )
   end
@@ -172,45 +171,5 @@ RSpec.describe RuboCop::Cop::ViewComponent::MissingPreview, :config do
         end
       RUBY
     end
-
-    context "when a custom parent class is configured" do
-      let(:config) do
-        RuboCop::Config.new(
-          "ViewComponent/MissingPreview" => {
-            "Enabled" => true,
-            "PreviewPaths" => ["/previews"],
-            "ViewComponentParentClasses" => %w[ViewComponent::Base ApplicationComponent BaseComponent]
-          }
-        )
-      end
-
-      it "does not register an offense for the custom parent class" do
-        expect_no_offenses(<<~RUBY, "/app/components/base_component.rb")
-          class BaseComponent < ViewComponent::Base
-          end
-        RUBY
-      end
-    end
-
-    context "when a namespaced custom parent class is configured" do
-      let(:config) do
-        RuboCop::Config.new(
-          "ViewComponent/MissingPreview" => {
-            "Enabled" => true,
-            "PreviewPaths" => ["/previews"],
-            "ViewComponentParentClasses" => %w[ViewComponent::Base ApplicationComponent MyApp::BaseComponent]
-          }
-        )
-      end
-
-      it "does not register an offense for the namespaced custom parent class" do
-        expect_no_offenses(<<~RUBY, "/app/components/my_app/base_component.rb")
-          module MyApp
-            class BaseComponent < ViewComponent::Base
-            end
-          end
-        RUBY
-      end
-    end
   end
 end

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

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require "fileutils"
+require "tmpdir"
+
 RSpec.describe RuboCop::Cop::ViewComponent::PreferComposition, :config do
   let(:config) { RuboCop::Config.new }
 
@@ -55,6 +58,62 @@ RSpec.describe RuboCop::Cop::ViewComponent::PreferComposition, :config do
     end
   end
 
+  context "when the parent is a resolvable component with its own template" do
+    it "registers an offense" do
+      allow(File).to receive(:exist?).and_call_original
+      allow(File).to receive(:exist?).with("/test_source.html.erb").and_return(true)
+
+      expect_offense(<<~RUBY)
+        class BaseCardComponent < ViewComponent::Base
+        end
+
+        class UserCardComponent < BaseCardComponent
+                                  ^^^^^^^^^^^^^^^^^ ViewComponent/PreferComposition: Avoid inheriting from another ViewComponent.
+        end
+      RUBY
+    end
+  end
+
+  context "when the parent is a resolvable component without a template" do
+    it "does not register an offense" do
+      expect_no_offenses(<<~RUBY)
+        class BaseCardComponent < ViewComponent::Base
+        end
+
+        class UserCardComponent < BaseCardComponent
+        end
+      RUBY
+    end
+  end
+
+  context "when the parent resolves to a non-ViewComponent class" do
+    it "does not register an offense even when the name ends with Component" do
+      expect_no_offenses(<<~RUBY)
+        class WidgetComponent
+        end
+
+        class UserCardComponent < WidgetComponent
+        end
+      RUBY
+    end
+  end
+
+  context "when inheriting from a namespaced abstract base class" do
+    it "does not register an offense" do
+      expect_no_offenses(<<~RUBY)
+        module Shadcn
+          class ApplicationViewComponent < ViewComponent::Base
+          end
+
+          module Button
+            class Component < ApplicationViewComponent
+            end
+          end
+        end
+      RUBY
+    end
+  end
+
   context "when class has no parent" do
     it "does not register an offense" do
       expect_no_offenses(<<~RUBY)
@@ -89,18 +148,46 @@ RSpec.describe RuboCop::Cop::ViewComponent::PreferComposition, :config do
     end
   end
 
-  context "when ViewComponentParentClasses is configured" do
+  context "with AdditionalSourcePaths" do
+    let(:engine_dir) { Dir.mktmpdir("engine") }
+
     let(:config) do
       RuboCop::Config.new(
         "ViewComponent/PreferComposition" => {
-          "ViewComponentParentClasses" => ["Primer::Component"]
+          "AdditionalSourcePaths" => [File.join(engine_dir, "app", "components")]
         }
       )
     end
 
-    it "does not register an offense for configured parent classes" do
+    before do
+      write_engine_component("engine_card", "EngineCard")
+      write_engine_component("engine_base", "EngineBase")
+    end
+
+    after { FileUtils.remove_entry(engine_dir) }
+
+    def write_engine_component(dir_name, class_name)
+      dir = File.join(engine_dir, "app", "components", dir_name)
+      FileUtils.mkdir_p(dir)
+      File.write(
+        File.join(dir, "component.rb"),
+        "module #{class_name}\n  class Component < ViewComponent::Base\n  end\nend\n"
+      )
+    end
+
+    it "resolves a parent through the additional paths and flags one with a template" do
+      File.write(File.join(engine_dir, "app", "components", "engine_card", "component.html.erb"), "<div></div>\n")
+
+      expect_offense(<<~RUBY)
+        class UserCardComponent < EngineCard::Component
+                                  ^^^^^^^^^^^^^^^^^^^^^ Avoid inheriting from another ViewComponent.
+        end
+      RUBY
+    end
+
+    it "does not flag a parent resolved through the additional paths without a template" do
       expect_no_offenses(<<~RUBY)
-        class FooBarComponent < Primer::Component
+        class UserCardComponent < EngineBase::Component
         end
       RUBY
     end