optify-config 0.6.0-x86_64-linux → 0.6.1-x86_64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e20a14d5df635156747d3e06136173f7e0b1c29a45559e3d23c02c56b80358bd
-  data.tar.gz: 0de8d4a9af5797201d95821e647d89e6ce810c845c7857a0c4857ab904308023
+  metadata.gz: 5b6b92f653278035c649822630c249c8c250640b765219d1568a3cd046570055
+  data.tar.gz: b1b58e7557f9af9961f71939116967c4e4e2c192b8f2dc4d2ae044207673bf34
 SHA512:
-  metadata.gz: 9508336a857b243f540e02facc91eccd6e71436a41f6805c61a341370673853d19e0f36791c45d8635796cd77957ce1fa69fa5d17ecc82766e808e75bad1b4d8
-  data.tar.gz: 7f49ab44cdfd8bd8377397499f82db8ca9cebff75728eddfb3b572c264d1c66470e529f7da2a950e2f751c10a1ae4c1f1c40d49e6988ca6a87f54f2074485fc6
+  metadata.gz: 23ea56dea463d0d77783604005e68f438392904e215849d07aaa9e17665e6b97921bb22578ae35199cbaa2ff14fd7e41e96bb0919e316285e2e4d6b59905b005
+  data.tar.gz: 8ef1de56881966cf126bf265d8b3c19845661a4e37244e3356fcb03ad37809c72d083543984f90a3b217bd0a76bc99a681dd5f25b59f04e0c01ca6db0c439ef3

data/lib/optify_ruby/base_config.rb

@@ -19,9 +19,9 @@ module Optify
     # Create a new immutable instance of the class from a hash.
     #
     # This is a class method that so that it can set members with private setters.
-    # @param hash [Hash] The hash to create the instance from.
+    # @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) }
+    #: (Hash[untyped, untyped] hash) -> instance
     def self.from_hash(hash)
       result = new
 
@@ -34,7 +34,7 @@ module Optify
       T.unsafe(result).freeze if T.unsafe(result).respond_to?(:freeze)
     end
 
-    sig { params(value: T.untyped, type: T.untyped).returns(T.untyped) }
+    #: (untyped value, untyped type) -> untyped
     def self._convert_value(value, type)
       case value
       when Array
@@ -55,12 +55,7 @@ module Optify
       value
     end
 
-    sig do
-      params(
-        hash: T::Hash[T.untyped, T.untyped],
-        type: T.untyped
-      ).returns(T.untyped)
-    end
+    #: (Hash[untyped, untyped] hash, untyped type) -> untyped
     def self._convert_hash(hash, type) # rubocop:disable Metrics/PerceivedComplexity
       if type.respond_to?(:raw_type)
         # There is an object for the hash.

data/lib/optify_ruby/implementation.rb

@@ -20,24 +20,14 @@ module Optify
 
     # 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.
+    # @param key The key to fetch options for.
+    # @param feature_names The enabled feature names to use to build the options.
+    # @param config_class 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 [CacheOptions] Set this if caching is desired. Only very simple caching is supported for now.
-    # @param preferences [GetOptionsPreferences] The preferences to use when getting options.
-    # @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),
-          preferences: T.nilable(Optify::GetOptionsPreferences)
-        )
-        .returns(T.type_parameter(:Config))
-    end
+    # @param cache_options Set this if caching is desired. Only very simple caching is supported for now.
+    # @param preferences The preferences to use when getting options.
+    # @return The options.
+    #: [Config] (String key, Array[String] feature_names, Class[Config] config_class, ?CacheOptions? cache_options, ?Optify::GetOptionsPreferences? preferences) -> Config
     def get_options(key, feature_names, config_class, cache_options = nil, preferences = nil)
       return get_options_with_cache(key, feature_names, config_class, cache_options, preferences) if cache_options
 
@@ -59,7 +49,7 @@ module Optify
 
     # (Optional) Eagerly initializes the cache.
     # @return [OptionsProvider] `self`.
-    sig { returns(OptionsProvider) }
+    #: -> OptionsProvider
     def init
       @cache = T.let({}, T.nilable(T::Hash[T.untyped, T.untyped]))
       self
@@ -69,17 +59,7 @@ module Optify
 
     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,
-          preferences: T.nilable(Optify::GetOptionsPreferences)
-        )
-        .returns(T.type_parameter(:Config))
-    end
+    #: [Config] (String key, Array[String] feature_names, Class[Config] config_class, Optify::CacheOptions _cache_options, ?Optify::GetOptionsPreferences? preferences) -> Config
     def get_options_with_cache(key, feature_names, config_class, _cache_options, preferences = nil)
       # Cache directly in Ruby instead of Rust because:
       # * Avoid any possible conversion overhead.

data/rbi/optify.rbi

@@ -15,7 +15,7 @@ module Optify
     # 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 [Hash] The hash to create the instance from.
+    # @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
@@ -46,13 +46,13 @@ module Optify
 
     # 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.
+    # @param key The key to fetch options for.
+    # @param feature_names The enabled feature names to use to build the options.
+    # @param config_class 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 [CacheOptions] Set this if caching is desired. Only very simple caching is supported for now.
-    # @param preferences [GetOptionsPreferences] The preferences to use when getting options.
-    # @return [ConfigType] The options.
+    # @param cache_options Set this if caching is desired. Only very simple caching is supported for now.
+    # @param preferences The preferences to use when getting options.
+    # @return The options.
     sig do
       type_parameters(:Config)
         .params(

data/sig/optify.rbs

@@ -0,0 +1,67 @@
+# Tools for working with configurations declared in files.
+module Optify
+end
+
+# 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 Optify::BaseConfig
+  # 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
+end
+
+# Options for caching.
+# Only enabling or disabling caching is supported for now.
+class Optify::CacheOptions < BaseConfig
+end
+
+# Preferences when getting options.
+class Optify::GetOptionsPreferences
+  def skip_feature_name_conversion=: (bool value) -> GetOptionsPreferences
+
+  def skip_feature_name_conversion: () -> bool
+end
+
+# Provides configurations based on keys and enabled feature names.
+class Optify::OptionsProvider
+  # Map an alias or canonical feature name (perhaps derived from a file name) to a canonical feature name.
+  # Canonical feature names map to themselves.
+  #
+  # @param feature_name The name of an alias or a feature.
+  # @return The canonical feature name.
+  def get_canonical_feature_name: (String feature_name) -> String
+
+  def get_options: [Config] (String key, ::Array[String] feature_names, T::Class[Config] config_class, ?CacheOptions? cache_options, ?Optify::GetOptionsPreferences? preferences) -> Config
+
+  # 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.
+  def get_options_json: (String key, ::Array[String] feature_names) -> String
+
+  def get_options_json_with_preferences: (String key, ::Array[String] feature_names, GetOptionsPreferences preferences) -> String
+
+  # (Optional) Eagerly initializes the cache.
+  # @return [OptionsProvider] `self`.
+  def init: () -> OptionsProvider
+end
+
+# A builder for creating an `OptionsProvider` instance.
+class Optify::OptionsProviderBuilder
+  # Adds a directory to the builder.
+  #
+  # @param path [String] The path of the directory to add.
+  # @return [OptionsProviderBuilder] `self`.
+  def add_directory: (String path) -> OptionsProviderBuilder
+
+  # @return [OptionsProvider] A newly built `OptionsProvider`.
+  def build: () -> OptionsProvider
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: optify-config
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: x86_64-linux
 authors:
 - Justin D. Harris
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-02-17 00:00:00.000000000 Z
+date: 2025-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.11796
+        version: 0.5.11851
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.11796
+        version: 0.5.11851
 - !ruby/object:Gem::Dependency
   name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
@@ -38,34 +38,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.2.9
+- !ruby/object:Gem::Dependency
+  name: rbs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.1
 - !ruby/object:Gem::Dependency
   name: sorbet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.11796
+        version: 0.5.11851
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.11796
+        version: 0.5.11851
 - !ruby/object:Gem::Dependency
   name: tapioca
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.8
+        version: 0.16.11
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.8
+        version: 0.16.11
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
@@ -95,6 +109,7 @@ files:
 - lib/optify_ruby/base_config.rb
 - lib/optify_ruby/implementation.rb
 - rbi/optify.rbi
+- sig/optify.rbs
 homepage: https://github.com/juharris/optify
 licenses:
 - MIT