new: Add ConfigSetting.nested. (#143)

Author: milesj

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## Unreleased
+
+#### 🚀 Updates
+
+- Added `ConfigSetting.nested` to recursively include nested settings.
+
 ## 0.17.8
 
 #### 🚀 Updates

Cargo.lock

@@ -13,9 +13,9 @@ rpkl = "0.3.5"
 rust_decimal = "1.36.0"
 semver = "1.0.24"
 serde = { version = "1.0.217", features = ["derive"] }
-serde_json = "1.0.134"
+serde_json = "1.0.135"
 serde_yaml = "0.9.34"
-starbase_sandbox = "0.8.0"
+starbase_sandbox = "0.8.1"
 toml = "0.8.19"
 tracing = "0.1.41"
 url = "2.5.4"

Cargo.toml

@@ -14,7 +14,7 @@ all-features = true
 proc-macro = true
 
 [dependencies]
-convert_case = "0.6.0"
+convert_case = "0.7.1"
 darling = "0.20.10"
 proc-macro2 = "1.0.89"
 quote = "1.0.37"

crates/macros/Cargo.toml

@@ -33,29 +33,21 @@ impl Container<'_> {
         };
 
         match self {
-            Self::NamedStruct { fields } => {
+            Self::NamedStruct { fields } | Self::UnnamedStruct { fields } => {
                 for field in fields {
-                    let name = field.get_name(Some(&field.casing_format));
+                    let name = if field.name.is_some() {
+                        field.get_name(Some(&field.casing_format))
+                    } else {
+                        field.index.to_string()
+                    };
                     let env_key = if let Some(value) = field.get_env_var() {
                         quote!(Some(#value.into()))
                     } else {
                         quote!(None)
                     };
-                    let type_alias = format_alias(field.value.to_token_stream());
-
-                    settings.push(quote! {
-                        (#name.into(), schematic::ConfigSetting {
-                            env_key: #env_key,
-                            type_alias: #type_alias.into(),
-                        }),
-                    });
-                }
-            }
-            Self::UnnamedStruct { fields } => {
-                for field in fields {
-                    let name = field.index.to_string();
-                    let env_key = if let Some(value) = field.get_env_var() {
-                        quote!(Some(#value.into()))
+                    let nested = if field.is_nested() {
+                        let value = field.value_type.get_config_type();
+                        quote!(Some(#value::settings()))
                     } else {
                         quote!(None)
                     };
@@ -64,6 +56,7 @@ impl Container<'_> {
                     settings.push(quote! {
                         (#name.into(), schematic::ConfigSetting {
                             env_key: #env_key,
+                            nested: #nested,
                             type_alias: #type_alias.into(),
                         }),
                     });
@@ -76,16 +69,16 @@ impl Container<'_> {
 
                     settings.push(quote! {
                         (#name.into(), schematic::ConfigSetting {
-                            env_key: None,
                             type_alias: #type_alias.into(),
+                            ..Default::default()
                         }),
                     });
                 }
             }
         };
 
         quote! {
-            std::collections::HashMap::from_iter([
+            std::collections::BTreeMap::from_iter([
                 #(#settings)*
             ])
         }

crates/macros/src/common/container.rs

@@ -181,6 +181,15 @@ impl<'l> FieldValue<'l> {
         }
     }
 
+    pub fn get_config_type(&self) -> &'l Type {
+        match self {
+            Self::NestedList { item, .. } => item,
+            Self::NestedMap { value, .. } => value,
+            Self::NestedValue { value, .. } => value,
+            Self::Value { value, .. } => value,
+        }
+    }
+
     pub fn get_inner_type(&self) -> Option<&'l Type> {
         match self {
             Self::Value { value, .. } => Some(value),

crates/macros/src/common/field_value.rs

@@ -145,7 +145,7 @@ impl ToTokens for ConfigMacro<'_> {
                 }
 
                 #instrument
-                fn settings() -> std::collections::HashMap<String, schematic::ConfigSetting> {
+                fn settings() -> schematic::ConfigSettingMap {
                     #settings_metadata
                 }
             }

crates/macros/src/config/mod.rs

@@ -24,7 +24,7 @@ pub fn format_case(format: &str, value: &str, is_variant: bool) -> String {
         } else {
             Case::Snake
         })
-        .without_boundaries(&[Boundary::UpperDigit, Boundary::LowerDigit])
+        .without_boundaries(&[Boundary::UPPER_DIGIT, Boundary::LOWER_DIGIT])
         .to_case(case)
 }
 

crates/macros/src/utils.rs

@@ -5,7 +5,7 @@ use super::extender::ExtendsFrom;
 use super::validator::*;
 use schematic_types::Schematic;
 use serde::{de::DeserializeOwned, Serialize};
-use std::collections::HashMap;
+use std::collections::BTreeMap;
 
 /// Represents a partial configuration of the base [`Config`], with all settings marked as optional
 /// by wrapping the values in [`Option`].
@@ -86,8 +86,8 @@ pub trait Config: Sized + Schematic {
     fn from_partial(partial: Self::Partial) -> Self;
 
     /// Return a map of all settings and their metadata for the configuration.
-    fn settings() -> HashMap<String, ConfigSetting> {
-        HashMap::default()
+    fn settings() -> ConfigSettingMap {
+        BTreeMap::default()
     }
 }
 
@@ -98,8 +98,11 @@ pub trait ConfigEnum: Sized + Schematic {
 }
 
 /// Represents metadata about a setting within a configuration.
-#[derive(Clone, Debug)]
+#[derive(Clone, Debug, Default)]
 pub struct ConfigSetting {
     pub env_key: Option<String>,
+    pub nested: Option<ConfigSettingMap>,
     pub type_alias: String,
 }
+
+pub type ConfigSettingMap = BTreeMap<String, ConfigSetting>;