Added CamelBreed enum (#25)

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "livestock-rs"
-version = "0.6.1"
+version = "0.7.0"
 edition = "2021"
 authors = ["Jaken Herman <jaken@rowanranch.com>"]
 license = "MIT"

README.md

@@ -12,6 +12,7 @@ Features
  - 🐖 Includes common swine breeds like Duroc and Hampshire.
  - 🫏 Includes common donkey breeds like Miniature and Standard.
  - 🦌 Includes common reindeer breeds like Even and Nentsi.
+ - 🐪 Includes common camel breeds like Afar Dromedary and Somali Dromedary.
  - 🛠️ Utilities for converting between enum variants and human-readable strings.
  - 🔒 Serde support for serialization and deserialization.
 
@@ -20,7 +21,7 @@ Add the crate to your `Cargo.toml`:
 
 ```
 [dependencies]
-livestock_rs = "0.6.1"
+livestock_rs = "0.7.0"
 ```
 
 or 
@@ -59,8 +60,12 @@ println!("{:?}", breed); // prints "Canindé"
 ## Reindeer Breeds
  - Features common reindeer breeds including Chukotka, Even, Evenk, and Nentsi.
 
+## Camel Breeds
+- Features common varieties of camel breeds like Afar Dromedary and Somali Dromedary.
+- Regional specialties, including Kalmyk Bactrian and more.
+
 ## Roadmap
- - 🗂️ Expand support for other livestock species (e.g., chickens, ducks, pigs).
+ - 🗂️ Expand support for other livestock species (e.g., chickens, ducks, geese).
  - 🌍 Localization support for breed names in multiple languages.
  - 📊 Add more utilities for livestock data management.
 

src/camel.rs

@@ -0,0 +1,103 @@
+use serde::{Deserialize, Serialize};
+use std::str::FromStr;
+
+/// An enum representing the different breeds of camel.
+///
+/// Initial data from: <https://breeds.okstate.edu/other-breeds-of-livestock/camels/>
+///
+/// # Examples
+/// ``` rust
+/// use livestock_rs::camel::CamelBreed;
+///
+/// let breed = CamelBreed::AfarDromedary;
+/// println!("{:?}", breed);
+/// ```
+#[derive(Debug, Deserialize, Eq, PartialEq, Serialize)]
+pub enum CamelBreed {
+    AfarDromedary,
+    AlxaBactrian,
+    ArvanaDromedary,
+    KalmykBactrian,
+    SomaliDromedary
+}
+
+impl ToString for CamelBreed {
+    /// Converts the CamelBreed enum to a human readable string.
+    ///
+    /// # Examples
+    /// ``` rust
+    /// use livestock_rs::camel::CamelBreed;
+    ///
+    /// let alxa = CamelBreed::AlxaBactrian;
+    /// println!("{}", alxa.to_string());
+    /// ```
+    fn to_string(&self) -> String {
+        match self {
+            CamelBreed::AfarDromedary => "Afar Dromedary".to_string(),
+            CamelBreed::AlxaBactrian => "Alxa Bactrian".to_string(),
+            CamelBreed::ArvanaDromedary => "Arvana Dromedary".to_string(),
+            CamelBreed::KalmykBactrian => "Kalmyk Bactrian".to_string(),
+            CamelBreed::SomaliDromedary => "Somali Dromedary".to_string(),
+        }
+    }
+}
+
+/// Converts a string to a CamelBreed enum.
+///
+/// # Examples
+/// ``` rust
+/// use livestock_rs::camel::CamelBreed;
+/// use std::str::FromStr;
+///
+/// let breed = CamelBreed::from_str("Somali Dromedary").unwrap();
+/// println!("{:?}", breed);
+/// ```
+
+impl FromStr for CamelBreed {
+    type Err = std::io::Error;
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
+        match s.to_lowercase().as_str() {
+            "afar dromedary" | "afar" => Ok(CamelBreed::AfarDromedary),
+            "alxa bactrian" | "alxa" => Ok(CamelBreed::AlxaBactrian),
+            "arvana dromedary" | "arvana" => Ok(CamelBreed::ArvanaDromedary),
+            "kalmyk bactrian" | "kalmyk" => Ok(CamelBreed::KalmykBactrian),
+            "somali dromedary" | "somali" => Ok(CamelBreed::SomaliDromedary),
+            _ => Err(std::io::Error::new(std::io::ErrorKind::InvalidInput, "Invalid camel breed")),
+        }
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn test_to_string() {
+        let breeds = [
+            (CamelBreed::AfarDromedary, "Afar Dromedary"),
+            (CamelBreed::AlxaBactrian, "Alxa Bactrian"),
+            (CamelBreed::ArvanaDromedary, "Arvana Dromedary"),
+            (CamelBreed::KalmykBactrian, "Kalmyk Bactrian"),
+            (CamelBreed::SomaliDromedary, "Somali Dromedary"),
+        ];
+
+        for (breed, expected) in breeds.iter() {
+            assert_eq!(breed.to_string(), *expected);
+        }
+    }
+
+    #[test]
+    fn test_from_str() {
+        let breeds = [
+            ("afar dromedary", CamelBreed::AfarDromedary),
+            ("alxa bactrian", CamelBreed::AlxaBactrian),
+            ("arvana dromedary", CamelBreed::ArvanaDromedary),
+            ("kalmyk bactrian", CamelBreed::KalmykBactrian),
+            ("somali dromedary", CamelBreed::SomaliDromedary),
+        ];
+
+        for (breed, expected) in breeds.iter() {
+            assert_eq!(CamelBreed::from_str(*breed).unwrap(), *expected);
+        }
+    }
+}

src/lib.rs

@@ -1,3 +1,4 @@
+pub mod camel;
 pub mod cattle;
 pub mod donkey;
 pub mod goat;