optify-config 1.19.0 → 1.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81af05a9dfdec78ffccbbab0e5706d18e10c2e0eec1a411e31fbe72ecf09986f
-  data.tar.gz: 8655770ee823d7a45e138435a1750384daf1d2d5d24ec66e99a1deb95873c4d9
+  metadata.gz: b9dd88296e3b768722678600aeda7d5e990d675b5165c7a0e2f878af54bc33fb
+  data.tar.gz: b28522bf1042b9f5c3ce12759118d61a670539dbdd1b44ee03c07560204a2c96
 SHA512:
-  metadata.gz: 7d5d9c76e78194ca49789693bff24825bcedd115e4d366741b7a56a3216b305b13c6983c59978510b43a4583178de1776b8aaedd6cce88efee43bde461537d2d
-  data.tar.gz: ec48acec24437adabab1663d91e43f047a81c8378dffccbb018afe841a57e844a993cc7bb1cee50ea228b102852bd23f8290f10c0cb5b45c6207f4b91d192722
+  metadata.gz: 21d05d3bf852a27f1503118c3b1514180b3d1e60822549ebac31d231b5d6f250fe53829dc033e155c4d9ed3506f76c4c775233abe8159307272323f41315904b
+  data.tar.gz: fb6ada9be0fd33096a73d2b3536857f9d2ed7b6bd5be62cd34bb1ff51d0097027474bb82005c13e25eb898f4ef9c3aed60ee9671a2e7f18c27d8dcc75aa8a700

data/ext/optify_ruby/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "optify_ruby"
-version = "0.21.0"
+version = "0.22.0"
 edition = "2021"
 
 description = "optify bindings for Ruby"

data/ext/optify_ruby/src/lib.rs

@@ -1,4 +1,7 @@
-use magnus::{function, method, prelude::*, wrap, Object, Ruby, Value as RbValue};
+use magnus::{
+    exception::ExceptionClass, function, method, prelude::*, wrap, Object, RModule, Ruby,
+    Value as RbValue,
+};
 use optify::builder::OptionsProviderBuilder;
 use optify::builder::OptionsRegistryBuilder;
 use optify::builder::OptionsWatcherBuilder;
@@ -13,6 +16,24 @@ use crate::preferences::MutGetOptionsPreferences;
 
 mod preferences;
 
+const UNKNOWN_FEATURE_PATTERN: &str = "is not a known feature.";
+
+fn get_unknown_feature_error(ruby: &Ruby) -> Result<ExceptionClass, magnus::Error> {
+    let module: RModule = ruby.class_object().const_get("Optify")?;
+    module.const_get("UnknownFeatureError")
+}
+
+fn map_feature_error(ruby: &Ruby, error: String) -> magnus::Error {
+    if error.contains(UNKNOWN_FEATURE_PATTERN) {
+        match get_unknown_feature_error(ruby) {
+            Ok(exception_class) => magnus::Error::new(exception_class, error),
+            Err(_) => magnus::Error::new(ruby.exception_runtime_error(), error),
+        }
+    } else {
+        magnus::Error::new(ruby.exception_runtime_error(), error)
+    }
+}
+
 fn json_value_to_ruby(ruby: &Ruby, value: &serde_json::Value) -> Result<RbValue, magnus::Error> {
     match value {
         serde_json::Value::Null => Ok(ruby.qnil().as_value()),
@@ -117,7 +138,7 @@ impl WrappedOptionsProvider {
             .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)),
+            Err(e) => Err(map_feature_error(ruby, e)),
         }
     }
 
@@ -134,7 +155,7 @@ impl WrappedOptionsProvider {
             .get_all_options(&feature_names, None, Some(preferences))
         {
             Ok(options) => json_value_to_ruby(ruby, &options),
-            Err(e) => Err(magnus::Error::new(ruby.exception_runtime_error(), e)),
+            Err(e) => Err(map_feature_error(ruby, e)),
         }
     }
 
@@ -147,7 +168,7 @@ impl WrappedOptionsProvider {
             .0
             .borrow()
             .get_canonical_feature_name(&feature_name)
-            .map_err(|e| magnus::Error::new(ruby.exception_arg_error(), e))
+            .map_err(|e| map_feature_error(ruby, e))
     }
 
     fn get_canonical_feature_names(
@@ -159,7 +180,7 @@ impl WrappedOptionsProvider {
             .0
             .borrow()
             .get_canonical_feature_names(&feature_names)
-            .map_err(|e| magnus::Error::new(ruby.exception_arg_error(), e))
+            .map_err(|e| map_feature_error(ruby, e))
     }
 
     fn get_feature_metadata_json(&self, canonical_feature_name: String) -> Option<String> {
@@ -191,7 +212,7 @@ impl WrappedOptionsProvider {
             .get_filtered_feature_names(&feature_names, Some(preferences))
         {
             Ok(features) => Ok(features),
-            Err(e) => Err(magnus::Error::new(ruby.exception_runtime_error(), e)),
+            Err(e) => Err(map_feature_error(ruby, e)),
         }
     }
 
@@ -208,7 +229,7 @@ impl WrappedOptionsProvider {
             .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)),
+            Err(e) => Err(map_feature_error(ruby, e)),
         }
     }
 
