rubocop-sorbet 0.5.1 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0df763a5f1ab8de8024c732f5e3fae7d31d21e13c807fceca5c0d8c674e52d46
-  data.tar.gz: 36fb28afefdb665eb471bb536be012b5123efe5e19ef1ddf61415c21a6aa5892
+  metadata.gz: bd3fcc1ddd15ba9418aeb852d83149b3594fb315c7aa77ab4641c9046466d109
+  data.tar.gz: 2b446c026647ebb8d312e8be0034af253f61dc5ac8903c2b75bf42c11be903fe
 SHA512:
-  metadata.gz: 80f5462984070d3194ad111484b5a4f40905b9ba65ab55f95b050915a8df7fa2c2e54d30a7771738f7bb5e9c26dac8568c36a90c3e854dabb14240b255759c64
-  data.tar.gz: 66ed0ca23fa3b76a372fdae99273af7e037e3f0de5b437fc8a4d35ad024da31d0cd174c0afb12c0176c8b111d2b73be7be9960611f9176d58d46825e5c702015
+  metadata.gz: dd23c876c6224baf1a3888c169291b6260286326329d9b48650d1c4113571257837e0fa96d12b4357d4aee62e78b20e1be6373295b0d1e7d065c139e8cf3e25f
+  data.tar.gz: 12c3c8aae878c4474284fd41f79da1f4671399bb8e1f01403fe556d36e25274d951f42771ecd0dfc0c3527686b0f3aa1a0d3a22db9b7287c802adf9c43cbc718

data/.github/release.yml

@@ -0,0 +1,23 @@
+# release.yml
+
+changelog:
+  exclude:
+    labels:
+      - dependencies
+      - chore
+    authors:
+      - dependabot
+  categories:
+    - title: 🚧 Breaking Changes
+      labels:
+        - breaking-change
+    - title: ✨ Enhancements
+      labels:
+        - enhancement
+        - feature
+    - title: 🐛 Bug Fixes
+      labels:
+        - bugfix
+    - title: 🛠 Other Changes
+      labels:
+        - "*"

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,33 +1,22 @@
 PATH
   remote: .
   specs:
-    rubocop-sorbet (0.5.1)
-      rubocop
+    rubocop-sorbet (0.6.3)
+      rubocop (>= 0.90.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    abstract_type (0.0.7)
-    adamantium (0.2.0)
-      ice_nine (~> 0.11.0)
-      memoizable (~> 0.4.0)
-    ast (2.4.0)
-    concord (0.1.5)
-      adamantium (~> 0.2.0)
-      equalizer (~> 0.0.9)
+    ast (2.4.2)
+    byebug (11.1.3)
     diff-lcs (1.3)
-    equalizer (0.0.11)
-    ice_nine (0.11.2)
-    memoizable (0.4.2)
-      thread_safe (~> 0.3, >= 0.3.1)
-    parallel (1.19.1)
-    parser (2.7.1.3)
-      ast (~> 2.4.0)
-    procto (0.0.3)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
     rainbow (3.0.0)
     rake (13.0.1)
-    regexp_parser (1.7.0)
-    rexml (3.2.4)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -41,42 +30,37 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.2)
-    rubocop (0.85.0)
+    rubocop (1.16.0)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 0.0.3)
+      rubocop-ast (>= 1.7.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.0.3)
-      parser (>= 2.7.0.1)
-    rubocop-shopify (1.0.3)
-      rubocop (~> 0.85.0)
-    ruby-progressbar (1.10.1)
-    thread_safe (0.3.6)
-    unicode-display_width (1.7.0)
-    unparser (0.4.7)
-      abstract_type (~> 0.0.7)
-      adamantium (~> 0.2.0)
-      concord (~> 0.1.5)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.7.0)
+      parser (>= 3.0.1.1)
+    rubocop-shopify (2.1.0)
+      rubocop (~> 1.13)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.0.0)
+    unparser (0.6.0)
       diff-lcs (~> 1.3)
