Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(ext): add parse method and FromStr implementation for Black and Blue enums #54

Merged
merged 3 commits into from
Sep 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- add parsing functionality for Basic colours(pr [#51])
- support parsing color codes without hash prefix in Basic module(pr [#52])
- add parsing for black shades and implement FromStr trait(pr [#53])
- add parse method and FromStr implementation for Black and Blue enums(pr [#54])

### Changed

Expand Down Expand Up @@ -133,6 +134,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
[#51]: https://github.com/jerus-org/named-colour/pull/51
[#52]: https://github.com/jerus-org/named-colour/pull/52
[#53]: https://github.com/jerus-org/named-colour/pull/53
[#54]: https://github.com/jerus-org/named-colour/pull/54
[Unreleased]: https://github.com/jerus-org/named-colour/compare/v0.2.0...HEAD
[0.2.0]: https://github.com/jerus-org/named-colour/compare/v0.1.6...v0.2.0
[0.1.6]: https://github.com/jerus-org/named-colour/compare/v0.1.5...v0.1.6
Expand Down
13 changes: 13 additions & 0 deletions src/ext/black.rs
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,19 @@ impl Black {
format!("{}{:02X}{:02X}{:02X}", prefix, rgb.r, rgb.g, rgb.b)
}

/// Parse a colour from string
///
/// ## Example
///
///```
/// # use named_colour::ext::Black;
/// # fn main() {
/// let colour = Black::parse("gainsboro");
///
/// assert_eq!(Some(Black::Gainsboro), colour);
/// # }
/// ```
///
pub fn parse(name: &str) -> Option<Black> {
match name.to_lowercase().as_str() {
"#708090" | "708090" | "slategray" => Some(Black::SlateGray),
Expand Down
102 changes: 100 additions & 2 deletions src/ext/blue.rs
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
//! Extended named colours providing shades collected in enums for the main colour
//!

use std::fmt;
use std::{fmt, str::FromStr};

use rgb::Rgb;

use crate::Prefix;

/// Shades of blue
#[derive(Debug)]
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[allow(missing_docs)]
pub enum Blue {
PowderBlue,
Expand Down Expand Up @@ -139,6 +139,50 @@ impl Blue {

format!("{}{:02X}{:02X}{:02X}", prefix, rgb.r, rgb.g, rgb.b)
}

/// Parse a colour from string
///
/// ## Example
///
///```
/// # use named_colour::ext::Blue;
/// # use named_colour::Prefix;
/// let colour = Blue::Azure;
///
/// assert_eq!(Blue::Azure, Blue::parse("#F0FFFF").unwrap());
///
///```
pub fn parse(name: &str) -> Option<Blue> {
match name.to_lowercase().as_str() {
"#b0e0e6" | "b0e0e6" | "powderblue" => Some(Blue::PowderBlue),
"#5f9ea0" | "5f9ea0" | "cadetblue" => Some(Blue::CadetBlue),
"#4682b4" | "4682b4" | "steelblue" => Some(Blue::SteelBlue),
"#6495ed" | "6495ed" | "cornflowerblue" => Some(Blue::CornFlowerBlue),
"#00bfff" | "00bfff" | "deepskyblue" => Some(Blue::DeepSkyBlue),
"#1e90ff" | "1e90ff" | "dodgerblue" => Some(Blue::DodgerBlue),
"#add8e6" | "add8e6" | "lightblue" => Some(Blue::LightBlue),
"#87ceeb" | "87ceeb" | "skyblue" => Some(Blue::SkyBlue),
"#87cefa" | "87cefa" | "lightskyblue" => Some(Blue::LightSkyBlue),
"#191970" | "191970" | "midnightblue" => Some(Blue::MidnightBlue),
"#000080" | "000080" | "navy" => Some(Blue::Navy),
"#00008b" | "00008b" | "darkblue" => Some(Blue::DarkBlue),
"#0000cd" | "0000cd" | "mediumblue" => Some(Blue::MediumBlue),
"#0000ff" | "0000ff" | "blue" => Some(Blue::Blue),
"#4169e1" | "4169e1" | "royalblue" => Some(Blue::RoyalBlue),
"#f0ffff" | "f0ffff" | "azure" => Some(Blue::Azure),
_ => None,
}
}
}

impl FromStr for Blue {
type Err = String;
fn from_str(s: &str) -> Result<Self, Self::Err> {
match Blue::parse(s) {
Some(colour) => Ok(colour),
None => Err(format!("Invalid Colour: {}", s)),
}
}
}

#[cfg(test)]
Expand Down Expand Up @@ -187,6 +231,7 @@ mod tests {
#[case(Blue::Blue, "0000FF")]
#[case(Blue::RoyalBlue, "4169E1")]
#[case(Blue::Azure, "F0FFFF")]

fn test_hex_triplet_string(
#[case] colour: Blue,
#[values(Prefix::None, Prefix::Hash)] prefix: Prefix,
Expand All @@ -203,4 +248,57 @@ mod tests {

assert_eq!(expected, hex_colour);
}

#[rstest]
#[case("#b0e0e6", Blue::PowderBlue)]
#[case("b0e0e6", Blue::PowderBlue)]
#[case("powderblue", Blue::PowderBlue)]
#[case("#5f9ea0", Blue::CadetBlue)]
#[case("5f9ea0", Blue::CadetBlue)]
#[case("cadetblue", Blue::CadetBlue)]
#[case("#4682b4", Blue::SteelBlue)]
#[case("4682b4", Blue::SteelBlue)]
#[case("steelblue", Blue::SteelBlue)]
#[case("#6495ed", Blue::CornFlowerBlue)]
#[case("6495ed", Blue::CornFlowerBlue)]
#[case("cornflowerblue", Blue::CornFlowerBlue)]
#[case("#00bfff", Blue::DeepSkyBlue)]
#[case("00bfff", Blue::DeepSkyBlue)]
#[case("deepskyblue", Blue::DeepSkyBlue)]
#[case("#1e90ff", Blue::DodgerBlue)]
#[case("1e90ff", Blue::DodgerBlue)]
#[case("dodgerblue", Blue::DodgerBlue)]
#[case("#add8e6", Blue::LightBlue)]
#[case("add8e6", Blue::LightBlue)]
#[case("lightblue", Blue::LightBlue)]
#[case("#87ceeb", Blue::SkyBlue)]
#[case("87ceeb", Blue::SkyBlue)]
#[case("skyblue", Blue::SkyBlue)]
#[case("#87cefa", Blue::LightSkyBlue)]
#[case("87cefa", Blue::LightSkyBlue)]
#[case("lightskyblue", Blue::LightSkyBlue)]
#[case("#191970", Blue::MidnightBlue)]
#[case("191970", Blue::MidnightBlue)]
#[case("midnightblue", Blue::MidnightBlue)]
#[case("#000080", Blue::Navy)]
#[case("000080", Blue::Navy)]
#[case("navy", Blue::Navy)]
#[case("#00008b", Blue::DarkBlue)]
#[case("00008b", Blue::DarkBlue)]
#[case("darkblue", Blue::DarkBlue)]
#[case("#0000cd", Blue::MediumBlue)]
#[case("0000cd", Blue::MediumBlue)]
#[case("mediumblue", Blue::MediumBlue)]
#[case("#0000ff", Blue::Blue)]
#[case("0000ff", Blue::Blue)]
#[case("blue", Blue::Blue)]
#[case("#4169e1", Blue::RoyalBlue)]
#[case("4169e1", Blue::RoyalBlue)]
#[case("royalblue", Blue::RoyalBlue)]
#[case("#f0ffff", Blue::Azure)]
#[case("f0ffff", Blue::Azure)]
#[case("azure", Blue::Azure)]
fn test_from_str(#[case] input: &str, #[case] expected: Blue) {
assert_eq!(expected, Blue::from_str(input).unwrap())
}
}