optify-config 1.18.0-x86_64-linux → 1.20.0-x86_64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72ce685effaf20e61f50d3b6dbfd7977404de2cce2dc236083354f61ed4ff275
-  data.tar.gz: 4f36e14bac44774c4e78452d17dcd42b251fc8e91ef62e5064e2115bbfd38cff
+  metadata.gz: c0c6af3de09e020f3c54b8ab92039aa9ce0d41cb05509b9326ee1967860d6f14
+  data.tar.gz: 6310dda89ed60816ec0c3ad79d37cf65bf57a3a64129aa6939374545cdb424d4
 SHA512:
-  metadata.gz: c70b2f22709bfa93c383b51466535eb196697f8920bbd060e7c1f7c08770cac9ef2fc9e2c18473b7cfbb13e18986f56f7c11e2939afc6aad20094e45f550629f
-  data.tar.gz: 07bec6e9d42b0b2fa7e43f142bfc5a3fac8806fb0bd75b2f2382da127bbcf5b6ff9d7b0bf61c095cbd67d51084184bba0eb4bcf246b55c81f70070045d71df95
+  metadata.gz: 6b9332ce87a8fe7093b76de7a4dc199585229d00645378aae2be6a3ff3be1ee6c411a5a866529da5e9066dbbf948c1ca4a56c83989a2ac945bdd9927c106074c
+  data.tar.gz: 66f9cda4aa03931b2c0b73b67b9b7cce0fb6bbb6010060132b570e7eb92ddae7edb91f075e937cd7b39a0aa4c7a20dff028b3b8405147ccd9ffe8b276ef50995

data/lib/optify_ruby/cache_init_options.rb

@@ -0,0 +1,41 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Optify
+  # The mode for the cache.
+  module CacheMode
+    # Non-thread-safe LRU cache.
+    # Should be faster than `THREAD_SAFE` for single-threaded applications.
+    NOT_THREAD_SAFE = :not_thread_safe #: Symbol
+    # Thread-safe LRU cache.
+    THREAD_SAFE = :thread_safe #: Symbol
+  end
+
+  # Options for initializing the cache.
+  class CacheInitOptions
+    #: Integer?
+    attr_reader :max_size
+
+    # A value from `CacheMode`.
+    #
+    #: Symbol
+    attr_reader :mode
+
+    # Initializes the cache options.
+    # Defaults to a non-thread-safe unlimited size cache for backwards compatibility
+    # with how this library was originally configured with an unbounded hash as the case.
+    # @param mode A value from `CacheMode`.
+    #
+    #: (
+    #|   ?max_size: Integer?,
+    #|   ?mode: Symbol,
+    #| ) -> void
+    def initialize(
+      max_size: nil,
+      mode: CacheMode::NOT_THREAD_SAFE
+    )
+      @max_size = max_size
+      @mode = mode
+    end
+  end
+end

data/lib/optify_ruby/implementation.rb

@@ -4,6 +4,7 @@
 require 'sorbet-runtime'
 
 require_relative './base_config'
+require_relative './cache_init_options'
 require_relative './options_metadata'
 require_relative './provider_module'
 
@@ -32,9 +33,9 @@ module Optify
 
     # (Optional) Eagerly initializes the cache.
     # @return [OptionsProvider] `self`.
-    #: -> OptionsProvider
-    def init
-      _init
+    #: (?CacheInitOptions?) -> OptionsProvider
+    def init(cache_init_options = nil)
+      _init(cache_init_options)
       self
     end
   end

data/lib/optify_ruby/provider_module.rb

@@ -2,11 +2,47 @@
 # frozen_string_literal: true
 
 require 'json'
+require 'lru_redux'
 require 'sorbet-runtime'
 
 module Optify
   # @!visibility private
   module ProviderModule
+    #: [T] (LruRedux::Cache | Hash[untyped, untyped], Array[untyped]) { -> T } -> T
+    def self._cache_getset(cache, cache_key, &block)
+      if cache.is_a? LruRedux::Cache
+        cache.getset(cache_key, &block)
+      else
+        # Plain Hash - use fetch with block and store result
+        cache.fetch(cache_key) do
+          result = block.call
+          cache[cache_key] = result
+        end
+      end
+    end
+
+    #: (CacheInitOptions?) -> ( Hash[Array[untyped], untyped] | LruRedux::Cache)
+    def self._create_cache(cache_init_options)
+      # Be backwards compatible with the original implementation of this library.
+      return {} if cache_init_options.nil?
+
+      max_size = cache_init_options.max_size
+      mode = cache_init_options.mode
+      if max_size.nil?
+        Kernel.raise ArgumentError, 'Thread-safe cache is not supported when max_size is nil' if mode == CacheMode::THREAD_SAFE
+        {}
+      else
+        case mode
+        when CacheMode::THREAD_SAFE
+          LruRedux::ThreadSafeCache.new(max_size)
+        when CacheMode::NOT_THREAD_SAFE
+          LruRedux::Cache.new(max_size)
+        else
+          Kernel.raise ArgumentError, "Invalid cache mode: #{mode}"
+        end
+      end
+    end
+
     #: (Array[String] feature_names) -> Array[String]
     def get_canonical_feature_names(feature_names)
       # Try to optimize a typical case where there are just a few features.
