rubocop-sorbet 0.8.7 → 0.8.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a44258e5997d8d76d11a35e921aaa0312daaadb5d159a2cf8425213baabdc1e
-  data.tar.gz: de2a3ed4f84838094981247acce55eb873c620fbcea454ed145c174008734cd7
+  metadata.gz: '048bbf857fc0e733a27de48597f476ca59d22efb8a8eded11de5252f604b5804'
+  data.tar.gz: 39d1335d326dc98b38041d5bfe66547d1398c10a6c1556f31bb22d5698db5bd9
 SHA512:
-  metadata.gz: af324556ad44f2eda2a26ba9cd006a92af766c8cc46872d761f1db769f9aa0b528d4d828b7d6a5e335a557cbce277f271da5a295f9c7d4a74f7babda35be6106
-  data.tar.gz: a927134808ef57e9ddaa7fb0798d61e2e00011b68c86f429e8c53d12f693072ef69368657963e587165693d84f0d814abdc2b1ff29531aa58fa36fb9ad849ae1
+  metadata.gz: feda39cdafbc2c3a06138bc9e34d6900423fefcbd3906e7b9104f725f15c3469e3f9e8aa03148ba12b4e2ee5fd0d4f3b54930810d8ed1715ba31881748a9a0a1
+  data.tar.gz: 5c626f9c2f15436297415e01dad6f758452e79289ede0ae74d22a3cb39fd77b2188598e199f123d263a99ffb183208ee83fff175f700cc44be40e559ef4031a6

data/.github/workflows/ci.yml

@@ -11,7 +11,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ["3.1", "3.2", "3.3"]
+        ruby: ["3.1", "3.2", "3.3", "3.4"]
     name: Test Ruby ${{ matrix.ruby }}
     steps:
       - uses: actions/checkout@v4
@@ -42,5 +42,7 @@ jobs:
           bin/rubocop --config config/default.yml config -r rubocop-sorbet
       - name: Lint Ruby files
         run: bin/rubocop
+      - name: Verify cop examples
+        run: bundle exec rake documentation_syntax_check
       - name: Verify documentation is up to date
         run: bundle exec rake generate_cops_documentation

data/.rubocop.yml

@@ -24,3 +24,18 @@ Layout/LineLength:
 
 InternalAffairs/UndefinedConfig:
   Enabled: false # Bug in implementation fails to find our configs
+
+InternalAffairs/OnSendWithoutOnCSend:
+  Exclude:
+    # Cases where we don't expect a conditional send
+    - lib/rubocop/cop/sorbet/callback_conditionals_binding.rb
+    - lib/rubocop/cop/sorbet/forbid_include_const_literal.rb
+    - lib/rubocop/cop/sorbet/forbid_t_struct.rb
+    - lib/rubocop/cop/sorbet/forbid_t_untyped.rb
+    - lib/rubocop/cop/sorbet/implicit_conversion_method.rb
+    - lib/rubocop/cop/sorbet/rbi/forbid_extend_t_sig_helpers_in_shims.rb
+    - lib/rubocop/cop/sorbet/redundant_extend_t_sig.rb
+    - lib/rubocop/cop/sorbet/refinement.rb
+    - lib/rubocop/cop/sorbet/signatures/allow_incompatible_override.rb
+    - lib/rubocop/cop/sorbet/signatures/enforce_signatures.rb
+    - lib/rubocop/cop/sorbet/t_enum/forbid_comparable_t_enum.rb

data/.ruby-version

@@ -1 +1 @@
-3.3.3
+3.4.1

data/Gemfile.lock

@@ -1,36 +1,39 @@
 PATH
   remote: .
   specs:
-    rubocop-sorbet (0.8.7)
+    rubocop-sorbet (0.8.9)
       rubocop (>= 1)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    debug (1.9.2)
+    date (3.4.1)
+    debug (1.10.0)
       irb (~> 1.10)
       reline (>= 0.3.8)
     diff-lcs (1.5.1)
-    io-console (0.7.2)
-    irb (1.12.0)
-      rdoc
+    io-console (0.8.0)
+    irb (1.14.3)
+      rdoc (>= 4.0.0)
       reline (>= 0.4.2)
-    json (2.7.2)
-    language_server-protocol (3.17.0.3)
+    json (2.10.1)
+    language_server-protocol (3.17.0.4)
+    lint_roller (1.1.0)
     parallel (1.26.3)
-    parser (3.3.5.0)
+    parser (3.3.7.1)
       ast (~> 2.4.1)
       racc
-    psych (5.1.2)
+    psych (5.2.2)
+      date
       stringio
     racc (1.8.1)
     rainbow (3.1.1)
     rake (13.2.1)
-    rdoc (6.6.3.1)
+    rdoc (6.10.0)
       psych (>= 4.0.0)
-    regexp_parser (2.9.2)
-    reline (0.5.1)
+    regexp_parser (2.10.0)
+    reline (0.6.0)
       io-console (~> 0.5)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
@@ -45,23 +48,26 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.1)
-    rubocop (1.67.0)
+    rubocop (1.72.1)
       json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 2.4, < 3.0)
-      rubocop-ast (>= 1.32.2, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.32.3)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.38.0)
       parser (>= 3.3.1.0)
     rubocop-shopify (2.15.1)
       rubocop (~> 1.51)
     ruby-progressbar (1.13.0)
-    stringio (3.1.0)
-    unicode-display_width (2.6.0)
+    stringio (3.1.2)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
     yard (0.9.37)
 
 PLATFORMS

data/config/default.yml

@@ -110,6 +110,13 @@ Sorbet/ForbidSuperclassConstLiteral:
   Exclude:
   - db/migrate/*.rb
 
+Sorbet/ForbidTEnum:
+  Description: 'Forbid usage of T::Enum.'
+  Enabled: false
+  VersionAdded: <<next>>
+  VersionChanged: <<next>>
+  Safe: false
+
 Sorbet/ForbidTStruct:
   Description: 'Forbid usage of T::Struct.'
   Enabled: false
@@ -252,6 +259,7 @@ Sorbet/SingleLineRbiClassModuleDefinitions:
 Sorbet/StrictSigil:
   Description: 'All files must be at least at strictness `strict`.'
   Enabled: false
+  Safe: false
   SuggestedStrictness: "strict"
   VersionAdded: 0.3.3
   Include:

data/config/rbi.yml

@@ -103,11 +103,11 @@ Layout/InitialIndentation:
 
 Layout/LeadingCommentSpace:
   Enabled: true
+  AllowRBSInlineAnnotation: true
 
 Layout/LeadingEmptyLines:
   Enabled: true
 
-# TODO: make Tapioca break long lines?
 Layout/LineLength:
   Enabled: false
 

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

@@ -6,6 +6,7 @@ module RuboCop
       # Ensures that callback conditionals are bound to the right type
       # so that they are type checked properly.
       #
+      # @safety
       # Auto-correction is unsafe because other libraries define similar style callbacks as Rails, but don't always need
       # binding to the attached class. Auto-correcting those usages can lead to false positives and auto-correction
       # introduces new typing errors.

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

@@ -50,14 +50,14 @@ module RuboCop
         private
 
         def neither_const_nor_self?(node)
-          !node.const_type? && !node.self_type?
+          !node.type?(:const, :self)
         end
 
         # Returns true if the node is within a module declaration that is not anonymous.
         def within_onymous_module?(node)
           parent = node.parent
-          parent = parent.parent while parent&.begin_type? || parent&.block_type?
-          parent && (parent.module_type? || parent.class_type? || parent.sclass_type?)
+          parent = parent.parent while parent&.type?(:begin, :block)
+          parent&.type?(:module, :class, :sclass)
         end
       end
     end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+module RuboCop
+  module Cop
+    module Sorbet
+      # Disallow using `T::Enum`.
+      #
+      # @example
+      #
+      #   # bad
+      #   class MyEnum < T::Enum
+      #     enums do
+      #       A = new
+      #       B = new
+      #     end
+      #   end
+      #
+      #   # good
+      #   class MyEnum
+      #     A = "a"
+      #     B = "b"
+      #     C = "c"
+      #   end
+      class ForbidTEnum < RuboCop::Cop::Base
+        MSG = "Using `T::Enum` is deprecated in this codebase."
+
+        # @!method t_enum?(node)
+        def_node_matcher(:t_enum?, <<~PATTERN)
+          (const (const {nil? cbase} :T) :Enum)
+        PATTERN
+
+        def on_class(node)
+          add_offense(node) if t_enum?(node.parent_class)
+        end
+      end
+    end
+  end
+end

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

@@ -43,8 +43,8 @@ module RuboCop
 
         RESTRICT_ON_SEND = [:include, :prepend, :extend].freeze
 
-        MSG_STRUCT = "Using `T::Struct` or its variants is deprecated."
-        MSG_PROPS = "Using `T::Props` or its variants is deprecated."
+        MSG_STRUCT = "Using `T::Struct` or its variants is deprecated in this codebase."
+        MSG_PROPS = "Using `T::Props` or its variants is deprecated in this codebase."
 
         # This class walks down the class body of a T::Struct and collects all the properties that will need to be
         # translated into `attr_reader` and `attr_accessor` methods.

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

@@ -24,6 +24,7 @@ module RuboCop
         def on_send(node)
           add_offense(node) if t_unsafe?(node)
         end
+        alias_method :on_csend, :on_send
       end
     end
   end

data/lib/rubocop/cop/sorbet/sigils/has_sigil.rb

@@ -13,6 +13,7 @@ module RuboCop
       # * `SuggestedStrictness`: Sorbet strictness level suggested in offense messages (default: 'false')
       # * `MinimumStrictness`: If set, make offense if the strictness level in the file is below this one
       #
+      # If a `SuggestedStrictness` level is specified, it will be used in autocorrect.
       # If a `MinimumStrictness` level is specified, it will be used in offense messages and autocorrect.
       class HasSigil < ValidSigil
         def require_sigil_on_all_files?

data/lib/rubocop/cop/sorbet/sigils/strict_sigil.rb

@@ -7,6 +7,21 @@ module RuboCop
   module Cop
     module Sorbet
       # Makes the Sorbet `strict` sigil mandatory in all files.
+      #
+      # @safety
+      #   This cop is unsafe because Sorbet sigils may not exist yet when it is run.
+      #
+      # @example
+      #
+      #   # bad
+      #   # typed: true
+      #
+      #   # bad
+      #   # typed: false
+      #
+      #   # good
+      #   # typed: strict
+      #
       class StrictSigil < HasSigil
         def minimum_strictness
           "strict"

data/lib/rubocop/cop/sorbet/sigils/valid_sigil.rb

@@ -16,6 +16,7 @@ module RuboCop
       # * `ExactStrictness`: If set, make offense if the strictness level in the file is different than this one
       #
       # If an `ExactStrictness` level is specified, it will be used in offense messages and autocorrect.
+      # If a `SuggestedStrictness` level is specified, it will be used in autocorrect.
       # Otherwise, if a `MinimumStrictness` level is specified, it will be used in offense messages and autocorrect.
       class ValidSigil < RuboCop::Cop::Base
         extend AutoCorrector

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

@@ -35,7 +35,7 @@ module RuboCop
           out_of_kwoptarg = false
 
           parameters.reverse.each do |param|
-            out_of_kwoptarg = true unless param.kwoptarg_type? || param.blockarg_type? || param.kwrestarg_type?
+            out_of_kwoptarg = true unless param.type?(:kwoptarg, :blockarg, :kwrestarg)
 
             next unless param.kwoptarg_type? && out_of_kwoptarg
 

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

@@ -35,7 +35,7 @@ module RuboCop
 
         # @!method checked_tests(node)
         def_node_search(:checked_tests, <<~PATTERN)
-          ({csend send} _ :checked (sym :tests))
+          (call _ :checked (sym :tests))
         PATTERN
 
         MESSAGE =

data/lib/rubocop/cop/sorbet_cops.rb

@@ -12,6 +12,7 @@ require_relative "sorbet/forbid_type_aliased_shapes"
 require_relative "sorbet/forbid_untyped_struct_props"
 require_relative "sorbet/implicit_conversion_method"
 require_relative "sorbet/callback_conditionals_binding"
+require_relative "sorbet/forbid_t_enum"
 require_relative "sorbet/forbid_t_struct"
 require_relative "sorbet/forbid_t_unsafe"
 require_relative "sorbet/forbid_t_untyped"

data/lib/rubocop/sorbet/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Sorbet
-    VERSION = "0.8.7"
+    VERSION = "0.8.9"
   end
 end

data/manual/cops.md

@@ -21,6 +21,7 @@ In the following section you find all available cops:
 * [Sorbet/ForbidIncludeConstLiteral](cops_sorbet.md#sorbetforbidincludeconstliteral)
 * [Sorbet/ForbidRBIOutsideOfAllowedPaths](cops_sorbet.md#sorbetforbidrbioutsideofallowedpaths)
 * [Sorbet/ForbidSuperclassConstLiteral](cops_sorbet.md#sorbetforbidsuperclassconstliteral)
+* [Sorbet/ForbidTEnum](cops_sorbet.md#sorbetforbidtenum)
 * [Sorbet/ForbidTStruct](cops_sorbet.md#sorbetforbidtstruct)
 * [Sorbet/ForbidTUnsafe](cops_sorbet.md#sorbetforbidtunsafe)
 * [Sorbet/ForbidTUntyped](cops_sorbet.md#sorbetforbidtuntyped)

data/manual/cops_sorbet.md

@@ -448,6 +448,33 @@ Name | Default value | Configurable values
 --- | --- | ---
 Exclude | `db/migrate/*.rb` | Array
 
+## Sorbet/ForbidTEnum
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+--- | --- | --- | --- | ---
+Disabled | No | No | <<next>> | <<next>>
+
+Disallow using `T::Enum`.
+
+### Examples
+
+```ruby
+# bad
+class MyEnum < T::Enum
+  enums do
+    A = new
+    B = new
+  end
+end
+
+# good
+class MyEnum
+  A = "a"
+  B = "b"
+  C = "c"
+end
+```
+
 ## Sorbet/ForbidTStruct
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
@@ -588,6 +615,7 @@ Options:
 * `SuggestedStrictness`: Sorbet strictness level suggested in offense messages (default: 'false')
 * `MinimumStrictness`: If set, make offense if the strictness level in the file is below this one
 
+If a `SuggestedStrictness` level is specified, it will be used in autocorrect.
 If a `MinimumStrictness` level is specified, it will be used in offense messages and autocorrect.
 
 ### Configurable attributes
@@ -860,10 +888,23 @@ Include | `**/*.rbi` | Array
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
 --- | --- | --- | --- | ---
-Disabled | Yes | Yes  | 0.3.3 | -
+Disabled | No | Yes  | 0.3.3 | -
 
 Makes the Sorbet `strict` sigil mandatory in all files.
 
+### Examples
+
+```ruby
+# bad
+# typed: true
+
+# bad
+# typed: false
+
+# good
+# typed: strict
+```
+
 ### Configurable attributes
 
 Name | Default value | Configurable values
@@ -970,6 +1011,7 @@ Options:
 * `ExactStrictness`: If set, make offense if the strictness level in the file is different than this one
 
 If an `ExactStrictness` level is specified, it will be used in offense messages and autocorrect.
+If a `SuggestedStrictness` level is specified, it will be used in autocorrect.
 Otherwise, if a `MinimumStrictness` level is specified, it will be used in offense messages and autocorrect.
 
 ### Configurable attributes

metadata

@@ -1,17 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-sorbet
 version: !ruby/object:Gem::Version
-  version: 0.8.7
+  version: 0.8.9
 platform: ruby
 authors:
 - Ufuk Kayserilioglu
 - Alan Wu
 - Alexandre Terrasa
 - Peter Zhu
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-01 00:00:00.000000000 Z
+date: 2025-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -27,7 +26,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1'
-description:
 email:
 - ruby@shopify.com
 executables: []
@@ -68,6 +66,7 @@ files:
 - lib/rubocop/cop/sorbet/constants_from_strings.rb
 - lib/rubocop/cop/sorbet/forbid_include_const_literal.rb
 - lib/rubocop/cop/sorbet/forbid_superclass_const_literal.rb
+- lib/rubocop/cop/sorbet/forbid_t_enum.rb
 - lib/rubocop/cop/sorbet/forbid_t_struct.rb
 - lib/rubocop/cop/sorbet/forbid_t_unsafe.rb
 - lib/rubocop/cop/sorbet/forbid_t_untyped.rb
@@ -122,7 +121,6 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/shopify/rubocop-sorbet
   source_code_uri: https://github.com/shopify/rubocop-sorbet
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -137,8 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.3
 specification_version: 4
 summary: Automatic Sorbet code style checking tool.
 test_files: []