gl_rubocop 0.3.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d0d6882bfbd2fb93c58c4c0e3a9302e4f98ac4977aa469e0b40a57856a7cfd0
-  data.tar.gz: 86ea3ab20f3b8899e6b8806ad1daabf561d732c6ad26c80017102e57c8f67bf1
+  metadata.gz: 83a8c15ce9c97fee3534fd6ec1b13efa8c150b4a6a06042f1408be213022c453
+  data.tar.gz: aef1892a704ffc69e5b4fc5ecc35d3c45461a8cac740c07a635e09a46811895b
 SHA512:
-  metadata.gz: bac9a336b0f9e60517d727a5791f8cf909d824ce978e30dff1bb3a4788d22ed358fff0106e14db757c64c3079a0fa7df7b7cb632df258bce529a963b3d6763d4
-  data.tar.gz: 7b84eda9ac0ea8feddc5996f499b36c4d0408d729f764b95b882dbdcfdf5fe7a44e08d1e1eaa6dec5e726bfcfd75e45ad88e157d017afc3497ea4e43378ef5a4
+  metadata.gz: 796c52aff461d138901b41715b5d677518057ae3cb81715f39036f4e4c92c9c1294732d5e149160addc245eee87065b7fc49ffaad3c936ae0d586f5263dedf42
+  data.tar.gz: 35f95f56ace1f7c2e529df369e5d397b7a6cfd741be5a4a7d53fb7a9ffd849b200919343a0006586cb772403b81d5369c3bda5e406fa924de127ec1c656e5f76

data/default.yml

@@ -9,14 +9,17 @@ 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
 
 AllCops:
@@ -43,6 +46,11 @@ Capybara/NegationMatcher:
 GLCops/CallbackMethodNames:
   Enabled: true
 
+GLCops/ConsolidateRequestSystemSpecs:
+  Enabled: true
+  Include:
+    - "**/*spec.rb"
+
 GLCops/InteractorInheritsFromInteractorBase:
   Enabled: true
   Include:
@@ -76,6 +84,18 @@ GLCops/UniqueIdentifier:
   Include:
     - "app/components/**/*.erb"
 
+GLCops/ValidDataTestId:
+  Enabled: true
+  Include:
+    - "**/*.erb"
+    - "**/*.haml"
+    - "**/*.rb"
+
+GLCops/VcrCassetteNames:
+  Enabled: true
+  Include:
+    - "**/*spec.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/valid_data_test_id.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require_relative '../helpers/haml_content_helper'
+require_relative '../helpers/erb_content_helper'
+
+module GLRubocop
+  module GLCops
+    class ValidDataTestId < RuboCop::Cop::Cop
+      include GLRubocop::HamlContentHelper
+      include GLRubocop::ErbContentHelper
+
+      MSG = 'Use data-test-id instead of %<invalid>s'
+
+      # Invalid variations of data-test-id
+      # Matches: data-testid, data_test_id, datatestid, dataTestId, etc.
+      # Does NOT match: data-test-id (the valid format)
+      INVALID_PATTERN = /\bdata(?!-test-id\b)[-_]?test[-_]?id\b/i
+
+      def investigate(processed_source)
+        return unless haml_file? || erb_file?
+
+        content = haml_file? ? read_haml_file : read_erb_file
+        return unless content
+
+        check_file_content(content, processed_source)
+      end
+
+      def on_str(node)
+        return unless node.str_type?
+
+        check_string_content(node.value, node)
+      end
+
+      private
+
+      def check_file_content(content, processed_source)
+        return unless content.match?(INVALID_PATTERN)
+
+        match = content.match(INVALID_PATTERN)
+        invalid_attr = match[0].split(/[=:]/).first.gsub(/["']/, '')
+        range = processed_source.buffer.source_range
+        add_offense(
+          nil,
+          location: range,
+          message: format(MSG, invalid: invalid_attr)
+        )
+      end
+
+      def check_string_content(content, node)
+        return unless content.match?(INVALID_PATTERN)
+
+        match = content.match(INVALID_PATTERN)
+        invalid_attr = match[0].split(/[=:]/).first.gsub(/["']/, '')
+        add_offense(
+          node,
+          message: format(MSG, invalid: invalid_attr)
+        )
+      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_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.3.3'.freeze
+  VERSION = '0.5.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gl_rubocop
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.5.0
 platform: ruby
 authors:
 - Give Lively
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-11-12 00:00:00.000000000 Z
+date: 2026-03-03 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
@@ -171,6 +172,8 @@ files:
 - lib/gl_rubocop/gl_cops/sidekiq_inherits_from_sidekiq_job.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/helpers/erb_content_helper.rb
 - lib/gl_rubocop/helpers/haml_content_helper.rb
@@ -195,7 +198,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: A shareable configuration of Give Lively's rubocop rules.