@@ -55,7 +91,7 @@ module Optify
     # @return The options.
     #: [Config] (String, Array[String], Class[Config], ?CacheOptions?, ?Optify::GetOptionsPreferences?) -> 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
+      return _get_options_with_cache(key, feature_names, config_class, cache_options, preferences) if cache_options
 
       unless config_class.respond_to?(:from_hash)
         Kernel.raise NotImplementedError,
@@ -73,14 +109,8 @@ module Optify
         .from_hash(hash)
     end
 
-    #: -> void
-    def _init
-      @cache = {} #: Hash[untyped, untyped]?
-      @features_with_metadata = nil #: Hash[String, OptionsMetadata]?
-    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)
+    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.
       # * Memory management: probably better to do it in Ruby for a Ruby app and avoid memory in Rust.
@@ -100,22 +130,27 @@ module Optify
       # Features are filtered, so we don't need the constraints in the cache key.
       are_configurable_strings_enabled = preferences&.are_configurable_strings_enabled? || false
       cache_key = [key, feature_names, are_configurable_strings_enabled, config_class]
-      @cache #: as !nil
-        .fetch(cache_key) do
+      ProviderModule._cache_getset(
+        @cache, #: as !nil
+        cache_key,
+      ) do
         # Handle a cache miss.
 
         # We can avoid converting the features names because they're already converted from filtering above, if that was desired.
         # We don't need the constraints because we filtered the features above.
         # We already know there are no overrides because we checked above.
-        preferences = GetOptionsPreferences.new
-        preferences.skip_feature_name_conversion = true
-        preferences.enable_configurable_strings if are_configurable_strings_enabled
+        cache_miss_preferences = GetOptionsPreferences.new
+        cache_miss_preferences.skip_feature_name_conversion = true
+        cache_miss_preferences.enable_configurable_strings if are_configurable_strings_enabled
 
-        result = _get_options(key, feature_names, config_class, nil, preferences)
-
-        @cache #: as !nil
-          .[]= cache_key, result
+        _get_options(key, feature_names, config_class, nil, cache_miss_preferences)
       end
     end
+
+    #: (?CacheInitOptions?) -> void
+    def _init(cache_init_options = nil)
+      @cache = ProviderModule._create_cache(cache_init_options) #: ( Hash[untyped, untyped] | LruRedux::Cache)?
+      @features_with_metadata = nil #: Hash[String, OptionsMetadata]?
+    end
   end
 end

data/lib/optify_ruby/watcher_implementation.rb

@@ -30,9 +30,9 @@ module Optify
 
     # (Optional) Eagerly initializes the cache.
     # @return [OptionsWatcher] `self`.
-    #: -> OptionsWatcher
-    def init
-      _init
+    #: (?CacheInitOptions?) -> OptionsWatcher
+    def init(cache_init_options = nil)
+      _init(cache_init_options)
       @cache_creation_time = Time.now #: Time?
       self
     end

data/rbi/optify.rbi

@@ -3,6 +3,10 @@
 
 # Tools for working with configurations declared in files.
 module Optify
+  # Raised when a feature name is not found in the registry.
+  class UnknownFeatureError < StandardError
+  end
+
   # DEPRECATED: Use `Optify::FromHashable` instead.
   # A base class for classes from configuration files.
   # Classes that derive from this can easily be used with `Optify::OptionsProvider.get_options`
@@ -19,6 +23,37 @@ module Optify
   class CacheOptions < FromHashable
   end
 
+  # The mode for the cache.
+  module CacheMode
+    # Non-thread-safe LRU cache.
+    # Should be faster than `THREAD_SAFE` for single-threaded applications.
+    NOT_THREAD_SAFE = T.let(:not_thread_safe, Symbol)
+    # Thread-safe LRU cache.
+    THREAD_SAFE = T.let(:thread_safe, Symbol)
+  end
+
+  # Options for initializing the cache.
+  class CacheInitOptions
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :max_size
+
+    # A value from `CacheMode`.
+    sig { returns(Symbol) }
+    attr_reader :mode
+
+    # Initializes the cache options.
+    # Defaults to a non-thread-safe unlimited size cache for backwards compatibility
+    # with how this library was originally configured with an unbounded hash as the case.
+    # @param mode A value from `CacheMode`.
+    sig do
+      params(
+        max_size: T.nilable(Integer),
+        mode: Symbol,
+      ).void
+    end
+    def initialize(max_size: nil, mode: CacheMode::NOT_THREAD_SAFE); end
+  end
+
   # Information about a feature.
   class OptionsMetadata < FromHashable
     sig { returns(T.nilable(T::Array[String])) }
@@ -188,7 +223,7 @@ module Optify
     sig do
       params(
         feature_names: T::Array[String],
-        preferences: GetOptionsPreferences
+        preferences: GetOptionsPreferences,
       )
         .returns(T::Array[String])
     end
@@ -211,7 +246,7 @@ module Optify
           feature_names: T::Array[String],
           config_class: T::Class[T.type_parameter(:Config)],
           cache_options: T.nilable(CacheOptions),
-          preferences: T.nilable(Optify::GetOptionsPreferences)
+          preferences: T.nilable(Optify::GetOptionsPreferences),
         )
         .returns(T.type_parameter(:Config))
     end
@@ -264,8 +299,11 @@ module Optify
 
     # (Optional) Eagerly initializes the cache.
     # @return `self`.
-    sig { returns(T.self_type) }
-    def init; end
+    sig do
+      params(cache_init_options: T.nilable(CacheInitOptions))
+        .returns(T.self_type)
+    end
+    def init(cache_init_options = nil); end
 
     private
 

data/sig/optify.rbs

@@ -2,6 +2,10 @@
 module Optify
 end
 
+# Raised when a feature name is not found in the registry.
+class Optify::UnknownFeatureError < StandardError
+end
+
 # DEPRECATED: Use `Optify::FromHashable` instead.
 # A base class for classes from configuration files.
 # Classes that derive from this can easily be used with `Optify::OptionsProvider.get_options`
@@ -17,6 +21,22 @@ end
 class Optify::CacheOptions < FromHashable
 end
 
+# The mode for the cache.
+module Optify::CacheMode
+end
+
+Optify::Optify::CacheMode::NOT_THREAD_SAFE: Symbol
+
+Optify::Optify::CacheMode::THREAD_SAFE: Symbol
+
+# Options for initializing the cache.
+class Optify::CacheInitOptions
+  # A value from `CacheMode`.
+  def initialize: () -> Integer?
+                | () -> Symbol
+                | (?max_size: Integer? max_size, ?mode: Symbol mode) -> void
+end
+
 # Information about a feature.
 class Optify::OptionsMetadata < FromHashable
   def aliases: () -> ::Array[String]?
@@ -163,9 +183,7 @@ module Optify::ProviderModule
   # @return Whether the feature has conditions.
   def conditions?: (String canonical_feature_name) -> bool
 
-  # (Optional) Eagerly initializes the cache.
-  # @return `self`.
-  def init: () -> self
+  def init: (?CacheInitOptions? cache_init_options) -> self
 
   # Map aliases or canonical feature names (perhaps derived from a file names) to the canonical feature names.
   # Canonical feature names map to themselves.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: optify-config
 version: !ruby/object:Gem::Version
-  version: 1.18.0
+  version: 1.20.0
 platform: x86_64-linux
 authors:
 - Justin D. Harris
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-12-10 00:00:00.000000000 Z
+date: 2026-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: optify-from_hash
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.1
+- !ruby/object:Gem::Dependency
+  name: sin_lru_redux
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.2
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
   requirement: !ruby/object:Gem::Requirement
@@ -78,14 +92,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.76.1
+        version: 1.82.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.76.1
+        version: 1.82.1
 - !ruby/object:Gem::Dependency
   name: rubocop-sorbet
   requirement: !ruby/object:Gem::Requirement
@@ -161,6 +175,7 @@ files:
 - lib/optify_ruby/3.3/optify_ruby.so
 - lib/optify_ruby/3.4/optify_ruby.so
 - lib/optify_ruby/base_config.rb
+- lib/optify_ruby/cache_init_options.rb
 - lib/optify_ruby/get_options_preferences.rb
 - lib/optify_ruby/implementation.rb
 - lib/optify_ruby/options_metadata.rb