gl_rubocop 0.4.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2dc8147315555f5d211c9d5577a449f69d73b913126481bc1477ea5ede612f38
-  data.tar.gz: ddd3961ae821ea369248be94d91dc23559ef5993261f75e660cdf05246a28358
+  metadata.gz: 55c5e4d549add201fba2d9cdcf5c63b3adf2fff339785be177d2b992c841750a
+  data.tar.gz: 50d1687524ca84b65fca2ab5e8d9502446991aa69b3d0b06f9711d614393785d
 SHA512:
-  metadata.gz: d1b05b7ffd3b6917ac6838fea98e817572629d5b25258816b773a69671b51487754caabf5283cb840451b800f2f695fa551b4ddf4faebfe93ab2c914a7456f70
-  data.tar.gz: 60be23fbb3bfb84505da907c041bb7708a1f0b7f5e7ff5dcfbd6b3fa1db37866880092612d7a7302ec5eefdf6f97751244bf0df37e5ecd95223b1ce74a0e2dee
+  metadata.gz: 3ddaebd810428c15841487137a7f692a17124bd95278244422107540690858398c69667111102f9f9d43e18a5e6326eef3e95fe6e77ff5341fbcdb6844b64aef
+  data.tar.gz: dd7ad7ea6d9f11648bf103da2e743540c6709444e28f926eb6d4692d768a4ae5a6c3da37f023b5ab9f08305fb7c6c52e91a43a57ec89e69555bf716564fa5432

data/default.yml

@@ -9,16 +9,21 @@ require:
   - rubocop-rake
   - rubocop-sorbet
   - ./lib/gl_rubocop/gl_cops/callback_method_names.rb
+  - ./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_perform_async.rb
   - ./lib/gl_rubocop/gl_cops/prevent_haml_files.rb
   - ./lib/gl_rubocop/gl_cops/rails_cache.rb
   - ./lib/gl_rubocop/gl_cops/sidekiq_inherits_from_sidekiq_job.rb
-  - ./lib/gl_rubocop/gl_cops/unique_identifier.rb
   - ./lib/gl_rubocop/gl_cops/tailwind_no_contradicting_class_name.rb
+  - ./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_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
@@ -44,6 +49,11 @@ Capybara/NegationMatcher:
 GLCops/CallbackMethodNames:
   Enabled: true
 
+GLCops/ConsolidateRequestSystemSpecs:
+  Enabled: true
+  Include:
+    - "**/*spec.rb"
+
 GLCops/InteractorInheritsFromInteractorBase:
   Enabled: true
   Include:
@@ -84,6 +94,26 @@ GLCops/ValidDataTestId:
     - "**/*.haml"
     - "**/*.rb"
 
+GLCops/VcrCassetteNames:
+  Enabled: true
+  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/**/component.rb"
+
 GLCops/ViewComponentInitializeKeywordArgs:
   Enabled: true
   Include:

data/lib/gl_rubocop/gl_cops/callback_method_names.rb

@@ -1,4 +1,3 @@
-# rubocop:disable I18n/RailsI18n/DecorateString
 module GLRubocop
   module GLCops
     # This cop ensures that controller callbacks are named methods, not inline blocks.
@@ -22,4 +21,3 @@ module GLRubocop
     end
   end
 end
-# rubocop:enable I18n/RailsI18n/DecorateString

data/lib/gl_rubocop/gl_cops/consolidate_request_system_specs.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+module GLRubocop
+  module GLCops
+    # This cop ensures request and system specs consolidate examples in a single it block,
+    #   per each describe and context.
+    # Reason: Setup for specs should go in let/before blocks - which are different for each context.
+    #   it blocks with the same setup should be consolidated to keep our tests fast.
+    #
+    #
+    # Good:
+    #   RSpec.describe UsersController, type: :request do
+    #     describe 'GET /users' do
+    #       it 'returns users' do
+    #         get users_path
+    #         expect(response).to be_successful
+    #         expect(response).to render_template(:index)
+    #
+    #         get users_path, headers: {format: :json}
+    #         expect(response).to be_successful
+    #         expect(response.content_type).to eq('application/json')
+    #       end
+    #     end
+    #     describe 'GET /users/id' do
+    #       let(:user_id) { user.id }
+    #       it 'returns user' do
+    #         get user_path(user_id)
+    #         expect(response).to be_successful
+    #       end
+    #       context 'with unknown user' do
+    #         let(:user_id) { 111111 }
+    #         it 'does not return user' do
+    #           get user_path(user_id)
+    #           expect(response).not_to be_successful
+    #         end
+    #       end
+    #     end
+    #   end
+    #
+    # Bad:
+    #   RSpec.describe UsersController, type: :request do
+    #     describe 'GET /users' do
+    #       it 'returns success' do
+    #         get users_path
+    #         expect(response).to be_successful
+    #       end
+    #
+    #       it 'returns json' do
+    #         get users_path
+    #         expect(response.content_type).to eq('application/json')
+    #       end
+    #     end
+    #   end
+    class ConsolidateRequestSystemSpecs < RuboCop::Cop::Base
+      MSG = 'Consolidate examples with the same setup in request specs and system specs. ' \
+            'Use a single it block instead of multiple it blocks.'
+
+      RSPEC_EXAMPLE_METHODS = %i[it specify example].freeze
+
+      # @!method rspec_group?(node)
+      def_node_matcher :rspec_group?, <<~PATTERN
+        (block (send _ {:describe :context} ...) ...)
+      PATTERN
+
+      # @!method request_or_system_type?(node)
+      def_node_matcher :request_or_system_type?, <<~PATTERN
+        (block (send _ _ ... (hash <(pair (sym :type) (sym {:request :system})) ...>)) ...)
+      PATTERN
+
+      def on_new_investigation
+        @spec_type_cache = {}
+      end
+
+      def on_block(node)
+        return unless rspec_group?(node)
+        return unless request_or_system_spec?(node)
+
+        check_multiple_examples(node)
+      end
+
+      private
+
+      def request_or_system_spec?(node)
+        current = node
+        while current
+          if current.block_type?
+            unless @spec_type_cache.key?(current)
+              @spec_type_cache[current] =
+                request_or_system_type?(current)
+            end
+            return true if @spec_type_cache[current]
+          end
+          current = current.parent
+        end
+
+        false
+      end
+
+      def check_multiple_examples(node)
+        examples = find_example_blocks(node)
+        return if examples.size <= 1
+
+        examples[1..].each do |example_node|
+          add_offense(example_node, message: MSG)
+        end
+      end
+
+      def find_example_blocks(node)
+        return [] unless node.body
+
+        node.body.each_child_node(:block).select do |child|
+          RSPEC_EXAMPLE_METHODS.include?(child.send_node.method_name)
+        end
+      end
+    end
+  end
+end

data/lib/gl_rubocop/gl_cops/vcr_cassette_names.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module GLRubocop
+  module GLCops
+    # This cop ensures that VCR cassettes have names.
+    #
+    # Good:
+    #   VCR.use_cassette('cassette_name') { ... }
+    #   VCR.use_cassette("cassette_name") { ... }
+    #   describe '.create', vcr: { cassette_name: :chariot_connect_create } do
+    #
+    # Bad:
+    #   VCR.use_cassette { ... }
+    #   VCR.use_cassette() { ... }
+    #   describe 'something', :vcr do
+    class VcrCassetteNames < RuboCop::Cop::Base
+      MSG = 'VCR cassettes must have a name. Example: VCR.use_cassette("cassette_name") { ... }'
+      RSPEC_MSG = 'VCR cassettes must have a name. ' \
+                  'Example: describe "test", vcr: { cassette_name: :my_cassette } do'
+
+      RSPEC_METHODS = %i[describe context it specify example].freeze
+
+      # @!method vcr_use_cassette?(node)
+      def_node_matcher :vcr_use_cassette?, <<~PATTERN
+        (send (const nil? :VCR) :use_cassette ...)
+      PATTERN
+
+      # @!method vcr_use_cassette_with_name?(node)
+      def_node_matcher :vcr_use_cassette_with_name?, <<~PATTERN
+        (send (const nil? :VCR) :use_cassette {str dstr} ...)
+      PATTERN
+
+      # @!method rspec_vcr_symbol?(node)
+      def_node_matcher :rspec_vcr_symbol?, <<~PATTERN
+        (sym :vcr)
+      PATTERN
+
+      # @!method vcr_hash_without_cassette_name?(node)
+      def_node_matcher :vcr_hash_without_cassette_name?, <<~PATTERN
+        (pair (sym :vcr) !{(hash <(pair (sym :cassette_name) _) ...>)})
+      PATTERN
+
+      def on_send(node)
+        check_vcr_use_cassette(node)
+        check_rspec_metadata(node)
+      end
+
+      private
+
+      def check_vcr_use_cassette(node)
+        return unless vcr_use_cassette?(node)
+        return if vcr_use_cassette_with_name?(node)
+
+        add_offense(node, message: MSG)
+      end
+
+      def check_rspec_metadata(node)
+        return unless RSPEC_METHODS.include?(node.method_name)
+
+        node.arguments.each do |arg|
+          if rspec_vcr_symbol?(arg)
+            add_offense(arg, message: RSPEC_MSG)
+          elsif arg.hash_type?
+            arg.pairs.each do |pair|
+              add_offense(pair, message: RSPEC_MSG) if vcr_hash_without_cassette_name?(pair)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gl_rubocop/gl_cops/view_component_class_naming.rb

@@ -0,0 +1,25 @@
+module GLRubocop
+  module GLCops
+    # This cop checks that the class name is "Component" or "ApplicationViewComponent".
+    #
+    # Good:
+    #   class Component < ViewComponent::Base
+    #   end
+    #
+    #   class ApplicationViewComponent < ViewComponent::Base
+    #   end
+    #
+    # Bad:
+    #   class UserCardComponent < ViewComponent::Base
+    #   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'
+
+        add_offense(node, message: 'ViewComponent class names must be "Component".')
+      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,38 @@
+module GLRubocop
+  module GLCops
+    # This cop checks that all ViewComponent classes inherit from an allowlisted base class.
+    #
+    # Good:
+    #   class Components::HeroComponent < ApplicationViewComponent
+    #   end
+    #
+    #   class Components::CardComponent < ViewComponent::Base
+    #   end
+    #
+    # Bad:
+    #   class Components::HeroComponent < ViewComponent
+    #   end
+    #
+    #   class Components::CardComponent
+    #   end
+    class ViewComponentInheritance < RuboCop::Cop::Base
+      INHERITANCE_MSG = 'ViewComponent must inherit from ApplicationViewComponent'.freeze
+
+      def on_class(node)
+        return true if inherits_from_application_view_component(node)
+
+        add_offense(node, message: INHERITANCE_MSG)
+      end
+
+      private
+
+      def inherits_from_application_view_component(node)
+        parent = node.parent_class
+        return false unless parent
+
+        parent_name = parent.const_name
+        %w[ApplicationViewComponent ViewComponent::Base].include?(parent_name)
+      end
+    end
+  end
+end

data/lib/gl_rubocop/gl_cops/view_component_initialize_keyword_args.rb

@@ -1,4 +1,3 @@
-# rubocop:disable I18n/RailsI18n/DecorateString
 module GLRubocop
   module GLCops
     # This cop ensures that ViewComponent initialize methods use keyword arguments only.
@@ -27,4 +26,3 @@ module GLRubocop
     end
   end
 end
-# rubocop:enable I18n/RailsI18n/DecorateString

data/lib/gl_rubocop/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gl_rubocop
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Give Lively
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-02-10 00:00:00.000000000 Z
+date: 2026-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -163,6 +163,7 @@ files:
 - gl_rubocop.gemspec
 - lib/gl_rubocop.rb
 - lib/gl_rubocop/gl_cops/callback_method_names.rb
+- 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_perform_async.rb
@@ -172,6 +173,10 @@ files:
 - lib/gl_rubocop/gl_cops/tailwind_no_contradicting_class_name.rb
 - 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
@@ -196,7 +201,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: A shareable configuration of Give Lively's rubocop rules.