new: Add RegexSetting type. (#168)

Author: milesj

CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## Unreleased
+
+#### 🚀 Updates
+
+- Added a `RegexSetting` type that wraps `regex::Regex` and implements additional traits so that it
+  can be used in configs.
+  - Requires the `type_regex` feature.
+  - Default implementation uses `.` (match all) pattern.
+
 ## 0.18.10
 
 #### ⚙️ Internal

Cargo.lock

@@ -28,6 +28,7 @@ tracing = { workspace = true }
 garde = { version = "0.22.0", default-features = false, optional = true, features = [
 	"regex",
 ] }
+regex = { workspace = true, optional = true }
 serde = { workspace = true }
 serde_path_to_error = { version = "0.1.17", optional = true }
 starbase_styles = { version = "0.6.3", optional = true }
@@ -93,7 +94,7 @@ renderer_typescript = ["schema"]
 # Types
 type_chrono = ["schematic_types/chrono"]
 type_indexmap = ["schematic_types/indexmap"]
-type_regex = ["schematic_types/regex"]
+type_regex = ["schematic_types/regex", "dep:regex"]
 type_relative_path = ["schematic_types/relative_path"]
 type_rust_decimal = ["schematic_types/rust_decimal", "garde?/rust_decimal"]
 type_semver = ["schematic_types/semver"]
@@ -145,7 +146,6 @@ derive_more = { version = "2.0.1", features = ["try_into", "as_ref"] }
 # Types
 chrono = { workspace = true, features = ["serde"] }
 indexmap = { workspace = true }
-regex = { workspace = true }
 relative-path = { workspace = true, features = ["serde"] }
 rust_decimal = { workspace = true }
 semver = { workspace = true, features = ["serde"] }

crates/schematic/Cargo.toml

@@ -9,6 +9,7 @@ mod loader;
 mod merger;
 mod parser;
 mod path;
+mod settings;
 mod source;
 #[cfg(feature = "validate")]
 mod validator;
@@ -23,6 +24,7 @@ pub use loader::*;
 pub use merger::*;
 pub use parser::*;
 pub use path::*;
+pub use settings::*;
 pub use source::*;
 #[cfg(feature = "validate")]
 pub use validator::*;

crates/schematic/src/config/mod.rs

@@ -0,0 +1,5 @@
+#[cfg(feature = "type_regex")]
+mod regex;
+
+#[cfg(feature = "type_regex")]
+pub use regex::*;

crates/schematic/src/config/settings/mod.rs

@@ -0,0 +1,81 @@
+use crate::schema::{Schema, SchemaBuilder, Schematic};
+use regex::{Error, Regex};
+use serde::{Deserialize, Serialize};
+use std::hash::{Hash, Hasher};
+use std::ops::Deref;
+use std::str::FromStr;
+
+#[derive(Clone, Debug, Deserialize, Serialize)]
+#[serde(try_from = "String", into = "String")]
+pub struct RegexSetting(pub Regex);
+
+impl RegexSetting {
+    pub fn new(value: impl AsRef<str>) -> Result<Self, Error> {
+        Ok(Self(Regex::new(value.as_ref())?))
+    }
+}
+
+impl Default for RegexSetting {
+    fn default() -> Self {
+        Self(Regex::new(".").unwrap())
+    }
+}
+
+impl Deref for RegexSetting {
+    type Target = Regex;
+
+    fn deref(&self) -> &Self::Target {
+        &self.0
+    }
+}
+
+impl FromStr for RegexSetting {
+    type Err = Error;
+
+    fn from_str(value: &str) -> Result<Self, Self::Err> {
+        Self::new(value)
+    }
+}
+
+impl TryFrom<&str> for RegexSetting {
+    type Error = Error;
+
+    fn try_from(value: &str) -> Result<Self, Self::Error> {
+        Self::new(value)
+    }
+}
+
+impl TryFrom<String> for RegexSetting {
+    type Error = Error;
+
+    fn try_from(value: String) -> Result<Self, Self::Error> {
+        Self::new(value)
+    }
+}
+
+#[allow(clippy::from_over_into)]
+impl Into<String> for RegexSetting {
+    fn into(self) -> String {
+        self.to_string()
+    }
+}
+
+impl PartialEq<RegexSetting> for RegexSetting {
+    fn eq(&self, other: &RegexSetting) -> bool {
+        self.as_str() == other.as_str()
+    }
+}
+
+impl Eq for RegexSetting {}
+
+impl Hash for RegexSetting {
+    fn hash<H: Hasher>(&self, state: &mut H) {
+        state.write(self.0.as_str().as_bytes());
+    }
+}
+
+impl Schematic for RegexSetting {
+    fn build_schema(_: SchemaBuilder) -> Schema {
+        SchemaBuilder::generate::<Regex>()
+    }
+}

crates/schematic/src/config/settings/regex.rs

@@ -64,6 +64,7 @@ struct GenConfig {
     decimal: rust_decimal::Decimal,
     time: chrono::NaiveTime,
     path: PathBuf,
+    regex: RegexSetting,
     rel_path: relative_path::RelativePathBuf,
     url: Option<url::Url>,
     uuid: uuid::Uuid,

crates/schematic/tests/generator_test.rs

@@ -1,6 +1,5 @@
 ---
 source: crates/schematic/tests/generator_test.rs
-assertion_line: 184
 expression: "fs::read_to_string(file).unwrap()"
 ---
 {
@@ -24,6 +23,7 @@ expression: "fs::read_to_string(file).unwrap()"
     "nested",
     "number",
     "path",
+    "regex",
     "relPath",
     "string",
     "time",
@@ -130,6 +130,10 @@ expression: "fs::read_to_string(file).unwrap()"
       "type": "string",
       "format": "path"
     },
+    "regex": {
+      "type": "string",
+      "format": "regex"
+    },
     "relPath": {
       "type": "string",
       "format": "path"

crates/schematic/tests/snapshots/generator_test__json_schema__defaults.snap

@@ -102,6 +102,10 @@ expression: "fs::read_to_string(file).unwrap()"
       "type": "string",
       "format": "path"
     },
+    "regex": {
+      "type": "string",
+      "format": "regex"
+    },
     "relPath": {
       "type": "string",
       "format": "path"

crates/schematic/tests/snapshots/generator_test__json_schema__not_required.snap

@@ -188,6 +188,17 @@ expression: "fs::read_to_string(file).unwrap()"
         }
       ]
     },
+    "regex": {
+      "anyOf": [
+        {
+          "type": "string",
+          "format": "regex"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
     "relPath": {
       "anyOf": [
         {
@@ -395,6 +406,7 @@ expression: "fs::read_to_string(file).unwrap()"
         "nested",
         "number",
         "path",
+        "regex",
         "relPath",
         "string",
         "time",
@@ -501,6 +513,10 @@ expression: "fs::read_to_string(file).unwrap()"
           "type": "string",
           "format": "path"
         },
+        "regex": {
+          "type": "string",
+          "format": "regex"
+        },
         "relPath": {
           "type": "string",
           "format": "path"