optify-config 1.18.0 → 1.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd8f5a1196800f635ebc7f4a9c1ac020ba3cc021654fa7dbbd914d0cb6122ff0
-  data.tar.gz: 27555219991c4a53971f29c50bf7b01ab5f40efab70c4264c4b155595d4e02e8
+  metadata.gz: b9dd88296e3b768722678600aeda7d5e990d675b5165c7a0e2f878af54bc33fb
+  data.tar.gz: b28522bf1042b9f5c3ce12759118d61a670539dbdd1b44ee03c07560204a2c96
 SHA512:
-  metadata.gz: b7dda691f74e094addd304d87c184361565e9df2d604e7a13ea3bf89e7833e4ac9e3350a500cdaf7cc5f6ec4885900e7ebdebe985e73a8bb17295710eb6e49f4
-  data.tar.gz: da0e154d813a6ee1858c25fb4ba4b62288acb639822a89567621641d0708e0682505b38fd0dfeb94e9084b195fb102d424f5aa21464a15b928f5c7d9dffdb252
+  metadata.gz: 21d05d3bf852a27f1503118c3b1514180b3d1e60822549ebac31d231b5d6f250fe53829dc033e155c4d9ed3506f76c4c775233abe8159307272323f41315904b
+  data.tar.gz: fb6ada9be0fd33096a73d2b3536857f9d2ed7b6bd5be62cd34bb1ff51d0097027474bb82005c13e25eb898f4ef9c3aed60ee9671a2e7f18c27d8dcc75aa8a700

data/ext/optify_ruby/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "optify_ruby"
-version = "0.20.0"
+version = "0.22.0"
 edition = "2021"
 
 description = "optify bindings for Ruby"

data/ext/optify_ruby/src/lib.rs

@@ -1,4 +1,7 @@
-use magnus::{function, method, prelude::*, wrap, Object, Ruby, Value as RbValue};
+use magnus::{
+    exception::ExceptionClass, function, method, prelude::*, wrap, Object, RModule, Ruby,
+    Value as RbValue,
+};
 use optify::builder::OptionsProviderBuilder;
 use optify::builder::OptionsRegistryBuilder;
 use optify::builder::OptionsWatcherBuilder;
@@ -13,6 +16,24 @@ use crate::preferences::MutGetOptionsPreferences;
 
 mod preferences;
 
