Skip to content

[pigeon] Implement Screaming Snake Case Conversion for Kotlin Enum Cases #5918

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 10 commits into from
Feb 9, 2024
Merged

[pigeon] Implement Screaming Snake Case Conversion for Kotlin Enum Cases #5918

merged 10 commits into from
Feb 9, 2024

Conversation

erdzan12
Copy link
Contributor

This pull request addresses issue flutter/flutter#140938 in the Pigeon package, related to the naming convention of Kotlin enum cases generated from lower camel case Dart enums. The current implementation concatenates the enum cases in uppercase, deviating from the Kotlin naming convention, specifically when dealing with multi-word names.

Changes

  • Kotlin Enum Generation: Modified the writeEnum function in the Pigeon package to ensure the Kotlin generator produces enum cases in SCREAMING_SNAKE_CASE. This adheres to the Kotlin coding conventions and allows a consistent cross-platform enum naming convention across Dart, Kotlin, and Swift.
  • Regex Handling: Enhanced the regex pattern to correctly transform lower camel case names to screaming snake case, considering edge cases involving numbers and special characters.
  • Testing: Updated the Dart unit tests to include cases for validating the correct transformation of multi-word and complex enum names from lower camel case to screaming snake case.

Pre-launch Checklist

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • I read the Tree Hygiene wiki page, which explains my responsibilities.
  • I read and followed the relevant style guides and ran the auto-formatter. (Unlike the flutter/flutter repo, the flutter/packages repo does use dart format.)
  • I signed the CLA.
  • The title of the PR starts with the name of the package surrounded by square brackets, e.g. [shared_preferences]
  • I listed at least one issue that this PR fixes in the description above.
  • I updated pubspec.yaml with an appropriate new version according to the pub versioning philosophy, or this PR is exempt from version changes.
  • I updated CHANGELOG.md to add a description of the change, following repository CHANGELOG style.
  • I updated/added relevant documentation (doc comments with ///).
  • I added new tests to check the change I am making, or this PR is test-exempt.
  • All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

@erdzan12
feat(kotlin_generator.dart): implement screaming snake case conversio…
2a4845f 
…n for enum member names to follow Kotlin naming conventions

test(kotlin_generator_test.dart): update test cases to reflect changes in enum member name conversion
@erdzan12
chore(pigeon): update pigeon package version to 17.0.0 in generator_t…
531f87c 
…ools.dart and pubspec.yaml to reflect new changes

docs(pigeon): update CHANGELOG.md with details of the new version and migration note for users
@erdzan12 erdzan12 requested a review from tarrinneal as a code owner January 18, 2024 02:52
tarrinneal
tarrinneal requested changes Jan 18, 2024
View reviewed changes
Copy link
Contributor

@tarrinneal tarrinneal left a comment

Choose a reason for hiding this comment

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

I think this is a good change, it will need updated integration tests as well though.

Thanks for putting this together.

@erdzan12
refactor(kotlin_generator_test.dart): use original test description f…
35423a7 
…or enum class generation
@erdzan12
feat(kotlin_generator.dart, enum.dart, enum.gen.dart, EnumTest.kt): a…
1fa26d6 
…dd SnakeCase enum member to EnumState

refactor(kotlin_generator.dart): simplify nameScreamingSnakeCase regex replacement logic
test(EnumTest.kt): update test cases to use new SnakeCase enum member for better coverage
@tarrinneal tarrinneal mentioned this pull request Jan 20, 2024
Closed
11 tasks
@tarrinneal
Copy link
Contributor

This shouldn't be passing tests as is, I'll go ahead and generate the new files, format them, and upload them to this pr (assuming the branch isn't preventing that).

@stuartmorgan for tests not failing here.

@erdzan12
Copy link
Contributor Author

erdzan12 commented Feb 7, 2024

I was hesitant regarding the generated files, wanted to check if they would be generated when running the tests here on the CI, as I saw the generated files on my end had lots of changes but only regarding the formatting + a couple of new things regarding the additions

@tarrinneal
Copy link
Contributor

I was hesitant regarding the generated files, wanted to check if they would be generated when running the tests here on the CI, as I saw the generated files on my end had lots of changes but only regarding the formatting + a couple of new things regarding the additions

always good to run the formatting tool after generation to clean things up a bit: https://github.com/flutter/plugins/blob/master_archive/script/tool/README.md#format-code

@tarrinneal
Copy link
Contributor

tarrinneal commented Feb 7, 2024 •
edited
Loading

There should also be a few integration test in packages/pigeon/platform_tests/shared_test_plugin_code/lib/integration_tests.dart that echo's an enum, it would be good to add one of each that sends one of the new members across as well.

@erdzan12
feat(core_tests.gen.dart): add new enum values 'fourtyTwo' and 'fourH…
630191b 
…undredTwentyTwo' to AnEnum to extend test coverage
@erdzan12
fix(core_tests.dart): correct spelling of 'fourtyTwo' to 'fortyTwo' i…
4fd43ee 
…n AnEnum for better code readability and to follow correct English spelling conventions
@tarrinneal
Copy link
Contributor

@stuartmorgan for second review

@tarrinneal tarrinneal force-pushed the enum_scream_snake_case_140938 branch from cda5799 to 679cc3d Compare February 7, 2024 22:16
@tarrinneal
Copy link
Contributor

Sorry for the force push, I accidentally sent up a file I didn't mean to, had to revert that.

tarrinneal
tarrinneal approved these changes Feb 7, 2024
View reviewed changes
Copy link
Contributor

@tarrinneal tarrinneal left a comment

Choose a reason for hiding this comment

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

As long as the tests pass, this lgtm

@stuartmorgan-g
Copy link
Contributor

@stuartmorgan for tests not failing here.

What tests weren't failing that should have been, specifically? There was a Flutter-wide issue where test failures didn't turn the step red, so we can inspect the output manually.

stuartmorgan-g
stuartmorgan-g approved these changes Feb 8, 2024
View reviewed changes
Copy link
Contributor

@stuartmorgan-g stuartmorgan-g left a comment

Choose a reason for hiding this comment

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

LGTM

@stuartmorgan-g
Copy link
Contributor

(Holding off on autosubmit until the test question is resolved in case there's still something going on here that would result in us not seeing issues with this PR in CI.)

@tarrinneal
Copy link
Contributor

(Holding off on autosubmit until the test question is resolved in case there's still something going on here that would result in us not seeing issues with this PR in CI.)

wasn't related to the code itself. There was no updated generated files, but it didn't fail the formatting test.

@tarrinneal tarrinneal added the autosubmit Merge PR when tree becomes green via auto submit App label Feb 9, 2024
@auto-submit auto-submit bot merged commit 90baeee into flutter:main Feb 9, 2024
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Feb 9, 2024
Merged
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Feb 9, 2024
@engine-flutter-autoroll
90baeee [pigeon] Implement Screaming Snake Case Conversion for Kotlin…
13246be 
… Enum Cases (flutter/packages#5918)
auto-submit bot pushed a commit to flutter/flutter that referenced this pull request Feb 9, 2024
@engine-flutter-autoroll
Roll Packages from 29d8cc0 to 11152d2 (4 revisions) (#143217)
03891a4 
flutter/packages@29d8cc0...11152d2

2024-02-09 jsharp83@gmail.com [webview_flutter] Add interface for showing javascript dialog message (flutter/packages#4704)
2024-02-09 32931186+erdzan12@users.noreply.github.com [pigeon] Implement Screaming Snake Case Conversion for Kotlin Enum Cases (flutter/packages#5918)
2024-02-09 43054281+camsim99@users.noreply.github.com [camerax] Small fixes to starting/stopping video capture (flutter/packages#6068)
2024-02-08 engine-flutter-autoroll@skia.org Roll Flutter from 8431cae to eb5d0a4 (33 revisions) (flutter/packages#6079)

If this roll has caused a breakage, revert this CL and stop the roller
using the controls here:
https://autoroll.skia.org/r/flutter-packages-flutter-autoroll
Please CC flutter-ecosystem@google.com,rmistry@google.com on the revert to ensure that a human
is aware of the problem.

To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose

To report a problem with the AutoRoller itself, please file a bug:
https://issues.skia.org/issues/new?component=1389291&template=1850622

Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
@reidbaker reidbaker mentioned this pull request Feb 19, 2024
Merged
16 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@stuartmorgan-g stuartmorgan-g stuartmorgan-g approved these changes

@tarrinneal tarrinneal tarrinneal approved these changes

Assignees
No one assigned
Labels
autosubmit Merge PR when tree becomes green via auto submit App p: pigeon platform-android platform-ios platform-macos platform-windows
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@erdzan12 @tarrinneal @stuartmorgan-g