Skip to content
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

Added feature to align title of the block #462

Merged
merged 5 commits into from May 22, 2021
Merged

Added feature to align title of the block #462

merged 5 commits into from May 22, 2021

Conversation

orreksu
Copy link
Contributor

@orreksu orreksu commented Mar 28, 2021

This is PR for #450

  • Added title_alignment field to block struct
  • Added title_alignment() method to set title_alignment of the block
  • Added comments and title alignment to the example/block.rs
  • Added tests for title alignment in tests/widgets_block.rs
  • Added tests in srs/block.rs for inner

For all above, used layout::Alignment enum as the type for title_alignment.

Copy link
Owner

@fdehau fdehau left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for keeping you waiting for a review. This is a very nice pull request. I have some suggestions to make it even better. Let me know what you think :).


let title_dx = match self.title_alignment {
Alignment::Left => 0,
Alignment::Center => (title_area_width - title.width() as u16) / 2,
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will probably panic if title_area_width < title.width(). You may want to use saturating_sub here as well unless the precondition is checked beforehand. This could use a test as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will update to use saturating_sub and add a test for this case. Thank you for pointing this out.

@@ -507,5 +532,39 @@ mod tests {
height: 0,
},
);
assert_eq!(
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The title_alignment is not taken into account in Block::inner. Therefore, is there a reason to add those test cases here ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added them to show that title_alignment does not effect Block::inner. I am not sure, if that is necessary.

@@ -211,3 +211,471 @@ fn widgets_block_renders_on_small_areas() {
Buffer::with_lines(vec!["┌Test─"]),
);
}

#[test]
fn widgets_block_renders_title_top_left_all_borders() {
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for including tests. However, a lot of them share the same structure. Could we use a more data-driven approach here ? For example, in widgets_paragraph_can_wrap_its_content, the common structure is extracted to a closure which is then called with all test inputs. Additionally, the TestBackend could maybe a bit smaller to have more concise buffer assertions.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ohhhh, that is so neat! Thank you for showing the closure example, I will try to do something similar.
I will make TestBackend smaller.

Copy link
Contributor Author

@orreksu orreksu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for all of the suggestions :)

@@ -507,5 +532,39 @@ mod tests {
height: 0,
},
);
assert_eq!(
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added them to show that title_alignment does not effect Block::inner. I am not sure, if that is necessary.


let title_dx = match self.title_alignment {
Alignment::Left => 0,
Alignment::Center => (title_area_width - title.width() as u16) / 2,
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will update to use saturating_sub and add a test for this case. Thank you for pointing this out.

@@ -211,3 +211,471 @@ fn widgets_block_renders_on_small_areas() {
Buffer::with_lines(vec!["┌Test─"]),
);
}

#[test]
fn widgets_block_renders_title_top_left_all_borders() {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ohhhh, that is so neat! Thank you for showing the closure example, I will try to do something similar.
I will make TestBackend smaller.

…net code to be more straightforward and have correct behavior when placing title in the center without left border
@orreksu
Copy link
Contributor Author

orreksu commented May 5, 2021

Committed updates based on the suggestions and fixed behavior of the center alignment when used without left border.

@orreksu orreksu requested a review from fdehau May 5, 2021 09:20
fdehau
fdehau approved these changes May 22, 2021
@fdehau fdehau merged commit a346704 into fdehau:master May 22, 2021
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants