ratatui/tests/stylize.rs
EdJoPaTo 2cfe82a47e
refactor(buffer): deprecate assert_buffer_eq! in favor of assert_eq! (#1007)
- Simplify `assert_buffer_eq!` logic.
- Deprecate `assert_buffer_eq!`.
- Introduce `TestBackend::assert_buffer_lines`.

Also simplify many tests involving buffer comparisons.

For the deprecation, just use `assert_eq` instead of `assert_buffer_eq`:

```diff
-assert_buffer_eq!(actual, expected);
+assert_eq!(actual, expected);
```

---

I noticed `assert_buffer_eq!` creating no test coverage reports and
looked into this macro. First I simplified it. Then I noticed a bunch of
`assert_eq!(buffer, …)` and other indirect usages of this macro (like
`TestBackend::assert_buffer`).

The good thing here is that it's mainly used in tests so not many
changes to the library code.
2024-05-13 18:13:46 -07:00

112 lines
2.8 KiB
Rust

use std::io;
use ratatui::{
backend::TestBackend,
buffer::Buffer,
layout::Rect,
style::{Color, Style, Stylize},
widgets::{BarChart, Block, Paragraph},
Terminal,
};
#[test]
fn barchart_can_be_stylized() {
let barchart = BarChart::default()
.on_white()
.bar_style(Style::new().red())
.bar_width(2)
.value_style(Style::new().green())
.label_style(Style::new().blue())
.data(&[("A", 1), ("B", 2), ("C", 3)])
.max(3);
let area = Rect::new(0, 0, 9, 5);
let mut terminal = Terminal::new(TestBackend::new(9, 6)).unwrap();
terminal
.draw(|f| {
f.render_widget(barchart, area);
})
.unwrap();
let mut expected = Buffer::with_lines([
" ██ ",
" ▅▅ ██ ",
"▂▂ ██ ██ ",
"1█ 2█ 3█ ",
"A B C ",
" ",
]);
for y in area.y..area.height {
// background
for x in area.x..area.width {
expected.get_mut(x, y).set_bg(Color::White);
}
// bars
for x in [0, 1, 3, 4, 6, 7] {
expected.get_mut(x, y).set_fg(Color::Red);
}
}
// values
for x in 0..3 {
expected.get_mut(x * 3, 3).set_fg(Color::Green);
}
// labels
for x in 0..3 {
expected.get_mut(x * 3, 4).set_fg(Color::Blue);
expected.get_mut(x * 3 + 1, 4).set_fg(Color::Reset);
}
terminal.backend().assert_buffer(&expected);
}
#[test]
fn block_can_be_stylized() -> io::Result<()> {
let block = Block::bordered()
.title("Title".light_blue())
.on_cyan()
.cyan();
let area = Rect::new(0, 0, 8, 3);
let mut terminal = Terminal::new(TestBackend::new(11, 4))?;
terminal.draw(|f| {
f.render_widget(block, area);
})?;
#[rustfmt::skip]
let mut expected = Buffer::with_lines([
"┌Title─┐ ",
"│ │ ",
"└──────┘ ",
" ",
]);
for x in area.x..area.width {
for y in area.y..area.height {
expected
.get_mut(x, y)
.set_fg(Color::Cyan)
.set_bg(Color::Cyan);
}
}
for x in 1..=5 {
expected.get_mut(x, 0).set_fg(Color::LightBlue);
}
terminal.backend().assert_buffer(&expected);
Ok(())
}
#[test]
fn paragraph_can_be_stylized() -> io::Result<()> {
let paragraph = Paragraph::new("Text".cyan());
let area = Rect::new(0, 0, 10, 1);
let mut terminal = Terminal::new(TestBackend::new(10, 1))?;
terminal.draw(|f| {
f.render_widget(paragraph, area);
})?;
let mut expected = Buffer::with_lines(["Text "]);
for x in 0..4 {
expected.get_mut(x, 0).set_fg(Color::Cyan);
}
terminal.backend().assert_buffer(&expected);
Ok(())
}