optify-config 0.2.0-arm64-darwin-23 → 0.4.0-arm64-darwin-23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f56ac9cfd62424015ae1a1219f17a95c607ddc1f707d2695d264ecf6badf635
-  data.tar.gz: 8a96be88160561676ec121b574950f5e6d5bad12ab02f2e0eb6a8c031e48adaf
+  metadata.gz: a854df741a2d742bf02aa203680cb8e009d650c94e6df0bd7cb8e56c884c408d
+  data.tar.gz: b77a4cb44c75fb188213b359b22140a26e80540e2795e92d9dd3a26b8faea308
 SHA512:
-  metadata.gz: bb1cf2ceb0811c3a1972c5be3e66d1d04fb22fe48352741ebf543ee58a55cc14db6e1de5a4b3f022e58b1508343721e55695aa78efdd632f3dabea0e44c6f83c
-  data.tar.gz: 16041070d1449b7afa3face9fdf531785d440ec96b1048826517101d0c8c64d8ba7a6024ae69455f6aa12666a6bd8709f4506a9e362a8642425c4ed67715d4ea
+  metadata.gz: bcf0e1b405a0c949670f13977586305d8ae4e232a976d0be6449d238c1e5850b67fe84c785f661f821f2ad11f5a6df3800e57b19d2e0313c0bdbe00e6464eab3
+  data.tar.gz: 045fc428b2459348d422a8fefaf8a5a5c5d606416a9fbd990fdf44e7e2cb8b1f78bef81d28619b415fa320753fd3555d421c8849712718c537a5fce3a99f6f08

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

@@ -2,12 +2,18 @@
 # typed: strict
 
 require 'json'
-require 'ostruct'
 
 require 'sorbet-runtime'
 
+require_relative './base_config'
+
 # Tools for working with configurations declared in files.
 module Optify
+  # Options for caching.
+  # Only enabling or disabling caching is supported for now.
+  class CacheOptions < BaseConfig
+  end
+
   # Provides configurations based on keys and enabled feature names.
   class OptionsProvider
     extend T::Sig
@@ -27,11 +33,62 @@ 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`.
+    # @param cache_options Set this if caching is desired. Only very simple caching is supported for now.
+    # @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)],
+          cache_options: T.nilable(CacheOptions)
+        )
+        .returns(T.type_parameter(:Config))
+    end
+    def get_options(key, feature_names, config_class, cache_options = nil)
+      return get_options_with_cache(key, feature_names, config_class, cache_options) if cache_options
+
       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 must implement `from_hash` as a class method
+            in order to be converted."
+      end
+
+      T.unsafe(config_class).from_hash(h)
+    end
+
+    private
+
+    NOT_FOUND_IN_CACHE_SENTINEL = Object.new
+
+    sig do
+      type_parameters(:Config)
+        .params(
+          key: String,
+          feature_names: T::Array[String],
+          config_class: T::Class[T.type_parameter(:Config)],
+          _cache_options: CacheOptions
+        )
+        .returns(T.type_parameter(:Config))
+    end
+    def get_options_with_cache(key, feature_names, config_class, _cache_options)
+      # Cache directly in Ruby instead of Rust because:
+      # * Avoid any possible conversion overhead.
+      # * Memory management: probably better to do it in Ruby for a Ruby app and avoid memory in Rust.
+      # TODO: Handle aliases. Right now, they are only visible in Rust
+      # and we don't want the cache in Rust because we won't to avoid any conversion overhead.
+      @cache ||= T.let({}, T.nilable(T::Hash[T.untyped, T.untyped]))
+      cache_key = [key, feature_names, config_class]
+      result = @cache.fetch(cache_key, NOT_FOUND_IN_CACHE_SENTINEL)
+      return result unless result.equal?(NOT_FOUND_IN_CACHE_SENTINEL)
+
+      result = get_options(key, feature_names, config_class)
+
+      @cache[cache_key] = result
     end
   end
 
@@ -56,4 +113,4 @@ module Optify
       raise NotImplementedError
     end
   end
-end
+end

data/rbi/optify.rbi

@@ -0,0 +1,71 @@
+# 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
+
+  # Options for caching.
+  # Only enabling or disabling caching is supported for now.
+  class CacheOptions < BaseConfig
+  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.
+    # @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)],
+          cache_options: T.nilable(CacheOptions)
+          )
+          .returns(T.type_parameter(:Config))
+      end
+      def get_options(key, feature_names, config_class, cache_options = nil); end
+
+    # Fetches options in JSON format 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 [String] the options in JSON.
+    sig { params(key: String, feature_names: T::Array[String]).returns(String) }
+    def get_options_json(key, feature_names); end
+  end
+
+  # A builder for creating an `OptionsProvider` instance.
+  class OptionsProviderBuilder
+    # Adds a directory to the builder.
+    #
+    # @param path [String] The path of the directory to add.
+    # @return [OptionsProviderBuilder] `self`.
+    sig { params(path: String).returns(OptionsProviderBuilder) }
+    def add_directory(path); end
+
+    # @return [OptionsProvider] A newly built `OptionsProvider`.
+    sig { returns(OptionsProvider) }
+    def build; end
+  end
+end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: optify-config
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: arm64-darwin-23
 authors:
 - Justin D. Harris
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-03 00:00:00.000000000 Z
+date: 2025-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.11796
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.11796
 - !ruby/object:Gem::Dependency
   name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
@@ -42,60 +42,63 @@ dependencies:
   name: sorbet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.11796
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.11796
 - !ruby/object:Gem::Dependency
   name: tapioca
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.16.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.16.8
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.6.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: Simplifies getting the right configuration options for a process using
-  pre-loaded configurations from files to manage options for experiments or flights.
+        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.
 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.bundle
+- rbi/optify.rbi
 homepage: https://github.com/juharris/optify
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/juharris/optify
   bug_tracker_uri: https://github.com/juharris/optify/issues
+  source_code_uri: https://github.com/juharris/optify
 post_install_message:
 rdoc_options: []
 require_paths: