sorbet-schema 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a84e583349600c869258e039e2e77f14dad713fb1c3a8d60c8759d962ff4eaef
-  data.tar.gz: 67658459bd944e7118b45cb2fcfd5abbaea9c212153edec253d5d329519d772c
+  metadata.gz: e55d3305b62c159b5843939a7851c7e69614b5a940b0f3ec76d2946e76022611
+  data.tar.gz: d9574d1aabe4909e7076eeec87e430bd9b2ff4a31c4e1a7f3929a5bcabdc430a
 SHA512:
-  metadata.gz: 8ac735414ed3ed8668384f68d49c666abf8426410adabcdae115d533dd9110f4cdda2eaf5bc8c85f60797101a8d1dc3723b9fd52740144f639ff390abded0719
-  data.tar.gz: fd4877530222a722f9a3e719bb592d06ae9d6b979b5b22aac7638a80a678779e0d9408a014ed857cba938fe3e0410d6af1f542c865b843462427e6b2467c3813
+  metadata.gz: e6e17d592757da12f27ac1b7f7a4e33c24b4c81bce5005d6cd7d7e3d6f4ce79c568fcd9d07d86a9af76a61c22bd5bb4b428c0d7e250685932537a31d1c16b301
+  data.tar.gz: 0062e1b11c2f748f901549ca534ba0f302c58f899975d6f2dceccd50d09b52180d53c2303b08ee06219073ca09b3545452238582889bc1dd17a75e1cbfb124a5

data/CHANGELOG.md

@@ -4,6 +4,24 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.2.1](https://github.com/maxveldink/sorbet-schema/compare/v0.2.0...v0.2.1) (2024-03-11)
+
+
+### Bug Fixes
+
+* Add options argument for use by ActiveSupport serialization ([#37](https://github.com/maxveldink/sorbet-schema/issues/37)) ([4326c00](https://github.com/maxveldink/sorbet-schema/commit/4326c00d20e4f16de1c4a0562725b403fea92afd))
+
+## [0.2.0](https://github.com/maxveldink/sorbet-schema/compare/v0.1.1...v0.2.0) (2024-03-08)
+
+
+### ⚠ BREAKING CHANGES
+
+* Allow for custom Coercers ([#34](https://github.com/maxveldink/sorbet-schema/issues/34))
+
+### Features
+
+* Allow for custom Coercers ([#34](https://github.com/maxveldink/sorbet-schema/issues/34)) ([54c6a53](https://github.com/maxveldink/sorbet-schema/commit/54c6a53019b18d65b18d6d1130c1034f1f6b1341))
+
 ## [0.1.1](https://github.com/maxveldink/sorbet-schema/compare/v0.1.0...v0.1.1) (2024-03-08)
 
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sorbet-schema (0.1.1)
+    sorbet-schema (0.2.1)
       sorbet-result (~> 1.1)
       sorbet-runtime (~> 0.5)
       sorbet-struct-comparable (~> 1.3)
@@ -72,16 +72,16 @@ GEM
     rubocop-sorbet (0.7.7)
       rubocop (>= 0.90.0)
     ruby-progressbar (1.13.0)
-    sorbet (0.5.11284)
-      sorbet-static (= 0.5.11284)
+    sorbet (0.5.11287)
+      sorbet-static (= 0.5.11287)
     sorbet-result (1.1.0)
       sorbet-runtime (~> 0.5)
-    sorbet-runtime (0.5.11284)
-    sorbet-static (0.5.11284-universal-darwin)
-    sorbet-static (0.5.11284-x86_64-linux)
-    sorbet-static-and-runtime (0.5.11284)
-      sorbet (= 0.5.11284)
-      sorbet-runtime (= 0.5.11284)
+    sorbet-runtime (0.5.11287)
+    sorbet-static (0.5.11287-universal-darwin)
+    sorbet-static (0.5.11287-x86_64-linux)
+    sorbet-static-and-runtime (0.5.11287)
+      sorbet (= 0.5.11287)
+      sorbet-runtime (= 0.5.11287)
     sorbet-struct-comparable (1.3.0)
       sorbet-runtime (>= 0.5)
     spoom (1.2.4)

data/lib/sorbet-schema/struct_ext.rb

@@ -29,8 +29,8 @@ module T
       Typed::HashSerializer.new(schema: self.class.create_schema).serialize(self)
     end
 
-    sig { returns(String) }
-    def to_json
+    sig { params(_options: T::Hash[T.untyped, T.untyped]).returns(String) }
+    def to_json(_options = {})
       Typed::JSONSerializer.new(schema: self.class.create_schema).serialize(self)
     end
   end

data/lib/sorbet-schema/version.rb

@@ -1,5 +1,5 @@
 # typed: strict
 
 module SorbetSchema
-  VERSION = "0.1.1"
+  VERSION = "0.2.1"
 end

data/lib/typed/coercion/coercer.rb

@@ -2,7 +2,7 @@
 
 module Typed
   module Coercion
-    module Coercer
+    class Coercer
       extend T::Sig
       extend T::Generic
 
@@ -10,6 +10,10 @@ module Typed
 
       Target = type_member(:out)
 
+      sig { abstract.params(type: T::Class[T.anything]).returns(T::Boolean) }
+      def used_for_type?(type)
+      end
+
       sig { abstract.params(field: Field, value: Value).returns(Result[Target, CoercionError]) }
       def coerce(field:, value:)
       end

data/lib/typed/coercion/coercer_registry.rb

@@ -0,0 +1,37 @@
+# typed: strict
+
+require "singleton"
+
+module Typed
+  module Coercion
+    class CoercerRegistry
+      extend T::Sig
+
+      include Singleton
+
+      Registry = T.type_alias { T::Array[T.class_of(Coercer)] }
+
+      DEFAULT_COERCERS = T.let([StringCoercer, IntegerCoercer, FloatCoercer, StructCoercer], Registry)
+
+      sig { void }
+      def initialize
+        @available = T.let(DEFAULT_COERCERS.clone, Registry)
+      end
+
+      sig { params(coercer: T.class_of(Coercer)).void }
+      def register(coercer)
+        @available.prepend(coercer)
+      end
+
+      sig { void }
+      def reset!
+        @available = DEFAULT_COERCERS.clone
+      end
+
+      sig { params(type: T::Class[T.anything]).returns(T.nilable(T.class_of(Coercer))) }
+      def select_coercer_by(type:)
+        @available.find { |coercer| coercer.new.used_for_type?(type) }
+      end
+    end
+  end
+end

data/lib/typed/coercion/float_coercer.rb

@@ -2,16 +2,18 @@
 
 module Typed
   module Coercion
-    class FloatCoercer
-      extend T::Sig
+    class FloatCoercer < Coercer
       extend T::Generic
 
-      extend Coercer
+      Target = type_member { {fixed: Float} }
 
-      Target = type_template { {fixed: Float} }
+      sig { override.params(type: T::Class[T.anything]).returns(T::Boolean) }
+      def used_for_type?(type)
+        type == Float
+      end
 
       sig { override.params(field: Field, value: Value).returns(Result[Target, CoercionError]) }
-      def self.coerce(field:, value:)
+      def coerce(field:, value:)
         Success.new(Float(value))
       rescue ArgumentError, TypeError
         Failure.new(CoercionError.new("'#{value}' cannot be coerced into Float."))

data/lib/typed/coercion/integer_coercer.rb

@@ -2,16 +2,18 @@
 
 module Typed
   module Coercion
-    class IntegerCoercer
-      extend T::Sig
+    class IntegerCoercer < Coercer
       extend T::Generic
 
-      extend Coercer
+      Target = type_member { {fixed: Integer} }
 
-      Target = type_template { {fixed: Integer} }
+      sig { override.params(type: T::Class[T.anything]).returns(T::Boolean) }
+      def used_for_type?(type)
+        type == Integer
+      end
 
       sig { override.params(field: Field, value: Value).returns(Result[Target, CoercionError]) }
-      def self.coerce(field:, value:)
+      def coerce(field:, value:)
         Success.new(Integer(value))
       rescue ArgumentError, TypeError
         Failure.new(CoercionError.new("'#{value}' cannot be coerced into Integer."))

data/lib/typed/coercion/string_coercer.rb

@@ -2,16 +2,18 @@
 
 module Typed
   module Coercion
-    class StringCoercer
-      extend T::Sig
+    class StringCoercer < Coercer
       extend T::Generic
 
-      extend Coercer
+      Target = type_member { {fixed: String} }
 
-      Target = type_template { {fixed: String} }
+      sig { override.params(type: T::Class[T.anything]).returns(T::Boolean) }
+      def used_for_type?(type)
+        type == String
+      end
 
       sig { override.params(field: Field, value: Value).returns(Result[Target, CoercionError]) }
-      def self.coerce(field:, value:)
+      def coerce(field:, value:)
         Success.new(String(value))
       end
     end

data/lib/typed/coercion/struct_coercer.rb

@@ -2,16 +2,18 @@
 
 module Typed
   module Coercion
-    class StructCoercer
-      extend T::Sig
+    class StructCoercer < Coercer
       extend T::Generic
 
-      extend Coercer
+      Target = type_member { {fixed: T::Struct} }
 
-      Target = type_template { {fixed: T::Struct} }
+      sig { override.params(type: T::Class[T.anything]).returns(T::Boolean) }
+      def used_for_type?(type)
+        !!(type < T::Struct)
+      end
 
       sig { override.params(field: Field, value: Value).returns(Result[Target, CoercionError]) }
-      def self.coerce(field:, value:)
+      def coerce(field:, value:)
         type = field.type
 
         return Failure.new(CoercionError.new("Field type must inherit from T::Struct for Struct coercion.")) unless type < T::Struct

data/lib/typed/coercion.rb

@@ -4,23 +4,18 @@ module Typed
   module Coercion
     extend T::Sig
 
-    # TODO: We can definitely improve how we select which coercer to use
-    #   Related issues:
-    #   * https://github.com/maxveldink/sorbet-schema/issues/9
-    #   * https://github.com/maxveldink/sorbet-schema/issues/10
+    sig { params(coercer: T.class_of(Coercer)).void }
+    def self.register_coercer(coercer)
+      CoercerRegistry.instance.register(coercer)
+    end
+
     sig { type_parameters(:U).params(field: Field, value: Value).returns(Result[Value, CoercionError]) }
     def self.coerce(field:, value:)
-      if field.type < T::Struct
-        StructCoercer.coerce(field: field, value: value)
-      elsif field.type == String
-        StringCoercer.coerce(field: field, value: value)
-      elsif field.type == Integer
-        IntegerCoercer.coerce(field: field, value: value)
-      elsif field.type == Float
-        FloatCoercer.coerce(field: field, value: value)
-      else
-        Failure.new(CoercionNotSupportedError.new)
-      end
+      coercer = CoercerRegistry.instance.select_coercer_by(type: field.type)
+
+      return Failure.new(CoercionNotSupportedError.new) unless coercer
+
+      coercer.new.coerce(field: field, value: value)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sorbet-schema
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Max VelDink
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-03-08 00:00:00.000000000 Z
+date: 2024-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-result
@@ -89,6 +89,7 @@ files:
 - lib/sorbet-schema/version.rb
 - lib/typed/coercion.rb
 - lib/typed/coercion/coercer.rb
+- lib/typed/coercion/coercer_registry.rb
 - lib/typed/coercion/coercion_error.rb
 - lib/typed/coercion/coercion_not_supported_error.rb
 - lib/typed/coercion/float_coercer.rb