Skip to content

feat(ascii): parse multi-byte unicode chars correctly + docs #936

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

Merged
merged 6 commits into from
Jan 19, 2023
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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@
.DS_Store
result
**/generated-*
**/.idea
3 changes: 3 additions & 0 deletions ascii/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# ascii

[![crates.io](https://img.shields.io/crates/v/onefetch-ascii)](https://crates.io/crates/onefetch-ascii)
[![docs.rs](https://img.shields.io/docsrs/onefetch-ascii)](https://docs.rs/onefetch-ascii)

Provides the primary interface to display ascii art to the terminal.

More info [here](https://github.com/o2sh/onefetch/wiki/ascii-art).
Expand Down
57 changes: 55 additions & 2 deletions ascii/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,52 @@
//! # onefetch-ascii
//!
//! Provides the ascii template interface for [onefetch](https://github.com/o2sh/onefetch).
//!
//! ```rust,no_run
//! use onefetch_ascii::AsciiArt;
//! use owo_colors::{DynColors, AnsiColors};
//!
//! const ASCII: &str = r#"
//! {2} .:--::////::--.`
//! {1} `/yNMMNho{2}////////////:.
//! {1} `+NMMMMMMMMmy{2}/////////////:`
//! {0} `-:::{1}ohNMMMMMMMNy{2}/////////////:`
//! {0} .::::::::{1}odMMMMMMMNy{2}/////////////-
//! {0} -:::::::::::{1}/hMMMMMMMmo{2}////////////-
//! {0} .::::::::::::::{1}oMMMMMMMMh{2}////////////-
//! {0}`:::::::::::::{1}/dMMMMMMMMMMNo{2}///////////`
//! {0}-::::::::::::{1}sMMMMMMmMMMMMMMy{2}//////////-
//! {0}-::::::::::{1}/dMMMMMMs{0}:{1}+NMMMMMMd{2}/////////:
//! {0}-:::::::::{1}+NMMMMMm/{0}:::{1}/dMMMMMMm+{2}///////:
//! {0}-::::::::{1}sMMMMMMh{0}:::::::{1}dMMMMMMm+{2}//////-
//! {0}`:::::::{1}sMMMMMMy{0}:::::::::{1}dMMMMMMm+{2}/////`
//! {0} .:::::{1}sMMMMMMs{0}:::::::::::{1}mMMMMMMd{2}////-
//! {0} -:::{1}sMMMMMMy{0}::::::::::::{1}/NMMMMMMh{2}//-
//! {0} .:{1}+MMMMMMd{0}::::::::::::::{1}oMMMMMMMo{2}-
//! {1} `yMMMMMN/{0}:::::::::::::::{1}hMMMMMh.
//! {1} -yMMMo{0}::::::::::::::::{1}/MMMy-
//! {1} `/s{0}::::::::::::::::::{1}o/`
//! {0} ``.---::::---..`
//! "#;
//!
//! let colors = vec![
//! DynColors::Ansi(AnsiColors::Blue),
//! DynColors::Ansi(AnsiColors::Default),
//! DynColors::Ansi(AnsiColors::BrightBlue)
//! ];
//!
//! let art = AsciiArt::new(ASCII, colors.as_slice(), true);
//!
//! for line in art {
//! println!("{line}")
//! }
//! ```
//!

use owo_colors::{AnsiColors, DynColors, OwoColorize, Style};
use std::fmt::Write;

/// Renders an ascii template with the given colors truncated to the correct width.
pub struct AsciiArt<'a> {
content: Box<dyn 'a + Iterator<Item = &'a str>>,
colors: &'a [DynColors],
Expand Down Expand Up @@ -211,9 +257,10 @@ fn add_styled_segment(base: &mut String, segment: &str, color: DynColors, bold:
type ParseResult<'a, R> = Option<(&'a str, R)>;

fn token<R>(s: &str, predicate: impl FnOnce(char) -> Option<R>) -> ParseResult<R> {
let token = s.chars().next()?;
let mut chars = s.chars();
let token = chars.next()?;
let result = predicate(token)?;
Some((s.get(1..).unwrap(), result))
Some((chars.as_str(), result))
}

// Parsers
Expand Down Expand Up @@ -313,6 +360,12 @@ mod test {
"\u{1b}[39;1m \u{1b}[0m"
);

// https://github.com/o2sh/onefetch/issues/935
assert_eq!(
Tokens("███").render(Vec::new().as_slice(), 0, 3, true),
"\u{1b}[39;1m███\u{1b}[0m"
);

assert_eq!(
Tokens(" {1} {5} {9} a").render(&colors_shim, 4, 10, true),
"\u{1b}[39;1m\u{1b}[0m\u{1b}[39;1m\u{1b}[0m\u{1b}[39;1m \u{1b}[0m\u{1b}[39;1m a\u{1b}[0m "
Expand Down