sorbet-coerce 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5c3d4dbcef7e149630285f69ffdb189af9c939a6fc23569550f98c8f6dee5fa
-  data.tar.gz: d6692abfe404b6cc9c0a7e3e79a7c3ff43416f1a68ab9c2140f552d17395141e
+  metadata.gz: f267197b77c7b2c9ed7558ad7f94818fc54f9af5fc56c99c9d824af47e40bf78
+  data.tar.gz: 04da4e2a3ebdde38cf4d2e6d60200c365d371250f9d33f588f67adc5b766c6b2
 SHA512:
-  metadata.gz: 71d5ff39ed7674752b3437e812d4518c7f3e51d28d517e47fcdaea32d0d548c8e56eb9178158a8db990fa15d1dce71f91697a4250c99578dda1b05fa91503e95
-  data.tar.gz: bf4534d41c56e2e82a5a5219099dcefa8d96fd4887670b50c86dfd60dede71710dbc934addafb83e833a7a7ce221789244089ddfb5caec637e84af57e1bf325e
+  metadata.gz: 6ee1d39f9e9b12ebdb2d3f1f9c4066ef2f7707329dfe10ab3330fc33b9e943ae9560028ec467203efad12bad567eb5b226ae4669be0b378bf1897a3ca84fbe37
+  data.tar.gz: a989b4a83745234e88e5c1ba5f26bda2d57be9ec0f61d26d4ece75f5db68bc88130fad68ec9fd43c6a4a44ae263231b65c8a0235bd34188b9c875f377ad9ddee

data/lib/configuration.rb

@@ -1,7 +1,7 @@
 # typed: true
 require 'sorbet-runtime'
 
-module T::Coerce
+module TypeCoerce
   module Configuration
     class << self
       extend T::Sig
@@ -12,4 +12,4 @@ module T::Coerce
   end
 end
 
-T::Coerce::Configuration.raise_coercion_error = true
+TypeCoerce::Configuration.raise_coercion_error = true

data/lib/private/converter.rb

@@ -1,11 +1,14 @@
 # typed: strict
 require 'safe_type'
+require 'set'
 require 'sorbet-runtime'
 require 'polyfill'
 
 using Polyfill(Hash: %w[#slice])
 
-module T::Private
+module TypeCoerce; end
+
+module TypeCoerce::Private
   class Converter
     extend T::Sig
 
@@ -22,8 +25,12 @@ module T::Private
     protected
     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)
+      if type.is_a?(T::Types::Untyped)
+        value
+      elsif type.is_a?(T::Types::TypedArray)
         _convert_to_a(value, type.type, raise_coercion_error)
+      elsif type.is_a?(T::Types::TypedSet)
+        Set.new(_convert_to_a(value, type.type, raise_coercion_error))
       elsif type.is_a?(T::Types::Simple)
         _convert(value, type.raw_type, raise_coercion_error)
       elsif type.is_a?(T::Types::Union)
@@ -53,7 +60,7 @@ module T::Private
         end
       elsif type.is_a?(T::Types::TypedHash)
         unless value.respond_to?(:map)
-          raise T::Coerce::ShapeError.new(value, type)
+          raise TypeCoerce::ShapeError.new(value, type)
         end
 
         value.map do |k, v|
@@ -91,7 +98,7 @@ module T::Private
       SafeType::coerce(value, safe_type_rule)
     rescue SafeType::EmptyValueError, SafeType::CoercionError
       if raise_coercion_error
-        raise T::Coerce::CoercionError.new(value, type)
+        raise TypeCoerce::CoercionError.new(value, type)
       else
         nil
       end
@@ -104,7 +111,7 @@ module T::Private
       return [] if _nil_like?(ary, type)
 
       unless ary.respond_to?(:map)
-        raise T::Coerce::ShapeError.new(ary, type)
+        raise TypeCoerce::ShapeError.new(ary, type)
       end
 
       ary.map { |value| _convert(value, type, raise_coercion_error) }
@@ -115,7 +122,7 @@ module T::Private
       return {} if _nil_like?(args, Hash)
 
       unless args.respond_to?(:each_pair)
-        raise T::Coerce::ShapeError.new(args, type)
+        raise TypeCoerce::ShapeError.new(args, type)
       end
 
       props = type.props

data/lib/sorbet-coerce.rb

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

data/rbi/sorbet-coerce.rbi

@@ -3,20 +3,20 @@ module SafeType
   class CoercionError < StandardError; end
 end
 
-module T
-  module Coerce
-    extend T::Sig
-    extend T::Generic
+module TypeCoerce
+  extend T::Sig
+  extend T::Generic
 
-    Elem = type_member
+  Elem = type_member
 
-    sig { params(args: T.untyped, raise_coercion_error: T.nilable(T::Boolean)).returns(Elem) }
-    def from(args, raise_coercion_error: nil); end
+  sig { params(args: T.untyped, raise_coercion_error: T.nilable(T::Boolean)).returns(Elem) }
+  def from(args, raise_coercion_error: nil); end
 
-    class CoercionError < SafeType::CoercionError; end
-    class ShapeError < SafeType::CoercionError; end
-  end
+  class CoercionError < SafeType::CoercionError; end
+  class ShapeError < SafeType::CoercionError; end
+end
 
+module T
   module Private
     module Types
       class TypeAlias

data/spec/coerce_spec.rb

@@ -2,7 +2,7 @@
 require 'sorbet-coerce'
 require 'sorbet-runtime'
 
-describe T::Coerce do
+describe TypeCoerce do
   context 'when given T::Struct' do
     class ParamInfo < T::Struct
       const :name, String
@@ -48,7 +48,7 @@ describe T::Coerce do
     end
 
     let!(:param) {
-      T::Coerce[Param].new.from({
+      TypeCoerce[Param].new.from({
         id: 1,
         info: {
           name: 'mango',
@@ -64,7 +64,7 @@ describe T::Coerce do
     }
 
     let!(:param2) {
-      T::Coerce[Param].new.from({
+      TypeCoerce[Param].new.from({
         id: '2',
         info: {
           name: 'honeydew',
@@ -105,7 +105,7 @@ describe T::Coerce do
       expect(param2.opt.notes).to eql []
 
       expect {
-        T::Coerce[Param].new.from({
+        TypeCoerce[Param].new.from({
           id: 3,
           info: {
             # missing required name
@@ -114,8 +114,8 @@ describe T::Coerce do
         })
       }.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
+      expect(TypeCoerce[DefaultParams].new.from(nil).a).to be 1
+      expect(TypeCoerce[DefaultParams].new.from('').a).to be 1
     end
   end
 
@@ -127,74 +127,74 @@ describe T::Coerce do
 
     it 'raises an error' do
       expect {
-        T::Coerce[Param2].new.from({id: 1, info: 1})
+        TypeCoerce[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))
+      T.assert_type!(TypeCoerce[Integer].new.from(1), Integer)
+      T.assert_type!(TypeCoerce[Integer].new.from('1.0'), Integer)
+      T.assert_type!(TypeCoerce[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{TypeCoerce[Integer].new.from(nil)}.to raise_error(TypeError)
+      expect(TypeCoerce[T.nilable(Integer)].new.from(nil) || 1).to eql 1
+      expect(TypeCoerce[Integer].new.from(2)).to eql 2
+      expect(TypeCoerce[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{TypeCoerce[T.nilable(Integer)].new.from('invalid integer string')}.to raise_error(TypeCoerce::CoercionError)
+      expect(TypeCoerce[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(TypeCoerce[T::Boolean].new.from('false')).to be false
+      expect(TypeCoerce[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 ''
+      expect(TypeCoerce[T.nilable(Integer)].new.from('')).to be nil
+      expect{TypeCoerce[T.nilable(Integer)].new.from([])}.to raise_error(TypeCoerce::CoercionError)
+      expect(TypeCoerce[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
+      T.assert_type!(TypeCoerce[CustomType].new.from(a: 1), CustomType)
+      expect(TypeCoerce[CustomType].new.from(1).a).to be 1
 
-      expect{T::Coerce[UnsupportedCustomType].new.from(1)}.to raise_error(ArgumentError)
+      expect{TypeCoerce[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)
+      expect{TypeCoerce[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: []}])
+      expect(TypeCoerce[T::Array[Integer]].new.from(nil)).to eql []
+      expect(TypeCoerce[T::Array[Integer]].new.from('')).to eql []
+      expect{TypeCoerce[T::Array[Integer]].new.from('not an array')}.to raise_error(TypeCoerce::ShapeError)
+      expect{TypeCoerce[T::Array[Integer]].new.from('1')}.to raise_error(TypeCoerce::ShapeError)
+      expect(TypeCoerce[T::Array[Integer]].new.from(['1', '2', '3'])).to eql [1, 2, 3]
+      expect{TypeCoerce[T::Array[Integer]].new.from(['1', 'invalid', '3'])}.to raise_error(TypeCoerce::CoercionError)
+      expect{TypeCoerce[T::Array[Integer]].new.from({a: 1})}.to raise_error(TypeCoerce::CoercionError)
+
+      infos = TypeCoerce[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: []}])
+      infos = TypeCoerce[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})
+        TypeCoerce[ParamInfo2].new.from({a: nil, b: nil})
       }.to raise_error(TypeError)
     end
   end
 
-  context 'when dealing with hashes'  do
+  context 'when dealing with hashes' do
     it 'coreces correctly' do
-      expect(T::Coerce[T::Hash[String, T::Boolean]].new.from({
+      expect(TypeCoerce[T::Hash[String, T::Boolean]].new.from({
         a: 'true',
         b: 'false',
       })).to eql({
@@ -202,21 +202,37 @@ describe T::Coerce do
         'b' => false,
       })
 
-      expect(T::Coerce[HashParams].new.from({
+      expect(TypeCoerce[HashParams].new.from({
         myhash: {'a' => '1', 'b' => '2'},
       }).myhash).to eql({'a' => 1, 'b' => 2})
 
 
       expect {
-        T::Coerce[T::Hash[String, T::Boolean]].new.from({
+        TypeCoerce[T::Hash[String, T::Boolean]].new.from({
           a: 'invalid',
           b: 'false',
         })
-      }.to raise_error(T::Coerce::CoercionError)
+      }.to raise_error(TypeCoerce::CoercionError)
 
       expect {
-        T::Coerce[T::Hash[String, Integer]].new.from(1)
-      }.to raise_error(T::Coerce::ShapeError)
+        TypeCoerce[T::Hash[String, Integer]].new.from(1)
+      }.to raise_error(TypeCoerce::ShapeError)
+    end
+  end
+
+  context 'when dealing with sets' do
+    it 'coreces correctly' do
+      expect(TypeCoerce[T::Set[Integer]].new.from(
+        Set.new(['1', '2', '3'])
+      )).to eq Set.new([1, 2, 3])
+
+      expect {
+        TypeCoerce[T::Set[Integer]].new.from(Set.new(['1', 'invalid', '3']))
+      }.to raise_error(TypeCoerce::CoercionError)
+
+      expect {
+        TypeCoerce[T::Set[Integer]].new.from(1)
+      }.to raise_error(TypeCoerce::ShapeError)
     end
   end
 
@@ -224,7 +240,14 @@ describe T::Coerce do
     MyType = T.type_alias(T::Boolean)
 
     it 'coerces correctly' do
-      expect(T::Coerce[MyType].new.from('false')).to be false
+      expect(TypeCoerce[MyType].new.from('false')).to be false
     end
   end
+
+  it 'works with T.untyped' do
+    expect(TypeCoerce[T.untyped].new.from(1)).to eql 1
+
+    obj = CustomType.new(1)
+    expect(TypeCoerce[T::Hash[String, T.untyped]].new.from({a: obj})).to eq({'a' => obj})
+  end
 end

data/spec/nested_spec.rb

@@ -2,7 +2,7 @@
 require 'sorbet-coerce'
 require 'sorbet-runtime'
 
-describe T::Coerce do
+describe TypeCoerce do
   context 'when given nested types' do
     class User < T::Struct
       const :id, Integer
@@ -15,7 +15,7 @@ describe T::Coerce do
     end
 
     it 'works with nest T::Struct' do
-      converted = T::Coerce[NestedParam].new.from({
+      converted = TypeCoerce[NestedParam].new.from({
         users: [{id: '1'}],
         params: {
           users: [{id: '2', valid: 'true'}],
@@ -42,16 +42,16 @@ describe T::Coerce do
 
     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)
+        TypeCoerce[T::Array[T.nilable(Integer)]].new.from(['1', 'invalid', '3'])
+      }.to raise_error(TypeCoerce::CoercionError)
       expect(
-        T::Coerce[T::Array[T::Array[Integer]]].new.from([nil])
+        TypeCoerce[T::Array[T::Array[Integer]]].new.from([nil])
       ).to eql([[]])
       expect(
-        T::Coerce[T::Array[T::Array[Integer]]].new.from([['1'], ['2'], ['3']]),
+        TypeCoerce[T::Array[T::Array[Integer]]].new.from([['1'], ['2'], ['3']]),
       ).to eql [[1], [2], [3]]
 
-      expect(T::Coerce[
+      expect(TypeCoerce[
         T::Array[
           T::Array[
             T::Array[User]
@@ -59,7 +59,7 @@ describe T::Coerce do
         ]
       ].new.from([[[{id: '1'}]]]).flatten.first.id).to eql(1)
 
-      expect(T::Coerce[
+      expect(TypeCoerce[
         T::Array[
           T::Array[
             T::Array[
@@ -71,7 +71,7 @@ describe T::Coerce do
         ]
       ].new.from([[[[[{id: 1}]]]]]).flatten.first.id).to eql 1
 
-      expect(T::Coerce[
+      expect(TypeCoerce[
         T.nilable(T::Array[T.nilable(T::Array[T.nilable(User)])])
       ].new.from([[{id: '1'}]]).flatten.map(&:id)).to eql([1])
     end

data/spec/soft_error_spec.rb

@@ -2,12 +2,12 @@
 require 'sorbet-coerce'
 require 'sorbet-runtime'
 
-describe T::Coerce do
+describe TypeCoerce do
   context 'when type errors are soft errors' do
     let(:ignore_error) { Proc.new {} }
 
     before(:each) do
-      allow(T::Coerce::Configuration).to receive(
+      allow(TypeCoerce::Configuration).to receive(
         :raise_coercion_error,
       ).and_return(false)
 
@@ -42,24 +42,24 @@ describe T::Coerce do
 
     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)
+        TypeCoerce[Integer].new.from(invalid_arg, raise_coercion_error: true)
+      }.to raise_error(TypeCoerce::CoercionError)
     end
 
     it 'works as expected' do
-      expect(T::Coerce[Integer].new.from(invalid_arg)).to eql(nil)
+      expect(TypeCoerce[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{TypeCoerce[T::Array[Integer]].new.from(1)}.to raise_error(TypeCoerce::ShapeError)
+      expect(TypeCoerce[T::Array[Integer]].new.from({a: 1})).to eql([nil])
 
       expect {
-        T::Coerce[CustomTypeRaisesHardError].new.from(1)
+        TypeCoerce[CustomTypeRaisesHardError].new.from(1)
       }.to raise_error(StandardError)
-      expect(T::Coerce[CustomTypeDoesNotRiaseHardError].new.from(1)).to eql(1)
+      expect(TypeCoerce[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)
+        expect(TypeCoerce[ParamsWithSortError].new.from({a: invalid_arg}).a).to eql(nil)
       end
     end
   end

data/spec/sorbet_test_cases.rb

@@ -1,22 +1,22 @@
 # typed: true
 require 'sorbet-coerce'
 
-T.assert_type!(T::Coerce[Integer].new.from('1'), Integer)
+T.assert_type!(TypeCoerce[Integer].new.from('1'), Integer)
 T.assert_type!(
-  T::Coerce[T.nilable(Integer)].new.from('invalid', raise_coercion_error: false),
+  TypeCoerce[T.nilable(Integer)].new.from('invalid', raise_coercion_error: false),
   T.nilable(Integer),
 )
 
-T::Coerce::Configuration.raise_coercion_error = true
+TypeCoerce::Configuration.raise_coercion_error = true
 coercion_error = nil
 begin
-  T::Coerce[T.nilable(Integer)].new.from('invalid')
-rescue T::Coerce::CoercionError => e
+  TypeCoerce[T.nilable(Integer)].new.from('invalid')
+rescue TypeCoerce::CoercionError => e
   coercion_error = e
 end
 raise 'no coercion error is raised' unless coercion_error
 
 T.assert_type!(
-  T::Coerce[T.nilable(Integer)].new.from('invalid', raise_coercion_error: false),
+  TypeCoerce[T.nilable(Integer)].new.from('invalid', raise_coercion_error: false),
   T.nilable(Integer),
 )

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sorbet-coerce
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Chan Zuckerberg Initiative