rubocop-gusto 10.2.0 → 10.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad5b8322bb818e1f765532f2757ae7bcce5bf7275ef22ced8700f87883715972
-  data.tar.gz: aff19b02288f2b23afb2df259a2a63b441189527d9d91f2e115ab75c7a2f1746
+  metadata.gz: 5b80d8e2199d3f26a7c573b61905ea30b866eb0a9f5ca2bf6eb0f6ef9891ecd4
+  data.tar.gz: 88a6fac9e262c3c40caa6ce939b194badf71a84cd05e63165b11a3f36ed4b54d
 SHA512:
-  metadata.gz: ed0bc51d62ead56c64464e36bd9142d6600d2a05430fc78c0510b50d577ccdb10d376de287079bec788abca083e40804eb59e6056f45743b9f8ac80576df7067
-  data.tar.gz: 39af6427e9a5b54b167c26679c314272c26c178b645bcb141b373da48c6829ee1d61d515518398bdf64b9279e8f005ba618674cda144fd80d873988198c2066e
+  metadata.gz: 830e8793b87b42c2a727dcbbda20a93de35f5a4887009455e8ff65bc8002dc9499d5fdfadd6971e2e5ce73660e47ddbd4cdf53eeae67c5c26d4840dadda0f092
+  data.tar.gz: 1d6b49aa37716ac6095ae0e261f8673e5c2389bff7432ba5775d39b64a86f8f17725b2f35c4c1ffbea1e32cac36751c1ee7924d6251af30b5ea7bed60466bc1c

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## Pending
 
+## 10.3.0
+
+- Add Gusto/RspecDateTimeMock cop
+
 ## 10.2.0
 
 - Fix Sorbet sigil exclusions, exclude specs from strict, and add rubocop-sorbet dependency

data/config/default.yml

@@ -113,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.'
 
@@ -134,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}.'
@@ -340,9 +347,6 @@ RSpec/DescribeMethod:
 RSpec/DescribedClass:
   Enabled: false
 
-RSpec/DescribedClassModuleWrapping:
-  Enabled: true
-
 RSpec/ExampleLength:
   Enabled: false
 
@@ -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}'
@@ -748,7 +751,7 @@ Style/SymbolProc:
   Enabled: true
 
 Style/TernaryParentheses:
-  EnforcedStyle: require_parentheses_when_complex
+  Enabled: false
 
 Style/TrailingCommaInArguments:
   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/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Gusto
-    VERSION = "10.2.0"
+    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.2.0
+  version: 10.3.0
 platform: ruby
 authors:
 - Gusto Engineering
@@ -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