[Merged by Bors] - Move `get_short_name` utility method from `bevy_reflect` into `bevy_utils` by alice-i-cecile · Pull Request #5174 · bevyengine/bevy

alice-i-cecile · 2022-07-02T15:48:32Z

Summary

This method strips a long type name like bevy::render::camera::PerspectiveCameraBundle down into the bare type name (PerspectiveCameraBundle). This is generally useful utility method, needed by #4299 and #5121.

As a result:

This method was moved to bevy_utils for easier reuse.
The legibility and robustness of this method has been significantly improved.
Harder test cases have been added.

This change was split out of #4299 to unblock it and make merging / reviewing the rest of those changes easier.

Changelog

added bevy_utils::get_short_name, which strips the path from a type name for convenient display.
removed the TypeRegistry::get_short_name method. Use the function in bevy_utils instead.

sixfold-origami

One quibble with the docstring. Otherwise, this looks great!

crates/bevy_utils/src/short_names.rs

sixfold-origami

Looks good!

tools/spancmp/Cargo.toml

Co-authored-by: bjorn3 <17426603+bjorn3@users.noreply.github.com>

Nilirad

Didn't check line by line, but tests pass, so LGTM.

PS: There are some comment checks.

crates/bevy_utils/src/short_names.rs

jakobhellermann · 2022-07-02T17:11:00Z

I was wondering whether the new dependency edge from bevy_utils to bevy_reflect would have a negative impact on compilation time. Looking at the output of cargo build --timing, it currently does not, as bevy_reflect is bottlenecked by syn->serde->glam.

Alternatively this could go into an entirely different crate. Which is what I needed a while ago for bevy_mod_debugdump so I put the function into a small crate pretty-type-name. We could just use that, unless we want to keep the non-bevy-maintained dependency count low.

Co-authored-by: Federico Rinaldi <gisquerin@gmail.com>

alice-i-cecile · 2022-07-02T17:27:46Z

Good to see the compile time shouldn't be affected.

I'd be happy to split apart bevy_utils basically as much as we can; I always dislike catch-all utilities. It's unsurprising that bevy_mod_debugdump needed this too, and further suggests that this needs to be a standalone function. I'd also be in favor of this to make bevy_reflect more self-contained as a general-purpose Rust crate.

That said, creating a different crate for this or pulling in a third-party dependency is significantly more controversial. That should be done in a seperate PR, which should be much easier after this refactoring.

alice-i-cecile · 2022-07-02T18:30:30Z

bors r+

…tils` (#5174) # Summary This method strips a long type name like `bevy::render::camera::PerspectiveCameraBundle` down into the bare type name (`PerspectiveCameraBundle`). This is generally useful utility method, needed by #4299 and #5121. As a result: - This method was moved to `bevy_utils` for easier reuse. - The legibility and robustness of this method has been significantly improved. - Harder test cases have been added. This change was split out of #4299 to unblock it and make merging / reviewing the rest of those changes easier. ## Changelog - added `bevy_utils::get_short_name`, which strips the path from a type name for convenient display. - removed the `TypeRegistry::get_short_name` method. Use the function in `bevy_utils` instead.

bors · 2022-07-02T18:52:09Z

Pull request successfully merged into main.

Build succeeded:

…tils` (bevyengine#5174) # Summary This method strips a long type name like `bevy::render::camera::PerspectiveCameraBundle` down into the bare type name (`PerspectiveCameraBundle`). This is generally useful utility method, needed by bevyengine#4299 and bevyengine#5121. As a result: - This method was moved to `bevy_utils` for easier reuse. - The legibility and robustness of this method has been significantly improved. - Harder test cases have been added. This change was split out of bevyengine#4299 to unblock it and make merging / reviewing the rest of those changes easier. ## Changelog - added `bevy_utils::get_short_name`, which strips the path from a type name for convenient display. - removed the `TypeRegistry::get_short_name` method. Use the function in `bevy_utils` instead.

alice-i-cecile added 2 commits July 2, 2022 11:36

Add improved short-name code to bevy_utils

400d625

Use bevy_utils method in bevy_reflect

d57a588

alice-i-cecile added C-Code-Quality A section of code that is hard to understand or change A-Utils Utility functions and types M-Migration-Guide A breaking change to Bevy's public API that needs to be noted in a migration guide labels Jul 2, 2022

alice-i-cecile added 3 commits July 2, 2022 11:54

Remove TypeRegistry::get_short_name

90a4d6f

Move detailed docs

129f667

Clippy

8c3a80d

sixfold-origami suggested changes Jul 2, 2022

View reviewed changes

crates/bevy_utils/src/short_names.rs Outdated Show resolved Hide resolved

alice-i-cecile added 2 commits July 2, 2022 12:09

Improve doc string summary

10aba09

Migrate spancmp tool

911563c

sixfold-origami approved these changes Jul 2, 2022

View reviewed changes

bjorn3 reviewed Jul 2, 2022

View reviewed changes

tools/spancmp/Cargo.toml Outdated Show resolved Hide resolved

Formatting nit

81bd237

Co-authored-by: bjorn3 <17426603+bjorn3@users.noreply.github.com>

Nilirad approved these changes Jul 2, 2022

View reviewed changes

crates/bevy_utils/src/short_names.rs Outdated Show resolved Hide resolved

crates/bevy_utils/src/short_names.rs Outdated Show resolved Hide resolved

crates/bevy_utils/src/short_names.rs Outdated Show resolved Hide resolved

crates/bevy_utils/src/short_names.rs Outdated Show resolved Hide resolved

Manually lint for trailing periods ;)

83ee324

Co-authored-by: Federico Rinaldi <gisquerin@gmail.com>

alice-i-cecile added the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label Jul 2, 2022

alice-i-cecile mentioned this pull request Jul 2, 2022

Split short name functionality into standalone crate #5177

Closed

bors bot changed the title ~~Move get_short_name utility method from bevy_reflect into bevy_utils~~ [Merged by Bors] - Move get_short_name utility method from bevy_reflect into bevy_utils Jul 2, 2022

bors bot closed this Jul 2, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[Merged by Bors] - Move `get_short_name` utility method from `bevy_reflect` into `bevy_utils`#5174

[Merged by Bors] - Move `get_short_name` utility method from `bevy_reflect` into `bevy_utils`#5174
alice-i-cecile wants to merge 9 commits intobevyengine:mainfrom
alice-i-cecile:short-names

alice-i-cecile commented Jul 2, 2022 •

edited

Loading

Uh oh!

sixfold-origami left a comment

Uh oh!

Uh oh!

sixfold-origami left a comment

Uh oh!

Uh oh!

Nilirad left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jakobhellermann commented Jul 2, 2022

Uh oh!

alice-i-cecile commented Jul 2, 2022

Uh oh!

alice-i-cecile commented Jul 2, 2022

Uh oh!

bors bot commented Jul 2, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Uh oh!

Conversation

alice-i-cecile commented Jul 2, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changelog

Uh oh!

sixfold-origami left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sixfold-origami left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Nilirad left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jakobhellermann commented Jul 2, 2022

Uh oh!

alice-i-cecile commented Jul 2, 2022

Uh oh!

alice-i-cecile commented Jul 2, 2022

Uh oh!

bors bot commented Jul 2, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

alice-i-cecile commented Jul 2, 2022 •

edited

Loading