Improve readability of outdated #4474

tlynam · 2016-04-28T02:16:35Z

Haven't fixed tests since wanted buy-in.

Before:

Outdated gems included in the bundle:
  * active_model_serializers (newest 0.9.5, installed 0.8.3, requested ~> 0.8.0) in group "default"
  * activerecord-import (newest 0.13.0, installed 0.10.0) in group "default"
  * addressable (newest 2.4.0, installed 2.3.5, requested = 2.3.5) in group "default"
  * airbrake (newest 5.2.3, installed 5.1.0) in group "default"
  * bootstrap-sass (newest 3.3.6, installed 3.3.5.1) in group "default"
  * capistrano (newest 3.5.0, installed 3.4.0, requested ~> 3.4) in group "development"
  * capistrano-rails (newest 1.1.6, installed 1.1.3, requested ~> 1.1.1) in group "development"

After:

--pretty
Outdated gems included in the bundle:
Gem Name                New        Installed  Requested  Groups
airbrake                5.3.0      5.0.3                 default
better_errors           2.1.1      1.0.1      ~> 1.0.1   development
bootstrap-sass          3.3.6      3.3.0.1    ~> 3.3.0.1 default
factory_girl_rails      4.7.0      4.4.1                 test, development

--pretty --verbose
Outdated gems included in the bundle:
Gem Name                New        Installed  Requested  Groups            Load Path
airbrake                5.3.0      5.0.3                 default           /Users/todd/.rbenv/versions/2.2.3/lib/ruby/gems/2.2.0/specifications/airbrake-5.3.0.gemspec
better_errors           2.1.1      1.0.1      ~> 1.0.1   development       /Users/todd/.rbenv/versions/2.2.3/lib/ruby/gems/2.2.0/specifications/better_errors-2.1.1.gemspec
bootstrap-sass          3.3.6      3.3.0.1    ~> 3.3.0.1 default           /Users/todd/.rbenv/versions/2.2.3/lib/ruby/gems/2.2.0/specifications/bootstrap-sass-3.3.6.gemspec
factory_girl            4.7.0      4.4.0                                   /Users/todd/.rbenv/versions/2.2.3/lib/ruby/gems/2.2.0/specifications/factory_girl-4.7.0.gemspec
factory_girl_rails      4.7.0      4.4.1                 test, development /Users/todd/.rbenv/versions/2.2.3/lib/ruby/gems/2.2.0/specifications/factory_girl_rails-4.7.0.gemspec

segiddins · 2016-05-05T03:18:03Z

I like this! Would it maybe make sense to justify all the different parts of the line as well?

hmistry · 2016-05-10T03:29:23Z

I think so. Something like below is what I'd like to see if possible. Removing all the repetitive labeling, removes clutter and makes it easier to read.

Outdated gems included in the bundle:
  * Gem Name                   New      Installed   Requested    Group
  * active_model_serializers   0.9.5    0.8.3       ~> 0.8.0     "default"
  * activerecord-import        0.13.0   0.10.0                   "default"
  * addressable                2.4.0    2.3.5       = 2.3.5      "default"
  * airbrake                   5.2.3    5.1.0                    "default"
  * bootstrap-sass             3.3.6    3.3.5.1                  "default"
  * capistrano                 3.4.1    3.4.0       ~> 3.4       "development"
  * capistrano-rails           1.1.6    1.1.3       ~> 1.1.1     "development"

segiddins · 2016-05-10T03:32:30Z

Only issue with that is that it will break any automated parsing of the --outdated output, right?

RochesterinNYC · 2016-05-10T03:39:03Z

Well, maybe we should be encouraging people to use bundle outdated --parseable for automated parsing? Though, we'd have to decide whether that output would stay the same or get formatted the same as here.

hmistry · 2016-05-10T03:39:46Z

@segiddins because it's not CSV formatted? It's possible. We can add the comma's in to help with that but it will require a little mod to their script. Alternatively, it could be a --outdated-prettyformat option.

segiddins · 2016-05-10T03:41:12Z

No, not that its not CSV, but rather because that header line has the same format as an outdated gem line

RochesterinNYC · 2016-05-10T03:47:45Z

If we make it an alternative option/something that needs to be specified via flags, I don't think it'll see much use.

Ideally, it'd be nice to shore up and focus bundle outdated on producing pleasing human-readable output while ensuring bundle outdated --parseable maintains an automatically parseable format might be a good resolution. However, after looking around Github at some repos, I think the original output (ex. * active_model_serializers (newest 0.9.5, installed 0.8.3, requested ~> 0.8.0) in group "default") might be as far as we might consider changing the output to. Even then, it seems that we might be breaking some people's usages/parsing of bundle outdated.

Alternatively, this could be a PR/change to Bundler 2.0? In which case, breaking the interface/format is acceptable?

hmistry · 2016-05-10T04:08:08Z

@segiddins Ah! I see. It's an easy thing to fix either do all caps or wrap them in parentheses or ... depends if we decide to go this route.

@RochesterinNYC Agree, breaking changes like this is better done in major version upgrades. My thoughts on the flag option is it's ok to have low usage in the beginning as it will take time for awareness and adoption/user change. What's more important is to hear their feedback and see rate of adoption, though for a command utility it's harder than it is for a website.

phiggins · 2016-05-13T05:04:30Z

Is there any reason to keep the sorting based on the group, rather than the gem name?

When I use bundle outdated, I typically scan the output to see if a gem or set of gems is listed, and the list being sorted by group is not the most helpful way it could be. I'd suggest sorting the list based on the name of the gem.

RochesterinNYC · 2016-05-13T12:42:58Z

Grouping by Gemfile groups, then by sub-dependencies (dependencies of the explicitly named dependencies in the Gemfile), is more logical than having an alphabetical list of gems as it can get confusing which type of gem dependency you're looking at. Additionally, from what I've seen in terms of bundle outdated usage, many users choose to be more stringent about updates for certain groups (ex. production rather than testing).

phiggins · 2016-05-15T20:08:45Z

I can only speak for myself, but I find the current output very confusing. The only times I've ever used bundle outdated was to find out if a gem or set of gems had newer versions available, and the current output is not useful for that.

I felt obligated to add my two cents because I put @tlynam up to this in the first place. I'll respect whatever decisions are made by the project maintainers and I promise I won't belabor the point.

tlynam · 2016-05-15T21:27:03Z

Could we support both use cases? What do you think if there were a --grouped option as a type of sorting? Do you think it could be confusing to read a list if there were several group combinations? Looking through our gemfile we have
test, development, staging
test, development
test
development
If it were pre-grouped, I think there could be a high chance someone would still need to play with the output if they were trying to isolate certain environments.

indirect · 2016-05-15T22:06:43Z

To be honest, I'm also confused by the way outdated prints an undifferentiated list that isn't in alphabetical order. I think might make sense if it did it in a hierarchical way, maybe like this:

Outdated gems in the default group:
  rack-obama (newest 0.1.1, installed 0.1.0, requested 0.1.0)
    rack (newest 1.6.3, installed 1.2.1, requested ~> 1.2.0)

But given the way that it prints now, I think alphabetizing the list would actually make a lot of sense. I also like the tabular output, and I think adding a --parseable output to outdated that prints in some easily computer-parsable format like TSV or CSV make a lot of sense.

To be fully backwards-compatible, we could alphabetize the current output, add --parseable with TSV output, and plan to change the regular output to something tabular in 2.0. How does everyone feel about that?

phiggins · 2016-05-15T22:10:56Z

To be fully backwards-compatible, we could alphabetize the current output, add --parseable with TSV output, and plan to change the regular output to something tabular in 2.0. How does everyone feel about that?

Sounds good to me. 👍

hmistry · 2016-05-15T22:26:56Z

I agree with that.

booch · 2016-05-23T23:57:48Z

We could keep the current output format if STDOUT is a pipe, and print the pretty output if we're running it interactively, or if --pretty is specified.

tlynam · 2016-06-05T16:01:21Z

What do you think of this? This alphabetizes the current default. We already have a parseable option so I added pretty. It uses offsets and works with verbose.

--pretty
Outdated gems included in the bundle:
Gem Name                New        Installed  Requested  Groups
airbrake                5.3.0      5.0.3                 default
better_errors           2.1.1      1.0.1      ~> 1.0.1   development
bootstrap-sass          3.3.6      3.3.0.1    ~> 3.3.0.1 default
factory_girl_rails      4.7.0      4.4.1                 test, development

--pretty --verbose
Outdated gems included in the bundle:
Gem Name                New        Installed  Requested  Groups            Load Path
airbrake                5.3.0      5.0.3                 default           /Users/todd/.rbenv/versions/2.2.3/lib/ruby/gems/2.2.0/specifications/airbrake-5.3.0.gemspec
better_errors           2.1.1      1.0.1      ~> 1.0.1   development       /Users/todd/.rbenv/versions/2.2.3/lib/ruby/gems/2.2.0/specifications/better_errors-2.1.1.gemspec
bootstrap-sass          3.3.6      3.3.0.1    ~> 3.3.0.1 default           /Users/todd/.rbenv/versions/2.2.3/lib/ruby/gems/2.2.0/specifications/bootstrap-sass-3.3.6.gemspec
factory_girl            4.7.0      4.4.0                                   /Users/todd/.rbenv/versions/2.2.3/lib/ruby/gems/2.2.0/specifications/factory_girl-4.7.0.gemspec
factory_girl_rails      4.7.0      4.4.1                 test, development /Users/todd/.rbenv/versions/2.2.3/lib/ruby/gems/2.2.0/specifications/factory_girl_rails-4.7.0.gemspec

hmistry · 2016-06-05T20:15:19Z

Nice! I really like that. 👍

Check with @segiddins if he wishes to differentiate the title row for easy parsing as he raised a concern earlier about the title row being similar to a table row.

phiggins · 2016-06-07T04:47:30Z

This looks awesome @tlynam!

homu · 2016-10-06T14:40:31Z

☔ The latest upstream changes (presumably #4841) made this pull request unmergeable. Please resolve the merge conflicts.

chrismo · 2016-10-06T14:57:40Z

Welp. @tlynam - we just approved a PR to add grouping to this command (#4841) and left this one behind. :| I'm sure it was unintentional, lots of PRs and Issues and only so much time.

That said, your proposed changes still seem relevant if you'd like to rebase this.

FYI, I'm working on #5061 which is making some additional changes to it.

(Big picture, I'd love to see this code cleaned up to better separate out the data gathering and presentation - it's all intertwined right now and makes it more difficult to extend for different views - though I won't be focusing on that).

tlynam · 2016-10-06T22:02:21Z

Thanks @chrismo, I'll work on improving this :)

tlynam · 2016-10-28T04:21:04Z

I rewrote this, please let me know how it can be improved, thanks! :)

chrismo · 2016-10-28T04:39:49Z

thx @tlynam. if someone else can get to it before me, cool - imma having a very busy week that doesn't include any time for bundler :/

feel free to ping me or us on this PR if we neglect you too long, I don't mind the reminders :)

tlynam · 2016-10-28T04:44:02Z

Thanks @chrismo, I completely understand :)

bundlerbot · 2016-11-19T00:21:22Z

☔ The latest upstream changes (presumably #5114) made this pull request unmergeable. Please resolve the merge conflicts.

With this, if we rename the hash, we don't have to change the indentation of every entry to keep it consistent.

The list part doesn't add much and it's very implementation dependent.

The output feels a bit cleaner because there's more space, and the term is more clear in my opinion.

I don't think it adds much to the output?

If bundler crashes, specs should fail anyways.

The "Latest" version may also be installed, so I think it's more accurate to use "Locked" here.

All the other screen output and checks for `--parseable` are doing inline, so let's do it here too.

`--parseable` checks `Bundler.ui.debug?` instead of look at the option directly.

deivid-rodriguez · 2019-10-13T14:05:29Z

I'll merge this in tomorrow if there's no further feedback.

deivid-rodriguez · 2019-10-14T20:23:41Z

@bundlerbot r+

4474: Improve readability of outdated r=deivid-rodriguez a=tlynam Haven't fixed tests since wanted buy-in. Before: ``` Outdated gems included in the bundle: * active_model_serializers (newest 0.9.5, installed 0.8.3, requested ~> 0.8.0) in group "default" * activerecord-import (newest 0.13.0, installed 0.10.0) in group "default" * addressable (newest 2.4.0, installed 2.3.5, requested = 2.3.5) in group "default" * airbrake (newest 5.2.3, installed 5.1.0) in group "default" * bootstrap-sass (newest 3.3.6, installed 3.3.5.1) in group "default" * capistrano (newest 3.5.0, installed 3.4.0, requested ~> 3.4) in group "development" * capistrano-rails (newest 1.1.6, installed 1.1.3, requested ~> 1.1.1) in group "development" ``` After: ``` --pretty Outdated gems included in the bundle: Gem Name New Installed Requested Groups airbrake 5.3.0 5.0.3 default better_errors 2.1.1 1.0.1 ~> 1.0.1 development bootstrap-sass 3.3.6 3.3.0.1 ~> 3.3.0.1 default factory_girl_rails 4.7.0 4.4.1 test, development --pretty --verbose Outdated gems included in the bundle: Gem Name New Installed Requested Groups Load Path airbrake 5.3.0 5.0.3 default /Users/todd/.rbenv/versions/2.2.3/lib/ruby/gems/2.2.0/specifications/airbrake-5.3.0.gemspec better_errors 2.1.1 1.0.1 ~> 1.0.1 development /Users/todd/.rbenv/versions/2.2.3/lib/ruby/gems/2.2.0/specifications/better_errors-2.1.1.gemspec bootstrap-sass 3.3.6 3.3.0.1 ~> 3.3.0.1 default /Users/todd/.rbenv/versions/2.2.3/lib/ruby/gems/2.2.0/specifications/bootstrap-sass-3.3.6.gemspec factory_girl 4.7.0 4.4.0 /Users/todd/.rbenv/versions/2.2.3/lib/ruby/gems/2.2.0/specifications/factory_girl-4.7.0.gemspec factory_girl_rails 4.7.0 4.4.1 test, development /Users/todd/.rbenv/versions/2.2.3/lib/ruby/gems/2.2.0/specifications/factory_girl_rails-4.7.0.gemspec ``` Co-authored-by: Todd Lynam <tlynam@gmail.com> Co-authored-by: David Rodríguez <deivid.rodriguez@riseup.net>

ghost · 2019-10-14T21:06:17Z

Build succeeded

continuous-integration/travis-ci/push

tlynam force-pushed the outdated-format branch from 8b47e71 to c4ed95d Compare June 5, 2016 15:51

tlynam force-pushed the outdated-format branch 2 times, most recently from 20fe0be to 73fe587 Compare October 28, 2016 04:16

chrismo self-assigned this Nov 19, 2016

deivid-rodriguez added 20 commits October 12, 2019 16:46

Extract table header to a method

c004288

Make hash alignment style more diff-friendly

cf0ac92

With this, if we rename the hash, we don't have to change the indentation of every entry to keep it consistent.

Rename outdated_gems_list

3742b33

The list part doesn't add much and it's very implementation dependent.

Add a bit more space between columns

f6ef150

Change "Gem Name" header to just "Gem"

3ed6cf8

Change "New" header to "Latest"

17e71ea

The output feels a bit cleaner because there's more space, and the term is more clear in my opinion.

Remove outdated header

78ae7d9

I don't think it adds much to the output?

Remove unnecessary expectations

43b4c56

If bundler crashes, specs should fail anyways.

Tighten some expectations

a4d2ff4

Change "Load Path" header to just "Path"

fb72186

Change "Installed" column to "Locked"

5ab4db1

The "Latest" version may also be installed, so I think it's more accurate to use "Locked" here.

Consistenly pass strings to method that prints a table

0c9aeb9

Move row justification logic to a method

95e9bd9

Strip row trailing spaces

37ae646

Remove --pretty option and make it the default

eb47767

Don't include table header when ordering

a65304f

Inline one method

f5ddf68

All the other screen output and checks for `--parseable` are doing inline, so let's do it here too.

Normalize bundle outdated --verbose option handling

73ff5d5

`--parseable` checks `Bundler.ui.debug?` instead of look at the option directly.

Split --verbose option to a separate spec

a7cec29

Rename "Locked" to "Current"

76b1d89

deivid-rodriguez force-pushed the outdated-format branch from 2029182 to 76b1d89 Compare October 12, 2019 14:54

ghost merged commit 76b1d89 into rubygems:master Oct 14, 2019

tlynam deleted the outdated-format branch October 14, 2019 23:11

JunichiIto mentioned this pull request Jul 7, 2021

Support table format stdin for Bundler 2.2 or higher emsk/bundle_outdated_formatter#6

Open

do-you-dare mentioned this pull request Feb 7, 2022

No outdated packages found rafamanzo/gisdatigo#13

Open

misdoro mentioned this pull request Mar 21, 2022

Parse new bundler outdated format teeparham/gemdiff#27

Closed

This pull request was closed.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve readability of outdated #4474

Improve readability of outdated #4474

tlynam commented Apr 28, 2016 •

edited

Loading

segiddins commented May 5, 2016

hmistry commented May 10, 2016

segiddins commented May 10, 2016

RochesterinNYC commented May 10, 2016

hmistry commented May 10, 2016 •

edited

Loading

segiddins commented May 10, 2016

RochesterinNYC commented May 10, 2016

hmistry commented May 10, 2016

phiggins commented May 13, 2016

RochesterinNYC commented May 13, 2016

phiggins commented May 15, 2016

tlynam commented May 15, 2016

indirect commented May 15, 2016

phiggins commented May 15, 2016

hmistry commented May 15, 2016

booch commented May 23, 2016

tlynam commented Jun 5, 2016

hmistry commented Jun 5, 2016

phiggins commented Jun 7, 2016

homu commented Oct 6, 2016

chrismo commented Oct 6, 2016 •

edited

Loading

tlynam commented Oct 6, 2016

tlynam commented Oct 28, 2016

chrismo commented Oct 28, 2016

tlynam commented Oct 28, 2016

bundlerbot commented Nov 19, 2016

deivid-rodriguez commented Oct 13, 2019

deivid-rodriguez commented Oct 14, 2019

ghost commented Oct 14, 2019

Improve readability of outdated #4474

Improve readability of outdated #4474

Conversation

tlynam commented Apr 28, 2016 • edited Loading

segiddins commented May 5, 2016

hmistry commented May 10, 2016

segiddins commented May 10, 2016

RochesterinNYC commented May 10, 2016

hmistry commented May 10, 2016 • edited Loading

segiddins commented May 10, 2016

RochesterinNYC commented May 10, 2016

hmistry commented May 10, 2016

phiggins commented May 13, 2016

RochesterinNYC commented May 13, 2016

phiggins commented May 15, 2016

tlynam commented May 15, 2016

indirect commented May 15, 2016

phiggins commented May 15, 2016

hmistry commented May 15, 2016

booch commented May 23, 2016

tlynam commented Jun 5, 2016

hmistry commented Jun 5, 2016

phiggins commented Jun 7, 2016

homu commented Oct 6, 2016

chrismo commented Oct 6, 2016 • edited Loading

tlynam commented Oct 6, 2016

tlynam commented Oct 28, 2016

chrismo commented Oct 28, 2016

tlynam commented Oct 28, 2016

bundlerbot commented Nov 19, 2016

deivid-rodriguez commented Oct 13, 2019

deivid-rodriguez commented Oct 14, 2019

ghost commented Oct 14, 2019

Build succeeded

tlynam commented Apr 28, 2016 •

edited

Loading

hmistry commented May 10, 2016 •

edited

Loading

chrismo commented Oct 6, 2016 •

edited

Loading