sorbet-coerce 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f267197b77c7b2c9ed7558ad7f94818fc54f9af5fc56c99c9d824af47e40bf78
-  data.tar.gz: 04da4e2a3ebdde38cf4d2e6d60200c365d371250f9d33f588f67adc5b766c6b2
+  metadata.gz: b3a8032d0ba46f76ce47d4ec30e3e486005028d61a06c4f1047d6691f3e995f4
+  data.tar.gz: 6ec0fd090fbce8cb3889d69ce10bfa07b74b928425af2f9a4ca47bf60d1d1889
 SHA512:
-  metadata.gz: 6ee1d39f9e9b12ebdb2d3f1f9c4066ef2f7707329dfe10ab3330fc33b9e943ae9560028ec467203efad12bad567eb5b226ae4669be0b378bf1897a3ca84fbe37
-  data.tar.gz: a989b4a83745234e88e5c1ba5f26bda2d57be9ec0f61d26d4ece75f5db68bc88130fad68ec9fd43c6a4a44ae263231b65c8a0235bd34188b9c875f377ad9ddee
+  metadata.gz: 4ec5337779c9eece9610d73a037662d36d2dc9e50cfc77dd2762fb323f90dcb6edca41ee1337c12074243b1a1587450753a8afce49f5923aaf4ee1f88cc0bb2b
+  data.tar.gz: 84a9967bac7c2fb07d7c0f7530f1c4063a687019cc66e5787d0d69b1973884cf7e32d245ff2e99cb258abb963ae037f68e7dcc84c78d5c8f1b253d5b2f0b123a

data/{rbi → lib/bundled_rbi}/sorbet-coerce.rbi

@@ -1,4 +1,4 @@
-# typed: true
+# typed: false
 module SafeType
   class CoercionError < StandardError; end
 end
@@ -15,13 +15,3 @@ module TypeCoerce
   class CoercionError < SafeType::CoercionError; end
   class ShapeError < SafeType::CoercionError; end
 end
-
-module T
-  module Private
-    module Types
-      class TypeAlias
-        def aliased_type; end
-      end
-    end
-  end
-end

data/lib/sorbet-coerce.rb

@@ -1,23 +1,8 @@
-# typed: strict
-require_relative 'configuration'
-require 'private/converter'
-require 'safe_type'
+# typed: ignore
+require 'sorbet-coerce/converter'
 
 module TypeCoerce
-  class CoercionError < SafeType::CoercionError; end
-  class ShapeError < SafeType::CoercionError; end
-
-  define_singleton_method(:[]) do |type|
-    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 = TypeCoerce::Configuration.raise_coercion_error
-        end
-
-        T.send('let', send('_convert', args, type, raise_coercion_error), type)
-      end
-    end
+  def self.[](type)
+    TypeCoerce::Converter.new(type)
   end
 end

data/lib/sorbet-coerce/converter.rb

@@ -0,0 +1,183 @@
+# typed: ignore
+require 'polyfill'
+require 'safe_type'
+require 'set'
+require 'sorbet-runtime'
+require 'sorbet-coerce/configuration'
+
+using Polyfill(Hash: %w[#slice])
+
+module TypeCoerce
+  class CoercionError < SafeType::CoercionError; end
+  class ShapeError < SafeType::CoercionError; end
+end
+
+class TypeCoerce::Converter
+  def initialize(type)
+    @type = type
+  end
+
+  def new
+    self
+  end
+
+  def to_s
+    "#{name}#[#{@type.to_s}]"
+  end
+
+  def from(args, raise_coercion_error: nil)
+    if raise_coercion_error.nil?
+      raise_coercion_error = TypeCoerce::Configuration.raise_coercion_error
+    end
+
+    T.let(_convert(args, @type, raise_coercion_error), @type)
+  end
+
+  private
+
+  PRIMITIVE_TYPES = T.let(::Set[
+    Date,
+    DateTime,
+    Float,
+    Integer,
+    String,
+    Symbol,
+    Time,
+  ], T.untyped)
+
+  def _convert(value, type, raise_coercion_error)
+    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)
+      true_idx = T.let(nil, T.nilable(Integer))
+      false_idx = T.let(nil, T.nilable(Integer))
+      nil_idx = T.let(nil, T.nilable(Integer))
+
+      type.types.each_with_index do |t, i|
+        nil_idx = i if t.is_a?(T::Types::Simple) && t.raw_type == NilClass
+        true_idx = i if t.is_a?(T::Types::Simple) && t.raw_type == TrueClass
+        false_idx = i if t.is_a?(T::Types::Simple) && t.raw_type == FalseClass
+      end
+
+      raise ArgumentError.new(
+        'the only supported union types are T.nilable and T::Boolean',
+      ) unless (
+        (!true_idx.nil? && !false_idx.nil? && !nil_idx.nil?) || # T.nilable(T::Boolean)
+        (type.types.length == 2 && (
+          !nil_idx.nil? || (!true_idx.nil? && !false_idx.nil?) # T.nilable || T::Boolean
+        ))
+      )
+
+      if !true_idx.nil? && !false_idx.nil?
+        _convert_simple(value, T::Boolean, raise_coercion_error)
+      else
+        _convert(value, type.types[nil_idx == 0 ? 1 : 0], raise_coercion_error)
+      end
+    elsif type.is_a?(T::Types::TypedHash)
+      return {} if _nil_like?(value, type)
+
+      unless value.respond_to?(:map)
+        raise TypeCoerce::ShapeError.new(value, type)
+      end
+
+      value.map do |k, v|
+        [
+          _convert(k, type.keys, raise_coercion_error),
+          _convert(v, type.values, raise_coercion_error),
+        ]
+      end.to_h
+    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.respond_to?(:<) && type < T::Struct
+      return value if value.is_a?(type)
+
+      args = _build_args(value, type, raise_coercion_error)
+      type.new(args)
+    elsif type.respond_to?(:<) && type < T::Enum
+      return value if value.is_a?(type)
+
+      _convert_enum(value, type, raise_coercion_error)
+    else
+      return value if value.is_a?(type)
+
+      _convert_simple(value, type, raise_coercion_error)
+    end
+  end
+
+  def _convert_enum(value, type, raise_coercion_error)
+    if raise_coercion_error
+      type.deserialize(value)
+    else
+      type.try_deserialize(value)
+    end
+  rescue KeyError
+    raise TypeCoerce::CoercionError.new(value, type)
+  end
+
+  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
+      safe_type_rule = SafeType::Boolean.strict
+    elsif value.is_a?(type)
+      return value
+    elsif PRIMITIVE_TYPES.include?(type)
+      safe_type_rule = SafeType.const_get(type.name).strict
+    else
+      safe_type_rule = type
+    end
+
+    if safe_type_rule.is_a?(SafeType::Rule)
+      SafeType::coerce(value, safe_type_rule)
+    else
+      type.new(value)
+    end
+  rescue SafeType::EmptyValueError, SafeType::CoercionError
+    if raise_coercion_error
+      raise TypeCoerce::CoercionError.new(value, type)
+    else
+      nil
+    end
+  end
+
+  def _convert_to_a(ary, type, raise_coercion_error)
+    return [] if _nil_like?(ary, type)
+
+    unless ary.respond_to?(:map)
+      raise TypeCoerce::ShapeError.new(ary, type)
+    end
+
+    ary.map { |value| _convert(value, type, raise_coercion_error) }
+  end
+
+  def _build_args(args, type, raise_coercion_error)
+    return {} if _nil_like?(args, Hash)
+
+    unless args.respond_to?(:each_pair)
+      raise TypeCoerce::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], raise_coercion_error),
+      ]
+    }.to_h.slice(*props.keys)
+  end
+
+  def _nil_like?(value, type)
+    value.nil? || (value == '' && type != String)
+  end
+end

data/spec/coerce_spec.rb

@@ -31,6 +31,21 @@ describe TypeCoerce do
       const :myhash, T::Hash[String, Integer]
     end
 
+    class HashParamsWithDefault < T::Struct
+      const :myhash, T::Hash[String, Integer], default: Hash['a' => 1]
+    end
+
+    class TestEnum < T::Enum
+      enums do
+        Test = new
+        Other = new
+      end
+    end
+
+    class WithEnum < T::Struct
+      const :myenum, TestEnum
+    end
+
     class CustomType
       attr_reader :a
 
@@ -95,6 +110,7 @@ describe TypeCoerce do
       expect(param.info.name).to eql 'mango'
       expect(param.info.skill_ids).to eql [123, 456]
       expect(param.opt.notes).to eql []
+      expect(TypeCoerce[Param].new.from(param)).to eq(param)
 
       expect(param2.id).to eql 2
       expect(param2.info.name).to eql 'honeydew'
@@ -159,8 +175,10 @@ describe TypeCoerce do
 
   context 'when given custom types' do
     it 'coerces correctly' do
-      T.assert_type!(TypeCoerce[CustomType].new.from(a: 1), CustomType)
-      expect(TypeCoerce[CustomType].new.from(1).a).to be 1
+      obj = TypeCoerce[CustomType].new.from(1)
+      T.assert_type!(obj, CustomType)
+      expect(obj.a).to be 1
+      expect(TypeCoerce[CustomType].new.from(obj)).to be obj
 
       expect{TypeCoerce[UnsupportedCustomType].new.from(1)}.to raise_error(ArgumentError)
       # CustomType2.new(anything) returns Integer 1; 1.is_a?(CustomType2) == false
@@ -194,6 +212,8 @@ describe TypeCoerce do
 
   context 'when dealing with hashes' do
     it 'coreces correctly' do
+      expect(TypeCoerce[T::Hash[T.untyped, T.untyped]].new.from(nil)).to eql({})
+
       expect(TypeCoerce[T::Hash[String, T::Boolean]].new.from({
         a: 'true',
         b: 'false',
@@ -206,6 +226,7 @@ describe TypeCoerce do
         myhash: {'a' => '1', 'b' => '2'},
       }).myhash).to eql({'a' => 1, 'b' => 2})
 
+      expect(TypeCoerce[HashParamsWithDefault].new.from({}).myhash).to eql({'a' => 1})
 
       expect {
         TypeCoerce[T::Hash[String, T::Boolean]].new.from({
@@ -244,6 +265,24 @@ describe TypeCoerce do
     end
   end
 
+  context 'when dealing with enums' do
+    it 'coerces a serialized enum correctly' do
+      coerced = TypeCoerce[WithEnum].new.from(myenum: "test")
+      expect(coerced.myenum).to eq(TestEnum::Test)
+    end
+
+    it 'handles a real enum correctly' do
+      coerced = TypeCoerce[WithEnum].new.from(myenum: TestEnum::Test)
+      expect(coerced.myenum).to eq(TestEnum::Test)
+    end
+
+    it 'handles bad enum' do
+      expect {
+        TypeCoerce[WithEnum].new.from(myenum: "bad_key")
+      }.to raise_error(TypeCoerce::CoercionError)
+    end
+  end
+
   it 'works with T.untyped' do
     expect(TypeCoerce[T.untyped].new.from(1)).to eql 1
 

data/spec/nested_spec.rb

@@ -75,5 +75,14 @@ describe TypeCoerce do
         T.nilable(T::Array[T.nilable(T::Array[T.nilable(User)])])
       ].new.from([[{id: '1'}]]).flatten.map(&:id)).to eql([1])
     end
+
+    it 'works with nested T::Hash' do
+      expect(
+        TypeCoerce[T::Hash[Symbol, T::Hash[Symbol, Integer]]].new.from({
+          a: nil,
+          b: {c: '1'}
+        })
+      ).to eql({a: {}, b: {c: 1}})
+    end
   end
 end

data/spec/soft_error_spec.rb

@@ -4,6 +4,12 @@ require 'sorbet-runtime'
 
 describe TypeCoerce do
   context 'when type errors are soft errors' do
+    class SoftErrorTestEnum < T::Enum
+      enums do
+        Other = new
+      end
+    end
+
     let(:ignore_error) { Proc.new {} }
 
     before(:each) do
@@ -48,6 +54,7 @@ describe TypeCoerce do
 
     it 'works as expected' do
       expect(TypeCoerce[Integer].new.from(invalid_arg)).to eql(nil)
+      expect(TypeCoerce[SoftErrorTestEnum].new.from('bad_key')).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])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sorbet-coerce
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Chan Zuckerberg Initiative
@@ -76,40 +76,40 @@ dependencies:
   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,10 +118,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/configuration.rb
-- lib/private/converter.rb
+- lib/bundled_rbi/sorbet-coerce.rbi
 - lib/sorbet-coerce.rb
-- rbi/sorbet-coerce.rbi
+- lib/sorbet-coerce/configuration.rb
+- lib/sorbet-coerce/converter.rb
 - spec/coerce_spec.rb
 - spec/nested_spec.rb
 - spec/soft_error_spec.rb
@@ -146,8 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: A type coercion lib works with Sorbet's static type checker and type definitions;

data/lib/private/converter.rb

@@ -1,144 +0,0 @@
-# typed: strict
-require 'safe_type'
-require 'set'
-require 'sorbet-runtime'
-require 'polyfill'
-
-using Polyfill(Hash: %w[#slice])
-
-module TypeCoerce; end
-
-module TypeCoerce::Private
-  class Converter
-    extend T::Sig
-
-    PRIMITIVE_TYPES = T.let(::Set[
-      Date,
-      DateTime,
-      Float,
-      Integer,
-      String,
-      Symbol,
-      Time,
-    ], T.untyped)
-
-    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::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)
-        true_idx = T.let(nil, T.nilable(Integer))
-        false_idx = T.let(nil, T.nilable(Integer))
-        nil_idx = T.let(nil, T.nilable(Integer))
-
-        type.types.each_with_index do |t, i|
-          nil_idx = i if t.is_a?(T::Types::Simple) && t.raw_type == NilClass
-          true_idx = i if t.is_a?(T::Types::Simple) && t.raw_type == TrueClass
-          false_idx = i if t.is_a?(T::Types::Simple) && t.raw_type == FalseClass
-        end
-
-        raise ArgumentError.new(
-          'the only supported union types are T.nilable and T::Boolean',
-        ) unless (
-          (!true_idx.nil? && !false_idx.nil? && !nil_idx.nil?) || # T.nilable(T::Boolean)
-          (type.types.length == 2 && (
-            !nil_idx.nil? || (!true_idx.nil? && !false_idx.nil?) # T.nilable || T::Boolean
-          ))
-        )
-
-        if !true_idx.nil? && !false_idx.nil?
-          _convert_simple(value, T::Boolean, raise_coercion_error)
-        else
-          _convert(value, type.types[nil_idx == 0 ? 1 : 0], raise_coercion_error)
-        end
-      elsif type.is_a?(T::Types::TypedHash)
-        unless value.respond_to?(:map)
-          raise TypeCoerce::ShapeError.new(value, type)
-        end
-
-        value.map do |k, v|
-          [
-            _convert(k, type.keys, raise_coercion_error),
-            _convert(v, type.values, raise_coercion_error),
-          ]
-        end.to_h
-      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, raise_coercion_error)
-        type.new(args)
-      else
-        _convert_simple(value, type, raise_coercion_error)
-      end
-    end
-
-    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
-        safe_type_rule = SafeType::Boolean.strict
-      elsif value.is_a?(type)
-        return value
-      elsif PRIMITIVE_TYPES.include?(type)
-        safe_type_rule = SafeType.const_get(type.name).strict
-      else
-        safe_type_rule = type
-      end
-      SafeType::coerce(value, safe_type_rule)
-    rescue SafeType::EmptyValueError, SafeType::CoercionError
-      if raise_coercion_error
-        raise TypeCoerce::CoercionError.new(value, type)
-      else
-        nil
-      end
-    rescue SafeType::InvalidRuleError
-      type.new(value)
-    end
-
-    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 TypeCoerce::ShapeError.new(ary, type)
-      end
-
-      ary.map { |value| _convert(value, type, raise_coercion_error) }
-    end
-
-    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 TypeCoerce::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], 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