optify-config 1.5.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6e408009d1e2d33b018e713943bff39e64af229cd6d01230545049ef4c581f8
-  data.tar.gz: cab2f82de63a7a1b6b0b2a7be7534ea7d70ff393f127020690ca702193d7721c
+  metadata.gz: c39f6b23931576d844b9c6c4991a373f96198f009e4f4a78227adcb373162f2c
+  data.tar.gz: 98cd040744bdfeab713795c276b58b472b5e9fff7d4c7bf164f5196aab94e812
 SHA512:
-  metadata.gz: 9e53a8589e16df9cfee91990646d719dd39b056f5eb90da8a2ac0f1e4bf9c8b6d5681eab7944d81e650077615fe2d6cee0f214d57f6c1df9d859efc5afedfdf8
-  data.tar.gz: 7a7c183366b9969a23960c303bcc43004403e34daf5ab7adb06fdfa7dee00d47081950bb58d057a14b1ad14c8d0b1e77aeb919763c921ff26876bdacdc49dbb5
+  metadata.gz: b3c2ae32795dbca9e1a9a48eebbec2b6a854e44071554693dbad9c226ec94624cab294b6ed8fa790a0bbd7bbfec5a59bc42cb4d61d475299fde1c41ff0476738
+  data.tar.gz: 50bcc0e02ced878b270fd3d98a4f7ba46c66eb67f0b1913429e78ef4362dc30ec9045dc22c00c006424849cfe590b77c8219bac5dd8a6e7a05402f26a966b1c1

data/ext/optify_ruby/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "optify_ruby"
-version = "0.9.0"
+version = "0.10.0"
 edition = "2021"
 
 description = "optify bindings for Ruby"
@@ -21,6 +21,6 @@ crate-type = ["cdylib"]
 
 [dependencies]
 magnus = "0.7.1"
-optify = { path = "../../../../rust/optify", version = "0.9.0" }
+optify = { path = "../../../../rust/optify", version = "0.10.0" }
 rb-sys = { version = "*", default-features = false, features = ["ruby-static"] }
 serde_json = "1.0.140"

data/ext/optify_ruby/src/lib.rs

@@ -2,7 +2,6 @@ use magnus::{function, method, prelude::*, wrap, Object, Ruby};
 use optify::builder::OptionsProviderBuilder;
 use optify::builder::OptionsRegistryBuilder;
 use optify::builder::OptionsWatcherBuilder;
-use optify::convert_to_str_slice;
 use optify::provider::GetOptionsPreferences;
 use optify::provider::OptionsProvider;
 use optify::provider::OptionsRegistry;
@@ -53,6 +52,14 @@ fn convert_metadata(metadata: &OptionsMetadata) -> String {
 }
 
 impl WrappedOptionsProvider {
+    fn get_aliases(&self) -> Vec<String> {
+        self.0.borrow().get_aliases()
+    }
+
+    fn get_features_and_aliases(&self) -> Vec<String> {
+        self.0.borrow().get_features_and_aliases()
+    }
+
     // These methods cannot accept `str`s because of how magnus works.
     // Return the JSON as a string so that it can be deserialized easily into a specific immutable class in Ruby.
     fn get_all_options_json(
@@ -61,12 +68,11 @@ impl WrappedOptionsProvider {
         feature_names: Vec<String>,
         preferences: &MutGetOptionsPreferences,
     ) -> Result<String, magnus::Error> {
-        let _preferences = convert_preferences(preferences);
-        let features = convert_to_str_slice!(feature_names);
+        let preferences = convert_preferences(preferences);
         match rb_self
             .0
             .borrow()
-            .get_all_options(&features, &None, &_preferences)
+            .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)),
@@ -90,11 +96,10 @@ impl WrappedOptionsProvider {
         rb_self: &Self,
         feature_names: Vec<String>,
     ) -> Result<Vec<String>, magnus::Error> {
-        let features = convert_to_str_slice!(feature_names);
         rb_self
             .0
             .borrow()
-            .get_canonical_feature_names(&features)
+            .get_canonical_feature_names(&feature_names)
             .map_err(|e| magnus::Error::new(ruby.exception_arg_error(), e))
     }
 
@@ -121,11 +126,10 @@ impl WrappedOptionsProvider {
         key: String,
         feature_names: Vec<String>,
     ) -> Result<String, magnus::Error> {
-        let features = convert_to_str_slice!(feature_names);
         match rb_self
             .0
             .borrow()
-            .get_options_with_preferences(&key, &features, &None, &None)
+            .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)),
@@ -139,24 +143,24 @@ impl WrappedOptionsProvider {
         feature_names: Vec<String>,
         preferences: &MutGetOptionsPreferences,
     ) -> Result<String, magnus::Error> {
-        let _preferences = convert_preferences(preferences);
-        let features = convert_to_str_slice!(feature_names);
-        match rb_self
-            .0
-            .borrow()
-            .get_options_with_preferences(&key, &features, &None, &_preferences)
-        {
+        let preferences = convert_preferences(preferences);
+        match rb_self.0.borrow().get_options_with_preferences(
+            &key,
+            &feature_names,
+            None,
+            Some(&preferences),
+        ) {
             Ok(options) => Ok(options.to_string()),
             Err(e) => Err(magnus::Error::new(ruby.exception_runtime_error(), e)),
         }
     }
 }
 
-fn convert_preferences(preferences: &MutGetOptionsPreferences) -> Option<GetOptionsPreferences> {
-    Some(optify::provider::GetOptionsPreferences {
+fn convert_preferences(preferences: &MutGetOptionsPreferences) -> GetOptionsPreferences {
+    GetOptionsPreferences {
         overrides_json: preferences.get_overrides_json(),
         skip_feature_name_conversion: preferences.skip_feature_name_conversion(),
-    })
+    }
 }
 
 #[derive(Clone)]
@@ -192,18 +196,25 @@ impl WrappedOptionsProviderBuilder {
 struct WrappedOptionsWatcher(RefCell<OptionsWatcher>);
 
 impl WrappedOptionsWatcher {
+    fn get_aliases(&self) -> Vec<String> {
+        self.0.borrow().get_aliases()
+    }
+
+    fn get_features_and_aliases(&self) -> Vec<String> {
+        self.0.borrow().get_features_and_aliases()
+    }
+
     fn get_all_options_json(
         ruby: &Ruby,
         rb_self: &Self,
         feature_names: Vec<String>,
         preferences: &MutGetOptionsPreferences,
     ) -> Result<String, magnus::Error> {
-        let _preferences = convert_preferences(preferences);
-        let features = convert_to_str_slice!(feature_names);
+        let preferences = convert_preferences(preferences);
         match rb_self
             .0
             .borrow()
-            .get_all_options(&features, &None, &_preferences)
+            .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)),
@@ -227,11 +238,10 @@ impl WrappedOptionsWatcher {
         rb_self: &Self,
         feature_names: Vec<String>,
     ) -> Result<Vec<String>, magnus::Error> {
-        let features = convert_to_str_slice!(feature_names);
         rb_self
             .0
             .borrow()
-            .get_canonical_feature_names(&features)
+            .get_canonical_feature_names(&feature_names)
             .map_err(|e| magnus::Error::new(ruby.exception_arg_error(), e))
     }
 
@@ -256,11 +266,10 @@ impl WrappedOptionsWatcher {
         key: String,
         feature_names: Vec<String>,
     ) -> Result<String, magnus::Error> {
-        let features = convert_to_str_slice!(feature_names);
         match rb_self
             .0
             .borrow()
-            .get_options_with_preferences(&key, &features, &None, &None)
+            .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)),
@@ -274,13 +283,13 @@ impl WrappedOptionsWatcher {
         feature_names: Vec<String>,
         preferences: &MutGetOptionsPreferences,
     ) -> Result<String, magnus::Error> {
-        let _preferences = convert_preferences(preferences);
-        let features = convert_to_str_slice!(feature_names);
-        match rb_self
-            .0
-            .borrow()
-            .get_options_with_preferences(&key, &features, &None, &_preferences)
-        {
+        let preferences = convert_preferences(preferences);
+        match rb_self.0.borrow().get_options_with_preferences(
+            &key,
+            &feature_names,
+            None,
+            Some(&preferences),
+        ) {
             Ok(options) => Ok(options.to_string()),
             Err(e) => Err(magnus::Error::new(ruby.exception_runtime_error(), e)),
         }
@@ -335,7 +344,12 @@ fn init(ruby: &Ruby) -> Result<(), magnus::Error> {
     builder_class.define_method("build", method!(WrappedOptionsProviderBuilder::build, 0))?;
 
     let provider_class = module.define_class("OptionsProvider", ruby.class_object())?;
+    provider_class.define_method("aliases", method!(WrappedOptionsProvider::get_aliases, 0))?;
     provider_class.define_method("features", method!(WrappedOptionsProvider::get_features, 0))?;
+    provider_class.define_method(
+        "features_and_aliases",
+        method!(WrappedOptionsProvider::get_features_and_aliases, 0),
+    )?;
     provider_class.define_method(
         "get_all_options_json",
         method!(WrappedOptionsProvider::get_all_options_json, 2),
@@ -405,7 +419,12 @@ fn init(ruby: &Ruby) -> Result<(), magnus::Error> {
         .define_method("build", method!(WrappedOptionsWatcherBuilder::build, 0))?;
 
     let watcher_class = module.define_class("OptionsWatcher", ruby.class_object())?;
+    watcher_class.define_method("aliases", method!(WrappedOptionsWatcher::get_aliases, 0))?;
     watcher_class.define_method("features", method!(WrappedOptionsWatcher::get_features, 0))?;
+    watcher_class.define_method(
+        "features_and_aliases",
+        method!(WrappedOptionsWatcher::get_features_and_aliases, 0),
+    )?;
     watcher_class.define_method(
         "get_all_options_json",
         method!(WrappedOptionsWatcher::get_all_options_json, 2),

data/lib/optify_ruby/base_config.rb

@@ -8,8 +8,7 @@ module Optify
   # A base class for classes from configuration files.
   # Classes that derive from this can easily be used with `Optify::OptionsProvider.get_options`
   # because they will have an implementation of `from_hash` that works recursively.
-  # This class is a work in progress with minimal error handling
-  # and doesn't handle certain cases such as nilable types yet.
+  # This class is a work in progress with minimal error handling.
   # It may be moved to another gem in the future.
   class BaseConfig
     extend T::Sig
@@ -26,7 +25,10 @@ module Optify
       instance = new
 
       hash.each do |key, value|
-        sig_return_type = T::Utils.signature_for_method(instance_method(key)).return_type
+        sig = T::Utils.signature_for_method(instance_method(key))
+        raise "A Sorbet signature is required for `#{name}.#{key}`." if sig.nil?
+
+        sig_return_type = sig.return_type
         value = _convert_value(value, sig_return_type)
         instance.instance_variable_set("@#{key}", value)
       end
@@ -104,8 +106,47 @@ module Optify
       return true if other.equal?(self)
       return false unless other.is_a?(self.class)
 
-      instance_variables.all? do |var|
-        instance_variable_get(var) == other.instance_variable_get(var)
+      instance_variables.all? do |name|
+        instance_variable_get(name) == other.instance_variable_get(name)
+      end
+    end
+
+    # Convert this object to a Hash recursively.
+    # This is mostly the reverse operation of `from_hash`,
+    # as keys will be symbols
+    # and `from_hash` will convert strings to symbols if that's how the attribute is declared.
+    # @return [Hash] The hash representation of this object.
+    #: () -> Hash[Symbol, untyped]
+    def to_h
+      result = Hash.new(instance_variables.size)
+
+      instance_variables.each do |var_name|
+        # Remove the @ prefix to get the method name
+        method_name = var_name.to_s[1..] #: as !nil
+        value = instance_variable_get(var_name)
+        result[method_name.to_sym] = _convert_value_to_hash(value)
+      end
+
+      result
+    end
+
+    private
+
+    #: (untyped value) -> untyped
+    def _convert_value_to_hash(value)
+      case value
+      when Array
+        value.map { |v| _convert_value_to_hash(v) }
+      when Hash
+        value.transform_values { |v| _convert_value_to_hash(v) }
+      when nil
+        nil
+      else
+        if value.respond_to?(:to_h)
+          value.to_h
+        else
+          value
+        end
       end
     end
   end

data/rbi/optify.rbi

@@ -76,6 +76,14 @@ module Optify
   class OptionsRegistry
     abstract!
 
+    # @return All of the aliases.
+    sig { returns(T::Array[String]) }
+    def aliases; end
+
+    # @return All of the aliases and features.
+    sig { returns(T::Array[String]) }
+    def features_and_aliases; end
+
     # @return All of the canonical feature names.
     sig { returns(T::Array[String]) }
     def features; end

data/sig/optify.rbs

@@ -60,6 +60,12 @@ end
 
 # A registry of features that provides configurations.
 class Optify::OptionsRegistry
+  # @return All of the aliases.
+  def aliases: () -> ::Array[String]
+
+  # @return All of the aliases and features.
+  def features_and_aliases: () -> ::Array[String]
+
   # @return All of the canonical feature names.
   def features: () -> ::Array[String]
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: optify-config
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Justin D. Harris
 bindir: exe
 cert_chain: []
-date: 2025-05-16 00:00:00.000000000 Z
+date: 2025-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rb_sys
@@ -29,14 +29,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.12083
+        version: 0.5.12167
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.12083
+        version: 0.5.12167
 - !ruby/object:Gem::Dependency
   name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
@@ -57,42 +57,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.9.3
+        version: 4.0.0.dev.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.9.3
+        version: 4.0.0.dev.4
 - !ruby/object:Gem::Dependency
   name: sorbet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.12083
+        version: 0.5.12167
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.12083
+        version: 0.5.12167
 - !ruby/object:Gem::Dependency
   name: tapioca
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.11
+        version: 0.17.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.11
+        version: 0.17.2
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement