Updates.

Author: DariuszDepta

.github/workflows/build-manual.yml

@@ -0,0 +1,62 @@
+name: manual
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+      - release/*
+  pull_request:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    name: Build manual
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - name: Install latest mdBook and mdbook-yapp
+        run: |
+          tag_mdbook=$(curl -sSL 'https://api.github.com/repos/rust-lang/mdbook/releases/latest'| jq -r '.tag_name')
+          url_mdbook="https://github.com/rust-lang/mdBook/releases/download/${tag_mdbook}/mdbook-${tag_mdbook}-x86_64-unknown-linux-gnu.tar.gz"
+          tag_mdbook_yapp=$(curl -sSL 'https://api.github.com/repos/EngosSoftware/mdbook-yapp/releases/latest' | jq -r '.tag_name')
+          url_mdbook_yapp="https://github.com/EngosSoftware/mdbook-yapp/releases/download/${tag_mdbook_yapp}/mdbook-yapp-${tag_mdbook_yapp}-x86_64-unknown-linux-gnu.tar.gz"
+          mkdir mdbook
+          curl -sSL $url_mdbook | tar -xz --directory=./mdbook
+          curl -sSL $url_mdbook_yapp | tar -xz --directory=./mdbook
+          echo `pwd`/mdbook >> $GITHUB_PATH
+
+      - name: Build manual
+        run: cd manual && mdbook build
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v6
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v5
+        with:
+          path: manual/book
+
+  deploy:
+    name: Deploy manual
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v5

Cargo.lock

@@ -1,11 +1,12 @@
 [package]
 name = "antex"
-version = "0.2.2"
+version = "0.2.3"
 authors = ["Dariusz Depta <depta@engos.de>"]
 description = "Styled text and tree in terminal"
 documentation = "https://docs.rs/antex"
 repository = "https://github.com/EngosSoftware/antex.git"
 keywords = ["ansi", "ascii", "text", "tree", "styled"]
+homepage = "https://engossoftware.github.io/antex/"
 categories = ["text-processing", "visualization", "encoding"]
 license = "MIT OR Apache-2.0"
 edition = "2024"

Cargo.toml

@@ -38,7 +38,9 @@ pub trait StyledText: Sized {
   /// Fills the content with the given character until the given width is reached.
   fn fill(self, ch: char, width: usize) -> Self;
   /// Adds new content based on the condition.
-  fn choose<T: Display>(self, condition: bool, when_true: T, when_false: T) -> Self;
+  fn choose<T: Display, F: Display>(self, condition: bool, when_true: T, when_false: F) -> Self;
+  /// Adds new content based on the first matching condition.
+  fn matches<C: IntoIterator<Item = (bool, impl Display)>>(self, conditions: C) -> Self;
   /// Adds indented content.
   fn indent<T: Display>(self, indent: usize, s: T) -> Self;
   /// Style text as bold.
@@ -237,6 +239,12 @@ pub struct Text {
   content: Content,
 }
 
+impl AsRef<Text> for Text {
+  fn as_ref(&self) -> &Text {
+    self
+  }
+}
+
 impl Display for Text {
   fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
     if let Some(width) = f.width() {
@@ -317,6 +325,14 @@ impl Text {
   pub fn count(&self) -> usize {
     self.chars().count()
   }
+
+  /// Returns text containing only characters,
+  /// all control sequences (if present) are omitted.
+  ///
+  /// It is an equivalent of calling `chars().collect::<String>()`.
+  pub fn characters(&self) -> String {
+    self.content.chars().collect()
+  }
 }
 
 impl StyledText for Text {
@@ -385,8 +401,17 @@ impl StyledText for Text {
     self
   }
 
-  fn choose<T: Display>(self, condition: bool, when_true: T, when_false: T) -> Self {
-    self.s(if condition { when_true } else { when_false })
+  fn choose<T: Display, F: Display>(self, condition: bool, when_true: T, when_false: F) -> Self {
+    self.s(if condition { when_true.to_string() } else { when_false.to_string() })
+  }
+
+  fn matches<C: IntoIterator<Item = (bool, impl Display)>>(self, conditions: C) -> Self {
+    for (condition, content) in conditions.into_iter() {
+      if condition {
+        return self.s(content);
+      }
+    }
+    self
   }
 
   fn indent<T: Display>(self, indent: usize, s: T) -> Self {

src/text.rs

@@ -161,10 +161,6 @@ impl StyledText for LeafLineBuilder {
     self
   }
 
-  fn indent<T: Display>(self, indent: usize, s: T) -> Self {
-    self.pad(' ', indent, s)
-  }
-
   fn align_left<T: Display>(self, s: T, width: usize) -> Self {
     self.pad_right(' ', s, width)
   }
@@ -197,11 +193,25 @@ impl StyledText for LeafLineBuilder {
     self
   }
 
-  fn choose<T: Display>(mut self, condition: bool, when_true: T, when_false: T) -> Self {
+  fn fill(mut self, ch: char, width: usize) -> Self {
+    self.text = self.text.fill(ch, width);
+    self
+  }
+
+  fn choose<T: Display, F: Display>(mut self, condition: bool, when_true: T, when_false: F) -> Self {
     self.text = self.text.choose(condition, when_true, when_false);
     self
   }
 
+  fn matches<C: IntoIterator<Item = (bool, impl Display)>>(mut self, conditions: C) -> Self {
+    self.text = self.text.matches(conditions);
+    self
+  }
+
+  fn indent<T: Display>(self, indent: usize, s: T) -> Self {
+    self.pad(' ', indent, s)
+  }
+
   fn bold(mut self) -> Self {
     self.text = self.text.bold();
     self
@@ -436,11 +446,6 @@ impl StyledText for LeafLineBuilder {
     self.text = self.text.bg_color_rgb(c);
     self
   }
-
-  fn fill(mut self, ch: char, width: usize) -> Self {
-    self.text = self.text.fill(ch, width);
-    self
-  }
 }
 
 /// Builder for [TreeNode::Node].
@@ -543,10 +548,6 @@ impl StyledText for NodeLineBuilder {
     self
   }
 
-  fn indent<T: Display>(self, indent: usize, s: T) -> Self {
-    self.pad(' ', indent, s)
-  }
-
   fn align_left<T: Display>(self, s: T, width: usize) -> Self {
     self.pad_right(' ', s, width)
   }
@@ -579,11 +580,25 @@ impl StyledText for NodeLineBuilder {
     self
   }
 
-  fn choose<T: Display>(mut self, condition: bool, when_true: T, when_false: T) -> Self {
+  fn fill(mut self, ch: char, width: usize) -> Self {
+    self.text = self.text.fill(ch, width);
+    self
+  }
+
+  fn choose<T: Display, F: Display>(mut self, condition: bool, when_true: T, when_false: F) -> Self {
     self.text = self.text.choose(condition, when_true, when_false);
     self
   }
 
+  fn matches<C: IntoIterator<Item = (bool, impl Display)>>(mut self, conditions: C) -> Self {
+    self.text = self.text.matches(conditions);
+    self
+  }
+
+  fn indent<T: Display>(self, indent: usize, s: T) -> Self {
+    self.pad(' ', indent, s)
+  }
+
   fn bold(mut self) -> Self {
     self.text = self.text.bold();
     self
@@ -818,9 +833,4 @@ impl StyledText for NodeLineBuilder {
     self.text = self.text.bg_color_rgb(c);
     self
   }
-
-  fn fill(mut self, ch: char, width: usize) -> Self {
-    self.text = self.text.fill(ch, width);
-    self
-  }
 }

src/tree.rs

@@ -5,31 +5,32 @@ fn any_char_should_work() {
   let text = Text::default().s("Hello").s('^').s("world!");
   assert_eq!("Hello^world!", text.to_string());
   assert_eq!("Hello^world!", text.chars().collect::<String>());
+  assert_eq!("Hello^world!", text.characters());
+  assert_eq!(12, text.count());
 }
 
 #[test]
 fn unicode_char_should_work() {
   let text = Text::default().s("Hello").s('☺').s("world!");
   assert_eq!("Hello☺world!", text.to_string());
   assert_eq!("Hello☺world!", text.chars().collect::<String>());
+  assert_eq!("Hello☺world!", text.characters());
+  assert_eq!(12, text.count());
 }
 
 #[test]
 fn repeat_should_work() {
   let text = Text::default().s("Hello").repeat('☺', 5).s("world!");
   assert_eq!("Hello☺☺☺☺☺world!", text.to_string());
   assert_eq!("Hello☺☺☺☺☺world!", text.chars().collect::<String>());
+  assert_eq!("Hello☺☺☺☺☺world!", text.characters());
+  assert_eq!(16, text.count());
 }
 
 #[test]
 fn colored_repeat_should_work() {
   let text = Text::default().blue().s("Hello").reset().green().repeat('☺', 5).reset().red().s("world!").reset();
   assert_eq!("Hello☺☺☺☺☺world!", text.chars().collect::<String>());
+  assert_eq!("Hello☺☺☺☺☺world!", text.characters());
   assert_eq!(16, text.count());
 }
-
-#[test]
-fn plural_should_work() {
-  assert_eq!("Hello world!", Text::default().s("Hello ").plural("world", 1).s('!').to_string());
-  assert_eq!("Hello worlds!", Text::default().s("Hello ").plural("world", 2).s('!').to_string());
-}

tests/test_text/characters.rs

@@ -5,3 +5,9 @@ fn if_else_should_work() {
   assert_eq!("1", format!("{}", never().choose(true, "1", "0")));
   assert_eq!("0", format!("{}", never().choose(false, "1", "0")));
 }
+
+#[test]
+fn if_else_with_different_types_should_work() {
+  assert_eq!("1", format!("{}", never().choose(true, 1, "0")));
+  assert_eq!("0", format!("{}", never().choose(false, '1', 0)));
+}

tests/test_text/choose.rs

@@ -0,0 +1,13 @@
+use antex::{StyledText, never};
+
+#[test]
+fn matches_should_work() {
+  assert_eq!("a", format!("{}", never().matches([(true, "a"), (true, "b"), (true, "c")])));
+  assert_eq!("a", format!("{}", never().matches([(true, "a"), (true, "b"), (false, "c")])));
+  assert_eq!("a", format!("{}", never().matches([(true, "a"), (false, "b"), (true, "c")])));
+  assert_eq!("a", format!("{}", never().matches([(true, "a"), (false, "b"), (false, "c")])));
+  assert_eq!("b", format!("{}", never().matches([(false, "a"), (true, "b"), (true, "c")])));
+  assert_eq!("b", format!("{}", never().matches([(false, "a"), (true, "b"), (false, "c")])));
+  assert_eq!("c", format!("{}", never().matches([(false, "a"), (false, "b"), (true, "c")])));
+  assert_eq!("", format!("{}", never().matches([(false, "a"), (false, "b"), (false, "c")])));
+}

tests/test_text/matches.rs

@@ -8,7 +8,9 @@ mod colors;
 mod filling;
 mod format;
 mod formatting;
+mod matches;
 mod padding;
+mod plural;
 mod writer;
 
 #[test]
@@ -106,3 +108,19 @@ fn text_coloured_from_cm_on_should_work() {
   assert_eq!("\x1b[33mHello", text.to_string());
   assert_eq!("\x1b[33mHello", format!("{}", text));
 }
+
+#[test]
+fn text_as_ref_should_work() {
+  let t1 = Text::default().yellow().s("Hello").reset();
+  let t2 = Text::default().red().s("Hello").reset();
+
+  fn a(t: impl AsRef<Text>) -> String {
+    t.as_ref().characters()
+  }
+
+  fn b(t: impl AsRef<Text>) -> String {
+    t.as_ref().characters()
+  }
+
+  assert_eq!(a(t1), b(t2));
+}

tests/test_text/mod.rs

@@ -0,0 +1,7 @@
+use antex::{StyledText, Text};
+
+#[test]
+fn plural_should_work() {
+  assert_eq!("Hello world!", Text::default().s("Hello ").plural("world", 1).s('!').to_string());
+  assert_eq!("Hello worlds!", Text::default().s("Hello ").plural("world", 2).s('!').to_string());
+}