gl_rubocop 0.5.0 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83a8c15ce9c97fee3534fd6ec1b13efa8c150b4a6a06042f1408be213022c453
-  data.tar.gz: aef1892a704ffc69e5b4fc5ecc35d3c45461a8cac740c07a635e09a46811895b
+  metadata.gz: fa594b531f0d00238170541e84317172b54acf43dde2e41eede7ad26f7d20d19
+  data.tar.gz: 6f3a07046f7d082f0bcbfe6f98754350ab5966d10c97de0cbac00ad3e189f955
 SHA512:
-  metadata.gz: 796c52aff461d138901b41715b5d677518057ae3cb81715f39036f4e4c92c9c1294732d5e149160addc245eee87065b7fc49ffaad3c936ae0d586f5263dedf42
-  data.tar.gz: 35f95f56ace1f7c2e529df369e5d397b7a6cfd741be5a4a7d53fb7a9ffd849b200919343a0006586cb772403b81d5369c3bda5e406fa924de127ec1c656e5f76
+  metadata.gz: 6726a89cc1d5de58ecb536f729af9ac08a44735ff91e03cba605e50d59193e773644474da29e0068e4b204e169973d921f7a2f3b85b10c666850c5422f61d685
+  data.tar.gz: d9497503468a4d3ce800156293299f857ec5766bbae85887e20699aa62ed71af7d4a5aded239ca56c49c07cad272b778576086dc505013fe30c1c7941ff6cb17

data/default.yml

@@ -21,6 +21,9 @@ require:
   - ./lib/gl_rubocop/gl_cops/valid_data_test_id.rb
   - ./lib/gl_rubocop/gl_cops/vcr_cassette_names.rb
   - ./lib/gl_rubocop/gl_cops/view_component_initialize_keyword_args.rb
+  - ./lib/gl_rubocop/gl_cops/view_component_class_naming.rb
+  - ./lib/gl_rubocop/gl_cops/view_component_inheritance.rb
+  - ./lib/gl_rubocop/gl_cops/view_component_directory_structure.rb
 
 AllCops:
   SuggestExtensions: false
@@ -96,6 +99,21 @@ GLCops/VcrCassetteNames:
   Include:
     - "**/*spec.rb"
 
+GLCops/ViewComponentClassNaming:
+  Enabled: true
+  Include:
+    - "app/components/**/*.rb"
+
+GLCops/ViewComponentDirectoryStructure:
+  Enabled: true
+  Include:
+    - "app/components/**/component.rb"
+
+GLCops/ViewComponentInheritance:
+  Enabled: true
+  Include:
+    - "app/components/**/*.rb"
+
 GLCops/ViewComponentInitializeKeywordArgs:
   Enabled: true
   Include:

data/lib/gl_rubocop/gl_cops/view_component_class_naming.rb

@@ -0,0 +1,36 @@
+module GLRubocop
+  module GLCops
+    # This cop checks naming for classes inheriting from
+    # ApplicationViewComponent or ApplicationViewComponentPreview.
+    #
+    # Good:
+    #   class Component < ApplicationViewComponent
+    #   end
+    #
+    #   class ComponentPreview < ApplicationViewComponentPreview
+    #   end
+    #
+    # Bad:
+    #   class UserCardComponent < ApplicationViewComponent
+    #   end
+    #
+    #   class UserCardComponentPreview < ApplicationViewComponentPreview
+    #   end
+    class ViewComponentClassNaming < RuboCop::Cop::Base
+      def on_class(node)
+        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: 'ViewComponentPreview class names must be "ComponentPreview".')
+        end
+        true
+      end
+    end
+  end
+end

data/lib/gl_rubocop/gl_cops/view_component_directory_structure.rb

@@ -0,0 +1,33 @@
+module GLRubocop
+  module GLCops
+    # This cop checks that all ViewComponent is part of an allowlisted base module.
+    #
+    # Good:
+    #   module Core
+    #     module Users
+    #       class Component < ApplicationViewComponent
+    #       end
+    #     end
+    #   end
+    #
+    # Bad:
+    #   module Billing
+    #     class Component < ApplicationViewComponent
+    #     end
+    #   end
+    class ViewComponentDirectoryStructure < RuboCop::Cop::Base
+      MSG = 'ViewComponent must belong to an allowed base module: %<allowed>s'.freeze
+      ALLOWED_MODULES = %w[Core Admin NonprofitAdmin Packs Users].freeze
+
+      def on_class(node)
+        return true if node.identifier.const_name == 'ApplicationViewComponent'
+
+        base_module = node.parent_module_name&.split('::')&.first
+        return true if base_module.nil?
+        return true if ALLOWED_MODULES.include?(base_module)
+
+        add_offense(node, message: format(MSG, allowed: ALLOWED_MODULES.join(', ')))
+      end
+    end
+  end
+end

data/lib/gl_rubocop/gl_cops/view_component_inheritance.rb

@@ -0,0 +1,65 @@
+module GLRubocop
+  module GLCops
+    # 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::CardComponentPreview < ApplicationViewComponentPreview
+    #   end
+    #
+    #   class SomeHelperClass < SomeOtherClass
+    #   end
+    #
+    # Bad:
+    #   class Components::HeroComponent
+    #   end
+    #
+    #   class Components::CardComponent < ViewComponent::Base
+    #   end
+    #
+    #   class Components::CardComponentPreview < ViewComponent::Preview
+    #   end
+    #
+    #   class Components::CardComponentPreview
+    #   end
+    class ViewComponentInheritance < RuboCop::Cop::Base
+      COMPONENT_MSG = 'ViewComponents must inherit from ApplicationViewComponent'.freeze
+      PREVIEW_MSG = 'ViewComponentPreviews must inherit from ApplicationViewComponentPreview'.freeze
+
+      def on_class(node)
+        parent = node.parent_class&.const_name
+        class_name = node.identifier.const_name
+
+        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)
+
+          add_offense(node, message: COMPONENT_MSG)
+        else
+          true
+        end
+      end
+
+      def component_preview_valid?(parent, class_name)
+        class_name == 'ApplicationViewComponentPreview' ||
+          parent == 'ApplicationViewComponentPreview'
+      end
+
+      def component_valid?(parent, class_name)
+        class_name == 'ApplicationViewComponent' ||
+          parent == 'ApplicationViewComponent'
+      end
+    end
+  end
+end

data/lib/gl_rubocop/version.rb

@@ -1,3 +1,3 @@
 module GLRubocop
-  VERSION = '0.5.0'.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.0
+  version: 0.5.2
 platform: ruby
 authors:
 - Give Lively
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-03-03 00:00:00.000000000 Z
+date: 2026-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -174,6 +174,9 @@ files:
 - lib/gl_rubocop/gl_cops/unique_identifier.rb
 - lib/gl_rubocop/gl_cops/valid_data_test_id.rb
 - lib/gl_rubocop/gl_cops/vcr_cassette_names.rb
+- lib/gl_rubocop/gl_cops/view_component_class_naming.rb
+- lib/gl_rubocop/gl_cops/view_component_directory_structure.rb
+- lib/gl_rubocop/gl_cops/view_component_inheritance.rb
 - lib/gl_rubocop/gl_cops/view_component_initialize_keyword_args.rb
 - lib/gl_rubocop/helpers/erb_content_helper.rb
 - lib/gl_rubocop/helpers/haml_content_helper.rb
@@ -198,7 +201,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: A shareable configuration of Give Lively's rubocop rules.