sorbet-runtime 0.5.5400 → 0.5.5410

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4f9fd0690e5e4161f08d170c0ad34c991b419d7718cb6d3cc3db90036c35387
-  data.tar.gz: acd9cfcc9cca1df5271b927d2dd85ffa0276337276a0df1ee522fe0c55dde9a4
+  metadata.gz: 72e771c6dd47d33ac98f5acec99201a8bd2b8dcbe41b8c28101f301c91fd62a2
+  data.tar.gz: 4ae0ff258bfd7d346e68766354490a1de8ecd624e61755a442613bff8a7c3548
 SHA512:
-  metadata.gz: c9935807087e676840c09e8e2c43b4c3bc25639264bb8ed793a0e677fce16742db55a14362a39e701da6e63b130ffa1213717e755a98695db849dc1c5ba9dcd5
-  data.tar.gz: b0ee575a179bb1a6da3a10d3f40a16e27a94f739c28ca47bd174b9f7c854d90e5a5085bea444d715f1dc4fa12ffef98cdc98166c2af962ac06c5ff27dce0f911
+  metadata.gz: 7711cad1c9dda852f2977ed55d85020ede97b6c05a233046a4e4b4d51b9fa3f9813258d1b0aae08cb77a24444f105213ad9818940b521ee829becb9411791607
+  data.tar.gz: 885b932a56b3b492ed7dfcad5c530df0530e2d6600c81d8168dbaaef9cab6d9eef3826e3ab96f00cb1fe277a133916e3dbd7c71c23de37ef64afe917694542b6

data/lib/types/props/decorator.rb

@@ -67,6 +67,7 @@ class T::Props::Decorator
     clobber_existing_method!
     extra
     optional
+    setter_validate
     _tnilable
   }.map {|k| [k, true]}.to_h.freeze, T::Hash[Symbol, T::Boolean])
   private_constant :VALID_RULE_KEYS
@@ -429,7 +430,7 @@ class T::Props::Decorator
     end
 
     handle_foreign_option(name, cls, rules, rules[:foreign]) if rules[:foreign]
-    handle_foreign_hint_only_option(cls, rules[:foreign_hint_only]) if rules[:foreign_hint_only]
+    handle_foreign_hint_only_option(name, cls, rules[:foreign_hint_only]) if rules[:foreign_hint_only]
     handle_redaction_option(name, rules[:redaction]) if rules[:redaction]
   end
 
@@ -636,12 +637,13 @@ class T::Props::Decorator
 
   sig do
     params(
+      prop_name: Symbol,
       prop_cls: Module,
       foreign_hint_only: T.untyped,
     )
     .void
   end
-  private def handle_foreign_hint_only_option(prop_cls, foreign_hint_only)
+  private def handle_foreign_hint_only_option(prop_name, prop_cls, foreign_hint_only)
     if ![String, Array].include?(prop_cls) && !(prop_cls.is_a?(T::Props::CustomType))
       raise ArgumentError.new(
         "`foreign_hint_only` can only be used with String or Array prop types"
@@ -652,6 +654,21 @@ class T::Props::Decorator
       :foreign_hint_only, foreign_hint_only,
       valid_type_msg: "an individual or array of a model class, or a Proc returning such."
     )
+
+    unless foreign_hint_only.is_a?(Proc)
+      T::Configuration.soft_assert_handler(<<~MESSAGE, storytime: {prop: prop_name, value: foreign_hint_only}, notify: 'jerry')
+        Please use a Proc that returns a model class instead of the model class itself as the argument to `foreign_hint_only`. In other words:
+
+          instead of `prop :foo, String, foreign_hint_only: FooModel`
+          use `prop :foo, String, foreign_hint_only: -> {FooModel}`
+
+          OR
+
+          instead of `prop :foo, String, foreign_hint_only: [FooModel, BarModel]`
+          use `prop :foo, String, foreign_hint_only: -> {[FooModel, BarModel]}`
+
+      MESSAGE
+    end
   end
 
   # checked(:never) - Rules hash is expensive to check
@@ -745,6 +762,16 @@ class T::Props::Decorator
       )
     end
 
+    unless foreign.is_a?(Proc)
+      T::Configuration.soft_assert_handler(<<~MESSAGE, storytime: {prop: prop_name, value: foreign}, notify: 'jerry')
+        Please use a Proc that returns a model class instead of the model class itself as the argument to `foreign`. In other words:
+
+          instead of `prop :foo, String, foreign: FooModel`
+          use `prop :foo, String, foreign: -> {FooModel}`
+
+      MESSAGE
+    end
+
     define_foreign_method(prop_name, rules, foreign)
   end
 

data/lib/types/props/private/setter_factory.rb

@@ -7,6 +7,7 @@ module T::Props
       extend T::Sig
 
       SetterProc = T.type_alias {T.proc.params(val: T.untyped).void}
+      ValidateProc = T.type_alias {T.proc.params(prop: Symbol, value: T.untyped).void}
 
       sig do
         params(
@@ -31,6 +32,7 @@ module T::Props
           T::Utils::Nilable.get_underlying_type_object(rules.fetch(:type_object))
         end
         accessor_key = rules.fetch(:accessor_key)
+        validate = rules[:setter_validate]
 
         # It seems like a bug that this affects the behavior of setters, but
         # some existing code relies on this behavior
@@ -39,9 +41,9 @@ module T::Props
         # Use separate methods in order to ensure that we only close over necessary
         # variables
         if !T::Props::Utils.need_nil_write_check?(rules) || has_explicit_nil_default
-          nilable_proc(prop, accessor_key, non_nil_type)
+          nilable_proc(prop, accessor_key, non_nil_type, klass, validate)
         else
-          non_nil_proc(prop, accessor_key, non_nil_type)
+          non_nil_proc(prop, accessor_key, non_nil_type, klass, validate)
         end
       end
 
@@ -50,16 +52,21 @@ module T::Props
           prop: Symbol,
           accessor_key: Symbol,
           non_nil_type: T.any(T::Types::Base, T.all(T::Props::CustomType, Module)),
+          klass: T.all(Module, T::Props::ClassMethods),
+          validate: T.nilable(ValidateProc)
         )
         .returns(SetterProc)
       end
-      private_class_method def self.non_nil_proc(prop, accessor_key, non_nil_type)
+      private_class_method def self.non_nil_proc(prop, accessor_key, non_nil_type, klass, validate)
         proc do |val|
           if non_nil_type.valid?(val)
+            if validate
+              validate.call(prop, val)
+            end
             instance_variable_set(accessor_key, val)
           else
             T::Props::Private::SetterFactory.raise_pretty_error(
-              T.unsafe(self.class),
+              klass,
               prop,
               non_nil_type,
               val,
@@ -73,18 +80,23 @@ module T::Props
           prop: Symbol,
           accessor_key: Symbol,
           non_nil_type: T.any(T::Types::Base, T.all(T::Props::CustomType, Module)),
+          klass: T.all(Module, T::Props::ClassMethods),
+          validate: T.nilable(ValidateProc),
         )
         .returns(SetterProc)
       end
-      private_class_method def self.nilable_proc(prop, accessor_key, non_nil_type)
+      private_class_method def self.nilable_proc(prop, accessor_key, non_nil_type, klass, validate)
         proc do |val|
           if val.nil?
             instance_variable_set(accessor_key, nil)
           elsif non_nil_type.valid?(val)
+            if validate
+              validate.call(prop, val)
+            end
             instance_variable_set(accessor_key, val)
           else
             T::Props::Private::SetterFactory.raise_pretty_error(
-              T.unsafe(self.class),
+              klass,
               prop,
               non_nil_type,
               val,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sorbet-runtime
 version: !ruby/object:Gem::Version
-  version: 0.5.5400
+  version: 0.5.5410
 platform: ruby
 authors:
 - Stripe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-26 00:00:00.000000000 Z
+date: 2020-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest