Module: Mongoid::Interceptable
- Extended by:
- ActiveSupport::Concern
- Included in:
- Composable
- Defined in:
- lib/mongoid/interceptable.rb
Overview
This module contains all the callback hooks for Mongoid.
Constant Summary collapse
- CALLBACKS =
[ :after_build, :after_create, :after_destroy, :after_find, :after_initialize, :after_save, :after_touch, :after_update, :after_upsert, :after_validation, :around_create, :around_destroy, :around_save, :around_update, :around_upsert, :before_create, :before_destroy, :before_save, :before_update, :before_upsert, :before_validation, ].freeze
Instance Method Summary collapse
-
#_mongoid_run_child_callbacks(kind, children: nil, &block) ⇒ Object
private
Run the callbacks for embedded documents.
-
#callback_executable?(kind) ⇒ true | false
Is the provided type of callback executable by this document?.
-
#in_callback_state?(kind) ⇒ true | false
Is the document currently in a state that could potentially require callbacks to be executed?.
-
#pending_callbacks ⇒ Array<Symbol>
private
Returns the stored callbacks to be executed later.
-
#pending_callbacks=(value) ⇒ Array<Symbol>
private
Stores callbacks to be executed later.
-
#run_after_callbacks(*kinds) ⇒ Object
Run only the after callbacks for the specific event.
-
#run_before_callbacks(*kinds) ⇒ Object
Run only the before callbacks for the specific event.
-
#run_callbacks(kind, with_children: true, skip_if: nil, &block) ⇒ Object
Run the callbacks for the document.
-
#run_pending_callbacks ⇒ Object
private
Run the pending callbacks.
Instance Method Details
#_mongoid_run_child_callbacks(kind, children: nil, &block) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Run the callbacks for embedded documents.
151 152 153 154 155 156 157 158 159 160 161 162 163 |
# File 'lib/mongoid/interceptable.rb', line 151 def _mongoid_run_child_callbacks(kind, children: nil, &block) child, *tail = (children || cascadable_children(kind)) with_children = !Mongoid::Config. if child.nil? block&.call elsif tail.empty? child.run_callbacks(child_callback_type(kind, child), with_children: with_children, &block) else child.run_callbacks(child_callback_type(kind, child), with_children: with_children) do _mongoid_run_child_callbacks(kind, children: tail, &block) end end end |
#callback_executable?(kind) ⇒ true | false
Is the provided type of callback executable by this document?
60 61 62 |
# File 'lib/mongoid/interceptable.rb', line 60 def callback_executable?(kind) respond_to?("_#{kind}_callbacks") end |
#in_callback_state?(kind) ⇒ true | false
Is the document currently in a state that could potentially require callbacks to be executed?
73 74 75 |
# File 'lib/mongoid/interceptable.rb', line 73 def in_callback_state?(kind) [ :create, :destroy ].include?(kind) || new_record? || flagged_for_destroy? || changed? end |
#pending_callbacks ⇒ Array<Symbol>
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Returns the stored callbacks to be executed later.
170 171 172 |
# File 'lib/mongoid/interceptable.rb', line 170 def pending_callbacks @pending_callbacks ||= [].to_set end |
#pending_callbacks=(value) ⇒ Array<Symbol>
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Stores callbacks to be executed later. A good use case for this is delaying the after_find and after_initialize callbacks until the associations are set on the document. This can also be used to delay applying the defaults on a document.
184 185 186 |
# File 'lib/mongoid/interceptable.rb', line 184 def pending_callbacks=(value) @pending_callbacks = value end |
#run_after_callbacks(*kinds) ⇒ Object
ActiveSupport does not allow this type of behavior by default, so Mongoid has to get around it and implement itself.
Run only the after callbacks for the specific event.
88 89 90 91 92 |
# File 'lib/mongoid/interceptable.rb', line 88 def run_after_callbacks(*kinds) kinds.each do |kind| run_targeted_callbacks(:after, kind) end end |
#run_before_callbacks(*kinds) ⇒ Object
ActiveSupport does not allow this type of behavior by default, so Mongoid has to get around it and implement itself.
Run only the before callbacks for the specific event.
105 106 107 108 109 |
# File 'lib/mongoid/interceptable.rb', line 105 def run_before_callbacks(*kinds) kinds.each do |kind| run_targeted_callbacks(:before, kind) end end |
#run_callbacks(kind, with_children: true, skip_if: nil, &block) ⇒ Object
Run the callbacks for the document. This overrides active support’s functionality to cascade callbacks to embedded documents that have been flagged as such.
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 |
# File 'lib/mongoid/interceptable.rb', line 125 def run_callbacks(kind, with_children: true, skip_if: nil, &block) if skip_if&.call return block&.call end if with_children cascadable_children(kind).each do |child| if child.run_callbacks(child_callback_type(kind, child), with_children: with_children) == false return false end end end if callback_executable?(kind) super(kind, &block) else true end end |
#run_pending_callbacks ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Run the pending callbacks. If the callback is :apply_defaults, we will apply the defaults for this document. Otherwise, the callback is passed to the run_callbacks function.
193 194 195 196 197 198 199 200 201 202 |
# File 'lib/mongoid/interceptable.rb', line 193 def run_pending_callbacks pending_callbacks.each do |cb| if [:apply_defaults, :apply_post_processed_defaults].include?(cb) send(cb) else self.run_callbacks(cb, with_children: false) end end pending_callbacks.clear end |