Added ability to temporarily disable callbacks - closes #35

Andrew Kane
2 parents 94f7ff37 d43b42b0
Showing 5 changed files with 85 additions and 12 deletions Show diff stats
CHANGELOG.md
README.md
lib/searchkick.rb
lib/searchkick/model.rb
test/model_test.rb
 ## 0.4.2 [unreleased]
 - Added `should_index?` method to control which records are indexed
+- Added ability to temporarily disable callbacks
 ## 0.4.1
@@ -537,7 +537,7 @@ class Product &lt; ActiveRecord::Base
 end
 ```
-Turn off callbacks
+Turn off callbacks permanently
 ```ruby
 class Product < ActiveRecord::Base
@@ -545,6 +545,15 @@ class Product &lt; ActiveRecord::Base
 end
 ```
+or temporarily [master branch]
+
+```ruby
+Product.disable_search_callbacks # use Searchkick.disable_callbacks for all models
+ExpensiveProductsTask.execute
+Product.enable_search_callbacks
+Product.reindex
+```
+
 Eager load associations
 ```ruby
@@ -8,6 +8,22 @@ require &quot;searchkick/model&quot;
 require "searchkick/tasks"
 require "searchkick/logger" if defined?(Rails)
+module Searchkick
+  @callbacks = true
+
+  def self.enable_callbacks
+    @callbacks = true
+  end
+
+  def self.disable_callbacks
+    @callbacks = false
+  end
+
+  def self.callbacks?
+    @callbacks
+  end
+end
+
 # TODO find better ActiveModel hook
 ActiveModel::Callbacks.send(:include, Searchkick::Model)
 ActiveRecord::Base.send(:extend, Searchkick::Model) if defined?(ActiveRecord)
@@ -8,6 +8,7 @@ module Searchkick
         class_variable_set :@@searchkick_options, options.dup
         class_variable_set :@@searchkick_env, ENV["RACK_ENV"] || ENV["RAILS_ENV"] || "development"
         class_variable_set :@@searchkick_klass, self
+        class_variable_set :@@searchkick_callbacks, options[:callbacks] != false
         # set index name
         # TODO support proc
@@ -18,25 +19,36 @@ module Searchkick
         extend Searchkick::Reindex
         include Searchkick::Similar
+        after_save :reindex
+        after_destroy :reindex
+
+        def self.enable_search_callbacks
+          class_variable_set :@@searchkick_callbacks, true
+        end
+
+        def self.disable_search_callbacks
+          class_variable_set :@@searchkick_callbacks, false
+        end
+
+        def self.search_callbacks?
+          class_variable_get(:@@searchkick_callbacks) && Searchkick.callbacks?
+        end
+
         def should_index?
           true
         end
         def reindex
-          index = self.class.searchkick_index
-          if destroyed? or !should_index?
-            index.remove self
-          else
-            index.store self
+          if self.class.search_callbacks?
+            index = self.class.searchkick_index
+            if destroyed? or !should_index?
+              index.remove self
+            else
+              index.store self
+            end
           end
         end
-        unless options[:callbacks] == false
-          # TODO ability to temporarily disable
-          after_save :reindex
-          after_destroy :reindex
-        end
-
         def search_data
           respond_to?(:to_hash) ? to_hash : serializable_hash
         end
@@ -0,0 +1,35 @@
+require_relative "test_helper"
+
+class TestModel < Minitest::Unit::TestCase
+
+  def test_disable_callbacks_model
+    store_names ["product a"]
+
+    Product.disable_search_callbacks
+    assert !Product.search_callbacks?
+
+    store_names ["product b"]
+    assert_search "product", ["product a"]
+
+    Product.enable_search_callbacks
+    Product.reindex
+
+    assert_search "product", ["product a", "product b"]
+  end
+
+  def test_disable_callbacks_global
+    store_names ["product a"]
+
+    Searchkick.disable_callbacks
+    assert !Searchkick.callbacks?
+
+    store_names ["product b"]
+    assert_search "product", ["product a"]
+
+    Searchkick.enable_callbacks
+    Product.reindex
+
+    assert_search "product", ["product a", "product b"]
+  end
+
+end
1	## 0.4.2 [unreleased]	1	## 0.4.2 [unreleased]
2		2
3	- Added `should_index?` method to control which records are indexed	3	- Added `should_index?` method to control which records are indexed
		4	+- Added ability to temporarily disable callbacks
4		5
5	## 0.4.1	6	## 0.4.1
6		7
	@@ -8,6 +8,22 @@ require "searchkick/model"		@@ -8,6 +8,22 @@ require "searchkick/model"
8	require "searchkick/tasks"	8	require "searchkick/tasks"
9	require "searchkick/logger" if defined?(Rails)	9	require "searchkick/logger" if defined?(Rails)
10		10
		11	+module Searchkick
		12	+ @callbacks = true
		13	+
		14	+ def self.enable_callbacks
		15	+ @callbacks = true
		16	+ end
		17	+
		18	+ def self.disable_callbacks
		19	+ @callbacks = false
		20	+ end
		21	+
		22	+ def self.callbacks?
		23	+ @callbacks
		24	+ end
		25	+end
		26	+
11	# TODO find better ActiveModel hook	27	# TODO find better ActiveModel hook
12	ActiveModel::Callbacks.send(:include, Searchkick::Model)	28	ActiveModel::Callbacks.send(:include, Searchkick::Model)
13	ActiveRecord::Base.send(:extend, Searchkick::Model) if defined?(ActiveRecord)	29	ActiveRecord::Base.send(:extend, Searchkick::Model) if defined?(ActiveRecord)
@@ -0,0 +1,35 @@		@@ -0,0 +1,35 @@
	1	+require_relative "test_helper"
	2	+
	3	+class TestModel < Minitest::Unit::TestCase
	4	+
	5	+ def test_disable_callbacks_model
	6	+ store_names ["product a"]
	7	+
	8	+ Product.disable_search_callbacks
	9	+ assert !Product.search_callbacks?
	10	+
	11	+ store_names ["product b"]
	12	+ assert_search "product", ["product a"]
	13	+
	14	+ Product.enable_search_callbacks
	15	+ Product.reindex
	16	+
	17	+ assert_search "product", ["product a", "product b"]
	18	+ end
	19	+
	20	+ def test_disable_callbacks_global
	21	+ store_names ["product a"]
	22	+
	23	+ Searchkick.disable_callbacks
	24	+ assert !Searchkick.callbacks?
	25	+
	26	+ store_names ["product b"]
	27	+ assert_search "product", ["product a"]
	28	+
	29	+ Searchkick.enable_callbacks
	30	+ Product.reindex
	31	+
	32	+ assert_search "product", ["product a", "product b"]
	33	+ end
	34	+
	35	+end