rubocop-view_component 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60cf1f19ad3af3d8c80a7da526c8fcc77658723067e67bb42b6ce4bd97709302
-  data.tar.gz: ac9a362b04a16a58549e0733c72fbf874ae7ca954ce0509eac5fe763f00283c5
+  metadata.gz: 2ff827bf609adb03d687cb67fd54a92034775774f64cd0aa2808f3ceafc111fd
+  data.tar.gz: edadf55c4fdfdfb845a4377a23181358fc8a3fe178e1855ab97c96d41f775d84
 SHA512:
-  metadata.gz: 7282cc87157b8b189a735b776cf93d48f9084b93a60a637e8a349806cef1706d1aa3581a308a2ccac21cdff7fe7613dd6fd0098c5d542493f2a98c87b8280bea
-  data.tar.gz: bc67d21c75e60619c11e75db291f602f8a9967a7b1c31041341207a4ccba72e9aafe3029fd1efdb9db2a60c36b68e4b961e7fe40c50bd50d8023958ea0472944
+  metadata.gz: f8e2797d135b4978f4dc2abce7f36d0789382d3d494d6843bc3aa20c46406c8820cd916028e4ccc780b72035746416ac5db3ca9cbc24543dcf8928846d6d348f
+  data.tar.gz: 5615b9b6c3c9f3f195a99bd6e9e3bee741039e383d59d19be8f1c2bc1a3a5cbd9d06bed97dae181b54e84087ebf477be3038b1f26476e079d254ad62612417da

data/config/default.yml

@@ -55,3 +55,4 @@ ViewComponent/TestRenderedOutput:
   Include:
     - 'spec/components/**/*_spec.rb'
     - 'test/components/**/*_test.rb'
+  TestPaths: []

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

@@ -27,6 +27,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)
@@ -37,6 +38,7 @@ module RuboCop
 
         # Check RSpec-style it blocks
         def on_block(node)
+          return unless within_test_paths?
           return unless rspec_it_block?(node)
           return unless instantiates_component?(node)
           return if contains_render_method?(node)
@@ -46,6 +48,14 @@ module RuboCop
 
         private
 
+        def within_test_paths?
+          test_paths = cop_config["TestPaths"]
+          return true if test_paths.nil? || test_paths.empty?
+
+          file_path = processed_source.path
+          test_paths.any? { |path| file_path.include?(path) }
+        end
+
         def instantiates_component?(node)
           node.each_descendant(:send).any? do |send_node|
             next unless send_node.method_name == :new

data/lib/rubocop/view_component/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module ViewComponent
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

data/script/verify

@@ -21,7 +21,7 @@ def load_libraries
       tarball_url: library["tarball_url"],
       verification_dir: File.join(GEM_DIR, "verification", library_key),
       config_file: File.join(GEM_DIR, "verification", "#{library_key}_rubocop_config.yml"),
-      results_file: File.join(GEM_DIR, "spec", "expected_#{library_key}_failures.json"),
+      results_file: File.join(GEM_DIR, "spec", "expected_#{library_key}_failures.yml"),
       display_name: library["display_name"]
     }
   end
@@ -134,22 +134,39 @@ end
 
 def extract_offenses(rubocop_output)
   data = JSON.parse(rubocop_output)
-  data["files"].flat_map do |file|
-    file["offenses"].map do |offense|
-      {
-        "path" => file["path"],
-        "line" => offense["location"]["start_line"],
-        "cop" => offense["cop_name"],
-        "message" => offense["message"]
+  offenses_by_cop = Hash.new { |h, k| h[k] = [] }
+
+  data["files"].each do |file|
+    file["offenses"].each do |offense|
+      offenses_by_cop[offense["cop_name"]] << {
+        location: "#{file["path"]}:#{offense["location"]["start_line"]}",
+        message: offense["message"]
       }
     end
   end
+
+  offenses_by_cop.transform_values { |os| os.sort_by { |o| o[:location] } }.sort.to_h
 end
 
 def regenerate(offenses, results_file)
-  json = "#{JSON.pretty_generate(offenses)}\n"
-  File.write(results_file, json)
-  puts "#{offenses.length} offense(s) written to #{results_file}"
+  lines = []
+  lines << "# This file is auto-generated by `script/verify --regenerate`."
+  lines << "# It captures known offenses in the library source."
+  lines << "---"
+
+  offenses.each do |cop, entries|
+    lines << "#{cop}:"
+    entries.each { |e| lines << "  - #{e[:location]} # #{e[:message]}" }
+  end
+
+  File.write(results_file, lines.join("\n") + "\n")
+  total = offenses.values.sum(&:length)
+  puts "#{total} offense(s) written to #{results_file}"
+end
+
+def load_expected(results_file)
+  # YAML strips inline comments, so each entry loads as just the location string
+  YAML.load_file(results_file)
 end
 
 def verify(offenses, results_file)
@@ -157,19 +174,21 @@ def verify(offenses, results_file)
     abort "ERROR: #{results_file} not found. Run '#{$PROGRAM_NAME} --regenerate' first."
   end
 
-  current_json = JSON.pretty_generate(offenses)
-  expected_json = File.read(results_file)
+  expected = load_expected(results_file)
+  current = offenses.transform_values { |os| os.map { |o| o[:location] } }
 
-  if current_json.strip == expected_json.strip
+  if current == expected
     puts "Verification passed: output matches #{results_file}"
   else
     puts "Verification failed: output differs from #{results_file}"
-    expected = JSON.parse(expected_json)
-    added = offenses - expected
-    removed = expected - offenses
 
-    added.each { |o| puts "  + #{o["cop"]}: #{o["path"]}:#{o["line"]}" }
-    removed.each { |o| puts "  - #{o["cop"]}: #{o["path"]}:#{o["line"]}" }
+    all_cops = (current.keys + expected.keys).uniq.sort
+    all_cops.each do |cop|
+      added = (current[cop] || []) - (expected[cop] || [])
+      removed = (expected[cop] || []) - (current[cop] || [])
+      added.each { |loc| puts "  + #{cop}: #{loc}" }
+      removed.each { |loc| puts "  - #{cop}: #{loc}" }
+    end
 
     exit 1
   end

data/spec/expected_govuk_failures.yml

@@ -0,0 +1,39 @@
+# This file is auto-generated by `script/verify --regenerate`.
+# It captures known offenses in the library source.
+---
+ViewComponent/ComponentSuffix:
+  - app/components/govuk_component/base.rb:1 # ViewComponent class names should end with `Component`. (https://viewcomponent.org/best_practices.html)
+  - app/components/govuk_component/header_component.rb:46 # ViewComponent class names should end with `Component`. (https://viewcomponent.org/best_practices.html)
+  - app/components/govuk_component/notification_banner_component.rb:33 # ViewComponent class names should end with `Component`. (https://viewcomponent.org/best_practices.html)
+  - app/components/govuk_component/pagination_component/adjacent_page.rb:1 # ViewComponent class names should end with `Component`. (https://viewcomponent.org/best_practices.html)
+  - app/components/govuk_component/pagination_component/item.rb:1 # ViewComponent class names should end with `Component`. (https://viewcomponent.org/best_practices.html)
+  - app/components/govuk_component/tab_component.rb:21 # ViewComponent class names should end with `Component`. (https://viewcomponent.org/best_practices.html)
+ViewComponent/PreferPrivateMethods:
+  - app/components/govuk_component/base.rb:29 # Consider making `brand` private. Only ViewComponent interface methods should be public. (https://viewcomponent.org/best_practices.html)
+  - app/components/govuk_component/base.rb:35 # Consider making `class_prefix` private. Only ViewComponent interface methods should be public. (https://viewcomponent.org/best_practices.html)
+  - app/components/govuk_component/notification_banner_component.rb:55 # Consider making `link` private. Only ViewComponent interface methods should be public. (https://viewcomponent.org/best_practices.html)
+  - app/components/govuk_component/notification_banner_component.rb:59 # Consider making `default_attributes` private. Only ViewComponent interface methods should be public. (https://viewcomponent.org/best_practices.html)
+  - app/components/govuk_component/service_navigation_component.rb:54 # Consider making `navigation` private. Only ViewComponent interface methods should be public. (https://viewcomponent.org/best_practices.html)
+  - app/components/govuk_component/service_navigation_component.rb:62 # Consider making `navigation_list` private. Only ViewComponent interface methods should be public. (https://viewcomponent.org/best_practices.html)
+  - app/components/govuk_component/tab_component.rb:32 # Consider making `hidden_class` private. Only ViewComponent interface methods should be public. (https://viewcomponent.org/best_practices.html)
+  - app/components/govuk_component/tab_component.rb:38 # Consider making `li_classes` private. Only ViewComponent interface methods should be public. (https://viewcomponent.org/best_practices.html)
+  - app/components/govuk_component/tab_component.rb:42 # Consider making `li_link` private. Only ViewComponent interface methods should be public. (https://viewcomponent.org/best_practices.html)
+  - app/components/govuk_component/tab_component.rb:46 # Consider making `default_attributes` private. Only ViewComponent interface methods should be public. (https://viewcomponent.org/best_practices.html)
+  - app/components/govuk_component/tab_component.rb:50 # Consider making `combined_attributes` private. Only ViewComponent interface methods should be public. (https://viewcomponent.org/best_practices.html)
+ViewComponent/TestRenderedOutput:
+  - spec/components/govuk_component/accordion_component_spec.rb:84 # Test instantiates a component but doesn't use `render_inline` or `render_preview`. Test the rendered output instead of component methods directly. (https://viewcomponent.org/guide/testing.html)
+  - spec/components/govuk_component/breadcrumbs_component_spec.rb:44 # Test instantiates a component but doesn't use `render_inline` or `render_preview`. Test the rendered output instead of component methods directly. (https://viewcomponent.org/guide/testing.html)
+  - spec/components/govuk_component/configuration/footer_component_configuration_spec.rb:42 # Test instantiates a component but doesn't use `render_inline` or `render_preview`. Test the rendered output instead of component methods directly. (https://viewcomponent.org/guide/testing.html)
+  - spec/components/govuk_component/footer_component_spec.rb:123 # Test instantiates a component but doesn't use `render_inline` or `render_preview`. Test the rendered output instead of component methods directly. (https://viewcomponent.org/guide/testing.html)
+  - spec/components/govuk_component/footer_component_spec.rb:182 # Test instantiates a component but doesn't use `render_inline` or `render_preview`. Test the rendered output instead of component methods directly. (https://viewcomponent.org/guide/testing.html)
+  - spec/components/govuk_component/footer_component_spec.rb:235 # Test instantiates a component but doesn't use `render_inline` or `render_preview`. Test the rendered output instead of component methods directly. (https://viewcomponent.org/guide/testing.html)
+  - spec/components/govuk_component/footer_component_spec.rb:254 # Test instantiates a component but doesn't use `render_inline` or `render_preview`. Test the rendered output instead of component methods directly. (https://viewcomponent.org/guide/testing.html)
+  - spec/components/govuk_component/footer_component_spec.rb:274 # Test instantiates a component but doesn't use `render_inline` or `render_preview`. Test the rendered output instead of component methods directly. (https://viewcomponent.org/guide/testing.html)
+  - spec/components/govuk_component/footer_component_spec.rb:294 # Test instantiates a component but doesn't use `render_inline` or `render_preview`. Test the rendered output instead of component methods directly. (https://viewcomponent.org/guide/testing.html)
+  - spec/components/govuk_component/footer_component_spec.rb:312 # Test instantiates a component but doesn't use `render_inline` or `render_preview`. Test the rendered output instead of component methods directly. (https://viewcomponent.org/guide/testing.html)
+  - spec/components/govuk_component/footer_component_spec.rb:336 # Test instantiates a component but doesn't use `render_inline` or `render_preview`. Test the rendered output instead of component methods directly. (https://viewcomponent.org/guide/testing.html)
+  - spec/components/govuk_component/notification_banner_component_spec.rb:59 # Test instantiates a component but doesn't use `render_inline` or `render_preview`. Test the rendered output instead of component methods directly. (https://viewcomponent.org/guide/testing.html)
+  - spec/components/govuk_component/pagination_component_spec.rb:317 # Test instantiates a component but doesn't use `render_inline` or `render_preview`. Test the rendered output instead of component methods directly. (https://viewcomponent.org/guide/testing.html)
+  - spec/components/govuk_component/task_list_component_spec.rb:139 # Test instantiates a component but doesn't use `render_inline` or `render_preview`. Test the rendered output instead of component methods directly. (https://viewcomponent.org/guide/testing.html)
+  - spec/components/govuk_component/warning_text_component_spec.rb:11 # Test instantiates a component but doesn't use `render_inline` or `render_preview`. Test the rendered output instead of component methods directly. (https://viewcomponent.org/guide/testing.html)
+  - spec/components/govuk_component/warning_text_component_spec.rb:41 # Test instantiates a component but doesn't use `render_inline` or `render_preview`. Test the rendered output instead of component methods directly. (https://viewcomponent.org/guide/testing.html)

data/spec/expected_polaris_failures.yml

@@ -0,0 +1,65 @@
+# This file is auto-generated by `script/verify --regenerate`.
+# It captures known offenses in the library source.
+---
+ViewComponent/ComponentSuffix:
+  - app/components/polaris/base_button.rb:4 # ViewComponent class names should end with `Component`.
+  - app/components/polaris/base_checkbox.rb:2 # ViewComponent class names should end with `Component`.
+  - app/components/polaris/base_radio_button.rb:2 # ViewComponent class names should end with `Component`.
+  - app/components/polaris/headless_button.rb:4 # ViewComponent class names should end with `Component`.
+  - app/components/polaris/layout/annotated_section.rb:5 # ViewComponent class names should end with `Component`.
+  - app/components/polaris/layout/section.rb:5 # ViewComponent class names should end with `Component`.
+  - app/components/polaris/text_field_component.rb:195 # ViewComponent class names should end with `Component`.
+ViewComponent/NoGlobalState:
+  - app/components/polaris/shopify_navigation_component.rb:59 # Avoid accessing `request` directly in ViewComponents. Pass necessary data through the constructor instead.
+ViewComponent/PreferPrivateMethods:
+  - app/components/polaris/action_list/section_component.rb:16 # Consider making `system_arguments` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/avatar_component.rb:43 # Consider making `style_class` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/avatar_component.rb:69 # Consider making `xor_hash` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/banner_component.rb:77 # Consider making `default_icon` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/base_checkbox.rb:24 # Consider making `system_arguments` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/base_checkbox.rb:40 # Consider making `indeterminate?` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/base_radio_button.rb:21 # Consider making `system_arguments` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/button_group_component.rb:60 # Consider making `all_items` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/checkbox_component.rb:62 # Consider making `indeterminate?` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/choice_list_component.rb:58 # Consider making `renders?` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/choice_list_component.rb:62 # Consider making `multiple_choice_allowed?` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/collapsible_component.rb:15 # Consider making `system_arguments` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/description_list_component.rb:24 # Consider making `renders?` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/dropzone_component.rb:142 # Consider making `drop_actions` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/exception_list_component.rb:16 # Consider making `renders?` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/filters_component.rb:74 # Consider making `popover_arguments` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/form_layout_component.rb:29 # Consider making `all_items` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/headless_button.rb:104 # Consider making `html_options` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/headless_button.rb:96 # Consider making `system_arguments` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/index_table/cell_component.rb:7 # Consider making `system_arguments` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/inline_error_component.rb:14 # Consider making `renders?` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/keyboard_key_component.rb:9 # Consider making `system_arguments` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/label_component.rb:32 # Consider making `renders?` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/layout_component.rb:38 # Consider making `all_sections` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/modal/section_component.rb:6 # Consider making `system_arguments` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/navigation/item_component.rb:54 # Consider making `item_inner_wrapper_classes` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/navigation/item_component.rb:62 # Consider making `link_classes` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/navigation/item_component.rb:71 # Consider making `selected_sub_items?` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/navigation_component.rb:11 # Consider making `renders?` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/navigation_list_component.rb:9 # Consider making `renders?` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/new_tabs_component.rb:33 # Consider making `renders?` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/option_list/checkbox_component.rb:25 # Consider making `system_arguments` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/option_list/option_component.rb:6 # Consider making `system_arguments` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/option_list/radio_button_component.rb:32 # Consider making `system_arguments` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/option_list/section_component.rb:42 # Consider making `system_arguments` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/page_component.rb:57 # Consider making `title_length` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/popover/section_component.rb:6 # Consider making `system_arguments` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/popover_component.rb:112 # Consider making `popover_placement` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/resource_item/shortcut_actions_component.rb:82 # Consider making `action_list_item_arguments` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/resource_list_component.rb:37 # Consider making `resource_string` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/resource_list_component.rb:43 # Consider making `count` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/select_component.rb:88 # Consider making `hides_label?` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/shopify_navigation_component.rb:40 # Consider making `system_arguments` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/shopify_navigation_component.rb:56 # Consider making `detect_active` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/skeleton_display_text_component.rb:17 # Consider making `system_arguments` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/skeleton_thumbnail_component.rb:16 # Consider making `system_arguments` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/tabs_component.rb:33 # Consider making `renders?` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/text_component.rb:114 # Consider making `alignment_class` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/text_component.rb:120 # Consider making `color_class` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/text_component.rb:126 # Consider making `font_weight_class` private. Only ViewComponent interface methods should be public.
+  - app/components/polaris/thumbnail_component.rb:39 # Consider making `renders?` private. Only ViewComponent interface methods should be public.

data/spec/expected_primer_failures.yml

@@ -0,0 +1,27 @@
+# This file is auto-generated by `script/verify --regenerate`.
+# It captures known offenses in the library source.
+---
+ViewComponent/PreferPrivateMethods:
+  - app/components/primer/alpha/action_list.rb:189 # Consider making `build_item` private. Only ViewComponent interface methods should be public.
+  - app/components/primer/alpha/action_list.rb:217 # Consider making `build_avatar_item` private. Only ViewComponent interface methods should be public.
+  - app/components/primer/alpha/action_list.rb:228 # Consider making `single_select?` private. Only ViewComponent interface methods should be public.
+  - app/components/primer/alpha/action_list.rb:236 # Consider making `allows_selection?` private. Only ViewComponent interface methods should be public.
+  - app/components/primer/alpha/action_list.rb:240 # Consider making `acts_as_listbox?` private. Only ViewComponent interface methods should be public.
+  - app/components/primer/alpha/action_list.rb:244 # Consider making `acts_as_menu?` private. Only ViewComponent interface methods should be public.
+  - app/components/primer/alpha/action_list.rb:248 # Consider making `required_form_arguments_given?` private. Only ViewComponent interface methods should be public.
+  - app/components/primer/alpha/action_list.rb:257 # Consider making `will_add_item` private. Only ViewComponent interface methods should be public.
+  - app/components/primer/alpha/action_list.rb:53 # Consider making `custom_element_name` private. Only ViewComponent interface methods should be public.
+  - app/components/primer/alpha/action_list/divider.rb:33 # Consider making `active?` private. Only ViewComponent interface methods should be public.
+  - app/components/primer/alpha/action_list/form_wrapper.rb:53 # Consider making `get?` private. Only ViewComponent interface methods should be public.
+  - app/components/primer/alpha/dropdown/menu.rb:96 # Consider making `divider?` private. Only ViewComponent interface methods should be public.
+  - app/components/primer/alpha/form_control.rb:101 # Consider making `visually_hide_label?` private. Only ViewComponent interface methods should be public.
+  - app/components/primer/alpha/form_control.rb:107 # Consider making `full_width?` private. Only ViewComponent interface methods should be public.
+  - app/components/primer/alpha/toggle_switch.rb:94 # Consider making `on?` private. Only ViewComponent interface methods should be public.
+  - app/components/primer/alpha/toggle_switch.rb:98 # Consider making `enabled?` private. Only ViewComponent interface methods should be public.
+  - app/components/primer/alpha/tree_view/node.rb:155 # Consider making `merge_system_arguments!` private. Only ViewComponent interface methods should be public.
+  - app/components/primer/beta/avatar.rb:22 # Consider making `link?` private. Only ViewComponent interface methods should be public.
+  - app/components/primer/beta/nav_list.rb:116 # Consider making `build_item` private. Only ViewComponent interface methods should be public.
+  - app/components/primer/beta/nav_list.rb:139 # Consider making `build_avatar_item` private. Only ViewComponent interface methods should be public.
+ViewComponent/TestRenderedOutput:
+  - test/components/alpha/action_list_test.rb:253 # Test instantiates a component but doesn't use `render_inline` or `render_preview`. Test the rendered output instead of component methods directly.
+  - test/components/alpha/action_list_test.rb:268 # Test instantiates a component but doesn't use `render_inline` or `render_preview`. Test the rendered output instead of component methods directly.

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

@@ -96,6 +96,40 @@ RSpec.describe RuboCop::Cop::ViewComponent::TestRenderedOutput, :config do
     end
   end
 
+  context "with TestPaths configured" do
+    let(:config) do
+      RuboCop::Config.new(
+        "AllCops" => {"DisplayCopNames" => true},
+        "ViewComponent/TestRenderedOutput" => {
+          "TestPaths" => ["spec/components/v2/"]
+        }
+      )
+    end
+
+    context "when file is within a configured TestPath" do
+      it "registers an offense" do
+        expect_offense(<<~RUBY, "spec/components/v2/button_component_spec.rb")
+          def test_formatted_title
+          ^^^^^^^^^^^^^^^^^^^^^^^^ 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_equal "HELLO", component.formatted_title
+          end
+        RUBY
+      end
+    end
+
+    context "when file is outside all configured TestPaths" do
+      it "does not register an offense" do
+        expect_no_offenses(<<~RUBY, "spec/components/v1/button_component_spec.rb")
+          def test_formatted_title
+            component = UserComponent.new("hello")
+            assert_equal "HELLO", component.formatted_title
+          end
+        RUBY
+      end
+    end
+  end
+
   context "with RSpec-style tests" do
     context "when it block instantiates a component but doesn't render" do
       it "registers an offense" do

data/verification/primer_rubocop_config.yml

@@ -3,6 +3,11 @@ AllCops:
     - Primer::Component
     - Primer::BaseComponent
 
+# Primer seems to intentionally omit the Component suffix from most class names
+# (116 out of 131 components), so this cop is not useful here.
+ViewComponent/ComponentSuffix:
+  Enabled: false
+
 # Primer::Forms::BaseComponent is not a ViewComponent - it's a custom base class
 # for a forms framework that mimics the component interface but doesn't inherit
 # from ViewComponent::Base

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-view_component
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Andy Waite
@@ -93,9 +93,9 @@ files:
 - lib/rubocop/view_component/plugin.rb
 - lib/rubocop/view_component/version.rb
 - script/verify
-- spec/expected_govuk_failures.json
-- spec/expected_polaris_failures.json
-- spec/expected_primer_failures.json
+- spec/expected_govuk_failures.yml
+- spec/expected_polaris_failures.yml
+- spec/expected_primer_failures.yml
 - spec/fixtures/components/template_method_component.html.erb
 - spec/fixtures/components/template_method_component.rb
 - spec/rubocop/cop/view_component/component_suffix_spec.rb

data/spec/expected_govuk_failures.json

@@ -1,200 +0,0 @@
-[
-  {
-    "path": "app/components/govuk_component/base.rb",
-    "line": 1,
-    "cop": "ViewComponent/ComponentSuffix",
-    "message": "ViewComponent class names should end with `Component`. (https://viewcomponent.org/best_practices.html)"
-  },
-  {
-    "path": "app/components/govuk_component/base.rb",
-    "line": 29,
-    "cop": "ViewComponent/PreferPrivateMethods",
-    "message": "Consider making `brand` private. Only ViewComponent interface methods should be public. (https://viewcomponent.org/best_practices.html)"
-  },
-  {
-    "path": "app/components/govuk_component/base.rb",
-    "line": 35,
-    "cop": "ViewComponent/PreferPrivateMethods",
-    "message": "Consider making `class_prefix` private. Only ViewComponent interface methods should be public. (https://viewcomponent.org/best_practices.html)"
-  },
-  {
-    "path": "app/components/govuk_component/header_component.rb",
-    "line": 46,
-    "cop": "ViewComponent/ComponentSuffix",
-    "message": "ViewComponent class names should end with `Component`. (https://viewcomponent.org/best_practices.html)"
-  },
-  {
-    "path": "app/components/govuk_component/notification_banner_component.rb",
-    "line": 33,
-    "cop": "ViewComponent/ComponentSuffix",
-    "message": "ViewComponent class names should end with `Component`. (https://viewcomponent.org/best_practices.html)"
-  },
-  {
-    "path": "app/components/govuk_component/notification_banner_component.rb",
-    "line": 55,
-    "cop": "ViewComponent/PreferPrivateMethods",
-    "message": "Consider making `link` private. Only ViewComponent interface methods should be public. (https://viewcomponent.org/best_practices.html)"
-  },
-  {
-    "path": "app/components/govuk_component/notification_banner_component.rb",
-    "line": 59,
-    "cop": "ViewComponent/PreferPrivateMethods",
-    "message": "Consider making `default_attributes` private. Only ViewComponent interface methods should be public. (https://viewcomponent.org/best_practices.html)"
-  },
-  {
-    "path": "app/components/govuk_component/pagination_component/adjacent_page.rb",
-    "line": 1,
-    "cop": "ViewComponent/ComponentSuffix",
-    "message": "ViewComponent class names should end with `Component`. (https://viewcomponent.org/best_practices.html)"
-  },
-  {
-    "path": "app/components/govuk_component/pagination_component/item.rb",
-    "line": 1,
-    "cop": "ViewComponent/ComponentSuffix",
-    "message": "ViewComponent class names should end with `Component`. (https://viewcomponent.org/best_practices.html)"
-  },
-  {
-    "path": "app/components/govuk_component/service_navigation_component.rb",
-    "line": 54,
-    "cop": "ViewComponent/PreferPrivateMethods",
-    "message": "Consider making `navigation` private. Only ViewComponent interface methods should be public. (https://viewcomponent.org/best_practices.html)"
-  },
-  {
-    "path": "app/components/govuk_component/service_navigation_component.rb",
-    "line": 62,
-    "cop": "ViewComponent/PreferPrivateMethods",
-    "message": "Consider making `navigation_list` private. Only ViewComponent interface methods should be public. (https://viewcomponent.org/best_practices.html)"
-  },
-  {
-    "path": "app/components/govuk_component/tab_component.rb",
-    "line": 21,
-    "cop": "ViewComponent/ComponentSuffix",
-    "message": "ViewComponent class names should end with `Component`. (https://viewcomponent.org/best_practices.html)"
-  },
-  {
-    "path": "app/components/govuk_component/tab_component.rb",
-    "line": 32,
-    "cop": "ViewComponent/PreferPrivateMethods",
-    "message": "Consider making `hidden_class` private. Only ViewComponent interface methods should be public. (https://viewcomponent.org/best_practices.html)"
-  },
-  {
-    "path": "app/components/govuk_component/tab_component.rb",
-    "line": 38,
-    "cop": "ViewComponent/PreferPrivateMethods",
-    "message": "Consider making `li_classes` private. Only ViewComponent interface methods should be public. (https://viewcomponent.org/best_practices.html)"
-  },
-  {
-    "path": "app/components/govuk_component/tab_component.rb",
-    "line": 42,
-    "cop": "ViewComponent/PreferPrivateMethods",
-    "message": "Consider making `li_link` private. Only ViewComponent interface methods should be public. (https://viewcomponent.org/best_practices.html)"
-  },
-  {
-    "path": "app/components/govuk_component/tab_component.rb",
-    "line": 46,
-    "cop": "ViewComponent/PreferPrivateMethods",
-    "message": "Consider making `default_attributes` private. Only ViewComponent interface methods should be public. (https://viewcomponent.org/best_practices.html)"
-  },
-  {
-    "path": "app/components/govuk_component/tab_component.rb",
-    "line": 50,
-    "cop": "ViewComponent/PreferPrivateMethods",
-    "message": "Consider making `combined_attributes` private. Only ViewComponent interface methods should be public. (https://viewcomponent.org/best_practices.html)"
-  },
-  {
-    "path": "spec/components/govuk_component/accordion_component_spec.rb",
-    "line": 84,
-    "cop": "ViewComponent/TestRenderedOutput",
-    "message": "Test instantiates a component but doesn't use `render_inline` or `render_preview`. Test the rendered output instead of component methods directly. (https://viewcomponent.org/guide/testing.html)"
-  },
-  {
-    "path": "spec/components/govuk_component/breadcrumbs_component_spec.rb",
-    "line": 44,
-    "cop": "ViewComponent/TestRenderedOutput",
-    "message": "Test instantiates a component but doesn't use `render_inline` or `render_preview`. Test the rendered output instead of component methods directly. (https://viewcomponent.org/guide/testing.html)"
-  },
-  {
-    "path": "spec/components/govuk_component/configuration/footer_component_configuration_spec.rb",
-    "line": 42,
-    "cop": "ViewComponent/TestRenderedOutput",
-    "message": "Test instantiates a component but doesn't use `render_inline` or `render_preview`. Test the rendered output instead of component methods directly. (https://viewcomponent.org/guide/testing.html)"
-  },
-  {
-    "path": "spec/components/govuk_component/footer_component_spec.rb",
-    "line": 123,
-    "cop": "ViewComponent/TestRenderedOutput",
-    "message": "Test instantiates a component but doesn't use `render_inline` or `render_preview`. Test the rendered output instead of component methods directly. (https://viewcomponent.org/guide/testing.html)"
-  },
-  {
-    "path": "spec/components/govuk_component/footer_component_spec.rb",
-    "line": 182,
-    "cop": "ViewComponent/TestRenderedOutput",
-    "message": "Test instantiates a component but doesn't use `render_inline` or `render_preview`. Test the rendered output instead of component methods directly. (https://viewcomponent.org/guide/testing.html)"
-  },
-  {
-    "path": "spec/components/govuk_component/footer_component_spec.rb",
-    "line": 235,
-    "cop": "ViewComponent/TestRenderedOutput",
-    "message": "Test instantiates a component but doesn't use `render_inline` or `render_preview`. Test the rendered output instead of component methods directly. (https://viewcomponent.org/guide/testing.html)"
-  },
-  {
-    "path": "spec/components/govuk_component/footer_component_spec.rb",
-    "line": 254,
-    "cop": "ViewComponent/TestRenderedOutput",
-    "message": "Test instantiates a component but doesn't use `render_inline` or `render_preview`. Test the rendered output instead of component methods directly. (https://viewcomponent.org/guide/testing.html)"
-  },
-  {
-    "path": "spec/components/govuk_component/footer_component_spec.rb",
-    "line": 274,
-    "cop": "ViewComponent/TestRenderedOutput",
-    "message": "Test instantiates a component but doesn't use `render_inline` or `render_preview`. Test the rendered output instead of component methods directly. (https://viewcomponent.org/guide/testing.html)"
-  },
-  {
-    "path": "spec/components/govuk_component/footer_component_spec.rb",
-    "line": 294,
-    "cop": "ViewComponent/TestRenderedOutput",
-    "message": "Test instantiates a component but doesn't use `render_inline` or `render_preview`. Test the rendered output instead of component methods directly. (https://viewcomponent.org/guide/testing.html)"
-  },
-  {
-    "path": "spec/components/govuk_component/footer_component_spec.rb",
-    "line": 312,
-    "cop": "ViewComponent/TestRenderedOutput",
-    "message": "Test instantiates a component but doesn't use `render_inline` or `render_preview`. Test the rendered output instead of component methods directly. (https://viewcomponent.org/guide/testing.html)"
-  },
-  {
-    "path": "spec/components/govuk_component/footer_component_spec.rb",
-    "line": 336,
-    "cop": "ViewComponent/TestRenderedOutput",
-    "message": "Test instantiates a component but doesn't use `render_inline` or `render_preview`. Test the rendered output instead of component methods directly. (https://viewcomponent.org/guide/testing.html)"
-  },
-  {
-    "path": "spec/components/govuk_component/notification_banner_component_spec.rb",
-    "line": 59,
-    "cop": "ViewComponent/TestRenderedOutput",
-    "message": "Test instantiates a component but doesn't use `render_inline` or `render_preview`. Test the rendered output instead of component methods directly. (https://viewcomponent.org/guide/testing.html)"
-  },
-  {
-    "path": "spec/components/govuk_component/pagination_component_spec.rb",
-    "line": 317,
-    "cop": "ViewComponent/TestRenderedOutput",
-    "message": "Test instantiates a component but doesn't use `render_inline` or `render_preview`. Test the rendered output instead of component methods directly. (https://viewcomponent.org/guide/testing.html)"
-  },
-  {
-    "path": "spec/components/govuk_component/task_list_component_spec.rb",
-    "line": 139,
-    "cop": "ViewComponent/TestRenderedOutput",
-    "message": "Test instantiates a component but doesn't use `render_inline` or `render_preview`. Test the rendered output instead of component methods directly. (https://viewcomponent.org/guide/testing.html)"
-  },
-  {
-    "path": "spec/components/govuk_component/warning_text_component_spec.rb",
-    "line": 11,
-    "cop": "ViewComponent/TestRenderedOutput",
-    "message": "Test instantiates a component but doesn't use `render_inline` or `render_preview`. Test the rendered output instead of component methods directly. (https://viewcomponent.org/guide/testing.html)"
-  },
-  {
-    "path": "spec/components/govuk_component/warning_text_component_spec.rb",
-    "line": 41,
-    "cop": "ViewComponent/TestRenderedOutput",
-    "message": "Test instantiates a component but doesn't use `render_inline` or `render_preview`. Test the rendered output instead of component methods directly. (https://viewcomponent.org/guide/testing.html)"
-  }
-]