rubocop-view_component 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef33893cd9f89fc1d39a7e94d65d7f6278fdda552603a303743713889f851e89
-  data.tar.gz: fad82a125ffcb2463cda70830887e0f3b26f671d8f6a8bcfdc8f2c5a42dc1929
+  metadata.gz: d359676eea94fac5c19cabfdbb56688fa62cd50eb5264e04843f81bb75a9ae58
+  data.tar.gz: e1efa2b33bc90fa5f75255093c79984f4cd7f0340f6034a1ead911b780635298
 SHA512:
-  metadata.gz: b60217625dca16c9b4d6394f1114c362cadad8223459789b59cd9a52c26219200b8e5a9ef0da72825a847a6d11e9816890013575d048902e3f8fc198192ccff4
-  data.tar.gz: b896072336154eec7400ef95362544b90d00004678c86faff46ac6e68db8a0aace2a1f797185c7072fc707f345b5bc3ed5d1e44f8e3244f9a273dd671dc217a9
+  metadata.gz: 51577192c4ad213c49b41a116b6349387d5265a19679626ae0185d783d259803fb9d3a572a1ca449255baebfbdf0a606a72a95f0597803f4bd4844b751b267b9
+  data.tar.gz: '0876d2f67a173ee761d25b68115c8526dc51befa3841b0f9ad09091e1420827e786a442398bd694fcf14c38bbec07190fd11de0b2036e1517311bc66becac6be'

data/README.md

@@ -27,6 +27,7 @@ This gem provides several cops to enforce ViewComponent best practices:
 - **ViewComponent/PreferSlots** - Detect HTML parameters that should be slots
 - **ViewComponent/PreferComposition** - Avoid inheriting one ViewComponent from another (prefer composition)
 - **ViewComponent/TestRenderedOutput** - Encourage testing rendered output over private methods
+- **ViewComponent/MissingPreview** - Ensure every ViewComponent has a corresponding preview file (requires `PreviewPaths` configuration)
 
 ## Optional Configuration
 
@@ -56,7 +57,14 @@ Lint/MissingSuper:
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+To release a new version:
+
+1. Update the version number in `lib/rubocop/view_component/version.rb`
+2. Run `bundle install` to update `Gemfile.lock`
+3. Commit and push both files
+4. Trigger the [Push Gem](https://github.com/andyw8/rubocop-view_component/actions/workflows/push_gem.yml) workflow via GitHub Actions (uses trusted publishing — no API key needed)
 
 ## Real-World Verification
 

data/config/default.yml

@@ -1,5 +1,6 @@
-AllCops:
+ViewComponent:
   ViewComponentParentClasses: []
+  ComponentNamespaces: []
 
 ViewComponent/ComponentSuffix:
   Description: 'Enforce -Component suffix for ViewComponent classes.'
@@ -8,8 +9,20 @@ ViewComponent/ComponentSuffix:
   Severity: convention
   StyleGuide: 'https://viewcomponent.org/best_practices.html'
 
+ViewComponent/MissingPreview:
+  Description: 'Ensure every ViewComponent has a corresponding preview file.'
+  Enabled: true
+  VersionAdded: '0.5.0'
+  Severity: convention
+  Include:
+    - 'app/components/**/*_component.rb'
+  PreviewPaths:
+    - test/components/previews
+    - spec/components/previews
+
 ViewComponent/NoGlobalState:
-  Description: 'Avoid accessing global state (params, request, session, cookies, flash) directly.'
+  Description: 'Avoid accessing global state (params, request, session, cookies,
+    flash) directly.'
   Enabled: true
   VersionAdded: '0.1'
   Severity: convention
@@ -37,7 +50,7 @@ ViewComponent/PreferComposition:
   Enabled: true
   VersionAdded: '0.3'
   Severity: convention
-  StyleGuide: 'https://viewcomponent.org/best_practices.html'
+  StyleGuide: 'https://viewcomponent.org/best_practices.html#avoid-inheritance'
 
 ViewComponent/PreferSlots:
   Description: 'Prefer slots over HTML string parameters.'

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

