canvas-lms/gems/activesupport-suspend_callb...
James Williams 7423e4fb94 rails 5.2
closes #CORE-1301 #CORE-1302

Change-Id: I687132b066d12cf35e3c7a593dff9b2a91337f33
Reviewed-on: https://gerrit.instructure.com/147220
Reviewed-by: Cody Cutrer <cody@instructure.com>
Tested-by: Jenkins
Product-Review: James Williams  <jamesw@instructure.com>
QA-Review: James Williams  <jamesw@instructure.com>
2018-04-25 19:15:20 +00:00
..
lib/active_support/callbacks rails 5.1: activesupport-suspend_callbacks 2017-06-16 13:44:08 +00:00
spec da licença part 53 2017-05-01 21:06:11 +00:00
.rspec ActiveSupport::Callbacks::Suspension 2014-02-19 20:20:00 +00:00
Gemfile bump simplecov, fixes SD-2056 2017-04-04 18:06:25 +00:00
LICENSE.txt da licença part 53 2017-05-01 21:06:11 +00:00
README.md ActiveSupport::Callbacks::Suspension 2014-02-19 20:20:00 +00:00
Rakefile ActiveSupport::Callbacks::Suspension 2014-02-19 20:20:00 +00:00
activesupport-suspend_callbacks.gemspec rails 5.2 2018-04-25 19:15:20 +00:00
test.sh simplify gem test harnesses 2016-01-19 17:52:58 +00:00

README.md

Suspend Callbacks

ActiveSupport's Callbacks module allows you to define a callback hook and then register methods to be run before/after/around that hook.

It also let's you skip callbacks in a specific context. For example, ActiveRecord::Base defines a callback hook around save. My top level Person model may register an :ensure_privacy method to run before save. But the Celebrity model that inherits from Person can then skip that callback. End result: when I save a john_doe Person object, :ensure_privacy will run, but when I save the dhh Celebrity object, it won't.

But what if you want to suspend callbacks, regardless of subclass, but only for a duration of time? That's when you want to suspend callbacks.

Example

class MyModel < ActiveRecord::Base include ActiveSupport::Callbacks::Suspension

before :save, :expensive_callback after :save, :other_callback

def expensive_callback # stuff end

def other_callback # stuff end end

instance1 = MyModel.new instance2 = MyModel.new

MyModel.suspend_callbacks do

neither callback will run for either instance

instance1.save instance2.save end

MyModel.suspend_callbacks(kind: :save) do

same

instance1.save instance2.save end

MyModel.suspend_callbacks(:expensive_callback) do

expensive_callback won't run, but other_callback will

instance1.save instance2.save end

MyModel.suspend_callbacks(type: :before) do

same

instance1.save instance2.save end

instance1.suspend_callbacks do

callbacks won't run this time...

instance1.save

... but they will this time.

instance2.save end