betterlint 1.20.0 → 1.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8373ada8389173714d5f6086fd98f64e056340b8ddbd6c3b7e9cb78a3143b1f
-  data.tar.gz: bf710724c7163b0ef355cecfaad17bcf6af70c58fa50cdb81fd7d691d1e6e269
+  metadata.gz: 25f8e840f59447c480bca9bb7c6ec070d1a6ef4cc5d784448bbaae92bc81e0ee
+  data.tar.gz: 1aeef2d6f6c42e0967605a5dca2f69a43b58d7a4b705338956b392979c8fefe0
 SHA512:
-  metadata.gz: 991c3a041583443b9e53e0c3baa7ace7354b76a5a07e322d85e82f73bea4a01b7252f203ccbbac1e6947675eb20940777cc4f6df72132ba40f64aab265fbbbf3
-  data.tar.gz: c52af40049be9780cbd719df55e3747902f5c51d7e0136340140aaecc1bab53b8a17f5ecc9f84843dc43e066a9a7df90b02ce751d46c8784d2b0f77baba6e47f
+  metadata.gz: 4ed29d409e9038101e030a72bb736be26fa2687e8e2028be8b0fa25cddf49a768582c8fb04c546ebad0dcc4585a12705b9e0a94fa87fd81c7f381fd25f199fea
+  data.tar.gz: 622fab9cfcf2b8aeb6bc6e3ccc0c13cb62ed473d282a498798a814e1227dbfb3893f71e089359de11af7a6c8ba92b2ae4ea25f3abd0cda162b20abe8d9fdb8c6

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.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.21.0
 platform: ruby
 authors:
 - Development
 bindir: bin
 cert_chain: []
-date: 2025-05-28 00:00:00.000000000 Z
+date: 2025-06-05 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.21.0
+  changelog_uri: https://github.com/Betterment/betterlint/blob/v1.21.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.21.0
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths: