rubocop-sorbet 0.4.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b73993245df905cf40d9e0dbc440d613315e5b32d89e9b61ee123994fee53e73
-  data.tar.gz: '019d4212c2c204492aa38f928ddfc31cceac5d79fe6ee09927c889e3b245f999'
+  metadata.gz: 309687789d8de94ff0cc8c0d64361cd227ab332ffdd16ab0248d588639dfcd80
+  data.tar.gz: ca39d50843f2e577ed0a0328c9707e21af175daacd8c92b9b4403bc2195c4cff
 SHA512:
-  metadata.gz: d491ed5a48d75c2f5151329fc0018ca56ed57504d6d1e338befe0c9395bf85824b65f68164538667b4720eca216eeb15c29c6ed379524ae9ed1a8215cf6daf84
-  data.tar.gz: 7944aa4817f48ca0bb43c47dabcf197ced656674ab59ce261705b946045a2e3c0de813200187829cf9936a2144a5203ed625c8cdd89a33b7e80876229f7f2748
+  metadata.gz: f774385eec35af24755af1cc5e7f5de554bedf0f6a475e3235879aee61a2c68a818ea87ca4663daa17bb807c862d911264284d1f3270e852166c3e84cde32e7d
+  data.tar.gz: d6d91114e9c70bc64fa5adf6679a689c12263caa352f7f38b6d96d36609a81e90bc18f369e42b1605259262626114aac6fd5d50f7c91bced3e2f24e2f606fbc4

data/.github/workflows/ci.yml

@@ -0,0 +1,26 @@
+name: CI
+
+on: [push, pull_request]
+
+env:
+  SRB_SKIP_GEM_RBIS: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ 2.5, 2.6, 2.7, 3.0 ]
+    name: Test Ruby ${{ matrix.ruby }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Lint Ruby files
+        run: bin/rubocop
+      - name: Run tests
+        run: bin/rspec

data/.gitignore

@@ -6,3 +6,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+.byebug_history

data/Gemfile

@@ -4,6 +4,7 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in rubocop-sorbet.gemspec
 gemspec
 
+gem "byebug"
 gem "rake", ">= 12.3.3"
 gem "rspec"
 gem "rubocop-shopify", require: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop-sorbet (0.4.1)
+    rubocop-sorbet (0.6.2)
       rubocop
 
 GEM
@@ -12,6 +12,7 @@ GEM
       ice_nine (~> 0.11.0)
       memoizable (~> 0.4.0)
     ast (2.4.0)
+    byebug (11.1.3)
     concord (0.1.5)
       adamantium (~> 0.2.0)
       equalizer (~> 0.0.9)
@@ -27,7 +28,7 @@ GEM
     rainbow (3.0.0)
     rake (13.0.1)
     regexp_parser (1.7.0)
-    rexml (3.2.4)
+    rexml (3.2.5)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -71,6 +72,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  byebug
   rake (>= 12.3.3)
   rspec
   rubocop-shopify
@@ -79,4 +81,4 @@ DEPENDENCIES
   yard (~> 0.9)
 
 BUNDLED WITH
-   1.17.3
+   2.2.16

data/README.md

@@ -17,6 +17,13 @@ or, if you use `Bundler`, add this line your application's `Gemfile`:
 gem 'rubocop-sorbet', require: false
 ```
 
+Note: in order to use the [Sorbet/SignatureBuildOrder](https://github.com/Shopify/rubocop-sorbet/blob/master/manual/cops_sorbet.md#sorbetsignaturebuildorder) cop autocorrect feature, it is necessary
+to install `unparser` in addition to `rubocop-sorbet`.
+
+```ruby
+gem "unparser", require: false
+```
+
 ## Usage
 
 You need to tell RuboCop to load the Sorbet extension. There are three ways to do this:

data/bin/rubocop

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load(Gem.bin_path("rubocop", "rubocop"))

data/config/default.yml

@@ -14,6 +14,11 @@ Sorbet/BindingConstantWithoutTypeAlias:
   Enabled: true
   VersionAdded: 0.2.0
 
+Sorbet/CallbackConditionalsBinding:
+  Description: 'Ensures callback conditionals are bound to the right type.'
+  Enabled: true
+  VersionAdded: 0.7.0
+
 Sorbet/CheckedTrueInSignature:
   Description: 'Disallows the usage of `checked(true)` in signatures.'
   Enabled: true
@@ -42,7 +47,7 @@ Sorbet/FalseSigil:
   Description: 'All files must be at least at strictness `false`.'
   Enabled: true
   VersionAdded: 0.3.3
-  SuggestedStrictness: true
+  SuggestedStrictness: "false"
   Include:
   - "**/*.rb"
   - "**/*.rbi"
@@ -53,15 +58,39 @@ Sorbet/FalseSigil:
   - db/**/*.rb
   - script/**/*
 
+Sorbet/ForbidExtendTSigHelpersInShims:
+  Description: 'Forbid the use of `extend T::Sig` and `extend T::Helpers` in RBI shims'
+  Enabled: true
+  VersionAdded: '0.6.0'
+  Include:
+  - "**/*.rbi"
+
+Sorbet/ForbidRBIOutsideOfSorbetDir:
+  Description: 'Forbids RBI files outside of the sorbet/ directory.'
+  Enabled: true
+  VersionAdded: 0.6.1
+  Include:
+  - "**/*.rbi"
+
 Sorbet/ForbidIncludeConstLiteral:
   Description: 'Forbids include of non-literal constants.'
-  Enabled: true
+  Enabled: false
   VersionAdded: 0.2.0
+  VersionChanged: 0.5.0
 
 Sorbet/ForbidSuperclassConstLiteral:
   Description: 'Forbid superclasses which are non-literal constants.'
-  Enabled: true
+  Enabled: false
   VersionAdded: 0.2.0
+  VersionChanged: 0.6.1
+  Exclude:
+  - db/migrate/*.rb
+
+Sorbet/ForbidTUnsafe:
+  Description: 'Forbid usage of T.unsafe.'
+  Enabled: false
+  VersionAdded: 0.7.0
+  VersionChanged: 0.7.0
 
 Sorbet/ForbidUntypedStructProps:
   Description: >-
@@ -73,11 +102,14 @@ Sorbet/ForbidUntypedStructProps:
 Sorbet/HasSigil:
   Description: 'Makes the Sorbet typed sigil mandatory in all files.'
   Enabled: false
+  SuggestedStrictness: "false"
+  MinimumStrictness: "false"
   VersionAdded: 0.3.3
 
 Sorbet/IgnoreSigil:
   Description: 'All files must be at least at strictness `ignore`.'
   Enabled: false
+  SuggestedStrictness: "ignore"
   VersionAdded: 0.3.3
 
 Sorbet/KeywordArgumentOrdering:
@@ -90,6 +122,11 @@ Sorbet/KeywordArgumentOrdering:
   Enabled: true
   VersionAdded: 0.2.0
 
+Sorbet/OneAncestorPerLine:
+  Description: 'Enforces one ancestor per call to requires_ancestor'
+  Enabled: false
+  VersionAdded: '0.6.0'
+
 Sorbet/ParametersOrderingInSignature:
   Description: 'Enforces same parameter order between a method and its signature.'
   Enabled: true
@@ -105,22 +142,35 @@ Sorbet/SignatureBuildOrder:
   Enabled: true
   VersionAdded: 0.3.0
 
+Sorbet/SingleLineRbiClassModuleDefinitions:
+  Description: 'Empty class and module definitions in RBI must be on a single line.'
+  Enabled: false
+  VersionAdded: '0.6.0'
+  Include:
+  - "**/*.rbi"
+
 Sorbet/StrictSigil:
   Description: 'All files must be at least at strictness `strict`.'
   Enabled: false
+  SuggestedStrictness: "strict"
   VersionAdded: 0.3.3
 
 Sorbet/StrongSigil:
   Description: 'All files must be at least at strictness `strong`.'
   Enabled: false
+  SuggestedStrictness: "strong"
   VersionAdded: 0.3.3
 
 Sorbet/TrueSigil:
   Description: 'All files must be at least at strictness `true`.'
   Enabled: false
+  SuggestedStrictness: "true"
   VersionAdded: 0.3.3
 
 Sorbet/ValidSigil:
   Description: 'All files must have a valid sigil.'
   Enabled: true
+  RequireSigilOnAllFiles: false
+  SuggestedStrictness: "false"
+  MinimumStrictness: "false"
   VersionAdded: 0.3.3

data/dev.yml

@@ -8,4 +8,4 @@ up:
 
 commands:
   test:   "bin/rspec"
-  style:  "bundle exec rubocop"
+  style:  "bin/rubocop"

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

@@ -17,7 +17,7 @@ module RuboCop
       #   FooOrBar = T.type_alias { T.any(Foo, Bar) }
       class BindingConstantWithoutTypeAlias < RuboCop::Cop::Cop
         def_node_matcher(:binding_unaliased_type?, <<-PATTERN)
-          (casgn _ _ [#not_nil? #not_t_let? #not_generic_parameter_decl? #method_needing_aliasing_on_t?])
+          (casgn _ _ [#not_nil? #not_t_let? #not_dynamic_type_creation_with_block? #not_generic_parameter_decl? #method_needing_aliasing_on_t?])
         PATTERN
 
         def_node_matcher(:using_type_alias?, <<-PATTERN)
@@ -48,6 +48,15 @@ module RuboCop
           )
         PATTERN
 
+        def_node_matcher(:dynamic_type_creation_with_block?, <<-PATTERN)
+          (block
+            (send
+              const :new ...)
+              _
+              _
+          )
+        PATTERN
+
         def_node_matcher(:generic_parameter_decl?, <<-PATTERN)
           (
             send nil? {:type_template :type_member} ...
@@ -67,6 +76,10 @@ module RuboCop
           !t_let?(node)
         end
 
+        def not_dynamic_type_creation_with_block?(node)
+          !dynamic_type_creation_with_block?(node)
+        end
+
         def not_generic_parameter_decl?(node)
           !generic_parameter_decl?(node)
         end

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

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Sorbet
+      # This cop ensures that callback conditionals are bound to the right type
+      # so that they are type checked properly.
+      #
+      # @example
+      #
+      #   # bad
+      #   class Post < ApplicationRecord
+      #     before_create :do_it, if: -> { should_do_it? }
+      #
+      #     def should_do_it?
+      #       true
+      #     end
+      #   end
+      #
+      #   # good
+      #   class Post < ApplicationRecord
+      #     before_create :do_it, if: -> { T.bind(self, Post).should_do_it? }
+      #
+      #     def should_do_it?
+      #       true
+      #     end
+      #   end
+      class CallbackConditionalsBinding < RuboCop::Cop::Cop
+        CALLBACKS = %i(
+          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)
+          lambda do |corrector|
+            options = node.each_child_node.find(&:hash_type?)
+
+            conditional = nil
+            options.each_pair do |keyword, block|
+              if keyword.value == :if || keyword.value == :unless
+                conditional = block
+                break
+              end
+            end
+
+            _, _, block = conditional.child_nodes
+            expected_class = node.parent_module_name
+
+            bind = if block.begin_type?
+              indentation = " " * block.child_nodes.first.loc.column
+              "T.bind(self, #{expected_class})\n#{indentation}"
+            elsif block.child_nodes.empty? && !block.ivar_type?
+              "T.bind(self, #{expected_class})."
+            else
+              "T.bind(self, #{expected_class}); "
+            end
+
+            corrector.insert_before(block, bind)
+          end
+        end
+
+        def on_send(node)
+          return unless CALLBACKS.include?(node.method_name)
+
+          options = node.each_child_node.find(&:hash_type?)
+          return if options.nil?
+
+          conditional = nil
+          options.each_pair do |keyword, block|
+            next unless keyword.sym_type?
+
+            if keyword.value == :if || keyword.value == :unless
+              conditional = block
+              break
+            end
+          end
+
+          return if conditional.nil? || conditional.child_nodes.empty?
+
+          type, _, block = conditional.child_nodes
+          return unless type.lambda_or_proc?
+
+          expected_class = node.parent_module_name
+          return if expected_class.nil?
+
+          unless block.source.include?("T.bind(self, #{expected_class})")
+            add_offense(
+              node,
+              message: "Callback conditionals should be bound to the right type. Use T.bind(self, #{expected_class})"
+            )
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -14,15 +14,6 @@ require 'rubocop'
 # end
 # ```
 #
-# This cop replaces them by:
-#
-# ```ruby
-# class MyClass
-#   MyClassInclude = send_expr
-#   include MyClassInclude
-# end
-# ```
-#
 # Multiple occurences of this can be found in Shopify's code base like:
 #
 # ```ruby
@@ -61,37 +52,6 @@ module RuboCop
           return unless [:module, :class, :sclass].include?(parent.type)
           add_offense(node)
         end
-
-        def autocorrect(node)
-          lambda do |corrector|
-            # Find parent class node
-            parent = node.parent
-            parent = parent.parent if parent.type == :begin
-
-            # Build include variable name
-            class_name = (parent.child_nodes.first.const_name || 'Anon').split('::').last
-            include_name = find_free_name("#{class_name}Include")
-            used_names << include_name
-
-            # Apply fix
-            indent = ' ' * node.loc.column
-            fix = "#{include_name} = #{node.child_nodes.first.source}\n#{indent}"
-            corrector.insert_before(node.loc.expression, fix)
-            corrector.replace(node.child_nodes.first.loc.expression, include_name)
-          end
-        end
-
-        # Find a free local variable name
-        #
-        # Since each include uses its own local variable to store the send result,
-        # we need to ensure that we don't use the same name twice in the same
-        # module.
-        def find_free_name(base_name)
-          return base_name unless used_names.include?(base_name)
-          i = 2
-          i += 1 while used_names.include?("#{base_name}#{i}")
-          "#{base_name}#{i}"
-        end
       end
     end
   end