optify-from_hash 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: defb046567cf5eb3f38edf14687a1b6d62f6525b8f51cb09b2192238f974cac6
-  data.tar.gz: 8c812657f197ea275174418c9d337a5f6f8c129bdd28e58486c15e0d7a9ac519
+  metadata.gz: 0e24ce9b23b87819fc6688195ca5a90cb43dfbe23b25264e269cf37daa97f531
+  data.tar.gz: 18e142eb6c75bf80cfab5fb8d64079ec1f7fd2d212e97043def5555d595fcdd0
 SHA512:
-  metadata.gz: e20d38e4ef67f073fa5c3db61bdd77eaf6b54a059ca57fedfb518a8c0f0a66b5598740dcefc12f8fe13fdffb21e834d6d079bcc189599e88b983d34a4bcddefe
-  data.tar.gz: 4a6f118ce068585191c3d5193ea9c0ef135f65a653b5193464ddb5a0dce3e3a3e799b85c3f63037b6b9b47cb83b9dcdbcd6b9b9b2f34eb6a04dcc84143275a4c
+  metadata.gz: ecfa102d64db21405131a02545bfa524eebde5150c9030555faa89e8e802ec6bdf8006fbd90d30a713450a1beb28167302996bbee2507c01f6d67cea3196ad56
+  data.tar.gz: 1943ab3ab4ec77e5441de4006b1699683a5bf0d9e8151d3b51ef4fcedd00e6eedf5b8baa5e9d42e7edff367f22d29109495e63ee2e6cff197facd2f5edd8ed79

data/lib/optify_from_hash/from_hashable.rb

@@ -1,6 +1,7 @@
 # typed: strict
 # frozen_string_literal: true
 
+require 'json'
 require 'sorbet-runtime'
 require 'tapioca'
 
@@ -13,7 +14,6 @@ module Optify
 
     # Create a new immutable instance of the class from a hash.
     #
-    # This is a class method so that it can set members with private setters.
     # @param hash The hash to create the instance from.
     # @return The new instance.
     #: (Hash[untyped, untyped]) -> instance
@@ -39,7 +39,7 @@ module Optify
       instance.freeze
     end
 
-    #: (untyped, untyped) -> untyped
+    #: (untyped, T::Types::Base) -> untyped
     def self._convert_value(value, type)
       if type.is_a?(T::Types::Untyped)
         # No preferred type is given, so return the value as is.
@@ -51,7 +51,10 @@ module Optify
       case value
       when Array
         # Handle `T.nilable(T::Array[...])`
-        type = type.unwrap_nilable if type.respond_to?(:unwrap_nilable)
+        if type.respond_to?(:unwrap_nilable)
+          type = type #: as untyped
+                 .unwrap_nilable
+        end
         inner_type = type.type
         return value.map { |v| _convert_value(v, inner_type) }.freeze
       when Hash
@@ -60,7 +63,8 @@ module Optify
         # `T.any(...)` because using `.types` works for both cases.
         if type.respond_to?(:types)
           # Find a type that works for the hash.
-          type.types.each do |t|
+          type #: as untyped
+            .types.each do |t|
             return _convert_hash(value, t).freeze
           rescue StandardError
             # Ignore and try the next type.
@@ -75,12 +79,13 @@ module Optify
       value
     end
 
-    #: (Hash[untyped, untyped], untyped) -> untyped
+    #: (Hash[untyped, untyped], T::Types::Base) -> untyped
     def self._convert_hash(hash, type)
       if type.respond_to?(:raw_type)
         # There is an object for the hash.
         # It could be a custom class, a String, or maybe something else.
-        type_for_hash = type.raw_type
+        type_for_hash = type #: as untyped
+                        .raw_type
         return type_for_hash.from_hash(hash) if type_for_hash.respond_to?(:from_hash)
       elsif type.is_a?(T::Types::TypedHash)
         # The hash should be a hash, but the values might be objects to convert.
@@ -114,6 +119,12 @@ module Optify
       end
     end
 
+    # Convert this object to a JSON string.
+    #: (?JSON::State?) -> String
+    def to_json(state = nil)
+      to_h.to_json(state)
+    end
+
     # Convert this object to a Hash recursively.
     # This is mostly the reverse operation of `from_hash`,
     # as keys will be symbols
@@ -127,21 +138,19 @@ module Optify
         # Remove the @ prefix to get the method name
         method_name = var_name.to_s[1..] #: as !nil
         value = instance_variable_get(var_name)
-        result[method_name.to_sym] = _convert_value_to_hash(value)
+        result[method_name.to_sym] = self.class.send(:_convert_value_for_to_h, value)
       end
 
       result
     end
 
-    private
-
     #: (untyped) -> untyped
-    def _convert_value_to_hash(value)
+    def self._convert_value_for_to_h(value)
       case value
       when Array
-        value.map { |v| _convert_value_to_hash(v) }
+        value.map { |v| _convert_value_for_to_h(v) }
       when Hash
-        value.transform_values { |v| _convert_value_to_hash(v) }
+        value.transform_values { |v| _convert_value_for_to_h(v) }
       when nil
         nil
       else
@@ -152,5 +161,7 @@ module Optify
         end
       end
     end
+
+    private_class_method :_convert_value_for_to_h
   end
 end

data/rbi/optify_from_hash.rbi

@@ -5,18 +5,19 @@
 module Optify
   # A base class for classes that can be created from a hash.
   class FromHashable
-    extend T::Sig
-    extend T::Helpers
     abstract!
 
     # Create a new instance of the class from a hash.
     #
-    # This is a class method that so that it can set members with private setters.
     # @param hash The hash to create the instance from.
     # @return The new instance.
     sig { params(hash: T::Hash[T.untyped, T.untyped]).returns(T.attached_class) }
     def self.from_hash(hash); end
 
+    # Convert this object to a JSON string.
+    sig { params(state: T.nilable(JSON::State)).returns(String) }
+    def to_json(state = nil); end
+
     # Convert this object to a Hash recursively.
     # This is mostly the reverse operation of `from_hash`,
     # as keys will be symbols

data/sig/optify_from_hash.rbs

@@ -4,15 +4,15 @@ end
 
 # A base class for classes that can be created from a hash.
 class Optify::FromHashable
-  extend T::Helpers
-
   # Create a new instance of the class from a hash.
   #
-  # This is a class method that so that it can set members with private setters.
   # @param hash The hash to create the instance from.
   # @return The new instance.
   def self.from_hash: (::Hash[untyped, untyped] hash) -> instance
 
+  # Convert this object to a JSON string.
+  def to_json: (?JSON::State? state) -> String
+
   # Convert this object to a Hash recursively.
   # This is mostly the reverse operation of `from_hash`,
   # as keys will be symbols

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: optify-from_hash
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Justin D. Harris
@@ -134,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Utilities for converting hashes to immutable objects.
 test_files: []