Contents

# frozen_string_literal: true

require 'rubocop'

module RuboCop
  module Cop
    module Sorbet
      # This cop disallows binding the return value of `T.any`, `T.all`, `T.enum`
      # to a constant directly. To bind the value, one must use `T.type_alias`.
      #
      # @example
      #
      #   # bad
      #   FooOrBar = T.any(Foo, Bar)
      #
      #   # good
      #   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)
          (
            send
            (const nil? :T)
            :type_alias
            _
          )
        PATTERN

        def_node_matcher(:t_let?, <<-PATTERN)
          (
            send
            (const nil? :T)
            :let
            _
            _
          )
        PATTERN

        def_node_search(:method_needing_aliasing_on_t?, <<-PATTERN)
          (
            send
            (const nil? :T)
            {:any :all :noreturn :class_of :untyped :nilable :self_type :enum :proc}
             ...
          )
        PATTERN

        def not_t_let?(node)
          !t_let?(node)
        end

        def not_nil?(node)
          !node.nil?
        end

        def on_casgn(node)
          return unless binding_unaliased_type?(node) && !using_type_alias?(node.children[2])
          add_offense(
            node.children[2],
            message: "It looks like you're trying to bind a type to a constant. " \
            'To do this, you must alias the type using `T.type_alias`.'
          )
        end

        def autocorrect(node)
          lambda do |corrector|
            corrector.replace(
              node.source_range,
              "T.type_alias(#{node.source})"
            )
          end
        end
      end
    end
  end
end

Version data entries

6 entries across 6 versions & 1 rubygems

Version	Path
rubocop-sorbet-0.3.3	lib/rubocop/cop/sorbet/binding_constants_without_type_alias.rb
rubocop-sorbet-0.3.2	lib/rubocop/cop/sorbet/binding_constants_without_type_alias.rb
rubocop-sorbet-0.3.1	lib/rubocop/cop/sorbet/binding_constants_without_type_alias.rb
rubocop-sorbet-0.3.0	lib/rubocop/cop/sorbet/binding_constants_without_type_alias.rb
rubocop-sorbet-0.2.0	lib/rubocop/cop/sorbet/binding_constants_without_type_alias.rb
rubocop-sorbet-0.0.2	lib/rubocop/cop/sorbet/binding_constants_without_type_alias.rb