rubocop-sorbet 0.5.1 → 0.6.3

data/lib/rubocop/cop/sorbet/rbi/forbid_rbi_outside_of_allowed_paths.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Sorbet
+      # 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/**"])
+      #
+      # @example
+      #   # bad
+      #   # lib/some_file.rbi
+      #   # other_file.rbi
+      #
+      #   # good
+      #   # sorbet/rbi/some_file.rbi
+      #   # sorbet/rbi/any/path/for/file.rbi
+      class ForbidRBIOutsideOfAllowedPaths < RuboCop::Cop::Cop
+        include RangeHelp
+
+        def investigate(processed_source)
+          add_offense(
+            nil,
+            location: source_range(processed_source.buffer, 1, 0),
+            message: message
+          ) if allowed_paths.none? { |pattern| File.fnmatch(pattern, processed_source.file_path) }
+        end
+
+        private
+
+        def allowed_paths
+          cop_config["AllowedPaths"]&.compact || []
+        end
+
+        def message
+          if allowed_paths.empty?
+            "RBI files should be located in an allowed path, but AllowedPaths is empty or nil"
+          else
+            "RBI file path should match one of: #{allowed_paths.join(", ")}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/sorbet/rbi/single_line_rbi_class_module_definitions.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Sorbet
+      # This cop ensures empty class/module definitions in RBI files are
+      # done on a single line rather than being split across multiple lines.
+      #
+      # @example
+      #
+      #   # bad
+      #   module SomeModule
+      #   end
+      #
+      #   # good
+      #   module SomeModule; end
+      class SingleLineRbiClassModuleDefinitions < RuboCop::Cop::Cop
+        MSG = "Empty class/module definitions in RBI files should be on a single line."
+
+        def on_module(node)
+          process_node(node)
+        end
+
+        def on_class(node)
+          process_node(node)
+        end
+
+        def autocorrect(node)
+          -> (corrector) { corrector.replace(node, convert_newlines(node.source)) }
+        end
+
+        protected
+
+        def convert_newlines(source)
+          source.sub(/[\r\n]+\s*[\r\n]*/, "; ")
+        end
+
+        def process_node(node)
+          return if node.body
+          return if node.single_line?
+          add_offense(node)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/sorbet/sigils/enforce_sigil_order.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'rubocop'
+require "rubocop"
 
 module RuboCop
   module Cop
@@ -69,10 +69,10 @@ module RuboCop
         FROZEN_REGEX = /#\s+frozen_string_literal:(?:\s+([\w]+))?/
 
         PREFERRED_ORDER = {
-          CODING_REGEX => 'encoding',
-          SIGIL_REGEX => 'typed',
-          INDENT_REGEX => 'warn_indent',
-          FROZEN_REGEX => 'frozen_string_literal',
+          CODING_REGEX => "encoding",
+          SIGIL_REGEX => "typed",
+          INDENT_REGEX => "warn_indent",
+          FROZEN_REGEX => "frozen_string_literal",
         }.freeze
 
         MAGIC_REGEX = Regexp.union(*PREFERRED_ORDER.keys)
@@ -104,7 +104,7 @@ module RuboCop
               add_offense(
                 token,
                 location: token.pos,
-                message: "Magic comments should be in the following order: #{PREFERRED_ORDER.values.join(', ')}."
+                message: "Magic comments should be in the following order: #{PREFERRED_ORDER.values.join(", ")}."
               )
             end
           end

data/lib/rubocop/cop/sorbet/sigils/enforce_single_sigil.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Sorbet
+      # 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.
+      class EnforceSingleSigil < ValidSigil
+        include RangeHelp
+
+        def investigate(processed_source)
+          return if processed_source.tokens.empty?
+          sigils = extract_all_sigils(processed_source)
+          return unless sigils.size > 1
+
+          sigils[1..sigils.size].each do |token|
+            add_offense(token, location: token.pos, message: "Files must only contain one sigil")
+          end
+        end
+
+        def autocorrect(_node)
+          -> (corrector) do
+            sigils = extract_all_sigils(processed_source)
+            return unless sigils.size > 1
+
+            # The first sigil encountered represents the "real" strictness so remove any below
+            sigils[1..sigils.size].each do |token|
+              corrector.remove(
+                source_range(processed_source.buffer, token.line, (0..token.pos.last_column))
+              )
+            end
+          end
+        end
+
+        protected
+
+        def extract_all_sigils(processed_source)
+          processed_source.tokens
+            .take_while { |token| token.type == :tCOMMENT }
+            .find_all { |token| SIGIL_REGEX.match?(token.text) }
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/sorbet/sigils/false_sigil.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'rubocop'
-require_relative 'has_sigil'
+require "rubocop"
+require_relative "has_sigil"
 
 module RuboCop
   module Cop
@@ -9,7 +9,7 @@ module RuboCop
       # This cop makes the Sorbet `false` sigil mandatory in all files.
       class FalseSigil < HasSigil
         def minimum_strictness
-          'false'
+          "false"
         end
       end
     end

data/lib/rubocop/cop/sorbet/sigils/has_sigil.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'rubocop'
-require_relative 'valid_sigil'
+require "rubocop"
+require_relative "valid_sigil"
 
 module RuboCop
   module Cop

data/lib/rubocop/cop/sorbet/sigils/ignore_sigil.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'rubocop'
-require_relative 'has_sigil'
+require "rubocop"
+require_relative "has_sigil"
 
 module RuboCop
   module Cop
@@ -9,7 +9,7 @@ module RuboCop
       # This cop makes the Sorbet `ignore` sigil mandatory in all files.
       class IgnoreSigil < HasSigil
         def minimum_strictness
-          'ignore'
+          "ignore"
         end
       end
     end

data/lib/rubocop/cop/sorbet/sigils/strict_sigil.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'rubocop'
-require_relative 'has_sigil'
+require "rubocop"
+require_relative "has_sigil"
 
 module RuboCop
   module Cop
@@ -9,7 +9,7 @@ module RuboCop
       # This cop makes the Sorbet `strict` sigil mandatory in all files.
       class StrictSigil < HasSigil
         def minimum_strictness
-          'strict'
+          "strict"
         end
       end
     end

data/lib/rubocop/cop/sorbet/sigils/strong_sigil.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'rubocop'
-require_relative 'has_sigil'
+require "rubocop"
+require_relative "has_sigil"
 
 module RuboCop
   module Cop
@@ -9,7 +9,7 @@ module RuboCop
       # This cop makes the Sorbet `strong` sigil mandatory in all files.
       class StrongSigil < HasSigil
         def minimum_strictness
-          'strong'
+          "strong"
         end
       end
     end

data/lib/rubocop/cop/sorbet/sigils/true_sigil.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'rubocop'
-require_relative 'has_sigil'
+require "rubocop"
+require_relative "has_sigil"
 
 module RuboCop
   module Cop
@@ -9,7 +9,7 @@ module RuboCop
       # This cop makes the Sorbet `true` sigil mandatory in all files.
       class TrueSigil < HasSigil
         def minimum_strictness
-          'true'
+          "true"
         end
       end
     end

data/lib/rubocop/cop/sorbet/sigils/valid_sigil.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'rubocop'
+require "rubocop"
 
 module RuboCop
   module Cop
@@ -48,7 +48,7 @@ module RuboCop
 
         protected
 
-        STRICTNESS_LEVELS = %w(ignore false true strict strong)
+        STRICTNESS_LEVELS = ["ignore", "false", "true", "strict", "strong"]
         SIGIL_REGEX = /#\s+typed:(?:\s+([\w]+))?/
 
         # extraction
@@ -74,7 +74,7 @@ module RuboCop
             add_offense(
               token,
               location: token.pos,
-              message: 'No Sorbet sigil found in file. ' \
+              message: "No Sorbet sigil found in file. " \
                 "Try a `typed: #{strictness}` to start (you can also use `rubocop -a` to automatically add this)."
             )
           end
@@ -87,7 +87,7 @@ module RuboCop
           return suggested_strictness unless minimum_strictness
 
           # special case: if you're using Sorbet/IgnoreSigil without config, we should recommend `ignore`
-          return "ignore" if minimum_strictness == "ignore" && cop_config['SuggestedStrictness'].nil?
+          return "ignore" if minimum_strictness == "ignore" && cop_config["SuggestedStrictness"].nil?
 
           # if a minimum strictness is set (eg. you're using Sorbet/FalseSigil)
           # we want to compare the minimum strictness and suggested strictness. this is because
@@ -106,7 +106,7 @@ module RuboCop
           add_offense(
             sigil,
             location: sigil.pos,
-            message: 'Sorbet sigil should not be empty.'
+            message: "Sorbet sigil should not be empty."
           )
           false
         end
@@ -142,17 +142,19 @@ module RuboCop
 
         # Default is `false`
         def require_sigil_on_all_files?
-          !!cop_config['RequireSigilOnAllFiles']
+          !!cop_config["RequireSigilOnAllFiles"]
         end
 
         # Default is `'false'`
         def suggested_strictness
-          STRICTNESS_LEVELS.include?(cop_config['SuggestedStrictness']) ? cop_config['SuggestedStrictness'] : 'false'
+          config = cop_config["SuggestedStrictness"].to_s
+          STRICTNESS_LEVELS.include?(config) ? config : "false"
         end
 
         # Default is `nil`
         def minimum_strictness
-          cop_config['MinimumStrictness'] if STRICTNESS_LEVELS.include?(cop_config['MinimumStrictness'])
+          config = cop_config["MinimumStrictness"].to_s
+          config if STRICTNESS_LEVELS.include?(config)
         end
       end
     end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'rubocop'
+require "rubocop"
 
 module RuboCop
   module Cop
@@ -49,8 +49,8 @@ module RuboCop
           return unless allow_incompatible_override?(node)
           add_offense(
             node.children[2],
-            message: 'Usage of `allow_incompatible` suggests a violation of the Liskov Substitution Principle. '\
-            'Instead, strive to write interfaces which respect subtyping principles and remove `allow_incompatible`',
+            message: "Usage of `allow_incompatible` suggests a violation of the Liskov Substitution Principle. "\
+            "Instead, strive to write interfaces which respect subtyping principles and remove `allow_incompatible`",
           )
         end
       end

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'rubocop'
-require_relative 'signature_cop'
+require "rubocop"
+require_relative "signature_cop"
 
 module RuboCop
   module Cop
@@ -27,10 +27,10 @@ module RuboCop
         PATTERN
 
         MESSAGE =
-          'Using `checked(true)` in a method signature definition is not allowed. ' \
-            '`checked(true)` is the default behavior for modules/classes with runtime checks enabled. ' \
-            'To enable typechecking at runtime for this module, regardless of global settings, ' \
-            '`include(WaffleCone::RuntimeChecks)` to this module and set other methods to `checked(false)`.'
+          "Using `checked(true)` in a method signature definition is not allowed. " \
+            "`checked(true)` is the default behavior for modules/classes with runtime checks enabled. " \
+            "To enable typechecking at runtime for this module, regardless of global settings, " \
+            "`include(WaffleCone::RuntimeChecks)` to this module and set other methods to `checked(false)`."
         private_constant(:MESSAGE)
 
         def on_signature(node)

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

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'rubocop'
-require 'stringio'
-require_relative 'signature_cop'
+require "rubocop"
+require "stringio"
+require_relative "signature_cop"
 
 module RuboCop
   module Cop
@@ -27,6 +27,11 @@ module RuboCop
       # * `ParameterTypePlaceholder`: placeholders used for parameter types (default: 'T.untyped')
       # * `ReturnTypePlaceholder`: placeholders used for return types (default: 'T.untyped')
       class EnforceSignatures < SignatureCop
+        def initialize(config = nil, options = nil)
+          super(config, options)
+          @last_sig_for_scope = {}
+        end
+
         def_node_matcher(:accessor?, <<-PATTERN)
           (send nil? {:attr_reader :attr_writer :attr_accessor} ...)
         PATTERN
@@ -40,8 +45,11 @@ module RuboCop
         end
 
         def on_send(node)
-          return unless accessor?(node)
-          check_node(node)
+          check_node(node) if accessor?(node)
+        end
+
+        def on_signature(node)
+          @last_sig_for_scope[scope(node)] = node
         end
 
         def autocorrect(node)
@@ -56,37 +64,38 @@ module RuboCop
               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
+              suggest.returns = "void" if method == :attr_writer
             end
 
             corrector.insert_before(node.loc.expression, suggest.to_autocorrect)
           end
         end
 
+        def scope(node)
+          return nil unless node.parent
+          return node.parent if [:begin, :block, :class, :module].include?(node.parent.type)
+          scope(node.parent)
+        end
+
         private
 
         def check_node(node)
-          prev = previous_node(node)
-          unless signature?(prev)
+          scope = self.scope(node)
+          unless @last_sig_for_scope[scope]
             add_offense(
               node,
               message: "Each method is required to have a signature."
             )
           end
-        end
-
-        def previous_node(node)
-          parent = node.parent
-          return nil unless parent
-          parent.children[node.sibling_index - 1]
+          @last_sig_for_scope[scope] = nil
         end
 
         def param_type_placeholder
-          cop_config['ParameterTypePlaceholder'] || 'T.untyped'
+          cop_config["ParameterTypePlaceholder"] || "T.untyped"
         end
 
         def return_type_placeholder
-          cop_config['ReturnTypePlaceholder'] || 'T.untyped'
+          cop_config["ReturnTypePlaceholder"] || "T.untyped"
         end
 
         class SigSuggestion
@@ -102,11 +111,11 @@ module RuboCop
 
           def to_autocorrect
             out = StringIO.new
-            out << 'sig { '
+            out << "sig { "
             out << generate_params
             out << generate_return
             out << " }\n"
-            out << ' ' * @indent # preserve indent for the next line
+            out << " " * @indent # preserve indent for the next line
             out.string
           end
 
@@ -115,17 +124,17 @@ module RuboCop
           def generate_params
             return if @params.empty?
             out = StringIO.new
-            out << 'params('
+            out << "params("
             out << @params.map do |param|
               "#{param}: #{@param_placeholder}"
             end.join(", ")
-            out << ').'
+            out << ")."
             out.string
           end
 
           def generate_return
             return "returns(#{@return_placeholder})" if @returns.nil?
-            return @returns if @returns == 'void'
+            return @returns if @returns == "void"
             "returns(#{@returns})"
           end
         end

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'rubocop'
-require_relative 'signature_cop'
+require "rubocop"
+require_relative "signature_cop"
 
 module RuboCop
   module Cop
@@ -41,7 +41,7 @@ module RuboCop
 
             add_offense(
               param,
-              message: 'Optional keyword arguments must be at the end of the parameter list.'
+              message: "Optional keyword arguments must be at the end of the parameter list."
             )
           end
         end

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

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require 'rubocop'
-require_relative 'signature_cop'
+require "rubocop"
+require_relative "signature_cop"
 
 begin
-  require 'unparser'
+  require "unparser"
 rescue LoadError
   nil
 end
@@ -28,7 +28,7 @@ module RuboCop
           ].each_with_index.to_h.freeze
 
         def_node_search(:root_call, <<~PATTERN)
-          (send nil? {#{ORDER.keys.map(&:inspect).join(' ')}} ...)
+          (send nil? {#{ORDER.keys.map(&:inspect).join(" ")}} ...)
         PATTERN
 
         def on_signature(node)
@@ -38,10 +38,10 @@ module RuboCop
           expected_order = calls.sort_by { |call| ORDER[call] }
           return if expected_order == calls
 
-          message = "Sig builders must be invoked in the following order: #{expected_order.join(', ')}."
+          message = "Sig builders must be invoked in the following order: #{expected_order.join(", ")}."
 
           unless can_autocorrect?
-            message += ' For autocorrection, add the `unparser` gem to your project.'
+            message += " For autocorrection, add the `unparser` gem to your project."
           end
 
           add_offense(
@@ -55,7 +55,7 @@ module RuboCop
           return nil unless can_autocorrect?
 
           lambda do |corrector|
-            tree = call_chain(node_with_index_sends(node))
+            tree = call_chain(node_reparsed_with_modern_features(node))
               .sort_by { |call| ORDER[call.method_name] }
               .reduce(nil) do |receiver, caller|
                 caller.updated(nil, [receiver] + caller.children.drop(1))
@@ -68,16 +68,25 @@ module RuboCop
           end
         end
 
+        # Create a subclass of AST Builder that has modern features turned on
+        class ModernBuilder < RuboCop::AST::Builder
+          modernize
+        end
+        private_constant :ModernBuilder
+
         private
 
-        def node_with_index_sends(node)
-          # This is really dirty hack to reparse the current node with index send
-          # emitting enabled, which is necessary to unparse them back as index accessors.
-          emit_index_value = RuboCop::AST::Builder.emit_index
-          RuboCop::AST::Builder.emit_index = true
-          RuboCop::AST::ProcessedSource.new(node.source, target_ruby_version, processed_source.path).ast
-        ensure
-          RuboCop::AST::Builder.emit_index = emit_index_value
+        # This method exists to reparse the current node with modern features enabled.
+        # Modern features include "index send" emitting, which is necessary to unparse
+        # "index sends" (i.e. `[]` calls) back to index accessors (i.e. as `foo[bar]``).
+        # Otherwise, we would get the unparsed node as `foo.[](bar)`.
+        def node_reparsed_with_modern_features(node)
+          # Create a new parser with a modern builder class instance
+          parser = Parser::CurrentRuby.new(ModernBuilder.new)
+          # Create a new source buffer with the node source
+          buffer = Parser::Source::Buffer.new(processed_source.path, source: node.source)
+          # Re-parse the buffer
+          parser.parse(buffer)
         end
 
         def can_autocorrect?

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'rubocop'
+require "rubocop"
 
 module RuboCop
   module Cop
@@ -12,9 +12,24 @@ module RuboCop
         @registry = Cop.registry # So we can properly subclass this cop
 
         def_node_matcher(:signature?, <<~PATTERN)
-          (block (send nil? :sig) (args) ...)
+          (block (send #allowed_recv :sig) (args) ...)
         PATTERN
 
+        def_node_matcher(:with_runtime?, <<~PATTERN)
+          (const (const nil? :T) :Sig)
+        PATTERN
+
+        def_node_matcher(:without_runtime?, <<~PATTERN)
+          (const (const (const nil? :T) :Sig) :WithoutRuntime)
+        PATTERN
+
+        def allowed_recv(recv)
+          return true unless recv
+          return true if with_runtime?(recv)
+          return true if without_runtime?(recv)
+          false
+        end
+
         def on_block(node)
           on_signature(node) if signature?(node)
         end