refactor: pull request number is now a newtype PrNumber(NonZeroU32)

Author: nik-rev

src/cli.rs

@@ -9,7 +9,7 @@ use clap::{
 
 use crate::{
     commands,
-    config::{BranchName, Commit, Remote},
+    config::{BranchName, Commit, PrNumber, Remote},
 };
 
 /// A tool which makes it easy to declaratively manage personal forks by automatically merging pull requests
@@ -45,7 +45,7 @@ pub enum Command {
     /// Fetch pull request for a GitHub repository as a local branch
     PrFetch {
         /// Fetch PR of this number
-        pr: u32,
+        pr: PrNumber,
         /// The remote branch in the format `repo-owner/repo/branch`
         ///
         /// The final part (`/branch`) is optional and defaults to `main`

src/commands/pr_fetch.rs

@@ -3,14 +3,14 @@
 use anyhow::{Context as _, anyhow};
 use colored::Colorize as _;
 
-use crate::config::{BranchName, Commit, Remote};
+use crate::config::{BranchName, Commit, PrNumber, Remote};
 use crate::git::{fetch_pull_request, git};
 
 /// Fetch the given `pr` of `remote` at `commit` and store it in local `branch`
 ///
 /// If `checkout`, `--checkout` the `branch`
 pub async fn pr_fetch(
-    pr: u32,
+    pr: PrNumber,
     remote: Option<Remote>,
     branch: Option<BranchName>,
     commit: Option<Commit>,

src/config.rs

@@ -3,7 +3,7 @@
 use anyhow::{anyhow, bail};
 use itertools::Itertools;
 use nutype::nutype;
-use std::{convert::Infallible, str::FromStr};
+use std::{convert::Infallible, num::NonZeroU32, str::FromStr};
 use tap::Pipe as _;
 
 use indexmap::IndexSet;
@@ -99,7 +99,7 @@ impl FromStr for Remote {
 #[derive(Debug, Eq, PartialEq)]
 pub struct PullRequest {
     /// Number of the pull request
-    pub number: u32,
+    pub number: PrNumber,
     /// Commit to checkout of the pull request. If none, uses the latest commit
     pub commit: Option<Commit>,
 }
@@ -113,16 +113,13 @@ impl FromStr for PullRequest {
             commit,
         }) = s.parse::<Ref>();
 
-        let pr_number = pr_number
+        let number = pr_number
             .strip_prefix('#')
             .unwrap_or(&pr_number)
-            .parse::<u32>()
+            .parse()
             .map_err(|err| anyhow!("invalid PR number: {pr_number}: {err}"))?;
 
-        Ok(Self {
-            number: pr_number,
-            commit,
-        })
+        Ok(Self { number, commit })
     }
 }
 
@@ -187,6 +184,10 @@ impl FromStr for Ref {
     }
 }
 
+/// Number of a pull request
+#[nutype(const_fn, derive(Eq, PartialEq, Display, Debug, FromStr, Copy, Clone))]
+pub struct PrNumber(NonZeroU32);
+
 /// Name of a branch in git
 #[nutype(
     validate(not_empty),
@@ -327,26 +328,32 @@ patches = ['remove-tab']"#;
 
         let conf = toml::from_str::<Config>(config).unwrap();
 
+        macro_rules! pr_number {
+            ($num:literal) => {
+                PrNumber::new(const { ::std::num::NonZeroU32::new($num).expect("nonzero") })
+            };
+        }
+
         pretty_assertions::assert_eq!(
             conf,
             Config {
                 local_branch: BranchName::try_new("patchy".to_string()).unwrap(),
                 patches: indexset!["remove-tab".to_string()],
                 pull_requests: vec![
                     PullRequest {
-                        number: 10000,
+                        number: pr_number!(10000),
                         commit: None
                     },
                     PullRequest {
-                        number: 10000,
+                        number: pr_number!(10000),
                         commit: None
                     },
                     PullRequest {
-                        number: 454,
+                        number: pr_number!(454),
                         commit: Some(Commit::try_new("a1b2c3").unwrap())
                     },
                     PullRequest {
-                        number: 1,
+                        number: pr_number!(1),
                         commit: Some(Commit::try_new("a1b2c3").unwrap())
                     },
                 ],

src/git.rs

@@ -4,7 +4,7 @@
 //! - Extract into a separate module, put it behind some more nice API
 //! - Use `gix`? Or anyways, we could go without spawning an entire process each
 //!   time we want to interact with Git
-use crate::config::{BranchName, Commit};
+use crate::config::{BranchName, Commit, PrNumber};
 use std::path::{Path, PathBuf};
 use std::process::{self, Output};
 use std::sync::LazyLock;
@@ -190,7 +190,7 @@ pub fn merge_into_main(
 /// Merge the `pull_request` into patchy's branch
 pub fn merge_pull_request(
     info: &RemoteBranch,
-    pull_request: u32,
+    pull_request: PrNumber,
     pr_title: &str,
     pr_url: &str,
 ) -> Result<()> {
@@ -345,7 +345,7 @@ pub async fn fetch_branch(remote: &crate::config::Remote) -> Result<(Repo, Remot
 /// the branch name is generated if not supplied
 pub async fn fetch_pull_request(
     repo: &str,
-    pull_request: u32,
+    pull_request: PrNumber,
     custom_branch_name: Option<BranchName>,
     commit_hash: Option<&Commit>,
 ) -> Result<(GitHubResponse, RemoteBranch)> {