optify-from_hash 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e24ce9b23b87819fc6688195ca5a90cb43dfbe23b25264e269cf37daa97f531
-  data.tar.gz: 18e142eb6c75bf80cfab5fb8d64079ec1f7fd2d212e97043def5555d595fcdd0
+  metadata.gz: 323fea346213dffe7e7b35edf19d78d2fa2f8ad7febff0dcb43d6982c48e6732
+  data.tar.gz: c85f2f191f33306858d91855ae8a32ad0de373d565dca8227250f9c20d59e2fe
 SHA512:
-  metadata.gz: ecfa102d64db21405131a02545bfa524eebde5150c9030555faa89e8e802ec6bdf8006fbd90d30a713450a1beb28167302996bbee2507c01f6d67cea3196ad56
-  data.tar.gz: 1943ab3ab4ec77e5441de4006b1699683a5bf0d9e8151d3b51ef4fcedd00e6eedf5b8baa5e9d42e7edff367f22d29109495e63ee2e6cff197facd2f5edd8ed79
+  metadata.gz: 274a651a061c8ac9840de8c75a46391e78ac599ba71135dbd9b748045567f7c957fe8e9ce87b3c43ddf969868d149aa6526327ed26f16204e3a0404413ff7a35
+  data.tar.gz: 7b8793ab933e2478b798a06557d812bca70fd9c031394076b06790672162187261cb2f0801bf6f27320ec55b434bf1c827414de65f6804085acc529d3900ca3c

data/lib/optify_from_hash/from_hashable.rb

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 require 'json'
+require 'set'
 require 'sorbet-runtime'
 require 'tapioca'
 
@@ -39,6 +40,14 @@ module Optify
       instance.freeze
     end
 
+    #: (Array[untyped], untyped) -> (Array[untyped] | Set[untyped])
+    def self._convert_array(value, unwrapped_type)
+      inner_type = unwrapped_type.type
+      return value.map { |v| _convert_value(v, inner_type) }.freeze if unwrapped_type.is_a?(T::Types::TypedArray)
+
+      Set.new(value.map { |v| _convert_value(v, inner_type) }).freeze
+    end
+
     #: (untyped, T::Types::Base) -> untyped
     def self._convert_value(value, type)
       if type.is_a?(T::Types::Untyped)
@@ -46,17 +55,12 @@ module Optify
         return value
       end
 
-      return value.to_sym if type.is_a?(T::Types::Simple) && type.raw_type == Symbol
+      unwrapped_type = _unwrap_nilable(type)
+      return value&.to_sym if unwrapped_type.is_a?(T::Types::Simple) && unwrapped_type.raw_type == Symbol
 
       case value
       when Array
-        # Handle `T.nilable(T::Array[...])`
-        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
+        return _convert_array(value, unwrapped_type)
       when Hash
         # Handle `T.nilable(T::Hash[...])` and `T.any(...)`.
         # We used to use `type = type.unwrap_nilable if type.respond_to?(:unwrap_nilable)`, but it's not needed now that we handle
@@ -104,7 +108,18 @@ module Optify
       raise TypeError, "Could not convert hash #{hash} to `#{type}`."
     end
 
-    private_class_method :_convert_hash, :_convert_value
+    # Unwrap `T.nilable(...)` to get the inner type, or return the type as-is.
+    #: (T::Types::Base) -> T::Types::Base
+    def self._unwrap_nilable(type)
+      if type.respond_to?(:unwrap_nilable)
+        type #: as untyped
+          .unwrap_nilable
+      else
+        type
+      end
+    end
+
+    private_class_method :_convert_array, :_convert_hash, :_convert_value, :_unwrap_nilable
 
     # Compare this object with another object for equality.
     # @param other The object to compare.
@@ -119,6 +134,23 @@ module Optify
       end
     end
 
+    # Support equality by value so that instances can be used in Sets and as Hash keys.
+    #: (untyped) -> bool
+    def eql?(other)
+      return true if other.equal?(self)
+      return false if self.class != other.class
+
+      instance_variables.all? do |name|
+        instance_variable_get(name).eql?(other.instance_variable_get(name))
+      end
+    end
+
+    # @return [Integer] a hash value based on the object's class and instance variables.
+    #: () -> Integer
+    def hash
+      [self.class, *instance_variables.sort.map { |name| instance_variable_get(name) }].hash
+    end
+
     # Convert this object to a JSON string.
     #: (?JSON::State?) -> String
     def to_json(state = nil)
@@ -147,7 +179,8 @@ module Optify
     #: (untyped) -> untyped
     def self._convert_value_for_to_h(value)
       case value
-      when Array
+      # Treat sets like arrays for JSON serialization.
+      when Array, Set
         value.map { |v| _convert_value_for_to_h(v) }
       when Hash
         value.transform_values { |v| _convert_value_for_to_h(v) }

data/rbi/optify_from_hash.rbi

@@ -5,6 +5,8 @@
 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.
@@ -31,5 +33,13 @@ module Optify
     # @return [Boolean] true if the objects are equal; otherwise, false.
     sig { params(other: T.untyped).returns(T::Boolean) }
     def ==(other); end
+
+    # Support equality by value so that instances can be used in Sets and as Hash keys.
+    sig { params(other: T.untyped).returns(T::Boolean) }
+    def eql?(other); end
+
+    # @return a hash value based on the object's class and instance variables.
+    sig { returns(Integer) }
+    def hash; end
   end
 end

data/sig/optify_from_hash.rbs

@@ -4,6 +4,8 @@ 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.
   #
   # @param hash The hash to create the instance from.
@@ -24,4 +26,10 @@ class Optify::FromHashable
   # @param other The object to compare.
   # @return [Boolean] true if the objects are equal; otherwise, false.
   def ==: (untyped other) -> bool
+
+  # Support equality by value so that instances can be used in Sets and as Hash keys.
+  def eql?: (untyped other) -> bool
+
+  # @return a hash value based on the object's class and instance variables.
+  def hash: () -> Integer
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: optify-from_hash
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Justin D. Harris
@@ -49,14 +49,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0.dev.4
+        version: 4.0.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0.dev.4
+        version: 4.0.3
 - !ruby/object:Gem::Dependency
   name: sorbet
   requirement: !ruby/object:Gem::Requirement
@@ -83,14 +83,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.7
+        version: 0.19.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.7
+        version: 0.19.1
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement