History

Simon Williams 359c6dea13 upgrade many canvas gems to rspec 3 syntax as of this commit, all canvas gems should be on rspec 3.5, and pass without deprecation warnings. closes CNVS-34040 test plan: specs should pass without deprecation warnings Change-Id: I556b1a4a5aeb791c6ddd50ee35b51c513e025019 Reviewed-on: https://gerrit.instructure.com/98414 Reviewed-by: Landon Wilkins <lwilkins@instructure.com> Product-Review: Landon Wilkins <lwilkins@instructure.com> QA-Review: Landon Wilkins <lwilkins@instructure.com> Tested-by: Jenkins		2016-12-27 18:44:23 +00:00
..
lib/active_support/callbacks	make activesupport-suspend_callbacks threadsafe	2016-12-09 23:31:41 +00:00
spec	remove mocha from several canvas gems	2016-12-27 18:18:38 +00:00
.rspec	ActiveSupport::Callbacks::Suspension	2014-02-19 20:20:00 +00:00
Gemfile	remove rails 3 support	2015-12-23 21:36:43 +00:00
LICENSE.txt	ActiveSupport::Callbacks::Suspension	2014-02-19 20:20:00 +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	upgrade many canvas gems to rspec 3 syntax	2016-12-27 18:44:23 +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