Skip to content

[RF-DOCS] Active Record Callbacks #51654

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 91 commits into from
Jun 10, 2024
Merged

[RF-DOCS] Active Record Callbacks #51654

merged 91 commits into from
Jun 10, 2024

Conversation

Ridhwana
Copy link
Contributor

Motivation / Background

This Pull Request has been created to provide more clarity and update the Active Record Callbacks documentation.

Detail

This guide has probably been reviewed multiple times over time, so we can do a quick pass to see where we can make things clearer, simpler, and/or more concise.

Some initial thoughts to get started:

  • Samples that use Proc.new {} can likely be simplified to just use proc {}
  • Link to the validations guide where we mention it under conditional callbacks
  • after_find callbacks are also triggered by a few other methods: take, sole, find_by!
  • We could potentially add some more examples on different types of callbacks that aren't there.
  • Updated some sections for clarity

Checklist

Before submitting the PR make sure the following are checked:

  • This Pull Request is related to one change. Unrelated changes should be opened in separate PRs.
  • Commit message has a detailed description of what changed and why. If this PR fixes a related issue include it in the commit message. Ex: [Fix #issue-number]
  • Tests are added or updated if you fix a bug or add a feature.
  • CHANGELOG files are updated for the changed libraries if there is a behavior change or additional feature. Minor bug fixes and documentation changes should not be included.

Ridhwana and others added 30 commits March 28, 2024 13:16
@Ridhwana
base changes from the old PR
82eff47
@Ridhwana
rename callback classes to callback objects
1b57299
@Ridhwana
remove instance var
7e93965
@Ridhwana
oxford comma
3afdb97
@Ridhwana
updates as per suggestions
924f991
@Ridhwana
explain the use cases of callbacks
b1861ff
@Ridhwana
move the sentence below the code example
4f67b16
@Ridhwana
update the transactional callback ordering
d86f104
@Ridhwana
updates based on feedback
6009818
@Ridhwana
header guidelines
8f3fe46
@Ridhwana
column count
9854629
@Ridhwana
summary of the guide
7fb8b6a
@Ridhwana
move callback objects to the end
2e1c5d8
@Ridhwana
collumn count
482e198
@Ridhwana
make some small tweaks to the documentation
0c295cb
@Ridhwana @p8
Update guides/source/active_record_callbacks.md
9e7f924 
Co-authored-by: Petrik de Heus <petrik@deheus.net>
@Ridhwana @p8
Update guides/source/active_record_callbacks.md
fb86d3d 
Co-authored-by: Petrik de Heus <petrik@deheus.net>
@Ridhwana @p8
Update guides/source/active_record_callbacks.md
2d2d618 
Co-authored-by: Petrik de Heus <petrik@deheus.net>
@Ridhwana @p8
Update guides/source/active_record_callbacks.md
039fd2e 
Co-authored-by: Petrik de Heus <petrik@deheus.net>
@Ridhwana @p8
Update guides/source/active_record_callbacks.md
91a2948 
Co-authored-by: Petrik de Heus <petrik@deheus.net>
@Ridhwana @p8
Update guides/source/active_record_callbacks.md
18c2bc3 
Co-authored-by: Petrik de Heus <petrik@deheus.net>
@Ridhwana @p8
Update guides/source/active_record_callbacks.md
f7a2eee 
Co-authored-by: Petrik de Heus <petrik@deheus.net>
@Ridhwana @p8
Update guides/source/active_record_callbacks.md
2821627 
Co-authored-by: Petrik de Heus <petrik@deheus.net>
@Ridhwana @p8
Update guides/source/active_record_callbacks.md
7308c8a 
Co-authored-by: Petrik de Heus <petrik@deheus.net>
@Ridhwana @p8
Update guides/source/active_record_callbacks.md
26a22f4 
Co-authored-by: Petrik de Heus <petrik@deheus.net>
@Ridhwana
add before to relation
3c12c32
@Ridhwana
replace puts with Rails.logger.info
7a3e44c
@Ridhwana
change single quotes to double quotes
cb1b471
@Ridhwana
change the method name to not include normalize
9501158
@Ridhwana
add a note about valid?
5dbbe0b
@Ridhwana Ridhwana requested a review from p8 June 7, 2024 05:23
p8
p8 reviewed Jun 7, 2024
View reviewed changes
guides/source/active_record_callbacks.md Outdated
NOTE: If an `ActiveRecord::RecordNotDestroyed` is raised within `after_destroy`, `before_destroy` or `around_destroy` callback, it will not be re-raised and the `destroy` method will return `false`.
NOTE: If an `ActiveRecord::RecordNotDestroyed` is raised within `after_destroy`,
`before_destroy` or `around_destroy` callback, it will not be re-raised and the
`destroy` method will return `false`.

Relational Callbacks
Copy link
Member

Choose a reason for hiding this comment

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

I think "Cascading Association Callbacks" is a great title.
These changes are really nice.

@p8 p8 merged commit 78d6559 into rails:main Jun 10, 2024
3 checks passed
@p8 p8 deleted the Ridhwana/active-record-callbacks-documentation branch June 10, 2024 07:18
@sampatbadhe sampatbadhe mentioned this pull request Jun 11, 2024
Merged
rafaelfranca pushed a commit that referenced this pull request Jun 12, 2024
@Ridhwana @p8
@carlosantoniodasilva @hatsu38 @rafaelfranca
[RF-DOCS] Active Record Callbacks (#51654)
b1ab13e 
Review and improve Action View Overview guide. [ci-skip]

* Samples that use Proc.new {} can likely be simplified to just use proc {}
* Link to the validations guide where we mention it under conditional callbacks
* after_find callbacks are also triggered by a few other methods: take, sole, find_by!
* We could potentially add some more examples on different types of callbacks that aren't there.
* Updated some sections for clarity

Co-authored-by: Petrik de Heus <petrik@deheus.net>
Co-authored-by: Carlos Antonio da Silva <carlosantoniodasilva@gmail.com>
Co-authored-by: hatsu <hajiwata0308@gmail.com>
Set2005 pushed a commit to Set2005/fix-association-initialize-order that referenced this pull request Jul 8, 2024
@Ridhwana @p8
@carlosantoniodasilva @hatsu38
[RF-DOCS] Active Record Callbacks (rails#51654)
d8b6d91 
Review and improve Action View Overview guide. [ci-skip]

* Samples that use Proc.new {} can likely be simplified to just use proc {}
* Link to the validations guide where we mention it under conditional callbacks
* after_find callbacks are also triggered by a few other methods: take, sole, find_by!
* We could potentially add some more examples on different types of callbacks that aren't there.
* Updated some sections for clarity

Co-authored-by: Petrik de Heus <petrik@deheus.net>
Co-authored-by: Carlos Antonio da Silva <carlosantoniodasilva@gmail.com>
Co-authored-by: hatsu <hajiwata0308@gmail.com>
DanielaVelasquez pushed a commit to DanielaVelasquez/rails that referenced this pull request Oct 3, 2024
@Ridhwana @p8
@carlosantoniodasilva @hatsu38 @DanielaVelasquez
[RF-DOCS] Active Record Callbacks (rails#51654)
888802b 
Review and improve Action View Overview guide. [ci-skip]

* Samples that use Proc.new {} can likely be simplified to just use proc {}
* Link to the validations guide where we mention it under conditional callbacks
* after_find callbacks are also triggered by a few other methods: take, sole, find_by!
* We could potentially add some more examples on different types of callbacks that aren't there.
* Updated some sections for clarity

Co-authored-by: Petrik de Heus <petrik@deheus.net>
Co-authored-by: Carlos Antonio da Silva <carlosantoniodasilva@gmail.com>
Co-authored-by: hatsu <hajiwata0308@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@p8 p8 p8 left review comments

@tadas-s tadas-s tadas-s left review comments

@hatsu38 hatsu38 hatsu38 left review comments

@MatheusRich MatheusRich MatheusRich left review comments

@akhilgkrishnan akhilgkrishnan akhilgkrishnan left review comments

@brunoprietog brunoprietog brunoprietog left review comments

@b-sep b-sep b-sep left review comments

@carlosantoniodasilva carlosantoniodasilva Awaiting requested review from carlosantoniodasilva

Assignees

@carlosantoniodasilva carlosantoniodasilva

Labels
docs rails foundation Rails Foundation PRs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
10 participants
@Ridhwana @carlosantoniodasilva @p8 @tadas-s @hatsu38 @MatheusRich @akhilgkrishnan @brunoprietog @b-sep @AmandaPerino