From 32dd349c70edf02de62f7b52ad8b13a092497bc9 Mon Sep 17 00:00:00 2001
From: Nathan Fisher <jeang3nie@hitchhiker-linux.org>
Date: Wed, 10 Jan 2024 17:33:05 -0500
Subject: [PATCH] Add helper methods to `PreRelease`

---
 src/prerelease.rs | 73 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 73 insertions(+)

diff --git a/src/prerelease.rs b/src/prerelease.rs
index 164beb2..6f45ff8 100644
--- a/src/prerelease.rs
+++ b/src/prerelease.rs
@@ -4,14 +4,87 @@ use {
     std::{cmp, fmt, num::NonZeroU16, str},
 };
 
+static MAX_U10: u16 = 1024;
+
 #[derive(Clone, Copy, Debug, Deserialize, Serialize)]
+/// A specification for non-production releases
 pub enum PreRelease {
     Alpha(Option<NonZeroU16>),
     Beta(Option<NonZeroU16>),
     RC(Option<NonZeroU16>),
+    /// `PreRelease::None` is equivalent to a normal release
     None,
 }
 
+impl PreRelease {
+    pub fn is_prerelease(&self) -> bool {
+        match self {
+            Self::None => false,
+            _ => true,
+        }
+    }
+
+    pub fn is_alpha(&self) -> bool {
+        match self {
+            Self::Alpha(_) => true,
+            _ => false,
+        }
+    }
+
+    pub fn is_beta(&self) -> bool {
+        match self {
+            Self::Beta(_) => true,
+            _ => false,
+        }
+    }
+
+    pub fn is_rc(&self) -> bool {
+        match self {
+            Self::RC(_) => true,
+            _ => false,
+        }
+    }
+
+    pub fn number(&self) -> Option<u16> {
+        match self {
+            Self::Alpha(n) | Self::Beta(n) | Self::RC(n) => n.map(|x| x.into()),
+            _ => None,
+        }
+    }
+
+    /// Increments the numerical portion of the prerelease spec
+    /// # Errors
+    /// Returns `Error::Range` if the operation would overflow
+    pub fn increment(&mut self) -> Result<(), Error> {
+        match self {
+            Self::Alpha(n) | Self::Beta(n) | Self::RC(n) => match n {
+                Some(num) => {
+                    if u16::from(*num) >= MAX_U10 {
+                        return Err(Error::Range);
+                    } else {
+                        *num = num.saturating_add(1);
+                    }
+                }
+                None => *n = Some(NonZeroU16::new(2).unwrap()),
+            },
+            _ => {}
+        }
+        Ok(())
+    }
+
+    /// Promotes the prerelease spec to a higher type eg. alpha->beta or beta->rc
+    /// If the spec is already Self::RC(_) then it becomes a regular release ie.
+    /// `PreRelease::None`
+    pub fn promote(&mut self) {
+        match self {
+            Self::Alpha(_) => *self = Self::Beta(None),
+            Self::Beta(_) => *self = Self::RC(None),
+            Self::RC(_) => *self = Self::None,
+            _ => {}
+        }
+    }
+}
+
 impl fmt::Display for PreRelease {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
         match self {