Merge pull request #16 from Shopify/Alex/namespace-unexpected-nil-error

Move `UnexpectedNilError` into gem namespace

Author: amomchilov

lib/rubocop/cop/type_toolkit/dont_expect_unexpected_nil.rb

@@ -1,13 +1,20 @@
 # typed: true
 # frozen_string_literal: true
 
+require "type_toolkit/ext/nil_assertions"
+
 module RuboCop
   module Cop
     module TypeToolkit
       # This cop detects attempts to raise, rescue, or otherwise use the `UnexpectedNilError` class.
       class DontExpectUnexpectedNil < Base
         RESTRICT_ON_SEND = [:assert_raises, :raise].freeze
 
+        UNEXPECTED_NIL_ERROR_NAME = ::TypeToolkit::UnexpectedNilError.name.not_nil!
+          .split("::").last.not_nil!
+          .to_sym #: Symbol
+        private_constant :UNEXPECTED_NIL_ERROR_NAME
+
         #: (RuboCop::AST::SendNode) -> void
         def on_send(node)
           case node.method_name
@@ -55,7 +62,12 @@ def on_investigation_end
 
         #: (RuboCop::AST::ConstNode) -> bool
         def unexpected_nil_error?(node)
-          node.short_name == :UnexpectedNilError && (node.namespace.nil? || node.namespace.cbase_type?)
+          return false unless node.short_name == UNEXPECTED_NIL_ERROR_NAME
+
+          ns = node.namespace
+          return true if ns.nil? || ns.cbase_type?
+
+          ns.const_type? && ns.short_name == :TypeToolkit && (ns.namespace.nil? || ns.namespace.cbase_type?)
         end
 
         # Check for `raise UnexpectedNilError`

lib/type_toolkit/ext/nil_assertions.rb

@@ -18,17 +18,19 @@ class NilClass
   # @override
   #: -> bot
   def not_nil!
-    raise UnexpectedNilError
+    raise TypeToolkit::UnexpectedNilError
   end
 end
 
-# An error raised when calling `#not_nil!` on a `nil` value.
-#
-# `UnexpectedNilError` should never occur in well-formed code, so it should never be rescued.
-# This is why it inherits from `Exception` instead of `StandardError`,
-# so that bare rescues clauses (like `rescue => e`) don't rescue it.
-class UnexpectedNilError < Exception # rubocop:disable Lint/InheritException
-  def initialize(message = "Called `not_nil!` on nil.")
-    super(message)
+module TypeToolkit
+  # An error raised when calling `#not_nil!` on a `nil` value.
+  #
+  # `UnexpectedNilError` should never occur in well-formed code, so it should never be rescued.
+  # This is why it inherits from `Exception` instead of `StandardError`,
+  # so that bare rescues clauses (like `rescue => e`) don't rescue it.
+  class UnexpectedNilError < Exception # rubocop:disable Lint/InheritException
+    def initialize(message = "Called `not_nil!` on nil.")
+      super
+    end
   end
 end

sorbet/config

@@ -4,3 +4,4 @@
 --ignore=vendor/
 --enable-experimental-rbs-comments
 --suppress-payload-superclass-redefinition-for=RDoc::Markup::Heading
+--disable-watchman

sorbet/rbi/shims/minitest.rbi

@@ -2,5 +2,42 @@
 # frozen_string_literal: true
 
 module Minitest
-  class Spec < Minitest::Test; end
+  class Spec < Minitest::Test
+    extend Minitest::Spec::DSL
+
+    include RuboCop::Minitest::AssertOffense
+
+    sig do
+      params(
+        desc: T.anything,
+        block: T.proc.bind(T.self_type).void,
+      ).void
+    end
+    def it(desc = T.unsafe(nil), &block); end
+
+    module DSL
+      has_attached_class!(:out)
+
+      sig do
+        params(
+          desc: T.anything,
+          block: T.proc.bind(T.attached_class).void,
+        ).void
+      end
+      def describe(desc, &block); end
+
+      sig do
+        params(
+          desc: T.anything,
+          block: T.proc.bind(T.attached_class).void,
+        ).void
+      end
+      def it(desc = T.unsafe(nil), &block); end
+
+      sig do
+        params(block: T.proc.bind(T.attached_class).void).void
+      end
+      def before(&block); end
+    end
+  end
 end