Update Rust crate ratatui to 0.29.0 #7055

oxide-renovate · 2024-11-13T05:01:37Z

This PR contains the following updates:

Package	Type	Update	Change
ratatui (source)	workspace.dependencies	minor	`0.28.1` -> `0.29.0`

Release Notes

ratatui/ratatui (ratatui)

`v0.29.0`

Compare Source

Features

3a43274 (color) Add hsluv support by @du-ob in #1333
4c4851c (example) Add drawing feature to the canvas example by @orhun in #1429

fun fact: I had to do 35
pushups for this...

e5a7609 (line) Impl From<Cow> for Line by @joshka in #1373 [breaking]

BREAKING-CHANGES:Line now implements From<Cow<str>

As this adds an extra conversion, ambiguous inferred values may no longer
compile.
// given:
struct Foo { ... }
impl From<Foo> for String { ... }
impl From<Foo> for Cow<str> { ... }

let foo = Foo { ... };
let line = Line::from(foo); // now fails due to ambiguous type inference
// replace with
let line = Line::from(String::from(foo));
Fixes:https://github.com/ratatui/ratatui/issues/1367

2805ddd (logo) Add a Ratatui logo widget by @joshka in #1307
This is a simple logo widget that can be used to render the Ratatui logo
in the terminal. It is used in the examples/ratatui-logo.rs example,
and may be used in your applications' help or about screens.
```
use ratatui::{Frame, widgets::RatatuiLogo};

fn draw(frame: &mut Frame) {
    frame.render_widget(RatatuiLogo::tiny(), frame.area());
}
```
d72968d (scrolling-regions) Use terminal scrolling regions to stop Terminal::insert_before from flickering by @nfachan in #1341 [breaking]
The current implementation of Terminal::insert_before causes the
viewport to flicker. This is described in #584 .

This PR removes that flickering by using terminal scrolling regions
(sometimes called "scroll regions"). A terminal can have its scrolling
region set to something other than the whole screen. When a scroll ANSI
sequence is sent to the terminal and it has a non-default scrolling
region, the terminal will scroll just inside of that region.

We use scrolling regions to implement insert_before. We create a region
on the screen above the viewport, scroll that up to make room for the
newly inserted lines, and then draw the new lines. We may need to repeat
this process depending on how much space there is and how many lines we
need to draw.

When the viewport takes up the entire screen, we take a modified
approach. We create a scrolling region of just the top line (could be
more) of the viewport, then use that to draw the lines we want to
output. When we're done, we scroll it up by one line, into the
scrollback history, and then redraw the top line from the viewport.

A final edge case is when the viewport hasn't yet reached the bottom of
the screen. This case, we set up a different scrolling region, where the
top is the top of the viewport, and the bottom is the viewport's bottom
plus the number of lines we want to scroll by. We then scroll this
region down to open up space above the viewport for drawing the inserted
lines.

Regardless of what we do, we need to reset the scrolling region. This PR
takes the approach of always resetting the scrolling region after every
operation. So the Backend gets new scroll_region_up and
scroll_region_down methods instead of set_scrolling_region, scroll_up,
scroll_down, and reset_scrolling_region methods. We chose that approach
for two reasons. First, we don't want Ratatui to have to remember that
state and then reset the scrolling region when tearing down. Second, the
pre-Windows-10 console code doesn't support scrolling region

This PR:
- Adds a new scrolling-regions feature.
- Adds two new Backend methods: scroll_region_up and scroll_region_down.
- Implements those Backend methods on all backends in the codebase.
- The crossterm and termion implementations use raw ANSI escape
  sequences. I'm trying to merge changes into those two projects
  separately to support these functions.
- Adds code to Terminal::insert_before to choose between
  insert_before_scrolling_regions and insert_before_no_scrolling_regions.
  The latter is the old implementation.
- Adds lots of tests to the TestBackend to for the
  scrolling-region-related Backend methods.
- Adds versions of terminal tests that show that insert_before doesn't
  clobber the viewport. This is a change in behavior from before.
dc8d058 (table) Add support for selecting column and cell by @airblast-dev in #1331 [breaking]

Fixes https://github.com/ratatui-org/ratatui/issues/1250

Adds support for selecting a column and cell in TableState. The
selected column, and cells style can be set by
Table::column_highlight_style and Table::cell_highlight_style
respectively.

The table example has also been updated to display the new
functionality:

table_col_cel_selection.mp4

BREAKING CHANGE:The Serialized output of the state will now include the
"selected_column" field. Software that manually parse the serialized the
output (with anything other than the Serialize implementation on
TableState) may have to be refactored if the "selected_column" field
is not accounted for. This does not affect users who rely on the
Deserialize, or Serialize implementation on the state.

BREAKING CHANGE:The Table::highlight_style is now deprecated in favor
of Table::row_highlight_style.
ab6b1fe (tabs) Allow tabs to be deselected by @joshka in #1413 [breaking]
Tabs::select() now accepts Into<Option<usize>> instead of usize.
This allows tabs to be deselected by passing None.

Tabs::default() is now also implemented manually instead of deriving
Default, and a new method Tabs::titles() is added to set the titles
of the tabs.

Fixes:#1412

BREAKING CHANGE:Tabs::select() now accepts Into<Option<usize>>
which breaks any code already using parameter type inference:
```
let selected = 1u8;
- let tabs = Tabs::new(["A", "B"]).select(selected.into())
+ let tabs = Tabs::new(["A", "B"]).select(selected as usize)
```

23c0d52 (text) Improve concise debug view for Span,Line,Text,Style by @joshka in #1410

Improves https://github.com/ratatui/ratatui/pull/1383

The following now round trips when formatted for debug.
This will make it easier to use insta when testing text related views of
widgets.
Text::from_iter([
    Line::from("Hello, world!"),
    Line::from("How are you?").bold().left_aligned(),
    Line::from_iter([
        Span::from("I'm "),
        Span::from("doing ").italic(),
        Span::from("great!").bold(),
    ]),
]).on_blue().italic().centered()

60cc15b (uncategorized) Add support for empty bar style to Sparkline by @fujiapple852 in #1326 [breaking]
- distinguish between empty bars and bars with a value of 0
- provide custom styling for empty bars
- provide custom styling for individual bars
- inverts the rendering algorithm to be item first
Closes:#1325

BREAKING CHANGE:Sparkline::data takes IntoIterator<Item = SparklineBar>
instead of &[u64] and is no longer const

453a308 (uncategorized) Add overlap to layout by @kdheepak in #1398 [breaking]

This PR adds a new feature for the existing Layout::spacing method,
and introducing a Spacing enum.

Now Layout::spacing is generic and can take

zero or positive numbers, e.g. Layout::spacing(1) (current
functionality)
negative number, e.g. Layout::spacing(-1) (new)
variant of the Spacing (new)

This allows creating layouts with a shared pixel for segments. When
spacing(negative_value) is used, spacing is ignored and all segments
will be adjacent and have pixels overlapping.
spacing(zero_or_positive_value) behaves the same as before. These are
internally converted to Spacing::Overlap or Spacing::Space.

Here's an example output to illustrate the layout solve from this PR:

#[test]
fn test_layout() {
    use crate::layout::Constraint::*;
    let mut terminal = crate::Terminal::new(crate::backend::TestBackend::new(50, 4)).unwrap();
    terminal
        .draw(|frame| {
            let [upper, lower] = Layout::vertical([Fill(1), Fill(1)]).areas(frame.area());

            let (segments, spacers) = Layout::horizontal([Length(10), Length(10), Length(10)])
                .flex(Flex::Center)
                .split_with_spacers(upper);

            for segment in segments.iter() {
                frame.render_widget(
                    crate::widgets::Block::bordered()
                        .border_set(crate::symbols::border::DOUBLE),
                    *segment,
                );
            }
            for spacer in spacers.iter() {
                frame.render_widget(crate::widgets::Block::bordered(), *spacer);
            }

            let (segments, spacers) = Layout::horizontal([Length(10), Length(10), Length(10)])
                .flex(Flex::Center)
                .spacing(-1) // new feature
                .split_with_spacers(lower);

            for segment in segments.iter() {
                frame.render_widget(
                    crate::widgets::Block::bordered()
                        .border_set(crate::symbols::border::DOUBLE),
                    *segment,
                );
            }
            for spacer in spacers.iter() {
                frame.render_widget(crate::widgets::Block::bordered(), *spacer);
            }
        })
        .unwrap();
    dbg!(terminal.backend());
}

┌────────┐╔════════╗╔════════╗╔════════╗┌────────┐
└────────┘╚════════╝╚════════╝╚════════╝└────────┘
┌─────────┐╔════════╔════════╔════════╗┌─────────┐
└─────────┘╚════════╚════════╚════════╝└─────────┘

Currently drawing a border on top of an existing border overwrites it.
Future PRs will allow for making the border drawing handle overlaps
better.

7bdccce (uncategorized) Add an impl of DoubleEndedIterator for Columns and Rows by @fujiapple852 [breaking]

BREAKING-CHANGE:The pub modifier has been removed from fields on the

layout::rect::Columns and layout::rect::Rows iterators. These fields
were not intended to be public and should not have been accessed
directly.

Fixes:#1357

Bug Fixes

4f5503d (color) Hsl and hsluv are now clamped before conversion by @joshka in #1436 [breaking]
The from_hsl and from_hsluv functions now clamp the HSL and HSLuv
values before converting them to RGB. This ensures that the input values
are within the expected range before conversion.

Also note that the ranges of Saturation and Lightness values have been
aligned to be consistent with the palette crate. Saturation and Lightness
for from_hsl are now in the range [0.0..1.0] while from_hsluv are
in the range [0.0..100.0].

Refs:- https://redirect.github.com/Ogeon/palette/discussions/253
- https://docs.rs/palette/latest/palette/struct.Hsl.html
- https://docs.rs/palette/latest/palette/struct.Hsluv.html
Fixes:#1433
b7e4885 (color) Fix doc test for from_hsl by @joshka in #1421
3df685e (rect) Rect::area now returns u32 and Rect::new() no longer clamps area to u16::MAX by @joshka in #1378 [breaking]

This change fixes the unexpected behavior of the Rect::new() function to
be more intuitive. The Rect::new() function now clamps the width and
height of the rectangle to keep each bound within u16::MAX. The
Rect::area() function now returns a u32 instead of a u16 to allow for
larger areas to be calculated.

Previously, the Rect::new() function would clamp the total area of the
rectangle to u16::MAX, by preserving the aspect ratio of the rectangle.

BREAKING CHANGE:Rect::area() now returns a u32 instead of a u16.

Fixes:#1375
514d273 (terminal) Use the latest, resized area when clearing by @roberth in #1427
0f48239 (terminal) Resize() now resizes fixed viewports by @Patryk27 in #1353

Terminal::resize() on a fixed viewport used to do nothing due to
an accidentally shadowed variable. This now works as intended.
a52ee82 (text) Truncate based on alignment by @Lunderberg in #1432

This is a follow-up PR to https://github.com/ratatui/ratatui/pull/987,
which implemented alignment-aware truncation for the Line widget.
However, the truncation only checked the Line::alignment field, and
any alignment inherited from a parent's Text::alignment field would
not be used.

This commit updates the truncation of Line to depend both on the
individual Line::alignment, and on any alignment inherited from the
parent's Text::alignment.
611086e (uncategorized) Sparkline docs / doc tests by @joshka in #1437
b9653ba (uncategorized) Prevent calender render panic when terminal height is small by @adrodgers in #1380

Fixes:#1379
da821b4 (uncategorized) Clippy lints from rust 1.81.0 by @fujiapple852 in #1356
68886d1 (uncategorized) Add unstable-backend-writer feature by @Patryk27 in #1352

https://github.com/ratatui/ratatui/pull/991 created a new unstable
feature, but forgot to add it to Cargo.toml, making it impossible to use
on newer versions of rustc - this commit fixes it.

Refactor

6db16d6 (color) Use palette types for Hsl/Hsluv conversions by @orhun in #1418 [breaking]
BREAKING-CHANGE:Previously Color::from_hsl accepted components
as individual f64 parameters. It now accepts a single palette::Hsl
value
and is gated behind a palette feature flag.
```
- Color::from_hsl(360.0, 100.0, 100.0)
+ Color::from_hsl(Hsl::new(360.0, 100.0, 100.0))
```
Fixes:#1414
edcdc8a (layout) Rename element to segment in layout by @kdheepak in #1397

