rspec-sorbet 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfa6e3ee8be246791457ead7ccfadfb915bc17def59dec8f615287e8cbda3aba
-  data.tar.gz: 34c42b3831bc5712a67e544bc56d768c8617e917ede3f2251ad5a22000e50629
+  metadata.gz: 5658116844f34d4b596c0f46bbdcefa667a82d3186905f0acf0961d3654ec660
+  data.tar.gz: 38d680e034afe8cd469882f210efec1e7fb23c3ef4f3b3ec40f027069864451d
 SHA512:
-  metadata.gz: a1b97aa16c1923938827dc55a7e2b8574dd116ed5c88c43530ff47758bee34f9e8b401275b743fb5cd667427307cf0791218d2c33315605da6478798a4f11d48
-  data.tar.gz: 831e6e1f418ac631a7ec9ffc774a682e70ffe7908600d3c20253d6612b4d8d58368e53bcc7c912c10f5b153edab7c9e3825790d7eebb2cb29b0de5b2d0baec95
+  metadata.gz: 2377abcbc26c8d5925a868bb6ff2ca4f675769bc5a3522f253eb001f3e5d4f5e85cca4d669da2adde281eca7487a7405a2ea5b344c221ad154f8d62d62f24e26
+  data.tar.gz: d3ba0390f07496a8b1e9d06f344f701f66e1dcb4c3b47d378c8420d0e9e36b748c9e020e03836a08aaeda6053f811b626de0784f4dec98a41f25ee2097d3de48

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+1.1.0
+
+* Add basic `instance_double` verification to help check the type of an instance double.
+
 1.0.0
 
 * Initial release

data/README.md

@@ -1,4 +1,6 @@
-# RSpec Sorbet
+![rspec-sorbet](https://user-images.githubusercontent.com/2643026/63100456-02c12c00-bf6f-11e9-8430-630a27bc6e42.png)
+
+# RSpec Sorbet [![Gem Version](https://badge.fury.io/rb/rspec-sorbet.svg)](https://badge.fury.io/rb/rspec-sorbet)
 
 A small gem consisting of helpers for using Sorbet & RSpec together.
 
@@ -15,7 +17,7 @@ require 'rspec/sorbet'
 
 ### Allowing Instance Doubles
 
-Out of the box if your using `instance_double`'s in your tests you'll encounter errors such as the following:
+Out of the box if you're using `instance_double`'s in your tests you'll encounter errors such as the following:
 
 ```
  TypeError:
@@ -23,7 +25,7 @@ Out of the box if your using `instance_double`'s in your tests you'll encounter
        Caller: /Users/samuelgiles/Documents/Projects/Clients/Bellroy/bellroy/spec/lib/checkout/use_cases/my_use_case.rb:9
 ```
 
-Drop the following into your `spec_helper.rb` to allow instance doubles to be used:
+Drop the following into your `spec_helper.rb` to allow `instance_double` to be used without breaking type checking:
 
 ```ruby
 RSpec::Sorbet.allow_instance_doubles!

data/lib/rspec/sorbet/instance_doubles.rb

@@ -5,11 +5,6 @@ require 'sorbet-runtime'
 module RSpec
   module Sorbet
     module InstanceDoubles
-      WHITELISTED_ERROR_MESSAGES = [
-        'RSpec::Mocks::InstanceVerifyingDouble',
-        'InstanceDouble'
-      ].freeze
-
       def allow_instance_doubles!
         T::Configuration.inline_type_error_handler = proc do |error|
           inline_type_error_handler(error)
@@ -22,18 +17,73 @@ module RSpec
 
       private
 
+      INLINE_INSTANCE_DOUBLE_REGEX =
+        /T.let: Expected type (T.any\()?(?<expected_classes>[a-zA-Z:: ,]*)(\))?, got type (.*) with value #<InstanceDouble\((?<doubled_module>[a-zA-Z:: ,]*)\)/.freeze
+
       def inline_type_error_handler(error)
-        raise error unless error.is_a?(TypeError) && message_is_whitelisted?(error.message)
+        case error
+        when TypeError
+          message = error.message
+          return if instance_double_message_with_ellipsis?(message) || typed_array_message?(message)
+
+          _, expected_types_string, doubled_module_string = (message.match(INLINE_INSTANCE_DOUBLE_REGEX) || [])[0..2]
+          raise error unless expected_types_string && doubled_module_string
+
+          expected_types = expected_types_string.split(',').map do |expected_type_string|
+            Object.const_get(expected_type_string.strip)
+          end
+          doubled_module = Object.const_get(doubled_module_string)
+
+          valid = expected_types.any? do |expected_type|
+            doubled_module.ancestors.include?(expected_type)
+          end
+
+          raise error unless valid
+        else
+          raise error
+        end
       end
 
-      def call_validation_error_handler(_signature, opts)
-        raise TypeError, opts[:pretty_message] unless message_is_whitelisted?(opts[:message])
+      INSTANCE_VERIFYING_DOUBLE_OR_INSTANCE_DOUBLE =
+        /(RSpec::Mocks::InstanceVerifyingDouble|InstanceDouble)/.freeze
+
+      def instance_double_message_with_ellipsis?(message)
+        message.include?('...') && message.match?(INSTANCE_VERIFYING_DOUBLE_OR_INSTANCE_DOUBLE)
       end
 
-      def message_is_whitelisted?(message)
-        WHITELISTED_ERROR_MESSAGES.any? do |whitelisted_message|
-          message.include?(whitelisted_message)
+      TYPED_ARRAY_MESSAGE = /got T::Array/.freeze
+
+      def typed_array_message?(message)
+        message.match?(TYPED_ARRAY_MESSAGE)
+      end
+
+      def call_validation_error_handler(_signature, opts)
+        should_raise = true
+
+        if opts[:pretty_message].match?(INSTANCE_VERIFYING_DOUBLE_OR_INSTANCE_DOUBLE)
+          typing = opts[:type]
+          value = opts[:value].is_a?(Array) ? opts[:value].first : opts[:value]
+          target = value.instance_variable_get(:@doubled_module).target
+
+          case typing
+          when T::Types::TypedArray
+            typing = typing.type
+          end
+
+          case typing
+          when T::Types::Simple
+            should_raise = !target.ancestors.include?(typing.raw_type)
+          when T::Types::Union
+            valid = typing.types.map(&:raw_type).any? do |type|
+              target.ancestors.include?(type)
+            end
+            should_raise = !valid
+          else
+            should_raise = !target.ancestors.include?(typing)
+          end
         end
+
+        raise TypeError, opts[:pretty_message] if should_raise
       end
     end
   end

data/lib/rspec/sorbet/version.rb

@@ -2,6 +2,6 @@
 
 module RSpec
   module Sorbet
-    VERSION = '1.0.0'
+    VERSION = '1.1.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-sorbet
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Samuel Giles
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-15 00:00:00.000000000 Z
+date: 2019-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet