refactor(config): replace boilerplate with derive_more
All checks were successful
ci/woodpecker/tag/cron-docker-builder Pipeline was successful
ci/woodpecker/tag/push-next Pipeline was successful
ci/woodpecker/tag/tag-created Pipeline was successful
ci/woodpecker/push/cron-docker-builder Pipeline was successful
ci/woodpecker/push/push-next Pipeline was successful
ci/woodpecker/push/tag-created Pipeline was successful

This commit is contained in:
Paul Campbell 2024-05-12 22:27:20 +01:00
parent c7c95a5750
commit a4694d48f6
20 changed files with 48 additions and 134 deletions

View file

@ -45,7 +45,7 @@ secrecy = { workspace = true }
# warp = { workspace = true } # warp = { workspace = true }
# #
# # error handling # # error handling
# derive_more = { workspace = true } derive_more = { workspace = true }
# terrors = { workspace = true } # terrors = { workspace = true }
# #
# # file watcher # # file watcher

View file

@ -1,17 +1,8 @@
use std::fmt::Formatter;
/// The name of a Branch /// The name of a Branch
#[derive(Clone, Debug, Hash, PartialEq, Eq)] #[derive(Clone, Debug, Hash, PartialEq, Eq, derive_more::Display)]
pub struct BranchName(pub String); pub struct BranchName(String);
impl std::fmt::Display for BranchName { impl BranchName {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { pub fn new(str: impl Into<String>) -> Self {
write!(f, "{}", self.0) Self(str.into())
}
}
impl std::ops::Deref for BranchName {
type Target = String;
fn deref(&self) -> &Self::Target {
&self.0
} }
} }

View file

@ -1,12 +1,11 @@
use std::collections::HashMap; use std::collections::HashMap;
use serde::Deserialize;
use crate::{ApiToken, ForgeType, Hostname, RepoAlias, ServerRepoConfig, User}; use crate::{ApiToken, ForgeType, Hostname, RepoAlias, ServerRepoConfig, User};
/// Defines a Forge to connect to /// Defines a Forge to connect to
/// Maps from `git-next-server.toml` at `forge.{forge}` /// Maps from `git-next-server.toml` at `forge.{forge}`
#[derive(Clone, Debug, PartialEq, Eq, Deserialize)] #[derive(Clone, Debug, PartialEq, Eq, serde::Deserialize, derive_more::Display)]
#[display("{}:{}@{}", forge_type.to_string().to_lowercase(), user, hostname)]
pub struct ForgeConfig { pub struct ForgeConfig {
pub forge_type: ForgeType, pub forge_type: ForgeType,
pub hostname: String, pub hostname: String,
@ -15,9 +14,8 @@ pub struct ForgeConfig {
pub repos: HashMap<String, ServerRepoConfig>, pub repos: HashMap<String, ServerRepoConfig>,
} }
impl ForgeConfig { impl ForgeConfig {
#[allow(dead_code)] pub const fn forge_type(&self) -> ForgeType {
pub const fn forge_type(&self) -> &ForgeType { self.forge_type
&self.forge_type
} }
pub fn hostname(&self) -> Hostname { pub fn hostname(&self) -> Hostname {
@ -38,14 +36,3 @@ impl ForgeConfig {
.map(|(name, repo)| (RepoAlias(name.clone()), repo)) .map(|(name, repo)| (RepoAlias(name.clone()), repo))
} }
} }
impl std::fmt::Display for ForgeConfig {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(
f,
"{}:{}@{}",
self.forge_type.to_string().to_lowercase(),
self.user,
self.hostname
)
}
}

View file

@ -15,7 +15,7 @@ impl From<(&ForgeName, &ForgeConfig)> for ForgeDetails {
fn from(forge: (&ForgeName, &ForgeConfig)) -> Self { fn from(forge: (&ForgeName, &ForgeConfig)) -> Self {
Self { Self {
forge_name: forge.0.clone(), forge_name: forge.0.clone(),
forge_type: forge.1.forge_type.clone(), forge_type: forge.1.forge_type(),
hostname: forge.1.hostname(), hostname: forge.1.hostname(),
user: forge.1.user(), user: forge.1.user(),
token: forge.1.token(), token: forge.1.token(),

View file

@ -1,13 +1,8 @@
use std::path::PathBuf; use std::path::PathBuf;
/// The name of a Forge to connect to /// The name of a Forge to connect to
#[derive(Clone, Debug, PartialEq, Eq)] #[derive(Clone, Debug, PartialEq, Eq, derive_more::Display)]
pub struct ForgeName(pub String); pub struct ForgeName(pub String);
impl std::fmt::Display for ForgeName {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "{}", self.0)
}
}
impl From<&ForgeName> for PathBuf { impl From<&ForgeName> for PathBuf {
fn from(value: &ForgeName) -> Self { fn from(value: &ForgeName) -> Self {
Self::from(&value.0) Self::from(&value.0)

View file

@ -1,5 +1,5 @@
/// Identifier for the type of Forge /// Identifier for the type of Forge
#[derive(Clone, Debug, PartialEq, Eq, serde::Deserialize)] #[derive(Clone, Copy, Debug, PartialEq, Eq, serde::Deserialize)]
pub enum ForgeType { pub enum ForgeType {
#[cfg(feature = "forgejo")] #[cfg(feature = "forgejo")]
ForgeJo, ForgeJo,

View file

@ -1,6 +1,6 @@
use std::{ops::Deref, path::PathBuf}; use std::{ops::Deref, path::PathBuf};
#[derive(Debug, Clone, PartialEq, Eq, serde::Deserialize)] #[derive(Debug, Clone, PartialEq, Eq, serde::Deserialize, derive_more::From)]
pub struct GitDir(PathBuf); pub struct GitDir(PathBuf);
impl GitDir { impl GitDir {
pub fn new(pathbuf: &std::path::Path) -> Self { pub fn new(pathbuf: &std::path::Path) -> Self {
@ -33,11 +33,6 @@ impl From<&GitDir> for PathBuf {
value.to_path_buf() value.to_path_buf()
} }
} }
impl From<PathBuf> for GitDir {
fn from(value: PathBuf) -> Self {
Self(value)
}
}
impl From<GitDir> for PathBuf { impl From<GitDir> for PathBuf {
fn from(value: GitDir) -> Self { fn from(value: GitDir) -> Self {
value.0 value.0

View file

@ -1,10 +1,3 @@
use std::fmt::{Display, Formatter};
/// The hostname of a forge /// The hostname of a forge
#[derive(Clone, Debug, PartialEq, Eq)] #[derive(Clone, Debug, PartialEq, Eq, derive_more::Display)]
pub struct Hostname(pub String); pub struct Hostname(pub String);
impl Display for Hostname {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
write!(f, "{}", self.0)
}
}

View file

@ -1,9 +1,4 @@
/// The alias of a repo /// The alias of a repo
/// This is the alias for the repo within `git-next-server.toml` /// This is the alias for the repo within `git-next-server.toml`
#[derive(Clone, Debug, PartialEq, Eq, Hash)] #[derive(Clone, Debug, PartialEq, Eq, Hash, derive_more::Display)]
pub struct RepoAlias(pub String); pub struct RepoAlias(pub String);
impl std::fmt::Display for RepoAlias {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "{}", self.0)
}
}

View file

@ -1,34 +1,23 @@
use crate::BranchName; use crate::BranchName;
/// Mapped from `.git-next.toml` file at `branches` /// Mapped from `.git-next.toml` file at `branches`
#[derive(Clone, Debug, PartialEq, Eq, serde::Deserialize)] #[derive(Clone, Debug, PartialEq, Eq, serde::Deserialize, derive_more::Display)]
#[display("{},{},{}", main, next, dev)]
pub struct RepoBranches { pub struct RepoBranches {
pub main: String, pub main: String,
pub next: String, pub next: String,
pub dev: String, pub dev: String,
} }
impl RepoBranches { impl RepoBranches {
pub fn new(main: impl Into<String>, next: impl Into<String>, dev: impl Into<String>) -> Self {
Self {
main: main.into(),
next: next.into(),
dev: dev.into(),
}
}
pub fn main(&self) -> BranchName { pub fn main(&self) -> BranchName {
BranchName(self.main.clone()) BranchName::new(&self.main)
} }
pub fn next(&self) -> BranchName { pub fn next(&self) -> BranchName {
BranchName(self.next.clone()) BranchName::new(&self.next)
} }
pub fn dev(&self) -> BranchName { pub fn dev(&self) -> BranchName {
BranchName(self.dev.clone()) BranchName::new(&self.dev)
}
}
impl std::fmt::Display for RepoBranches {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "{},{},{}", self.main, self.next, self.dev)
} }
} }

View file

@ -4,16 +4,13 @@ use crate::RepoConfigSource;
/// Mapped from `.git-next.toml` file in target repo /// Mapped from `.git-next.toml` file in target repo
/// Is also derived from the optional parameters in `git-next-server.toml` at /// Is also derived from the optional parameters in `git-next-server.toml` at
/// `forge.{forge}.repos.{repo}.(main|next|dev)` /// `forge.{forge}.repos.{repo}.(main|next|dev)`
#[derive(Clone, Debug, PartialEq, Eq, serde::Deserialize)] #[derive(Clone, Debug, PartialEq, Eq, serde::Deserialize, derive_more::Display)]
#[display("{}", branches)]
pub struct RepoConfig { pub struct RepoConfig {
pub branches: RepoBranches, pub branches: RepoBranches,
pub source: RepoConfigSource, pub source: RepoConfigSource,
} }
impl RepoConfig { impl RepoConfig {
pub const fn new(branches: RepoBranches, source: RepoConfigSource) -> Self {
Self { branches, source }
}
pub fn load(toml: &str) -> Result<Self, toml::de::Error> { pub fn load(toml: &str) -> Result<Self, toml::de::Error> {
toml::from_str(format!("source = \"Repo\"\n{}", toml).as_str()) toml::from_str(format!("source = \"Repo\"\n{}", toml).as_str())
} }
@ -26,8 +23,3 @@ impl RepoConfig {
self.source self.source
} }
} }
impl std::fmt::Display for RepoConfig {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "{}", self.branches)
}
}

View file

@ -1,12 +1,5 @@
use std::fmt::{Display, Formatter};
/// The path for the repo within the forge. /// The path for the repo within the forge.
/// Typically this is composed of the user or organisation and the name of the repo /// Typically this is composed of the user or organisation and the name of the repo
/// e.g. `{user}/{repo}` /// e.g. `{user}/{repo}`
#[derive(Clone, Debug, PartialEq, Eq)] #[derive(Clone, Debug, PartialEq, Eq, derive_more::Display)]
pub struct RepoPath(pub String); pub struct RepoPath(pub String);
impl Display for RepoPath {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
write!(f, "{}", self.0)
}
}

View file

@ -4,7 +4,8 @@ use crate::{BranchName, GitDir, RepoBranches, RepoConfig, RepoConfigSource, Repo
/// Defines a Repo within a ForgeConfig to be monitored by the server /// Defines a Repo within a ForgeConfig to be monitored by the server
/// Maps from `git-next-server.toml` at `forge.{forge}.repos.{name}` /// Maps from `git-next-server.toml` at `forge.{forge}.repos.{name}`
#[derive(Clone, Debug, PartialEq, Eq, serde::Deserialize)] #[derive(Clone, Debug, PartialEq, Eq, serde::Deserialize, derive_more::Display)]
#[display("{}@{}", repo, branch)]
pub struct ServerRepoConfig { pub struct ServerRepoConfig {
pub repo: String, pub repo: String,
pub branch: String, pub branch: String,
@ -18,9 +19,8 @@ impl ServerRepoConfig {
RepoPath(self.repo.clone()) RepoPath(self.repo.clone())
} }
#[allow(dead_code)]
pub fn branch(&self) -> BranchName { pub fn branch(&self) -> BranchName {
BranchName(self.branch.clone()) BranchName::new(&self.branch)
} }
pub fn gitdir(&self) -> Option<GitDir> { pub fn gitdir(&self) -> Option<GitDir> {
@ -42,14 +42,3 @@ impl ServerRepoConfig {
} }
} }
} }
#[cfg(test)]
impl AsRef<Self> for ServerRepoConfig {
fn as_ref(&self) -> &Self {
self
}
}
impl std::fmt::Display for ServerRepoConfig {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "{}@{}", self.repo, self.branch)
}
}

View file

@ -1,8 +1,3 @@
/// The user within the forge to connect as /// The user within the forge to connect as
#[derive(Clone, Debug, PartialEq, Eq)] #[derive(Clone, Debug, PartialEq, Eq, derive_more::Display)]
pub struct User(pub String); pub struct User(pub String);
impl std::fmt::Display for User {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "{}", self.0)
}
}

View file

@ -2,7 +2,7 @@ use git_next_config::BranchName;
use crate::Commit; use crate::Commit;
#[derive(Clone, Debug, Hash, PartialEq, Eq)] #[derive(Clone, Debug, Hash, PartialEq, Eq, derive_more::Display)]
pub struct GitRef(pub String); pub struct GitRef(pub String);
impl From<Commit> for GitRef { impl From<Commit> for GitRef {
fn from(value: Commit) -> Self { fn from(value: Commit) -> Self {
@ -11,11 +11,6 @@ impl From<Commit> for GitRef {
} }
impl From<BranchName> for GitRef { impl From<BranchName> for GitRef {
fn from(value: BranchName) -> Self { fn from(value: BranchName) -> Self {
Self(value.0) Self(value.to_string())
}
}
impl std::fmt::Display for GitRef {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "{}", self.0)
} }
} }

View file

@ -30,11 +30,11 @@ impl RepoDetails {
repo_alias: repo_alias.clone(), repo_alias: repo_alias.clone(),
repo_path: RepoPath(server_repo_config.repo.clone()), repo_path: RepoPath(server_repo_config.repo.clone()),
repo_config: server_repo_config.repo_config(), repo_config: server_repo_config.repo_config(),
branch: BranchName(server_repo_config.branch.clone()), branch: BranchName::new(&server_repo_config.branch),
gitdir, gitdir,
forge: ForgeDetails { forge: ForgeDetails {
forge_name: forge_name.clone(), forge_name: forge_name.clone(),
forge_type: forge_config.forge_type.clone(), forge_type: forge_config.forge_type(),
hostname: forge_config.hostname(), hostname: forge_config.hostname(),
user: forge_config.user(), user: forge_config.user(),
token: forge_config.token(), token: forge_config.token(),

View file

@ -1,5 +1,5 @@
use actix::prelude::*; use actix::prelude::*;
use git_next_config::RepoBranches; use git_next_config::{BranchName, RepoBranches};
use git_next_git::{self as git, RepoDetails}; use git_next_git::{self as git, RepoDetails};
use kxio::network::{self, json}; use kxio::network::{self, json};
use tracing::{debug, info, warn}; use tracing::{debug, info, warn};
@ -286,16 +286,17 @@ impl Push {
return None; return None;
} }
let (_, branch) = self.reference.split_at(11); let (_, branch) = self.reference.split_at(11);
if branch == *repo_branches.main() { let branch = BranchName::new(branch);
if branch == repo_branches.main() {
return Some(Branch::Main); return Some(Branch::Main);
} }
if branch == *repo_branches.next() { if branch == repo_branches.next() {
return Some(Branch::Next); return Some(Branch::Next);
} }
if branch == *repo_branches.dev() { if branch == repo_branches.dev() {
return Some(Branch::Dev); return Some(Branch::Dev);
} }
warn!(branch, "Unexpected branch"); warn!(%branch, "Unexpected branch");
None None
} }
pub fn commit(&self) -> git::Commit { pub fn commit(&self) -> git::Commit {

View file

@ -47,6 +47,6 @@ struct Branch {
} }
impl From<Branch> for BranchName { impl From<Branch> for BranchName {
fn from(value: Branch) -> Self { fn from(value: Branch) -> Self {
Self(value.name) Self::new(value.name)
} }
} }

View file

@ -49,7 +49,7 @@ pub fn repo_details(
} }
pub fn branch_name(n: u32) -> BranchName { pub fn branch_name(n: u32) -> BranchName {
BranchName(format!("branch-name-{}", n)) BranchName::new(format!("branch-name-{}", n))
} }
pub fn repo_path(n: u32) -> RepoPath { pub fn repo_path(n: u32) -> RepoPath {
@ -61,8 +61,12 @@ pub fn repo_alias(n: u32) -> RepoAlias {
} }
pub fn repo_config(n: u32, source: RepoConfigSource) -> RepoConfig { pub fn repo_config(n: u32, source: RepoConfigSource) -> RepoConfig {
RepoConfig::new( RepoConfig {
RepoBranches::new(format!("main-{n}"), format!("next-{n}"), format!("dev-{n}")), branches: RepoBranches {
main: format!("main-{n}"),
next: format!("next-{n}"),
dev: format!("dev-{n}"),
},
source, source,
) }
} }

View file

@ -55,5 +55,5 @@ async fn test_branches_get() {
let_assert!(Some(requests) = net.mocked_requests()); let_assert!(Some(requests) = net.mocked_requests());
assert_eq!(requests.len(), 1); assert_eq!(requests.len(), 1);
assert_eq!(branches, vec![BranchName("string".into())]); assert_eq!(branches, vec![BranchName::new("string")]);
} }