Skip to content

Commit

Permalink
refactor modules
Browse files Browse the repository at this point in the history
  • Loading branch information
@eth0net
eth0net committed May 1, 2024
1 parent d921e36 commit bbf4466
Show file tree
Hide file tree
Showing 16 changed files with 385 additions and 388 deletions.
2 changes: 1 addition & 1 deletion Cargo.lock
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "cyborg"
version = "0.11.0"
version = "0.12.0"
authors = ["eth0net <[email protected]>"]
edition = "2021"
description = "A simple comic book organisation tool"
Expand Down
305 changes: 2 additions & 303 deletions src/comic.rs
View file
Original file line number Diff line number Diff line change
@@ -1,308 +1,7 @@
use std::fmt::Display;
use std::str::FromStr;

mod error;
mod format;
mod meta;
mod parse;
mod regex;

pub use error::ComicError;
pub use format::{Format, FormatError};

#[derive(Debug, PartialEq, Eq)]
/// A comic.
pub struct Comic {
/// Name of the series.
///
/// This should always be present as all comics,
/// even one-shots and volumes are part of a series.
pub series: String,

/// Issue or volume number.
///
/// This should be present for regular issues and volumes,
/// but often not for one-shots or collected editions.
///
/// Optional since not all comics have a number.
pub number: Option<usize>,

/// Issue or volume suffix.
///
/// This is often not present for regular issues,
/// but is often used for annuals and special issues.
pub suffix: Option<String>,

/// Total number of issues in the series.
///
/// This is often not present for regular issues,
/// but is usually present for limited series.
pub of: Option<usize>,

/// Issue title.
///
/// This is often not present for regular issues,
/// but is often present for one-shots and collected editions.
pub title: Option<String>,

/// Year on the cover.
///
/// This is nearly always present, but is optional
/// since year may not be known for all comics.
pub year: Option<usize>,

/// Tags for the comic.
///
/// This may or may not be present for all comics,
/// but is optional since not all comics have tags.
pub tags: Vec<String>,

/// Format of the comic.
pub format: Format,
}

impl Display for Comic {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "{}", self.series)?;

if let Some(number) = self.number {
write!(f, " {:03}", number)?;
}

if let Some(suffix) = &self.suffix {
write!(f, "{}", suffix)?;
}

if let Some(of) = self.of {
write!(f, " of {}", of)?;
}

if let Some(title) = &self.title {
write!(f, " {}", title)?;
}

if let Some(year) = self.year {
write!(f, " ({})", year)?;
}

for tag in &self.tags {
write!(f, " ({})", tag)?;
}

write!(f, ".{}", self.format)
}
}

impl FromStr for Comic {
type Err = ComicError;

fn from_str(s: &str) -> Result<Self, Self::Err> {
let caps = regex::COMIC.captures(s).ok_or(ComicError::GetCaptures)?;

let series = parse::series(&caps)?;
let number = parse::number(&caps)?;
let suffix = parse::suffix(&caps);
let of = parse::of(&caps)?;
let title = parse::title(&caps);
let year = parse::year(&caps)?;
let tags = parse::tags(&caps);
let format = parse::format(&caps)?;

Ok(Self {
series,
number,
suffix,
of,
title,
year,
tags,
format,
})
}
}

#[cfg(test)]
pub(crate) mod tests {
use super::*;

#[test]
fn comic_from_string() -> Result<(), ComicError> {
let cases = [
(
"Simple 001.cbr",
Comic {
series: "Simple".into(),
number: Some(1),
suffix: None,
of: None,
title: None,
year: None,
tags: vec![],
format: Format::Cbr,
},
),
(
"Year 090 (2024).cbt",
Comic {
series: "Year".into(),
number: Some(90),
suffix: None,
of: None,
title: None,
year: Some(2024),
tags: vec![],
format: Format::Cbt,
},
),
(
"Dashed - Series-Name 10.cbz",
Comic {
series: "Dashed - Series-Name".into(),
number: Some(10),
suffix: None,
of: None,
title: None,
year: None,
tags: vec![],
format: Format::Cbz,
},
),
(
"Tagged (Simple) (Over-Complicated Tag).cbr",
Comic {
series: "Tagged".into(),
number: None,
suffix: None,
of: None,
title: None,
year: None,
tags: vec!["Simple".into(), "Over-Complicated Tag".into()],
format: Format::Cbr,
},
),
(
"Year Tagged (2024) (Simple) (Over-Complicated Tag).cbt",
Comic {
series: "Year Tagged".into(),
number: None,
suffix: None,
of: None,
title: None,
year: Some(2024),
tags: vec!["Simple".into(), "Over-Complicated Tag".into()],
format: Format::Cbt,
},
),
(
"Special-characters - + & (x) (10) (+) '99 020.cbz",
Comic {
series: "Special-characters - + & (x) (10) (+) '99".into(),
number: Some(20),
suffix: None,
of: None,
title: None,
year: None,
tags: vec![],
format: Format::Cbz,
},
),
(
"Limited #01 of #02 (2020) (Tag).cbr",
Comic {
series: "Limited".into(),
number: Some(1),
suffix: None,
of: Some(2),
title: None,
year: Some(2020),
tags: vec!["Tag".into()],
format: Format::Cbr,
},
),
(
"Limited #02 (OF #03).cbt",
Comic {
series: "Limited".into(),
number: Some(2),
suffix: None,
of: Some(3),
title: None,
year: None,
tags: vec![],
format: Format::Cbt,
},
),
(
"Limited 003 OF #4.cbz",
Comic {
series: "Limited".into(),
number: Some(3),
suffix: None,
of: Some(4),
title: None,
year: None,
tags: vec![],
format: Format::Cbz,
},
),
(
"Limited 004 (of 5).cbr",
Comic {
series: "Limited".into(),
number: Some(4),
suffix: None,
of: Some(5),
title: None,
year: None,
tags: vec![],
format: Format::Cbr,
},
),
(
"Series With 001 Issue Name (2023).cbt",
Comic {
series: "Series With".into(),
number: Some(1),
suffix: None,
of: None,
title: Some("Issue Name".into()),
year: Some(2023),
tags: vec![],
format: Format::Cbt,
},
),
(
"With.Dots 001.cbr",
Comic {
series: "With.Dots".into(),
number: Some(1),
suffix: None,
of: None,
title: None,
year: None,
tags: vec![],
format: Format::Cbr,
},
),
(
"With Suffix 001X (2023).cbt",
Comic {
series: "With Suffix".into(),
number: Some(1),
suffix: Some("X".into()),
of: None,
title: None,
year: Some(2023),
tags: vec![],
format: Format::Cbt,
},
),
];

for (input, expected) in cases {
let comic: Comic = input.parse()?;
assert_eq!(comic, expected);
}

Ok(())
}
}
pub use meta::{Meta, MetaError};
24 changes: 0 additions & 24 deletions src/comic/error.rs
View file

This file was deleted.

Loading

0 comments on commit bbf4466

Please sign in to comment.