rubocop-sorbet 0.4.1 → 0.6.2

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

@@ -12,13 +12,6 @@ require 'rubocop'
 # class Foo < send_expr; end
 # ```
 #
-# This cop replaces them by:
-#
-# ```ruby
-# FooParent = send_expr
-# class Foo < FooParent; end
-# ```
-#
 # Multiple occurences of this can be found in Shopify's code base like:
 #
 # ```ruby
@@ -46,16 +39,6 @@ module RuboCop
           return unless not_lit_const_superclass?(node)
           add_offense(node.child_nodes[1])
         end
-
-        def autocorrect(node)
-          lambda do |corrector|
-            class_name = node.parent.child_nodes.first.const_name
-            parent_name = "#{class_name}Parent"
-            indent = ' ' * node.parent.loc.column
-            corrector.insert_before(node.parent.loc.expression, "#{parent_name} = #{node.source}\n#{indent}")
-            corrector.replace(node.loc.expression, parent_name)
-          end
-        end
       end
     end
   end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+module RuboCop
+  module Cop
+    module Sorbet
+      # This cop disallows using `T.unsafe` anywhere.
+      #
+      # @example
+      #
+      #   # bad
+      #   T.unsafe(foo)
+      #
+      #   # good
+      #   foo
+      class ForbidTUnsafe < RuboCop::Cop::Cop
+        def_node_matcher(:t_unsafe?, '(send (const nil? :T) :unsafe _)')
+
+        def on_send(node)
+          add_offense(node, message: "Do not use `T.unsafe`.") if t_unsafe?(node)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+require 'rubocop'
+
+module RuboCop
+  module Cop
+    module Sorbet
+      # This cop ensures one ancestor per requires_ancestor line
+      # rather than chaining them as a comma-separated list.
+      #
+      # @example
+      #
+      #   # bad
+      #   module SomeModule
+      #     requires_ancestor Kernel, Minitest::Assertions
+      #   end
+      #
+      #   # good
+      #   module SomeModule
+      #     requires_ancestor Kernel
+      #     requires_ancestor Minitest::Assertions
+      #   end
+      class OneAncestorPerLine < RuboCop::Cop::Cop
+        MSG = 'Cannot require more than one ancestor per line'
+
+        def_node_search :requires_ancestors, <<~PATTERN
+          (send nil? :requires_ancestor ...)
+        PATTERN
+
+        def_node_matcher :more_than_one_ancestor, <<~PATTERN
+          (send nil? :requires_ancestor const const+)
+        PATTERN
+
+        def_node_search :abstract?, <<~PATTERN
+          (send nil? :abstract!)
+        PATTERN
+
+        def on_module(node)
+          return unless node.body
+          return unless requires_ancestors(node)
+          process_node(node)
+        end
+
+        def on_class(node)
+          return unless abstract?(node)
+          return unless requires_ancestors(node)
+          process_node(node)
+        end
+
+        def autocorrect(node)
+          -> (corrector) do
+            ra_call = node.parent
+            split_ra_calls = ra_call.source.gsub(/,\s+/, new_ra_line(ra_call.loc.column))
+            corrector.replace(ra_call, split_ra_calls)
+          end
+        end
+
+        private
+
+        def process_node(node)
+          requires_ancestors(node).each do |ra|
+            add_offense(ra.child_nodes[1]) if more_than_one_ancestor(ra)
+          end
+        end
+
+        def new_ra_line(indent_count)
+          indents = " " * indent_count
+          indented_ra_call = "#{indents}requires_ancestor "
+          "\n#{indented_ra_call}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Sorbet
+      # This cop ensures RBI shims do not include a call to extend T::Sig
+      # or to extend T::Helpers
+      #
+      # @example
+      #
+      #   # 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
+      class ForbidExtendTSigHelpersInShims < RuboCop::Cop::Cop
+        include RangeHelp
+
+        MSG = 'Extending T::Sig or T::Helpers in a shim is unnecessary'
+        RESTRICT_ON_SEND = [:extend]
+
+        def_node_matcher :extend_t_sig?, <<~PATTERN
+          (send nil? :extend (const (const nil? :T) :Sig))
+        PATTERN
+
+        def_node_matcher :extend_t_helpers?, <<~PATTERN
+          (send nil? :extend (const (const nil? :T) :Helpers))
+        PATTERN
+
+        def autocorrect(node)
+          -> (corrector) do
+            corrector.remove(
+              range_by_whole_lines(node.source_range, include_final_newline: true)
+            )
+          end
+        end
+
+        def on_send(node)
+          add_offense(node) if extend_t_helpers?(node) || extend_t_sig?(node)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Sorbet
+      # This cop makes sure that RBI files are always located under 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 ForbidRBIOutsideOfSorbetDir < RuboCop::Cop::Cop
+        include RangeHelp
+
+        PATH_REGEXP = %r{sorbet/rbi}
+
+        def investigate(processed_source)
+          add_offense(
+            nil,
+            location: source_range(processed_source.buffer, 1, 0),
+            message: "RBI files are only accepted in the sorbet/rbi/ directory."
+          ) unless processed_source.file_path =~ PATH_REGEXP
+        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

@@ -28,6 +28,8 @@ module RuboCop
       # Only `typed`, `(en)?coding`, `warn_indent` and `frozen_string_literal` magic comments are considered,
       # other comments or magic comments are left in the same place.
       class EnforceSigilOrder < ValidSigil
+        include RangeHelp
+
         def investigate(processed_source)
           return if processed_source.tokens.empty?
 
@@ -49,6 +51,14 @@ module RuboCop
             tokens.each_with_index do |token, index|
               corrector.replace(token.pos, expected[index].text)
             end
+
+            # Remove blank lines between the magic comments
+            lines = tokens.map(&:line).to_set
+            (lines.min...lines.max).each do |line|
+              next if lines.include?(line)
+              next unless processed_source[line - 1].empty?
+              corrector.remove(source_range(processed_source.buffer, line, 0))
+            end
           end
         end
 

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

@@ -147,12 +147,14 @@ module RuboCop
 
         # 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/enforce_signatures.rb

@@ -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_block(node)
+          @last_sig_for_scope[scope(node)] = node if signature?(node)
         end
 
         def autocorrect(node)
@@ -63,22 +71,23 @@ module RuboCop
           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

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

@@ -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_cops.rb

@@ -4,6 +4,13 @@ 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/rbi/forbid_extend_t_sig_helpers_in_shims'
+require_relative 'sorbet/rbi/forbid_rbi_outside_of_sorbet_dir'
+require_relative 'sorbet/rbi/single_line_rbi_class_module_definitions'
 
 require_relative 'sorbet/signatures/allow_incompatible_override'
 require_relative 'sorbet/signatures/checked_true_in_signature'

data/lib/rubocop/sorbet/version.rb

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

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/FalseSigil](cops_sorbet.md#sorbetfalsesigil)
+* [Sorbet/ForbidExtendTSigHelpersInShims](cops_sorbet.md#sorbetforbidextendtsighelpersinshims)
 * [Sorbet/ForbidIncludeConstLiteral](cops_sorbet.md#sorbetforbidincludeconstliteral)
+* [Sorbet/ForbidRBIOutsideOfSorbetDir](cops_sorbet.md#sorbetforbidrbioutsideofsorbetdir)
 * [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/OneAncestorPerLine](cops_sorbet.md#sorbetoneancestorperline)
 * [Sorbet/ParametersOrderingInSignature](cops_sorbet.md#sorbetparametersorderinginsignature)
 * [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)