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.

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

dev/core#4999 [REF] - Extract some methods from CodeGen into a utility class #29364

Merged
merged 1 commit into from
Feb 12, 2024

Conversation

colemanw
Copy link
Member

Overview

Small step toward https://lab.civicrm.org/dev/core/-/issues/4999
Function extraction makes CodeGen more readable, and the methods reusable.

Technical Details

The one functional change that's not a straight extraction is to return actual booleans for the 'usage' items (e.g. usage.import = true instead of usage.import = "TRUE"). This makes the function more sane to use and adapting the .tpl was simple. It'll probably invalidate all the checksums and require regenerating all DAO files... sigh.

This makes CodeGen more readable, and the methods reusable
Copy link

civibot bot commented Feb 11, 2024

🤖 Thank you for contributing to CiviCRM! ❤️ We will need to test and review this PR. 👷

Introduction for new contributors...
  • If this is your first PR, an admin will greenlight automated testing with the command ok to test or add to whitelist.
  • A series of tests will automatically run. You can see the results at the bottom of this page (if there are any problems, it will include a link to see what went wrong).
  • A demo site will be built where anyone can try out a version of CiviCRM that includes your changes.
  • If this process needs to be repeated, an admin will issue the command test this please to rerun tests and build a new demo site.
  • Before this PR can be merged, it needs to be reviewed. Please keep in mind that reviewers are volunteers, and their response time can vary from a few hours to a few weeks depending on their availability and their knowledge of this particular part of CiviCRM.
  • A great way to speed up this process is to "trade reviews" with someone - find an open PR that you feel able to review, and leave a comment like "I'm reviewing this now, could you please review mine?" (include a link to yours). You don't have to wait for a response to get started (and you don't have to stop at one!) the more you review, the faster this process goes for everyone 😄
  • To ensure that you are credited properly in the final release notes, please add yourself to contributor-key.yml
  • For more information about contributing, see CONTRIBUTING.md.
Quick links for reviewers...

➡️ Online demo of this PR 🔗

@civibot civibot bot added the master label Feb 11, 2024
Copy link

civibot bot commented Feb 11, 2024

The issue associated with the Pull Request can be viewed at https://lab.civicrm.org/dev/core/-/issues/4999

@totten
Copy link
Member

totten commented Feb 12, 2024

IMHO, the safety of this change is demonstrated simply by running ./bin/setup.sh -g && git diff -- it still produces the same output!

There may be some juggling w/other PRs since it affects the hash. We should try to minimize the timeframe where master has old hashes (because it makes weird artifacts on dev builds).

@totten totten added the merge ready PR will be merged after a few days if there are no objections label Feb 12, 2024
@colemanw colemanw merged commit 26a870a into civicrm:master Feb 12, 2024
3 checks passed
@colemanw colemanw deleted the codeGenExt branch February 12, 2024 02:38
@totten totten mentioned this pull request Feb 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
master merge ready PR will be merged after a few days if there are no objections
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants