betterlint 1.16.0 → 1.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8824f5666cd34b9d8b14c60770e653721fe6f313c21a5c53d6ac3bbdd70af0d0
-  data.tar.gz: 50f8bedf98f9dd0f4ec57fd2a167115adb7d4c955e650b9afdbd91699fef9930
+  metadata.gz: a22aae83c05b82fd78756d3d69d45c25d71b5a63715831c947239a73a6ce5f1f
+  data.tar.gz: 1b80addb1d93b9823303e94c0e87b7360bd5d3456af6ab250c4f13a2e3bac625
 SHA512:
-  metadata.gz: 687ca7842919296a6f39eba3504ee8dd015a1837f354f11b0ffe030b1d66a9096d5d2fd516274753f3565883afbfd2df250f6a74d0da4d36db5a834df2c54ecc
-  data.tar.gz: 9cf4eedaac12097baf99af64d585e3ccb3b46d8ae3b5f6fda50b7b37a583b8fb3ea78528ef12fb7a904295553293b467908587aa940e972ccda055616444de69
+  metadata.gz: 95a2bd3580e962c52fab4a4cdb9778137ca3c96506f1dde5e9d8ae69f188364b81930980b68538200aeb9e1bc433a590725370216d239a754f9c8f19e7e055bc
+  data.tar.gz: e685d82cf02b3065077014c89d44b1bb91aa593a087c4479d29a55aa938f3f7ccf31fa3da5486ccba8a1dbd64ff62bd23246f6e8715232fee785545db518607e

data/README.md

@@ -280,3 +280,20 @@ actions often indicates error handling (e.g. `422 Unprocessable Entity`).
 This cop requires you to explicitly provide an HTTP status code when rendering a response in the
 create, update, and destroy actions. When autocorrecting, this will automatically add
 `status: :unprocessable_entity` or `status: :ok` depending on what you're rendering.