+const UNKNOWN_FEATURE_PATTERN: &str = "is not a known feature.";
+
+fn get_unknown_feature_error(ruby: &Ruby) -> Result<ExceptionClass, magnus::Error> {
+    let module: RModule = ruby.class_object().const_get("Optify")?;
+    module.const_get("UnknownFeatureError")
+}
+
+fn map_feature_error(ruby: &Ruby, error: String) -> magnus::Error {
+    if error.contains(UNKNOWN_FEATURE_PATTERN) {
+        match get_unknown_feature_error(ruby) {
+            Ok(exception_class) => magnus::Error::new(exception_class, error),
+            Err(_) => magnus::Error::new(ruby.exception_runtime_error(), error),
+        }
+    } else {
+        magnus::Error::new(ruby.exception_runtime_error(), error)
+    }
+}
+
 fn json_value_to_ruby(ruby: &Ruby, value: &serde_json::Value) -> Result<RbValue, magnus::Error> {
     match value {
         serde_json::Value::Null => Ok(ruby.qnil().as_value()),
@@ -117,7 +138,7 @@ impl WrappedOptionsProvider {
             .get_all_options(&feature_names, None, Some(preferences))
         {
             Ok(options) => Ok(options.to_string()),
-            Err(e) => Err(magnus::Error::new(ruby.exception_runtime_error(), e)),
+            Err(e) => Err(map_feature_error(ruby, e)),
         }
     }
 
@@ -134,7 +155,7 @@ impl WrappedOptionsProvider {
             .get_all_options(&feature_names, None, Some(preferences))
         {
             Ok(options) => json_value_to_ruby(ruby, &options),
-            Err(e) => Err(magnus::Error::new(ruby.exception_runtime_error(), e)),
+            Err(e) => Err(map_feature_error(ruby, e)),
         }
     }
 
@@ -147,7 +168,7 @@ impl WrappedOptionsProvider {
             .0
             .borrow()
             .get_canonical_feature_name(&feature_name)
-            .map_err(|e| magnus::Error::new(ruby.exception_arg_error(), e))
+            .map_err(|e| map_feature_error(ruby, e))
     }
 
     fn get_canonical_feature_names(
@@ -159,7 +180,7 @@ impl WrappedOptionsProvider {
             .0
             .borrow()
             .get_canonical_feature_names(&feature_names)
-            .map_err(|e| magnus::Error::new(ruby.exception_arg_error(), e))
+            .map_err(|e| map_feature_error(ruby, e))
     }
 
     fn get_feature_metadata_json(&self, canonical_feature_name: String) -> Option<String> {
@@ -191,7 +212,7 @@ impl WrappedOptionsProvider {
             .get_filtered_feature_names(&feature_names, Some(preferences))
         {
             Ok(features) => Ok(features),
-            Err(e) => Err(magnus::Error::new(ruby.exception_runtime_error(), e)),
+            Err(e) => Err(map_feature_error(ruby, e)),
         }
     }
 
@@ -208,7 +229,7 @@ impl WrappedOptionsProvider {
             .get_options_with_preferences(&key, &feature_names, None, None)
         {
             Ok(options) => Ok(options.to_string()),
-            Err(e) => Err(magnus::Error::new(ruby.exception_runtime_error(), e)),
+            Err(e) => Err(map_feature_error(ruby, e)),
         }
     }
 
@@ -227,7 +248,7 @@ impl WrappedOptionsProvider {
             Some(preferences),
         ) {
             Ok(options) => Ok(options.to_string()),
-            Err(e) => Err(magnus::Error::new(ruby.exception_runtime_error(), e)),
+            Err(e) => Err(map_feature_error(ruby, e)),
         }
     }
 
@@ -243,7 +264,7 @@ impl WrappedOptionsProvider {
             .get_options_with_preferences(&key, &feature_names, None, None)
         {
             Ok(options) => json_value_to_ruby(ruby, &options),
-            Err(e) => Err(magnus::Error::new(ruby.exception_runtime_error(), e)),
+            Err(e) => Err(map_feature_error(ruby, e)),
         }
     }
 
@@ -262,7 +283,7 @@ impl WrappedOptionsProvider {
             Some(preferences),
         ) {
             Ok(options) => json_value_to_ruby(ruby, &options),
-            Err(e) => Err(magnus::Error::new(ruby.exception_runtime_error(), e)),
+            Err(e) => Err(map_feature_error(ruby, e)),
         }
     }
 
@@ -363,7 +384,7 @@ impl WrappedOptionsWatcher {
             .get_all_options(&feature_names, None, Some(preferences))
         {
             Ok(options) => Ok(options.to_string()),
-            Err(e) => Err(magnus::Error::new(ruby.exception_runtime_error(), e)),
+            Err(e) => Err(map_feature_error(ruby, e)),
         }
     }
 
@@ -380,7 +401,7 @@ impl WrappedOptionsWatcher {
             .get_all_options(&feature_names, None, Some(preferences))
         {
             Ok(options) => json_value_to_ruby(ruby, &options),
-            Err(e) => Err(magnus::Error::new(ruby.exception_runtime_error(), e)),
+            Err(e) => Err(map_feature_error(ruby, e)),
         }
     }
 
@@ -393,7 +414,7 @@ impl WrappedOptionsWatcher {
             .0
             .borrow()
             .get_canonical_feature_name(&feature_name)
-            .map_err(|e| magnus::Error::new(ruby.exception_arg_error(), e))
+            .map_err(|e| map_feature_error(ruby, e))
     }
 
     fn get_canonical_feature_names(
@@ -405,7 +426,7 @@ impl WrappedOptionsWatcher {
             .0
             .borrow()
             .get_canonical_feature_names(&feature_names)
-            .map_err(|e| magnus::Error::new(ruby.exception_arg_error(), e))
+            .map_err(|e| map_feature_error(ruby, e))
     }
 
     fn get_feature_metadata_json(&self, canonical_feature_name: String) -> Option<String> {
@@ -436,7 +457,7 @@ impl WrappedOptionsWatcher {
             .get_filtered_feature_names(&feature_names, Some(preferences))
         {
             Ok(features) => Ok(features),
-            Err(e) => Err(magnus::Error::new(ruby.exception_runtime_error(), e)),
+            Err(e) => Err(map_feature_error(ruby, e)),
         }
     }
 
@@ -452,7 +473,7 @@ impl WrappedOptionsWatcher {
             .get_options_with_preferences(&key, &feature_names, None, None)
         {
             Ok(options) => Ok(options.to_string()),
-            Err(e) => Err(magnus::Error::new(ruby.exception_runtime_error(), e)),
+            Err(e) => Err(map_feature_error(ruby, e)),
         }
     }
 
@@ -471,7 +492,7 @@ impl WrappedOptionsWatcher {
             Some(preferences),
         ) {
             Ok(options) => Ok(options.to_string()),
-            Err(e) => Err(magnus::Error::new(ruby.exception_runtime_error(), e)),
+            Err(e) => Err(map_feature_error(ruby, e)),
         }
     }
 
@@ -487,7 +508,7 @@ impl WrappedOptionsWatcher {
             .get_options_with_preferences(&key, &feature_names, None, None)
         {
             Ok(options) => json_value_to_ruby(ruby, &options),
-            Err(e) => Err(magnus::Error::new(ruby.exception_runtime_error(), e)),
+            Err(e) => Err(map_feature_error(ruby, e)),
         }
     }
 
@@ -506,7 +527,7 @@ impl WrappedOptionsWatcher {
             Some(preferences),
         ) {
             Ok(options) => json_value_to_ruby(ruby, &options),
-            Err(e) => Err(magnus::Error::new(ruby.exception_runtime_error(), e)),
+            Err(e) => Err(map_feature_error(ruby, e)),
         }
     }
 
@@ -551,6 +572,8 @@ impl WrappedOptionsWatcherBuilder {
 fn init(ruby: &Ruby) -> Result<(), magnus::Error> {
     let module = ruby.define_module("Optify")?;
 
+    module.define_error("UnknownFeatureError", ruby.exception_standard_error())?;
+
     let builder_class = module.define_class("OptionsProviderBuilder", ruby.class_object())?;
 
     builder_class

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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: optify-config
 version: !ruby/object:Gem::Version
-  version: 1.18.0
+  version: 1.20.0
 platform: ruby
 authors:
 - Justin D. Harris
@@ -37,6 +37,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
@@ -91,14 +105,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
@@ -175,6 +189,7 @@ files:
 - ext/optify_ruby/src/preferences.rs
 - lib/optify.rb
 - 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