gl_rubocop 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55c5e4d549add201fba2d9cdcf5c63b3adf2fff339785be177d2b992c841750a
-  data.tar.gz: 50d1687524ca84b65fca2ab5e8d9502446991aa69b3d0b06f9711d614393785d
+  metadata.gz: fa594b531f0d00238170541e84317172b54acf43dde2e41eede7ad26f7d20d19
+  data.tar.gz: 6f3a07046f7d082f0bcbfe6f98754350ab5966d10c97de0cbac00ad3e189f955
 SHA512:
-  metadata.gz: 3ddaebd810428c15841487137a7f692a17124bd95278244422107540690858398c69667111102f9f9d43e18a5e6326eef3e95fe6e77ff5341fbcdb6844b64aef
-  data.tar.gz: dd7ad7ea6d9f11648bf103da2e743540c6709444e28f926eb6d4692d768a4ae5a6c3da37f023b5ab9f08305fb7c6c52e91a43a57ec89e69555bf716564fa5432
+  metadata.gz: 6726a89cc1d5de58ecb536f729af9ac08a44735ff91e03cba605e50d59193e773644474da29e0068e4b204e169973d921f7a2f3b85b10c666850c5422f61d685
+  data.tar.gz: d9497503468a4d3ce800156293299f857ec5766bbae85887e20699aa62ed71af7d4a5aded239ca56c49c07cad272b778576086dc505013fe30c1c7941ff6cb17

data/default.yml

@@ -112,7 +112,7 @@ GLCops/ViewComponentDirectoryStructure:
 GLCops/ViewComponentInheritance:
   Enabled: true
   Include:
-    - "app/components/**/component.rb"
+    - "app/components/**/*.rb"
 
 GLCops/ViewComponentInitializeKeywordArgs:
   Enabled: true

data/lib/gl_rubocop/gl_cops/view_component_class_naming.rb

@@ -1,24 +1,35 @@
 module GLRubocop
   module GLCops
-    # This cop checks that the class name is "Component" or "ApplicationViewComponent".
+    # This cop checks naming for classes inheriting from
+    # ApplicationViewComponent or ApplicationViewComponentPreview.
     #
     # Good:
-    #   class Component < ViewComponent::Base
+    #   class Component < ApplicationViewComponent
     #   end
     #
-    #   class ApplicationViewComponent < ViewComponent::Base
+    #   class ComponentPreview < ApplicationViewComponentPreview
     #   end
     #
     # Bad:
-    #   class UserCardComponent < ViewComponent::Base
+    #   class UserCardComponent < ApplicationViewComponent
+    #   end
+    #
+    #   class UserCardComponentPreview < ApplicationViewComponentPreview
     #   end
     class ViewComponentClassNaming < RuboCop::Cop::Base
       def on_class(node)
-        class_name = node.identifier.const_name
-        return true if class_name == 'Component'
-        return true if class_name == 'ApplicationViewComponent'
+        parent_class = node.parent_class&.const_name
+        if parent_class == 'ApplicationViewComponent'
+          return true if node.identifier.const_name == 'Component'
+
+          add_offense(node, message: 'ViewComponent class names must be "Component".')
+        end
+        if parent_class == 'ApplicationViewComponentPreview'
+          return true if node.identifier.const_name == 'ComponentPreview'
 
-        add_offense(node, message: 'ViewComponent class names must be "Component".')
+          add_offense(node, message: 'ViewComponentPreview class names must be "ComponentPreview".')
+        end
+        true
       end
     end
   end

data/lib/gl_rubocop/gl_cops/view_component_inheritance.rb

@@ -3,35 +3,62 @@ module GLRubocop
     # This cop checks that all ViewComponent classes inherit from an allowlisted base class.
     #
     # Good:
+    #   class ApplicationViewComponent < ViewComponent::Base
+    #   end
+    #
+    #   class ApplicationViewComponentPreview < ViewComponent::Preview
+    #   end
+    #
     #   class Components::HeroComponent < ApplicationViewComponent
     #   end
     #
-    #   class Components::CardComponent < ViewComponent::Base
+    #   class Components::CardComponentPreview < ApplicationViewComponentPreview
+    #   end
+    #
+    #   class SomeHelperClass < SomeOtherClass
     #   end
     #
     # Bad:
-    #   class Components::HeroComponent < ViewComponent
+    #   class Components::HeroComponent
+    #   end
+    #
+    #   class Components::CardComponent < ViewComponent::Base
+    #   end
+    #
+    #   class Components::CardComponentPreview < ViewComponent::Preview
     #   end
     #
-    #   class Components::CardComponent
+    #   class Components::CardComponentPreview
     #   end
     class ViewComponentInheritance < RuboCop::Cop::Base
-      INHERITANCE_MSG = 'ViewComponent must inherit from ApplicationViewComponent'.freeze
+      COMPONENT_MSG = 'ViewComponents must inherit from ApplicationViewComponent'.freeze
+      PREVIEW_MSG = 'ViewComponentPreviews must inherit from ApplicationViewComponentPreview'.freeze
 
       def on_class(node)
-        return true if inherits_from_application_view_component(node)
+        parent = node.parent_class&.const_name
+        class_name = node.identifier.const_name
 
-        add_offense(node, message: INHERITANCE_MSG)
-      end
+        if class_name.end_with?('ComponentPreview')
+          return true if component_preview_valid?(parent, class_name)
+
+          add_offense(node, message: PREVIEW_MSG)
+        elsif class_name.end_with?('Component')
+          return true if component_valid?(parent, class_name)
 
-      private
+          add_offense(node, message: COMPONENT_MSG)
+        else
+          true
+        end
+      end
 
-      def inherits_from_application_view_component(node)
-        parent = node.parent_class
-        return false unless parent
+      def component_preview_valid?(parent, class_name)
+        class_name == 'ApplicationViewComponentPreview' ||
+          parent == 'ApplicationViewComponentPreview'
+      end
 
-        parent_name = parent.const_name
-        %w[ApplicationViewComponent ViewComponent::Base].include?(parent_name)
+      def component_valid?(parent, class_name)
+        class_name == 'ApplicationViewComponent' ||
+          parent == 'ApplicationViewComponent'
       end
     end
   end

data/lib/gl_rubocop/version.rb

@@ -1,3 +1,3 @@
 module GLRubocop
-  VERSION = '0.5.1'.freeze
+  VERSION = '0.5.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gl_rubocop
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Give Lively
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-04-20 00:00:00.000000000 Z
+date: 2026-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop