sorbet-coerce 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e72cc347e68ca6df5bfd3378ec9482aa1463c43cf9f03f203f110cbde5da4e6f
-  data.tar.gz: c22aa7e85408cd2306d3cf582382ef5aac8c49873bd250f77fa17f4fa4cc91ec
+  metadata.gz: e5eefb63dc137b65889fa5dd16b05fcf3bef550474d7f7f175746ccca96e640d
+  data.tar.gz: 0ca052e76b580d9979d24444b8bee8d564a49c6d2162acd36469fbd205cb6354
 SHA512:
-  metadata.gz: c2a1141237ad7bc7bb666d50c03b2b4c7507789236ae2e0542d50603e7bdf1cc353a4d5faf9bbc10f1927a81bed6887715078e5252842bd10648f5e38224d49a
-  data.tar.gz: 0d82e8842ee6cbac0aefd823f023f71128088d414681a4600dc1c7b025c92c1010673b3334123d9a4c64a4315a26b39ea64f6f507ff010f9518799a9aad17519
+  metadata.gz: afb06e4b35972579d9ff0ffb0d9eb48c1de7465911b0f56a07a1d7dcda528f70d525834f5ac81c300394132ae5e8fec7d614814c900710778fa13296ed2db7f3
+  data.tar.gz: eecba6f2089a944984b2e6ba595ad21bbff2d11bb3fc56d38532fff94f029fe6beac3e1fce25272d46162e893d3040a548fe4240058db8a258900ee815acb946

data/lib/configuration.rb

@@ -0,0 +1,15 @@
+# typed: true
+require 'sorbet-runtime'
+
+module T::Coerce
+  module Configuration
+    class << self
+      extend T::Sig
+
+      sig { returns(T::Boolean) }
+      attr_accessor :raise_coercion_error
+    end
+  end
+end
+
+T::Coerce::Configuration.raise_coercion_error = true

data/lib/private/converter.rb

@@ -5,8 +5,6 @@ require 'polyfill'
 
 using Polyfill(Hash: %w[#slice])
 
-module T; end
-
 module T::Private
   class Converter
     extend T::Sig
@@ -22,12 +20,12 @@ module T::Private
     ], T.untyped)
 
     protected
-    sig { params(value: T.untyped, type: T.untyped).returns(T.untyped) }
-    def _convert(value, type)
+    sig { params(value: T.untyped, type: T.untyped, raise_coercion_error: T::Boolean).returns(T.untyped) }
+    def _convert(value, type, raise_coercion_error)
       if type.is_a?(T::Types::TypedArray)
-        _convert_to_a(value, type.type)
+        _convert_to_a(value, type.type, raise_coercion_error)
       elsif type.is_a?(T::Types::Simple)
-        _convert(value, type.raw_type)
+        _convert(value, type.raw_type, raise_coercion_error)
       elsif type.is_a?(T::Types::Union)
         true_idx = T.let(nil, T.nilable(Integer))
         false_idx = T.let(nil, T.nilable(Integer))
@@ -49,25 +47,25 @@ module T::Private
         )
 
         if !true_idx.nil? && !false_idx.nil?
-          _convert_simple(value, T::Boolean)
+          _convert_simple(value, T::Boolean, raise_coercion_error)
         else
-          _convert(value, type.types[nil_idx == 0 ? 1 : 0])
+          _convert(value, type.types[nil_idx == 0 ? 1 : 0], raise_coercion_error)
         end
+      elsif Object.const_defined?('T::Private::Types::TypeAlias') &&
+            type.is_a?(T::Private::Types::TypeAlias)
+        _convert(value, type.aliased_type, raise_coercion_error)
       elsif type < T::Struct
-        args = _build_args(value, type.props)
-        begin
-          type.new(args)
-        rescue T::Props::InvalidValueError, ArgumentError
-          nil
-        end
+        args = _build_args(value, type, raise_coercion_error)
+        type.new(args)
       else
-        _convert_simple(value, type)
+        _convert_simple(value, type, raise_coercion_error)
       end
     end
 
-    sig { params(value: T.untyped, type: T.untyped).returns(T.untyped) }
-    def _convert_simple(value, type)
-      return nil if value.nil?
+    sig { params(value: T.untyped, type: T.untyped, raise_coercion_error: T::Boolean).returns(T.untyped) }
+    def _convert_simple(value, type, raise_coercion_error)
+      return nil if _nil_like?(value, type)
+
       safe_type_rule = T.let(nil, T.untyped)
 
       if type == T::Boolean
@@ -81,38 +79,48 @@ module T::Private
       end
       SafeType::coerce(value, safe_type_rule)
     rescue SafeType::EmptyValueError, SafeType::CoercionError
-      nil
-    rescue SafeType::InvalidRuleError
-      begin
-        type.new(value)
-      rescue
+      if raise_coercion_error
+        raise T::Coerce::CoercionError.new(value, type)
+      else
         nil
       end
+    rescue SafeType::InvalidRuleError
+      type.new(value)
     end
 
-    sig { params(ary: T.untyped, type: T.untyped).returns(T.untyped) }
-    def _convert_to_a(ary, type)
-      ary = [ary] unless ary.is_a?(::Array)
-      T.send(
-        'let',
-        ary.map { |value| _convert(value, type) },
-        T.const_get('Array')[type],
-      )
-    rescue TypeError
-      []
+    sig { params(ary: T.untyped, type: T.untyped, raise_coercion_error: T::Boolean).returns(T.untyped) }
+    def _convert_to_a(ary, type, raise_coercion_error)
+      return [] if _nil_like?(ary, type)
+
+      unless ary.respond_to?(:map)
+        raise T::Coerce::ShapeError.new(ary, type)
+      end
+
+      ary.map { |value| _convert(value, type, raise_coercion_error) }
     end
 
-    sig { params(args: T.untyped, props: T.untyped).returns(T.untyped) }
-    def _build_args(args, props)
-      return {} if args.nil?
+    sig { params(args: T.untyped, type: T.untyped, raise_coercion_error: T::Boolean).returns(T.untyped) }
+    def _build_args(args, type, raise_coercion_error)
+      return {} if _nil_like?(args, Hash)
+
+      unless args.respond_to?(:each_pair)
+        raise T::Coerce::ShapeError.new(args, type)
+      end
+
+      props = type.props
       args.map { |name, value|
         key = name.to_sym
         [
           key,
           (!props.include?(key) || value.nil?) ?
-            nil : _convert(value, props[key][:type]),
+            nil : _convert(value, props[key][:type], raise_coercion_error),
         ]
       }.to_h.slice(*props.keys)
     end
+
+    sig { params(value: T.untyped, type: T.untyped).returns(T::Boolean) }
+    def _nil_like?(value, type)
+      value.nil? || (value == '' && type != String)
+    end
   end
 end

data/lib/sorbet-coerce.rb

@@ -1,22 +1,22 @@
 # typed: strict
+require_relative 'configuration'
 require 'private/converter'
 require 'safe_type'
 
-module T
+module T::Coerce
   class CoercionError < SafeType::CoercionError; end
+  class ShapeError < SafeType::CoercionError; end
 
-  module Coerce
-    define_singleton_method(:[]) do |type|
-      Class.new(T::Private::Converter) do
-        define_method(:to_s) { "#{name}#[#{type.to_s}]" }
+  define_singleton_method(:[]) do |type|
+    Class.new(T::Private::Converter) do
+      define_method(:to_s) { "#{name}#[#{type.to_s}]" }
 
-        define_method(:from) do |args|
-          begin
-            T.send('let', send('_convert', args, type), type)
-          rescue TypeError
-            raise CoercionError.new(args, type)
-          end
+      define_method(:from) do |args, raise_coercion_error: nil|
+        if raise_coercion_error.nil?
+          raise_coercion_error = T::Coerce::Configuration.raise_coercion_error
         end
+
+        T.send('let', send('_convert', args, type, raise_coercion_error), type)
       end
     end
   end

data/rbi/sorbet-coerce.rbi

@@ -0,0 +1,20 @@
+# typed: true
+module T
+  module Coerce
+    extend T::Sig
+    extend T::Generic
+
+    Elem = type_member
+
+    sig { params(args: T.untyped, raise_value_error: T.nilable(T::Boolean)).returns(Elem) }
+    def from(args, raise_value_error: nil); end
+  end
+
+  module Private
+    module Types
+      class TypeAlias
+        def aliased_type; end
+      end
+    end
+  end
+end

data/spec/coerce_spec.rb

@@ -0,0 +1,198 @@
+# typed: ignore
+require 'sorbet-coerce'
+require 'sorbet-runtime'
+
+describe T::Coerce do
+  context 'when given T::Struct' do
+    class ParamInfo < T::Struct
+      const :name, String
+      const :lvl, T.nilable(Integer)
+      const :skill_ids, T::Array[Integer]
+    end
+
+    class ParamInfo2 < T::Struct
+      const :a, Integer
+      const :b, Integer
+      const :notes, T::Array[String], default: []
+    end
+
+    class Param < T::Struct
+      const :id, Integer
+      const :role, String, default: 'wizard'
+      const :info, ParamInfo
+      const :opt, T.nilable(ParamInfo2)
+    end
+
+    class DefaultParams < T::Struct
+      const :a, Integer, default: 1
+    end
+
+    class CustomType
+      attr_reader :a
+
+      def initialize(a)
+        @a = a
+      end
+    end
+
+    class CustomType2
+      def self.new(a); 1; end
+    end
+
+    class UnsupportedCustomType
+      # Does not respond to new
+    end
+
+    let!(:param) {
+      T::Coerce[Param].new.from({
+        id: 1,
+        info: {
+          name: 'mango',
+          lvl: 100,
+          skill_ids: ['123', '456'],
+        },
+        opt: {
+          a: 1,
+          b: 2,
+        },
+        extra_attr: 'does not matter',
+      })
+    }
+
+    let!(:param2) {
+      T::Coerce[Param].new.from({
+        id: '2',
+        info: {
+          name: 'honeydew',
+          lvl: '5',
+          skill_ids: [],
+        },
+        opt: {
+          a: '1',
+          b: '2',
+          notes: [],
+        },
+      })
+    }
+
+    it 'reveals the right type' do
+      T.assert_type!(param, Param)
+      T.assert_type!(param.id, Integer)
+      T.assert_type!(param.info, ParamInfo)
+      T.assert_type!(param.info.name,String)
+      T.assert_type!(param.info.lvl, Integer)
+      T.assert_type!(param.opt, T.nilable(ParamInfo2))
+    end
+
+    it 'coerces correctly' do
+      expect(param.id).to eql 1
+      expect(param.role).to eql 'wizard'
+      expect(param.info.lvl).to eql 100
+      expect(param.info.name).to eql 'mango'
+      expect(param.info.skill_ids).to eql [123, 456]
+      expect(param.opt.notes).to eql []
+
+      expect(param2.id).to eql 2
+      expect(param2.info.name).to eql 'honeydew'
+      expect(param2.info.lvl).to eql 5
+      expect(param2.info.skill_ids).to eql []
+      expect(param2.opt.a).to eql 1
+      expect(param2.opt.b).to eql 2
+      expect(param2.opt.notes).to eql []
+
+      expect {
+        T::Coerce[Param].new.from({
+          id: 3,
+          info: {
+            # missing required name
+            lvl: 2,
+          },
+        })
+      }.to raise_error(ArgumentError)
+
+      expect(T::Coerce[DefaultParams].new.from(nil).a).to be 1
+      expect(T::Coerce[DefaultParams].new.from('').a).to be 1
+    end
+  end
+
+  context 'when the given T::Struct is invalid' do
+    class Param2 < T::Struct
+      const :id, Integer
+      const :info, T.any(Integer, String)
+    end
+
+    it 'raises an error' do
+      expect {
+        T::Coerce[Param2].new.from({id: 1, info: 1})
+      }.to raise_error(ArgumentError)
+    end
+  end
+
+  context 'when given primitive types' do
+    it 'reveals the right type' do
+      T.assert_type!(T::Coerce[Integer].new.from(1), Integer)
+      T.assert_type!(T::Coerce[Integer].new.from('1.0'), Integer)
+      T.assert_type!(T::Coerce[T.nilable(Integer)].new.from(nil), T.nilable(Integer))
+    end
+
+    it 'coreces correctly' do
+      expect{T::Coerce[Integer].new.from(nil)}.to raise_error(TypeError)
+      expect(T::Coerce[T.nilable(Integer)].new.from(nil) || 1).to eql 1
+      expect(T::Coerce[Integer].new.from(2)).to eql 2
+      expect(T::Coerce[Integer].new.from('1.0')).to eql 1
+
+      expect{T::Coerce[T.nilable(Integer)].new.from('invalid integer string')}.to raise_error(T::Coerce::CoercionError)
+      expect(T::Coerce[Float].new.from('1.0')).to eql 1.0
+
+      expect(T::Coerce[T::Boolean].new.from('false')).to be false
+      expect(T::Coerce[T::Boolean].new.from('true')).to be true
+
+      expect(T::Coerce[T.nilable(Integer)].new.from('')).to be nil
+      expect{T::Coerce[T.nilable(Integer)].new.from([])}.to raise_error(T::Coerce::CoercionError)
+      expect(T::Coerce[T.nilable(String)].new.from('')).to eql ''
+    end
+  end
+
+  context 'when given custom types' do
+    it 'coerces correctly' do
+      T.assert_type!(T::Coerce[CustomType].new.from(a: 1), CustomType)
+      expect(T::Coerce[CustomType].new.from(1).a).to be 1
+
+      expect{T::Coerce[UnsupportedCustomType].new.from(1)}.to raise_error(ArgumentError)
+      # CustomType2.new(anything) returns Integer 1; 1.is_a?(CustomType2) == false
+      expect{T::Coerce[CustomType2].new.from(1)}.to raise_error(TypeError)
+    end
+  end
+
+  context 'when dealing with arries' do
+    it 'coreces correctly' do
+      expect(T::Coerce[T::Array[Integer]].new.from(nil)).to eql []
+      expect(T::Coerce[T::Array[Integer]].new.from('')).to eql []
+      expect{T::Coerce[T::Array[Integer]].new.from('not an array')}.to raise_error(T::Coerce::ShapeError)
+      expect{T::Coerce[T::Array[Integer]].new.from('1')}.to raise_error(T::Coerce::ShapeError)
+      expect(T::Coerce[T::Array[Integer]].new.from(['1', '2', '3'])).to eql [1, 2, 3]
+      expect{T::Coerce[T::Array[Integer]].new.from(['1', 'invalid', '3'])}.to raise_error(T::Coerce::CoercionError)
+      expect{T::Coerce[T::Array[Integer]].new.from({a: 1})}.to raise_error(T::Coerce::CoercionError)
+
+      infos = T::Coerce[T::Array[ParamInfo]].new.from([{name: 'a', skill_ids: []}])
+      T.assert_type!(infos, T::Array[ParamInfo])
+      expect(infos.first.name).to eql 'a'
+
+      infos = T::Coerce[T::Array[ParamInfo]].new.from([{name: 'b', skill_ids: []}])
+      T.assert_type!(infos, T::Array[ParamInfo])
+      expect(infos.first.name).to eql 'b'
+
+      expect {
+        T::Coerce[ParamInfo2].new.from({a: nil, b: nil})
+      }.to raise_error(TypeError)
+    end
+  end
+
+  context 'when given a type alias' do
+    MyType = T.type_alias(T::Boolean)
+
+    it 'coerces correctly' do
+      expect(T::Coerce[MyType].new.from('false')).to be false
+    end
+  end
+end

data/spec/nested_spec.rb

@@ -0,0 +1,79 @@
+# typed: false
+require 'sorbet-coerce'
+require 'sorbet-runtime'
+
+describe T::Coerce do
+  context 'when given nested types' do
+    class User < T::Struct
+      const :id, Integer
+      const :valid, T.nilable(T::Boolean)
+    end
+
+    class NestedParam < T::Struct
+      const :users, T::Array[User]
+      const :params, T.nilable(NestedParam)
+    end
+
+    it 'works with nest T::Struct' do
+      converted = T::Coerce[NestedParam].new.from({
+        users: [{id: '1'}],
+        params: {
+          users: [{id: '2', valid: 'true'}],
+          params: {
+            users: [{id: '3', valid: 'true'}],
+          },
+        },
+      })
+      # => <NestedParam
+      #   params=<NestedParam
+      #     params=<NestedParam
+      #       params=nil,
+      #       users=[<User id=3 valid=true>]
+      #     >,
+      #     users=[<User id=2 valid=true>]
+      #   >,
+      #   users=[<User id=1 valid=nil>]
+      # >
+
+      expect(converted.users.map(&:id)).to eql([1])
+      expect(converted.params.users.map(&:id)).to eql([2])
+      expect(converted.params.params.users.map(&:id)).to eql([3])
+    end
+
+    it 'works with nest T::Array' do
+      expect {
+        T::Coerce[T::Array[T.nilable(Integer)]].new.from(['1', 'invalid', '3'])
+      }.to raise_error(T::Coerce::CoercionError)
+      expect(
+        T::Coerce[T::Array[T::Array[Integer]]].new.from([nil])
+      ).to eql([[]])
+      expect(
+        T::Coerce[T::Array[T::Array[Integer]]].new.from([['1'], ['2'], ['3']]),
+      ).to eql [[1], [2], [3]]
+
+      expect(T::Coerce[
+        T::Array[
+          T::Array[
+            T::Array[User]
+          ]
+        ]
+      ].new.from([[[{id: '1'}]]]).flatten.first.id).to eql(1)
+
+      expect(T::Coerce[
+        T::Array[
+          T::Array[
+            T::Array[
+              T::Array[
+                T::Array[User]
+              ]
+            ]
+          ]
+        ]
+      ].new.from([[[[[{id: 1}]]]]]).flatten.first.id).to eql 1
+
+      expect(T::Coerce[
+        T.nilable(T::Array[T.nilable(T::Array[T.nilable(User)])])
+      ].new.from([[{id: '1'}]]).flatten.map(&:id)).to eql([1])
+    end
+  end
+end

data/spec/soft_error_spec.rb

@@ -0,0 +1,66 @@
+# typed: false
+require 'sorbet-coerce'
+require 'sorbet-runtime'
+
+describe T::Coerce do
+  context 'when type errors are soft errors' do
+    let(:ignore_error) { Proc.new {} }
+
+    before(:each) do
+      allow(T::Coerce::Configuration).to receive(
+        :raise_coercion_error,
+      ).and_return(false)
+
+      allow(T::Configuration).to receive(
+        :inline_type_error_handler,
+      ).and_return(ignore_error)
+
+      allow(T::Configuration).to receive(
+        :call_validation_error_handler,
+      ).and_return(ignore_error)
+
+      allow(T::Configuration).to receive(
+        :sig_builder_error_handler,
+      ).and_return(ignore_error)
+    end
+
+    class ParamsWithSortError < T::Struct
+      const :a, Integer
+    end
+
+    class CustomTypeRaisesHardError
+      def initialize(value)
+        raise StandardError.new('value cannot be 1') if value == 1
+      end
+    end
+
+    class CustomTypeDoesNotRiaseHardError
+      def self.new(a); 1; end
+    end
+
+    let(:invalid_arg) { 'invalid integer string' }
+
+    it 'overwrites the global config when inline config is set' do
+      expect {
+        T::Coerce[Integer].new.from(invalid_arg, raise_coercion_error: true)
+      }.to raise_error(T::Coerce::CoercionError)
+    end
+
+    it 'works as expected' do
+      expect(T::Coerce[Integer].new.from(invalid_arg)).to eql(nil)
+
+      expect{T::Coerce[T::Array[Integer]].new.from(1)}.to raise_error(T::Coerce::ShapeError)
+      expect(T::Coerce[T::Array[Integer]].new.from({a: 1})).to eql([nil])
+
+      expect {
+        T::Coerce[CustomTypeRaisesHardError].new.from(1)
+      }.to raise_error(StandardError)
+      expect(T::Coerce[CustomTypeDoesNotRiaseHardError].new.from(1)).to eql(1)
+
+      sorbet_version = Gem.loaded_specs['sorbet-runtime'].version
+      if sorbet_version >= Gem::Version.new('0.4.4948')
+        expect(T::Coerce[ParamsWithSortError].new.from({a: invalid_arg}).a).to eql(nil)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+# typed: strict
+require 'byebug'
+require 'simplecov'
+
+SimpleCov.start
+
+if ENV['CI'] == 'true'
+  require 'codecov'
+  SimpleCov.formatter = SimpleCov::Formatter::Codecov
+end
+
+RSpec.configure do |config|
+  config.expect_with(:rspec) { |c| c.syntax = :expect }
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sorbet-coerce
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Chan Zuckerberg Initiative
@@ -14,14 +14,14 @@ dependencies:
   name: sorbet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.4704
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.4704
 - !ruby/object:Gem::Dependency
@@ -62,54 +62,54 @@ dependencies:
   name: sorbet-runtime
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.4704
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.4704
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.8'
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.8'
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.8'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 11.0.1
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 11.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 11.0.1
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 11.0.1
 description: 
@@ -118,9 +118,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/configuration.rb
 - lib/private/converter.rb
 - lib/sorbet-coerce.rb
-- lib/sorbet-coerce.rbi
+- rbi/sorbet-coerce.rbi
+- spec/coerce_spec.rb
+- spec/nested_spec.rb
+- spec/soft_error_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/chanzuckerberg/sorbet-coerce
 licenses:
 - MIT
@@ -133,7 +138,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -141,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.9
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: A type coercion lib works with Sorbet's static type checker and type definitions;

data/lib/sorbet-coerce.rbi

@@ -1,13 +0,0 @@
-# typed: strong
-
-module T
-  module Coerce
-    extend T::Sig
-    extend T::Generic
-
-    Elem = type_member
-
-    sig { params(args: T.untyped).returns(Elem) }
-    def from(args); end
-  end
-end