betterlint 1.20.0 → 1.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8373ada8389173714d5f6086fd98f64e056340b8ddbd6c3b7e9cb78a3143b1f
-  data.tar.gz: bf710724c7163b0ef355cecfaad17bcf6af70c58fa50cdb81fd7d691d1e6e269
+  metadata.gz: abed62a3254c489777ae4372142ff0bf2a4c8201003619e5c10f0754a07f9eb8
+  data.tar.gz: 618bb3269cb0c584e94bd3fef3f6776b5e325e9bf63d5cfdc8737c3c3d5f33a2
 SHA512:
-  metadata.gz: 991c3a041583443b9e53e0c3baa7ace7354b76a5a07e322d85e82f73bea4a01b7252f203ccbbac1e6947675eb20940777cc4f6df72132ba40f64aab265fbbbf3
-  data.tar.gz: c52af40049be9780cbd719df55e3747902f5c51d7e0136340140aaecc1bab53b8a17f5ecc9f84843dc43e066a9a7df90b02ce751d46c8784d2b0f77baba6e47f
+  metadata.gz: 641573afe2d923b6c4a063c6ed7051792484750e8542171f9f39c499886101ef6cb1aee01790de96f2c5c16de514e063a3ede731b37b68c7afce23a13b8cd9cb
+  data.tar.gz: bf51c01eb160f348615a8a0ee57c3f5954e22b18547b41b93f4c54a2c6dcf6bd3b544c761c56a162e6514c49e85b285c379a0270faf234f5739ae9b905dbf1d5

data/README.md

@@ -318,3 +318,15 @@ This allows us two benefits:
 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.
+
+### Betterment/VagueSerialize
+
+This cop identifies calls to `serialize` that do not specify a coder either by using the positional argument or
+the `coder` keyword argument.
+
+**NOTE:** Using a positional argument is deprecated for Rails 7.1+. That means that...
+
+- If you are on Rails 7.2
+- And you've opted into 7.1 defaults (namely, `config.active_record.default_column_serializer = nil`)
+
+...you can safely disable this cop, since failing to pass a deserializer will raise an exception.

data/config/default.yml

@@ -124,6 +124,13 @@ Betterment/UseGlobalStrictLoading/ForAssociations:
 FactoryBot/AssociationStyle:
   Enabled: false
 
+Betterment/NotUsingRswag:
+  Enabled: false
+  SafeAutoCorrect: false
+  Description: Detect API specs missing OpenAPI documentation using rswag
+  Include:
+    - spec/requests/**/*_spec.rb
+
 FactoryBot/ConsistentParenthesesStyle:
   Enabled: false
 

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Betterment
+      class NotUsingRswag < Base
+        MSG = 'Request specs must use rswag to test and document their API endpoints. See: https://github.com/rswag/rswag'
+
+        def on_block(node)
+          # Only run from root Rspec.describe block
+          return unless rspec_describe?(node)
+
+          # If the block descendants contain rswag structure, it's valid
+          return if contains_rswag_structure?(node)
+
+          # Otherwise, add offense
+          add_offense(node)
+        end
+
+        private
+
+        def contains_rswag_structure?(node)
+          has_path_block?(node) &&
+            has_http_method_block?(node) &&
+            has_response_block?(node)
+        end
+
+        # @!method rspec_describe?(node)
+        def_node_matcher :rspec_describe?, <<~PATTERN
+          (block
+            (send
+              (const nil? :RSpec) :describe ...)
+            ...)
+        PATTERN
+
+        # @!method has_path_block?(node)
+        def_node_matcher :has_path_block?, <<~PATTERN
+          `(block
+            (send nil? :path (str _))
+            ...)
+        PATTERN
+
+        # @!method has_http_method_block?(node)
+        def_node_matcher :has_http_method_block?, <<~PATTERN
+          `(block
+            (send nil? {:get :post :put :patch :delete} (str _))
+            ...)
+        PATTERN
+
+        # @!method has_response_block?(node)
+        def_node_matcher :has_response_block?, <<~PATTERN
+          `(block
+            (send nil? :response (str _) (str _))
+            ...)
+        PATTERN
+      end
+    end
+  end
+end

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

@@ -12,10 +12,16 @@ module RuboCop
           (send nil? :serialize ...)
         PATTERN
 
-        def on_send(node)
-          return unless serialize? node
+        # @!method kwargs_with_coder?(node)
+        def_node_matcher :kwargs_with_coder?, '(hash <(pair (sym :coder) const) ...>)'
+
+        # @!method valid_serialize?(node)
+        def_node_matcher :valid_serialize?, <<-PATTERN
+          (send nil? :serialize _ { const !#kwargs_with_coder?? | #kwargs_with_coder? })
+        PATTERN
 
-          add_offense(node) if node.arguments.length < 2 || !node.arguments[1].const_type?
+        def on_send(node)
+          add_offense(node) if serialize?(node) && !valid_serialize?(node)
         end
         alias on_csend on_send
       end

data/lib/rubocop/cop/betterment.rb

@@ -14,6 +14,7 @@ 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/not_using_rswag'
 require 'rubocop/cop/betterment/redirect_status'
 require 'rubocop/cop/betterment/render_status'
 require 'rubocop/cop/betterment/server_error_assertion'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: betterlint
 version: !ruby/object:Gem::Version
-  version: 1.20.0
+  version: 1.22.0
 platform: ruby
 authors:
 - Development
 bindir: bin
 cert_chain: []
-date: 2025-05-28 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -117,6 +117,7 @@ files:
 - lib/rubocop/cop/betterment/memoization_with_arguments.rb
 - lib/rubocop/cop/betterment/non_standard_actions.rb
 - lib/rubocop/cop/betterment/non_standard_controller.rb
+- lib/rubocop/cop/betterment/not_using_rswag.rb
 - lib/rubocop/cop/betterment/redirect_status.rb
 - lib/rubocop/cop/betterment/render_status.rb
 - lib/rubocop/cop/betterment/server_error_assertion.rb
@@ -136,10 +137,10 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/Betterment/betterlint
-  source_code_uri: https://github.com/Betterment/betterlint/tree/v1.20.0
-  changelog_uri: https://github.com/Betterment/betterlint/blob/v1.20.0/CHANGELOG.md
+  source_code_uri: https://github.com/Betterment/betterlint/tree/v1.22.0
+  changelog_uri: https://github.com/Betterment/betterlint/blob/v1.22.0/CHANGELOG.md
   bug_tracker_uri: https://github.com/Betterment/betterlint/issues
-  documentation_uri: https://www.rubydoc.info/gems/betterlint/1.20.0
+  documentation_uri: https://www.rubydoc.info/gems/betterlint/1.22.0
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
@@ -155,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: []