Skip to content
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

fix(developer): correct handling of trailing spaces by GetDelimitedString() in kmcmplib compiler #11938

Merged
merged 18 commits into from
Jul 23, 2024
Merged

fix(developer): correct handling of trailing spaces by GetDelimitedString() in kmcmplib compiler #11938

merged 18 commits into from
Jul 23, 2024

Conversation

markcsinclair
Copy link
Contributor

@markcsinclair markcsinclair commented Jul 8, 2024 •
edited
Loading

Fix GetDelimitedString() to correctly handle trailing spaces

Fixes: #11937

Tests for GetDelimitedString() in gtest-compiler-test.cpp

@keymanapp-test-bot skip

@keymanapp-test-bot
Copy link

keymanapp-test-bot bot commented Jul 8, 2024 •
edited
Loading

User Test Results

Test specification and instructions

User tests are not required

@keymanapp-test-bot keymanapp-test-bot bot added this to the A18S6 milestone Jul 8, 2024
@markcsinclair markcsinclair marked this pull request as draft July 8, 2024 15:46
@markcsinclair markcsinclair self-assigned this Jul 8, 2024
@markcsinclair
fix(developer): add multi-character and leading space test cases
1ac8b8f
@markcsinclair
fix(developer): add test cases for spaces before argument
e00eb1b
@markcsinclair
fix(developer): delete close delimiter when there are trailing spaces…
4a9c459 
…, plus test cases
@markcsinclair
fix(developer): add test cases for spaces after the close delimiter
7e572e2
@markcsinclair
fix(developer): add spaces before and after close delimiter case, plu…
2c0fab3 
…s several no flags cases
@markcsinclair
fix(developer): add comment
2b4bd1c
@markcsinclair
fix(developer): add documentation comment to GetDelimitedString()
0b548a1
@markcsinclair
fix(developer): add multi-word test case
cdb8fad
@markcsinclair
chore(developer): Merge branch 'master' into fix/developer/11937-corr…
1d1ff90 
…ect-handling-of-trailing-spaces-by-GetDelimitedString

# Keyman Conventional Commit suggestions:
#
# - Link to a Sentry issue with git trailer:
#     Fixes: _MODULE_-_ID_
# - Give credit to co-authors:
#     Co-authored-by: _Name_ <_email_>
# - Use imperative, present tense ('attach' not 'attaches', 'attached' etc)
# - Don't include a period at the end of the title
# - Always include a blank line before trailers
# - More: https://github.com/keymanapp/keyman/wiki/Pull-Request-and-Commit-workflow-notes
@markcsinclair
Copy link
Contributor Author

Ready for review.

Once merged, this should fix four commented-out test cases in #11663

@markcsinclair markcsinclair marked this pull request as ready for review July 9, 2024 11:17
@darcywong00 darcywong00 modified the milestones: A18S6, A18S7 Jul 19, 2024
@markcsinclair
chore(developer): Merge branch 'master' into fix/developer/11937-corr…
7db16a3 
…ect-handling-of-trailing-spaces-by-GetDelimitedString

# Keyman Conventional Commit suggestions:
#
# - Link to a Sentry issue with git trailer:
#     Fixes: _MODULE_-_ID_
# - Give credit to co-authors:
#     Co-authored-by: _Name_ <_email_>
# - Use imperative, present tense ('attach' not 'attaches', 'attached' etc)
# - Don't include a period at the end of the title
# - Always include a blank line before trailers
# - More: https://github.com/keymanapp/keyman/wiki/Pull-Request-and-Commit-workflow-notes
mcdurdin
mcdurdin approved these changes Jul 23, 2024
View reviewed changes
Copy link
Member

@mcdurdin mcdurdin left a comment

Choose a reason for hiding this comment

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

LGTM

@markcsinclair
chore(developer): Merge branch 'master' into fix/developer/11937-corr…
ca6f197 
…ect-handling-of-trailing-spaces-by-GetDelimitedString

# Keyman Conventional Commit suggestions:
#
# - Link to a Sentry issue with git trailer:
#     Fixes: _MODULE_-_ID_
# - Give credit to co-authors:
#     Co-authored-by: _Name_ <_email_>
# - Use imperative, present tense ('attach' not 'attaches', 'attached' etc)
# - Don't include a period at the end of the title
# - Always include a blank line before trailers
# - More: https://github.com/keymanapp/keyman/wiki/Pull-Request-and-Commit-workflow-notes
@markcsinclair
fix(developer): expanded some test comments
e94fac1
@markcsinclair
fix(developer): eight test cases for spaces in empty argument for Get…
2a7b10d 
…DelimitedString(), plus corresponding fix
@markcsinclair
fix(developer): remove unnecessary commented out debug code
bac6adb
@markcsinclair
fix(developer): edited for layout consistency
76384a1
@markcsinclair
Copy link
Contributor Author

An additional bug in the handling of spaces, but no argument, in the delimited string was identified in using test cases that had been previously commented out in #11663. This has required an additional one-line fix, and eight supporting test cases.

@markcsinclair markcsinclair merged commit 1449f13 into master Jul 23, 2024
4 checks passed
@markcsinclair markcsinclair deleted the fix/developer/11937-correct-handling-of-trailing-spaces-by-GetDelimitedString branch July 23, 2024 18:58
@mcdurdin
Copy link
Member

mcdurdin commented Jul 24, 2024 •
edited
Loading

An additional bug in the handling of spaces, but no argument, in the delimited string was identified in using test cases that had been previously commented out in #11663. This has required an additional one-line fix, and eight supporting test cases.

Process note: generally, if you make significant changes to a PR following a review, it should either be re-reviewed or the changes should be added to a follow-up PR. We try to keep changes post-approval of a PR to nits only.

I have reviewed those changes and they LGTM.

@markcsinclair
Copy link
Contributor Author

It's a fair cop, Your Honour! I had hoped to get these interlinked PRs merged in the short gap between your return and my departure to holiday, and so pushed past what I know to be good practice - sorry.

@mcdurdin
Copy link
Member

No worries mate, all good 😁

markcsinclair added a commit that referenced this pull request Jul 24, 2024
@markcsinclair
chore(developer): uncomment two test cases due to compiler fixes #11910…
d1be0f2 
…, #11938, plus correct a test case comment
@markcsinclair markcsinclair mentioned this pull request Jul 24, 2024
Merged
@keyman-server
Copy link
Collaborator

Changes in this pull request will be available for download in Keyman version 18.0.74-alpha

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mcdurdin mcdurdin mcdurdin approved these changes

@darcywong00 darcywong00 Awaiting requested review from darcywong00 darcywong00 is a code owner

Assignees

@markcsinclair markcsinclair

Labels
developer/compilers/ developer/ fix
Projects
None yet
Milestone
A18S7
Development

Successfully merging this pull request may close these issues.

bug(developer): incorrect handling of trailing spaces by GetDelimitedString() in kmcmplib compiler
4 participants
@markcsinclair @mcdurdin @keyman-server @darcywong00