optify-config 0.2.2-x86_64-linux → 0.3.0-x86_64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0463acc530f486215383435fcad1b3f9e793b1f72b54426f12b32b61b4d94fda
-  data.tar.gz: 79079c3c0f593a78f749ce0aee78118083c721ee4a885bea3217667101546e5d
+  metadata.gz: 315776d94257364c8eb04e7903470b47663c3ff67fdcbdc986645e9d1bf2d52e
+  data.tar.gz: '09b9c75f58222bc168f4f01cc950688caad14db583792d521a7a79c1b6af0847'
 SHA512:
-  metadata.gz: 57f396decf6318a185431e62cf0d229b86e2720cd044f6d4486d88b48c06f24cf519c7fd52ea150d0cc453efadd046b2aec9cf333f0866c1f2bbe2fb0232a273
-  data.tar.gz: 549f8a51fff4b97f8a6c7ae29fa6646c2524ebe80c75c2601132395733815f88756d060c165c460a7c8a3f52392028d43d80035e8d80be1fb06745098776c185
+  metadata.gz: ecb046e5c15cfdf8cc9a426f3c5fc31e24929386c951322fccdee3caa34afb54725136126934b2cf0380d22763bc6eb572eedef765af60bb7a64619e8f3d3894
+  data.tar.gz: b980f7c51edbd985c75e84b41900dab0e9544753a08e9aa07314c487eff7bff615df8e8cc2ce71750e2157808239487b32fe979c43f142274e0aea0b45b634fb

data/lib/optify.rb

@@ -2,10 +2,12 @@
 # typed: strict
 
 # The implementation to use directly Ruby and with types declared.
-require_relative "optify_ruby/implementation"
-
+require_relative 'optify_ruby/implementation'
 
 # The implementation in Rust which redefines some methods.
 # This yields some warnings, but we should redeclare the methods in Ruby to help with type checking anyway.
-# Warnings about redefining methods are normal and can be ignored because the implementations in Ruby are not implemented and only exist to help with type checking.
-require_relative "optify_ruby/optify_ruby"
+# Warnings about redefining methods are normal and can be ignored
+# because the implementations in Ruby are not implemented and only exist to help with type checking.
+require_relative 'optify_ruby/optify_ruby'
+
+require_relative 'optify_ruby/base_config'

data/lib/optify_ruby/base_config.rb

@@ -0,0 +1,48 @@
+# typed: strict
+# frozen_string_literal: true
+
+require 'sorbet-runtime'
+require 'tapioca'
+
+module Optify
+  # A base class for classes from configuration files.
+  # Classes that derive from this can easily be used with `Optify::OptionsProvider.get_options`
+  # because they will have an implementation of `from_hash` that works recursively.
+  # This class is a work in progress with minimal error handling
+  # and doesn't handle certain cases such as nilable types yet.
+  # It may be moved to another gem in the future.
+  class BaseConfig
+    extend T::Sig
+    extend T::Helpers
+    abstract!
+
+    # Create a new instance of the class from a hash.
+    #
+    # @param hash [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)
+      result = new
+
+      hash.each do |key, value|
+        # TODO: Might need some error handling here, but it should be fine if type signatures are used.
+        # TODO Handle nilable types.
+        case value
+        when Array
+          sig_return_type = T::Utils.signature_for_method(instance_method(key)).return_type
+          inner_type = sig_return_type.type.raw_type
+          value = value.map { |v| inner_type.from_hash(v) } if inner_type.respond_to?(:from_hash)
+        when Hash
+          sig_return_type = T::Utils.signature_for_method(instance_method(key)).return_type
+          if sig_return_type.respond_to?(:raw_type)
+            type_for_key = sig_return_type.raw_type
+            value = type_for_key.from_hash(value) if type_for_key.respond_to?(:from_hash)
+          end
+        end
+
+        result.instance_variable_set("@#{key}", value)
+      end
+      result
+    end
+  end
+end

data/lib/optify_ruby/implementation.rb

@@ -27,11 +27,26 @@ module Optify
     #
     # @param key [String] the key to fetch options for.
     # @param feature_names [Array<String>] The enabled feature names to use to build the options.
-    # @return [OpenStruct] the options.
-    sig { params(key: String, feature_names: T::Array[String]).returns(OpenStruct) }
-    def get_options(key, feature_names)
+    # @param config_class [ConfigType] The class of the configuration to return.
+    # It is recommended to use a class that extends `Optify::BaseConfig` because it implements `from_hash`.
+    # @return [ConfigType] The options.
+    sig do
+      type_parameters(:Config)
+        .params(
+          key: String,
+          feature_names: T::Array[String],
+          config_class: T::Class[T.type_parameter(:Config)]
+        )
+        .returns(T.type_parameter(:Config))
+    end
+    def get_options(key, feature_names, config_class)
       options_json = get_options_json(key, feature_names)
-      JSON.parse(options_json, object_class: OpenStruct)
+      h = JSON.parse(options_json, object_class: Hash)
+      unless config_class.respond_to?(:from_hash)
+        raise NotImplementedError, 'The provided config class does not implement to `from_hash`.'
+      end
+
+      T.unsafe(config_class).from_hash(h)
     end
   end
 
@@ -56,4 +71,4 @@ module Optify
       raise NotImplementedError
     end
   end
-end
+end

data/rbi/optify.rbi

@@ -1,16 +1,44 @@
-# typed: strict
+# frozen_string_literal: true
+# typed: strong
 
 # Tools for working with configurations declared in files.
 module Optify
+  # A base class for classes from configuration files.
+  # Classes that derive from this can easily be used with `Optify::OptionsProvider.get_options`
+  # because they will have an implementation of `from_hash` that works recursively.
+  # This class is a work in progress with minimal error handling
+  # and doesn't handle certain cases such as nilable types yet.
+  # It may be moved to another gem in the future.
+  class BaseConfig
+    abstract!
+
+    # Create a new instance of the class from a hash.
+    #
+    # @param hash [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
+  end
+
   # Provides configurations based on keys and enabled feature names.
   class OptionsProvider
     # Fetches options based on the provided key and feature names.
     #
     # @param key [String] the key to fetch options for.
     # @param feature_names [Array<String>] The enabled feature names to use to build the options.
-    # @return [OpenStruct] the options.
-    sig { params(key: String, feature_names: T::Array[String]).returns(OpenStruct) }
-    def get_options(key, feature_names); end
+    # @param config_class [ConfigType] The class of the configuration to return.
+    # It is recommended to use a class that extends `Optify::BaseConfig` because it implements `from_hash`.
+    # @return [ConfigType] The options.
+    sig do
+      type_parameters(:Config)
+        .params(
+          key: String,
+          feature_names: T::Array[String],
+          config_class: T::Class[T.type_parameter(:Config)]
+        )
+        .returns(T.type_parameter(:Config))
+    end
+    def get_options(key, feature_names, config_class); end
 
     # Fetches options in JSON format based on the provided key and feature names.
     #
@@ -34,4 +62,4 @@ module Optify
     sig { returns(OptionsProvider) }
     def build; end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: optify-config
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: x86_64-linux
 authors:
 - Justin D. Harris
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-02-04 00:00:00.000000000 Z
+date: 2025-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
@@ -80,14 +80,16 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.6.7
-description: Simplifies getting the right configuration options for a process using
-  pre-loaded configurations from files to manage options for experiments or flights.
+description: |-
+  Simplifies getting the right configuration options for a process using pre-loaded configurations
+    from files to manage options for experiments or flights.
 email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/optify.rb
+- lib/optify_ruby/base_config.rb
 - lib/optify_ruby/implementation.rb
 - lib/optify_ruby/optify_ruby.so
 - rbi/optify.rbi