sorbet-schema 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b4040ccaa87f90e0d32acee9868fffb0f4d645e599fe29726738fdb54c4f1e6
-  data.tar.gz: b83d96b38d8b7d786a3e174e576053f531bf03e237d7c1f049e98b9c813dc117
+  metadata.gz: d2adb1981aeb5218f9d137f472bd602a2b81bbe6e54166e2974f1c157f92d50a
+  data.tar.gz: 1f4ee3983069f2674aab270bb7d138ce3fc611154a4d5c37581b6698ac6f3189
 SHA512:
-  metadata.gz: 248121230fc7a86b616259a89db47c210360034aad0ec70a23e2b25d73b350e16eff09c09ea87efd0aa859ef86b6f5c7f7700043b2e0d3e1f570555e98baac31
-  data.tar.gz: 6f0c35a33ff1e84ebe704c30a6d0ba4b3520030c8ca59c897c33cc96f736c48c16e8672e7f4efef6f81f4a9816326db41c1cc625f49addd520a437066a04db1c
+  metadata.gz: d8b876a03ee53cafde5a9bbd9f46823d517aa6d69a3417a4e3c04591f1471066bc2912c2c26e00ba9e9294642912e4a4d58dafada77e8206685b4f726c23ae52
+  data.tar.gz: 9bf510fe1ef9e4b56ef9206ed1c5ea43bcb3934b1749c427afe76291a9b09871383d443f226f15cac733c39540180c2eed810d653b1728f73e11a8572f5b80be

data/CHANGELOG.md

@@ -4,6 +4,17 @@ 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.7.0](https://github.com/maxveldink/sorbet-schema/compare/v0.6.0...v0.7.0) (2024-07-08)
+
+
+### ⚠ BREAKING CHANGES
+
+* Fix mis-serializing hash keys that were suppose to be strings ([#111](https://github.com/maxveldink/sorbet-schema/issues/111))
+
+### Bug Fixes
+
+* Fix mis-serializing hash keys that were suppose to be strings ([#111](https://github.com/maxveldink/sorbet-schema/issues/111)) ([485a6c7](https://github.com/maxveldink/sorbet-schema/commit/485a6c7a83b9e70c731930d8406925304efa04a8))
+
 ## [0.6.0](https://github.com/maxveldink/sorbet-schema/compare/v0.5.1...v0.6.0) (2024-07-07)
 
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sorbet-schema (0.6.0)
+    sorbet-schema (0.7.0)
       sorbet-result (~> 1.1)
       sorbet-runtime (~> 0.5)
       sorbet-struct-comparable (~> 1.3)

data/lib/sorbet-schema/hash_transformer.rb

@@ -4,44 +4,21 @@
 # This is a simplified version of ActiveSupport's Key Hash extension
 # https://github.com/rails/rails/blob/main/activesupport/lib/active_support/core_ext/hash/keys.rb
 class HashTransformer
-  extend T::Sig
+  class << self
+    extend T::Sig
 
-  sig { params(should_serialize_values: T::Boolean).void }
-  def initialize(should_serialize_values: false)
-    @should_serialize_values = should_serialize_values
-  end
-
-  sig { params(hash: T::Hash[T.untyped, T.untyped]).returns(T::Hash[Symbol, T.untyped]) }
-  def deep_symbolize_keys(hash)
-    hash.each_with_object({}) do |(key, value), result|
-      result[key.to_sym] = transform_value(value, hash_transformation_method: :deep_symbolize_keys)
-    end
-  end
-
-  sig { params(hash: T::Hash[T.untyped, T.untyped]).returns(T::Hash[String, T.untyped]) }
-  def deep_stringify_keys(hash)
-    hash.each_with_object({}) do |(key, value), result|
-      result[key.to_s] = transform_value(value, hash_transformation_method: :deep_stringify_keys)
+    sig { params(hash: T::Hash[T.untyped, T.untyped]).returns(T::Hash[Symbol, T.untyped]) }
+    def symbolize_keys(hash)
+      hash.each_with_object({}) do |(key, value), result|
+        result[key.to_sym] = value
+      end
     end
-  end
-
-  private
-
-  sig { returns(T::Boolean) }
-  attr_reader :should_serialize_values
 
-  sig { params(value: T.untyped, hash_transformation_method: Symbol).returns(T.untyped) }
-  def transform_value(value, hash_transformation_method:)
-    if value.is_a?(Hash)
-      send(hash_transformation_method, value)
-    elsif value.is_a?(Array)
-      value.map { |inner_val| transform_value(inner_val, hash_transformation_method: hash_transformation_method) }
-    elsif value.is_a?(T::Struct) && should_serialize_values
-      deep_symbolize_keys(value.serialize)
-    elsif value.respond_to?(:serialize) && should_serialize_values
-      value.serialize
-    else
-      value
+    sig { params(hash: T::Hash[T.untyped, T.untyped]).returns(T::Hash[T.untyped, T.untyped]) }
+    def serialize_values(hash)
+      hash.each_with_object({}) do |(key, value), result|
+        result[key] = SerializeValue.serialize(value)
+      end
     end
   end
 end

data/lib/sorbet-schema/serialize_value.rb

@@ -0,0 +1,20 @@
+# typed: strict
+
+class SerializeValue
+  extend T::Sig
+
+  sig { params(value: T.untyped).returns(T.untyped) }
+  def self.serialize(value)
+    if value.is_a?(Hash)
+      HashTransformer.serialize_values(value)
+    elsif value.is_a?(Array)
+      value.map { |item| serialize(item) }
+    elsif value.is_a?(T::Struct)
+      value.serialize_to(:hash).payload_or(value)
+    elsif value.respond_to?(:serialize)
+      value.serialize
+    else
+      value
+    end
+  end
+end

data/lib/sorbet-schema/version.rb

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

data/lib/sorbet-schema.rb

@@ -16,10 +16,11 @@ loader.inflector.inflect(
 )
 loader.setup
 
-# We don't want to place this in the `Typed` module.
+# We don't want to place these in the `Typed` module.
 # `sorbet-schema` is a directory that is not autoloaded
 # but contains extensions, so we need to manually require it.
 require_relative "sorbet-schema/hash_transformer"
+require_relative "sorbet-schema/serialize_value"
 
 # We want to add a default `schema` method to structs
 # that will guarentee a schema can be created for use

data/lib/typed/hash_serializer.rb

@@ -15,14 +15,14 @@ module Typed
 
     sig { override.params(source: Input).returns(Result[T::Struct, DeserializeError]) }
     def deserialize(source)
-      deserialize_from_creation_params(HashTransformer.new(should_serialize_values: should_serialize_values).deep_symbolize_keys(source))
+      deserialize_from_creation_params(HashTransformer.symbolize_keys(source))
     end
 
     sig { override.params(struct: T::Struct).returns(Result[Output, SerializeError]) }
     def serialize(struct)
       return Failure.new(SerializeError.new("'#{struct.class}' cannot be serialized to target type of '#{schema.target}'.")) if struct.class != schema.target
 
-      Success.new(serialize_from_struct(struct: struct, should_serialize_values: should_serialize_values))
+      Success.new(serialize_from_struct(struct:, should_serialize_values:))
     end
 
     private

data/lib/typed/json_serializer.rb

@@ -24,7 +24,7 @@ module Typed
     def serialize(struct)
       return Failure.new(SerializeError.new("'#{struct.class}' cannot be serialized to target type of '#{schema.target}'.")) if struct.class != schema.target
 
-      Success.new(JSON.generate(serialize_from_struct(struct: struct, should_serialize_values: true)))
+      Success.new(JSON.generate(serialize_from_struct(struct:, should_serialize_values: true)))
     end
   end
 end

data/lib/typed/serializer.rb

@@ -82,7 +82,11 @@ module Typed
     def serialize_from_struct(struct:, should_serialize_values: false)
       hsh = schema.fields.each_with_object({}) { |field, hsh| hsh[field.name] = field.serialize(struct.send(field.name)) }.compact
 
-      HashTransformer.new(should_serialize_values: should_serialize_values).deep_symbolize_keys(hsh)
+      if should_serialize_values
+        hsh = HashTransformer.serialize_values(hsh)
+      end
+
+      hsh
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sorbet-schema
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Max VelDink
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-07-07 00:00:00.000000000 Z
+date: 2024-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-result
@@ -85,6 +85,7 @@ files:
 - Rakefile
 - lib/sorbet-schema.rb
 - lib/sorbet-schema/hash_transformer.rb
+- lib/sorbet-schema/serialize_value.rb
 - lib/sorbet-schema/t/struct.rb
 - lib/sorbet-schema/version.rb
 - lib/typed/coercion.rb