WIP: config: use newtype

crates/config/src/branch_name.rs

@@ -1,2 +1,2 @@
 // The name of a Branch
-crate::newtype!(BranchName is a String);
+crate::newtype!(BranchName is a String, derive_more::Display, Default);

crates/config/src/forge_alias.rs

@@ -1,5 +1,5 @@
 // The name of a Forge to connect to
-crate::newtype!(ForgeAlias is a String);
+crate::newtype!(ForgeAlias is a String, derive_more::Display, Default);
 impl From<&ForgeAlias> for std::path::PathBuf {
     fn from(value: &ForgeAlias) -> Self {
         Self::from(&value.0)

crates/config/src/git_dir.rs

@@ -1,7 +1,7 @@
 //
 use std::path::PathBuf;
 
-crate::newtype!(GitDir is a PathBuf, without Display);
+crate::newtype!(GitDir is a PathBuf, Default);
 impl GitDir {
     pub const fn pathbuf(&self) -> &PathBuf {
         &self.0
@@ -22,8 +22,3 @@ impl From<&GitDir> for PathBuf {
         value.to_path_buf()
     }
 }
-impl From<GitDir> for PathBuf {
-    fn from(value: GitDir) -> Self {
-        value.0
-    }
-}

crates/config/src/host_name.rs

@@ -1,2 +1,2 @@
 // The hostname of a forge
-crate::newtype!(Hostname is a String);
+crate::newtype!(Hostname is a String, derive_more::Display, Default);

crates/config/src/lib.rs

@@ -3,9 +3,9 @@
 mod api_token;
 mod branch_name;
 pub mod common;
+mod forge_alias;
 mod forge_config;
 mod forge_details;
-mod forge_name;
 mod forge_type;
 pub mod git_dir;
 mod host_name;
@@ -26,9 +26,9 @@ mod tests;
 
 pub use api_token::ApiToken;
 pub use branch_name::BranchName;
+pub use forge_alias::ForgeAlias;
 pub use forge_config::ForgeConfig;
 pub use forge_details::ForgeDetails;
-pub use forge_name::ForgeAlias;
 pub use forge_type::ForgeType;
 pub use git_dir::GitDir;
 pub use host_name::Hostname;

crates/config/src/newtype.rs

@@ -1,35 +1,10 @@
 //
 #[macro_export]
 macro_rules! newtype {
-    ($name:ident is a $type:ty, without Display) => {
+    ($name:ident) => {
-        #[derive(
-            Clone,
-            Default,
-            Debug,
-            derive_more::From,
-            PartialEq,
-            Eq,
-            PartialOrd,
-            Ord,
-            Hash,
-            derive_more::AsRef,
-            derive_more::Deref,
-            serde::Deserialize,
-            serde::Serialize,
-        )]
-        pub struct $name($type);
-        impl $name {
-            pub fn new(value: impl Into<$type>) -> Self {
-                Self(value.into())
-            }
-            pub fn unwrap(self) -> $type {
-                self.0
-            }
-        }
-    };
-    ($name:ident is a $type:ty) => {
         #[derive(
             Clone,
+            Copy,
             Default,
             Debug,
             derive_more::Display,
@@ -40,18 +15,42 @@ macro_rules! newtype {
             Ord,
             Hash,
             derive_more::AsRef,
+        )]
+        pub struct $name;
+        impl $name {
+            pub fn new() -> Self {
+                Self
+            }
+        }
+    };
+    ($name:ident is a $type:ty $(, $derive:ty)*) => {
+        #[derive(
+            Clone,
+            Debug,
+            derive_more::From,
+            PartialEq,
+            Eq,
+            PartialOrd,
+            Ord,
+            Hash,
+            derive_more::AsRef,
             derive_more::Deref,
-            serde::Deserialize,
+            $($derive),*
-            serde::Serialize,
         )]
         pub struct $name($type);
         impl $name {
             pub fn new(value: impl Into<$type>) -> Self {
                 Self(value.into())
             }
+            #[allow(clippy::missing_const_for_fn)]
             pub fn unwrap(self) -> $type {
                 self.0
             }
         }
+            impl From<$name> for $type {
+                fn from(value: $name) -> $type {
+                        value.unwrap()
+                }
+            }
     };
 }

crates/config/src/repo_branches.rs

@@ -2,7 +2,17 @@ use crate::BranchName;
 
 /// Mapped from `.git-next.toml` file at `branches`
 #[derive(
-    Clone, Debug, PartialEq, Eq, serde::Deserialize, derive_more::Constructor, derive_more::Display,
+    Clone,
+    Hash,
+    Debug,
+    PartialEq,
+    Eq,
+    PartialOrd,
+    Ord,
+    serde::Deserialize,
+    serde::Serialize,
+    derive_more::Constructor,
+    derive_more::Display,
 )]
 #[display("{},{},{}", main, next, dev)]
 pub struct RepoBranches {

crates/config/src/repo_config.rs

@@ -5,7 +5,17 @@ use crate::RepoConfigSource;
 /// Is also derived from the optional parameters in `git-next-server.toml` at
 /// `forge.{forge}.repos.{repo}.(main|next|dev)`
 #[derive(
-    Clone, Debug, PartialEq, Eq, serde::Deserialize, derive_more::Constructor, derive_more::Display,
+    Clone,
+    Hash,
+    Debug,
+    PartialEq,
+    Eq,
+    PartialOrd,
+    Ord,
+    serde::Deserialize,
+    serde::Serialize,
+    derive_more::Constructor,
+    derive_more::Display,
 )]
 #[display("{}", branches)]
 pub struct RepoConfig {
@@ -13,7 +23,7 @@ pub struct RepoConfig {
     source: RepoConfigSource,
 }
 impl RepoConfig {
-    pub fn load(toml: &str) -> Result<Self, toml::de::Error> {
+    pub fn parse(toml: &str) -> Result<Self, toml::de::Error> {
         toml::from_str(format!("source = \"Repo\"\n{}", toml).as_str())
     }
 

crates/config/src/repo_config_source.rs

@@ -1,4 +1,6 @@
-#[derive(Copy, Clone, Debug, PartialEq, Eq, serde::Deserialize)]
+#[derive(
+    Copy, Hash, Clone, Debug, PartialEq, Eq, serde::Deserialize, PartialOrd, Ord, serde::Serialize,
+)]
 pub enum RepoConfigSource {
     Repo,
     Server,

crates/config/src/server.rs

@@ -1,6 +1,5 @@
 //
 use actix::prelude::*;
-use derive_more::Constructor;
 
 use std::{
     collections::HashMap,
@@ -12,7 +11,7 @@ use std::{
 use kxio::fs::FileSystem;
 use tracing::info;
 
-use crate::{ForgeAlias, ForgeConfig, RepoAlias};
+use crate::{newtype, ForgeAlias, ForgeConfig, RepoAlias};
 
 #[derive(Debug, thiserror::Error)]
 pub enum Error {
@@ -96,18 +95,8 @@ impl Webhook {
     }
 }
 
-/// The URL for the webhook where forges should send their updates
+// The RL for the webhook where forges should send their updates
-#[derive(
+newtype!(WebhookUrl is a String, serde::Serialize);
-    Clone,
-    Debug,
-    PartialEq,
-    Eq,
-    serde::Serialize,
-    serde::Deserialize,
-    derive_more::AsRef,
-    Constructor,
-)]
-pub struct WebhookUrl(String);
 
 /// The directory to store server data, such as cloned repos
 #[derive(Clone, Debug, PartialEq, Eq, serde::Deserialize, derive_more::Constructor)]

crates/config/src/tests.rs

@@ -1,18 +1,22 @@
 //
+use super::*;
+
+use assert2::let_assert;
+use secrecy::ExposeSecret;
+use std::collections::BTreeMap;
+use std::path::PathBuf;
+
+use crate::server::Http;
+use crate::server::ServerConfig;
+use crate::server::ServerStorage;
+use crate::server::Webhook;
+use crate::webhook::push::Branch;
 
 type Result<T> = core::result::Result<T, Box<dyn std::error::Error>>;
 type TestResult = Result<()>;
 
 mod server_repo_config {
-    use std::path::PathBuf;
+    use super::*;
-
-    use assert2::let_assert;
-
-    use crate::{
-        tests::given, BranchName, GitDir, RepoBranches, RepoConfig, RepoConfigSource, RepoPath,
-    };
-
-    use super::super::server_repo_config::*;
 
     #[test]
     fn should_not_return_repo_config_when_no_branches() {
@@ -91,9 +95,6 @@ mod server_repo_config {
     }
 }
 mod repo_config {
-    use crate::{RepoBranches, RepoConfigSource};
-
-    use super::super::repo_config::*;
     use super::*;
 
     #[test]
@@ -110,7 +111,7 @@ mod repo_config {
         "#
         );
 
-        let rc = RepoConfig::load(toml.as_str())?;
+        let rc = RepoConfig::parse(toml.as_str())?;
 
         assert_eq!(
             rc,
@@ -144,13 +145,7 @@ mod repo_config {
     }
 }
 mod forge_config {
-    use std::collections::BTreeMap;
+    use super::*;
-
-    use secrecy::ExposeSecret;
-
-    use crate::{
-        tests::given, ForgeConfig, ForgeType, Hostname, RepoAlias, ServerRepoConfig, User,
-    };
 
     #[test]
     fn should_return_repos() {
@@ -246,14 +241,9 @@ mod forge_config {
     }
 }
 mod forge_details {
-    use std::collections::BTreeMap;
+    use super::*;
-
     use secrecy::ExposeSecret;
 
-    use crate::{
-        tests::given, ApiToken, ForgeAlias, ForgeConfig, ForgeDetails, ForgeType, Hostname, User,
-    };
-
     #[test]
     fn should_return_forge_alias() {
         let forge_type = ForgeType::MockForge;
@@ -364,10 +354,9 @@ mod forge_details {
     }
 }
 mod forge_name {
+    use super::*;
     use std::path::PathBuf;
 
-    use crate::{tests::given, ForgeAlias};
-
     #[test]
     fn should_convert_to_pathbuf() {
         let name = given::a_name();
@@ -379,7 +368,7 @@ mod forge_name {
     }
 }
 mod forge_type {
-    use crate::ForgeType;
+    use super::*;
 
     #[test]
     fn should_display_as_string() {
@@ -387,10 +376,9 @@ mod forge_type {
     }
 }
 mod gitdir {
+    use super::*;
     use std::path::PathBuf;
 
-    use crate::{tests::given, GitDir};
-
     #[test]
     fn should_return_pathbuf() {
         let pathbuf = PathBuf::default().join(given::a_name());
@@ -439,7 +427,7 @@ mod gitdir {
     }
 }
 mod repo_branches {
-    use crate::{tests::given, BranchName, RepoBranches};
+    use super::*;
 
     #[test]
     fn should_return_main() {
@@ -470,15 +458,10 @@ mod repo_branches {
     }
 }
 mod server {
+    use super::*;
     mod load {
 
-        use assert2::let_assert;
+        use super::*;
-        use pretty_assertions::assert_eq;
-
-        use crate::{
-            server::ServerConfig,
-            tests::{given, TestResult},
-        };
 
         #[test]
         fn load_should_parse_server_config() -> TestResult {
@@ -559,7 +542,7 @@ token = "{forge_token}"
 {repos}
                 "#
             );
-            eprintln!("{file_contents}");
+            println!("{file_contents}");
             fs.file_write(
                 &fs.base().join("git-next-server.toml"),
                 file_contents.as_str(),
@@ -569,8 +552,7 @@ token = "{forge_token}"
     }
 }
 mod registered_webhook {
-
+    use super::*;
-    use crate::{tests::given, RegisteredWebhook, WebhookAuth};
 
     #[test]
     fn should_return_id() {
@@ -590,11 +572,11 @@ mod registered_webhook {
     }
 }
 mod webhook {
+    use super::*;
     mod message {
+        use super::*;
         use std::collections::HashMap;
 
-        use crate::{tests::given, WebhookMessage};
-
         #[test]
         fn should_return_forge_alias() {
             let forge_alias = given::a_forge_alias();
@@ -645,7 +627,8 @@ mod webhook {
     }
 }
 mod push {
-    use crate::{tests::given, webhook::push::Branch, BranchName};
+
+    use super::*;
 
     #[test]
     fn should_return_main_branch() {
@@ -717,18 +700,14 @@ mod push {
     }
 }
 mod given {
+
+    use super::*;
+    use rand::Rng as _;
     use std::{
         collections::{BTreeMap, HashMap},
         path::{Path, PathBuf},
     };
 
-    use rand::Rng as _;
-
-    use crate::{
-        server::{Http, ServerConfig, ServerStorage, Webhook},
-        ForgeAlias, ForgeConfig, ForgeType, RepoAlias, RepoBranches, ServerRepoConfig, WebhookId,
-    };
-
     pub fn a_name() -> String {
         use rand::Rng;
         use std::iter;

crates/config/src/webhook/auth.rs

@@ -1,7 +1,7 @@
-#[derive(Clone, Debug, PartialEq, Eq, derive_more::Deref, derive_more::Display)]
+//
-pub struct WebhookAuth(ulid::Ulid);
+crate::newtype!(WebhookAuth is a ulid::Ulid, derive_more::Display);
 impl WebhookAuth {
-    pub fn new(authorisation: &str) -> Result<Self, ulid::DecodeError> {
+    pub fn try_new(authorisation: &str) -> Result<Self, ulid::DecodeError> {
         use std::str::FromStr as _;
         let id = ulid::Ulid::from_str(authorisation)?;
         tracing::info!("Parse auth token: {}", id);

crates/config/src/webhook/id.rs

@@ -1,4 +1,2 @@
-use derive_more::{Constructor, Deref, Display};
+//
-
+crate::newtype!(WebhookId is a String, derive_more::Display);
-#[derive(Clone, Debug, PartialEq, Eq, Constructor, Deref, Display)]
-pub struct WebhookId(String);

crates/config/src/webhook/tests.rs

@@ -5,7 +5,7 @@ mod auth {
     fn bytes() -> Result<(), Box<dyn std::error::Error>> {
         let ulid = ulid::Ulid::new();
 
-        let wa = WebhookAuth::new(ulid.to_string().as_str())?;
+        let wa = WebhookAuth::try_new(ulid.to_string().as_str())?;
 
         assert_eq!(ulid.to_bytes(), wa.to_bytes());
 
@@ -16,7 +16,7 @@ mod auth {
     fn string() -> Result<(), Box<dyn std::error::Error>> {
         let ulid = ulid::Ulid::new();
 
-        let wa = WebhookAuth::new(ulid.to_string().as_str())?;
+        let wa = WebhookAuth::try_new(ulid.to_string().as_str())?;
 
         assert_eq!(ulid.to_string(), wa.to_string());