gl_rubocop 0.5.1 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55c5e4d549add201fba2d9cdcf5c63b3adf2fff339785be177d2b992c841750a
-  data.tar.gz: 50d1687524ca84b65fca2ab5e8d9502446991aa69b3d0b06f9711d614393785d
+  metadata.gz: 1047a8465eb718c62b4582a7c18f339e17acb15bf0861c60460d21f2f1d74a65
+  data.tar.gz: c85258ff5eb9526fc05b9eb6d8dd15aa8b63f94fe868ed434356259080153fc8
 SHA512:
-  metadata.gz: 3ddaebd810428c15841487137a7f692a17124bd95278244422107540690858398c69667111102f9f9d43e18a5e6326eef3e95fe6e77ff5341fbcdb6844b64aef
-  data.tar.gz: dd7ad7ea6d9f11648bf103da2e743540c6709444e28f926eb6d4692d768a4ae5a6c3da37f023b5ab9f08305fb7c6c52e91a43a57ec89e69555bf716564fa5432
+  metadata.gz: 39d62d81dfbb69a9e213efb8df7f02486906849e9218572d3a48a76758715e3f598c14bbbcce9abfd483edc96f32f8d9dcb2167c44085774bd3e71573ac552a9
+  data.tar.gz: c32264166f4d1ba98cd73606541671718308de01b47e38c9b08cc59d9aa4496f1ea9a33385807e1aabe9a129e2c920e0433266107588028ad038c98b83e595af

data/default.yml

@@ -12,6 +12,7 @@ require:
   - ./lib/gl_rubocop/gl_cops/consolidate_request_system_specs.rb
   - ./lib/gl_rubocop/gl_cops/interactor_inherits_from_interactor_base.rb
   - ./lib/gl_rubocop/gl_cops/limit_flash_options.rb
+  - ./lib/gl_rubocop/gl_cops/no_stubbing_env.rb
   - ./lib/gl_rubocop/gl_cops/no_stubbing_perform_async.rb
   - ./lib/gl_rubocop/gl_cops/prevent_haml_files.rb
   - ./lib/gl_rubocop/gl_cops/rails_cache.rb
@@ -62,6 +63,11 @@ GLCops/InteractorInheritsFromInteractorBase:
 GLCops/LimitFlashOptions:
   Enabled: true
 
+GLCops/NoStubbingEnv:
+  Enabled: true
+  Include:
+    - "**/*spec.rb"
+
 GLCops/NoStubbingPerformAsync:
   Enabled: true
   Include:
@@ -112,7 +118,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/no_stubbing_env.rb

@@ -0,0 +1,42 @@
+module GLRubocop
+  module GLCops
+    # This cop ensures that you don't stub ENV with `allow`/`expect` + `receive`.
+    #
+    # Stubbing ENV this way (even with `and_call_original`) only stubs the env vars the
+    # spec explicitly knows about. Any var that is read but not stubbed - for example a
+    # var that is present on CI but not locally, or vice versa - behaves inconsistently
+    # and causes flaky failures.
+    #
+    # Instead, replace ENV wholesale with `stub_const`, building the hash from the real
+    # ENV so unrelated vars keep working everywhere:
+    #
+    # Good:
+    #   stub_const('ENV', ENV.to_hash.except('VAR_TO_UNSET').merge('VAR_TO_SET' => 'value'))
+    #
+    # Bad:
+    #   allow(ENV).to receive(:[]).and_call_original
+    #   allow(ENV).to receive(:[]).with('VAR_TO_SET').and_return('value')
+    #   expect(ENV).to receive(:fetch)
+    class NoStubbingEnv < RuboCop::Cop::Base
+      MSG = "Don't stub ENV with allow/expect + receive. Use " \
+            "stub_const('ENV', ENV.to_hash.except('VAR_TO_UNSET')." \
+            "merge('VAR_TO_SET' => 'value')) instead, so unrelated ENV vars " \
+            '(e.g. on CI) keep working.'.freeze
+
+      # Match `allow(ENV).to receive(...)` / `expect(ENV).not_to receive(...)`, including
+      # chained forms like `.and_call_original`, `.and_return(...)`, `.with(...)`.
+      def_node_matcher :stubbing_env?, <<~PATTERN
+        (send
+          (send nil? {:allow :expect} (const {nil? cbase} :ENV))
+          {:to :not_to :to_not}
+          `(send nil? :receive ...))
+      PATTERN
+
+      def on_send(node)
+        return unless stubbing_env?(node)
+
+        add_offense(node)
+      end
+    end
+  end
+end

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.3'.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.3
 platform: ruby
 authors:
 - Give Lively
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-04-20 00:00:00.000000000 Z
+date: 2026-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -166,6 +166,7 @@ files:
 - lib/gl_rubocop/gl_cops/consolidate_request_system_specs.rb
 - lib/gl_rubocop/gl_cops/interactor_inherits_from_interactor_base.rb
 - lib/gl_rubocop/gl_cops/limit_flash_options.rb
+- lib/gl_rubocop/gl_cops/no_stubbing_env.rb
 - lib/gl_rubocop/gl_cops/no_stubbing_perform_async.rb
 - lib/gl_rubocop/gl_cops/prevent_haml_files.rb
 - lib/gl_rubocop/gl_cops/rails_cache.rb
@@ -201,7 +202,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: A shareable configuration of Give Lively's rubocop rules.