rubocop-sorbet 0.3.3 → 0.4.0

data/lib/rubocop-sorbet.rb

@@ -1,3 +1,11 @@
 # frozen_string_literal: true
 
-require 'rubocop_sorbet'
+require 'rubocop'
+
+require_relative 'rubocop/sorbet'
+require_relative 'rubocop/sorbet/version'
+require_relative 'rubocop/sorbet/inject'
+
+RuboCop::Sorbet::Inject.defaults!
+
+require_relative 'rubocop/cop/sorbet_cops'

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

@@ -14,13 +14,22 @@ module RuboCop
       #   FooOrBar = T.any(Foo, Bar)
       #
       #   # good
-      #   FooOrBar = T.type_alias(T.any(Foo, Bar))
+      #   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? #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)
@@ -58,6 +67,16 @@ module RuboCop
 
         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. " \
@@ -69,7 +88,7 @@ module RuboCop
           lambda do |corrector|
             corrector.replace(
               node.source_range,
-              "T.type_alias(#{node.source})"
+              "T.type_alias { #{node.source} }"
             )
           end
         end

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

@@ -0,0 +1,58 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+require 'rubocop'
+
+module RuboCop
+  module Cop
+    module Sorbet
+      # This cop disallows use of `T.untyped` or `T.nilable(T.untyped)`
+      # as a prop type for `T::Struct`.
+      #
+      # @example
+      #
+      #   # bad
+      #   class SomeClass
+      #     const :foo, T.untyped
+      #     prop :bar, T.nilable(T.untyped)
+      #   end
+      #
+      #   # good
+      #   class SomeClass
+      #     const :foo, Integer
+      #     prop :bar, T.nilable(String)
+      #   end
+      class ForbidUntypedStructProps < RuboCop::Cop::Cop
+        MSG = 'Struct props cannot be T.untyped'
+
+        def_node_matcher :t_struct, <<~PATTERN
+          (const (const nil? :T) :Struct)
+        PATTERN
+
+        def_node_matcher :t_untyped, <<~PATTERN
+          (send (const nil? :T) :untyped)
+        PATTERN
+
+        def_node_matcher :t_nilable_untyped, <<~PATTERN
+          (send (const nil? :T) :nilable {#t_untyped #t_nilable_untyped})
+        PATTERN
+
+        def_node_matcher :subclass_of_t_struct?, <<~PATTERN
+          (class (const ...) #t_struct ...)
+        PATTERN
+
+        def_node_search :untyped_props, <<~PATTERN
+          (send nil? {:prop :const} _ {#t_untyped #t_nilable_untyped} ...)
+        PATTERN
+
+        def on_class(node)
+          return unless subclass_of_t_struct?(node)
+
+          untyped_props(node).each do |untyped_prop|
+            add_offense(untyped_prop.child_nodes[1])
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+module RuboCop
+  module Cop
+    module Sorbet
+      # This cop checks that the Sorbet sigil comes as the first magic comment in the file.
+      #
+      # The expected order for magic comments is: typed, (en)?coding, warn_indent then frozen_string_literal.
+      #
+      # For example, the following bad ordering:
+      #
+      # ```ruby
+      # # frozen_string_literal: true
+      # # typed: true
+      # class Foo; end
+      # ```
+      #
+      # Will be corrected as:
+      #
+      # ```ruby
+      # # typed: true
+      # # frozen_string_literal: true
+      # class Foo; end
+      # ```
+      #
+      # 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
+        def investigate(processed_source)
+          return if processed_source.tokens.empty?
+
+          tokens = extract_magic_comments(processed_source)
+          return if tokens.empty?
+
+          check_magic_comments_order(tokens)
+        end
+
+        def autocorrect(_node)
+          lambda do |corrector|
+            tokens = extract_magic_comments(processed_source)
+
+            # Get the magic comments tokens in their expected order
+            expected = PREFERRED_ORDER.keys.map do |re|
+              tokens.select { |token| re.match?(token.text) }
+            end.flatten
+
+            tokens.each_with_index do |token, index|
+              corrector.replace(token.pos, expected[index].text)
+            end
+          end
+        end
+
+        protected
+
+        CODING_REGEX = /#\s+(en)?coding:(?:\s+([\w]+))?/
+        INDENT_REGEX = /#\s+warn_indent:(?:\s+([\w]+))?/
+        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',
+        }.freeze
+
+        MAGIC_REGEX = Regexp.union(*PREFERRED_ORDER.keys)
+
+        # extraction
+
+        # Get all the tokens in `processed_source` that match `MAGIC_REGEX`
+        def extract_magic_comments(processed_source)
+          processed_source.tokens
+            .take_while { |token| token.type == :tCOMMENT }
+            .select { |token| MAGIC_REGEX.match?(token.text) }
+        end
+
+        # checks
+
+        def check_magic_comments_order(tokens)
+          # Get the current magic comments order
+          order = tokens.map do |token|
+            PREFERRED_ORDER.keys.find { |re| re.match?(token.text) }
+          end.compact.uniq
+
+          # Get the expected magic comments order based on the one used in the actual source
+          expected = PREFERRED_ORDER.keys.select do |re|
+            tokens.any? { |token| re.match?(token.text) }
+          end.uniq
+
+          if order != expected
+            tokens.each do |token|
+              add_offense(
+                token,
+                location: token.pos,
+                message: "Magic comments should be in the following order: #{PREFERRED_ORDER.values.join(', ')}."
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -36,7 +36,13 @@ module RuboCop
             return unless extract_sigil(processed_source).nil?
 
             token = processed_source.tokens.first
-            corrector.insert_before(token.pos, "# typed: #{minimum_strictness || suggested_strictness}\n")
+            replace_with = suggested_strictness_level(minimum_strictness, suggested_strictness)
+            sigil = "# typed: #{replace_with}"
+            if token.text.start_with?("#!") # shebang line
+              corrector.insert_after(token.pos, "\n#{sigil}")
+            else
+              corrector.insert_before(token.pos, "#{sigil}\n")
+            end
           end
         end
 
@@ -64,7 +70,7 @@ module RuboCop
 
           token = processed_source.tokens.first
           if require_sigil_on_all_files?
-            strictness = minimum_strictness || suggested_strictness
+            strictness = suggested_strictness_level(minimum_strictness, suggested_strictness)
             add_offense(
               token,
               location: token.pos,
@@ -75,6 +81,25 @@ module RuboCop
           false
         end
 
+        def suggested_strictness_level(minimum_strictness, suggested_strictness)
+          # if no minimum strictness is set (eg. using Sorbet/HasSigil without config) then
+          # we always use the suggested strictness which defaults to `false`
+          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?
+
+          # 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
+          # the suggested strictness might be higher than the minimum (eg. if you want all new files
+          # at a higher strictness level, without having to migrate existing files at lower levels).
+
+          suggested_level = STRICTNESS_LEVELS.index(suggested_strictness)
+          minimum_level = STRICTNESS_LEVELS.index(minimum_strictness)
+
+          suggested_level > minimum_level ? suggested_strictness : minimum_strictness
+        end
+
         def check_strictness_not_empty(sigil, strictness)
           return true if strictness
 
@@ -122,12 +147,12 @@ module RuboCop
 
         # Default is `'false'`
         def suggested_strictness
-          cop_config['SuggestedStrictness'] || 'false'
+          STRICTNESS_LEVELS.include?(cop_config['SuggestedStrictness']) ? cop_config['SuggestedStrictness'] : 'false'
         end
 
         # Default is `nil`
         def minimum_strictness
-          cop_config['MinimumStrictness']
+          cop_config['MinimumStrictness'] if STRICTNESS_LEVELS.include?(cop_config['MinimumStrictness'])
         end
       end
     end

data/lib/rubocop/cop/sorbet/{checked_true_in_signature.rb → signatures/checked_true_in_signature.rb}

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'rubocop'
+require_relative 'signature_cop'
 
 module RuboCop
   module Cop
@@ -18,13 +19,9 @@ module RuboCop
       #
       #   # good
       #   sig { void }
-      class CheckedTrueInSignature < RuboCop::Cop::Cop
+      class CheckedTrueInSignature < SignatureCop
         include(RuboCop::Cop::RangeHelp)
 
-        def_node_matcher(:signature?, <<~PATTERN)
-          (block (send nil? :sig) (args) ...)
-        PATTERN
-
         def_node_search(:offending_node, <<~PATTERN)
           (send _ :checked (true))
         PATTERN
@@ -36,9 +33,7 @@ module RuboCop
             '`include(WaffleCone::RuntimeChecks)` to this module and set other methods to `checked(false)`.'
         private_constant(:MESSAGE)
 
-        def on_block(node)
-          return unless signature?(node)
-
+        def on_signature(node)
           error = offending_node(node).first
           return unless error
 

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

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+require 'stringio'
+require_relative 'signature_cop'
+
+module RuboCop
+  module Cop
+    module Sorbet
+      # This cop checks that every method definition and attribute accessor has a Sorbet signature.
+      #
+      # It also suggest an autocorrect with placeholders so the following code:
+      #
+      # ```
+      # def foo(a, b, c); end
+      # ```
+      #
+      # Will be corrected as:
+      #
+      # ```
+      # sig { params(a: T.untyped, b: T.untyped, c: T.untyped).returns(T.untyped)
+      # def foo(a, b, c); end
+      # ```
+      #
+      # 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')
+      class EnforceSignatures < SignatureCop
+        def_node_matcher(:accessor?, <<-PATTERN)
+          (send nil? {:attr_reader :attr_writer :attr_accessor} ...)
+        PATTERN
+
+        def on_def(node)
+          check_node(node)
+        end
+
+        def on_defs(node)
+          check_node(node)
+        end
+
+        def on_send(node)
+          return unless accessor?(node)
+          check_node(node)
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            suggest = SigSuggestion.new(node.loc.column, param_type_placeholder, return_type_placeholder)
+
+            if node.is_a?(RuboCop::AST::DefNode) # def something
+              node.arguments.each do |arg|
+                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
+
+            corrector.insert_before(node.loc.expression, suggest.to_autocorrect)
+          end
+        end
+
+        private
+
+        def check_node(node)
+          prev = previous_node(node)
+          unless signature?(prev)
+            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]
+        end
+
+        def param_type_placeholder
+          cop_config['ParameterTypePlaceholder'] || 'T.untyped'
+        end
+
+        def return_type_placeholder
+          cop_config['ReturnTypePlaceholder'] || 'T.untyped'
+        end
+
+        class SigSuggestion
+          attr_accessor :params, :returns
+
+          def initialize(indent, param_placeholder, return_placeholder)
+            @params = []
+            @returns = nil
+            @indent = indent
+            @param_placeholder = param_placeholder
+            @return_placeholder = return_placeholder
+          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
+          end
+
+          private
+
+          def generate_params
+            return if @params.empty?
+            out = StringIO.new
+            out << 'params('
+            out << @params.map do |param|
+              "#{param}: #{@param_placeholder}"
+            end.join(", ")
+            out << ').'
+            out.string
+          end
+
+          def generate_return
+            return "returns(#{@return_placeholder})" if @returns.nil?
+            return @returns if @returns == 'void'
+            "returns(#{@returns})"
+          end
+        end
+      end
+    end
+  end
+end