rubocop-sorbet 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf3fcf2d81ddb556a7a499288fefc3cdd30f4c1a6a47047ae5111ba510b51d00
-  data.tar.gz: cfeddb88f154b226f0321ed78b6373725985daf068355659763eb9913a40fbcc
+  metadata.gz: 6435562ddd6c7da9c69d97032407e065c2258099a118a71b7d6ac5a0e1164fd0
+  data.tar.gz: 22267c08a28a1e491546a310be05de578ba7693aba4c597ba0b508c048669777
 SHA512:
-  metadata.gz: 51c844a3c3dc0254a09e7c31fe3c5794873e9757c5f2ebb59f842d7ccf8786b66788d98acbac922e064395baefeb9f44df2a1f128720a9c6b5ffc56d4dabfe51
-  data.tar.gz: d42d29fbbdaa9ffd32ff3f01e56443677e439ac04444859df3fa2f87f5273a891bd6e9bfdf7f46454e604e6a5c0388c554633f39d11e3932556b7e1dd80c1ed3
+  metadata.gz: 85a52ba95de0151045c93321e38ec24e0859067166084b3bf1d96e3e66e91cb27997224340a26cb39a1684341e4ce1d8e1e596643216b8761d3db0960e5e361a
+  data.tar.gz: d5897dc561a7fe22cbd099c3b34355bf474f7bbcf139c3c7a1c3fed24cf3295cc02e9349a46e75a6d75da0db547f21cd971dd557c0177b88dba6842ca661602e

data/.github/workflows/check-version-placeholders.yml

@@ -8,7 +8,7 @@ jobs:
   check-placeholders:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
       - uses: ruby/setup-ruby@v1
         with:
           bundler-cache: true

data/.github/workflows/ci.yml

@@ -14,7 +14,7 @@ jobs:
         ruby: ["3.1", "3.2", "3.3", "3.4"]
     name: Test Ruby ${{ matrix.ruby }}
     steps:
-      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
       - name: Set up Ruby
         uses: ruby/setup-ruby@a4effe49ee8ee5b8b5091268c473a4628afb5651 # v1.245.0
         with:
@@ -29,7 +29,7 @@ jobs:
       fail-fast: false
     name: Lint & Docs
     steps:
-      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
       - name: Set up Ruby
         uses: ruby/setup-ruby@a4effe49ee8ee5b8b5091268c473a4628afb5651 # v1.245.0
         with:

data/.github/workflows/dependabot_automerge.yml

@@ -12,7 +12,7 @@ jobs:
     steps:
       - name: Dependabot metadata
         id: metadata
-        uses: dependabot/fetch-metadata@08eff52bf64351f401fb50d4972fa95b9f2c2d1b # v2.4.0
+        uses: dependabot/fetch-metadata@21025c705c08248db411dc16f3619e6b5f9ea21a # v2.5.0
         with:
           github-token: "${{ secrets.GITHUB_TOKEN }}"
       - name: Enable auto-merge for Dependabot PRs

data/.github/workflows/stale.yml

@@ -12,7 +12,7 @@ jobs:
   stale:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/stale@5f858e3efba33a5ca4407a664cc011ad407f2008 # v10.1.0
+      - uses: actions/stale@997185467fa4f803885201cee163a9f38240193d # v10.1.1
         with:
           stale-pr-message: >
             This PR has been automatically marked as stale because it has not had

data/.rubocop.yml

@@ -20,7 +20,7 @@ Naming/FileName:
   - lib/rubocop-sorbet.rb
 
 Layout/LineLength:
-  IgnoreCopDirectives: true
+  AllowCopDirectives: true
 
 InternalAffairs/UndefinedConfig:
   Enabled: false # Bug in implementation fails to find our configs

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop-sorbet (0.11.0)
+    rubocop-sorbet (0.12.0)
       lint_roller
       rubocop (>= 1.75.2)
 
@@ -21,20 +21,20 @@ GEM
       pp (>= 0.6.0)
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
-    json (2.12.2)
+    json (2.18.1)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
     minitest (5.25.5)
     mocha (2.7.1)
       ruby2_keywords (>= 0.0.5)
     parallel (1.27.0)
-    parser (3.3.8.0)
+    parser (3.3.10.1)
       ast (~> 2.4.1)
       racc
     pp (0.6.2)
       prettyprint
     prettyprint (0.2.0)
-    prism (1.4.0)
+    prism (1.9.0)
     psych (5.2.6)
       date
       stringio
@@ -44,10 +44,10 @@ GEM
     rdoc (6.14.1)
       erb
       psych (>= 4.0.0)
-    regexp_parser (2.10.0)
+    regexp_parser (2.11.3)
     reline (0.6.1)
       io-console (~> 0.5)
-    rubocop (1.77.0)
+    rubocop (1.84.1)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
@@ -55,12 +55,12 @@ GEM
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 2.9.3, < 3.0)
-      rubocop-ast (>= 1.45.1, < 2.0)
+      rubocop-ast (>= 1.49.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.45.1)
+    rubocop-ast (1.49.0)
       parser (>= 3.3.7.2)
-      prism (~> 1.4)
+      prism (~> 1.7)
     rubocop-minitest (0.38.1)
       lint_roller (~> 1.1)
       rubocop (>= 1.75.0, < 2.0)
@@ -70,9 +70,9 @@ GEM
     ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
     stringio (3.1.7)
-    unicode-display_width (3.1.4)
-      unicode-emoji (~> 4.0, >= 4.0.4)
-    unicode-emoji (4.0.4)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.2.0)
     yard (0.9.37)
 
 PLATFORMS

data/VERSION

@@ -1 +1 @@
-0.11.0
+0.12.0

data/config/default.yml

@@ -324,6 +324,14 @@ Sorbet/Refinement:
   Enabled: pending
   VersionAdded: 0.8.6
 
+Sorbet/RuntimeOnFailureDependsOnChecked:
+  Description: >-
+                  Ensures that `on_failure` is called after `checked` in signatures.
+                  The `on_failure` method has no effect unless `checked(:tests)` or
+                  `checked(:always)` is also called.
+  Enabled: true
+  VersionAdded: '0.12.0'
+
 Sorbet/SelectByIsA:
   Description: >-
     Suggests using `grep` over `select` when using it only for type narrowing.

data/dev.yml

@@ -1,8 +1,12 @@
 name: "rubocop-sorbet"
 
+nix: true
+
 type: "ruby"
 
 up:
+  - packages:
+    - libyaml
   - ruby
   - "bundler"
 

data/lib/rubocop/cop/sorbet/forbid_t_struct.rb

@@ -222,7 +222,7 @@ module RuboCop
           string = +"\n"
 
           line = "#{indent}sig { params(#{sorted_props.map(&:initialize_sig_param).join(", ")}).void }\n"
-          if line.length <= max_line_length
+          if max_line_length.nil? || line.length <= max_line_length
             string << line
           else
             string << "#{indent}sig do\n"
@@ -237,7 +237,7 @@ module RuboCop
           end
 
           line = "#{indent}def initialize(#{sorted_props.map(&:initialize_param).join(", ")})\n"
-          if line.length <= max_line_length
+          if max_line_length.nil? || line.length <= max_line_length
             string << line
           else
             string << "#{indent}def initialize(\n"

data/lib/rubocop/cop/sorbet/obsolete_strict_memoization.rb

@@ -66,7 +66,7 @@ module RuboCop
               correction = "#{ivar} ||= #{t.source}.let(#{init_expr.source}, #{t.source}.nilable(#{ivar_type.source}))"
 
               # We know good places to put line breaks, if required.
-              if line_length(indent + correction) > max_line_length || correction.include?("\n")
+              if (max_line_length && line_length(indent + correction) > max_line_length) || correction.include?("\n")
                 correction = <<~RUBY.chomp
                   #{ivar} ||= #{t.source}.let(
                   #{indent}  #{init_expr.source.gsub("\n", "\n#{indent}")},

