algoliasearch-rails 1.10.3 → 1.10.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 675a8f42e7841895e66f88e9f4d550b59222d4e5
-  data.tar.gz: f832cadef3b8bef0c50b4f49f474423d1c40e3b2
+  metadata.gz: 7d6329550086f9eea99ae35aa6111fc515e8804c
+  data.tar.gz: e5f7dc994433e9d927252a1b2c1c9b69e8fa18cc
 SHA512:
-  metadata.gz: 10324137c57a424b127bdf4440bcc326e5c44f3558411973b76a83083d22f514d78b354c6c47cfbfa876c537d067d91b8896a867ef6ae48874dbd6be258086f6
-  data.tar.gz: 1a717beffdfe5507c5bf954e2dd6e6f29f2a157a1d1799b20f523993496b2cd134205a0d73cf8d2fe1781236805f0e3f09a9293c3ba6fef09c52227d6f315fa7
+  metadata.gz: 582679d281ba1dcddaa2ab478fb17129719d3c02013f8f0d6cc762b5bf488594a6a745ff754fa671b64d55557bfd9b5ffcba0de8762210fa2fe22d150e80f3cc
+  data.tar.gz: 7237460c4e85f5e8f8178eeae72388098b77059ce1822c006e7d0c4c48c9b6128678963c4bac0baf5367b96a5639489eee606c0fee6f1d8c44c8554925b7a518

data/ChangeLog

@@ -1,8 +1,12 @@
 CHANGELOG
 
+2014-06-28 1.10.4
+
+      * Ability to disable all indexing tasks (testing purpose)
+
 2014-06-17 1.10.3
 
-      * Kaminari: pad the result array to match the options/offset parameters
+      * Pagination: fixed a padding issue with recent versions of Kaminari
 
 2014-05-09 1.10.2
 

data/README.md

@@ -578,7 +578,25 @@ Note on testing
 
 To run the specs, please set the <code>ALGOLIA_APPLICATION_ID</code> and <code>ALGOLIA_API_KEY</code> environment variables. Since the tests are creating and removing indexes, DO NOT use your production account.
 
-You may want to mock Algolia's API calls. We provide a [WebMock](https://github.com/bblimke/webmock) configuration that you can use including `algolia/webmock`:
+You may want to disable all indexing (add, update & delete operations) API calls, you can set the ```disable_indexing``` option:
+
+```ruby
+class User < ActiveRecord::Base
+  include AlgoliaSearch
+
+  algoliasearch :per_environment => true, :disable_indexing => Rails.env.test? do
+  end
+end
+
+class User < ActiveRecord::Base
+  include AlgoliaSearch
+
+  algoliasearch :per_environment => true, :disable_indexing => Proc.new { Rails.env.test? || more_complex_condition } do
+  end
+end
+```
+
+Or you may want to mock Algolia's API calls. We provide a [WebMock](https://github.com/bblimke/webmock) sample configuration that you can use including `algolia/webmock`:
 
 ```ruby
 require 'algolia/webmock'

data/VERSION

@@ -1 +1 @@
-1.10.3
+1.10.4

data/algoliasearch-rails.gemspec

@@ -6,11 +6,11 @@
 
 Gem::Specification.new do |s|
   s.name = "algoliasearch-rails"
-  s.version = "1.10.3"
+  s.version = "1.10.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Algolia"]
-  s.date = "2014-06-17"
+  s.date = "2014-06-28"
   s.description = "AlgoliaSearch integration to your favorite ORM"
   s.email = "contact@algolia.com"
   s.extra_rdoc_files = [

data/lib/algoliasearch-rails.rb

@@ -199,6 +199,7 @@ module AlgoliaSearch
     def algolia_reindex!(batch_size = 1000, synchronous = false)
       return if @algolia_without_auto_index_scope
       algolia_configurations.each do |options, settings|
+        next if algolia_indexing_disabled?(options)
         index = algolia_ensure_init(options, settings)
         next if options[:slave]
         last_task = nil
@@ -222,6 +223,7 @@ module AlgoliaSearch
 
     def algolia_index_objects(objects, synchronous = false)
       algolia_configurations.each do |options, settings|
+        next if algolia_indexing_disabled?(options)
         index = algolia_ensure_init(options, settings)
         next if options[:slave]
         task = index.save_objects(objects.map { |o| settings.get_attributes(o).merge 'objectID' => algolia_object_id_of(o, options) })
@@ -232,6 +234,7 @@ module AlgoliaSearch
     def algolia_index!(object, synchronous = false)
       return if @algolia_without_auto_index_scope
       algolia_configurations.each do |options, settings|
+        next if algolia_indexing_disabled?(options)
         object_id = algolia_object_id_of(object, options)
         raise ArgumentError.new("Cannot index a blank objectID") if object_id.blank?
         index = algolia_ensure_init(options, settings)
@@ -259,6 +262,7 @@ module AlgoliaSearch
       object_id = algolia_object_id_of(object)
       raise ArgumentError.new("Cannot index a blank objectID") if object_id.blank?
       algolia_configurations.each do |options, settings|
+        next if algolia_indexing_disabled?(options)
         index = algolia_ensure_init(options, settings)
         next if options[:slave]
         if synchronous
@@ -272,6 +276,7 @@ module AlgoliaSearch
 
     def algolia_clear_index!(synchronous = false)
       algolia_configurations.each do |options, settings|
+        next if algolia_indexing_disabled?(options)
         index = algolia_ensure_init(options, settings)
         next if options[:slave]
         synchronous ? index.clear! : index.clear
@@ -374,7 +379,7 @@ module AlgoliaSearch
       return @algolia_indexes[settings] if @algolia_indexes[settings]
       @algolia_indexes[settings] = Algolia::Index.new(algolia_index_name(options))
       current_settings = @algolia_indexes[settings].get_settings rescue nil # if the index doesn't exist
-      @algolia_indexes[settings].set_settings(settings.to_settings) if algoliasearch_settings_changed?(current_settings, settings.to_settings)
+      @algolia_indexes[settings].set_settings(settings.to_settings) if !algolia_indexing_disabled?(options) && algoliasearch_settings_changed?(current_settings, settings.to_settings)
       @algolia_indexes[settings]
     end
 
@@ -461,6 +466,20 @@ module AlgoliaSearch
       end
     end
 
+    def algolia_indexing_disabled?(options = nil)
+      options ||= algoliasearch_options
+      constraint = options[:disable_indexing] || options['disable_indexing']
+      if constraint.nil?
+        false
+      elsif constraint == true || constraint == false
+        constraint
+      elsif constraint.respond_to?(:call) # Proc
+        constraint.call
+      else
+        raise ArgumentError, "Unknown constraint type: #{constraint} (#{constraint.class})"
+      end
+    end
+
     def algolia_find_in_batches(batch_size, &block)
       if (defined?(::ActiveRecord) && ancestors.include?(::ActiveRecord::Base)) || respond_to?(:find_in_batches)
         find_in_batches(:batch_size => batch_size, &block)

metadata

@@ -1,111 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch-rails
 version: !ruby/object:Gem::Version
-  version: 1.10.3
+  version: 1.10.4
 platform: ruby
 authors:
 - Algolia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-17 00:00:00.000000000 Z
+date: 2014-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.1
 - !ruby/object:Gem::Dependency
   name: algoliasearch
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.5
 - !ruby/object:Gem::Dependency
   name: will_paginate
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.3.15
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.3.15
 - !ruby/object:Gem::Dependency
   name: kaminari
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: travis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: AlgoliaSearch integration to your favorite ORM
@@ -117,9 +117,9 @@ extra_rdoc_files:
 - LICENSE
 - README.md
 files:
-- .document
-- .rspec
-- .travis.yml
+- ".document"
+- ".rspec"
+- ".travis.yml"
 - ChangeLog
 - Gemfile
 - Gemfile.lock
@@ -154,12 +154,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []