rubocop-gusto 10.1.1 → 10.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a06f9920ea80223223c9353783cfc0a8824f232cc3e18c323195811a28eb28a
-  data.tar.gz: 2943d0fd74fc5f31be0f0527e136ee034514d4215357c33e5c64207e377855e1
+  metadata.gz: 5b80d8e2199d3f26a7c573b61905ea30b866eb0a9f5ca2bf6eb0f6ef9891ecd4
+  data.tar.gz: 88a6fac9e262c3c40caa6ce939b194badf71a84cd05e63165b11a3f36ed4b54d
 SHA512:
-  metadata.gz: 7dffff3eae0680c7ced3dfd4fc42eb98b37431a86aebcce90c0492a3c05f9c7f13a38c3634037aa3da96647d9857e8553af6ca155ba3707bbcf0a7e9d3fa2e42
-  data.tar.gz: ebc7a8072aa0e99bf33f1596aa4502573c99006d28ba179f15fa5c32394d6dc27f94bebc322942c586157e6549a7b2c25b907fd3f4092f4f9f604c58bbd1579a
+  metadata.gz: 830e8793b87b42c2a727dcbbda20a93de35f5a4887009455e8ff65bc8002dc9499d5fdfadd6971e2e5ce73660e47ddbd4cdf53eeae67c5c26d4840dadda0f092
+  data.tar.gz: 1d6b49aa37716ac6095ae0e261f8673e5c2389bff7432ba5775d39b64a86f8f17725b2f35c4c1ffbea1e32cac36751c1ee7924d6251af30b5ea7bed60466bc1c

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 ## Pending
 
+## 10.3.0
+
+- Add Gusto/RspecDateTimeMock cop
+
+## 10.2.0
+
+- Fix Sorbet sigil exclusions, exclude specs from strict, and add rubocop-sorbet dependency
+- Add ActiveSupportExtensionsEnabled to rails config
+- Fix infinite loop and splitting problem in init command
+- Use default Style/InverseMethods configuration
+
+## 10.1.1
+
+- Opt in to Rails/IgnoredColumnsAssignment
+- Revert "Add Gusto/IgnoredColumnAssignment"
+- Update rubocop dependency from 1.79.0 to 1.79.1
+
+## 10.1.0
+
+- Add Gusto/IgnoredColumnAssignment cop
+
 ## 10.0.1
 
 - Require rubocop >= 1.76 to ensure Naming/PredicatePrefix is available.

data/config/default.yml

@@ -2,6 +2,7 @@ plugins:
   - rubocop-rspec
   - rubocop-performance
   - rubocop-rake
+  - rubocop-sorbet
 
 # After you add a rule, sort this file with `bundle exec rubocop-gusto sort config/default.yml`
 
@@ -112,6 +113,12 @@ Gusto/RegexpBypass:
     - '**/spec/**/*'
   Safe: false
 
+Gusto/RspecDateTimeMock:
+  Description: "Don't mock Date/Time/DateTime directly. Use Rails Testing Time Helpers (eg `freeze_time` and `travel_to`) instead."
+  Include:
+    - '**/spec/**/*'
+  Safe: false
+
 Gusto/SidekiqParams:
   Description: 'Sidekiq perform methods cannot take keyword arguments.'
 
@@ -133,6 +140,7 @@ Gusto/ToplevelConstants:
 
 Gusto/UsePaintNotColorize:
   Description: 'Use Paint instead of colorize for terminal colors.'
+  SafeAutoCorrect: false
 
 Gusto/VcrRecordings:
   Description: 'VCR should be set to not record in tests. Use vcr: {record: :none}.'
@@ -339,12 +347,6 @@ RSpec/DescribeMethod:
 RSpec/DescribedClass:
   Enabled: false
 
-RSpec/DescribedClassModuleWrapping:
-  Enabled: true
-  # TODO: improve this file matching pattern
-  Include:
-    - '**/spec/**/*_spec.rb'
-
 RSpec/ExampleLength:
   Enabled: false
 
@@ -426,7 +428,6 @@ Rake/ClassDefinitionInTask:
   Enabled: false
 
 Rake/Desc:
-  # TODO: Roll this out.
   Enabled: true
 
 Security/YAMLLoad:
@@ -443,11 +444,7 @@ Sorbet:
 Sorbet/FalseSigil:
   # We want to avoid `typed: ignore` as much as possible, as it breaks LSP tooling.
   Include:
-  - "**/*.{rb,rbi,rake,ru}"
-  Exclude:
-  - bin/**/*
-  - db/**/*.rb
-  - script/**/*
+    - "**/*.{rb,rbi,rake,ru}"
 
 Sorbet/Refinement:
   # Still marked pending upstream, we contributed this and enable it here.
@@ -457,6 +454,13 @@ Sorbet/StrictSigil:
   # Forgot the difference between typed levels? (ignore, false, true, strict, and strong)
   # Check this out: https://sorbet.org/docs/static#file-level-granularity-strictness-levels
   Enabled: true
+  Include:
+  - "**/*.{rb,rbi,rake,ru}"
+  Exclude:
+  - bin/**/*
+  - db/**/*.rb
+  - script/**/*
+  - spec/**/*spec.rb
 
 Sorbet/ValidSigil:
   Enabled: true
@@ -466,7 +470,6 @@ Sorbet/ValidSigil:
   # We do suggest that the user type their file as `typed: strict`
   SuggestedStrictness: strict
   Exclude:
-    - '**/spec/**/*'
     - '**/db/migrate/**/*'
     - '**/*.{rake,arb,erb,rabl}'
     - '**/{Gemfile,Rakefile}'
@@ -479,7 +482,6 @@ Style/Alias:
   EnforcedStyle: prefer_alias_method
 
 Style/AsciiComments:
-  # TODO: roll this out fully
   Enabled: true
 
 Style/AutoResourceCleanup:
@@ -542,9 +544,9 @@ Style/FrozenStringLiteralComment:
   EnforcedStyle: always
   Enabled: true
 
+# This can make lines longer and impair readability
 Style/GuardClause:
   Enabled: false
-  MinBodyLength: 4
 
 Style/HashEachMethods:
   Enabled: true
@@ -559,7 +561,7 @@ Style/HashTransformValues:
   Enabled: false
 
 Style/IfInsideElse:
-    Enabled: false
+  Enabled: false
 
 Style/IfUnlessModifier:
   Enabled: false
@@ -567,9 +569,6 @@ Style/IfUnlessModifier:
 Style/ImplicitRuntimeError:
   Enabled: false
 
-Style/InverseMethods:
-  Enabled: false
-
 Style/Lambda:
   EnforcedStyle: literal
 
@@ -753,7 +752,6 @@ Style/SymbolProc:
 
 Style/TernaryParentheses:
   Enabled: false
-  EnforcedStyle: require_parentheses_when_complex
 
 Style/TrailingCommaInArguments:
   Enabled: true

data/config/rails.yml

@@ -7,6 +7,7 @@ plugins:
   - rubocop-rails
 
 AllCops:
+  ActiveSupportExtensionsEnabled: true
   TargetRubyVersion: <%= RbConfig::CONFIG['RUBY_API_VERSION'] %>
   MaxFilesInCache: 100000
   Exclude:
@@ -16,6 +17,9 @@ AllCops:
     - 'db/**/*schema.rb'
     - 'db/seeds{.rb,/**/*}'
 
+Performance/DoubleStartEndWith:
+  IncludeActiveSupportAliases: true
+
 Rails:
   Enabled: true
 

data/lib/rubocop/cop/gusto/rspec_date_time_mock.rb

@@ -0,0 +1,100 @@
+# typed: false
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Gusto
+      # Never mock time in specs. Use Rails Testing Time Helpers (eg `freeze_time` and `travel_to`) instead.
+      # .and_call_original is allowed.
+      #
+      # @example
+      #   # bad
+      #   context 'time specific tests' do
+      #     before { allow(Time).to receive(:now).and_return(current_time) }
+      #     it 'does stuff in a fixed time' do
+      #       subject
+      #     end
+      #   end
+      #
+      #   # good
+      #   context 'time specific tests' do
+      #     it 'does stuff in a fixed time' do
+      #       freeze_time do
+      #         subject
+      #       end
+      #     end
+      #   end
+      class RspecDateTimeMock < Base
+        CLASSES = Set[
+          :Date,
+          :Time,
+          :DateTime
+        ].freeze
+        MSG = "Don't mock #{CLASSES.join('/')} directly. Use Rails Testing Time Helpers (eg `freeze_time` and `travel_to`) instead.".freeze
+        RESTRICT_ON_SEND = %i(to).freeze
+
+        # Matches allow/expect with a time class (or chain) receiver and a `receive` or `receive_message_chain`
+        # Examples matched:
+        #   allow(Time).to receive(:now)
+        #   allow(Time.zone).to receive(:now)
+        #   allow(Time).to receive_message_chain(:zone, :now)
+        #   expect(Date.today).to receive(:wday)
+        # @!method time_mock?(node)
+        def_node_matcher :time_mock?, <<~PATTERN
+          (send
+            (send nil? {:allow :expect} #rooted_in_time_class?)
+            :to
+            {
+              (send (send nil? :receive _) ...)
+              (send (send nil? :receive_message_chain ...) ...)
+            }
+          )
+        PATTERN
+
+        def on_send(node)
+          time_mock?(node) do
+            # Allow usages that explicitly call `.and_call_original` after `receive`
+            # Example: allow(Time).to receive(:parse).and_call_original
+            receive_chain = node.first_argument
+            return if and_call_original_in_chain?(receive_chain)
+
+            add_offense(node)
+          end
+        end
+
+        private
+
+        # Returns true if the given node is a const or a call chain whose root receiver
+        # is one of the protected time classes (Date/Time/DateTime)
+        def rooted_in_time_class?(node)
+          return false if node.nil?
+
+          current = node
+          while current.respond_to?(:send_type?) && current.send_type?
+            current = current.receiver
+          end
+
+          if current.nil?
+            return false
+          end
+
+          return false unless current.const_type?
+
+          # Accept both `Time` and `::Time` as root-level constants
+          namespace = current.namespace
+          is_root_level = namespace.nil? || namespace.cbase_type?
+          is_root_level && CLASSES.include?(current.children[1])
+        end
+
+        def and_call_original_in_chain?(node)
+          return false if node.nil?
+          return false unless node.send_type?
+
+          return true if node.method?(:and_call_original)
+
+          node.each_descendant(:send).any? { |send_node| send_node.method?(:and_call_original) }
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/gusto/use_paint_not_colorize.rb

@@ -5,6 +5,12 @@ module RuboCop
     module Gusto
       # Requires the use of the `paint` gem for terminal color methods on strings
       #
+      # @safety
+      #   This cop's autocorrection is unsafe because it replaces colorize gem
+      #   methods with Paint gem methods. If the Paint gem is not included in the
+      #   project's dependencies, the corrected code will fail at runtime with a
+      #   NameError (uninitialized constant Paint).
+      #
       # @example
       #
       #   # bad

data/lib/rubocop/gusto/config_yml.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "pathname"
+require "yaml"
 
 module RuboCop
   module Gusto
@@ -110,21 +111,46 @@ module RuboCop
         # Try to find a line that exactly matches KEY_REGEX
         # Use rstrip, not strip, to preserve indentation
         name_line = chunk.find { |line| line.rstrip.match?(KEY_REGEX) }
-        name_line&.rstrip&.delete_suffix(":")
+        if name_line
+          name_line.rstrip.delete_suffix(":")
+        else
+          # Try to find a key with value on the same line (e.g., "inherit_from: .rubocop_todo.yml")
+          first_line = chunk.find { |line| !line.strip.empty? && !line.strip.start_with?("#") }
+          if first_line&.include?(":")
+            first_line.split(":").first.strip
+          end
+        end
       end
 
       # Splits the lines into blocks whenever we drop from indented to unindented
       def chunk_blocks(lines)
-        # slice whenever we drop from indented to unindented
+        # slice whenever we drop from indented to unindented line
+        # or when we encounter a new top-level key after blank line(s)
         chunks = lines.slice_when do |prev, line|
-          prev.match?(INDENT_REGEX) && !prev.strip.empty? && !line.match?(INDENT_REGEX)
+          if prev.strip.empty?
+            # split when going from blank to non-indented non-blank
+            !line.match?(INDENT_REGEX) && !line.strip.empty?
+          elsif prev.match?(INDENT_REGEX)
+            # split when going from indented to non-blank unindented
+            !line.match?(INDENT_REGEX) && !line.strip.empty?
+          else
+            # prev is non-indented, split on blank lines too
+            line.strip.empty?
+          end
         end
 
         # Process each chunk to remove leading newlines and add 1 trailing newline
         chunks.filter_map do |chunk|
           # Remove leading and trailing empty lines
-          chunk.shift while chunk.first.to_s.strip.empty?
-          chunk.pop while chunk.last.to_s.strip.empty?
+          until chunk.empty? || !chunk.first.strip.empty?
+            chunk.shift
+          end
+          until chunk.empty? || !chunk.last.strip.empty?
+            chunk.pop
+          end
+
+          # Skip empty chunks
+          next if chunk.empty?
 
           # Ensure each chunk ends with a blank newline
           chunk << "\n"

data/lib/rubocop/gusto/templates/rubocop.yml

@@ -1,5 +1,3 @@
-inherit_from: .rubocop_todo.yml
-
 inherit_mode:
   merge:
     - Include
@@ -8,6 +6,8 @@ inherit_gem:
   rubocop-gusto:
     - config/default.yml
 
+inherit_from: .rubocop_todo.yml
+
 plugins:
   - rubocop-gusto
   - rubocop-rspec

data/lib/rubocop/gusto/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Gusto
-    VERSION = "10.1.1"
+    VERSION = "10.3.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-gusto
 version: !ruby/object:Gem::Version
-  version: 10.1.1
+  version: 10.3.0
 platform: ruby
 authors:
 - Gusto Engineering
@@ -10,7 +10,7 @@ cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bigdecimal
+  name: lint_roller
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -24,35 +24,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: lint_roller
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.76'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.76'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.76'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.76'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-performance
+  name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -66,7 +66,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rake
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -80,7 +80,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rspec
+  name: rubocop-sorbet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -140,6 +140,7 @@ files:
 - lib/rubocop/cop/gusto/rails_env.rb
 - lib/rubocop/cop/gusto/rake_constants.rb
 - lib/rubocop/cop/gusto/regexp_bypass.rb
+- lib/rubocop/cop/gusto/rspec_date_time_mock.rb
 - lib/rubocop/cop/gusto/sidekiq_params.rb
 - lib/rubocop/cop/gusto/toplevel_constants.rb
 - lib/rubocop/cop/gusto/use_paint_not_colorize.rb