hk2166 opened a new pull request, #16778:
URL: https://github.com/apache/grails-core/pull/16778
## Description
This follows up #16776, which adds a **Dirty Checking and Abstract Base
Classes** section to the Hibernate 5 and MongoDB guides on 7.0.x. The Hibernate
7 guide
(`grails-data-hibernate7/docs/.../persistenceBasics/modificationChecking.adoc`)
only exists on 8.x, so the merge up cannot reach it. This PR adds the same
section there.
Hibernate 7 behaves the same way, so the text is the same as in #16776. The
only difference is that it uses this page's `dirtyPropertyNames` property style:
- `@DirtyCheck` is handled by `DirtyCheckingTransformer` in
`grails-datamapping-core`, which all datastores share. It only instruments the
setters declared in the class it transforms, unless the parent is a domain
class or carries `@DirtyCheck`.
- `GrailsEntityDirtinessStrategy` in `grails-data-hibernate7` treats a
managed instance as dirty only when `hasChanged()` says so, and checks each
attribute with `hasChanged(name)`. A change to an untracked inherited property
therefore isn't saved on its own.
### Verification
- `./gradlew :grails-data-hibernate7-docs:asciidoctor` builds successfully.
None of the AsciiDoctor warnings it prints concern `modificationChecking.adoc`;
they come from other pages (`criteria.adoc`, `whereQueries.adoc`,
`eventsAutoTimestamping.adoc`, …). The new section contains no cross-references.
- The generated `persistenceBasics/modificationChecking.html` shows the new
section with its heading, the explanation, the `@DirtyCheck` example and both
notes.
Together with #16776, this fixes #14185.
Fixes #14185
Generative AI tooling (Claude Code) was used to research the behaviour in
the code and prepare this change.
## Contributor Checklist
Please review the following checklist before submitting your pull request.
Pull requests that do not meet these requirements may be closed without review.
### Issue and Scope
- [x] This PR is linked to an existing issue that has been **acknowledged or
approved** by the project team. If no approved issue exists, please give
background on why this change is necessary. Tickets are preferred for release
change log history.
- [x] This PR addresses the **complete scope** of the linked issue. Partial
implementations or unfinished work should not be submitted for review.
*(Together with #16776, which covers the Hibernate 5 and MongoDB guides.)*
- [x] This PR contains a **single, focused change**. Unrelated changes
should be submitted as separate pull requests.
- [x] This PR targets the **correct branch** for the type of change:
- **Patch release branches** (e.g., `7.0.x`): Bug fixes only. No new
features or API changes.
- **Minor release branches** (e.g., `7.1.x`): New features are welcome,
but breaking existing APIs must be avoided.
- **Major release branches** (e.g., `8.0.x`): Reserved for major
changes. Breaking API changes are permitted.
### Code Quality
- [ ] I have **added or updated tests** that cover the changes introduced in
this PR. All code contributions are expected to include appropriate test
coverage. *(Documentation-only change; verified by building the guide, see
above.)*
- [ ] I have verified that all existing tests pass by running `./gradlew
build --rerun-tasks`. *(Not run; documentation-only change.)*
- [ ] My code follows the project's **code style** guidelines. I have run
`./gradlew codeStyle` and resolved any violations. See [Code
Style](../CONTRIBUTING.md#code-style) for details. *(Not applicable to `.adoc`
files.)*
- [x] This PR does **not** include mass reformatting, style-only changes, or
large-scale refactoring unless it was **explicitly approved** in the linked
issue. Unsolicited reformatting will not be accepted.
- [x] If generative AI tooling was used in preparing this contribution, a
quality model was used to ensure contributions are **consistent with the
project's quality standards**.
### Licensing and Attribution
- [x] All contributed code is provided under the [Apache License
2.0](https://www.apache.org/licenses/LICENSE-2.0), and new source files include
the appropriate **Apache license header**.
- [ ] I have the necessary rights to submit this contribution and confirm it
is my own original work (see [Legal
Notice](../CONTRIBUTING.md#i-want-to-contribute)).
- [x] If generative AI tooling was used in preparing this contribution, I
have followed the [Apache Software Foundation's policy on generative
tooling](https://www.apache.org/legal/generative-tooling.html) and have
properly attributed its use.
### Documentation
- [x] If this PR introduces user-facing changes, I have included or updated
the relevant documentation.
- [x] If this PR adds a new feature, I have updated the **What's New**
section of the Grails Guide.
- [x] If this PR introduces breaking changes or changes that require user
action during an upgrade, I have updated the **Upgrade Notes** for the
corresponding version in the Grails Guide.
- [x] The PR description clearly explains **what** was changed and **why**.
---
> **First-time contributors:** Please read our [Contributing
Guide](../CONTRIBUTING.md) before submitting.
> Pull requests that appear to be auto-generated, incomplete, or unrelated
to an approved issue may be
> closed to help maintainers focus on reviewed and planned work. We
appreciate your understanding.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
