rubocop-sorbet 0.7.3 → 0.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0c73cc4c4d3b4982d210699da94d0dca321a93bf95e98579dc32521714e2921
-  data.tar.gz: b9aa475dea9aa87511868680e92fb1ad5dff83a5b8186439179c17371eaf35f5
+  metadata.gz: d771dbc78b04c867bb517a024dacaf6d1c280539ebbd6950374a19fe9d89e439
+  data.tar.gz: 5310766358cdbfec15d154733f32769ab7320cf987798710a2c0f1dcd2fddceb
 SHA512:
-  metadata.gz: 03a722e469cf1796ba965b044475dabbbe2d99a6b0b79efc083d605bd8dd0973ed1d320dbe511241dd6bfad3c9df7acb6354217ded268db5939ad7f8bf7684aa
-  data.tar.gz: 9fd995f27b0881e5ec939da2b0b1a87372bc910faa4f27cbaf0de43c367d877e1c5b077397f80130ec58f1caa7b6047a7c51ea1eb0872f194f118ce27dbfa10d
+  metadata.gz: 2b0a1b42b4a1a368565d86ef69a335bc5345a562a892dcc930bd4786e1049c5d4cc018a762df22ffac6189aa68628d3c5f74cee147232f6eb9de62d21350d19b
+  data.tar.gz: 21d0d71d76975bb9204622b40a026fdc3c5c62105506ddfa293df0cf117e52d05e541a430290d045792208019a60ee824c9e8535d36a5d8f70f455abdbc42f89

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop-sorbet (0.7.3)
+    rubocop-sorbet (0.7.4)
       rubocop (>= 0.90.0)
 
 GEM

data/config/default.yml

@@ -97,6 +97,13 @@ Sorbet/ForbidSuperclassConstLiteral:
   Exclude:
   - db/migrate/*.rb
 
+Sorbet/ForbidTStruct:
+  Description: 'Forbid usage of T::Struct.'
+  Enabled: false
+  VersionAdded: <<next>>
+  VersionChanged: <<next>>
+  Safe: false
+
 Sorbet/ForbidTUnsafe:
   Description: 'Forbid usage of T.unsafe.'
   Enabled: false
@@ -171,6 +178,23 @@ Sorbet/ObsoleteStrictMemoization:
   Safe: true
   SafeAutoCorrect: true
 
+Sorbet/BuggyObsoleteStrictMemoization:
+  Description: >-
+    Checks for the a mistaken variant of the "obsolete memoization pattern" that used to be required
+    for older Sorbet versions in `#typed: strict` files. The mistaken variant would overwrite the ivar with `nil`
+    on every call, causing the memoized value to be discarded and recomputed on every call.
+    
+    This cop will correct it to read from the ivar instead of `nil`, which will memoize it correctly.
+    
+    The result of this correction will be the "obsolete memoization pattern", which can further be corrected by
+    the `Sorbet/ObsoleteStrictMemoization` cop.
+    
+    See `Sorbet/ObsoleteStrictMemoization` for more details.
+  Enabled: true
+  VersionAdded: '0.7.3'
+  Safe: true
+  SafeAutoCorrect: false
+
 Sorbet/OneAncestorPerLine:
   Description: 'Enforces one ancestor per call to requires_ancestor'
   Enabled: false

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

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+module RuboCop
+  module Cop
+    module Sorbet
+      # Checks for the a mistaken variant of the "obsolete memoization pattern" that used to be required
+      # for older Sorbet versions in `#typed: strict` files. The mistaken variant would overwrite the ivar with `nil`
+      # on every call, causing the memoized value to be discarded and recomputed on every call.
+      #
+      # This cop will correct it to read from the ivar instead of `nil`, which will memoize it correctly.
+      #
+      # The result of this correction will be the "obsolete memoization pattern", which can further be corrected by
+      # the `Sorbet/ObsoleteStrictMemoization` cop.
+      #
+      # See `Sorbet/ObsoleteStrictMemoization` for more details.
+      #
+      # @safety
+      #   If the computation being memoized had side effects, calling it only once (instead of once on every call
+      #   to the affected method) can be observed, and might be a breaking change.
+      #
+      # @example
+      #   # bad
+      #   sig { returns(Foo) }
+      #   def foo
+      #     # This `nil` is likely a mistake, causing the memoized value to be discarded and recomputed on every call.
+      #     @foo = T.let(nil, T.nilable(Foo))
+      #     @foo ||= some_computation
+      #   end
+      #
+      #   # good
+      #   sig { returns(Foo) }
+      #   def foo
+      #     # This will now memoize the value as was likely intended, so `some_computation` is only ever called once.
+      #     # ⚠️If `some_computation` has side effects, this might be a breaking change!
+      #     @foo = T.let(@foo, T.nilable(Foo))
+      #     @foo ||= some_computation
+      #   end
+      #
+      # @see Sorbet/ObsoleteStrictMemoization
+      class BuggyObsoleteStrictMemoization < RuboCop::Cop::Base
+        include RuboCop::Cop::MatchRange
+        include RuboCop::Cop::Alignment
+        include RuboCop::Cop::LineLengthHelp
+        include RuboCop::Cop::RangeHelp
+        extend AutoCorrector
+
+        include TargetSorbetVersion
+
+        MSG = "This might be a mistaken variant of the two-stage workaround that used to be needed for memoization in "\
+          "`#typed: strict` files. See https://sorbet.org/docs/type-assertions#put-type-assertions-behind-memoization."
+
+        # @!method buggy_legacy_memoization_pattern?(node)
+        def_node_matcher :buggy_legacy_memoization_pattern?, <<~PATTERN
+          (begin
+            ...                                                       # Ignore any other lines that come first.
+            (ivasgn $_ivar                                           # First line: @_ivar = ...
+              (send                                                   # T.let(_ivar, T.nilable(_ivar_type))
+                (const {nil? cbase} :T) :let
+                $nil
+                (send (const {nil? cbase} :T) :nilable _ivar_type))) # T.nilable(_ivar_type)
+            (or-asgn (ivasgn _ivar) _initialization_expr))          # Second line: @_ivar ||= _initialization_expr
+        PATTERN
+
+        def on_begin(node)
+          buggy_legacy_memoization_pattern?(node) do |ivar, nil_node|
+            add_offense(nil_node) do |corrector|
+              corrector.replace(
+                range_between(nil_node.source_range.begin_pos, nil_node.source_range.end_pos),
+                ivar,
+              )
+            end
+          end
+        end
+
+        def relevant_file?(file)
+          super && sorbet_enabled?
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,223 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+module RuboCop
+  module Cop
+    module Sorbet
+      # Disallow using `T::Struct` and `T::Props`.
+      #
+      # @example
+      #
+      #   # bad
+      #   class MyStruct < T::Struct
+      #     const :foo, String
+      #     prop :bar, Integer, default: 0
+      #
+      #     def some_method; end
+      #   end
+      #
+      #   # good
+      #   class MyStruct
+      #     extend T::Sig
+      #
+      #     sig { returns(String) }
+      #     attr_reader :foo
+      #
+      #     sig { returns(Integer) }
+      #     attr_accessor :bar
+      #
+      #     sig { params(foo: String, bar: Integer) }
+      #     def initialize(foo:, bar: 0)
+      #       @foo = foo
+      #       @bar = bar
+      #     end
+      #
+      #     def some_method; end
+      #   end
+      class ForbidTStruct < RuboCop::Cop::Base
+        include Alignment
+        include RangeHelp
+        include CommentsHelp
+        extend AutoCorrector
+
+        RESTRICT_ON_SEND = [:include, :prepend, :extend].freeze
+
+        MSG_STRUCT = "Using `T::Struct` or its variants is deprecated."
+        MSG_PROPS = "Using `T::Props` or its variants is deprecated."
+
+        # This class walks down the class body of a T::Struct and collects all the properties that will need to be
+        # translated into `attr_reader` and `attr_accessor` methods.
+        class TStructWalker
+          include AST::Traversal
+          extend AST::NodePattern::Macros
+
+          attr_reader :props, :has_extend_t_sig
+
+          def initialize
+            @props = []
+            @has_extend_t_sig = false
+          end
+
+          # @!method extend_t_sig?(node)
+          def_node_matcher :extend_t_sig?, <<~PATTERN
+            (send _ :extend (const (const {nil? | cbase} :T) :Sig))
+          PATTERN
+
+          # @!method t_struct_prop?(node)
+          def_node_matcher(:t_struct_prop?, <<~PATTERN)
+            (send nil? {:const :prop} ...)
+          PATTERN
+
+          def on_send(node)
+            if extend_t_sig?(node)
+              # So we know we won't need to generate again a `extend T::Sig` line in the new class body
+              @has_extend_t_sig = true
+              return
+            end
+
+            return unless t_struct_prop?(node)
+
+            kind = node.method?(:const) ? :attr_reader : :attr_accessor
+            name = node.arguments[0].source.delete_prefix(":")
+            type = node.arguments[1].source
+            default = nil
+            factory = nil
+
+            node.arguments[2..-1].each do |arg|
+              next unless arg.hash_type?
+
+              arg.each_pair do |key, value|
+                case key.source
+                when "default"
+                  default = value.source
+                when "factory"
+                  factory = value.source
+                end
+              end
+            end
+
+            @props << Property.new(node, kind, name, type, default: default, factory: factory)
+          end
+        end
+
+        class Property
+          attr_reader :node, :kind, :name, :type, :default, :factory
+
+          def initialize(node, kind, name, type, default:, factory:)
+            @node = node
+            @kind = kind
+            @name = name
+            @type = type
+            @default = default
+            @factory = factory
+
+            # A T::Struct should have both a default and a factory, if we find one let's raise an error
+            raise if @default && @factory
+          end
+
+          def attr_sig
+            "sig { returns(#{type}) }"
+          end
+
+          def attr_accessor
+            "#{kind} :#{name}"
+          end
+
+          def initialize_sig_param
+            "#{name}: #{type}"
+          end
+
+          def initialize_param
+            rb = String.new
+            rb << "#{name}:"
+            rb << " #{default}" if default
+            rb << " #{factory}" if factory
+            rb
+          end
+
+          def initialize_assign
+            rb = String.new
+            rb << "@#{name} = #{name}"
+            rb << ".call" if factory
+            rb
+          end
+        end
+
+        # @!method t_struct?(node)
+        def_node_matcher(:t_struct?, <<~PATTERN)
+          (const (const {nil? cbase} :T) {:Struct :ImmutableStruct :InexactStruct})
+        PATTERN
+
+        # @!method t_props?(node)
+        def_node_matcher(:t_props?, "(send nil? {:include :prepend :extend} `(const (const {nil? cbase} :T) :Props))")
+
+        def on_class(node)
+          return unless t_struct?(node.parent_class)
+
+          add_offense(node, message: MSG_STRUCT) do |corrector|
+            walker = TStructWalker.new
+            walker.walk(node.body)
+
+            range = range_between(node.identifier.source_range.end_pos, node.parent_class.source_range.end_pos)
+            corrector.remove(range)
+            next if node.single_line?
+
+            unless walker.has_extend_t_sig
+              indent = offset(node)
+              corrector.insert_after(node.identifier, "\n#{indent}  extend T::Sig\n")
+            end
+
+            first_prop = walker.props.first
+            walker.props.each do |prop|
+              node = prop.node
+              indent = offset(node)
+              line_range = range_by_whole_lines(prop.node.source_range)
+              new_line = prop != first_prop && !previous_line_blank?(node)
+              trailing_comments = processed_source.each_comment_in_lines(line_range.line..line_range.line)
+
+              corrector.replace(
+                line_range,
+                "#{new_line ? "\n" : ""}" \
+                  "#{trailing_comments.map { |comment| "#{indent}#{comment.text}\n" }.join}" \
+                  "#{indent}#{prop.attr_sig}\n#{indent}#{prop.attr_accessor}",
+              )
+            end
+
+            last_prop = walker.props.last
+            if last_prop
+              indent = offset(last_prop.node)
+              line_range = range_by_whole_lines(last_prop.node.source_range, include_final_newline: true)
+              corrector.insert_after(line_range, initialize_method(indent, walker.props))
+            end
+          end
+        end
+
+        def on_send(node)
+          return unless t_props?(node)
+
+          add_offense(node, message: MSG_PROPS)
+        end
+
+        private
+
+        def initialize_method(indent, props)
+          # We sort optional keyword arguments after required ones
+          props = props.sort_by { |prop| prop.default || prop.factory ? 1 : 0 }
+
+          string = +"\n"
+          string << "#{indent}sig { params(#{props.map(&:initialize_sig_param).join(", ")}).void }\n"
+          string << "#{indent}def initialize(#{props.map(&:initialize_param).join(", ")})\n"
+          props.each do |prop|
+            string << "#{indent}  #{prop.initialize_assign}\n"
+          end
+          string << "#{indent}end\n"
+        end
+
+        def previous_line_blank?(node)
+          processed_source.buffer.source_line(node.source_range.line - 1).blank?
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/sorbet/mixin/target_sorbet_version.rb

@@ -11,21 +11,25 @@ module RuboCop
         end
 
         module ClassMethods
-          # The version of the Sorbet static type checker required by this cop
+          # Sets the version of the Sorbet static type checker required by this cop
           def minimum_target_sorbet_static_version(version)
             @minimum_target_sorbet_static_version = Gem::Version.new(version)
           end
 
-          def support_target_sorbet_static_version?(version)
+          def supports_target_sorbet_static_version?(version)
             @minimum_target_sorbet_static_version <= Gem::Version.new(version)
           end
         end
 
+        def sorbet_enabled?
+          !target_sorbet_static_version_from_bundler_lock_file.nil?
+        end
+
         def enabled_for_sorbet_static_version?
           sorbet_static_version = target_sorbet_static_version_from_bundler_lock_file
           return false unless sorbet_static_version
 
-          self.class.support_target_sorbet_static_version?(sorbet_static_version)
+          self.class.supports_target_sorbet_static_version?(sorbet_static_version)
         end
 
         def target_sorbet_static_version_from_bundler_lock_file

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

@@ -54,7 +54,7 @@ module RuboCop
             $(ivasgn $_ivar                                           # First line: @_ivar = ...
               (send                                                   # T.let(_ivar, T.nilable(_ivar_type))
                 $(const {nil? cbase} :T) :let
-                {(ivar _ivar) nil}
+                (ivar _ivar)
                 (send (const {nil? cbase} :T) :nilable $_ivar_type))) # T.nilable(_ivar_type)
             $(or-asgn (ivasgn _ivar) $_initialization_expr))          # Second line: @_ivar ||= _initialization_expr
         PATTERN

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

@@ -26,6 +26,7 @@ module RuboCop
       #   end
       #
       class RedundantExtendTSig < RuboCop::Cop::Base
+        include RangeHelp
         extend AutoCorrector
 
         MSG = "Do not redundantly `extend T::Sig` when it is already included in all modules."
@@ -40,7 +41,7 @@ module RuboCop
           return unless extend_t_sig?(node)
 
           add_offense(node) do |corrector|
-            corrector.remove(node)
+            corrector.remove(range_by_whole_lines(node.source_range, include_final_newline: true))
           end
         end
       end

data/lib/rubocop/cop/sorbet_cops.rb

@@ -10,11 +10,13 @@ require_relative "sorbet/forbid_untyped_struct_props"
 require_relative "sorbet/implicit_conversion_method"
 require_relative "sorbet/one_ancestor_per_line"
 require_relative "sorbet/callback_conditionals_binding"
+require_relative "sorbet/forbid_t_struct"
 require_relative "sorbet/forbid_t_unsafe"
 require_relative "sorbet/forbid_t_untyped"
 require_relative "sorbet/redundant_extend_t_sig"
 require_relative "sorbet/type_alias_name"
 require_relative "sorbet/obsolete_strict_memoization"
+require_relative "sorbet/buggy_obsolete_strict_memoization"
 
 require_relative "sorbet/rbi/forbid_extend_t_sig_helpers_in_shims"
 require_relative "sorbet/rbi/forbid_rbi_outside_of_allowed_paths"

data/lib/rubocop/sorbet/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Sorbet
-    VERSION = "0.7.3"
+    VERSION = "0.7.4"
   end
 end

data/manual/cops.md

@@ -7,6 +7,7 @@ In the following section you find all available cops:
 
 * [Sorbet/AllowIncompatibleOverride](cops_sorbet.md#sorbetallowincompatibleoverride)
 * [Sorbet/BindingConstantWithoutTypeAlias](cops_sorbet.md#sorbetbindingconstantwithouttypealias)
+* [Sorbet/BuggyObsoleteStrictMemoization](cops_sorbet.md#sorbetbuggyobsoletestrictmemoization)
 * [Sorbet/CallbackConditionalsBinding](cops_sorbet.md#sorbetcallbackconditionalsbinding)
 * [Sorbet/CheckedTrueInSignature](cops_sorbet.md#sorbetcheckedtrueinsignature)
 * [Sorbet/ConstantsFromStrings](cops_sorbet.md#sorbetconstantsfromstrings)
@@ -19,6 +20,7 @@ In the following section you find all available cops:
 * [Sorbet/ForbidIncludeConstLiteral](cops_sorbet.md#sorbetforbidincludeconstliteral)
 * [Sorbet/ForbidRBIOutsideOfAllowedPaths](cops_sorbet.md#sorbetforbidrbioutsideofallowedpaths)
 * [Sorbet/ForbidSuperclassConstLiteral](cops_sorbet.md#sorbetforbidsuperclassconstliteral)
+* [Sorbet/ForbidTStruct](cops_sorbet.md#sorbetforbidtstruct)
 * [Sorbet/ForbidTUnsafe](cops_sorbet.md#sorbetforbidtunsafe)
 * [Sorbet/ForbidTUntyped](cops_sorbet.md#sorbetforbidtuntyped)
 * [Sorbet/ForbidUntypedStructProps](cops_sorbet.md#sorbetforbiduntypedstructprops)

data/manual/cops_sorbet.md

@@ -41,6 +41,44 @@ FooOrBar = T.any(Foo, Bar)
 FooOrBar = T.type_alias { T.any(Foo, Bar) }
 ```
 
+## Sorbet/BuggyObsoleteStrictMemoization
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+--- | --- | --- | --- | ---
+Enabled | Yes | Yes (Unsafe) | 0.7.3 | -
+
+Checks for the a mistaken variant of the "obsolete memoization pattern" that used to be required
+for older Sorbet versions in `#typed: strict` files. The mistaken variant would overwrite the ivar with `nil`
+on every call, causing the memoized value to be discarded and recomputed on every call.
+
+This cop will correct it to read from the ivar instead of `nil`, which will memoize it correctly.
+
+The result of this correction will be the "obsolete memoization pattern", which can further be corrected by
+the `Sorbet/ObsoleteStrictMemoization` cop.
+
+See `Sorbet/ObsoleteStrictMemoization` for more details.
+
+### Examples
+
+```ruby
+# bad
+sig { returns(Foo) }
+def foo
+  # This `nil` is likely a mistake, causing the memoized value to be discarded and recomputed on every call.
+  @foo = T.let(nil, T.nilable(Foo))
+  @foo ||= some_computation
+end
+
+# good
+sig { returns(Foo) }
+def foo
+  # This will now memoize the value as was likely intended, so `some_computation` is only ever called once.
+  # ⚠️If `some_computation` has side effects, this might be a breaking change!
+  @foo = T.let(@foo, T.nilable(Foo))
+  @foo ||= some_computation
+end
+```
+
 ## Sorbet/CallbackConditionalsBinding
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
@@ -383,6 +421,45 @@ Name | Default value | Configurable values
 --- | --- | ---
 Exclude | `db/migrate/*.rb` | Array
 
+## Sorbet/ForbidTStruct
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+--- | --- | --- | --- | ---
+Disabled | No | Yes  | <<next>> | <<next>>
+
+Disallow using `T::Struct` and `T::Props`.
+
+### Examples
+
+```ruby
+# bad
+class MyStruct < T::Struct
+  const :foo, String
+  prop :bar, Integer, default: 0
+
+  def some_method; end
+end
+
+# good
+class MyStruct
+  extend T::Sig
+
+  sig { returns(String) }
+  attr_reader :foo
+
+  sig { returns(Integer) }
+  attr_accessor :bar
+
+  sig { params(foo: String, bar: Integer) }
+  def initialize(foo:, bar: 0)
+    @foo = foo
+    @bar = bar
+  end
+
+  def some_method; end
+end
+```
+
 ## Sorbet/ForbidTUnsafe
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-sorbet
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.7.4
 platform: ruby
 authors:
 - Ufuk Kayserilioglu
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-08-16 00:00:00.000000000 Z
+date: 2023-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -87,10 +87,12 @@ files:
 - dev.yml
 - lib/rubocop-sorbet.rb
 - lib/rubocop/cop/sorbet/binding_constant_without_type_alias.rb
+- lib/rubocop/cop/sorbet/buggy_obsolete_strict_memoization.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
 - lib/rubocop/cop/sorbet/forbid_superclass_const_literal.rb
+- lib/rubocop/cop/sorbet/forbid_t_struct.rb
 - 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
@@ -152,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.18
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: Automatic Sorbet code style checking tool.