Replace typed_builder with bon (#9)

jssblck · web-flow · commit adb3137fa7aa · 2024-10-10T15:20:49.000-07:00
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "locator"
-version = "2.1.0"
+version = "2.2.0"
 edition = "2021"
 
 [dependencies]
@@ -12,11 +12,12 @@ regex = "1.6.0"
 serde = { version = "1.0.140", features = ["derive"] }
 strum = { version = "0.24.1", features = ["derive"] }
 thiserror = "1.0.31"
-typed-builder = "0.10.0"
 utoipa = "4.2.3"
 serde_json = "1.0.95"
 documented = "0.4.1"
 semver = "1.0.23"
+bon = "2.3.0"
+duplicate = "2.0.0"
 
 [dev-dependencies]
 assert_matches = "1.5.0"
diff --git a/src/lib.rs b/src/lib.rs
@@ -5,6 +5,7 @@
 
 use std::{borrow::Cow, str::FromStr};
 
+use duplicate::duplicate;
 use lazy_static::lazy_static;
 use regex::Regex;
 use serde::{Deserialize, Serialize};
@@ -178,27 +179,40 @@ pub enum Fetcher {
 #[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
 pub struct OrgId(usize);
 
-impl From<OrgId> for u64 {
-    fn from(value: OrgId) -> Self {
-        value.0 as u64
-    }
-}
-
 impl From<OrgId> for usize {
     fn from(value: OrgId) -> Self {
         value.0
     }
 }
 
-impl From<OrgId> for i64 {
-    fn from(value: OrgId) -> Self {
-        value.0 as i64
+impl From<usize> for OrgId {
+    fn from(value: usize) -> Self {
+        Self(value)
     }
 }
 
-impl From<OrgId> for isize {
-    fn from(value: OrgId) -> Self {
-        value.0 as isize
+duplicate! {
+    [
+        number;
+        [ u64 ];
+        [ u32 ];
+        [ u16 ];
+        [ u8 ];
+        [ i64 ];
+        [ i32 ];
+        [ i16 ];
+        [ i8 ];
+        [ isize ];
+    ]
+    impl From<OrgId> for number {
+        fn from(value: OrgId) -> Self {
+            value.0 as number
+        }
+    }
+    impl From<number> for OrgId {
+        fn from(value: number) -> Self {
+            Self(value as usize)
+        }
     }
 }
 
@@ -245,6 +259,12 @@ impl From<&str> for Package {
     }
 }
 
+impl From<&Package> for Package {
+    fn from(value: &Package) -> Self {
+        value.clone()
+    }
+}
+
 impl std::fmt::Display for Package {
     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
         write!(f, "{}", self.0)
@@ -304,6 +324,12 @@ impl From<&str> for Revision {
     }
 }
 
+impl From<&Revision> for Revision {
+    fn from(value: &Revision) -> Self {
+        value.clone()
+    }
+}
+
 impl std::fmt::Display for Revision {
     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
         match self {
diff --git a/src/locator.rs b/src/locator.rs
@@ -1,12 +1,12 @@
 use std::{fmt::Display, str::FromStr};
 
+use bon::Builder;
 use documented::Documented;
 use getset::{CopyGetters, Getters};
 use lazy_static::lazy_static;
 use regex::Regex;
 use serde::{Deserialize, Serialize};
 use serde_json::json;
-use typed_builder::TypedBuilder;
 use utoipa::{
     openapi::{ObjectBuilder, SchemaType},
     ToSchema,
@@ -115,17 +115,7 @@ macro_rules! locator {
 ///
 /// This parse function is based on the function used in FOSSA Core for maximal compatibility.
 #[derive(
-    Clone,
-    Eq,
-    PartialEq,
-    Ord,
-    PartialOrd,
-    Hash,
-    Debug,
-    TypedBuilder,
-    Getters,
-    CopyGetters,
-    Documented,
+    Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Builder, Getters, CopyGetters, Documented,
 )]
 pub struct Locator {
     /// Determines which fetcher is used to download this package.
@@ -150,15 +140,15 @@ pub struct Locator {
     /// - A private Maven package that is hosted on a private host is namespaced.
     /// - A public NPM package that is hosted on NPM is not namespaced.
     /// - A private NPM package that is hosted on NPM but requires credentials is namespaced.
-    #[builder(default, setter(transform = |id: usize| Some(OrgId(id))))]
+    #[builder(into)]
     #[getset(get_copy = "pub")]
     org_id: Option<OrgId>,
 
     /// Specifies the unique identifier for the package by fetcher.
     ///
     /// For example, the `git` fetcher fetching a github package
     /// uses a value in the form of `{user_name}/{package_name}`.
-    #[builder(setter(transform = |package: impl ToString| Package(package.to_string())))]
+    #[builder(into)]
     #[getset(get = "pub")]
     package: Package,
 
@@ -167,7 +157,7 @@ pub struct Locator {
     /// For example, the `git` fetcher fetching a github package
     /// uses a value in the form of `{git_sha}` or `{git_tag}`,
     /// and the fetcher disambiguates.
-    #[builder(default, setter(transform = |revision: impl ToString| Some(Revision::from(revision.to_string()))))]
+    #[builder(into)]
     #[getset(get = "pub")]
     revision: Option<Revision>,
 }
@@ -419,6 +409,47 @@ mod tests {
 
     use super::*;
 
+    #[test]
+    fn from_existing() {
+        let first = locator!(Git, "github.com/foo/bar");
+        let second = Locator::builder()
+            .fetcher(first.fetcher())
+            .maybe_org_id(first.org_id())
+            .package(first.package())
+            .maybe_revision(first.revision().as_ref())
+            .build();
+        assert_eq!(first, second);
+    }
+
+    #[test]
+    fn optional_fields() {
+        let with_options = Locator::builder()
+            .fetcher(Fetcher::Git)
+            .package("github.com/foo/bar")
+            .maybe_org_id(Some(1234))
+            .maybe_revision(Some("abcd"))
+            .build();
+        let expected = Locator::builder()
+            .fetcher(Fetcher::Git)
+            .package("github.com/foo/bar")
+            .org_id(1234)
+            .revision("abcd")
+            .build();
+        assert_eq!(expected, with_options);
+
+        let without_options = Locator::builder()
+            .fetcher(Fetcher::Git)
+            .package("github.com/foo/bar")
+            .maybe_org_id(None::<usize>)
+            .maybe_revision(None::<&str>)
+            .build();
+        let expected = Locator::builder()
+            .fetcher(Fetcher::Git)
+            .package("github.com/foo/bar")
+            .build();
+        assert_eq!(expected, without_options);
+    }
+
     #[test]
     fn trait_impls() {
         const_assert!(impls!(Locator: AsRef<Locator>));
diff --git a/src/locator_package.rs b/src/locator_package.rs
@@ -1,10 +1,10 @@
 use std::{fmt::Display, str::FromStr};
 
+use bon::Builder;
 use documented::Documented;
 use getset::{CopyGetters, Getters};
 use serde::{Deserialize, Serialize};
 use serde_json::json;
-use typed_builder::TypedBuilder;
 use utoipa::{
     openapi::{ObjectBuilder, SchemaType},
     ToSchema,
@@ -72,17 +72,7 @@ macro_rules! package {
 ///
 /// This implementation ignores the `revision` segment if it exists. If this is not preferred, use [`Locator`] instead.
 #[derive(
-    Clone,
-    Eq,
-    PartialEq,
-    Ord,
-    PartialOrd,
-    Hash,
-    Debug,
-    TypedBuilder,
-    Getters,
-    CopyGetters,
-    Documented,
+    Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Builder, Getters, CopyGetters, Documented,
 )]
 pub struct PackageLocator {
     /// Determines which fetcher is used to download this package.
@@ -107,15 +97,15 @@ pub struct PackageLocator {
     /// - A private Maven package that is hosted on a private host is namespaced.
     /// - A public NPM package that is hosted on NPM is not namespaced.
     /// - A private NPM package that is hosted on NPM but requires credentials is namespaced.
-    #[builder(default, setter(transform = |id: usize| Some(OrgId(id))))]
+    #[builder(into)]
     #[getset(get_copy = "pub")]
     org_id: Option<OrgId>,
 
     /// Specifies the unique identifier for the package by fetcher.
     ///
     /// For example, the `git` fetcher fetching a github package
     /// uses a value in the form of `{user_name}/{package_name}`.
-    #[builder(setter(transform = |package: impl ToString| Package(package.to_string())))]
+    #[builder(into)]
     #[getset(get = "pub")]
     package: Package,
 }
@@ -147,7 +137,7 @@ impl PackageLocator {
         let locator = StrictLocator::builder()
             .fetcher(self.fetcher)
             .package(self.package)
-            .revision(revision);
+            .revision(revision.to_string());
 
         match self.org_id {
             None => locator.build(),
@@ -276,6 +266,43 @@ mod tests {
 
     use super::*;
 
+    #[test]
+    fn from_existing() {
+        let first = package!(Git, "github.com/foo/bar");
+        let second = PackageLocator::builder()
+            .fetcher(first.fetcher())
+            .maybe_org_id(first.org_id())
+            .package(first.package())
+            .build();
+        assert_eq!(first, second);
+    }
+
+    #[test]
+    fn optional_fields() {
+        let with_options = PackageLocator::builder()
+            .fetcher(Fetcher::Git)
+            .package("github.com/foo/bar")
+            .maybe_org_id(Some(1234))
+            .build();
+        let expected = PackageLocator::builder()
+            .fetcher(Fetcher::Git)
+            .package("github.com/foo/bar")
+            .org_id(1234)
+            .build();
+        assert_eq!(expected, with_options);
+
+        let without_options = PackageLocator::builder()
+            .fetcher(Fetcher::Git)
+            .package("github.com/foo/bar")
+            .maybe_org_id(None::<usize>)
+            .build();
+        let expected = PackageLocator::builder()
+            .fetcher(Fetcher::Git)
+            .package("github.com/foo/bar")
+            .build();
+        assert_eq!(expected, without_options);
+    }
+
     #[test]
     fn trait_impls() {
         const_assert!(impls!(PackageLocator: AsRef<PackageLocator>));
diff --git a/src/locator_strict.rs b/src/locator_strict.rs