+
+### Betterment/UseGlobalStrictLoading/ByDefaultForModels
+
+This cop identifies models where `self.strict_loading_by_default` is assigned to explicitly, and prefers that it be removed in favor of using the global strict loading settings.
+
+We use this to create a `.rubocop_todo.yml` file showing all the models that have been explicitly configured, so that we can "burn down" and lean more heavily on using global settings. We prefer to enable strict loading by default globally, but transioning a large Rails application to work in that state is difficult and must be broken down into smaller steps. Our workflow is to change all models to turn off strict loading, regenerate our rubocop todo file, then enable the flag globally. Then on a model-by-model basis we'll enable them one at a time, and fix all spec failures per model.
+
+This allows us two benefits:
+
+1. We can gradually change code used by older models to use strict loading without having to fix the world all at once.
+2. All new models will strict load by default, forcing us to specify the objcts to load up-front in our controllers and other call sites.
+
+### Betterment/UseGlobalStrictLoading/ForAssociations
+
+This cop identifies associations where `:strict_loading` is set explicitly, and prefers that it be removed in favor of using the global strict loading settings.
+
+This is related to the [Betterment/UseGlobalStrictLoading/ByDefaultForModels](#bettermentuseglobalstrictloadingbydefaultformodels) cop, but allows for more granular enablement and disablement of associations within a model. The intention is similar, in that we are using this cop to help "burn down" code to strict load, but it allows us to focus on the per-association level. Some models may have quite a lot of usage, so enabling it for a model might cause thousands of failures in the specs. In those cases we will disable all the associations, and then work through them one at a time until all code that uses the model strict loads.

data/config/default.yml

@@ -102,6 +102,14 @@ Betterment/UnsafeJob:
 Betterment/UnscopedFind:
   StyleGuide: '#bettermentunscopedfind'
 
+Betterment/UseGlobalStrictLoading/ByDefaultForModels:
+  Enabled: true
+  SafeAutoCorrect: false
+
+Betterment/UseGlobalStrictLoading/ForAssociations:
+  Enabled: true
+  SafeAutoCorrect: false
+
 FactoryBot/AssociationStyle:
   Enabled: false
 

data/lib/rubocop/cop/betterment/use_global_strict_loading.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Betterment
+      module UseGlobalStrictLoading
+        # This cop ensures that `self.strict_loading_by_default = <any value>` is not set in ActiveRecord models.
+        class ByDefaultForModels < Base
+          extend AutoCorrector
+          include RangeHelp
+
+          MSG = 'Do not set `self.strict_loading_by_default` in ActiveRecord models.'
+
+          # @!method strict_loading_by_default_set?(node)
+          def_node_matcher :strict_loading_by_default_set?, <<~PATTERN
+            $(send self :strict_loading_by_default= _)
+          PATTERN
+
+          def on_send(node)
+            strict_loading_by_default_set?(node) do |method_call|
+              add_offense(method_call) do |corrector|
+                corrector.remove(method_call)
+              end
+            end
+          end
+        end
+
+        # This cop ensures that `strict_loading: <any value>` is not set in ActiveRecord associations.
+        class ForAssociations < Base
+          extend AutoCorrector
+          include RangeHelp
+
+          MSG = 'Do not set `:strict_loading` in ActiveRecord associations.'
+
+          ASSOCIATION_METHODS = %i(belongs_to has_and_belongs_to_many has_many has_one).freeze
+
+          # @!method association_with_strict_loading?(node)
+          def_node_matcher :association_with_strict_loading?, <<~PATTERN
+            (send nil? {#{ASSOCIATION_METHODS.map(&:inspect).join(' ')}} ... (hash <$(pair (sym :strict_loading) ...) ...>))
+          PATTERN
+
+          def on_send(node)
+            association_with_strict_loading?(node) do |pair|
+              add_offense(node) do |corrector|
+                corrector.remove(range_with_surrounding_comma(range_with_surrounding_space(range: pair.source_range, side: :left), :left))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/betterment.rb

@@ -1,27 +1,28 @@
 # frozen_string_literal: true
 
 require 'rubocop'
-require 'rubocop/cop/betterment/utils/parser'
-require 'rubocop/cop/betterment/utils/method_return_table'
-require 'rubocop/cop/betterment/utils/hardcoded_attribute'
+require 'rubocop/cop/betterment/active_job_performable'
+require 'rubocop/cop/betterment/allowlist_blocklist'
 require 'rubocop/cop/betterment/authorization_in_controller'
 require 'rubocop/cop/betterment/direct_delayed_enqueue'
 require 'rubocop/cop/betterment/dynamic_params'
-require 'rubocop/cop/betterment/unscoped_find'
-require 'rubocop/cop/betterment/unsafe_job'
-require 'rubocop/cop/betterment/timeout'
+require 'rubocop/cop/betterment/fetch_boolean'
+require 'rubocop/cop/betterment/hardcoded_id'
+require 'rubocop/cop/betterment/implicit_redirect_type'
 require 'rubocop/cop/betterment/internals_protection'
 require 'rubocop/cop/betterment/memoization_with_arguments'
 require 'rubocop/cop/betterment/non_standard_actions'
 require 'rubocop/cop/betterment/non_standard_controller'
+require 'rubocop/cop/betterment/redirect_status'
+require 'rubocop/cop/betterment/render_status'
+require 'rubocop/cop/betterment/server_error_assertion'
 require 'rubocop/cop/betterment/site_prism_loaded'
 require 'rubocop/cop/betterment/spec_helper_required_outside_spec_dir'
-require 'rubocop/cop/betterment/implicit_redirect_type'
-require 'rubocop/cop/betterment/active_job_performable'
-require 'rubocop/cop/betterment/allowlist_blocklist'
-require 'rubocop/cop/betterment/server_error_assertion'
-require 'rubocop/cop/betterment/hardcoded_id'
+require 'rubocop/cop/betterment/timeout'
+require 'rubocop/cop/betterment/unsafe_job'
+require 'rubocop/cop/betterment/unscoped_find'
+require 'rubocop/cop/betterment/use_global_strict_loading'
+require 'rubocop/cop/betterment/utils/hardcoded_attribute'
+require 'rubocop/cop/betterment/utils/method_return_table'
+require 'rubocop/cop/betterment/utils/parser'
 require 'rubocop/cop/betterment/vague_serialize'
-require 'rubocop/cop/betterment/fetch_boolean'
-require 'rubocop/cop/betterment/render_status'
-require 'rubocop/cop/betterment/redirect_status'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: betterlint
 version: !ruby/object:Gem::Version
-  version: 1.16.0
+  version: 1.17.0
 platform: ruby
 authors:
 - Development
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-20 00:00:00.000000000 Z
+date: 2025-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -125,6 +125,7 @@ files:
 - lib/rubocop/cop/betterment/timeout.rb
 - lib/rubocop/cop/betterment/unsafe_job.rb
 - lib/rubocop/cop/betterment/unscoped_find.rb
+- lib/rubocop/cop/betterment/use_global_strict_loading.rb
 - lib/rubocop/cop/betterment/utils/hardcoded_attribute.rb
 - lib/rubocop/cop/betterment/utils/method_return_table.rb
 - lib/rubocop/cop/betterment/utils/parser.rb
@@ -135,10 +136,10 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/Betterment/betterlint
-  source_code_uri: https://github.com/Betterment/betterlint/tree/v1.16.0
-  changelog_uri: https://github.com/Betterment/betterlint/blob/v1.16.0/CHANGELOG.md
+  source_code_uri: https://github.com/Betterment/betterlint/tree/v1.17.0
+  changelog_uri: https://github.com/Betterment/betterlint/blob/v1.17.0/CHANGELOG.md
   bug_tracker_uri: https://github.com/Betterment/betterlint/issues
-  documentation_uri: https://www.rubydoc.info/gems/betterlint/1.16.0
+  documentation_uri: https://www.rubydoc.info/gems/betterlint/1.17.0
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []