Improve the role selection dialog #827

dgdavid · 2019-11-07T16:08:32Z

Context

Some time ago, the list of available roles grown enough to start not fitting in the role selection dialog. To fix it, the list was embedded in a scrollable RichText widget since libyui didn't offer a better option (see #671, bsc#1084674, bsc#1086187).

Trello card: https://trello.com/c/QjRVileZ

Current status

As part of a YaST UI improvements a new SingleItemSelector (see https://github.com/libyui/libyui/pull/148) has been added, which is a much better solution to display the roles list.

Changes

To update the role selection dialog using the new widget and removing the old code.

Tests

Unit tests updated/adapted
Also tested manually via driver update.

Screenshots

Click to show/hide

Before

ncurses	Qt

ncurses 80x25	ncurses 80x25 scrolling

After

ncurses	Qt

ncurses 80x25	ncurses 80x25 scrolling

Qt 1920x1080	Qt 2560x1600

coveralls · 2019-11-07T16:44:20Z

Coverage decreased (-0.1%) to 23.921% when pulling dca6922 on change-role-selector into 82939e0 on master.

src/lib/installation/select_system_role.rb

shundhammer · 2019-11-11T18:30:34Z

Technically, LGTM. Just the one typo in the comment.
We might think about the forced line break; it makes perfect sense in NCurses, but I am not so sure about Qt. But that's more the icing on the cake than a deal breaker.
I'd also like to have @lslezak look at this; he might have more input.

dgdavid · 2019-11-11T18:41:17Z

Thanks so much for the review!

Technically, LGTM. Just the one typo in the comment.
We might think about the forced line break; it makes perfect sense in NCurses, but I am not so sure about Qt.

The thing is that some role description also force the horizontal scroll in Qt. I'll take an screenshot as soon as possible.

But that's more the icing on the cake than a deal breaker.
I'd also like to have @lslezak look at this; he might have more input.

Perfect!

Because the SingleItemSelector widget (fixed to not enforce an initial selection) is now used to build the role selection dialog.

dgdavid · 2019-11-12T09:39:17Z

I'll take an screenshot as soon as possible.

See the comment above

As suggested in the code review, now the max line length is longer when not running in text mode.

Likely forgotten in f1b4e40

dgdavid · 2019-11-13T13:13:33Z

src/lib/installation/select_system_role.rb

+    def adjust_text(text)
+      max_line_length = Yast::UI.TextMode ? TEXT_MODE_MAX_LINE_LENGTH : MAX_LINE_LENGTH
+
+      text.strip.scan(/(.{1,#{max_line_length}})(?:\s|$)/).join("\n")


JFYI, I also tried

text.strip.gsub(/(.{1,#{max_line_length}})(?:\s|$)/, "\\1\n").chomp

but a benchmark reveal that scan and join allocates less memory than gsub and chomp. Exactly 1.11x less, although it will almost priceless for this use case...

hint, you can use existing code https://github.com/yast/yast-yast2/blob/66bc64d08c6ff017b88e3cff63fd02d78bbcf7f1/library/general/src/lib/ui/text_helpers.rb#L31

I just noticed that this does not work well if a word is longer than the max. line length:

max_line_length = 10 text = "123456789012 123456789012 123456789012 123456789012" puts text.strip.scan(/(.{1,#{max_line_length}})(?:\s|$)/).join("\n")

results in

3456789012 3456789012 3456789012 3456789012

i.e. some part is lost. But as using a word longer than at least 70 characters is not very likely we can live with that. But maybe it's worth adding a comment about this...

hint, you can use existing code https://github.com/yast/yast-yast2/blob/66bc64d08c6ff017b88e3cff63fd02d78bbcf7f1/library/general/src/lib/ui/text_helpers.rb#L31

Ops! I didn't know about it. And... I didn't took a look around 😓

Thanks!

dgdavid · 2019-11-13T13:16:30Z

@shundhammer, @lslezak

I re-tested it with the new changes (basically different max line lengths for textmode) and updated the most relevant screenshots in the PR description.

So, It's ready for a re-review, please.

shundhammer · 2019-11-13T13:19:26Z

Still LGTM from my side. @lslezak ?

lslezak

LGTM.

But as this is mainly about the UI it would be nice to see some screenshots here...

lslezak · 2019-11-14T08:31:09Z

src/lib/installation/select_system_role.rb

+    def adjust_text(text)
+      max_line_length = Yast::UI.TextMode ? TEXT_MODE_MAX_LINE_LENGTH : MAX_LINE_LENGTH
+
+      text.strip.scan(/(.{1,#{max_line_length}})(?:\s|$)/).join("\n")


I just noticed that this does not work well if a word is longer than the max. line length:

max_line_length = 10 text = "123456789012 123456789012 123456789012 123456789012" puts text.strip.scan(/(.{1,#{max_line_length}})(?:\s|$)/).join("\n")

results in

3456789012 3456789012 3456789012 3456789012

i.e. some part is lost. But as using a word longer than at least 70 characters is not very likely we can live with that. But maybe it's worth adding a comment about this...

lslezak · 2019-11-14T08:43:05Z

Oops, the screenshots are already there... 🤦‍♂️

dgdavid · 2019-11-14T08:44:05Z

I just noticed that this does not work well if a word is longer than the max. line length:

Yep, I was trying to solve this problem in different ways, but as you said

using a word longer than at least 70 characters is not very likely

reason why I decided to not invest much time on it. And, for the same reason, I don't want to solve this with a loop...

dgdavid · 2019-11-14T08:47:17Z

Yep, I was trying to solve this problem in different ways, but as you said

using a word longer than at least 70 characters is not very likely

reason why I decided to not invest much time on it. And, for the same reason, I don't want to solve this with a loop...

That said, I didn't know (my fault, for not asking or taken a look) about the helper pointed out by Josef (see his comment)

So, I'm going to update the code to use it.

dgdavid · 2019-11-14T09:43:35Z

😫 😫 wrap_text helper don't respect the carriage returns inside the text 😞

dgdavid · 2019-11-14T09:53:10Z

😫 😫 wrap_text helper don't respect the carriage returns inside the text 😞

Anyway, as we agreed in IRC, I'm goint to merge this, then continue with #825 and finally improve the helper to support this use case.

yast-bot · 2019-11-14T09:54:49Z

✔️ Public Jenkins job #76 successfully finished
✔️ Created OBS submit request #748578

yast-bot · 2019-11-14T09:56:32Z

✔️ Internal Jenkins job #17 successfully finished
✔️ Created IBS submit request #205113

dgdavid force-pushed the change-role-selector branch from 18e7af8 to bc5c062 Compare November 7, 2019 16:40

dgdavid force-pushed the change-role-selector branch 3 times, most recently from 7238dbb to edafd7e Compare November 8, 2019 12:41

dgdavid changed the title ~~[WIP] Change role selector~~ Improve the role selector Nov 11, 2019

dgdavid changed the title ~~Improve the role selector~~ Improve the role selection dialog Nov 11, 2019

dgdavid force-pushed the change-role-selector branch from 9a73a59 to d78f1e9 Compare November 11, 2019 08:47

dgdavid commented Nov 11, 2019

View reviewed changes

src/lib/installation/select_system_role.rb Outdated Show resolved Hide resolved

dgdavid marked this pull request as ready for review November 11, 2019 09:09

dgdavid force-pushed the change-role-selector branch from d78f1e9 to 5f268fd Compare November 11, 2019 09:23

dgdavid requested review from imobachgs, lslezak and shundhammer November 11, 2019 18:14

shundhammer reviewed Nov 11, 2019

View reviewed changes

src/lib/installation/select_system_role.rb Outdated Show resolved Hide resolved

dgdavid added 4 commits November 12, 2019 09:06

Use the new SingleItemSelector to build the roles selector

28456d5

Remove code no longer needed

006fe86

Update version and changelog

995d7d4

Declare conflict with libyui < 3.8.2

b91b2f6

Because the SingleItemSelector widget (fixed to not enforce an initial selection) is now used to build the role selection dialog.

dgdavid force-pushed the change-role-selector branch from 5f268fd to b91b2f6 Compare November 12, 2019 09:07

dgdavid force-pushed the change-role-selector branch 3 times, most recently from 17537ec to a35dd2a Compare November 13, 2019 11:10

dgdavid added 2 commits November 13, 2019 12:32

Better adjustment for the role description text

c5212fa

As suggested in the code review, now the max line length is longer when not running in text mode.

Remove a leftover

663a11a

Likely forgotten in f1b4e40

dgdavid force-pushed the change-role-selector branch from a35dd2a to 663a11a Compare November 13, 2019 12:33

dgdavid commented Nov 13, 2019

View reviewed changes

lslezak approved these changes Nov 14, 2019

View reviewed changes

Use #wrap_text helper

dca6922

jreidinger approved these changes Nov 14, 2019

View reviewed changes

dgdavid merged commit 61db415 into master Nov 14, 2019

dgdavid deleted the change-role-selector branch November 14, 2019 09:53

This was referenced Nov 14, 2019

Save and restore properly the proposal vertical scroll #825

Merged

Improve the #wrap_text helper yast/yast-yast2#980

Merged

Squad Sprint 88+89 yast/yast.github.io#204

Closed

Improve the role selection dialog #827

Improve the role selection dialog #827

Uh oh!

Conversation

dgdavid commented Nov 7, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Context

Current status

Changes

Tests

Screenshots

Uh oh!

coveralls commented Nov 7, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

shundhammer commented Nov 11, 2019

Uh oh!

dgdavid commented Nov 11, 2019

Uh oh!

dgdavid commented Nov 12, 2019

Uh oh!

dgdavid Nov 13, 2019

Choose a reason for hiding this comment

Uh oh!

jreidinger Nov 14, 2019

Choose a reason for hiding this comment

Uh oh!

lslezak Nov 14, 2019

Choose a reason for hiding this comment

Uh oh!

dgdavid Nov 14, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dgdavid commented Nov 13, 2019

Uh oh!

shundhammer commented Nov 13, 2019

Uh oh!

lslezak left a comment

Choose a reason for hiding this comment

Uh oh!

lslezak Nov 14, 2019

Choose a reason for hiding this comment

Uh oh!

lslezak commented Nov 14, 2019

Uh oh!

dgdavid commented Nov 14, 2019

Uh oh!

dgdavid commented Nov 14, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dgdavid commented Nov 14, 2019

Uh oh!

dgdavid commented Nov 14, 2019

Uh oh!

yast-bot commented Nov 14, 2019

Uh oh!

yast-bot commented Nov 14, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

dgdavid commented Nov 7, 2019 •

edited

Loading

coveralls commented Nov 7, 2019 •

edited

Loading

dgdavid Nov 14, 2019 •

edited

Loading

dgdavid commented Nov 14, 2019 •

edited

Loading