-      equalizer (~> 0.0.9)
-      parser (>= 2.6.5)
-      procto (~> 0.0.2)
+      parser (>= 3.0.0)
     yard (0.9.25)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  byebug
   rake (>= 12.3.3)
   rspec
   rubocop-shopify
   rubocop-sorbet!
-  unparser
+  unparser (~> 0.6)
   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:
@@ -53,6 +60,15 @@ RuboCop::RakeTask.new do |task|
 end
 ```
 
+### Rubocop rules for RBI files
+
+Put this into your `.rubocop.yml`:
+
+```yaml
+inherit_gem:
+  rubocop-sorbet: config/rbi.yml
+```
+
 ## The Cops
 All cops are located under [`lib/rubocop/cop/sorbet`](lib/rubocop/cop/sorbet), and contain examples/documentation.
 
@@ -87,6 +103,12 @@ 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.
 
+Don't forget to update the documentation with:
+
+```sh
+bundle exec rake generate_cops_documentation
+```
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://github.com/Shopify/rubocop-sorbet/blob/master/LICENSE.txt).

data/Rakefile

@@ -1,40 +1,36 @@
 # frozen_string_literal: true
 
-require('bundler/gem_tasks')
+require("bundler/gem_tasks")
 
-Dir['tasks/**/*.rake'].each { |t| load t }
+Dir["tasks/**/*.rake"].each { |t| load t }
 
-require 'rubocop/rake_task'
-require 'rspec/core/rake_task'
+require "rubocop/rake_task"
+require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
+  spec.pattern = FileList["spec/**/*_spec.rb"]
 end
 
-task(default: %i[
-  documentation_syntax_check
-  generate_cops_documentation
-  spec
-])
+task(default: [:documentation_syntax_check, :generate_cops_documentation, :spec])
 
-desc('Generate a new cop with a template')
+desc("Generate a new cop with a template")
 task :new_cop, [:cop] do |_task, args|
-  require 'rubocop'
+  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?
+  github_user = "Shopify" if github_user.empty?
 
   generator = RuboCop::Cop::Generator.new(cop_name, github_user)
 
   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')
+  generator.inject_require(root_file_path: "lib/rubocop/cop/sorbet_cops.rb")
+  generator.inject_config(config_file_path: "config/default.yml")
 
   puts generator.todo
 end

data/bin/console

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'bundler/setup'
-require 'rubocop/sorbet'
+require "bundler/setup"
+require "rubocop/sorbet"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -11,5 +11,5 @@ require 'rubocop/sorbet'
 # require "pry"
 # Pry.start
 
-require 'irb'
+require "irb"
 IRB.start(__FILE__)

data/bin/rspec

@@ -8,11 +8,11 @@
 # this file is here to facilitate running it.
 #
 
-require 'pathname'
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
   Pathname.new(__FILE__).realpath)
 
-bundle_binstub = File.expand_path('../bundle', __FILE__)
+bundle_binstub = File.expand_path("../bundle", __FILE__)
 
 if File.file?(bundle_binstub)
   if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
@@ -23,7 +23,7 @@ Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this
   end
 end
 
-require 'rubygems'
-require 'bundler/setup'
+require "rubygems"
+require "bundler/setup"
 
-load(Gem.bin_path('rspec-core', 'rspec'))
+load(Gem.bin_path("rspec-core", "rspec"))

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,12 @@ Sorbet/BindingConstantWithoutTypeAlias:
   Enabled: true
   VersionAdded: 0.2.0
 
+Sorbet/CallbackConditionalsBinding:
+  Description: 'Ensures callback conditionals are bound to the right type.'
+  Enabled: false
+  Safe: false
+  VersionAdded: 0.7.0
+
 Sorbet/CheckedTrueInSignature:
   Description: 'Disallows the usage of `checked(true)` in signatures.'
   Enabled: true
@@ -33,6 +39,11 @@ Sorbet/EnforceSigilOrder:
   Enabled: true
   VersionAdded: 0.3.4
 
+Sorbet/sigils/EnforceSingleSigil:
+  Description: 'Ensures that there is only one Sorbet sigil in a file.'
+  Enabled: true
+  VersionAdded: '<<next>>'
+
 Sorbet/EnforceSignatures:
   Description: 'Ensures all methods have a valid signature.'
   Enabled: false
@@ -42,17 +53,30 @@ 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"
-  - "**/*.rake"
-  - "**/*.ru"
+  - "**/*.{rb,rbi,rake,ru}"
   Exclude:
   - bin/**/*
   - 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/ForbidRBIOutsideOfAllowedPaths:
+  Description: 'Forbids RBI files outside of the allowed paths'
+  Enabled: true
+  VersionAdded: 0.6.1
+  AllowedPaths:
+  - "sorbet/rbi/**"
+  Include:
+  - "**/*.rbi"
+
 Sorbet/ForbidIncludeConstLiteral:
   Description: 'Forbids include of non-literal constants.'
   Enabled: false
@@ -63,7 +87,15 @@ Sorbet/ForbidSuperclassConstLiteral:
   Description: 'Forbid superclasses which are non-literal constants.'
   Enabled: false
   VersionAdded: 0.2.0
-  VersionChanged: 0.5.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: >-
@@ -75,12 +107,27 @@ Sorbet/ForbidUntypedStructProps:
 Sorbet/HasSigil:
   Description: 'Makes the Sorbet typed sigil mandatory in all files.'
   Enabled: false
+  SuggestedStrictness: "false"
+  MinimumStrictness: "false"
   VersionAdded: 0.3.3
+  Include:
+  - "**/*.{rb,rbi,rake,ru}"
+  Exclude:
+  - bin/**/*
+  - db/**/*.rb
+  - script/**/*
 
 Sorbet/IgnoreSigil:
   Description: 'All files must be at least at strictness `ignore`.'
   Enabled: false
+  SuggestedStrictness: "ignore"
   VersionAdded: 0.3.3
+  Include:
+  - "**/*.{rb,rbi,rake,ru}"
+  Exclude:
+  - bin/**/*
+  - db/**/*.rb
+  - script/**/*
 
 Sorbet/KeywordArgumentOrdering:
   Description: >-
@@ -92,10 +139,10 @@ Sorbet/KeywordArgumentOrdering:
   Enabled: true
   VersionAdded: 0.2.0
 
-Sorbet/ParametersOrderingInSignature:
-  Description: 'Enforces same parameter order between a method and its signature.'
-  Enabled: true
-  VersionAdded: 0.2.0
+Sorbet/OneAncestorPerLine:
+  Description: 'Enforces one ancestor per call to requires_ancestor'
+  Enabled: false
+  VersionAdded: '0.6.0'
 
 Sorbet/SignatureBuildOrder:
   Description: >-
@@ -107,22 +154,59 @@ 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
+  Include:
+  - "**/*.{rb,rbi,rake,ru}"
+  Exclude:
+  - bin/**/*
+  - db/**/*.rb
+  - script/**/*
 
 Sorbet/StrongSigil:
   Description: 'All files must be at least at strictness `strong`.'
   Enabled: false
+  SuggestedStrictness: "strong"
   VersionAdded: 0.3.3
+  Include:
+  - "**/*.{rb,rbi,rake,ru}"
+  Exclude:
+  - bin/**/*
+  - db/**/*.rb
+  - script/**/*
 
 Sorbet/TrueSigil:
   Description: 'All files must be at least at strictness `true`.'
   Enabled: false
+  SuggestedStrictness: "true"
   VersionAdded: 0.3.3
+  Include:
+  - "**/*.{rb,rbi,rake,ru}"
+  Exclude:
+  - bin/**/*
+  - db/**/*.rb
+  - script/**/*
 
 Sorbet/ValidSigil:
   Description: 'All files must have a valid sigil.'
   Enabled: true
+  RequireSigilOnAllFiles: false
+  SuggestedStrictness: "false"
+  MinimumStrictness: "false"
   VersionAdded: 0.3.3
+  Include:
+  - "**/*.{rb,rbi,rake,ru}"
+  Exclude:
+  - bin/**/*
+  - db/**/*.rb
+  - script/**/*