rubocop-sorbet 0.7.0 → 0.7.1

data/manual/cops_sorbet.md

@@ -6,10 +6,10 @@ Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChan
 --- | --- | --- | --- | ---
 Enabled | Yes | No | 0.2.0 | -
 
-This cop disallows using `.override(allow_incompatible: true)`.
+Disallows using `.override(allow_incompatible: true)`.
 Using `allow_incompatible` suggests a violation of the Liskov
 Substitution Principle, meaning that a subclass is not a valid
-subtype of it's superclass. This Cop prevents these design smells
+subtype of its superclass. This Cop prevents these design smells
 from occurring.
 
 ### Examples
@@ -28,7 +28,7 @@ Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChan
 --- | --- | --- | --- | ---
 Enabled | Yes | Yes  | 0.2.0 | -
 
-This cop disallows binding the return value of `T.any`, `T.all`, `T.enum`
+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`.
 
 ### Examples
@@ -47,7 +47,7 @@ Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChan
 --- | --- | --- | --- | ---
 Disabled | No | Yes  | 0.7.0 | -
 
-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
@@ -85,7 +85,7 @@ Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChan
 --- | --- | --- | --- | ---
 Enabled | Yes | No | 0.2.0 | -
 
-This cop disallows the usage of `checked(true)`. This usage could cause
+Disallows the usage of `checked(true)`. This usage could cause
 confusion; it could lead some people to believe that a method would be checked
 even if runtime checks have not been enabled on the class or globally.
 Additionally, in the event where checks are enabled, `checked(true)` would
@@ -107,7 +107,7 @@ Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChan
 --- | --- | --- | --- | ---
 Enabled | Yes | No | 0.2.0 | -
 
-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,
@@ -144,7 +144,7 @@ Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChan
 --- | --- | --- | --- | ---
 Enabled | Yes | Yes  | 0.7.0 | -
 
-This cop checks for blank lines after signatures.
+Checks for blank lines after signatures.
 
 It also suggests an autocorrect
 
@@ -167,7 +167,7 @@ Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChan
 --- | --- | --- | --- | ---
 Enabled | Yes | Yes  | 0.3.4 | -
 
-This cop checks that the Sorbet sigil comes as the first magic comment in the file.
+Checks that the Sorbet sigil comes as the first magic comment in the file.
 
 The expected order for magic comments is: (en)?coding, typed, warn_indent then frozen_string_literal.
 
@@ -196,7 +196,7 @@ Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChan
 --- | --- | --- | --- | ---
 Disabled | Yes | Yes  | 0.3.4 | -
 
-This cop checks that every method definition and attribute accessor has a Sorbet signature.
+Checks that every method definition and attribute accessor has a Sorbet signature.
 
 It also suggest an autocorrect with placeholders so the following code:
 
@@ -222,7 +222,7 @@ Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChan
 --- | --- | --- | --- | ---
 Enabled | Yes | Yes  | 0.7.0 | -
 
-This cop checks that there is only one Sorbet sigil in a given file
+Checks that there is only one Sorbet sigil in a given file
 
 For example, the following class with two sigils
 
@@ -249,7 +249,7 @@ Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChan
 --- | --- | --- | --- | ---
 Enabled | Yes | Yes  | 0.3.3 | -
 
-This cop makes the Sorbet `false` sigil mandatory in all files.
+Makes the Sorbet `false` sigil mandatory in all files.
 
 ### Configurable attributes
 
@@ -265,7 +265,7 @@ Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChan
 --- | --- | --- | --- | ---
 Enabled | Yes | Yes  | 0.6.0 | -
 
-This cop ensures RBI shims do not include a call to extend T::Sig
+Ensures RBI shims do not include a call to extend T::Sig
 or to extend T::Helpers
 
 ### Examples
@@ -299,7 +299,26 @@ Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChan
 --- | --- | --- | --- | ---
 Disabled | Yes | Yes  | 0.2.0 | 0.5.0
 
-No documentation
+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
+```
 
 ## Sorbet/ForbidRBIOutsideOfAllowedPaths
 
@@ -307,7 +326,7 @@ Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChan
 --- | --- | --- | --- | ---
 Enabled | Yes | No | 0.6.1 | -
 
-This cop makes sure that RBI files are always located under the defined allowed paths.
+Makes sure that RBI files are always located under the defined allowed paths.
 
 Options:
 
@@ -339,7 +358,24 @@ Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChan
 --- | --- | --- | --- | ---
 Disabled | Yes | No | 0.2.0 | 0.6.1
 
-No documentation
+Correct superclass `send` expressions by constant literals.
+
+Sorbet, the static checker, is not (yet) able to support constructs on the
+following form:
+
+```ruby
+class Foo < send_expr; end
+```
+
+Multiple occurences of this can be found in Shopify's code base like:
+
+```ruby
+class ShopScope < Component::TrustedIdScope[ShopIdentity::ShopId]
+```
+or
+```ruby
+class ApiClientEligibility < Struct.new(:api_client, :match_results, :shop)
+```
 
 ### Configurable attributes
 
@@ -353,7 +389,7 @@ Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChan
 --- | --- | --- | --- | ---
 Disabled | Yes | No | 0.7.0 | 0.7.0
 
-This cop disallows using `T.unsafe` anywhere.
+Disallows using `T.unsafe` anywhere.
 
 ### Examples
 
@@ -371,7 +407,7 @@ Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChan
 --- | --- | --- | --- | ---
 Disabled | Yes | No | 0.6.9 | 0.7.0
 
-This cop disallows using `T.untyped` anywhere.
+Disallows using `T.untyped` anywhere.
 
 ### Examples
 
@@ -391,7 +427,7 @@ Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChan
 --- | --- | --- | --- | ---
 Enabled | Yes | No | 0.4.0 | -
 
-This cop disallows use of `T.untyped` or `T.nilable(T.untyped)`
+Disallows use of `T.untyped` or `T.nilable(T.untyped)`
 as a prop type for `T::Struct` or `T::ImmutableStruct`.
 
 ### Examples
@@ -416,7 +452,7 @@ Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChan
 --- | --- | --- | --- | ---
 Disabled | Yes | Yes  | 0.3.3 | -
 
-This cop makes the Sorbet typed sigil mandatory in all files.
+Makes the Sorbet typed sigil mandatory in all files.
 
 Options:
 
@@ -430,7 +466,8 @@ If a `MinimumStrictness` level is specified, it will be used in offense messages
 Name | Default value | Configurable values
 --- | --- | ---
 SuggestedStrictness | `false` | String
-MinimumStrictness | `false` | String
+MinimumStrictness | `nil` | String
+ExactStrictness | `nil` | String
 Include | `**/*.{rb,rbi,rake,ru}` | Array
 Exclude | `bin/**/*`, `db/**/*.rb`, `script/**/*` | Array
 
@@ -440,7 +477,7 @@ Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChan
 --- | --- | --- | --- | ---
 Disabled | Yes | Yes  | 0.3.3 | -
 
-This cop makes the Sorbet `ignore` sigil mandatory in all files.
+Makes the Sorbet `ignore` sigil mandatory in all files.
 
 ### Configurable attributes
 
@@ -450,13 +487,42 @@ SuggestedStrictness | `ignore` | String
 Include | `**/*.{rb,rbi,rake,ru}` | Array
 Exclude | `bin/**/*`, `db/**/*.rb`, `script/**/*` | Array
 
+## Sorbet/ImplicitConversionMethod
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+--- | --- | --- | --- | ---
+Disabled | Yes | No | <<next>> | -
+
+Disallows declaring implicit conversion methods.
+Since Sorbet is a nominal (not structural) type system,
+implicit conversion is currently unsupported.
+
+### Examples
+
+```ruby
+# bad
+def to_str; end
+
+# good
+def to_str(x); end
+
+# bad
+def self.to_str; end
+
+# good
+def self.to_str(x); end
+
+# bad
+alias to_str to_s
+```
+
 ## Sorbet/KeywordArgumentOrdering
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
 --- | --- | --- | --- | ---
 Enabled | Yes | No | 0.2.0 | -
 
-This cop checks for the ordering of keyword arguments required by
+Checks for the ordering of keyword arguments required by
 sorbet-runtime. The ordering requires that all keyword arguments
 are at the end of the parameters list, and all keyword arguments
 with a default value must be after those without default values.
@@ -473,13 +539,50 @@ sig { params(b: String, a: Integer).void }
 def foo(b:, a: 1); end
 ```
 
+## Sorbet/ObsoleteStrictMemoization
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+--- | --- | --- | --- | ---
+Enabled | Yes | Yes  | 0.7.1 | -
+
+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
+
+### Examples
+
+```ruby
+# bad
+sig { returns(Foo) }
+def foo
+  @foo = T.let(@foo, T.nilable(Foo))
+  @foo ||= Foo.new
+end
+
+# bad
+sig { returns(Foo) }
+def foo
+  # This would have been a mistake, causing the memoized value to be discarded and recomputed on every call.
+  @foo = T.let(nil, T.nilable(Foo))
+  @foo ||= Foo.new
+end
+
+# good
+sig { returns(Foo) }
+def foo
+  @foo ||= T.let(Foo.new, T.nilable(Foo))
+end
+```
+
 ## Sorbet/OneAncestorPerLine
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
 --- | --- | --- | --- | ---
 Disabled | Yes | Yes  | 0.6.0 | -
 
-This cop ensures one ancestor per requires_ancestor line
+Ensures one ancestor per requires_ancestor line
 rather than chaining them as a comma-separated list.
 
 ### Examples
@@ -548,7 +651,7 @@ Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChan
 --- | --- | --- | --- | ---
 Disabled | Yes | Yes  | 0.6.0 | -
 
-This cop ensures empty class/module definitions in RBI files are
+Ensures empty class/module definitions in RBI files are
 done on a single line rather than being split across multiple lines.
 
 ### Examples
@@ -574,7 +677,7 @@ Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChan
 --- | --- | --- | --- | ---
 Disabled | Yes | Yes  | 0.3.3 | -
 
-This cop makes the Sorbet `strict` sigil mandatory in all files.
+Makes the Sorbet `strict` sigil mandatory in all files.
 
 ### Configurable attributes
 
@@ -590,7 +693,7 @@ Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChan
 --- | --- | --- | --- | ---
 Disabled | Yes | Yes  | 0.3.3 | -
 
-This cop makes the Sorbet `strong` sigil mandatory in all files.
+Makes the Sorbet `strong` sigil mandatory in all files.
 
 ### Configurable attributes
 
@@ -606,7 +709,7 @@ Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChan
 --- | --- | --- | --- | ---
 Disabled | Yes | Yes  | 0.3.3 | -
 
-This cop makes the Sorbet `true` sigil mandatory in all files.
+Makes the Sorbet `true` sigil mandatory in all files.
 
 ### Configurable attributes
 
@@ -622,7 +725,7 @@ Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChan
 --- | --- | --- | --- | ---
 Enabled | Yes | No | 0.6.6 | -
 
-This cop ensures all constants used as `T.type_alias` are using CamelCase.
+Ensures all constants used as `T.type_alias` are using CamelCase.
 
 ### Examples
 
@@ -647,7 +750,7 @@ Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChan
 --- | --- | --- | --- | ---
 Enabled | Yes | Yes  | 0.3.3 | -
 
-This cop checks that every Ruby file contains a valid Sorbet sigil.
+Checks that every Ruby file contains a valid Sorbet sigil.
 Adapted from: https://gist.github.com/clarkdave/85aca4e16f33fd52aceb6a0a29936e52
 
 Options:
@@ -655,8 +758,10 @@ Options:
 * `RequireSigilOnAllFiles`: make offense if the Sorbet typed is not found in the file (default: false)
 * `SuggestedStrictness`: Sorbet strictness level suggested in offense messages (default: 'false')
 * `MinimumStrictness`: If set, make offense if the strictness level in the file is below this one
+* `ExactStrictness`: If set, make offense if the strictness level in the file is different than this one
 
-If a `MinimumStrictness` level is specified, it will be used in offense messages and autocorrect.
+If an `ExactStrictness` level is specified, it will be used in offense messages and autocorrect.
+Otherwise, if a `MinimumStrictness` level is specified, it will be used in offense messages and autocorrect.
 
 ### Configurable attributes
 
@@ -664,6 +769,7 @@ Name | Default value | Configurable values
 --- | --- | ---
 RequireSigilOnAllFiles | `false` | Boolean
 SuggestedStrictness | `false` | String
-MinimumStrictness | `false` | String
+MinimumStrictness | `nil` | String
+ExactStrictness | `nil` | String
 Include | `**/*.{rb,rbi,rake,ru}` | Array
 Exclude | `bin/**/*`, `db/**/*.rb`, `script/**/*` | Array

data/rubocop-sorbet.gemspec

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative "lib/rubocop/sorbet/version"
 
 Gem::Specification.new do |spec|

data/tasks/cops_documentation.rake

@@ -46,12 +46,15 @@ task generate_cops_documentation: :yard_for_generate_documentation do
 
   def properties(config, cop)
     header = [
-      "Enabled by default", "Safe", "Supports autocorrection", "VersionAdded",
-      "VersionChanged"
+      "Enabled by default",
+      "Safe",
+      "Supports autocorrection",
+      "VersionAdded",
+      "VersionChanged",
     ]
     config = config.for_cop(cop)
     safe_auto_correct = config.fetch("SafeAutoCorrect", true)
-    autocorrect = if cop.new.support_autocorrect?
+    autocorrect = if cop.support_autocorrect?
       "Yes #{"(Unsafe)" unless safe_auto_correct}"
     else
       "No"
@@ -192,8 +195,16 @@ task generate_cops_documentation: :yard_for_generate_documentation do
 
   def print_cop_with_doc(cop, config)
     t = config.for_cop(cop)
-    non_display_keys = ["Description", "Enabled", "StyleGuide", "Reference", "Safe", "SafeAutoCorrect", "VersionAdded",
-                        "VersionChanged"]
+    non_display_keys = [
+      "Description",
+      "Enabled",
+      "StyleGuide",
+      "Reference",
+      "Safe",
+      "SafeAutoCorrect",
+      "VersionAdded",
+      "VersionChanged",
+    ]
     pars = t.reject { |k| non_display_keys.include?(k) }
     description = "No documentation"
     examples_object = []

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-sorbet
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Ufuk Kayserilioglu
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-02-03 00:00:00.000000000 Z
+date: 2023-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -71,6 +71,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- ".yardopts"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -85,7 +86,7 @@ files:
 - config/rbi.yml
 - dev.yml
 - lib/rubocop-sorbet.rb
-- lib/rubocop/cop/sorbet/binding_constants_without_type_alias.rb
+- lib/rubocop/cop/sorbet/binding_constant_without_type_alias.rb
 - lib/rubocop/cop/sorbet/callback_conditionals_binding.rb
 - lib/rubocop/cop/sorbet/constants_from_strings.rb
 - lib/rubocop/cop/sorbet/forbid_include_const_literal.rb
@@ -93,7 +94,10 @@ files:
 - lib/rubocop/cop/sorbet/forbid_t_unsafe.rb
 - lib/rubocop/cop/sorbet/forbid_t_untyped.rb
 - lib/rubocop/cop/sorbet/forbid_untyped_struct_props.rb
+- lib/rubocop/cop/sorbet/implicit_conversion_method.rb
+- lib/rubocop/cop/sorbet/mixin/target_sorbet_version.rb
 - lib/rubocop/cop/sorbet/mutable_constant_sorbet_aware_behaviour.rb
+- lib/rubocop/cop/sorbet/obsolete_strict_memoization.rb
 - lib/rubocop/cop/sorbet/one_ancestor_per_line.rb
 - 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
@@ -148,7 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.4.17
 signing_key: 
 specification_version: 4
 summary: Automatic Sorbet code style checking tool.

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

@@ -1,127 +0,0 @@
-# frozen_string_literal: true
-
-require "rubocop"
-
-module RuboCop
-  module Cop
-    module Sorbet
-      # This cop 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::Cop
-        def_node_matcher(:binding_unaliased_type?, <<-PATTERN)
-          (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)
-          (block
-            (send
-              (const nil? :T) :type_alias)
-              _
-              _
-          )
-        PATTERN
-
-        def_node_matcher(:using_deprecated_type_alias_syntax?, <<-PATTERN)
-          (
-            send
-            (const nil? :T)
-            :type_alias
-            _
-          )
-        PATTERN
-
-        def_node_matcher(:t_let?, <<-PATTERN)
-          (
-            send
-            (const nil? :T)
-            :let
-            _
-            _
-          )
-        PATTERN
-
-        def_node_matcher(:dynamic_type_creation_with_block?, <<-PATTERN)
-          (block
-            (send
-              const :new ...)
-              _
-              _
-          )
-        PATTERN
-
-        def_node_matcher(:generic_parameter_decl_call?, <<-PATTERN)
-          (
-            send nil? {:type_template :type_member} ...
-          )
-        PATTERN
-
-        def_node_matcher(:generic_parameter_decl_block_call?, <<-PATTERN)
-          (block
-            (send nil? {:type_template :type_member} ...) ...
-          )
-        PATTERN
-
-        def_node_search(:method_needing_aliasing_on_t?, <<-PATTERN)
-          (
-            send
-            (const nil? :T)
-            {:any :all :noreturn :class_of :untyped :nilable :self_type :enum :proc}
-             ...
-          )
-        PATTERN
-
-        def not_t_let?(node)
-          !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_call?(node) && !generic_parameter_decl_block_call?(node)
-        end
-
-        def not_nil?(node)
-          !node.nil?
-        end
-
-        def on_casgn(node)
-          return unless binding_unaliased_type?(node) && !using_type_alias?(node.children[2])
-          if using_deprecated_type_alias_syntax?(node.children[2])
-            add_offense(
-              node.children[2],
-              message: "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."
-            )
-            return
-          end
-          add_offense(
-            node.children[2],
-            message: "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`."
-          )
-        end
-
-        def autocorrect(node)
-          lambda do |corrector|
-            corrector.replace(
-              node.source_range,
-              "T.type_alias { #{node.source} }"
-            )
-          end
-        end
-      end
-    end
-  end
-end