betterlint 1.23.0 → 1.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e78f83970d4e6b36b46992475351b250c46011a6038cb48eab065ab96dc602b7
-  data.tar.gz: 8a8638f233932cab03d50d11d34c90a1abc043823be86c75252f2a79ff2773bb
+  metadata.gz: 04c560ef56ed92b4393449c238d64d433b16caa1db01dbcb81c647c04f9931d6
+  data.tar.gz: bac5e05a6ec457e6c047eba8c1d709549167ceae3b408fa084c5aa83c9594676
 SHA512:
-  metadata.gz: 6a95aa48d9f871dd4c1b09f3361d62808d058afe8739a8d5ea85c2ed28aedb43e16c2cc6c54e9b8bbff27d31dd03215abd0c0701df90abaa8f7e77d0caf984cf
-  data.tar.gz: dd86cb3a940ced9cde0eb1902aa435bfe66f7bb7c94b2cd08d3f340f1c6f86537ec4eee890dcaeb4f15c62f2524029cc576c6b5a03df5c57f26f5de401b8b0b6
+  metadata.gz: 57bf6d2446f5ec19e463e3bad15bb22934b08104a7614f08b1f67291bd8243ef7c1fdbccd7d8259f8b7b69c10f995248561c2e2cecf032c2bac01df2fd074aba
+  data.tar.gz: f2cee92d7b16ba483562f7bb1ebf822ff186e106cbf1df9f3f026f013f801a2f4f9fb01737e50b3e8bbfe83f4ee26af1b44614e35a48cf65028e7d3f6afb1dd2

data/README.md

@@ -142,13 +142,18 @@ If there isn't a better place to assign your environment variable, Rails provide
 for [custom configuration](https://guides.rubyonrails.org/configuring.html#custom-configuration):
 
 ```ruby
-config.x.whatever = ENV.fetch('WHATEVER')
+config.x.some_namespace.whatever = ENV.fetch('WHATEVER')
 ```
 
 Here's how you'd reference this configuration parameter at runtime:
 
 ```ruby
-Rails.configuration.x.whatever
+Rails.configuration.x.some_namespace.whatever
+```
+
+Or to raise an error when the value is not present
+```ruby
+Rails.configuration.x.some_namespace.whatever! # will raise "KeyError: :whatever is blank" when value is not set or set to nil
 ```
 
 ### Betterment/InternalsProtection
@@ -302,6 +307,39 @@ This cop requires you to explicitly provide an HTTP status code when rendering a
 create, update, and destroy actions. When autocorrecting, this will automatically add
 `status: :unprocessable_entity` or `status: :ok` depending on what you're rendering.
 
+### Betterment/SimpleDelegator
+
+This cop requires you to use Rails's `delegate` class method instead of `SimpleDelegator` in order to explicitly specify
+the set of delegated methods.
+
+#### BAD:
+
+```ruby
+class GearPresenter < SimpleDelegator
+  def ratio_string
+    ratio.to_s
+  end
+end
+```
+
+#### GOOD:
+
+```ruby
+class GearPresenter
+  attr_reader :gear
+  
+  delegate :ratio, to: :gear
+  
+  def initialize(gear)
+    @gear = gear
+  end
+  
+  def ratio_string
+    ratio.to_s
+  end
+end
+```
+
 ### 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.

data/STYLEGUIDE.md

@@ -109,3 +109,36 @@ expect(response).to have_http_status 422
 expect(response).to have_http_status :internal_server_error
 expect(response).to have_http_status 500
 ```
+
+## Betterment/SimpleDelegator
+
+This cop requires you to use Rail's `delegate` class method instead of `SimpleDelegator` in order to explicitly specify
+the set of delegating methods.
+
+### BAD:
+
+```ruby
+class GearPresenter < SimpleDelegator
+  def ratio_string
+    ratio.to_s
+  end
+end
+```
+
+### GOOD:
+
+```ruby
+class GearDelegator
+  attr_reader :gear
+
+  delegate :ratio, to: :gear
+
+  def initialize(gear)
+    @gear = gear
+  end
+
+  def ratio_string
+    ratio.to_s
+  end
+end
+```

data/config/default.yml

@@ -95,6 +95,10 @@ Betterment/ServerErrorAssertion:
   Include:
     - spec/requests/**/*_spec.rb
 
+Betterment/SimpleDelegator:
+  StyleGuide: '#bettermentsimpledelegator'
+  AutoCorrect: false
+
 Betterment/SitePrismLoaded:
   Include:
     - spec/features/**/*_spec.rb

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

@@ -37,17 +37,17 @@ module RuboCop
           super
           @unsafe_parameters = cop_config.fetch("unsafe_parameters").map(&:to_sym)
           @unsafe_regex = Regexp.new cop_config.fetch("unsafe_regex")
-          @param_wrappers = []
+        end
+
+        def on_new_investigation
+          super
+          @class_methods = {}.freeze
+          @param_wrappers = [].freeze
         end
 
         def on_class(node)
-          Utils::MethodReturnTable.populate_index node
-          Utils::MethodReturnTable.indexed_methods.each do |method_name, method_returns|
-            method_returns.each do |x|
-              name = Utils::Parser.get_root_token(x)
-              @param_wrappers << method_name if name == :params || @param_wrappers.include?(name)
-            end
-          end
+          @class_methods = Utils::Parser.get_instance_methods(node).freeze
+          @param_wrappers = find_param_wrappers(@class_methods).freeze
         end
 
         def on_send(node) # rubocop:disable Metrics/PerceivedComplexity
@@ -88,7 +88,7 @@ module RuboCop
 
         # Flags objects being created/updated with unsafe
         # params indirectly from params or through params.permit
-        def flag_indirect_param_use(node) # rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
+        def flag_indirect_param_use(node) # rubocop:disable Metrics/PerceivedComplexity
           name = Utils::Parser.get_root_token(node)
           # extracted_params contains parameters used like:
           # def create
@@ -99,7 +99,7 @@ module RuboCop
           # end
           extracted_params = Utils::Parser.get_extracted_parameters(node, param_aliases: @param_wrappers)
 
-          returns = Utils::MethodReturnTable.get_method(name) || []
+          returns = get_method_returns(name)
           returns.each do |ret|
             # # propagated_params contains parameters used like:
             # def create
@@ -120,7 +120,7 @@ module RuboCop
             if ret.send_type? && ret.method?(:[])
               internal_params = ret.arguments.select { |x| x.sym_type? || x.str_type? }.map(&:value)
             else
-              internal_returns = Utils::MethodReturnTable.get_method(Utils::Parser.get_root_token(ret)) || []
+              internal_returns = get_method_returns(Utils::Parser.get_root_token(ret))
               internal_params = internal_returns.flat_map { |x| Utils::Parser.get_extracted_parameters(x, param_aliases: @param_wrappers) }
             end
 
@@ -144,6 +144,19 @@ module RuboCop
         def suspicious_id?(symbol_name)
           @unsafe_parameters.include?(symbol_name.to_sym) || @unsafe_regex.match(symbol_name) # symbol_name.to_s.end_with?("_id")
         end
+
+        def find_param_wrappers(class_methods)
+          class_methods.each_with_object([]) do |(method_name, method_returns), param_wrappers|
+            param_wrappers << method_name if method_returns.any? do |return_value|
+              name = Utils::Parser.get_root_token(return_value)
+              name.equal?(:params) || param_wrappers.include?(name)
+            end
+          end
+        end
+
+        def get_method_returns(method_name)
+          @class_methods.fetch(method_name, [])
+        end
       end
     end
   end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Betterment
+      class SimpleDelegator < Base
+        MSG = <<~MSG
+          In order to specify a set of explicitly available methods,
+          use the `delegate` class method instead of `SimpleDelegator`.
+
+          See here for more information on this error:
+          https://github.com/Betterment/betterlint/#bettermentsimpledelegator
+        MSG
+
+        # @!method class_with_simple_delegator?(node)
+        def_node_matcher :class_with_simple_delegator?, <<~PATTERN
+          (class _ (const nil? :SimpleDelegator) _)
+        PATTERN
+
+        def on_class(node)
+          add_offense(node) if class_with_simple_delegator?(node)
+        end
+      end
+    end
+  end
+end

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

@@ -40,8 +40,13 @@ module RuboCop
           @unauthenticated_models = cop_config.fetch("unauthenticated_models").map(&:to_sym)
         end
 
+        def on_new_investigation
+          super
+          @class_methods = {}.freeze
+        end
+
         def on_class(node)
-          Utils::MethodReturnTable.populate_index(node)
+          @class_methods = Utils::Parser.get_instance_methods(node).freeze
         end
 
         def on_send(node)
@@ -86,9 +91,7 @@ module RuboCop
 
         def uses_params?(node)
           root = Utils::Parser.get_root_token(node)
-          root == :params || Array(Utils::MethodReturnTable.get_method(root)).find do |x|
-            Utils::Parser.get_root_token(x) == :params
-          end
+          root.equal?(:params) || method_returns_params?(root)
         end
 
         # yoinked from Rails/DynamicFindBy
@@ -98,6 +101,12 @@ module RuboCop
 
           match[2] ? 'find_by!' : 'find_by'
         end
+
+        def method_returns_params?(method_name)
+          @class_methods.fetch(method_name, []).any? do |return_value|
+            Utils::Parser.get_root_token(return_value).equal?(:params)
+          end
+        end
       end
     end
   end

data/lib/rubocop/cop/betterment/utils/parser.rb

@@ -88,16 +88,16 @@ module RuboCop
             return [] unless node.send_type?
 
             parameter_names = []
-            param_aliases << :params
+            aliases = param_aliases | %i(params)
 
-            if node.method?(:[]) && param_aliases.include?(get_root_token(node))
+            if node.method?(:[]) && aliases.include?(get_root_token(node))
               return node.arguments.select { |x|
                 x.sym_type? || x.str_type?
               }.map(&:value)
             end
 
             children = node.descendants.select do |child|
-              child.send_type? && param_aliases.include?(child.method_name)
+              child.send_type? && aliases.include?(child.method_name)
             end
 
             children.each do |child|
@@ -112,6 +112,23 @@ module RuboCop
 
             parameter_names.map(&:to_sym)
           end
+
+          def self.get_instance_methods(node) # rubocop:disable Metrics/PerceivedComplexity
+            raise ArgumentError, 'must be a class node' unless node&.class_type?
+
+            methods = node.descendants.select(&:def_type?).to_h do |method|
+              [method.method_name, get_return_values(method)]
+            end
+
+            node.descendants.each do |descendant|
+              lhs, rhs = *descendant
+              if descendant.equals_asgn? && !descendant.type.equal?(:casgn) && rhs&.send_type?
+                methods[lhs] = [rhs]
+              end
+            end
+
+            methods
+          end
         end
       end
     end

data/lib/rubocop/cop/betterment.rb

@@ -18,6 +18,7 @@ require 'rubocop/cop/betterment/not_using_rswag'
 require 'rubocop/cop/betterment/redirect_status'
 require 'rubocop/cop/betterment/render_status'
 require 'rubocop/cop/betterment/server_error_assertion'
+require 'rubocop/cop/betterment/simple_delegator'
 require 'rubocop/cop/betterment/site_prism_loaded'
 require 'rubocop/cop/betterment/spec_helper_required_outside_spec_dir'
 require 'rubocop/cop/betterment/timeout'
@@ -25,6 +26,5 @@ 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'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: betterlint
 version: !ruby/object:Gem::Version
-  version: 1.23.0
+  version: 1.25.0
 platform: ruby
 authors:
 - Development
 bindir: bin
 cert_chain: []
-date: 2025-07-10 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -121,6 +121,7 @@ files:
 - lib/rubocop/cop/betterment/redirect_status.rb
 - lib/rubocop/cop/betterment/render_status.rb
 - lib/rubocop/cop/betterment/server_error_assertion.rb
+- lib/rubocop/cop/betterment/simple_delegator.rb
 - lib/rubocop/cop/betterment/site_prism_loaded.rb
 - lib/rubocop/cop/betterment/spec_helper_required_outside_spec_dir.rb
 - lib/rubocop/cop/betterment/timeout.rb
@@ -128,7 +129,6 @@ files:
 - 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
 - lib/rubocop/cop/betterment/utils/response_status.rb
 - lib/rubocop/cop/betterment/vague_serialize.rb
@@ -137,10 +137,10 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/Betterment/betterlint
-  source_code_uri: https://github.com/Betterment/betterlint/tree/v1.23.0
-  changelog_uri: https://github.com/Betterment/betterlint/blob/v1.23.0/CHANGELOG.md
+  source_code_uri: https://github.com/Betterment/betterlint/tree/v1.25.0
+  changelog_uri: https://github.com/Betterment/betterlint/blob/v1.25.0/CHANGELOG.md
   bug_tracker_uri: https://github.com/Betterment/betterlint/issues
-  documentation_uri: https://www.rubydoc.info/gems/betterlint/1.23.0
+  documentation_uri: https://www.rubydoc.info/gems/betterlint/1.25.0
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
@@ -156,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.6
+rubygems_version: 3.6.8
 specification_version: 4
 summary: Betterment rubocop configuration
 test_files: []

data/lib/rubocop/cop/betterment/utils/method_return_table.rb

@@ -1,52 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module Betterment
-      module Utils
-        module MethodReturnTable
-          class << self
-            def populate_index(node)
-              raise "not a class" unless node.class_type?
-
-              get_methods_for_class(node).each do |method|
-                track_method(method.method_name, Utils::Parser.get_return_values(method))
-              end
-
-              node.descendants.each do |descendant|
-                lhs, rhs = *descendant
-                next unless descendant.equals_asgn? && (descendant.type != :casgn) && rhs&.send_type?
-
-                track_method(lhs, [rhs])
-              end
-            end
-
-            def indexed_methods
-              @indexed_methods ||= {}
-            end
-
-            def get_method(method_name)
-              indexed_methods[method_name]
-            end
-
-            def has_method?(method_name)
-              indexed_methods.include?(method_name)
-            end
-
-            private
-
-            def track_method(method_name, returns)
-              indexed_methods[method_name] = returns
-            end
-
-            def get_methods_for_class(node)
-              return [] unless node.children && node.class_type?
-
-              node.descendants.select(&:def_type?)
-            end
-          end
-        end
-      end
-    end
-  end
-end