optify-config 0.3.1-x86_64-linux → 0.4.0-x86_64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6870c41300fad1002661403e126bd059c3ac038e92d930a01bf77dbb8a184e9
-  data.tar.gz: b2776930d110fe84d1cb1434f77c7313a702d0149ef3982fd66fd907a77fafd9
+  metadata.gz: 0cd8b5c2a180c50fb96ddc0de87c5bc202d8284dd3d0841a11983992d8d850e7
+  data.tar.gz: 3a9a083c2cf74d7fd91f4860acc3f78f676a08a4ade0030c911f27b65bd01bb9
 SHA512:
-  metadata.gz: 77545f64e60742c89b150c6ecae0dc4cccece963b573795b9f1178513993ea6c6d5727b4de7853157ecb1236ae0c0fa7bd570fd6408a98a900102fdbc2a80148
-  data.tar.gz: 19ecad6d22146c0a2accb0f8cea153e41ad19ed11e252e9f51b82f5f4fe5bcdf48ef8bf1641692a1aa7e99a480126e568c8cac5fc4d96f5add3985598718fd4b
+  metadata.gz: e76ab78301cc0369c2994d62cdb57ca92c33e60bee0257b2aa0af3dd2508a26718d00c5d35a6681d0610d037f665eb53e5660ed7ab6194b701086a2f5f484fc2
+  data.tar.gz: 9420836983600d66c1f1f54786cb70e11752f0429a8947ce222e58d245b9dc7c81e48c20baf83a0fbe183b2cf0090c0e9776fe1c82b8e2c1690fe26c91242321

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: x86_64-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