rubocop-sorbet 0.8.3 → 0.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aaaf459633c48aa90d90f4ed3e0a24a5d1692b992be907850135b38a71c29730
-  data.tar.gz: cbcdf3988bb27fcce914a7ed5e94e50ab4d0924a3730851aa4b2c8965695c159
+  metadata.gz: 9cb17e31fa88a9bf6693e1bbdad97425f25920b8293782b2dbf3642df2b3138d
+  data.tar.gz: 1a7cc0e93155410faf2f7e9f431b7a182e72b081217774796ff63515a1b2bbc4
 SHA512:
-  metadata.gz: b90e1a014923517f5d59bd129c40a74fe1675b23e140550211daeeb94188f5c9143df53c77ed529845d45ff072f429db90ba3312bb0ce7201461849355fbe212
-  data.tar.gz: 744f09646e590c363a172414501d695b8fae04c3357fe0e90301f55e9c8110fa87ff0278515ab6c58b4cc5355ac969264065dc93e67e06f171c0be8aa3cc7067
+  metadata.gz: 694a6aeff04a8c14a8a511f0f44ffc6abb0035fbbedc9a9e0bdaeeef3ba97d5a360cdc8141048f502f663475743441d8537f7f27c4c2cae78b40cb8d050e8375
+  data.tar.gz: 8781a983e0e0e97a3535943c9ffe76beab985cc5643832b9b138590d3585220dddba6ec3fcdbe6d2ea58152a6349d6fb28c418d7874a7b53b271190120d7bf93

data/.github/dependabot.yml

@@ -4,6 +4,7 @@ updates:
     directory: "/"
     schedule:
       interval: "weekly"
+    open-pull-requests-limit: 100
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:

data/.github/workflows/ci.yml

@@ -11,7 +11,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ["3.0", "3.1", "3.2", "3.3"]
+        ruby: ["3.1", "3.2", "3.3"]
     name: Test Ruby ${{ matrix.ruby }}
     steps:
       - uses: actions/checkout@v4
@@ -33,8 +33,13 @@ jobs:
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.2
           bundler-cache: true
+      # This is just to ensure the default config is valid. The target is intentionally set
+      # to a directory that doesn't contain any .rb or .rbi files.
+      - name: Validate default config
+        run: |
+          bin/rubocop --config config/rbi.yml config
+          bin/rubocop --config config/default.yml config -r rubocop-sorbet
       - name: Lint Ruby files
         run: bin/rubocop
       - name: Verify documentation is up to date

data/.ruby-version

@@ -1 +1 @@
-3.2.0
+3.3.3

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    rubocop-sorbet (0.8.3)
-      rubocop (>= 0.90.0)
+    rubocop-sorbet (0.8.4)
+      rubocop (>= 1)
 
 GEM
   remote: https://rubygems.org/
@@ -18,21 +18,22 @@ GEM
       reline (>= 0.4.2)
     json (2.7.2)
     language_server-protocol (3.17.0.3)
-    parallel (1.24.0)
-    parser (3.3.0.5)
+    parallel (1.25.1)
+    parser (3.3.4.0)
       ast (~> 2.4.1)
       racc
     psych (5.1.2)
       stringio
-    racc (1.7.3)
+    racc (1.8.0)
     rainbow (3.1.1)
     rake (13.2.1)
     rdoc (6.6.3.1)
       psych (>= 4.0.0)
-    regexp_parser (2.9.0)
+    regexp_parser (2.9.2)
     reline (0.5.1)
       io-console (~> 0.5)
-    rexml (3.2.6)
+    rexml (3.3.1)
+      strscan
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
@@ -46,23 +47,24 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.1)
-    rubocop (1.63.2)
+    rubocop (1.65.0)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
+      regexp_parser (>= 2.4, < 3.0)
       rexml (>= 3.2.5, < 4.0)
       rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.31.2)
-      parser (>= 3.3.0.4)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
     rubocop-shopify (2.15.1)
       rubocop (~> 1.51)
     ruby-progressbar (1.13.0)
     stringio (3.1.0)
+    strscan (3.1.0)
     unicode-display_width (2.5.0)
     yard (0.9.36)
 

data/lib/rubocop/cop/sorbet/rbi/forbid_rbi_outside_of_allowed_paths.rb

@@ -20,23 +20,21 @@ module RuboCop
       #   # rbi/external_interface.rbi
       #   # sorbet/rbi/some_file.rbi
       #   # sorbet/rbi/any/path/for/file.rbi
-      class ForbidRBIOutsideOfAllowedPaths < RuboCop::Cop::Cop # rubocop:todo InternalAffairs/InheritDeprecatedCopClass
+      class ForbidRBIOutsideOfAllowedPaths < RuboCop::Cop::Base
         include RangeHelp
 
-        def investigate(processed_source)
+        def on_new_investigation
           paths = allowed_paths
 
           if paths.nil?
             add_offense(
-              nil,
-              location: source_range(processed_source.buffer, 1, 0),
+              source_range(processed_source.buffer, 1, 0),
               message: "AllowedPaths expects an array",
             )
             return
           elsif paths.empty?
             add_offense(
-              nil,
-              location: source_range(processed_source.buffer, 1, 0),
+              source_range(processed_source.buffer, 1, 0),
               message: "AllowedPaths cannot be empty",
             )
             return
@@ -47,8 +45,7 @@ module RuboCop
           rel_path = processed_source.file_path.sub("#{Dir.pwd}/", "")
 
           add_offense(
-            nil,
-            location: source_range(processed_source.buffer, 1, 0),
+            source_range(processed_source.buffer, 1, 0),
             message: "RBI file path should match one of: #{paths.join(", ")}",
           ) if paths.none? { |pattern| File.fnmatch(pattern, rel_path) }
         end

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

@@ -5,10 +5,12 @@ require "rubocop"
 module RuboCop
   module Cop
     module Sorbet
-      # Checks that the Sorbet sigil comes as the first magic comment in the file.
+      # Checks that the Sorbet sigil comes as the first magic comment in the file, after the encoding comment if any.
       #
       # The expected order for magic comments is: (en)?coding, typed, warn_indent then frozen_string_literal.
       #
+      # The ordering is for consistency only, except for the encoding comment which must be first, if present.
+      #
       # For example, the following bad ordering:
       #
       # ```ruby
@@ -30,7 +32,7 @@ module RuboCop
       class EnforceSigilOrder < ValidSigil
         include RangeHelp
 
-        def investigate(processed_source)
+        def on_new_investigation
           return if processed_source.tokens.empty?
 
           tokens = extract_magic_comments(processed_source)
@@ -39,30 +41,6 @@ module RuboCop
           check_magic_comments_order(tokens)
         end
 
-        def autocorrect(_node)
-          lambda do |corrector|
-            tokens = extract_magic_comments(processed_source)
-
-            # Get the magic comments tokens in their expected order
-            expected = PREFERRED_ORDER.keys.map do |re|
-              tokens.select { |token| re.match?(token.text) }
-            end.flatten
-
-            tokens.each_with_index do |token, index|
-              corrector.replace(token.pos, expected[index].text)
-            end
-
-            # Remove blank lines between the magic comments
-            lines = tokens.map(&:line).to_set
-            (lines.min...lines.max).each do |line|
-              next if lines.include?(line)
-              next unless processed_source[line - 1].empty?
-
-              corrector.remove(source_range(processed_source.buffer, line, 0))
-            end
-          end
-        end
-
         protected
 
         CODING_REGEX = /#\s+(en)?coding:(?:\s+([\w]+))?/
@@ -103,13 +81,36 @@ module RuboCop
           if order != expected
             tokens.each do |token|
               add_offense(
-                token,
-                location: token.pos,
+                token.pos,
                 message: "Magic comments should be in the following order: #{PREFERRED_ORDER.values.join(", ")}.",
-              )
+              ) do |corrector|
+                autocorrect(corrector)
+              end
             end
           end
         end
+
+        def autocorrect(corrector)
+          tokens = extract_magic_comments(processed_source)
+
+          # Get the magic comments tokens in their expected order
+          expected = PREFERRED_ORDER.keys.map do |re|
+            tokens.select { |token| re.match?(token.text) }
+          end.flatten
+
+          tokens.each_with_index do |token, index|
+            corrector.replace(token.pos, expected[index].text)
+          end
+
+          # Remove blank lines between the magic comments
+          lines = tokens.map(&:line).to_set
+          (lines.min...lines.max).each do |line|
+            next if lines.include?(line)
+            next unless processed_source[line - 1].empty?
+
+            corrector.remove(source_range(processed_source.buffer, line, 0))
+          end
+        end
       end
     end
   end

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

