rubocop-sorbet 0.6.11 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a3b043348a2ad38724ebb70db4bb8db09a6a02d9c9bbc56a262e0de4b90d5eb
-  data.tar.gz: 50e5a9d5e61b0e95343a8d4699f81910bff19f10387119ae97bfec688906c6d9
+  metadata.gz: c0d4456bcb92b2f40f1208842fce6a102f6ce2ba88ff491840d77a3001784677
+  data.tar.gz: 5e389a2c6c772f68aaf95555da670732ac70a9c5262be18c0418e0d787feb5de
 SHA512:
-  metadata.gz: e749a4ac82f0e9b76a5f3bb2e77bbefeec539a939b107b3dc59c1d20c83b4f4b4766a6792938a03cd8d7e8044ec58a53d8af4d346ec5177390993fb2ddcd181e
-  data.tar.gz: 417259e5915b4836c8b90939d7922d34ab02e2d4d7955482d9fdb7dac58cb728114bd08e0437650b10687e64cdbfd75361ed586dd21cfb9de5bbacd1fc816db7
+  metadata.gz: c2cb4129f91d6c52aa3affe2728a9c049635ce9ccefdcaa86520bbf0a1d25b7160a3d253597329008661f4207bf953ec36058c3908874b6f9077da0742a9f15f
+  data.tar.gz: c4736a927b8f377f81bf7982e9a6d6fa4669b6ebc7dea5c60bba7a8e54adc843f096c8bfe6a0eea7fc47e34cc4374c4675495936d5c9b1289a17b2d226c44375

data/.github/workflows/ci.yml

@@ -11,7 +11,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '2.5', '2.6', '2.7', '3.0', '3.1' ]
+        ruby: [ '2.7', '3.0', '3.1', '3.2' ]
     name: Test Ruby ${{ matrix.ruby }}
     steps:
       - uses: actions/checkout@v2
@@ -22,5 +22,7 @@ jobs:
           bundler-cache: true
       - name: Lint Ruby files
         run: bin/rubocop
+      - name: Verify documentation is up to date
+        run: bundle exec rake generate_cops_documentation
       - name: Run tests
         run: bin/rspec

data/.github/workflows/cla.yml

@@ -0,0 +1,22 @@
+name: Contributor License Agreement (CLA)
+
+on:
+  pull_request_target:
+    types: [opened, synchronize, reopened]
+  issue_comment:
+    types: [created]
+
+jobs:
+  cla:
+    runs-on: ubuntu-latest
+    if: |
+      (github.event.issue.pull_request 
+        && !github.event.issue.pull_request.merged_at
+        && contains(github.event.comment.body, 'signed')
+      ) 
+      || (github.event.pull_request && !github.event.pull_request.merged)
+    steps:
+      - uses: Shopify/shopify-cla-action@v1
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          cla-token: ${{ secrets.CLA_TOKEN }}

data/.github/workflows/stale.yml

@@ -0,0 +1,24 @@
+name: "Close stale PRs"
+
+permissions:
+  pull-requests: write
+  issues: write
+
+on:
+  schedule:
+    - cron: "55 1 * * *"
+
+jobs:
+  stale:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/stale@v5
+        with:
+          stale-pr-message: >
+            This PR has been automatically marked as stale because it has not had
+            recent activity. It will be closed if no further activity occurs. Thank you
+            for your contributions.
+          days-before-stale: 30
+          days-before-issue-stale: -1
+          days-before-close: 7
+          exempt-pr-labels: pinned,security

data/.rubocop.yml

@@ -3,11 +3,22 @@
 inherit_gem:
   rubocop-shopify: rubocop.yml
 
+require:
+  - rubocop/cop/internal_affairs
+
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.7
   Exclude:
     - vendor/**/*
+  NewCops: disable
+  SuggestExtensions: false
+
+InternalAffairs:
+  Enabled: true
 
 Naming/FileName:
   Exclude:
   - lib/rubocop-sorbet.rb
+
+Layout/LineLength:
+  IgnoreCopDirectives: true

data/.yardopts

@@ -0,0 +1 @@
+--tag safety:"Cop Safety Information"

data/Gemfile

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 source "https://rubygems.org"
 
 # Specify your gem's dependencies in rubocop-sorbet.gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop-sorbet (0.6.11)
+    rubocop-sorbet (0.7.1)
       rubocop (>= 0.90.0)
 
 GEM
@@ -10,13 +10,17 @@ GEM
     ast (2.4.2)
     byebug (11.1.3)
     diff-lcs (1.3)
-    parallel (1.21.0)
-    parser (3.0.1.1)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    parallel (1.23.0)
+    parser (3.2.2.3)
       ast (~> 2.4.1)
+      racc
+    racc (1.7.1)
     rainbow (3.1.1)
     rake (13.0.1)
-    regexp_parser (2.2.0)
-    rexml (3.2.5)
+    regexp_parser (2.8.1)
+    rexml (3.2.6)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -30,21 +34,23 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.2)
-    rubocop (1.24.1)
+    rubocop (1.55.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.2.2.3)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.15.1, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.15.1)
-      parser (>= 3.0.1.1)
-    rubocop-shopify (2.1.0)
-      rubocop (~> 1.13)
-    ruby-progressbar (1.11.0)
-    unicode-display_width (2.1.0)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-shopify (2.14.0)
+      rubocop (~> 1.51)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.4.2)
     unparser (0.6.0)
       diff-lcs (~> 1.3)
       parser (>= 3.0.0)
@@ -63,4 +69,4 @@ DEPENDENCIES
   yard (~> 0.9)
 
 BUNDLED WITH
-   2.2.16
+   2.4.18

data/README.md

@@ -98,7 +98,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/Shopif
 To contribute a new cop, please use the supplied generator like this:
 
 ```sh
-bundle exec rake new_cop[Sorbet/NewCopName]
+bundle exec rake "new_cop[Sorbet/NewCopName]"
 ```
 
 which will create a skeleton cop, a skeleton spec, an entry in the default config file and will require the new cop so that it is properly exported from the gem.

data/Rakefile

@@ -18,19 +18,19 @@ task :new_cop, [:cop] do |_task, args|
   require "rubocop"
 
   cop_name = args.fetch(:cop) do
-    warn("usage: bundle exec rake new_cop[Department/Name]")
+    warn('usage: bundle exec rake "new_cop[Department/Name]"')
     exit!
   end
 
-  github_user = %x(git config github.user).chop
-  github_user = "Shopify" if github_user.empty?
-
-  generator = RuboCop::Cop::Generator.new(cop_name, github_user)
+  generator = RuboCop::Cop::Generator.new(cop_name)
 
   generator.write_source
   generator.write_spec
   generator.inject_require(root_file_path: "lib/rubocop/cop/sorbet_cops.rb")
   generator.inject_config(config_file_path: "config/default.yml")
 
-  puts generator.todo
+  # We don't use Rubocop's changelog automation workflow
+  todo_without_changelog_instruction = generator.todo
+    .sub(/$\s+4\. Run.*changelog.*for your new cop\.$/m, "")
+  puts todo_without_changelog_instruction
 end

data/bin/rspec

@@ -9,8 +9,10 @@
 #
 
 require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path(
+  "../../Gemfile",
+  Pathname.new(__FILE__).realpath,
+)
 
 bundle_binstub = File.expand_path("../bundle", __FILE__)
 

data/bin/rubocop

@@ -9,8 +9,10 @@
 #
 
 require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path(
+  "../../Gemfile",
+  Pathname.new(__FILE__).realpath,
+)
 
 bundle_binstub = File.expand_path("../bundle", __FILE__)
 

data/config/default.yml

@@ -25,6 +25,11 @@ Sorbet/CheckedTrueInSignature:
   Enabled: true
   VersionAdded: 0.2.0
 
+Sorbet/EmptyLineAfterSig:
+  Description: 'Ensures that there are no blank lines after signatures'
+  Enabled: true
+  VersionAdded: 0.7.0
+
 Sorbet/ConstantsFromStrings:
   Description: >-
                   Forbids constant access through meta-programming.
@@ -42,7 +47,7 @@ Sorbet/EnforceSigilOrder:
 Sorbet/EnforceSingleSigil:
   Description: 'Ensures that there is only one Sorbet sigil in a file.'
   Enabled: true