@@ -9,6 +9,9 @@ module RuboCop
         def view_component_class?(node)
           return false unless node&.class_type?
 
+          class_source = node.identifier.source
+          return true if component_namespaces.any? { |ns| class_source.start_with?(ns) }
+
           parent_class = node.parent_class
           return false unless parent_class
 
@@ -23,10 +26,14 @@ module RuboCop
           source = node.source
           return true if source == "ViewComponent::Base" || source == "ApplicationComponent"
 
-          additional = config.for_all_cops["ViewComponentParentClasses"] || []
+          additional = cop_config["ViewComponentParentClasses"] || []
           additional.include?(source)
         end
 
+        def component_namespaces
+          cop_config["ComponentNamespaces"] || []
+        end
+
         # Find the enclosing class node
         def enclosing_class(node)
           node.each_ancestor(:class).first

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module ViewComponent
+      # Ensures that every ViewComponent has a corresponding preview file.
+      #
+      # Looks for previews in the configured PreviewPaths, supporting both
+      # naming conventions: `user_preview.rb` and `user_component_preview.rb`.
+      #
+      class MissingPreview < RuboCop::Cop::Base
+        include ViewComponent::Base
+
+        MSG = "No preview found for %<component>s (looked in: %<paths>s)."
+
+        def on_class(node)
+          return unless view_component_class?(node)
+
+          class_name = node.identifier.source
+          return if preview_exists?(class_name)
+
+          add_offense(node.identifier, message: format(MSG, component: class_name, paths: preview_paths.join(", ")))
+        end
+
+        private
+
+        def preview_exists?(class_name)
+          preview_paths.any? do |preview_path|
+            candidate_filenames(class_name).any? do |filename|
+              File.exist?(File.join(preview_path, filename))
+            end
+          end
+        end
+
+        def candidate_filenames(class_name)
+          base = class_name.gsub(/Component$/, "").gsub("::", "/").gsub(/([A-Z])/, '_\1').downcase.gsub("/_", "/")
+          base = base.delete_prefix("_").delete_prefix("/")
+          [
+            "#{base}_preview.rb",
+            "#{base}_component_preview.rb"
+          ]
+        end
+
+        def preview_paths
+          cop_config.fetch("PreviewPaths", [])
+        end
+      end
+    end
+  end
+end

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

@@ -5,6 +5,11 @@ module RuboCop
     module ViewComponent
       # Prevents direct access to global state within ViewComponent classes.
       #
+      # ViewComponent's own documentation notes that accessing `request` directly
+      # "introduces coupling that inhibits encapsulation & reuse, often making
+      # testing difficult." The same principle applies to `params`, `session`,
+      # `cookies`, and `flash`.
+      #
       # @example
       #   # bad
       #   class UserComponent < ViewComponent::Base

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

@@ -36,7 +36,13 @@ module RuboCop
         def component_like_parent?(node)
           return false unless node.const_type?
 
-          node.source.end_with?("Component")
+          source = node.source
+          source.end_with?("Component") ||
+            component_namespaces.any? { |ns| source.start_with?(ns) }
+        end
+
+        def component_namespaces
+          cop_config.fetch("ComponentNamespaces", [])
         end
       end
     end

data/lib/rubocop/cop/view_component_cops.rb

@@ -2,6 +2,7 @@
 
 require_relative "view_component/base"
 require_relative "view_component/component_suffix"
+require_relative "view_component/missing_preview"
 require_relative "view_component/no_global_state"
 require_relative "view_component/prefer_private_methods"
 require_relative "view_component/prefer_composition"

data/lib/rubocop/view_component/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module ViewComponent
-    VERSION = "0.4.1"
+    VERSION = "0.5.0"
   end
 end

data/script/verify

@@ -134,18 +134,15 @@ end
 
 def extract_offenses(rubocop_output)
   data = JSON.parse(rubocop_output)
