rubocop-sorbet 0.8.4 → 0.8.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cb17e31fa88a9bf6693e1bbdad97425f25920b8293782b2dbf3642df2b3138d
-  data.tar.gz: 1a7cc0e93155410faf2f7e9f431b7a182e72b081217774796ff63515a1b2bbc4
+  metadata.gz: 5eabd8cb864c16962c3d9f7ca1cb64bd9a811424bc480df6f976f28c2741eb97
+  data.tar.gz: c25050b4162e19a06c525e7e008a79ed8ffd1217c24e57cd03e4af88f4194abf
 SHA512:
-  metadata.gz: 694a6aeff04a8c14a8a511f0f44ffc6abb0035fbbedc9a9e0bdaeeef3ba97d5a360cdc8141048f502f663475743441d8537f7f27c4c2cae78b40cb8d050e8375
-  data.tar.gz: 8781a983e0e0e97a3535943c9ffe76beab985cc5643832b9b138590d3585220dddba6ec3fcdbe6d2ea58152a6349d6fb28c418d7874a7b53b271190120d7bf93
+  metadata.gz: 2cbc0786d76687e380eb8252a580bbfa06fb893d0b283ca7a04516f85f77ccec4ec39d5d6eaecdda31fc1cc5ffa0a2d9b3b6f3357dd1a9a4bd83aa1f0265d617
+  data.tar.gz: a22169eca15cf38a85cbf234c73cf26aed164460af125ed15978feab77cc7fdf2555b5f71037ba4a5c938e3861d0bee6d8141bfe5ee30a37bcf3fa71bcc37fd7

data/.github/dependabot.yml

@@ -5,6 +5,11 @@ updates:
     schedule:
       interval: "weekly"
     open-pull-requests-limit: 100
+    groups:
+      minor-and-patch:
+        update-types:
+          - "minor"
+          - "patch"
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:

data/.github/workflows/dependabot_automerge.yml

@@ -0,0 +1,65 @@
+name: Dependabot auto-merge
+on: pull_request_target
+
+permissions:
+  pull-requests: write
+  contents: write
+
+jobs:
+  dependabot:
+    runs-on: ubuntu-latest
+    if: ${{ github.event.pull_request.user.login == 'dependabot[bot]' }}
+    steps:
+      - name: Dependabot metadata
+        id: metadata
+        uses: dependabot/fetch-metadata@v2
+        with:
+          github-token: "${{ secrets.GITHUB_TOKEN }}"
+      - name: Enable auto-merge for Dependabot PRs
+        if: ${{ steps.metadata.outputs.update-type != 'version-update:semver-major' }}
+        uses: actions/github-script@v7
+        with:
+          github-token: "${{ secrets.GITHUB_TOKEN }}"
+          script: |
+            const getPullRequestIdQuery = `query GetPullRequestId($owner: String!, $repo: String!, $pullRequestNumber: Int!) {
+              repository(owner: $owner, name: $repo) {
+                pullRequest(number: $pullRequestNumber) {
+                  id
+                }
+              }
+            }`
+            const repoInfo = {
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              pullRequestNumber: context.issue.number,
+            }
+            const response = await github.graphql(getPullRequestIdQuery, repoInfo)
+
+            await github.rest.pulls.createReview({
+              pull_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              event: 'APPROVE',
+            })
+
+            const enableAutoMergeQuery = `mutation ($pullRequestId: ID!, $mergeMethod: PullRequestMergeMethod!) {
+              enablePullRequestAutoMerge(input: {
+                pullRequestId: $pullRequestId,
+                mergeMethod: $mergeMethod
+              }) {
+                pullRequest {
+                  autoMergeRequest {
+                    enabledAt
+                    enabledBy {
+                      login
+                    }
+                  }
+                }
+              }
+            }`
+            const data = {
+              pullRequestId: response.repository.pullRequest.id,
+              mergeMethod: 'MERGE',
+            }
+
+            await github.graphql(enableAutoMergeQuery, data)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop-sorbet (0.8.4)
+    rubocop-sorbet (0.8.6)
       rubocop (>= 1)
 
 GEM
@@ -18,13 +18,13 @@ GEM
       reline (>= 0.4.2)
     json (2.7.2)
     language_server-protocol (3.17.0.3)
-    parallel (1.25.1)
-    parser (3.3.4.0)
+    parallel (1.26.3)
+    parser (3.3.5.0)
       ast (~> 2.4.1)
       racc
     psych (5.1.2)
       stringio
-    racc (1.8.0)
+    racc (1.8.1)
     rainbow (3.1.1)
     rake (13.2.1)
     rdoc (6.6.3.1)
@@ -32,8 +32,6 @@ GEM
     regexp_parser (2.9.2)
     reline (0.5.1)
       io-console (~> 0.5)
-    rexml (3.3.1)
-      strscan
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
@@ -47,26 +45,24 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.1)
-    rubocop (1.65.0)
+    rubocop (1.66.1)
       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 (>= 2.4, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
+      rubocop-ast (>= 1.32.2, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.31.3)
+    rubocop-ast (1.32.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)
+    yard (0.9.37)
 
 PLATFORMS
   ruby

data/config/default.yml

@@ -1,3 +1,11 @@
+Sorbet/Refinement:
+  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.
+  Enabled: pending
+  VersionAdded: '<<next>>'
+
 inherit_mode:
   merge:
   - Exclude

data/config/rbi.yml

@@ -169,9 +169,15 @@ Layout/SpaceBeforeFirstArg:
 Layout/SpaceBeforeSemicolon:
   Enabled: true
 
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+
 Layout/SpaceInsideParens:
   Enabled: true
 
+Layout/SpaceInsideReferenceBrackets:
+  Enabled: true
+
 Layout/TrailingEmptyLines:
   Enabled: true
   EnforcedStyle: final_newline
@@ -220,6 +226,16 @@ Sorbet/SingleLineRbiClassModuleDefinitions:
 Sorbet/TypeAliasName:
   Enabled: true
 
+Sorbet/ValidGemVersionAnnotations:
+  Description: >-
+                  Ensures all gem version annotations in RBI files are correctly formatted per
+                  Ruby's gem version specification guidelines.
+
+                  See the rubygems.org documentation for more information on how to format gem
+                  versions: https://guides.rubygems.org/patterns/#pessimistic-version-constraint
+  Enabled: false
+  VersionAdded: 0.8.5
+
 Sorbet/ValidSigil:
   Enabled: true
   RequireSigilOnAllFiles: true

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

@@ -46,6 +46,7 @@ module RuboCop
         def on_send(node)
           add_offense(node.selector, message: format(MSG, method_name: node.method_name))
         end
+        alias_method :on_csend, :on_send
       end
     end
   end

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

@@ -44,7 +44,7 @@ module RuboCop
         def read_sorbet_static_version_from_bundler_lock_file
           require "bundler"
           ::Bundler.locked_gems.specs.find { |spec| spec.name == "sorbet-static" }&.version
-        rescue LoadError, Bundler::GemfileNotFound
+        rescue LoadError, ::Bundler::GemfileNotFound
           nil
         end
       end

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

@@ -27,16 +27,10 @@ module RuboCop
           paths = allowed_paths
 
           if paths.nil?
-            add_offense(
-              source_range(processed_source.buffer, 1, 0),
-              message: "AllowedPaths expects an array",
-            )
+            add_global_offense("AllowedPaths expects an array")
             return
           elsif paths.empty?
-            add_offense(
-              source_range(processed_source.buffer, 1, 0),
-              message: "AllowedPaths cannot be empty",
-            )
+            add_global_offense("AllowedPaths cannot be empty")
             return
           end
 
@@ -44,9 +38,8 @@ module RuboCop
           # We need to remove the exec path directory prefix before matching with the filename regular expressions.
           rel_path = processed_source.file_path.sub("#{Dir.pwd}/", "")
 
-          add_offense(
-            source_range(processed_source.buffer, 1, 0),
-            message: "RBI file path should match one of: #{paths.join(", ")}",
+          add_global_offense(
+            "RBI file path should match one of: #{paths.join(", ")}",
           ) if paths.none? { |pattern| File.fnmatch(pattern, rel_path) }
         end
 

data/lib/rubocop/cop/sorbet/rbi_versioning/gem_version_annotation_helper.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Sorbet
+      module GemVersionAnnotationHelper
+        VERSION_PREFIX = "# @version"
+
+        def gem_version_annotations
+          processed_source.comments.select do |comment|
+            gem_version_annotation?(comment)
+          end
+        end
+
+        private
+
+        def gem_version_annotation?(comment)
+          comment.text.start_with?(VERSION_PREFIX)
+        end
+
+        def gem_versions(comment)
+          comment.text.delete_prefix(VERSION_PREFIX).split(/, ?/).map(&:strip)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/sorbet/rbi_versioning/valid_gem_version_annotations.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Sorbet
+      # Checks that gem versions in RBI annotations are properly formatted per the Bundler gem specification.
+      #
+      # @example
+      #   # bad
+      #   # @version > not a version number
+      #
+      #   # good
+      #   # @version = 1
+      #
+      #   # good
+      #   # @version > 1.2.3
+      #
+      #   # good
+      #   # @version <= 4.3-preview
+      #
+      class ValidGemVersionAnnotations < RuboCop::Cop::Base
+        include GemVersionAnnotationHelper
+
+        MSG = "Invalid gem version(s) detected: %<versions>s"
+        VALID_OPERATORS = ["=", "!=", ">", ">=", "<", "<=", "~>"]
+
+        def on_new_investigation
+          gem_version_annotations.each do |comment|
+            gem_versions = gem_versions(comment)
+
+            if gem_versions.empty?
+              message = format(MSG, versions: "empty version")
+              add_offense(comment, message: message)
+              break
+            end
+
+            invalid_versions = gem_versions.reject do |version|
+              valid_version?(version)
+            end
+
+            unless invalid_versions.empty?
+              message = format(MSG, versions: invalid_versions.map(&:strip).join(", "))
+              add_offense(comment, message: message)
+            end
+          end
+        end
+
+        private
+
+        def valid_version?(version_string)
+          parts = version_string.strip.split(" ")
+          operator, version = parts
+
+          return false unless operator && parts
+          return false unless VALID_OPERATORS.include?(operator)
+
+          Gem::Version.correct?(version)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Sorbet
+      # Checks for the use of Ruby Refinements library. Refinements add
+      # complexity and incur a performance penalty that can be significant
+      # for large code bases. Good examples are cases of unrelated
+      # methods that happen to have the same name as these module methods.
+      #
+      # @example
+      #   # bad
+      #   module Foo
+      #     refine(Date) do
+      #     end
+      #   end
+      #
+      #   # bad
+      #   module Foo
+      #     using(Date) do
+      #     end
+      #   end
+      #
+      #   # good
+      #   module Foo
+      #     bar.refine(Date)
+      #   end
+      #
+      #   # good
+      #   module Foo
+      #     bar.using(Date)
+      #   end
+
+      class Refinement < Base
+        MSG = "Do not use Ruby Refinements library as it is not supported by Sorbet."
+        RESTRICT_ON_SEND = [:refine, :using].freeze
+
+        def on_send(node)
+          return unless node.receiver.nil?
+          return unless node.first_argument&.const_type?
+
+          if node.method?(:refine)
+            return unless node.block_node
+            return unless node.parent.parent.module_type?
+          end
+
+          add_offense(node)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/sorbet/t_enum/forbid_comparable_t_enum.rb

@@ -21,7 +21,7 @@ module RuboCop
       #      serialize <=> other.serialize
       #    end
       #  end
-      class ForbidComparableTEnum < Base
+      class ForbidComparableTEnum < RuboCop::Cop::Base
         include TEnum
 
         MSG = "Do not use `T::Enum` as a comparable object because of significant performance overhead."

data/lib/rubocop/cop/sorbet/t_enum/multiple_t_enum_values.rb

@@ -21,7 +21,7 @@ module RuboCop
       #      NotFound = new("The resource was not found.")
       #    end
       #  end
-      class MultipleTEnumValues < Base
+      class MultipleTEnumValues < RuboCop::Cop::Base
         include TEnum
 
         MSG = "`T::Enum` should have at least two values."

data/lib/rubocop/cop/sorbet_cops.rb

@@ -16,6 +16,7 @@ require_relative "sorbet/forbid_t_struct"
 require_relative "sorbet/forbid_t_unsafe"
 require_relative "sorbet/forbid_t_untyped"
 require_relative "sorbet/redundant_extend_t_sig"
+require_relative "sorbet/refinement"
 require_relative "sorbet/type_alias_name"
 require_relative "sorbet/obsolete_strict_memoization"
 require_relative "sorbet/buggy_obsolete_strict_memoization"
@@ -24,6 +25,9 @@ require_relative "sorbet/rbi/forbid_extend_t_sig_helpers_in_shims"
 require_relative "sorbet/rbi/forbid_rbi_outside_of_allowed_paths"
 require_relative "sorbet/rbi/single_line_rbi_class_module_definitions"
 
+require_relative "sorbet/rbi_versioning/gem_version_annotation_helper"
+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"

data/lib/rubocop/sorbet/inject.rb

@@ -11,6 +11,14 @@ module RuboCop
         def defaults!
           path = CONFIG_DEFAULT.to_s
           hash = ConfigLoader.send(:load_yaml_configuration, path)
+          if Gem::Version.new(RuboCop::Version::STRING) >= Gem::Version.new("1.66")
+            # We use markdown for cop documentation. Unconditionally setting
+            # the base url will produce incorrect urls on older RuboCop versions,
+            # so we do that for fully supported version only here.
+            hash["Sorbet"] ||= {}
+            hash["Sorbet"]["DocumentationBaseURL"] = "https://github.com/Shopify/rubocop-sorbet/blob/main/manual"
+            hash["Sorbet"]["DocumentationExtension"] = ".md"
+          end
           config = Config.new(hash, path).tap(&:make_excludes_absolute)
           puts "configuration from #{path}" if ConfigLoader.debug?
           config = ConfigLoader.merge_with_default(config, path)

data/lib/rubocop/sorbet/version.rb

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

data/manual/cops.md

@@ -33,12 +33,14 @@ In the following section you find all available cops:
 * [Sorbet/MultipleTEnumValues](cops_sorbet.md#sorbetmultipletenumvalues)
 * [Sorbet/ObsoleteStrictMemoization](cops_sorbet.md#sorbetobsoletestrictmemoization)
 * [Sorbet/RedundantExtendTSig](cops_sorbet.md#sorbetredundantextendtsig)
+* [Sorbet/Refinement](cops_sorbet.md#sorbetrefinement)
 * [Sorbet/SignatureBuildOrder](cops_sorbet.md#sorbetsignaturebuildorder)
 * [Sorbet/SingleLineRbiClassModuleDefinitions](cops_sorbet.md#sorbetsinglelinerbiclassmoduledefinitions)
 * [Sorbet/StrictSigil](cops_sorbet.md#sorbetstrictsigil)
 * [Sorbet/StrongSigil](cops_sorbet.md#sorbetstrongsigil)
 * [Sorbet/TrueSigil](cops_sorbet.md#sorbettruesigil)
 * [Sorbet/TypeAliasName](cops_sorbet.md#sorbettypealiasname)
+* [Sorbet/ValidGemVersionAnnotations](cops_sorbet.md#sorbetvalidgemversionannotations)
 * [Sorbet/ValidSigil](cops_sorbet.md#sorbetvalidsigil)
 * [Sorbet/VoidCheckedTests](cops_sorbet.md#sorbetvoidcheckedtests)
 

data/manual/cops_sorbet.md

@@ -759,6 +759,43 @@ class Example
 end
 ```
 
+## Sorbet/Refinement
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+--- | --- | --- | --- | ---
+Enabled | Yes | No | <<next>> | -
+
+Checks for the use of Ruby Refinements library. Refinements add
+complexity and incur a performance penalty that can be significant
+for large code bases. Good examples are cases of unrelated
+methods that happen to have the same name as these module methods.
+
+### Examples
+
+```ruby
+# bad
+module Foo
+  refine(Date) do
+  end
+end
+
+# bad
+module Foo
+  using(Date) do
+  end
+end
+
+# good
+module Foo
+  bar.refine(Date)
+end
+
+# good
+module Foo
+  bar.using(Date)
+end
+```
+
 ## Sorbet/SignatureBuildOrder
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
@@ -892,6 +929,30 @@ Name | Default value | Configurable values
 Include | `**/*.{rb,rbi,rake,ru}` | Array
 Exclude | `bin/**/*`, `db/**/*.rb`, `script/**/*` | Array
 
+## Sorbet/ValidGemVersionAnnotations
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+--- | --- | --- | --- | ---
+Enabled | Yes | No | - | -
+
+Checks that gem versions in RBI annotations are properly formatted per the Bundler gem specification.
+
+### Examples
+
+```ruby
+# bad
+# @version > not a version number
+
+# good
+# @version = 1
+
+# good
+# @version > 1.2.3
+
+# good
+# @version <= 4.3-preview
+```
+
 ## Sorbet/ValidSigil
 
 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.8.4
+  version: 0.8.6
 platform: ruby
 authors:
 - Ufuk Kayserilioglu
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-16 00:00:00.000000000 Z
+date: 2024-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -39,6 +39,7 @@ files:
 - ".github/release.yml"
 - ".github/workflows/ci.yml"
 - ".github/workflows/cla.yml"
+- ".github/workflows/dependabot_automerge.yml"
 - ".github/workflows/stale.yml"
 - ".gitignore"
 - ".rspec"
@@ -81,7 +82,10 @@ files:
 - lib/rubocop/cop/sorbet/rbi/forbid_extend_t_sig_helpers_in_shims.rb
 - lib/rubocop/cop/sorbet/rbi/forbid_rbi_outside_of_allowed_paths.rb
 - lib/rubocop/cop/sorbet/rbi/single_line_rbi_class_module_definitions.rb
+- lib/rubocop/cop/sorbet/rbi_versioning/gem_version_annotation_helper.rb
+- lib/rubocop/cop/sorbet/rbi_versioning/valid_gem_version_annotations.rb
 - lib/rubocop/cop/sorbet/redundant_extend_t_sig.rb
+- lib/rubocop/cop/sorbet/refinement.rb
 - lib/rubocop/cop/sorbet/sigils/enforce_sigil_order.rb
 - lib/rubocop/cop/sorbet/sigils/enforce_single_sigil.rb
 - lib/rubocop/cop/sorbet/sigils/false_sigil.rb
@@ -133,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.15
+rubygems_version: 3.5.21
 signing_key:
 specification_version: 4
 summary: Automatic Sorbet code style checking tool.