optify-config 1.6.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36866b3812d07006be63012e27381c3cae692e3a4a4adc6c1c9d54dbfda32c26
-  data.tar.gz: df8fa299cbd2bc4891011e60a847c1819ab83de05b668924576515ffab648773
+  metadata.gz: 987b7a6cc75f0b5ab66cf1862917aecc96c1efef0ca54a771e49f3c359694534
+  data.tar.gz: ea2b13f32633ca71b4d947ab71cd0dfa918891c2b796078dea1b79ad939fa2d8
 SHA512:
-  metadata.gz: 57eec9c48450af7a1b0541d2e241215f4b5b7c374d0b8e5a39dcfee1608cab60f29f02483c9b7a8a4422bb70cbde863c659c5e7f01821e21f06bcb1cb7005cb3
-  data.tar.gz: c8bec708ad806a205a3fe0d9dee33237e1c29b38c4c42ad8df21daf1d7c9910322e7b99abddeba512a3175b8b368b42db1e564be148e2731f078aec6e17e42fb
+  metadata.gz: f8ce4f21f5e025a0a2fef506ea348a7bd12d0d97196dd580cf87fb078cd4730a637b5796769228d20d10ee433e60f7c9e2782f5d5c3173063324306e249ad30e
+  data.tar.gz: e73782f6410d5e045df70ea7537f05504cea49a7bde3314a5902a9717cc6c2c9ded89ddd810eae372b8c67eab5e24f9bca1626b0f983f1186839ac5026b94e91

data/ext/optify_ruby/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "optify_ruby"
-version = "0.10.0"
+version = "0.11.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.10.0" }
+optify = { path = "../../../../rust/optify", version = "0.11.0" }
 rb-sys = { version = "*", default-features = false, features = ["ruby-static"] }
 serde_json = "1.0.140"

data/ext/optify_ruby/src/lib.rs

@@ -2,13 +2,13 @@ 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;
 use optify::provider::OptionsWatcher;
 use optify::schema::metadata::OptionsMetadata;
 use std::cell::RefCell;
+use std::path::Path;
 
 #[derive(Clone)]
 #[wrap(class = "Optify::GetOptionsPreferences")]
@@ -53,6 +53,23 @@ fn convert_metadata(metadata: &OptionsMetadata) -> String {
 }
 
 impl WrappedOptionsProvider {
+    fn build(ruby: &Ruby, directory: String) -> Result<WrappedOptionsProvider, magnus::Error> {
+        match OptionsProvider::build(Path::new(&directory)) {
+            Ok(provider) => Ok(WrappedOptionsProvider(RefCell::new(provider))),
+            Err(e) => Err(magnus::Error::new(ruby.exception_runtime_error(), e)),
+        }
+    }
+
+    fn build_from_directories(
+        ruby: &Ruby,
+        directories: Vec<String>,
+    ) -> Result<WrappedOptionsProvider, magnus::Error> {
+        match OptionsProvider::build_from_directories(&directories) {
+            Ok(provider) => Ok(WrappedOptionsProvider(RefCell::new(provider))),
+            Err(e) => Err(magnus::Error::new(ruby.exception_runtime_error(), e)),
+        }
+    }
+
     fn get_aliases(&self) -> Vec<String> {
         self.0.borrow().get_aliases()
     }
@@ -70,11 +87,10 @@ impl WrappedOptionsProvider {
         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_all_options(&features, None, Some(&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)),
@@ -98,11 +114,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))
     }
 
@@ -129,11 +144,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)),
@@ -148,10 +162,9 @@ impl WrappedOptionsProvider {
         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,
+            &feature_names,
             None,
             Some(&preferences),
         ) {
@@ -201,6 +214,23 @@ impl WrappedOptionsProviderBuilder {
 struct WrappedOptionsWatcher(RefCell<OptionsWatcher>);
 
 impl WrappedOptionsWatcher {
+    fn build(ruby: &Ruby, directory: String) -> Result<WrappedOptionsWatcher, magnus::Error> {
+        match OptionsWatcher::build(Path::new(&directory)) {
+            Ok(provider) => Ok(WrappedOptionsWatcher(RefCell::new(provider))),
+            Err(e) => Err(magnus::Error::new(ruby.exception_runtime_error(), e)),
+        }
+    }
+
+    fn build_from_directories(
+        ruby: &Ruby,
+        directories: Vec<String>,
+    ) -> Result<WrappedOptionsWatcher, magnus::Error> {
+        match OptionsWatcher::build_from_directories(&directories) {
+            Ok(provider) => Ok(WrappedOptionsWatcher(RefCell::new(provider))),
+            Err(e) => Err(magnus::Error::new(ruby.exception_runtime_error(), e)),
+        }
+    }
+
     fn get_aliases(&self) -> Vec<String> {
         self.0.borrow().get_aliases()
     }
@@ -216,11 +246,10 @@ impl WrappedOptionsWatcher {
         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_all_options(&features, None, Some(&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)),
@@ -244,11 +273,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))
     }
 
@@ -273,11 +301,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)),
@@ -292,10 +319,9 @@ impl WrappedOptionsWatcher {
         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,
+            &feature_names,
             None,
             Some(&preferences),
         ) {
@@ -353,6 +379,11 @@ 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_singleton_method("build", function!(WrappedOptionsProvider::build, 1))?;
+    provider_class.define_singleton_method(
+        "build_from_directories",
+        function!(WrappedOptionsProvider::build_from_directories, 1),
+    )?;
     provider_class.define_method("aliases", method!(WrappedOptionsProvider::get_aliases, 0))?;
     provider_class.define_method("features", method!(WrappedOptionsProvider::get_features, 0))?;
     provider_class.define_method(
@@ -428,6 +459,11 @@ 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_singleton_method("build", function!(WrappedOptionsWatcher::build, 1))?;
+    watcher_class.define_singleton_method(
+        "build_from_directories",
+        function!(WrappedOptionsWatcher::build_from_directories, 1),
+    )?;
     watcher_class.define_method("aliases", method!(WrappedOptionsWatcher::get_aliases, 0))?;
     watcher_class.define_method("features", method!(WrappedOptionsWatcher::get_features, 0))?;
     watcher_class.define_method(

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,20 @@ module Optify
   class OptionsRegistry
     abstract!
 
+    class << self
+      # Build using just one directory.
+      # @param directory The directory to build the provider from.
+      # @return The instance.
+      sig { params(directory: String).returns(OptionsRegistry) }
+      def build(directory); end
+
+      # Build from multiple directories.
+      # @param directories The directories to build the provider from.
+      # @return The instance.
+      sig { params(directories: T::Array[String]).returns(OptionsRegistry) }
+      def build_from_directories(directories); end
+    end
+
     # @return All of the aliases.
     sig { returns(T::Array[String]) }
     def aliases; end

data/sig/optify.rbs

@@ -60,6 +60,16 @@ end
 
 # A registry of features that provides configurations.
 class Optify::OptionsRegistry
+  # Build using just one directory.
+  # @param directory The directory to build the provider from.
+  # @return The instance.
+  def build: (String directory) -> OptionsRegistry
+
+  # Build from multiple directories.
+  # @param directories The directories to build the provider from.
+  # @return The instance.
+  def build_from_directories: (::Array[String] directories) -> OptionsRegistry
+
   # @return All of the aliases.
   def aliases: () -> ::Array[String]
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: optify-config
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Justin D. Harris
 bindir: exe
 cert_chain: []
-date: 2025-06-11 00:00:00.000000000 Z
+date: 2025-06-30 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