betterlint 1.24.0 → 1.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dedcf1bca77813b532e0523d2c85776697e0a0602faaa7a6939f77d0c1af5d9c
-  data.tar.gz: 68097f9df8adb9f37db3ecafa2fbec26d1445418bc080f8d879a845557b25f4a
+  metadata.gz: 521829c1a24b2013526ec739c7767473854130c2e57f7c29b184011f059264a4
+  data.tar.gz: a7cb5622266cc225688096b99811eae23fec5a1af226e410f205986c3d7414ac
 SHA512:
-  metadata.gz: '07922a227dc628c4c3fd9389dee5ffbacb56db56cc4e15160db8849a69a21e8102e1b46c9f80bbe1062073e6886832b4ef1978ed4506aa7912edfc9a6948d9e8'
-  data.tar.gz: 38d4bfc4ea265f2242cbb45b67f9d872dfb4ea7c168b3f729ce121a7f848f2c9b1c7ca2b3df89a2b65969eb9b5994f3f012ab575b3899b9b8e1c2d060a7c76fd
+  metadata.gz: cc3c3e063757b97e37257303a939e2d6d13bd8534646c5b0047f2fd58a229979bf2687702025a6d24971dac784b987c2393d67df79bc58875842500d67f55cb0
+  data.tar.gz: 0e1171c10b8c6b26f71cc13ddd77694487fce3749e40d84931ad82d90d0f57bf9eaea48bd16504c64695cdc95686932625de0dd4c56853c6bb2bf2807539a6ce

data/README.md

@@ -15,9 +15,8 @@ gem 'betterlint'
 .rubocop.yml:
 
 ```yml
-inherit_gem:
-  betterlint:
-    - config/default.yml
+plugins:
+  - betterlint
 ```
 
 ## Dependencies

data/config/default.yml

@@ -2,11 +2,16 @@
 
 require:
   - rubocop/cop/betterment.rb
+
+plugins:
+  - rubocop-capybara
+  - rubocop-factory_bot
   - rubocop-graphql
   - rubocop-performance
   - rubocop-rails
   - rubocop-rake
   - rubocop-rspec
+  - rubocop-rspec_rails
 
 AllCops:
   DisplayCopNames: true
@@ -42,10 +47,9 @@ Betterment/DynamicParams:
 
 Betterment/EnvironmentConfiguration:
   StyleGuide: '#bettermentenvironmentconfiguration'
-  Exclude:
-    - config/**/*.rb
-    - spec/**/*.rb
-    - test/**/*.rb
+  Include:
+    - app/**/*.rb
+    - lib/**/*.rb
 
 Betterment/HardcodedID:
   AutoCorrect: false
@@ -254,7 +258,7 @@ Metrics/PerceivedComplexity:
 Naming/HeredocDelimiterNaming:
   Enabled: false
 
-Naming/PredicateName:
+Naming/PredicatePrefix:
   ForbiddenPrefixes:
     - is_
   NamePrefix:
@@ -269,9 +273,6 @@ Performance/RedundantMatch:
 RSpec/BeEq:
   Enabled: false
 
-RSpec/Capybara/FeatureMethods:
-  Enabled: false
-
 RSpec/ContextWording:
   Enabled: false
 
@@ -303,7 +304,7 @@ RSpec/ExpectChange:
   EnforcedStyle: block
 
 RSpec/SpecFilePathSuffix:
-  Enabled: false
+  Enabled: true
 
 RSpec/SpecFilePathFormat:
   Enabled: false

data/lib/betterlint/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Betterlint
+  VERSION = '1.26.0'
+end

data/lib/betterlint.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'lint_roller'
+require_relative 'betterlint/version'
+
+module Betterlint
+  class Plugin < LintRoller::Plugin
+    def about
+      LintRoller::About.new(
+        name: 'betterlint',
+        version: VERSION,
+        homepage: 'https://github.com/Betterment/betterlint',
+        description: 'Shared rubocop configuration for Betterment Rails apps/engines.',
+      )
+    end
+
+    def supported?(context)
+      context.engine == :rubocop
+    end
+
+    def rules(_context)
+      LintRoller::Rules.new(
+        type: :path,
+        config_format: :rubocop,
+        value: File.expand_path('../config/default.yml', __dir__),
+      )
+    end
+  end
+end

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
@@ -118,9 +118,9 @@ module RuboCop
             #   params[:user_id]
             # end
             if ret.send_type? && ret.method?(:[])
-              internal_params = ret.arguments.select { |x| x.sym_type? || x.str_type? }.map(&:value)
+              internal_params = ret.arguments.select { |x| x.type?(:sym, :str) }.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/non_standard_actions.rb

@@ -52,6 +52,10 @@ module RuboCop
           route = route_to(node)
           if route
             (path, param, value) = route
+
+            # Newer Rubocop versions return param as an array
+            param = param.first if param.is_a?(Array)
+
             action = case param
             when :to then value.first.split('#').last
             when :action then value.first

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

@@ -67,16 +67,16 @@ module RuboCop
             end
           end
 
-          def self.params_from_arguments(arguments) # rubocop:disable Metrics/PerceivedComplexity
+          def self.params_from_arguments(arguments)
             parameter_names = []
 
             arguments.each do |arg|
               if arg.hash_type?
                 arg.children.each do |pair|
                   value = pair.value
-                  parameter_names << value.value if value.sym_type? || value.str_type?
+                  parameter_names << value.value if value.type?(:sym, :str)
                 end
-              elsif arg.sym_type? || arg.str_type?
+              elsif arg.type?(:sym, :str)
                 parameter_names << arg.value
               end
             end
@@ -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?
+                x.type?(:sym, :str)
               }.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

@@ -26,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,28 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: betterlint
 version: !ruby/object:Gem::Version
-  version: 1.24.0
+  version: 1.26.0
 platform: ruby
 authors:
 - Development
+autorequire:
 bindir: bin
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2025-12-17 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: lint_roller
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.71'
+        version: '1.82'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.82'
+- !ruby/object:Gem::Dependency
+  name: rubocop-capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.22'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.22'
+- !ruby/object:Gem::Dependency
+  name: rubocop-factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.28'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.71'
+        version: '2.28'
 - !ruby/object:Gem::Dependency
   name: rubocop-graphql
   requirement: !ruby/object:Gem::Requirement
@@ -30,6 +73,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -37,62 +83,79 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.6
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.23'
+        version: '1.26'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.23'
+        version: '1.26'
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.29'
+        version: '2.34'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.29'
+        version: '2.34'
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.29'
+        version: '3.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.32'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.29'
+        version: '2.32'
 description: Betterment rubocop configuration
 email:
 - development@betterment.com
@@ -103,6 +166,8 @@ files:
 - README.md
 - STYLEGUIDE.md
 - config/default.yml
+- lib/betterlint.rb
+- lib/betterlint/version.rb
 - lib/rubocop/cop/betterment.rb
 - lib/rubocop/cop/betterment/active_job_performable.rb
 - lib/rubocop/cop/betterment/allowlist_blocklist.rb
@@ -129,7 +194,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
@@ -138,11 +202,13 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/Betterment/betterlint
-  source_code_uri: https://github.com/Betterment/betterlint/tree/v1.24.0
-  changelog_uri: https://github.com/Betterment/betterlint/blob/v1.24.0/CHANGELOG.md
+  source_code_uri: https://github.com/Betterment/betterlint/tree/v1.26.0
+  changelog_uri: https://github.com/Betterment/betterlint/blob/v1.26.0/CHANGELOG.md
   bug_tracker_uri: https://github.com/Betterment/betterlint/issues
-  documentation_uri: https://www.rubydoc.info/gems/betterlint/1.24.0
+  documentation_uri: https://www.rubydoc.info/gems/betterlint/1.26.0
   rubygems_mfa_required: 'true'
+  default_lint_roller_plugin: Betterlint::Plugin
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -157,7 +223,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.8
+rubygems_version: 3.4.10
+signing_key:
 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