-  VersionAdded: '<<next>>'
+  VersionAdded: 0.7.0
 
 Sorbet/EnforceSignatures:
   Description: 'Ensures all methods have a valid signature.'
@@ -73,6 +78,7 @@ Sorbet/ForbidRBIOutsideOfAllowedPaths:
   Enabled: true
   VersionAdded: 0.6.1
   AllowedPaths:
+  - "rbi/**"
   - "sorbet/rbi/**"
   Include:
   - "**/*.rbi"
@@ -114,7 +120,8 @@ Sorbet/HasSigil:
   Description: 'Makes the Sorbet typed sigil mandatory in all files.'
   Enabled: false
   SuggestedStrictness: "false"
-  MinimumStrictness: "false"
+  MinimumStrictness: nil
+  ExactStrictness: nil
   VersionAdded: 0.3.3
   Include:
   - "**/*.{rb,rbi,rake,ru}"
@@ -135,6 +142,13 @@ Sorbet/IgnoreSigil:
   - db/**/*.rb
   - script/**/*
 
+Sorbet/ImplicitConversionMethod:
+  Description: >-
+    This cop disallows declaring implicit conversion methods, as sorbet does
+    not support implicit conversion.
+  Enabled: false
+  VersionAdded: '<<next>>'
+
 Sorbet/KeywordArgumentOrdering:
   Description: >-
                   Enforces a compatible keyword arguments with Sorbet.
@@ -145,11 +159,33 @@ Sorbet/KeywordArgumentOrdering:
   Enabled: true
   VersionAdded: 0.2.0
 
+Sorbet/ObsoleteStrictMemoization:
+  Description: >-
+    This cop checks for the obsolete pattern for initializing instance variables that was required for older Sorbet
+    versions in `#typed: strict` files.
+
+    It's no longer required, as of Sorbet 0.5.10210
+    See https://sorbet.org/docs/type-assertions#put-type-assertions-behind-memoization
+  Enabled: true
+  VersionAdded: '0.7.1'
+  Safe: true
+  SafeAutoCorrect: true
+
 Sorbet/OneAncestorPerLine:
   Description: 'Enforces one ancestor per call to requires_ancestor'
   Enabled: false
   VersionAdded: '0.6.0'
 
+Sorbet/RedundantExtendTSig:
+  Description: >-
+    Forbid the usage of redundant `extend T::Sig`.
+
+    Only for use in applications that monkey patch `Module.include(T::Sig)` directly,
+    where it is useful to reduce noise.
+  Enabled: false
+  Safe: false
+  VersionAdded: 0.7.0
+
 Sorbet/SignatureBuildOrder:
   Description: >-
                   Enforces the order of parts in a signature.
@@ -219,7 +255,8 @@ Sorbet/ValidSigil:
   Enabled: true
   RequireSigilOnAllFiles: false
   SuggestedStrictness: "false"
-  MinimumStrictness: "false"
+  MinimumStrictness: nil
+  ExactStrictness: nil
   VersionAdded: 0.3.3
   Include:
   - "**/*.{rb,rbi,rake,ru}"

data/dev.yml

@@ -3,7 +3,7 @@ name: "rubocop-sorbet"
 type: "ruby"
 
 up:
-  - ruby: "2.5.5"
+  - ruby: "3.2.0"
   - "bundler"
 
 commands:

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

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+module RuboCop
+  module Cop
+    module Sorbet
+      # Disallows binding the return value of `T.any`, `T.all`, `T.enum`
+      # to a constant directly. To bind the value, one must use `T.type_alias`.
+      #
+      # @example
+      #
+      #   # bad
+      #   FooOrBar = T.any(Foo, Bar)
+      #
+      #   # good
+      #   FooOrBar = T.type_alias { T.any(Foo, Bar) }
+      class BindingConstantWithoutTypeAlias < RuboCop::Cop::Base
+        extend AutoCorrector
+
+        MSG = "It looks like you're trying to bind a type to a constant. " \
+          "To do this, you must alias the type using `T.type_alias`."
+        WITHOUT_BLOCK_MSG = "It looks like you're using the old `T.type_alias` syntax. " \
+          "`T.type_alias` now expects a block." \
+          'Run Sorbet with the options "--autocorrect --error-white-list=5043" ' \
+          "to automatically upgrade to the new syntax."
+
+        # @!method type_alias_without_block(node)
+        def_node_matcher :type_alias_without_block, <<~PATTERN
+          (send
+            (const {nil? cbase} :T)
+            :type_alias
+            $_
+          )
+        PATTERN
+
+        # @!method type_alias_with_block?(node)
+        def_node_matcher :type_alias_with_block?, <<~PATTERN
+          (block
+            (send
+              (const {nil? cbase} :T)
+            :type_alias)
+            ...
+          )
+        PATTERN
+
+        # @!method requires_type_alias?(node)
+        def_node_matcher :requires_type_alias?, <<~PATTERN
+          (send
+            (const {nil? cbase} :T)
+            {
+              :all
+              :any
+              :class_of
+              :nilable
+              :noreturn
+              :proc
+              :self_type
+              :untyped
+            }
+            ...
+          )
+        PATTERN
+
+        def on_casgn(node)
+          expression = node.expression
+          return if expression.nil? # multiple assignment
+
+          type_alias_without_block(expression) do |type|
+            return add_offense(expression, message: WITHOUT_BLOCK_MSG) do |corrector|
+              corrector.replace(expression, "T.type_alias { #{type.source} }")
+            end
+          end
+
+          return if type_alias_with_block?(expression)
+
+          requires_type_alias?(send_leaf(expression)) do
+            return add_offense(expression) do |corrector|
+              corrector.replace(expression, "T.type_alias { #{expression.source} }")
+            end
+          end
+        end
+
+        private
+
+        # Given nested send nodes, returns the leaf with explicit receiver.
+        #
+        # i.e. in Ruby
+        #
+        #     a.b.c.d.e.f
+        #     ^^^
+        #
+        # i.e. in AST
+        #
+        #     (send (send (send (send (send (send nil :a) :b) :c) :d) :e) :f)
+        #                             ^^^^^^^^^^^^^^^^^^^^^^^
+        #
+        def send_leaf(node)
+          node = node.receiver while node&.receiver&.send_type?
+          node
+        end
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Sorbet
-      # This cop ensures that callback conditionals are bound to the right type
+      # Ensures that callback conditionals are bound to the right type
       # so that they are type checked properly.
       #
       # Auto-correction is unsafe because other libraries define similar style callbacks as Rails, but don't always need
@@ -32,16 +32,44 @@ module RuboCop
       #       true
       #     end
       #   end
-      class CallbackConditionalsBinding < RuboCop::Cop::Cop
+      class CallbackConditionalsBinding < RuboCop::Cop::Cop # rubocop:todo InternalAffairs/InheritDeprecatedCopClass
         CALLBACKS = [
-          :validate, :validates, :validates_with, :before_validation, :around_validation, :before_create,
-          :before_save, :before_destroy, :before_update, :after_create, :after_save, :after_destroy,
-          :after_update, :after_touch, :after_initialize, :after_find, :around_create, :around_save,
-          :around_destroy, :around_update, :before_commit, :after_commit, :after_create_commit,
-          :after_destroy_commit, :after_rollback, :after_save_commit, :after_update_commit,
-          :before_action, :prepend_before_action, :append_before_action, :around_action,
-          :prepend_around_action, :append_around_action, :after_action, :prepend_after_action,
-          :append_after_action
+          :validate,
+          :validates,
+          :validates_with,
+          :before_validation,
+          :around_validation,
+          :before_create,
+          :before_save,
+          :before_destroy,
+          :before_update,
+          :after_create,
+          :after_save,
+          :after_destroy,
+          :after_update,
+          :after_touch,
+          :after_initialize,
+          :after_find,
+          :around_create,
+          :around_save,
+          :around_destroy,
+          :around_update,
+          :before_commit,
+          :after_commit,
+          :after_create_commit,
+          :after_destroy_commit,
+          :after_rollback,
+          :after_save_commit,
+          :after_update_commit,
+          :before_action,
+          :prepend_before_action,
+          :append_before_action,
+          :around_action,
+          :prepend_around_action,
+          :append_around_action,
+          :after_action,
+          :prepend_after_action,
+          :append_after_action,
         ].freeze
 
         def autocorrect(node)
@@ -132,7 +160,7 @@ module RuboCop
           unless block.source.include?("T.bind(self")
             add_offense(
               node,
-              message: "Callback conditionals should be bound to the right type. Use T.bind(self, #{expected_class})"
+              message: "Callback conditionals should be bound to the right type. Use T.bind(self, #{expected_class})",
             )
           end
         end

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

@@ -5,7 +5,7 @@ require "rubocop"
 module RuboCop
   module Cop
     module Sorbet
-      # This cop disallows the calls that are used to get constants fom Strings
+      # Disallows the calls that are used to get constants fom Strings
       # such as +constantize+, +const_get+, and +constants+.
       #
       # The goal of this cop is to make the code easier to statically analyze,
@@ -33,18 +33,20 @@ module RuboCop
       #
       #   # good
       #   { "User" => User }.fetch(class_name)
-      class ConstantsFromStrings < ::RuboCop::Cop::Cop
+      class ConstantsFromStrings < ::RuboCop::Cop::Cop # rubocop:todo InternalAffairs/InheritDeprecatedCopClass
+        # @!method constant_from_string?(node)
         def_node_matcher(:constant_from_string?, <<-PATTERN)
           (send _ {:constantize :constants :const_get} ...)
         PATTERN
 
         def on_send(node)
           return unless constant_from_string?(node)
+
           add_offense(
             node,
             location: :selector,
             message: "Don't use `#{node.method_name}`, it makes the code harder to understand, less editor-friendly, " \
-              "and impossible to analyze. Replace `#{node.method_name}` with a case/when or a hash."
+              "and impossible to analyze. Replace `#{node.method_name}` with a case/when or a hash.",
           )
         end
       end

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

@@ -3,34 +3,35 @@
 
 require "rubocop"
 
-# Correct `send` expressions in include statements by constant literals.
-#
-# Sorbet, the static checker, is not (yet) able to support constructs on the
-# following form:
-#
-# ```ruby
-# class MyClass
-#   include send_expr
-# end
-# ```
-#
-# Multiple occurences of this can be found in Shopify's code base like:
-#
-# ```ruby
-# include Rails.application.routes.url_helpers
-# ```
-# or
-# ```ruby
-# include Polaris::Engine.helpers
-# ```
 module RuboCop
   module Cop
     module Sorbet
-      class ForbidIncludeConstLiteral < RuboCop::Cop::Cop
+      # Correct `send` expressions in include statements by constant literals.
+      #
+      # Sorbet, the static checker, is not (yet) able to support constructs on the
+      # following form:
+      #
+      # ```ruby
+      # class MyClass
+      #   include send_expr
+      # end
+      # ```
+      #
+      # Multiple occurences of this can be found in Shopify's code base like:
+      #
+      # ```ruby
+      # include Rails.application.routes.url_helpers
+      # ```
+      # or
+      # ```ruby
+      # include Polaris::Engine.helpers
+      # ```
+      class ForbidIncludeConstLiteral < RuboCop::Cop::Cop # rubocop:todo InternalAffairs/InheritDeprecatedCopClass
         MSG = "Includes must only contain constant literals"
 
         attr_accessor :used_names
 
+        # @!method not_lit_const_include?(node)
         def_node_matcher :not_lit_const_include?, <<-PATTERN
           (send nil? {:include :extend :prepend}
             $_
@@ -46,18 +47,21 @@ module RuboCop
           return unless not_lit_const_include?(node) do |send_argument|
             ![:const, :self].include?(send_argument.type)
           end
+
           parent = node.parent
           return unless parent
+
           parent = parent.parent if [:begin, :block].include?(parent.type)
           return unless [:module, :class, :sclass].include?(parent.type)
+
           add_offense(node)
         end
 
         def autocorrect(node)
           lambda do |corrector|
             corrector.replace(
-              node.source_range,
-              "T.unsafe(self).#{node.source}"
+              node,
+              "T.unsafe(self).#{node.source}",
             )
           end
         end