optify-config 1.3.1-arm64-darwin → 1.4.1-arm64-darwin

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 047de527f317e146c8c1a1e0a55fb064fdfbb1deba7244ff1918f7711bc37f58
-  data.tar.gz: e311875d61d5f4eba2b6e94aff241dae276846d981974d872da9d3b60bf4f1fa
+  metadata.gz: d5323df292e4343c8e96adefab27f4c86fb02144af156f9c68c9d121365186c5
+  data.tar.gz: ab4346606d0624c868cb9bb980f25567f99a0961651b715620b16915ac3b857d
 SHA512:
-  metadata.gz: 2c02a632370d7412f22b2167d9ed854abd39cfee9ece700fa40e425b14869dcd5abcf4e23bfc5e623d3e1586bc56c0387ad452d23c8f12b2b7bbf02957188788
-  data.tar.gz: 6c94214d6397e1003f4ebb800a72ceecae16c9e3da5d0422413d734c08853fe23102bb6c55be889a783eafb969c19ad56bd58f789703cde394df921f5956450f
+  metadata.gz: f660032bbb46c1ec49b9eca62cb7f7b07b213c4050c8794bc7b6d493418c281038c7acc2e0ca2bde8de59fbb7b67961c8d39df8f7e64104b80b972dc38a445a0
+  data.tar.gz: 1230db10484560654152e9bfe0bdc41dd0f2d33e8728b23f5998a607ef625a3c7eff6adecb80268261d6e2aca84cbf869a881e706387b921f44490486c58bfe1

data/lib/optify.rb

@@ -2,6 +2,7 @@
 # typed: strict
 
 # The implementation to use directly Ruby and with types declared.
+require_relative 'optify_ruby/get_options_preferences'
 require_relative 'optify_ruby/implementation'
 require_relative 'optify_ruby/watcher_implementation'
 

data/lib/optify_ruby/get_options_preferences.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+# typed: strict
+
+module Optify
+  # Preferences for `get_options`.
+  class GetOptionsPreferences
+    # @param overrides [Hash]
+    #: (Hash[untyped, untyped] overrides) -> void
+    def overrides=(overrides)
+      self.overrides_json = overrides.to_json
+    end
+  end
+end

data/lib/optify_ruby/provider_module.rb

@@ -11,7 +11,7 @@ module Optify
     #: (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.
-      # Ideally in production, a single feature that imports many other features is used for the most common scenario.
+      # Ideally in production, a single feature that imports many other features is used for the most common scenarios.
       # Benchmarks show that it is faster to use a loop than to call the Rust implementation which involves making a `Vec<String>` and returning a `Vec<String>`.
       if feature_names.length < 4
         feature_names.map { |feature_name| get_canonical_feature_name(feature_name) }
@@ -87,19 +87,31 @@ module Optify
       # 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.
-      init unless @cache
-      unless preferences&.skip_feature_name_conversion
-        # When there are just a few names, then it can be faster to convert them one by one in a loop to avoid working with an array in Rust.
-        # When there are over 7 names, then it is faster to convert them with one call to Rust.
-        feature_names = get_canonical_feature_names(feature_names)
+      if preferences&.overrides?
+        Kernel.raise ArgumentError,
+                     'Caching when overrides are given is not supported. Do not pass cache options when using overrides in preferences.'
       end
 
+      init unless @cache
+      feature_names = get_canonical_feature_names(feature_names) unless preferences&.skip_feature_name_conversion
+
       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)
 
-      preferences ||= GetOptionsPreferences.new
-      preferences.skip_feature_name_conversion = true
+      # Handle a cache miss.
+
+      # We can avoid converting the features names because they're already converted, if that was desired.
+      if preferences.nil?
+        preferences = GetOptionsPreferences.new
+        preferences.skip_feature_name_conversion = true
+      else
+        # Indeed the copying of preferences could be wasteful, but this only happens on a cache miss
+        # and when no custom preferences are provided.
+        preferences = preferences.dup
+        preferences.skip_feature_name_conversion = true
+      end
+
       result = get_options(key, feature_names, config_class, nil, preferences)
 
       T.must(@cache)[cache_key] = result

data/rbi/optify.rbi

@@ -43,8 +43,25 @@ module Optify
 
   # Preferences when getting options.
   class GetOptionsPreferences
-    sig { params(value: T::Boolean).returns(GetOptionsPreferences) }
+    # Indicates if overrides are set.
+    sig { returns(T::Boolean) }
+    def overrides?; end
+
+    # Set overrides to apply after building the options based on the feature names.
+    # Do not provide overrides when requesting cached options.
+    # @param value The overrides to apply.
+    sig { params(value: T.nilable(T::Hash[T.untyped, T.untyped])).void }
+    def overrides=(value); end
+
+    # Set overrides to apply after building the options based on the feature names.
+    # Do not provide overrides when requesting cached options.
+    # @param value The overrides to apply as serialized JSON.
+    sig { params(value: T.nilable(String)).void }
+    def overrides_json=(value); end
+
+    sig { params(value: T::Boolean).void }
     def skip_feature_name_conversion=(value); end
+
     sig { returns(T::Boolean) }
     def skip_feature_name_conversion; end
   end

data/sig/optify.rbs

@@ -35,7 +35,20 @@ end
 
 # Preferences when getting options.
 class Optify::GetOptionsPreferences
-  def skip_feature_name_conversion=: (bool value) -> GetOptionsPreferences
+  # Indicates if overrides are set.
+  def overrides?: () -> bool
+
+  # Set overrides to apply after building the options based on the feature names.
+  # Do not provide overrides when requesting cached options.
+  # @param value The overrides to apply.
+  def overrides=: (::Hash[untyped, untyped]? value) -> void
+
+  # Set overrides to apply after building the options based on the feature names.
+  # Do not provide overrides when requesting cached options.
+  # @param value The overrides to apply as serialized JSON.
+  def overrides_json=: (String? value) -> void
+
+  def skip_feature_name_conversion=: (bool value) -> void
 
   def skip_feature_name_conversion: () -> bool
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: optify-config
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.1
 platform: arm64-darwin
 authors:
 - Justin D. Harris
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-05-08 00:00:00.000000000 Z
+date: 2025-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
@@ -16,56 +16,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.11911
+        version: 0.5.12083
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.11911
+        version: 0.5.12083
 - !ruby/object:Gem::Dependency
   name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.9
+        version: 1.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.9
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: rbs
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.9.2
+        version: 3.9.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.9.2
+        version: 3.9.3
 - !ruby/object:Gem::Dependency
   name: sorbet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.11911
+        version: 0.5.12083
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.11911
+        version: 0.5.12083
 - !ruby/object:Gem::Dependency
   name: tapioca
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.6.7
+        version: 3.6.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.6.7
+        version: 3.6.8
 description: |-
   Simplifies getting the right configuration options for a process using pre-loaded configurations
     from files to manage options for experiments or flights.
@@ -106,6 +106,7 @@ files:
 - lib/optify_ruby/3.2/optify_ruby.bundle
 - lib/optify_ruby/3.4/optify_ruby.bundle
 - lib/optify_ruby/base_config.rb
+- lib/optify_ruby/get_options_preferences.rb
 - lib/optify_ruby/implementation.rb
 - lib/optify_ruby/options_metadata.rb
 - lib/optify_ruby/provider_module.rb