rubocop-sorbet 0.10.4 → 0.10.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79bcbc5d5d2a20065dae6bd132ce89a78f6d55d913253f582d57b26dbc90e3fe
-  data.tar.gz: fc68fab55a25f15a2689564842768d87b2268ed99e8bdcf503284e47dd82deb2
+  metadata.gz: '086645a85b87da08958ff04471b05e238fbe14de8bc6108610bd20ca638f5ef7'
+  data.tar.gz: 24b4add23624df28a1019f528b0f24f5f87bf379ecca807d922b0220c65b09d0
 SHA512:
-  metadata.gz: 6b67f844675e5ca0c5f229cf8dd55e091f12c068dcaeb0cf289eded28a92367d32ead0f315ca4776bd0acd04e743c3c0420c345ac1ac6a7041f84dc61cc1fa78
-  data.tar.gz: ca77c4f1a29809ce05da20319309c760dff38fcf4adae09b60e4a588a24ca234a32c6a48226df8baa9eaa169b388953e4f65cb079a47d22f062924efdf3b9c3b
+  metadata.gz: 3fd16f332f9df0642787e8a60baa934611298a1487aabb3b84c05795764ce839dfb37001413f751bcd6a494c068220038941aaf972d36ebe0edf05315daa1fe2
+  data.tar.gz: 2d015fbdc34e4d4fcb8ba3ea60db28ec9a5af2e88efc78f258152b5cf0c1cb748c15f464b6bba2c596f24141bbb98b2a82d57afb49a3ed27a18901d11f68253b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop-sorbet (0.10.4)
+    rubocop-sorbet (0.10.5)
       lint_roller
       rubocop (>= 1.75.2)
 

data/VERSION

@@ -1 +1 @@
-0.10.3
+0.10.5

data/config/default.yml

@@ -82,7 +82,7 @@ Sorbet/EnforceSigilOrder:
 Sorbet/EnforceSignatures:
   Description: 'Ensures all methods have a valid signature.'
   Enabled: false
-  AllowRBS: false
+  Style: sig
   VersionAdded: 0.3.4
 
 Sorbet/EnforceSingleSigil:
@@ -174,32 +174,32 @@ Sorbet/ForbidTStruct:
 Sorbet/ForbidTAbsurd:
   Description: 'Forbid usage of T.absurd.'
   Enabled: false
-  VersionAdded: <<next>>
+  VersionAdded: 0.10.4
 
 Sorbet/ForbidTBind:
   Description: 'Forbid usage of T.bind.'
   Enabled: false
-  VersionAdded: <<next>>
+  VersionAdded: 0.10.4
 
 Sorbet/ForbidTCast:
   Description: 'Forbid usage of T.cast.'
   Enabled: false
-  VersionAdded: <<next>>
+  VersionAdded: 0.10.4
 
 Sorbet/ForbidTLet:
   Description: 'Forbid usage of T.let.'
   Enabled: false
-  VersionAdded: <<next>>
+  VersionAdded: 0.10.4
 
 Sorbet/ForbidTMust:
   Description: 'Forbid usage of T.must.'
   Enabled: false
-  VersionAdded: <<next>>
+  VersionAdded: 0.10.4
 
 Sorbet/ForbidTTypeAlias:
   Description: 'Forbid usage of T.type_alias.'
   Enabled: false
-  VersionAdded: <<next>>
+  VersionAdded: 0.10.4
 
 Sorbet/ForbidTUnsafe:
   Description: 'Forbid usage of T.unsafe.'

data/config/obsoletion.yml

@@ -6,3 +6,8 @@
 removed:
   Sorbet/OneAncestorPerLine:
     reason: '`require_ancestor` now takes a block instead of arguments'
+
+changed_parameters:
+  - cops: 'Sorbet/EnforceSignatures'
+    parameters: 'AllowRBS'
+    alternative: 'Style'

data/lib/rubocop/cop/sorbet/signatures/enforce_signatures.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "stringio"
-
 module RuboCop
   module Cop
     module Sorbet
@@ -24,16 +22,12 @@ module RuboCop
       #
       # * `ParameterTypePlaceholder`: placeholders used for parameter types (default: 'T.untyped')
       # * `ReturnTypePlaceholder`: placeholders used for return types (default: 'T.untyped')
+      # * `Style`: signature style to enforce - 'sig' for sig blocks, 'rbs' for RBS comments, 'both' to allow either (default: 'sig')
       class EnforceSignatures < ::RuboCop::Cop::Base
         extend AutoCorrector
         include SignatureHelp
 
-        RBS_COMMENT_REGEX = /^#:.*$/
-
-        def initialize(config = nil, options = nil)
-          super(config, options)
-          @last_sig_for_scope = {}
-        end
+        VALID_STYLES = ["sig", "rbs", "both"].freeze
 
         # @!method accessor?(node)
         def_node_matcher(:accessor?, <<-PATTERN)
@@ -53,7 +47,13 @@ module RuboCop
         end
 
         def on_signature(node)
-          @last_sig_for_scope[scope(node)] = node
+          sig_checker.on_signature(node, scope(node))
+        end
+
+        def on_new_investigation
+          super
+          @sig_checker = nil
+          @rbs_checker = nil
         end
 
         def scope(node)
@@ -67,48 +67,102 @@ module RuboCop
 
         def check_node(node)
           scope = self.scope(node)
-          unless @last_sig_for_scope[scope] || has_rbs_comment?(node)
-            add_offense(
-              node,
-              message: "Each method is required to have a signature.",
-            ) do |corrector|
-              autocorrect(corrector, node)
+          sig_node = sig_checker.signature_node(scope)
+          rbs_node = rbs_checker.signature_node(node)
+
+          case signature_style
+          when "rbs"
+            # RBS style - only RBS signatures allowed
+            if sig_node
+              add_offense(sig_node, message: "Use RBS signature comments rather than sig blocks.")
+              return
+            end
+
+            unless rbs_node
+              add_offense(node, message: "Each method is required to have an RBS signature.") do |corrector|
+                autocorrect_with_signature_type(corrector, node, "rbs")
+              end
+            end
+          when "both"
+            # Both styles allowed - require at least one
+            unless sig_node || rbs_node
+              add_offense(node, message: "Each method is required to have a signature.") do |corrector|
+                autocorrect_with_signature_type(corrector, node, "sig")
+              end
+            end
+          else # "sig" (default)
+            # Sig style - only sig signatures allowed
+            unless sig_node
+              add_offense(node, message: "Each method is required to have a sig block signature.") do |corrector|
+                autocorrect_with_signature_type(corrector, node, "sig")
+              end
             end
           end
-          @last_sig_for_scope[scope] = nil
+        ensure
+          sig_checker.clear_signature(scope)
         end
 
-        def has_rbs_comment?(node)
-          return false unless cop_config["AllowRBS"] == true
-
-          node = node.parent while RuboCop::AST::SendNode === node.parent
-          return false if (comments = preceeding_comments(node)).empty?
+        def sig_checker
+          @sig_checker ||= SigSignatureChecker.new(processed_source)
+        end
 
-          last_comment = comments.last
-          return false if last_comment.loc.line + 1 < node.loc.line
+        def rbs_checker
+          @rbs_checker ||= RBSSignatureChecker.new(processed_source)
+        end
 
-          comments.any? { |comment| RBS_COMMENT_REGEX.match?(comment.text) }
+        def autocorrect_with_signature_type(corrector, node, type)
+          suggest = create_signature_suggestion(node, type)
+          populate_signature_suggestion(suggest, node)
+          corrector.insert_before(node, suggest.to_autocorrect)
         end
 
-        def preceeding_comments(node)
-          processed_source.ast_with_comments[node].select { |comment| comment.loc.line < node.loc.line }
+        def create_signature_suggestion(node, type)
+          case type
+          when "rbs"
+            RBSSuggestion.new(node.loc.column)
+          else # "sig"
+            SigSuggestion.new(node.loc.column, param_type_placeholder, return_type_placeholder)
+          end
         end
 
-        def autocorrect(corrector, node)
-          suggest = SigSuggestion.new(node.loc.column, param_type_placeholder, return_type_placeholder)
+        def populate_signature_suggestion(suggest, node)
+          if node.any_def_type?
+            populate_method_definition_suggestion(suggest, node)
+          elsif accessor?(node)
+            populate_accessor_suggestion(suggest, node)
+          end
+        end
 
-          if node.is_a?(RuboCop::AST::DefNode) # def something
-            node.arguments.each do |arg|
+        def populate_method_definition_suggestion(suggest, node)
+          node.arguments.each do |arg|
+            if arg.blockarg_type? && suggest.respond_to?(:has_block=)
+              suggest.has_block = true
+            else
               suggest.params << arg.children.first
             end
-          elsif accessor?(node) # attr reader, writer, accessor
-            method = node.children[1]
-            symbol = node.children[2]
-            suggest.params << symbol.value if symbol && (method == :attr_writer || method == :attr_accessor)
-            suggest.returns = "void" if method == :attr_writer
           end
+        end
 
-          corrector.insert_before(node, suggest.to_autocorrect)
+        def populate_accessor_suggestion(suggest, node)
+          method = node.children[1]
+          symbol = node.children[2]
+
+          add_accessor_parameter_if_needed(suggest, symbol, method)
+          set_void_return_for_writer(suggest, method)
+        end
+
+        def add_accessor_parameter_if_needed(suggest, symbol, method)
+          return unless symbol && writer_or_accessor?(method)
+
+          suggest.params << symbol.value
+        end
+
+        def set_void_return_for_writer(suggest, method)
+          suggest.returns = "void" if method == :attr_writer
+        end
+
+        def writer_or_accessor?(method)
+          method == :attr_writer || method == :attr_accessor
         end
 
         def param_type_placeholder
@@ -119,6 +173,80 @@ module RuboCop
           cop_config["ReturnTypePlaceholder"] || "T.untyped"
         end
 
+        def allow_rbs?
+          cop_config["AllowRBS"] == true
+        end
+
+        def signature_style
+          config_value = cop_config["Style"]
+          if config_value
+            unless VALID_STYLES.include?(config_value)
+              raise ArgumentError, "Invalid Style option: '#{config_value}'. Valid options are: #{VALID_STYLES.join(", ")}"
+            end
+
+            return config_value
+          end
+
+          return "both" if allow_rbs?
+
+          "sig"
+        end
+
+        class SignatureChecker
+          def initialize(processed_source)
+            @processed_source = processed_source
+          end
+
+          protected
+
+          attr_reader :processed_source
+
+          def preceding_comments(node)
+            processed_source.ast_with_comments[node].select { |comment| comment.loc.line < node.loc.line }
+          end
+        end
+
+        class RBSSignatureChecker < SignatureChecker
+          RBS_COMMENT_REGEX = /^#\s*:.*$/
+
+          def signature_node(node)
+            node = find_non_send_ancestor(node)
+            comments = preceding_comments(node)
+            return if comments.empty?
+
+            last_comment = comments.last
+            return if last_comment.loc.line + 1 < node.loc.line
+
+            comments.find { |comment| RBS_COMMENT_REGEX.match?(comment.text) }
+          end
+
+          private
+
+          def find_non_send_ancestor(node)
+            node = node.parent while node.parent&.send_type?
+            node
+          end
+        end
+
+        class SigSignatureChecker < SignatureChecker
+          def initialize(processed_source)
+            super(processed_source)
+            @last_sig_for_scope = {}
+          end
+
+          def signature_node(scope)
+            @last_sig_for_scope[scope]
+          end
+
+          def on_signature(node, scope)
+            @last_sig_for_scope[scope] = node
+          end
+
+          def clear_signature(scope)
+            @last_sig_for_scope[scope] = nil
+          end
+        end
+
         class SigSuggestion
           attr_accessor :params, :returns
 
@@ -131,34 +259,59 @@ module RuboCop
           end
 
           def to_autocorrect
-            out = StringIO.new
-            out << "sig { "
-            out << generate_params
-            out << generate_return
-            out << " }\n"
-            out << " " * @indent # preserve indent for the next line
-            out.string
+            "sig { #{generate_params}#{generate_return} }\n#{" " * @indent}"
           end
 
           private
 
           def generate_params
-            return if @params.empty?
+            return "" if @params.empty?
 
-            out = StringIO.new
-            out << "params("
-            out << @params.map do |param|
-              "#{param}: #{@param_placeholder}"
-            end.join(", ")
-            out << ")."
-            out.string
+            param_list = @params.map { |param| "#{param}: #{@param_placeholder}" }.join(", ")
+            "params(#{param_list})."
           end
 
           def generate_return
-            return "returns(#{@return_placeholder})" if @returns.nil?
-            return @returns if @returns == "void"
+            if @returns.nil?
+              "returns(#{@return_placeholder})"
+            elsif @returns == "void"
+              "void"
+            else
+              "returns(#{@returns})"
+            end
+          end
+        end
+
+        class RBSSuggestion
+          attr_accessor :params, :returns, :has_block
+
+          def initialize(indent)
+            @params = []
+            @returns = nil
+            @has_block = false
+            @indent = indent
+          end
+
+          def to_autocorrect
+            "#: #{generate_signature}\n#{" " * @indent}"
+          end
+
+          private
+
+          def generate_signature
+            param_types = @params.map { "untyped" }.join(", ")
+            return_type = @returns || "untyped"
+
+            signature = if @params.empty?
+              "()"
+            else
+              "(#{param_types})"
+            end
+
+            signature += " { (?) -> untyped }" if @has_block
+            signature += " -> #{return_type}"
 
-            "returns(#{@returns})"
+            signature
           end
         end
       end

data/lib/rubocop/sorbet/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Sorbet
-    VERSION = "0.10.4"
+    VERSION = "0.10.5"
   end
 end

data/manual/cops_sorbet.md

@@ -331,12 +331,13 @@ 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')
+* `Style`: signature style to enforce - 'sig' for sig blocks, 'rbs' for RBS comments, 'both' to allow either (default: 'sig')
 
 ### Configurable attributes
 
 Name | Default value | Configurable values
 --- | --- | ---
-AllowRBS | `false` | Boolean
+Style | `sig` | String
 
 ## Sorbet/EnforceSingleSigil
 
@@ -636,7 +637,7 @@ Exclude | `db/migrate/*.rb` | Array
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
 --- | --- | --- | --- | ---
-Disabled | Yes | No | <<next>> | -
+Disabled | Yes | No | 0.10.4 | -
 
 Disallows using `T.absurd` anywhere.
 
@@ -654,7 +655,7 @@ x #: absurd
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
 --- | --- | --- | --- | ---
-Disabled | Yes | No | <<next>> | -
+Disabled | Yes | No | 0.10.4 | -
 
 Disallows using `T.bind` anywhere.
 
@@ -672,7 +673,7 @@ T.bind(self, Integer)
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
 --- | --- | --- | --- | ---
-Disabled | Yes | No | <<next>> | -
+Disabled | Yes | No | 0.10.4 | -
 
 Disallows using `T.cast` anywhere.
 
@@ -717,7 +718,7 @@ end
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
 --- | --- | --- | --- | ---
-Disabled | Yes | No | <<next>> | -
+Disabled | Yes | No | 0.10.4 | -
 
 Disallows using `T.let` anywhere.
 
@@ -735,7 +736,7 @@ foo #: Integer
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
 --- | --- | --- | --- | ---
-Disabled | Yes | No | <<next>> | -
+Disabled | Yes | No | 0.10.4 | -
 
 Disallows using `T.must` anywhere.
 
@@ -792,7 +793,7 @@ end
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
 --- | --- | --- | --- | ---
-Disabled | Yes | No | <<next>> | -
+Disabled | Yes | No | 0.10.4 | -
 
 Disallows using `T.type_alias` anywhere.
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-sorbet
 version: !ruby/object:Gem::Version
-  version: 0.10.4
+  version: 0.10.5
 platform: ruby
 authors:
 - Ufuk Kayserilioglu