Handle keyword Self after stripping enum type prefix
#998
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
caspermeijn
reviewed
Mar 15, 2024
caspermeijn
reviewed
Mar 15, 2024
There was a problem hiding this comment.
It seems there are more keywords with the same problem: https://github.com/rust-lang/rust/blob/d7723b21910075a3c38c2b6e64b2467394c93724/library/proc_macro/src/bridge/symbol.rs#L82
I suggest fixing this for all these keywords
|
The thing is, we know that the result starts with an upper-case letter, as it is already converted to PascalCase, so Self really was the only issue. I can definitely do that though! Thank you for your consideration! |
|
I have moved the sanitizing of identifiers to a common function that can be used by all the others. What do you think? I think it'd definitely a lot safer this way |
caspermeijn
reviewed
Apr 5, 2024
tests/src/enum_keyword_variant.rs
Outdated
| @@ -0,0 +1,7 @@ | |||
| mod enum_keyword_variant { | |||
| // #![deny(unused_results)] | |||
There was a problem hiding this comment.
This comment can be removed
prost-build/src/ident.rs
Outdated
| /// It also tries to handle cases where the stripped name would be | ||
| /// invalid - for example, if it were to begin with a number. | ||
| /// | ||
| /// The stripped name can be `Self`, which is sanitized analogously to [to_upper_camel] |
There was a problem hiding this comment.
This last line doesn´t add information, as to_upper_camel docs doesn't explain how it is handled. Either remove or describe how it is sanitized.
prost-build/src/ident.rs
Outdated
Comment on lines
249
to
262
| #[test] | ||
| fn test_strip_enum_prefix() { | ||
| assert_eq!(strip_enum_prefix("Foo", "FooBar"), "Bar"); | ||
| assert_eq!(strip_enum_prefix("Foo", "Foobar"), "Foobar"); | ||
| assert_eq!(strip_enum_prefix("Foo", "Foo"), "Foo"); | ||
| assert_eq!(strip_enum_prefix("Foo", "Bar"), "Bar"); | ||
| assert_eq!(strip_enum_prefix("Foo", "Foo1"), "Foo1"); | ||
| } | ||
|
|
||
| #[test] | ||
| fn test_strip_enum_prefix_resulting_in_keyword() { | ||
| assert_eq!(strip_enum_prefix("Foo", "FooBar"), "Bar"); | ||
| assert_eq!(strip_enum_prefix("Foo", "FooSelf"), "Self_"); | ||
| } |
There was a problem hiding this comment.
I would combine these two tests
| @@ -47,6 +73,67 @@ mod tests { | |||
|
|
|||
| use super::*; | |||
|
|
|||
| #[test] | |||
| fn test_sanitize_identifier() { | |||
There was a problem hiding this comment.
Thanks for this thorough test.
| enum Grooming { | ||
| UNSPECIFIED = 0; | ||
| ASSISTED = 1; | ||
| SELF = 2; |
There was a problem hiding this comment.
Should this have a keyword as well? for example: ELSE = 3;
|
Should be all done now |
caspermeijn
approved these changes
Apr 9, 2024
|
Thanks for your contribution |
caspermeijn
added a commit
to caspermeijn/prost
that referenced
this pull request
May 5, 2024
_PROST!_ is a [Protocol Buffers](https://developers.google.com/protocol-buffers/) implementation for the [Rust Language](https://www.rust-lang.org/). `prost` generates simple, idiomatic Rust code from `proto2` and `proto3` files. This patch update brings new fixes: - fix: include_file should handle proto without package (tokio-rs#1002) - Place Config::format behind the format feature flag - Handle keyword `Self` after stripping enum type prefix (tokio-rs#998) ## Documentation - fix(readme): fix the link and badge for CI (tokio-rs#1049) ## Internal - style(codegen): `Syntax` to a separate file (tokio-rs#1029) - chore(codegen): extract c string escaping to a separate file (tokio-rs#1028) - style(prost-build): `CodeGenerator::boxed` method (tokio-rs#1019) - style(prost-build): Consolidate field data into struct (tokio-rs#1017) - style(prost-build): `BytesType and MapType` into a `collections` module. (tokio-rs#1030) - style(prost-build): Split `Config` and `Module` into a separate module and files (tokio-rs#1020) - style(prost-build): prost_path helper (tokio-rs#1018) - style: Fix toml indent (tokio-rs#1048) - style: Fix clippy warnings and enable clippy in CI (tokio-rs#1008) - build: Use git submodule to download protobuf sources (tokio-rs#1014) - ci: Add TOML validation with `taplo` (tokio-rs#1034) - tests: Create a separate tempdir for each test (tokio-rs#1044) - tests: Remove GoogleMessage3 and GoogleMessage4 benchmarks (tokio-rs#1037) - chore: Update internal crates to Rust edition 2021 (tokio-rs#1039) - chore: Update crate descriptions (tokio-rs#1038) - chore: Fix clippy checks in CI (tokio-rs#1032) - chore: Add Casper Meijn as author (tokio-rs#1025)
github-merge-queue bot
pushed a commit
that referenced
this pull request
May 8, 2024
_PROST!_ is a [Protocol Buffers](https://developers.google.com/protocol-buffers/) implementation for the [Rust Language](https://www.rust-lang.org/). `prost` generates simple, idiomatic Rust code from `proto2` and `proto3` files. This patch update brings new fixes: - fix: include_file should handle proto without package (#1002) - Place Config::format behind the format feature flag - Handle keyword `Self` after stripping enum type prefix (#998) ## Documentation - fix(readme): fix the link and badge for CI (#1049) ## Internal - style(codegen): `Syntax` to a separate file (#1029) - chore(codegen): extract c string escaping to a separate file (#1028) - style(prost-build): `CodeGenerator::boxed` method (#1019) - style(prost-build): Consolidate field data into struct (#1017) - style(prost-build): `BytesType and MapType` into a `collections` module. (#1030) - style(prost-build): Split `Config` and `Module` into a separate module and files (#1020) - style(prost-build): prost_path helper (#1018) - style: Fix toml indent (#1048) - style: Fix clippy warnings and enable clippy in CI (#1008) - build: Use git submodule to download protobuf sources (#1014) - ci: Add TOML validation with `taplo` (#1034) - tests: Create a separate tempdir for each test (#1044) - tests: Remove GoogleMessage3 and GoogleMessage4 benchmarks (#1037) - chore: Update internal crates to Rust edition 2021 (#1039) - chore: Update crate descriptions (#1038) - chore: Fix clippy checks in CI (#1032) - chore: Add Casper Meijn as author (#1025)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #997
Relates to #179