rubocop-sorbet 0.8.9 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '048bbf857fc0e733a27de48597f476ca59d22efb8a8eded11de5252f604b5804'
-  data.tar.gz: 39d1335d326dc98b38041d5bfe66547d1398c10a6c1556f31bb22d5698db5bd9
+  metadata.gz: 743baa95aeb8e124bebb3d354867e42a397e874d43ab75e0f8fcc2b7d40e7757
+  data.tar.gz: 705349f2986c114712c99303de229cf95128a66c79dc97de54d274623ab9a785
 SHA512:
-  metadata.gz: feda39cdafbc2c3a06138bc9e34d6900423fefcbd3906e7b9104f725f15c3469e3f9e8aa03148ba12b4e2ee5fd0d4f3b54930810d8ed1715ba31881748a9a0a1
-  data.tar.gz: 5c626f9c2f15436297415e01dad6f758452e79289ede0ae74d22a3cb39fd77b2188598e199f123d263a99ffb183208ee83fff175f700cc44be40e559ef4031a6
+  metadata.gz: 9fac22901d690391f93b24ceef20727e3b6e79a9de887792d7cdb50cd3237caa38ac5655162aec3c748d01e747dd838ed6ca9efa4c5b727ff5d218fe495867f6
+  data.tar.gz: c988d90e224c3cfd3c93d13190e8d100165d35d3e9968c15930319ca94f5c6d787484bbb9bff3a92cb7b84deb4643b86720bc841751f823560865cf429121c4c

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    rubocop-sorbet (0.8.9)
+    rubocop-sorbet (0.9.0)
+      lint_roller (~> 1.1)
       rubocop (>= 1)
 
 GEM
@@ -48,7 +49,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.1)
-    rubocop (1.72.1)
+    rubocop (1.73.2)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
@@ -59,7 +60,7 @@ GEM
       rubocop-ast (>= 1.38.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.38.0)
+    rubocop-ast (1.38.1)
       parser (>= 3.3.1.0)
     rubocop-shopify (2.15.1)
       rubocop (~> 1.51)

data/README.md

@@ -24,30 +24,33 @@ You need to tell RuboCop to load the Sorbet extension. There are three ways to d
 Put this into your `.rubocop.yml`:
 
 ```yaml
-require: rubocop-sorbet
+plugins: rubocop-sorbet
 ```
 
 Alternatively, use the following array notation when specifying multiple extensions:
 
 ```yaml
-require:
-  - rubocop-other-extension
+plugins:
   - rubocop-sorbet
+  - rubocop-other-extension
 ```
 
 Now you can run `rubocop` and it will automatically load the RuboCop Sorbet cops together with the standard cops.
 
+> [!NOTE]
+> The plugin system is supported in RuboCop 1.72+. In earlier versions, use `require` instead of `plugins`.
+
 ### Command line
 
 ```sh
-rubocop --require rubocop-sorbet
+rubocop --plugin rubocop-sorbet
 ```
 
 ### Rake task
 
 ```ruby
 RuboCop::RakeTask.new do |task|
-  task.requires << 'rubocop-sorbet'
+  task.plugins << 'rubocop-sorbet'
 end
 ```
 

data/config/default.yml

@@ -1,5 +1,5 @@
 Sorbet/Refinement:
-  Description: >- 
+  Description: >-
                   Checks for the use of Ruby Refinements library. Refinements add
                   complexity and incur a performance penalty that can be significant
                   for large code bases. They are also not supported by Sorbet.
@@ -102,6 +102,21 @@ Sorbet/ForbidTypeAliasedShapes:
   Enabled: false
   VersionAdded: 0.7.6
 
+Sorbet/ForbidSig:
+  Description: 'Forbid usage of sig'
+  Enabled: false
+  VersionAdded: <<next>>
+
+Sorbet/ForbidSigWithRuntime:
+  Description: 'Forbid usage of T::Sig.sig'
+  Enabled: false
+  VersionAdded: <<next>>
+
+Sorbet/ForbidSigWithoutRuntime:
+  Description: 'Forbid usage of T::Sig::WithoutRuntime.sig'
+  Enabled: false
+  VersionAdded: <<next>>
+
 Sorbet/ForbidSuperclassConstLiteral:
   Description: 'Forbid superclasses which are non-literal constants.'
   Enabled: false

data/config/rbi.yml

@@ -199,6 +199,9 @@ Lint/Syntax:
 
 ## Sorbet
 
+Sorbet/ForbidSigWithoutRuntime:
+  Enabled: true
+
 Sorbet/EnforceSigilOrder:
   Enabled: true
 

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

@@ -41,6 +41,7 @@ module RuboCop
           :constantize,
           :constants,
           :const_get,
+          :safe_constantize,
         ].freeze
 
         def on_send(node)

data/lib/rubocop/cop/sorbet/mixin/signature_help.rb

@@ -9,21 +9,34 @@ module RuboCop
 
         # @!method signature?(node)
         def_node_matcher(:signature?, <<~PATTERN)
+          {#bare_sig? #sig_with_runtime? #sig_without_runtime?}
+        PATTERN
+
+        # @!method bare_sig?(node)
+        def_node_matcher(:bare_sig?, <<~PATTERN)
           (block (send
-            {nil? #with_runtime? #without_runtime?}
+            nil?
             :sig
             (sym :final)?
           ) (args) ...)
         PATTERN
 
-        # @!method with_runtime?(node)
-        def_node_matcher(:with_runtime?, <<~PATTERN)
-          (const (const {nil? cbase} :T) :Sig)
+        # @!method sig_with_runtime?(node)
+        def_node_matcher(:sig_with_runtime?, <<~PATTERN)
+          (block (send
+            (const (const {nil? cbase} :T) :Sig)
+            :sig
+            (sym :final)?
+          ) (args) ...)
         PATTERN
 
-        # @!method without_runtime?(node)
-        def_node_matcher(:without_runtime?, <<~PATTERN)
-          (const (const (const {nil? cbase} :T) :Sig) :WithoutRuntime)
+        # @!method sig_without_runtime?(node)
+        def_node_matcher(:sig_without_runtime?, <<~PATTERN)
+          (block (send
+            (const (const (const {nil? cbase} :T) :Sig) :WithoutRuntime)
+            :sig
+            (sym :final)?
+          ) (args) ...)
         PATTERN
 
         def on_block(node)

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

@@ -28,6 +28,8 @@ module RuboCop
         extend AutoCorrector
         include SignatureHelp
 
+        RBS_COMMENT_REGEX = /^#:.*$/
+
         def initialize(config = nil, options = nil)
           super(config, options)
           @last_sig_for_scope = {}
@@ -65,7 +67,7 @@ module RuboCop
 
         def check_node(node)
           scope = self.scope(node)
-          unless @last_sig_for_scope[scope]
+          unless @last_sig_for_scope[scope] || has_rbs_comment?(node)
             add_offense(
               node,
               message: "Each method is required to have a signature.",
@@ -76,6 +78,22 @@ module RuboCop
           @last_sig_for_scope[scope] = nil
         end
 
+        def has_rbs_comment?(node)
+          return false unless cop_config["AllowRBS"] == true
+
+          node = node.parent while RuboCop::AST::SendNode === node.parent
+          return false if (comments = preceeding_comments(node)).empty?
+
+          last_comment = comments.last
+          return false if last_comment.loc.line + 1 < node.loc.line
+
+          comments.any? { |comment| RBS_COMMENT_REGEX.match?(comment.text) }
+        end
+
+        def preceeding_comments(node)
+          processed_source.ast_with_comments[node].select { |comment| comment.loc.line < node.loc.line }
+        end
+
         def autocorrect(corrector, node)
           suggest = SigSuggestion.new(node.loc.column, param_type_placeholder, return_type_placeholder)
 

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "stringio"
+
+module RuboCop
+  module Cop
+    module Sorbet
+      # Check that definitions do not use a `sig` block.
+      #
+      # Good:
+      #
+      # ```
+      # #: -> void
+      # def foo; end
+      # ```
+      #
+      # Bad:
+      #
+      # ```
+      # sig { void }
+      # def foo; end
+      # ```
+      class ForbidSig < ::RuboCop::Cop::Base
+        include SignatureHelp
+
+        MSG = "Do not use `T::Sig`."
+
+        def on_signature(node)
+          add_offense(node) if bare_sig?(node)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "stringio"
+
+module RuboCop
+  module Cop
+    module Sorbet
+      # Check that definitions do not use a `sig` block.
+      #
+      # Good:
+      #
+      # ```
+      # #: -> void
+      # def foo; end
+      # ```
+      #
+      # Bad:
+      #
+      # ```
+      # T::Sig.sig { void }
+      # def foo; end
+      # ```
+      class ForbidSigWithRuntime < ::RuboCop::Cop::Base
+        include SignatureHelp
+
+        MSG = "Do not use `T::Sig.sig`."
+
+        def on_signature(node)
+          add_offense(node) if sig_with_runtime?(node)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "stringio"
+
+module RuboCop
+  module Cop
+    module Sorbet
+      # Check that `sig` is used instead of `T::Sig::WithoutRuntime.sig`.
+      #
+      # Good:
+      #
+      # ```
+      # sig { void }
+      # def foo; end
+      # ```
+      #
+      # Bad:
+      #
+      # ```
+      # T::Sig::WithoutRuntime.sig { void }
+      # def foo; end
+      # ```
+      class ForbidSigWithoutRuntime < ::RuboCop::Cop::Base
+        include SignatureHelp
+        extend AutoCorrector
+
+        MSG = "Do not use `T::Sig::WithoutRuntime.sig`."
+
+        def on_signature(node)
+          return unless sig_without_runtime?(node)
+
+          sig = node.children[0]
+          add_offense(sig) do |corrector|
+            corrector.replace(sig, sig.source.gsub(/T\s*::\s*Sig\s*::\s*WithoutRuntime\s*\.\s*/m, ""))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/sorbet_cops.rb

@@ -31,11 +31,14 @@ require_relative "sorbet/rbi_versioning/valid_gem_version_annotations"
 
 require_relative "sorbet/signatures/allow_incompatible_override"
 require_relative "sorbet/signatures/checked_true_in_signature"
-require_relative "sorbet/signatures/void_checked_tests"
+require_relative "sorbet/signatures/empty_line_after_sig"
+require_relative "sorbet/signatures/enforce_signatures"
+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/signature_build_order"
-require_relative "sorbet/signatures/enforce_signatures"
-require_relative "sorbet/signatures/empty_line_after_sig"
+require_relative "sorbet/signatures/void_checked_tests"
 
 require_relative "sorbet/sigils/valid_sigil"
 require_relative "sorbet/sigils/has_sigil"

data/lib/rubocop/sorbet/plugin.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "rubocop"
+require "lint_roller"
+require "pathname"
+
+module RuboCop
+  module Sorbet
+    # A plugin that integrates RuboCop Sorbet with RuboCop's plugin system.
+    class Plugin < LintRoller::Plugin
+      RUBOCOP_MIN_VERSION = "1.72.1"
+      SUPPORTED = Gem::Version.create(RuboCop::Version.version) < RUBOCOP_MIN_VERSION
+
+      def about
+        LintRoller::About.new(
+          name: "rubocop-sorbet",
+          version: VERSION,
+          homepage: "https://github.com/Shopify/rubocop-sorbet",
+          description: "A collection of Rubocop rules for Sorbet.",
+        )
+      end
+
+      def supported?(context)
+        context.engine == :rubocop
+      end
+
+      def rules(_context)
+        project_root = Pathname.new(__dir__).join("../../..")
+
+        ConfigObsoletion.files << project_root.join("config", "obsoletion.yml")
+
+        LintRoller::Rules.new(type: :path, config_format: :rubocop, value: project_root.join("config", "default.yml"))
+      end
+    end
+  end
+end

data/lib/rubocop/sorbet/version.rb

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

data/lib/rubocop/sorbet.rb

@@ -1,18 +1,23 @@
 # frozen_string_literal: true
 
+require "rubocop"
 require "rubocop/sorbet/version"
+require "rubocop/sorbet/plugin"
+require "pathname"
 require "yaml"
 
 module RuboCop
   module Sorbet
     class Error < StandardError; end
 
-    PROJECT_ROOT   = Pathname.new(__dir__).parent.parent.expand_path.freeze
-    CONFIG_DEFAULT = PROJECT_ROOT.join("config", "default.yml").freeze
-    CONFIG         = YAML.safe_load(CONFIG_DEFAULT.read).freeze
+    unless Plugin::SUPPORTED
+      PROJECT_ROOT   = Pathname.new(__dir__).parent.parent.expand_path.freeze
+      CONFIG_DEFAULT = PROJECT_ROOT.join("config", "default.yml").freeze
+      CONFIG         = YAML.safe_load(CONFIG_DEFAULT.read).freeze
 
-    private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
+      private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
 
-    ::RuboCop::ConfigObsoletion.files << PROJECT_ROOT.join("config", "obsoletion.yml")
+      ::RuboCop::ConfigObsoletion.files << PROJECT_ROOT.join("config", "obsoletion.yml")
+    end
   end
 end

data/lib/rubocop-sorbet.rb

@@ -4,8 +4,11 @@ require "rubocop"
 
 require_relative "rubocop/sorbet"
 require_relative "rubocop/sorbet/version"
-require_relative "rubocop/sorbet/inject"
+require_relative "rubocop/sorbet/plugin"
 
-RuboCop::Sorbet::Inject.defaults!
+unless RuboCop::Sorbet::Plugin::SUPPORTED
+  require_relative "rubocop/sorbet/inject"
+  RuboCop::Sorbet::Inject.defaults!
+end
 
 require_relative "rubocop/cop/sorbet_cops"

data/manual/cops.md

@@ -20,6 +20,9 @@ In the following section you find all available cops:
 * [Sorbet/ForbidExtendTSigHelpersInShims](cops_sorbet.md#sorbetforbidextendtsighelpersinshims)
 * [Sorbet/ForbidIncludeConstLiteral](cops_sorbet.md#sorbetforbidincludeconstliteral)
 * [Sorbet/ForbidRBIOutsideOfAllowedPaths](cops_sorbet.md#sorbetforbidrbioutsideofallowedpaths)
+* [Sorbet/ForbidSig](cops_sorbet.md#sorbetforbidsig)
+* [Sorbet/ForbidSigWithRuntime](cops_sorbet.md#sorbetforbidsigwithruntime)
+* [Sorbet/ForbidSigWithoutRuntime](cops_sorbet.md#sorbetforbidsigwithoutruntime)
 * [Sorbet/ForbidSuperclassConstLiteral](cops_sorbet.md#sorbetforbidsuperclassconstliteral)
 * [Sorbet/ForbidTEnum](cops_sorbet.md#sorbetforbidtenum)
 * [Sorbet/ForbidTStruct](cops_sorbet.md#sorbetforbidtstruct)

data/manual/cops_sorbet.md

@@ -417,6 +417,72 @@ Name | Default value | Configurable values
 AllowedPaths | `rbi/**`, `sorbet/rbi/**` | Array
 Include | `**/*.rbi` | Array
 
+## Sorbet/ForbidSig
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+--- | --- | --- | --- | ---
+Disabled | Yes | No | <<next>> | -
+
+Check that definitions do not use a `sig` block.
+
+Good:
+
+```
+#: -> void
+def foo; end
+```
+
+Bad:
+
+```
+sig { void }
+def foo; end
+```
+
+## Sorbet/ForbidSigWithRuntime
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+--- | --- | --- | --- | ---
+Disabled | Yes | No | <<next>> | -
+
+Check that definitions do not use a `sig` block.
+
+Good:
+
+```
+#: -> void
+def foo; end
+```
+
+Bad:
+
+```
+T::Sig.sig { void }
+def foo; end
+```
+
+## Sorbet/ForbidSigWithoutRuntime
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+--- | --- | --- | --- | ---
+Disabled | Yes | Yes  | <<next>> | -
+
+Check that `sig` is used instead of `T::Sig::WithoutRuntime.sig`.
+
+Good:
+
+```
+sig { void }
+def foo; end
+```
+
+Bad:
+
+```
+T::Sig::WithoutRuntime.sig { void }
+def foo; end
+```
+
 ## Sorbet/ForbidSuperclassConstLiteral
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged

data/rubocop-sorbet.gemspec

@@ -17,6 +17,7 @@ Gem::Specification.new do |spec|
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/shopify/rubocop-sorbet"
+  spec.metadata["default_lint_roller_plugin"] = "RuboCop::Sorbet::Plugin"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -27,5 +28,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_runtime_dependency("lint_roller", "~> 1.1")
   spec.add_runtime_dependency("rubocop", ">= 1")
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-sorbet
 version: !ruby/object:Gem::Version
-  version: 0.8.9
+  version: 0.9.0
 platform: ruby
 authors:
 - Ufuk Kayserilioglu
@@ -10,8 +10,22 @@ authors:
 - Peter Zhu
 bindir: exe
 cert_chain: []
-date: 2025-02-20 00:00:00.000000000 Z
+date: 2025-03-10 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
@@ -98,6 +112,9 @@ files:
 - lib/rubocop/cop/sorbet/signatures/checked_true_in_signature.rb
 - lib/rubocop/cop/sorbet/signatures/empty_line_after_sig.rb
 - lib/rubocop/cop/sorbet/signatures/enforce_signatures.rb
+- lib/rubocop/cop/sorbet/signatures/forbid_sig.rb
+- 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/signature_build_order.rb
 - lib/rubocop/cop/sorbet/signatures/void_checked_tests.rb
@@ -107,6 +124,7 @@ files:
 - lib/rubocop/cop/sorbet_cops.rb
 - lib/rubocop/sorbet.rb
 - lib/rubocop/sorbet/inject.rb
+- lib/rubocop/sorbet/plugin.rb
 - lib/rubocop/sorbet/version.rb
 - manual/cops.md
 - manual/cops_sorbet.md
@@ -121,6 +139,7 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/shopify/rubocop-sorbet
   source_code_uri: https://github.com/shopify/rubocop-sorbet
+  default_lint_roller_plugin: RuboCop::Sorbet::Plugin
 rdoc_options: []
 require_paths:
 - lib
@@ -135,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.3
+rubygems_version: 3.6.5
 specification_version: 4
 summary: Automatic Sorbet code style checking tool.
 test_files: []