rubocop-sorbet 0.5.1 → 0.6.3

data/lib/rubocop/cop/sorbet_cops.rb

@@ -1,22 +1,29 @@
 # frozen_string_literal: true
-require_relative 'sorbet/binding_constants_without_type_alias'
-require_relative 'sorbet/constants_from_strings'
-require_relative 'sorbet/forbid_superclass_const_literal'
-require_relative 'sorbet/forbid_include_const_literal'
-require_relative 'sorbet/forbid_untyped_struct_props'
+require_relative "sorbet/binding_constants_without_type_alias"
+require_relative "sorbet/constants_from_strings"
+require_relative "sorbet/forbid_superclass_const_literal"
+require_relative "sorbet/forbid_include_const_literal"
+require_relative "sorbet/forbid_untyped_struct_props"
+require_relative "sorbet/one_ancestor_per_line"
+require_relative "sorbet/callback_conditionals_binding"
+require_relative "sorbet/forbid_t_unsafe"
 
-require_relative 'sorbet/signatures/allow_incompatible_override'
-require_relative 'sorbet/signatures/checked_true_in_signature'
-require_relative 'sorbet/signatures/keyword_argument_ordering'
-require_relative 'sorbet/signatures/parameters_ordering_in_signature'
-require_relative 'sorbet/signatures/signature_build_order'
-require_relative 'sorbet/signatures/enforce_signatures'
+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/sigils/valid_sigil'
-require_relative 'sorbet/sigils/has_sigil'
-require_relative 'sorbet/sigils/ignore_sigil'
-require_relative 'sorbet/sigils/false_sigil'
-require_relative 'sorbet/sigils/true_sigil'
-require_relative 'sorbet/sigils/strict_sigil'
-require_relative 'sorbet/sigils/strong_sigil'
-require_relative 'sorbet/sigils/enforce_sigil_order'
+require_relative "sorbet/signatures/allow_incompatible_override"
+require_relative "sorbet/signatures/checked_true_in_signature"
+require_relative "sorbet/signatures/keyword_argument_ordering"
+require_relative "sorbet/signatures/signature_build_order"
+require_relative "sorbet/signatures/enforce_signatures"
+
+require_relative "sorbet/sigils/valid_sigil"
+require_relative "sorbet/sigils/has_sigil"
+require_relative "sorbet/sigils/ignore_sigil"
+require_relative "sorbet/sigils/false_sigil"
+require_relative "sorbet/sigils/true_sigil"
+require_relative "sorbet/sigils/strict_sigil"
+require_relative "sorbet/sigils/strong_sigil"
+require_relative "sorbet/sigils/enforce_sigil_order"
+require_relative "sorbet/sigils/enforce_single_sigil"

data/lib/rubocop/sorbet/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 module RuboCop
   module Sorbet
-    VERSION = "0.5.1"
+    VERSION = "0.6.3"
   end
 end

data/lib/rubocop/sorbet.rb

@@ -7,7 +7,7 @@ module RuboCop
     class Error < StandardError; end
 
     PROJECT_ROOT   = Pathname.new(__dir__).parent.parent.expand_path.freeze
-    CONFIG_DEFAULT = PROJECT_ROOT.join('config', 'default.yml').freeze
+    CONFIG_DEFAULT = PROJECT_ROOT.join("config", "default.yml").freeze
     CONFIG         = YAML.safe_load(CONFIG_DEFAULT.read).freeze
 
     private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)

data/lib/rubocop-sorbet.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require 'rubocop'
+require "rubocop"
 
-require_relative 'rubocop/sorbet'
-require_relative 'rubocop/sorbet/version'
-require_relative 'rubocop/sorbet/inject'
+require_relative "rubocop/sorbet"
+require_relative "rubocop/sorbet/version"
+require_relative "rubocop/sorbet/inject"
 
 RuboCop::Sorbet::Inject.defaults!
 
-require_relative 'rubocop/cop/sorbet_cops'
+require_relative "rubocop/cop/sorbet_cops"

data/manual/cops.md

@@ -7,20 +7,26 @@ In the following section you find all available cops:
 
 * [Sorbet/AllowIncompatibleOverride](cops_sorbet.md#sorbetallowincompatibleoverride)
 * [Sorbet/BindingConstantWithoutTypeAlias](cops_sorbet.md#sorbetbindingconstantwithouttypealias)
+* [Sorbet/CallbackConditionalsBinding](cops_sorbet.md#sorbetcallbackconditionalsbinding)
 * [Sorbet/CheckedTrueInSignature](cops_sorbet.md#sorbetcheckedtrueinsignature)
 * [Sorbet/ConstantsFromStrings](cops_sorbet.md#sorbetconstantsfromstrings)
 * [Sorbet/EnforceSigilOrder](cops_sorbet.md#sorbetenforcesigilorder)
 * [Sorbet/EnforceSignatures](cops_sorbet.md#sorbetenforcesignatures)
+* [Sorbet/EnforceSingleSigil](cops_sorbet.md#sorbetenforcesinglesigil)
 * [Sorbet/FalseSigil](cops_sorbet.md#sorbetfalsesigil)
+* [Sorbet/ForbidExtendTSigHelpersInShims](cops_sorbet.md#sorbetforbidextendtsighelpersinshims)
 * [Sorbet/ForbidIncludeConstLiteral](cops_sorbet.md#sorbetforbidincludeconstliteral)
+* [Sorbet/ForbidRBIOutsideOfAllowedPaths](cops_sorbet.md#sorbetforbidrbioutsideofallowedpaths)
 * [Sorbet/ForbidSuperclassConstLiteral](cops_sorbet.md#sorbetforbidsuperclassconstliteral)
+* [Sorbet/ForbidTUnsafe](cops_sorbet.md#sorbetforbidtunsafe)
 * [Sorbet/ForbidUntypedStructProps](cops_sorbet.md#sorbetforbiduntypedstructprops)
 * [Sorbet/HasSigil](cops_sorbet.md#sorbethassigil)
 * [Sorbet/IgnoreSigil](cops_sorbet.md#sorbetignoresigil)
 * [Sorbet/KeywordArgumentOrdering](cops_sorbet.md#sorbetkeywordargumentordering)
-* [Sorbet/ParametersOrderingInSignature](cops_sorbet.md#sorbetparametersorderinginsignature)
+* [Sorbet/OneAncestorPerLine](cops_sorbet.md#sorbetoneancestorperline)
 * [Sorbet/SignatureBuildOrder](cops_sorbet.md#sorbetsignaturebuildorder)
 * [Sorbet/SignatureCop](cops_sorbet.md#sorbetsignaturecop)
+* [Sorbet/SingleLineRbiClassModuleDefinitions](cops_sorbet.md#sorbetsinglelinerbiclassmoduledefinitions)
 * [Sorbet/StrictSigil](cops_sorbet.md#sorbetstrictsigil)
 * [Sorbet/StrongSigil](cops_sorbet.md#sorbetstrongsigil)
 * [Sorbet/TrueSigil](cops_sorbet.md#sorbettruesigil)

data/manual/cops_sorbet.md

@@ -41,6 +41,44 @@ FooOrBar = T.any(Foo, Bar)
 FooOrBar = T.type_alias { T.any(Foo, Bar) }
 ```
 
+## Sorbet/CallbackConditionalsBinding
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+--- | --- | --- | --- | ---
+Disabled | No | Yes  | 0.7.0 | -
+
+This cop 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
+binding to the attached class. Auto-correcting those usages can lead to false positives and auto-correction
+introduces new typing errors.
+
+### Examples
+
+```ruby
+# 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
+```
+
 ## Sorbet/CheckedTrueInSignature
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
@@ -155,6 +193,33 @@ You can configure the placeholders used by changing the following options:
 * `ParameterTypePlaceholder`: placeholders used for parameter types (default: 'T.untyped')
 * `ReturnTypePlaceholder`: placeholders used for return types (default: 'T.untyped')
 
+## Sorbet/EnforceSingleSigil
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+--- | --- | --- | --- | ---
+Enabled | Yes | Yes  | <<next>> | -
+
+This cop checks that there is only one Sorbet sigil in a given file
+
+For example, the following class with two sigils
+
+```ruby
+# typed: true
+# typed: true
+# frozen_string_literal: true
+class Foo; end
+```
+
+Will be corrected as:
+
+```ruby
+# typed: true
+# frozen_string_literal: true
+class Foo; end
+```
+
+Other comments or magic comments are left in place.
+
 ## Sorbet/FalseSigil
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
@@ -167,31 +232,120 @@ This cop makes the Sorbet `false` sigil mandatory in all files.
 
 Name | Default value | Configurable values
 --- | --- | ---
-SuggestedStrictness | `true` | Boolean
-Include | `**/*.rb`, `**/*.rbi`, `**/*.rake`, `**/*.ru` | Array
+SuggestedStrictness | `false` | String
+Include | `**/*.{rb,rbi,rake,ru}` | Array
 Exclude | `bin/**/*`, `db/**/*.rb`, `script/**/*` | Array
 
+## Sorbet/ForbidExtendTSigHelpersInShims
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+--- | --- | --- | --- | ---
+Enabled | Yes | Yes  | 0.6.0 | -
+
+This cop ensures RBI shims do not include a call to extend T::Sig
+or to extend T::Helpers
+
+### Examples
+
+```ruby
+# bad
+module SomeModule
+  extend T::Sig
+  extend T::Helpers
+
+  sig { returns(String) }
+  def foo; end
+end
+
+# good
+module SomeModule
+  sig { returns(String) }
+  def foo; end
+end
+```
+
+### Configurable attributes
+
+Name | Default value | Configurable values
+--- | --- | ---
+Include | `**/*.rbi` | Array
+
 ## Sorbet/ForbidIncludeConstLiteral
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
 --- | --- | --- | --- | ---
-Disabled | Yes | No  | 0.2.0 | 0.5.0
+Disabled | Yes | No | 0.2.0 | 0.5.0
 
 No documentation
 
+## Sorbet/ForbidRBIOutsideOfAllowedPaths
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+--- | --- | --- | --- | ---
+Enabled | Yes | No | 0.6.1 | -
+
+This cop makes sure that RBI files are always located under the defined allowed paths
+
+Options:
+
+* `AllowedPaths`: A list of the paths where RBI files are allowed (default: ["sorbet/rbi/**"])
+
+### Examples
+
+```ruby
+# bad
+# lib/some_file.rbi
+# other_file.rbi
+
+# good
+# sorbet/rbi/some_file.rbi
+# sorbet/rbi/any/path/for/file.rbi
+```
+
+### Configurable attributes
+
+Name | Default value | Configurable values
+--- | --- | ---
+AllowedPaths | `sorbet/rbi/**` | Array
+Include | `**/*.rbi` | Array
+
 ## Sorbet/ForbidSuperclassConstLiteral
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
 --- | --- | --- | --- | ---
-Disabled | Yes | No  | 0.2.0 | 0.5.0
+Disabled | Yes | No | 0.2.0 | 0.6.1
 
 No documentation
 
+### Configurable attributes
+
+Name | Default value | Configurable values
+--- | --- | ---
+Exclude | `db/migrate/*.rb` | Array
+
+## Sorbet/ForbidTUnsafe
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+--- | --- | --- | --- | ---
+Disabled | Yes | No | 0.7.0 | 0.7.0
+
+This cop disallows using `T.unsafe` anywhere.
+
+### Examples
+
+```ruby
+# bad
+T.unsafe(foo)
+
+# good
+foo
+```
+
 ## Sorbet/ForbidUntypedStructProps
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
 --- | --- | --- | --- | ---
-Enabled | Yes | No | 0.3.8 | -
+Enabled | Yes | No | 0.4.0 | -
 
 This cop disallows use of `T.untyped` or `T.nilable(T.untyped)`
 as a prop type for `T::Struct`.
@@ -227,6 +381,15 @@ Options:
 
 If a `MinimumStrictness` level is specified, it will be used in offense messages and autocorrect.
 
+### Configurable attributes
+
+Name | Default value | Configurable values
+--- | --- | ---
+SuggestedStrictness | `false` | String
+MinimumStrictness | `false` | String
+Include | `**/*.{rb,rbi,rake,ru}` | Array
+Exclude | `bin/**/*`, `db/**/*.rb`, `script/**/*` | Array
+
 ## Sorbet/IgnoreSigil
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
@@ -235,6 +398,14 @@ Disabled | Yes | Yes  | 0.3.3 | -
 
 This cop makes the Sorbet `ignore` sigil mandatory in all files.
 
+### Configurable attributes
+
+Name | Default value | Configurable values
+--- | --- | ---
+SuggestedStrictness | `ignore` | String
+Include | `**/*.{rb,rbi,rake,ru}` | Array
+Exclude | `bin/**/*`, `db/**/*.rb`, `script/**/*` | Array
+
 ## Sorbet/KeywordArgumentOrdering
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
@@ -258,26 +429,28 @@ sig { params(b: String, a: Integer).void }
 def foo(b:, a: 1); end
 ```
 
-## Sorbet/ParametersOrderingInSignature
+## Sorbet/OneAncestorPerLine
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
 --- | --- | --- | --- | ---
-Enabled | Yes | No | 0.2.0 | -
+Disabled | Yes | Yes  | 0.6.0 | -
 
-This cop checks for inconsistent ordering of parameters between the
-signature and the method definition. The sorbet-runtime gem raises
-when such inconsistency occurs.
+This cop ensures one ancestor per requires_ancestor line
+rather than chaining them as a comma-separated list.
 
 ### Examples
 
 ```ruby
 # bad
-sig { params(a: Integer, b: String).void }
-def foo(b:, a:); end
+module SomeModule
+  requires_ancestor Kernel, Minitest::Assertions
+end
 
 # good
-sig { params(a: Integer, b: String).void }
-def foo(a:, b:); end
+module SomeModule
+  requires_ancestor Kernel
+  requires_ancestor Minitest::Assertions
+end
 ```
 
 ## Sorbet/SignatureBuildOrder
@@ -298,6 +471,32 @@ Abstract cop specific to Sorbet signatures
 
 You can subclass it to use the `on_signature` trigger and the `signature?` node matcher.
 
+## Sorbet/SingleLineRbiClassModuleDefinitions
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+--- | --- | --- | --- | ---
+Disabled | Yes | Yes  | 0.6.0 | -
+
+This cop ensures empty class/module definitions in RBI files are
+done on a single line rather than being split across multiple lines.
+
+### Examples
+
+```ruby
+# bad
+module SomeModule
+end
+
+# good
+module SomeModule; end
+```
+
+### Configurable attributes
+
+Name | Default value | Configurable values
+--- | --- | ---
+Include | `**/*.rbi` | Array
+
 ## Sorbet/StrictSigil
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
@@ -306,6 +505,14 @@ Disabled | Yes | Yes  | 0.3.3 | -
 
 This cop makes the Sorbet `strict` sigil mandatory in all files.
 
+### Configurable attributes
+
+Name | Default value | Configurable values
+--- | --- | ---
+SuggestedStrictness | `strict` | String
+Include | `**/*.{rb,rbi,rake,ru}` | Array
+Exclude | `bin/**/*`, `db/**/*.rb`, `script/**/*` | Array
+
 ## Sorbet/StrongSigil
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
@@ -314,6 +521,14 @@ Disabled | Yes | Yes  | 0.3.3 | -
 
 This cop makes the Sorbet `strong` sigil mandatory in all files.
 
+### Configurable attributes
+
+Name | Default value | Configurable values
+--- | --- | ---
+SuggestedStrictness | `strong` | String
+Include | `**/*.{rb,rbi,rake,ru}` | Array
+Exclude | `bin/**/*`, `db/**/*.rb`, `script/**/*` | Array
+
 ## Sorbet/TrueSigil
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
@@ -322,6 +537,14 @@ Disabled | Yes | Yes  | 0.3.3 | -
 
 This cop makes the Sorbet `true` sigil mandatory in all files.
 
+### Configurable attributes
+
+Name | Default value | Configurable values
+--- | --- | ---
+SuggestedStrictness | `true` | String
+Include | `**/*.{rb,rbi,rake,ru}` | Array
+Exclude | `bin/**/*`, `db/**/*.rb`, `script/**/*` | Array
+
 ## Sorbet/ValidSigil
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
@@ -338,3 +561,13 @@ Options:
 * `MinimumStrictness`: If set, make offense if the strictness level in the file is below this one
 
 If a `MinimumStrictness` level is specified, it will be used in offense messages and autocorrect.
+
+### Configurable attributes
+
+Name | Default value | Configurable values
+--- | --- | ---
+RequireSigilOnAllFiles | `false` | Boolean
+SuggestedStrictness | `false` | String
+MinimumStrictness | `false` | String
+Include | `**/*.{rb,rbi,rake,ru}` | Array
+Exclude | `bin/**/*`, `db/**/*.rb`, `script/**/*` | Array

data/rubocop-sorbet.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency("rspec", "~> 3.7")
-  spec.add_development_dependency("unparser")
+  spec.add_development_dependency("unparser", "~> 0.6")
 
-  spec.add_runtime_dependency("rubocop")
+  spec.add_runtime_dependency("rubocop", ">= 0.90.0")
 end

data/service.yml

@@ -1,6 +1 @@
-# https://services.shopify.io/services/rubocop-sorbet/production
-owners:
-  - Shopify/sorbet
 classification: library
-slack_channels:
-  - help-ruby-typing