-  offenses_by_cop = Hash.new { |h, k| h[k] = [] }
+  offenses_by_cop = Hash.new { |h, k| h[k] = Set.new }
 
   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"]
-      }
+      offenses_by_cop[offense["cop_name"]] << file["path"]
     end
   end
 
-  offenses_by_cop.transform_values { |os| os.sort_by { |o| o[:location] } }.sort.to_h
+  offenses_by_cop.transform_values { |paths| paths.sort }.sort.to_h
 end
 
 def regenerate(offenses, results_file)
@@ -154,18 +151,17 @@ def regenerate(offenses, results_file)
   lines << "# It captures known offenses in the library source."
   lines << "---"
 
-  offenses.each do |cop, entries|
+  offenses.each do |cop, paths|
     lines << "#{cop}:"
-    entries.each { |e| lines << "  - #{e[:location]} # #{e[:message]}" }
+    paths.each { |path| lines << "  - '#{path}'" }
   end
 
   File.write(results_file, lines.join("\n") + "\n")
   total = offenses.values.sum(&:length)
-  puts "#{total} offense(s) written to #{results_file}"
+  puts "#{total} file(s) with 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
 
@@ -175,19 +171,18 @@ def verify(offenses, results_file)
   end
 
   expected = load_expected(results_file)
-  current = offenses.transform_values { |os| os.map { |o| o[:location] } }
 
-  if current == expected
+  if offenses == expected
     puts "Verification passed: output matches #{results_file}"
   else
     puts "Verification failed: output differs from #{results_file}"
 
-    all_cops = (current.keys + expected.keys).uniq.sort
+    all_cops = (offenses.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}" }
+      added = (offenses[cop] || []) - (expected[cop] || [])
+      removed = (expected[cop] || []) - (offenses[cop] || [])
+      added.each { |path| puts "  + #{cop}: #{path}" }
+      removed.each { |path| puts "  - #{cop}: #{path}" }
     end
 
     exit 1

data/spec/expected_govuk_failures.yml

@@ -2,38 +2,23 @@
 # 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)
+  - '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/pagination_component/adjacent_page.rb'
+  - 'app/components/govuk_component/pagination_component/item.rb'
+  - 'app/components/govuk_component/tab_component.rb'
 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)
+  - 'app/components/govuk_component/base.rb'
+  - 'app/components/govuk_component/notification_banner_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: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)
+  - '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

@@ -2,64 +2,68 @@
 # 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`.
+  - 'app/components/polaris/base_button.rb'
+  - 'app/components/polaris/base_checkbox.rb'
+  - 'app/components/polaris/base_radio_button.rb'
+  - 'app/components/polaris/headless_button.rb'
+  - 'app/components/polaris/layout/annotated_section.rb'
+  - 'app/components/polaris/layout/section.rb'
+  - 'app/components/polaris/text_field_component.rb'
+ViewComponent/MissingPreview:
+  - 'app/components/polaris/button_group_component.rb'
+  - 'app/components/polaris/choice_component.rb'
+  - 'app/components/polaris/description_list_component.rb'
+  - 'app/components/polaris/filters_component.rb'
+  - 'app/components/polaris/inline_code_component.rb'
+  - 'app/components/polaris/label_component.rb'
+  - 'app/components/polaris/labelled_component.rb'
+  - 'app/components/polaris/list_component.rb'
+  - 'app/components/polaris/page_component.rb'
+  - '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:59 # Avoid accessing `request` directly in ViewComponents. Pass necessary data through the constructor instead.
+  - 'app/components/polaris/shopify_navigation_component.rb'
 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.
+  - 'app/components/polaris/action_list/section_component.rb'
+  - 'app/components/polaris/avatar_component.rb'
+  - 'app/components/polaris/banner_component.rb'
+  - 'app/components/polaris/base_checkbox.rb'
+  - 'app/components/polaris/base_radio_button.rb'
+  - 'app/components/polaris/button_group_component.rb'
+  - 'app/components/polaris/checkbox_component.rb'
+  - 'app/components/polaris/choice_list_component.rb'
+  - 'app/components/polaris/collapsible_component.rb'
+  - 'app/components/polaris/description_list_component.rb'
+  - 'app/components/polaris/dropzone_component.rb'
+  - 'app/components/polaris/exception_list_component.rb'
+  - 'app/components/polaris/filters_component.rb'
+  - 'app/components/polaris/form_layout_component.rb'
+  - 'app/components/polaris/headless_button.rb'
+  - 'app/components/polaris/index_table/cell_component.rb'
+  - 'app/components/polaris/inline_error_component.rb'
+  - 'app/components/polaris/keyboard_key_component.rb'
+  - 'app/components/polaris/label_component.rb'
+  - 'app/components/polaris/layout_component.rb'
+  - 'app/components/polaris/modal/section_component.rb'
+  - 'app/components/polaris/navigation/item_component.rb'
+  - 'app/components/polaris/navigation_component.rb'
+  - 'app/components/polaris/navigation_list_component.rb'
+  - 'app/components/polaris/new_tabs_component.rb'
+  - 'app/components/polaris/option_list/checkbox_component.rb'
+  - 'app/components/polaris/option_list/option_component.rb'
+  - 'app/components/polaris/option_list/radio_button_component.rb'
+  - 'app/components/polaris/option_list/section_component.rb'
+  - 'app/components/polaris/page_component.rb'
+  - 'app/components/polaris/popover/section_component.rb'
+  - 'app/components/polaris/popover_component.rb'
+  - 'app/components/polaris/resource_item/shortcut_actions_component.rb'
+  - 'app/components/polaris/resource_list_component.rb'
+  - 'app/components/polaris/select_component.rb'
+  - 'app/components/polaris/shopify_navigation_component.rb'
+  - 'app/components/polaris/skeleton_display_text_component.rb'
+  - 'app/components/polaris/skeleton_thumbnail_component.rb'
+  - 'app/components/polaris/tabs_component.rb'
+  - 'app/components/polaris/text_component.rb'
+  - 'app/components/polaris/thumbnail_component.rb'

data/spec/expected_primer_failures.yml

@@ -1,27 +1,19 @@
 # This file is auto-generated by `script/verify --regenerate`.
 # It captures known offenses in the library source.
 ---
+ViewComponent/MissingPreview:
+  - 'app/components/primer/blankslate_component.rb'
+  - 'app/components/primer/button_component.rb'
+  - 'app/components/primer/layout_component.rb'
 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.
+  - 'app/components/primer/alpha/action_list.rb'
+  - 'app/components/primer/alpha/action_list/divider.rb'
+  - 'app/components/primer/alpha/action_list/form_wrapper.rb'
+  - 'app/components/primer/alpha/dropdown/menu.rb'
+  - 'app/components/primer/alpha/form_control.rb'
+  - 'app/components/primer/alpha/toggle_switch.rb'
+  - '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: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.
+  - 'test/components/alpha/action_list_test.rb'

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

@@ -77,7 +77,7 @@ RSpec.describe RuboCop::Cop::ViewComponent::ComponentSuffix, :config do
   context "when ViewComponentParentClasses is configured" do
     let(:config) do
       RuboCop::Config.new(
-        "AllCops" => {
+        "ViewComponent/ComponentSuffix" => {
           "ViewComponentParentClasses" => ["Primer::Component"]
         }
       )

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

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+RSpec.describe RuboCop::Cop::ViewComponent::MissingPreview, :config do
+  let(:config) do
+    RuboCop::Config.new(
+      "ViewComponent/MissingPreview" => {
+        "Enabled" => true,
+        "PreviewPaths" => ["/previews"]
+      }
+    )
+  end
+
+  context "when a preview file exists" do
+    it "does not register an offense" do
+      allow(File).to receive(:exist?).and_return(true)
+
+      expect_no_offenses(<<~RUBY, "/app/components/user_component.rb")
+        class UserComponent < ViewComponent::Base
+        end
+      RUBY
+    end
+  end
+
+  context "when no preview file exists" do
+    it "registers an offense" do
+      allow(File).to receive(:exist?).and_return(false)
+
+      expect_offense(<<~RUBY, "/app/components/user_component.rb")
+        class UserComponent < ViewComponent::Base
+              ^^^^^^^^^^^^^ No preview found for UserComponent (looked in: /previews).
+        end
+      RUBY
+    end
+  end
+
+  context "when ComponentNamespaces is configured" do
+    let(:config) do
+      RuboCop::Config.new(
+        "ViewComponent/MissingPreview" => {
+          "Enabled" => true,
+          "PreviewPaths" => ["/previews"],
+          "ComponentNamespaces" => ["V2::"]
+        }
+      )
+    end
+
+    it "registers an offense for a component in a configured namespace" do
+      allow(File).to receive(:exist?).and_return(false)
+
+      expect_offense(<<~RUBY, "/app/components/v2/table.rb")
+        class V2::Table < SomeBase
+              ^^^^^^^^^ No preview found for V2::Table (looked in: /previews).
+        end
+      RUBY
+    end
+
+    it "checks the correct preview path for namespaced classes" 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")
+        class V2::GroupedMultiSelect < V2::MultiSelect
+        end
+      RUBY
+    end
+
+    it "checks the correct preview path for deeply namespaced classes" do
+      allow(File).to receive(:exist?).and_return(false)
+      allow(File).to receive(:exist?).with("/previews/v2/catalogs/index_table_preview.rb").and_return(true)
+
+      expect_no_offenses(<<~RUBY, "/app/components/v2/catalogs/index_table.rb")
+        class V2::Catalogs::IndexTable < V2::Table
+        end
+      RUBY
+    end
+
+    it "does not register an offense for a non-component class in a configured namespace" do
+      allow(File).to receive(:exist?).and_return(false)
+
+      expect_no_offenses(<<~RUBY, "/app/models/user.rb")
+        class User < SomeBase
+        end
+      RUBY
+    end
+  end
+
+  context "when not a ViewComponent" do
+    it "does not register an offense" do
+      allow(File).to receive(:exist?).and_return(false)
+
+      expect_no_offenses(<<~RUBY, "/app/components/user_component.rb")
+        class UserComponent
+        end
+      RUBY
+    end
+  end
+end

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

@@ -64,10 +64,35 @@ RSpec.describe RuboCop::Cop::ViewComponent::PreferComposition, :config do
     end
   end
 
+  context "when ComponentNamespaces is configured" do
+    let(:config) do
+      RuboCop::Config.new(
+        "ViewComponent/PreferComposition" => {
+          "ComponentNamespaces" => ["V2::"]
+        }
+      )
+    end
+
+    it "registers an offense for a class in a configured namespace" do
+      expect_offense(<<~RUBY)
+        class UserCard < V2::Table
+                         ^^^^^^^^^ Avoid inheriting from another ViewComponent.
+        end
+      RUBY
+    end
+
+    it "does not register an offense for a class outside configured namespaces" do
+      expect_no_offenses(<<~RUBY)
+        class UserCard < SomeOtherBase
+        end
+      RUBY
+    end
+  end
+
   context "when ViewComponentParentClasses is configured" do
     let(:config) do
       RuboCop::Config.new(
-        "AllCops" => {
+        "ViewComponent/PreferComposition" => {
           "ViewComponentParentClasses" => ["Primer::Component"]
         }
       )

data/verification/govuk_rubocop_config.yml

@@ -1,3 +1,7 @@
-AllCops:
+ViewComponent:
   ViewComponentParentClasses:
     - GovukComponent::Base
+
+# x-govuk components do not use ViewComponent previews
+ViewComponent/MissingPreview:
+  Enabled: false

data/verification/polaris_rubocop_config.yml

@@ -1,4 +1,45 @@
-AllCops:
+ViewComponent:
   ViewComponentParentClasses:
     - Polaris::Component
     - Component
+
+ViewComponent/MissingPreview:
+  PreviewPaths:
+    - demo/app/previews
+  Exclude:
+    - app/components/polaris/base_component.rb
+    - app/components/polaris/base_button.rb
+    - app/components/polaris/base_checkbox.rb
+    - app/components/polaris/base_radio_button.rb
+    # Sub-components are rendered as part of their parent component's preview
+    # rather than having dedicated preview files
+    - app/components/polaris/action_list/item_component.rb
+    - app/components/polaris/action_list/section_component.rb
+    - app/components/polaris/autocomplete/action_component.rb
+    - app/components/polaris/autocomplete/option_component.rb
+    - app/components/polaris/autocomplete/section_component.rb
+    - app/components/polaris/card/header_component.rb
+    - app/components/polaris/card/section_component.rb
+    - app/components/polaris/data_table/cell_component.rb
+    - app/components/polaris/data_table/column_component.rb
+    - app/components/polaris/exception_list/item_component.rb
+    - app/components/polaris/form_layout/group_component.rb
+    - app/components/polaris/form_layout/item_component.rb
+    - app/components/polaris/frame/save_bar_component.rb
+    - app/components/polaris/frame/top_bar_component.rb
+    - app/components/polaris/index_table/cell_component.rb
+    - app/components/polaris/index_table/column_component.rb
+    - app/components/polaris/modal/section_component.rb
+    - app/components/polaris/navigation/item_component.rb
+    - app/components/polaris/navigation/section_component.rb
+    - app/components/polaris/new_tabs/tab_component.rb
+    - app/components/polaris/option_list/checkbox_component.rb
+    - app/components/polaris/option_list/option_component.rb
+    - app/components/polaris/option_list/radio_button_component.rb
+    - app/components/polaris/option_list/section_component.rb
+    - app/components/polaris/popover/pane_component.rb
+    - app/components/polaris/popover/section_component.rb
+    - app/components/polaris/resource_item/shortcut_actions_component.rb
+    - app/components/polaris/stack/item_component.rb
+    - app/components/polaris/tabs/tab_component.rb
+    - app/components/polaris/top_bar/user_menu_component.rb

data/verification/primer_rubocop_config.yml

@@ -1,4 +1,4 @@
-AllCops:
+ViewComponent:
   ViewComponentParentClasses:
     - Primer::Component
     - Primer::BaseComponent
@@ -22,3 +22,9 @@ ViewComponent/TestRenderedOutput:
     - test/components/base_component_test.rb
     - test/components/component_test.rb
     - test/lib/primer/attributes_helper_test.rb
+
+ViewComponent/MissingPreview:
+  PreviewPaths:
+    - previews
+  Exclude:
+    - app/components/primer/base_component.rb

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-view_component
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Andy Waite
@@ -82,6 +82,7 @@ files:
 - lib/rubocop-view_component.rb
 - lib/rubocop/cop/view_component/base.rb
 - lib/rubocop/cop/view_component/component_suffix.rb
+- lib/rubocop/cop/view_component/missing_preview.rb
 - lib/rubocop/cop/view_component/no_global_state.rb
 - lib/rubocop/cop/view_component/prefer_composition.rb
 - lib/rubocop/cop/view_component/prefer_private_methods.rb
@@ -99,6 +100,7 @@ files:
 - spec/fixtures/components/template_method_component.html.erb
 - spec/fixtures/components/template_method_component.rb
 - spec/rubocop/cop/view_component/component_suffix_spec.rb
+- spec/rubocop/cop/view_component/missing_preview_spec.rb
 - spec/rubocop/cop/view_component/no_global_state_spec.rb
 - spec/rubocop/cop/view_component/prefer_composition_spec.rb
 - spec/rubocop/cop/view_component/prefer_private_methods_spec.rb
@@ -130,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.6
+rubygems_version: 3.6.9
 specification_version: 4
 summary: RuboCop extension for ViewComponent best practices
 test_files: []