This PR renames element to segment in a couple of functions in the
layout calculations for clarity. element can refer to segments or
spacers and functions that take only segments should use segment
as the variable names.
1153a9e (uncategorized) Consistent result expected in layout tests by @farmeroy in #1406

Fixes #1399
I've looked through all the assert_eq and made sure that they follow
the expected, result pattern. I wasn't sure if it was desired to
actually pass result and expected as variables to the assert_eq
statements, so I've left everything that seems to have followed the
pattern as is.
20c88aa (uncategorized) Avoid unneeded allocations by @mo8it in #1345

Documentation

b13e2f9 (backend) Added link to stdio FAQ by @Valentin271 in #1349
b88717b (constraint) Add note about percentages by @joshka in #1368
381ec75 (readme) Reduce the length by @joshka in #1431

Motivation for this is that there's a bunch of stuff at the bottom of the Readme that we don't really keep up to date. Instead it's better to link to the places that we do keep this info.
4728f0e (uncategorized) Tweak readme by @joshka in #1419

Fixes:#1417
4069aa8 (uncategorized) Fix missing breaking changes link by @joshka in #1416
870bc6a (uncategorized) Use Frame::area() instead of size() in examples by @hosseinnedaee in #1361

Frame::size() is deprecated

Performance

8db7a9a (uncategorized) Implement size hints for Rect iterators by @airblast-dev in #1420

Styling

e02947b (example) Update panic message in minimal template by @orhun in #1344

Miscellaneous Tasks

67c0ea2 (block) Deprecate block::Title by @joshka in #1372

ratatui::widgets::block::Title is deprecated in favor of using Line
to represent titles.
This removes an unnecessary layer of wrapping (string -> Span -> Line ->
Title).

This struct will be removed in a future release of Ratatui (likely
0.31).
For more information see:

#738

To update your code:
Block::new().title(Title::from("foo"));
// becomes any of

Block::new().title("foo");

Block::new().title(Line::from("foo"));

Block::new().title(Title::from("foo").position(Position::TOP));
// becomes any of

Block::new().title_top("foo");

Block::new().title_top(Line::from("foo"));

Block::new().title(Title::from("foo").position(Position::BOTTOM));
// becomes any of

Block::new().title_bottom("foo");

Block::new().title_bottom(Line::from("foo"));

6515097 (cargo) Check in Cargo.lock by @joshka in #1434
When kept up to date, this makes it possible to build any git version
with the same versions of crates that were used for any version, without
it, you can only use the current versions. This makes bugs in semver
compatible code difficult to detect.

The Cargo.lock file is not used by downstream consumers of the crate, so
it is safe to include it in the repository (and recommended by the Rust
docs).

See:- https://doc.rust-lang.org/cargo/faq.html#why-have-cargolock-in-version-control
- https://blog.rust-lang.org/2023/08/29/committing-lockfiles.html
- https://github.com/rust-lang/cargo/issues/8728
c777beb (ci) Bump git-cliff-action to v4 by @orhun in #1350

See:https://github.com/orhun/git-cliff-action/releases/tag/v4.0.0
69e0cd2 (deny) Allow Zlib license in cargo-deny configuration by @orhun in #1411
bc10af5 (style) Make Debug output for Text/Line/Span/Style more concise by @joshka in #1383
Given:```rust

Text::from_iter([
Line::from("without line fields"),
Line::from("with line fields").bold().centered(),
Line::from_iter([
Span::from("without span fields"),
Span::from("with span fields")
.green()
.on_black()
.italic()
.not_dim(),
]),
])
```
Debug:```
Text [Line [Span("without line fields")], Line { style: Style::new().add_modifier(Modifier::BOLD), alignment: Some(Center), spans: [Span("with line fields")] }, Line [Span("without span fields"), Span { style: Style::new().green().on_black().add_modifier(Modifier::ITALIC).remove_modifier(Modifier::DIM), content: "with span fields" }]]
```
Fixes: https://github.com/ratatui/ratatui/issues/1382
f6f7794 (uncategorized) Remove leftover prelude refs / glob imports from example code by @joshka in #1430

Fixes:#1150
9fd1bee (uncategorized) Make Positions iterator fields private by @joshka in #1424 [breaking]

BREAKING CHANGE:The Rect Positions iterator no longer has public
fields. The rect and current_position fields have been made private
as they were not intended to be accessed directly.
c32baa7 (uncategorized) Add benchmark for Table by @airblast-dev in #1408
5ad623c (uncategorized) Remove usage of prelude by @joshka in #1390

This helps make the doc examples more explicit about what is being used.
It will also makes it a bit easier to do future refactoring of Ratatui,
into several crates, as the ambiguity of where types are coming from
will be reduced.

Additionally, several doc examples have been simplified to use Stylize,
and necessary imports are no longer hidden.

This doesn't remove the prelude. Only the internal usages.
f4880b4 (deps) Pin unicode-width to 0.2.0 by @orhun in #1403 [breaking]

We pin unicode-width to avoid breaking applications when there are breaking changes in the library.

Discussion in #1271

Continuous Integration

5635b93 (uncategorized) Add cargo-machete and remove unused deps by @Veetaha in #1362

https://github.com/bnjbvr/cargo-machete

New Contributors

@roberth made their first contribution in #1427
@du-ob made their first contribution in #1333
@farmeroy made their first contribution in #1406
@adrodgers made their first contribution in #1380
@Veetaha made their first contribution in #1362
@hosseinnedaee made their first contribution in #1361
@Patryk27 made their first contribution in #1352

Full Changelog: ratatui/ratatui@v0.28.1...v0.29.0

Configuration

📅 Schedule: Branch creation - "after 8pm,before 6am" in timezone America/Los_Angeles, Automerge - "after 8pm,before 6am" in timezone America/Los_Angeles.

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

If you want to rebase/retry this PR, check this box

This PR has been generated by Renovate Bot.

oxide-renovate · 2024-11-13T05:01:39Z

⚠️ Artifact update problem

Renovate failed to update an artifact related to this branch. You probably do not want to merge this PR as-is.

♻ Renovate will retry this branch, including artifacts, only when one of the following happens:

any of the package files in this branch needs updating, or
the branch becomes conflicted, or
you click the rebase/retry checkbox if found above, or
you rename this PR's title to start with "rebase!" to trigger it manually

The artifact failure details are included below:

File name: Cargo.lock

Command failed: cargo update --config net.git-fetch-with-cli=true --manifest-path Cargo.toml --package [email protected] --precise 0.29.0
    Updating crates.io index
error: failed to select a version for the requirement `ratatui = "^0.28"`
candidate versions found which didn't match: 0.29.0
location searched: crates.io index
required by package `tui-tree-widget v0.22.0`
    ... which satisfies dependency `tui-tree-widget = "^0.22.0"` (locked to 0.22.0) of package `wicket v0.1.0 (/tmp/renovate/repos/github/oxidecomputer/omicron/wicket)`
    ... which satisfies path dependency `wicket` (locked to 0.1.0) of package `wicket-dbg v0.1.0 (/tmp/renovate/repos/github/oxidecomputer/omicron/wicket-dbg)`

oxide-renovate bot added the dependencies Pull requests that update a dependency file label Nov 13, 2024

oxide-renovate bot force-pushed the renovate/ratatui-0.x branch 3 times, most recently from d0fc9e6 to e7a8610 Compare November 20, 2024 04:20

Update Rust crate ratatui to 0.29.0

9f74616

oxide-renovate bot force-pushed the renovate/ratatui-0.x branch from e7a8610 to 9f74616 Compare November 22, 2024 04:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Rust crate ratatui to 0.29.0 #7055

Update Rust crate ratatui to 0.29.0 #7055

oxide-renovate bot commented Nov 13, 2024

oxide-renovate bot commented Nov 13, 2024

Update Rust crate ratatui to 0.29.0 #7055

Are you sure you want to change the base?

Update Rust crate ratatui to 0.29.0 #7055

Conversation

oxide-renovate bot commented Nov 13, 2024

Release Notes

v0.29.0

Features

Bug Fixes

Refactor

Documentation

Performance

Styling

Miscellaneous Tasks

Continuous Integration

New Contributors

Configuration

oxide-renovate bot commented Nov 13, 2024

⚠️ Artifact update problem

File name: Cargo.lock

`v0.29.0`