@@ -26,27 +26,15 @@ module RuboCop
       class EnforceSingleSigil < ValidSigil
         include RangeHelp
 
-        def investigate(processed_source)
+        def on_new_investigation
           return if processed_source.tokens.empty?
 
           sigils = extract_all_sigils(processed_source)
           return if sigils.empty?
 
           sigils[1..sigils.size].each do |token|
-            add_offense(token, location: token.pos, message: "Files must only contain one sigil")
-          end
-        end
-
-        def autocorrect(_node)
-          ->(corrector) do
-            sigils = extract_all_sigils(processed_source)
-            return if sigils.empty?
-
-            # The first sigil encountered represents the "real" strictness so remove any below
-            sigils[1..sigils.size].each do |token|
-              corrector.remove(
-                source_range(processed_source.buffer, token.line, (0..token.pos.last_column)),
-              )
+            add_offense(token.pos, message: "Files must only contain one sigil") do |corrector|
+              autocorrect(corrector)
             end
           end
         end
@@ -58,6 +46,18 @@ module RuboCop
             .take_while { |token| token.type == :tCOMMENT }
             .find_all { |token| SIGIL_REGEX.match?(token.text) }
         end
+
+        def autocorrect(corrector)
+          sigils = extract_all_sigils(processed_source)
+          return if sigils.empty?
+
+          # The first sigil encountered represents the "real" strictness so remove any below
+          sigils[1..sigils.size].each do |token|
+            corrector.remove(
+              source_range(processed_source.buffer, token.line, (0..token.pos.last_column)),
+            )
+          end
+        end
       end
     end
   end

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

@@ -15,8 +15,6 @@ module RuboCop
       #
       # If a `MinimumStrictness` level is specified, it will be used in offense messages and autocorrect.
       class HasSigil < ValidSigil
-        @registry = Cop.registry # So we can properly subclass this cop
-
         def require_sigil_on_all_files?
           true
         end

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

@@ -17,10 +17,10 @@ module RuboCop
       #
       # If an `ExactStrictness` level is specified, it will be used in offense messages and autocorrect.
       # Otherwise, if a `MinimumStrictness` level is specified, it will be used in offense messages and autocorrect.
-      class ValidSigil < RuboCop::Cop::Cop # rubocop:todo InternalAffairs/InheritDeprecatedCopClass
-        @registry = Cop.registry # So we can properly subclass this cop
+      class ValidSigil < RuboCop::Cop::Base
+        extend AutoCorrector
 
-        def investigate(processed_source)
+        def on_new_investigation
           return if processed_source.tokens.empty?
 
           sigil = extract_sigil(processed_source)
@@ -33,22 +33,6 @@ module RuboCop
           nil unless check_strictness_level(sigil, strictness)
         end
 
-        def autocorrect(_node)
-          lambda do |corrector|
-            return unless require_sigil_on_all_files?
-            return unless extract_sigil(processed_source).nil?
-
-            token = processed_source.tokens.first
-            replace_with = suggested_strictness_level
-            sigil = "# typed: #{replace_with}"
-            if token.text.start_with?("#!") # shebang line
-              corrector.insert_after(token.pos, "\n#{sigil}")
-            else
-              corrector.insert_before(token.pos, "#{sigil}\n")
-            end
-          end
-        end
-
         protected
 
         STRICTNESS_LEVELS = ["ignore", "false", "true", "strict", "strong"]
@@ -75,11 +59,12 @@ module RuboCop
           if require_sigil_on_all_files?
             strictness = suggested_strictness_level
             add_offense(
-              token,
-              location: token.pos,
+              token.pos,
               message: "No Sorbet sigil found in file. " \
                 "Try a `typed: #{strictness}` to start (you can also use `rubocop -a` to automatically add this).",
-            )
+            ) do |corrector|
+              autocorrect(corrector)
+            end
           end
           false
         end
@@ -110,10 +95,11 @@ module RuboCop
           return true if strictness
 
           add_offense(
-            sigil,
-            location: sigil.pos,
+            sigil.pos,
             message: "Sorbet sigil should not be empty.",
-          )
+          ) do |corrector|
+            autocorrect(corrector)
+          end
           false
         end
 
@@ -121,10 +107,11 @@ module RuboCop
           return true if STRICTNESS_LEVELS.include?(strictness)
 
           add_offense(
-            sigil,
-            location: sigil.pos,
+            sigil.pos,
             message: "Invalid Sorbet sigil `#{strictness}`.",
-          )
+          ) do |corrector|
+            autocorrect(corrector)
+          end
           false
         end
 
@@ -137,20 +124,22 @@ module RuboCop
             exact_level = STRICTNESS_LEVELS.index(exact_strictness)
             if current_level != exact_level
               add_offense(
-                sigil,
-                location: sigil.pos,
+                sigil.pos,
                 message: "Sorbet sigil should be `#{exact_strictness}` got `#{strictness}`.",
-              )
+              ) do |corrector|
+                autocorrect(corrector)
+              end
               return false
             end
           else
             minimum_level = STRICTNESS_LEVELS.index(minimum_strictness)
             if current_level < minimum_level
               add_offense(
-                sigil,
-                location: sigil.pos,
+                sigil.pos,
                 message: "Sorbet sigil should be at least `#{minimum_strictness}` got `#{strictness}`.",
-              )
+              ) do |corrector|
+                autocorrect(corrector)
+              end
               return false
             end
           end
@@ -158,6 +147,20 @@ module RuboCop
           true
         end
 
+        def autocorrect(corrector)
+          return unless require_sigil_on_all_files?
+          return unless extract_sigil(processed_source).nil?
+
+          token = processed_source.tokens.first
+          replace_with = suggested_strictness_level
+          sigil = "# typed: #{replace_with}"
+          if token.text.start_with?("#!") # shebang line
+            corrector.insert_after(token.pos, "\n#{sigil}")
+          else
+            corrector.insert_before(token.pos, "#{sigil}\n")
+          end
+        end
+
         # options
 
         # Default is `false`

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

@@ -16,7 +16,7 @@ module RuboCop
       #
       #   # good
       #   sig { void }
-      class CheckedTrueInSignature < ::RuboCop::Cop::Cop # rubocop:todo InternalAffairs/InheritDeprecatedCopClass
+      class CheckedTrueInSignature < ::RuboCop::Cop::Base
         include(RuboCop::Cop::RangeHelp)
         include(RuboCop::Cop::Sorbet::SignatureHelp)
 
@@ -37,8 +37,7 @@ module RuboCop
           return unless error
 
           add_offense(
-            error,
-            location: source_range(
+            source_range(
               processed_source.buffer,
               error.location.line,
               (error.location.selector.begin_pos)..(error.location.end.begin_pos),

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

@@ -24,7 +24,8 @@ module RuboCop
       #
       # * `ParameterTypePlaceholder`: placeholders used for parameter types (default: 'T.untyped')
       # * `ReturnTypePlaceholder`: placeholders used for return types (default: 'T.untyped')
-      class EnforceSignatures < ::RuboCop::Cop::Cop # rubocop:todo InternalAffairs/InheritDeprecatedCopClass
+      class EnforceSignatures < ::RuboCop::Cop::Base
+        extend AutoCorrector
         include SignatureHelp
 
         def initialize(config = nil, options = nil)
@@ -53,25 +54,6 @@ module RuboCop
           @last_sig_for_scope[scope(node)] = node
         end
 
-        def autocorrect(node)
-          lambda do |corrector|
-            suggest = SigSuggestion.new(node.loc.column, param_type_placeholder, return_type_placeholder)
-
-            if node.is_a?(RuboCop::AST::DefNode) # def something
-              node.arguments.each do |arg|
-                suggest.params << arg.children.first
-              end
-            elsif accessor?(node) # attr reader, writer, accessor
-              method = node.children[1]
-              symbol = node.children[2]
-              suggest.params << symbol.value if symbol && (method == :attr_writer || method == :attr_accessor)
-              suggest.returns = "void" if method == :attr_writer
-            end
-
-            corrector.insert_before(node, suggest.to_autocorrect)
-          end
-        end
-
         def scope(node)
           return unless node.parent
           return node.parent if [:begin, :block, :class, :module].include?(node.parent.type)
@@ -87,11 +69,30 @@ module RuboCop
             add_offense(
               node,
               message: "Each method is required to have a signature.",
-            )
+            ) do |corrector|
+              autocorrect(corrector, node)
+            end
           end
           @last_sig_for_scope[scope] = nil
         end
 
+        def autocorrect(corrector, node)
+          suggest = SigSuggestion.new(node.loc.column, param_type_placeholder, return_type_placeholder)
+
+          if node.is_a?(RuboCop::AST::DefNode) # def something
+            node.arguments.each do |arg|
+              suggest.params << arg.children.first
+            end
+          elsif accessor?(node) # attr reader, writer, accessor
+            method = node.children[1]
+            symbol = node.children[2]
+            suggest.params << symbol.value if symbol && (method == :attr_writer || method == :attr_accessor)
+            suggest.returns = "void" if method == :attr_writer
+          end
+
+          corrector.insert_before(node, suggest.to_autocorrect)
+        end
+
         def param_type_placeholder
           cop_config["ParameterTypePlaceholder"] || "T.untyped"
         end

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

@@ -17,7 +17,7 @@ module RuboCop
       #   # good
       #   sig { params(b: String, a: Integer).void }
       #   def foo(b:, a: 1); end
-      class KeywordArgumentOrdering < ::RuboCop::Cop::Cop # rubocop:todo InternalAffairs/InheritDeprecatedCopClass
+      class KeywordArgumentOrdering < ::RuboCop::Cop::Base
         include SignatureHelp
 
         def on_signature(node)

data/lib/rubocop/sorbet/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Sorbet
-    VERSION = "0.8.3"
+    VERSION = "0.8.4"
   end
 end

data/manual/cops_sorbet.md

@@ -203,10 +203,12 @@ Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChan
 --- | --- | --- | --- | ---
 Enabled | Yes | Yes  | 0.3.4 | -
 
-Checks that the Sorbet sigil comes as the first magic comment in the file.
+Checks that the Sorbet sigil comes as the first magic comment in the file, after the encoding comment if any.
 
 The expected order for magic comments is: (en)?coding, typed, warn_indent then frozen_string_literal.
 
+The ordering is for consistency only, except for the encoding comment which must be first, if present.
+
 For example, the following bad ordering:
 
 ```ruby

data/rubocop-sorbet.gemspec

@@ -27,5 +27,5 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency("rubocop", ">= 0.90.0")
+  spec.add_runtime_dependency("rubocop", ">= 1")
 end

data/tasks/cops_documentation.rake

@@ -278,7 +278,7 @@ task generate_cops_documentation: :yard_for_generate_documentation do
   end
 
   def main
-    cops   = RuboCop::Cop::Cop.registry
+    cops   = RuboCop::Cop::Registry.global
     config = RuboCop::ConfigLoader.load_file("config/default.yml")
 
     YARD::Registry.load!
@@ -302,7 +302,7 @@ task documentation_syntax_check: :yard_for_generate_documentation do
 
   ok = true
   YARD::Registry.load!
-  cops = RuboCop::Cop::Cop.registry
+  cops = RuboCop::Cop::Registry.global
   cops.each do |cop|
     examples = YARD::Registry.all(:class).find do |code_object|
       next unless RuboCop::Cop::Badge.for(code_object.to_s) == cop.badge

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-sorbet
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.8.4
 platform: ruby
 authors:
 - Ufuk Kayserilioglu
 - Alan Wu
 - Alexandre Terrasa
 - Peter Zhu
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-29 00:00:00.000000000 Z
+date: 2024-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -19,15 +19,15 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.90.0
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.90.0
-description: 
+        version: '1'
+description:
 email:
 - ruby@shopify.com
 executables: []
@@ -118,7 +118,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
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -133,8 +133,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
-signing_key: 
+rubygems_version: 3.5.15
+signing_key:
 specification_version: 4
 summary: Automatic Sorbet code style checking tool.
 test_files: []