data/lib/rubocop/cop/sorbet/signatures/runtime_on_failure_depends_on_checked.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Sorbet
+      # Checks that `on_failure` is not used without `checked(:tests)` or `checked(:always)`.
+      #
+      # @example
+      #
+      #   # bad
+      #   sig { params(x: Integer).returns(Integer).on_failure(:raise) }
+      #   def plus_one(x)
+      #     x + 1
+      #   end
+      #
+      #   # good
+      #   sig { params(x: Integer).returns(Integer).checked(:always).on_failure(:raise) }
+      #   def plus_one(x)
+      #     x + 1
+      #   end
+      #
+      class RuntimeOnFailureDependsOnChecked < ::RuboCop::Cop::Base
+        include SignatureHelp
+
+        MSG = "To use .on_failure you must additionally call .checked(:tests) or .checked(:always), otherwise, the .on_failure has no effect."
+
+        # @!method on_failure_call?(node)
+        def_node_matcher :on_failure_call?, <<~PATTERN
+          (send _ :on_failure ...)
+        PATTERN
+
+        # @!method checked_tests_or_always?(node)
+        def_node_matcher :checked_tests_or_always?, <<~PATTERN
+          (send _ :checked (sym {:tests | :always}))
+        PATTERN
+
+        def on_signature(node)
+          return unless node.descendants.any? { |n| on_failure_call?(n) }
+          return if node.descendants.any? { |n| checked_tests_or_always?(n) }
+
+          add_offense(node)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/sorbet_cops.rb

@@ -50,6 +50,7 @@ require_relative "sorbet/signatures/forbid_sig"
 require_relative "sorbet/signatures/forbid_sig_with_runtime"
 require_relative "sorbet/signatures/forbid_sig_without_runtime"
 require_relative "sorbet/signatures/keyword_argument_ordering"
+require_relative "sorbet/signatures/runtime_on_failure_depends_on_checked"
 require_relative "sorbet/signatures/signature_build_order"
 require_relative "sorbet/signatures/void_checked_tests"
 

data/manual/cops.md

@@ -50,6 +50,7 @@ In the following section you find all available cops:
 * [Sorbet/ObsoleteStrictMemoization](cops_sorbet.md#sorbetobsoletestrictmemoization)
 * [Sorbet/RedundantExtendTSig](cops_sorbet.md#sorbetredundantextendtsig)
 * [Sorbet/Refinement](cops_sorbet.md#sorbetrefinement)
+* [Sorbet/RuntimeOnFailureDependsOnChecked](cops_sorbet.md#sorbetruntimeonfailuredependsonchecked)
 * [Sorbet/SelectByIsA](cops_sorbet.md#sorbetselectbyisa)
 * [Sorbet/SignatureBuildOrder](cops_sorbet.md#sorbetsignaturebuildorder)
 * [Sorbet/SingleLineRbiClassModuleDefinitions](cops_sorbet.md#sorbetsinglelinerbiclassmoduledefinitions)

data/manual/cops_sorbet.md

@@ -1197,6 +1197,30 @@ module Foo
 end
 ```
 
+## Sorbet/RuntimeOnFailureDependsOnChecked
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+--- | --- | --- | --- | ---
+Enabled | Yes | No | 0.12.0 | -
+
+Checks that `on_failure` is not used without `checked(:tests)` or `checked(:always)`.
+
+### Examples
+
+```ruby
+# bad
+sig { params(x: Integer).returns(Integer).on_failure(:raise) }
+def plus_one(x)
+  x + 1
+end
+
+# good
+sig { params(x: Integer).returns(Integer).checked(:always).on_failure(:raise) }
+def plus_one(x)
+  x + 1
+end
+```
+
 ## Sorbet/SelectByIsA
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-sorbet
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Ufuk Kayserilioglu
@@ -132,6 +132,7 @@ files:
 - lib/rubocop/cop/sorbet/signatures/forbid_sig_with_runtime.rb
 - lib/rubocop/cop/sorbet/signatures/forbid_sig_without_runtime.rb
 - lib/rubocop/cop/sorbet/signatures/keyword_argument_ordering.rb
+- lib/rubocop/cop/sorbet/signatures/runtime_on_failure_depends_on_checked.rb
 - lib/rubocop/cop/sorbet/signatures/signature_build_order.rb
 - lib/rubocop/cop/sorbet/signatures/void_checked_tests.rb
 - lib/rubocop/cop/sorbet/t_enum/forbid_comparable_t_enum.rb
@@ -169,7 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Automatic Sorbet code style checking tool.
 test_files: []