@@ -227,7 +248,7 @@ impl WrappedOptionsProvider {
             Some(preferences),
         ) {
             Ok(options) => Ok(options.to_string()),
-            Err(e) => Err(magnus::Error::new(ruby.exception_runtime_error(), e)),
+            Err(e) => Err(map_feature_error(ruby, e)),
         }
     }
 
@@ -243,7 +264,7 @@ impl WrappedOptionsProvider {
             .get_options_with_preferences(&key, &feature_names, None, None)
         {
             Ok(options) => json_value_to_ruby(ruby, &options),
-            Err(e) => Err(magnus::Error::new(ruby.exception_runtime_error(), e)),
+            Err(e) => Err(map_feature_error(ruby, e)),
         }
     }
 
@@ -262,7 +283,7 @@ impl WrappedOptionsProvider {
             Some(preferences),
         ) {
             Ok(options) => json_value_to_ruby(ruby, &options),
-            Err(e) => Err(magnus::Error::new(ruby.exception_runtime_error(), e)),
+            Err(e) => Err(map_feature_error(ruby, e)),
         }
     }
 
@@ -363,7 +384,7 @@ impl WrappedOptionsWatcher {
             .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)),
+            Err(e) => Err(map_feature_error(ruby, e)),
         }
     }
 
@@ -380,7 +401,7 @@ impl WrappedOptionsWatcher {
             .get_all_options(&feature_names, None, Some(preferences))
         {
             Ok(options) => json_value_to_ruby(ruby, &options),
-            Err(e) => Err(magnus::Error::new(ruby.exception_runtime_error(), e)),
+            Err(e) => Err(map_feature_error(ruby, e)),
         }
     }
 
@@ -393,7 +414,7 @@ impl WrappedOptionsWatcher {
             .0
             .borrow()
             .get_canonical_feature_name(&feature_name)
-            .map_err(|e| magnus::Error::new(ruby.exception_arg_error(), e))
+            .map_err(|e| map_feature_error(ruby, e))
     }
 
     fn get_canonical_feature_names(
@@ -405,7 +426,7 @@ impl WrappedOptionsWatcher {
             .0
             .borrow()
             .get_canonical_feature_names(&feature_names)
-            .map_err(|e| magnus::Error::new(ruby.exception_arg_error(), e))
+            .map_err(|e| map_feature_error(ruby, e))
     }
 
     fn get_feature_metadata_json(&self, canonical_feature_name: String) -> Option<String> {
@@ -436,7 +457,7 @@ impl WrappedOptionsWatcher {
             .get_filtered_feature_names(&feature_names, Some(preferences))
         {
             Ok(features) => Ok(features),
-            Err(e) => Err(magnus::Error::new(ruby.exception_runtime_error(), e)),
+            Err(e) => Err(map_feature_error(ruby, e)),
         }
     }
 
@@ -452,7 +473,7 @@ impl WrappedOptionsWatcher {
             .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)),
+            Err(e) => Err(map_feature_error(ruby, e)),
         }
     }
 
@@ -471,7 +492,7 @@ impl WrappedOptionsWatcher {
             Some(preferences),
         ) {
             Ok(options) => Ok(options.to_string()),
-            Err(e) => Err(magnus::Error::new(ruby.exception_runtime_error(), e)),
+            Err(e) => Err(map_feature_error(ruby, e)),
         }
     }
 
@@ -487,7 +508,7 @@ impl WrappedOptionsWatcher {
             .get_options_with_preferences(&key, &feature_names, None, None)
         {
             Ok(options) => json_value_to_ruby(ruby, &options),
-            Err(e) => Err(magnus::Error::new(ruby.exception_runtime_error(), e)),
+            Err(e) => Err(map_feature_error(ruby, e)),
         }
     }
 
@@ -506,7 +527,7 @@ impl WrappedOptionsWatcher {
             Some(preferences),
         ) {
             Ok(options) => json_value_to_ruby(ruby, &options),
-            Err(e) => Err(magnus::Error::new(ruby.exception_runtime_error(), e)),
+            Err(e) => Err(map_feature_error(ruby, e)),
         }
     }
 
@@ -551,6 +572,8 @@ impl WrappedOptionsWatcherBuilder {
 fn init(ruby: &Ruby) -> Result<(), magnus::Error> {
     let module = ruby.define_module("Optify")?;
 
+    module.define_error("UnknownFeatureError", ruby.exception_standard_error())?;
+
     let builder_class = module.define_class("OptionsProviderBuilder", ruby.class_object())?;
 
     builder_class

data/rbi/optify.rbi

@@ -3,6 +3,10 @@
 
 # Tools for working with configurations declared in files.
 module Optify
+  # Raised when a feature name is not found in the registry.
+  class UnknownFeatureError < StandardError
+  end
+
   # DEPRECATED: Use `Optify::FromHashable` instead.
   # A base class for classes from configuration files.
   # Classes that derive from this can easily be used with `Optify::OptionsProvider.get_options`

data/sig/optify.rbs

@@ -2,6 +2,10 @@
 module Optify
 end
 
+# Raised when a feature name is not found in the registry.
+class Optify::UnknownFeatureError < StandardError
+end
+
 # DEPRECATED: Use `Optify::FromHashable` instead.
 # A base class for classes from configuration files.
 # Classes that derive from this can easily be used with `Optify::OptionsProvider.get_options`

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: optify-config
 version: !ruby/object:Gem::Version
-  version: 1.19.0
+  version: 1.20.0
 platform: ruby
 authors:
 - Justin D. Harris