synkarius commented 3 years ago

fix words.txt transformer bug

Description

The words.txt transformer had some logic built into it which was intended to protect the user from accidentally altering required extras. That logic prevented users from doing any replacements with extras in them. This change fixes that while still protecting users against altering required extras.

How Has This Been Tested

Unit tests are included. I also tested it manually.

Types of changes

[x] Bug fix (non-breaking change which fixes an issue or bug)

Checklist

[ ] I have read the CONTRIBUTING document.
[ ] My code follows the code style of this project.
[ ] I have checked that my code does not duplicate functionality elsewhere in Caster.
[ ] I have checked for and utilized existing command phrases from within Caster (delete if not applicable).
[ ] My code implements all the features I wish to merge in this pull request.
[ ] My change requires a change to the documentation.
[ ] I have updated the documentation accordingly.
[x] I have added tests to cover my changes.
[x] All new and existing tests pass.

Maintainer/Reviewer Checklist

[x] Basic functionality has been tested and works as claimed.
[ ] New documentation is clear and complete.
[x] Code is clear and readable.

LexiconCode commented 3 years ago

Tested with the following commands. Everything functions as expected.

peek [<big>] format -> [<big>] my test
spark [<nnavi500>] [(<capitalization> <spacing> | <capitalization> | <spacing>) [(bow|bowel)]] -> ghost [<nnavi500>] [(<capitalization> <spacing> | <capitalization> | <spacing>) [(bow|bowel)]]
(tell | tau) <semi> -> my you <semi>

Testing removing optional's.

spark [<nnavi500>] [(<capitalization> <spacing> | <capitalization> | <spacing>) [(bow|bowel)]] -> ghost [<nnavi500>]
spark [<nnavi500>] [(<capitalization> <spacing> | <capitalization> | <spacing>) [(bow|bowel)]] -> ghost me

testing removing non optional

(tell | tau) <semi> -> my you
Illegal spec modification: cannot alter required extras. Cannot modify semi in "(tell | tau) <semi>".

Transforming to an invalid extra mycategory that is not referenced in the grammar.

(tell | tau) <semi> -> my you <mycategory>
Illegal spec modification: cannot alter required extras. Cannot modify semi in "(tell | tau) <semi>".

My only improvement here would be to make sure the extra stands out in the error message. Cannot modify <semi> in "(tell | tau) <semi>".

May not be worth it's time to distinguish between in the error messages removing an extra and modifying an extra that's required.

@synkarius Let me know when you're ready and it can be merged.