optify-config 0.3.1-aarch64-linux → 0.4.0-aarch64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ca08576e6486f44d10f34b164024a7b1827d9821b45e73a33eb6ff80689cc90
-  data.tar.gz: 00403717bb667efee520dc03a1a169d0592fc34216802083d2f71fca1158ba72
+  metadata.gz: 80aa089ed4b89d881246babfec79def4e156e0cc3574c49461a1edc0ca4c5d1d
+  data.tar.gz: 53862c20e3009adb89e4c3c02856590ed5ec76c1d76977f1f21bb7714e38ae6a
 SHA512:
-  metadata.gz: 56f54eb5bcf62da381d6c1397b1858c48228cd270a48a3c33a6c9882fc5f168d3afdbcad163f7069b7a911dbf403188910ce38eaebdf8140e26d5a046f14dd1a
-  data.tar.gz: 8dfb6107be09d5b942a208be82d9c95bcecd561d41413a722845a939e54bbecde3194dac9803a0542b90e71c1e398e6e8afbbefe7172ea920945cf43ede3fe8d
+  metadata.gz: ba979c843fc765e5cfa152c0c3715b1f768c56176898453f99006a9f46a545d70583fbfabb98c94b24f8f7733f181646adc4837aa284536084b6d80d2d392276
+  data.tar.gz: 2b09394038fb04536d916ae311c41d626697faed9af92477fd59a9d32384713beff71fce53701de4585c8621d34698b84feb9a43c29dfd5f8d31d017b259ac7f

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
@@ -29,25 +35,61 @@ module Optify
     # @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`.
+    # @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)]
+          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)
+    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)
       h = JSON.parse(options_json, object_class: Hash)
       unless config_class.respond_to?(:from_hash)
-        raise NotImplementedError, 'The provided config class does not implement 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
 
   # A builder for creating an `OptionsProvider` instance.

data/rbi/optify.rbi

@@ -20,6 +20,11 @@ module Optify
     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.
@@ -34,11 +39,12 @@ module Optify
         .params(
           key: String,
           feature_names: T::Array[String],
-          config_class: T::Class[T.type_parameter(:Config)]
-        )
-        .returns(T.type_parameter(:Config))
-    end
-    def get_options(key, feature_names, config_class); end
+          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.
     #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: optify-config
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: aarch64-linux
 authors:
 - Justin D. Harris
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-02-07 00:00:00.000000000 Z
+date: 2025-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime