algoliasearch-rails 1.22.0 → 1.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04d14efb20e58715bff263a1eb160ccd0d192c7c44091b03aa2dc9f9ee9a3bac
-  data.tar.gz: 0eaa9daddcdde5d578fa8a9657a3233bcf7b30d24af61f9892056c70bf9dfe3e
+  metadata.gz: 6aa4976dffc097e623adfa3426845bceb29262940094082668defb70ecda498c
+  data.tar.gz: 72a7af5ba91d37dce26523a87562a2d571843d8322e19d7183153d677463d286
 SHA512:
-  metadata.gz: 10af848ac5cea8769630f6bbeab00756f85ba5dd27e17eedaa9f5a026c20c5d027ae60523ec42fa7e7c4a9d737995ee4b828a17a447ebf23fe9dc807760cf740
-  data.tar.gz: 4427826729ef4ab92903e6161373b6eaee44b3601a236ce2278d1bda8d3f2351c06cffdd503d246ac965f5f75033dd058ef8622e5535d26ee7e75630c5ccccb8
+  metadata.gz: c2b612ef3d142bd24aa7342f636fcb3659794611f51f413ac3e3586aca35954f5c3ae5f95481baa8fd091468caa9e2b5197bbf0d3529b1628a99fc1945519a0e
+  data.tar.gz: ec3ccc8b3589c89ddd3fada065304f087e47197ac876902969db526824ff38ea7335c3b37e4d6b32072c9251b5cf70d131559c2937c23ef414debf838c9161af

data/ChangeLog

@@ -1,5 +1,36 @@
 # CHANGELOG
 
+## [1.23.0](https://github.com/algolia/algoliasearch-rails/releases/tag/1.23.0) (2019-06-25)
+
+**Added**
+
+* Introduce `rake algoliasearch:set_all_settings` command - PR [#315](https://github.com/algolia/algoliasearch-rails/pull/315)
+
+    This command will push settings for all models to all indices: primary index,
+    replicas and additional indices. It follows the `inherit: true` option.
+    It should typically be added to your deployment script
+
+* Add option to disable automatic settings - PR [#315](https://github.com/algolia/algoliasearch-rails/pull/315)
+
+    By default, this gem check your settings to see when to push them. Depending on
+    your implementation, it might create a lot of API calls. If you wish to disable
+    the automatic change detection for settings, use the `check_settings` option:
+
+    ```ruby
+    class Musician < ActiveRecord::Base
+      include AlgoliaSearch
+
+      algoliasearch check_settings: false do
+        # Settings...
+      end
+    end
+    ```
+
+**Fixed**
+
+* Handle attribute_changed? in transactions - PR [#354](https://github.com/algolia/algoliasearch-rails/pull/354)
+
+
 ## [1.22.0](https://github.com/algolia/algoliasearch-rails/releases/tag/1.22.0) (2019-03-21)
 
 🚨 The documentation for our Rails integration was refreshed 🎉

data/Gemfile

@@ -1,7 +1,7 @@
 source "http://rubygems.org"
 
 gem 'json', '~> 1.8', '>= 1.8.6'
-gem 'algoliasearch', '>= 1.17.0', '< 2.0.0'
+gem 'algoliasearch', '>= 1.23.0', '< 2.0.0'
 
 if defined?(RUBY_ENGINE) && RUBY_ENGINE == 'rbx'
   gem 'rubysl', '~> 2.0', :platform => :rbx

data/Gemfile.lock

@@ -1,72 +1,72 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    actioncable (5.2.2)
-      actionpack (= 5.2.2)
+    actioncable (5.2.3)
+      actionpack (= 5.2.3)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailer (5.2.2)
-      actionpack (= 5.2.2)
-      actionview (= 5.2.2)
-      activejob (= 5.2.2)
+    actionmailer (5.2.3)
+      actionpack (= 5.2.3)
+      actionview (= 5.2.3)
+      activejob (= 5.2.3)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (5.2.2)
-      actionview (= 5.2.2)
-      activesupport (= 5.2.2)
+    actionpack (5.2.3)
+      actionview (= 5.2.3)
+      activesupport (= 5.2.3)
       rack (~> 2.0)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.2.2)
-      activesupport (= 5.2.2)
+    actionview (5.2.3)
+      activesupport (= 5.2.3)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    active_model_serializers (0.10.8)
+    active_model_serializers (0.10.9)
       actionpack (>= 4.1, < 6)
       activemodel (>= 4.1, < 6)
       case_transform (>= 0.2)
       jsonapi-renderer (>= 0.1.1.beta1, < 0.3)
-    activejob (5.2.2)
-      activesupport (= 5.2.2)
+    activejob (5.2.3)
+      activesupport (= 5.2.3)
       globalid (>= 0.3.6)
-    activemodel (5.2.2)
-      activesupport (= 5.2.2)
-    activerecord (5.2.2)
-      activemodel (= 5.2.2)
-      activesupport (= 5.2.2)
+    activemodel (5.2.3)
+      activesupport (= 5.2.3)
+    activerecord (5.2.3)
+      activemodel (= 5.2.3)
+      activesupport (= 5.2.3)
       arel (>= 9.0)
-    activestorage (5.2.2)
-      actionpack (= 5.2.2)
-      activerecord (= 5.2.2)
+    activestorage (5.2.3)
+      actionpack (= 5.2.3)
+      activerecord (= 5.2.3)
       marcel (~> 0.3.1)
-    activesupport (5.2.2)
+    activesupport (5.2.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     addressable (2.4.0)
-    algoliasearch (1.25.2)
+    algoliasearch (1.26.0)
       httpclient (~> 2.8, >= 2.8.3)
       json (>= 1.5.1)
     arel (9.0.0)
-    backports (3.11.4)
+    backports (3.15.0)
     builder (3.2.3)
     case_transform (0.2)
       activesupport
-    concurrent-ruby (1.1.4)
+    concurrent-ruby (1.1.5)
     crass (1.0.4)
     diff-lcs (1.3)
     erubi (1.8.0)
-    ethon (0.11.0)
+    ethon (0.12.0)
       ffi (>= 1.3.0)
     faraday (0.15.4)
       multipart-post (>= 1.2, < 3)
-    faraday_middleware (0.12.2)
+    faraday_middleware (0.13.1)
       faraday (>= 0.7.4, < 1.0)
-    ffi (1.9.25)
+    ffi (1.11.1)
     gh (0.15.1)
       addressable (~> 2.4.0)
       backports
@@ -74,14 +74,14 @@ GEM
       multi_json (~> 1.0)
       net-http-persistent (~> 2.9)
       net-http-pipeline
-    globalid (0.4.1)
+    globalid (0.4.2)
       activesupport (>= 4.2.0)
     highline (1.7.10)
     httpclient (2.8.3)
-    i18n (1.4.0)
+    i18n (1.6.0)
       concurrent-ruby (~> 1.0)
     json (1.8.6)
-    jsonapi-renderer (0.2.0)
+    jsonapi-renderer (0.2.2)
     kaminari (1.1.1)
       activesupport (>= 4.1.0)
       kaminari-actionview (= 1.1.1)
@@ -109,39 +109,39 @@ GEM
     mini_portile2 (2.4.0)
     minitest (5.11.3)
     multi_json (1.13.1)
-    multipart-post (2.0.0)
+    multipart-post (2.1.1)
     net-http-persistent (2.9.4)
     net-http-pipeline (1.0.1)
     nio4r (2.3.1)
-    nokogiri (1.9.1)
+    nokogiri (1.10.3)
       mini_portile2 (~> 2.4.0)
     pusher-client (0.6.2)
       json
       websocket (~> 1.0)
-    rack (2.0.6)
+    rack (2.0.7)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (5.2.2)
-      actioncable (= 5.2.2)
-      actionmailer (= 5.2.2)
-      actionpack (= 5.2.2)
-      actionview (= 5.2.2)
-      activejob (= 5.2.2)
-      activemodel (= 5.2.2)
-      activerecord (= 5.2.2)
-      activestorage (= 5.2.2)
-      activesupport (= 5.2.2)
+    rails (5.2.3)
+      actioncable (= 5.2.3)
+      actionmailer (= 5.2.3)
+      actionpack (= 5.2.3)
+      actionview (= 5.2.3)
+      activejob (= 5.2.3)
+      activemodel (= 5.2.3)
+      activerecord (= 5.2.3)
+      activestorage (= 5.2.3)
+      activesupport (= 5.2.3)
       bundler (>= 1.3.0)
-      railties (= 5.2.2)
+      railties (= 5.2.3)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.0.4)
       loofah (~> 2.2, >= 2.2.2)
-    railties (5.2.2)
-      actionpack (= 5.2.2)
-      activesupport (= 5.2.2)
+    railties (5.2.3)
+      actionpack (= 5.2.3)
+      activesupport (= 5.2.3)
       method_source
       rake (>= 0.8.7)
       thor (>= 0.19.0, < 2.0)
@@ -156,7 +156,7 @@ GEM
     rspec-expectations (2.99.2)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.99.4)
-    sequel (5.16.0)
+    sequel (5.21.0)
     sprockets (3.7.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
@@ -167,7 +167,7 @@ GEM
     sqlite3 (1.3.13)
     thor (0.20.3)
     thread_safe (0.3.6)
-    travis (1.8.9)
+    travis (1.8.10)
       backports
       faraday (~> 0.9)
       faraday_middleware (~> 0.9, >= 0.9.1)
@@ -181,10 +181,10 @@ GEM
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
     websocket (1.2.8)
-    websocket-driver (0.7.0)
+    websocket-driver (0.7.1)
       websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.3)
-    will_paginate (3.1.6)
+    websocket-extensions (0.1.4)
+    will_paginate (3.1.7)
 
 PLATFORMS
   ruby
@@ -208,4 +208,4 @@ DEPENDENCIES
   will_paginate (>= 2.3.15)
 
 BUNDLED WITH
-   1.17.3
+   2.0.1

data/README.md

@@ -44,7 +44,7 @@ You can find the full reference on [Algolia's website](https://www.algolia.com/d
     * [Per-environment indices](#per-environment-indices)
     * [Custom attribute definition](#custom-attribute-definition)
     * [Nested objects/relations](#nested-objectsrelations)
-    * [Custom <code>objectID</code>](#custom-codeobjectidcode)
+    * [Custom <code>objectID</code>](#custom-objectid)
     * [Restrict indexing to a subset of your data](#restrict-indexing-to-a-subset-of-your-data)
     * [Sanitizer](#sanitizer)
     * [UTF-8 Encoding](#utf-8-encoding)

data/lib/algoliasearch-rails.rb

@@ -576,6 +576,25 @@ module AlgoliaSearch
       nil
     end
 
+    def algolia_set_settings(synchronous = false)
+      algolia_configurations.each do |options, settings|
+        if options[:primary_settings] && options[:inherit]
+          primary = options[:primary_settings].to_settings
+          primary.delete :slaves
+          primary.delete 'slaves'
+          primary.delete :replicas
+          primary.delete 'replicas'
+          final_settings = primary.merge(settings.to_settings)
+        else
+          final_settings = settings.to_settings
+        end
+
+        index = SafeIndex.new(algolia_index_name(options), true)
+        task = index.set_settings(final_settings)
+        index.wait_task(task["taskID"]) if synchronous
+      end
+    end
+
     def algolia_index_objects(objects, synchronous = false)
       algolia_configurations.each do |options, settings|
         next if algolia_indexing_disabled?(options)
@@ -743,6 +762,7 @@ module AlgoliaSearch
       return object.send(:algolia_dirty?) if (object.respond_to?(:algolia_dirty?))
       # Loop over each index to see if a attribute used in records has changed
       algolia_configurations.each do |options, settings|
+        next if algolia_indexing_disabled?(options)
         next if options[:slave] || options[:replica]
         return true if algolia_object_id_changed?(object, options)
         settings.get_attribute_names(object).each do |k|
@@ -785,7 +805,9 @@ module AlgoliaSearch
       index_settings ||= settings.to_settings
       index_settings = options[:primary_settings].to_settings.merge(index_settings) if options[:inherit]
 
-      if !algolia_indexing_disabled?(options) && algoliasearch_settings_changed?(current_settings, index_settings)
+      options[:check_settings] = true if options[:check_settings].nil?
+
+      if !algolia_indexing_disabled?(options) && options[:check_settings] && algoliasearch_settings_changed?(current_settings, index_settings)
         used_slaves = !current_settings.nil? && !current_settings['slaves'].nil?
         replicas = index_settings.delete(:replicas) ||
                    index_settings.delete('replicas') ||
@@ -952,8 +974,8 @@ module AlgoliaSearch
         return object.send("will_save_change_to_#{attr_name}?")
       end
 
-      # Nil means we don't know if the attribute has changed
-      nil
+      # We don't know if the attribute has changed, so conservatively assume it has
+      true
     end
 
     def automatic_changed_method?(object, method_name)
@@ -1017,7 +1039,9 @@ module AlgoliaSearch
     end
 
     def algolia_mark_must_reindex
-      @algolia_must_reindex =
+      # algolia_must_reindex flag is reset after every commit as part. If we must reindex at any point in
+      # a stransaction, keep flag set until it is explicitly unset
+      @algolia_must_reindex ||=
        if defined?(::Sequel) && is_a?(Sequel::Model)
          new? || self.class.algolia_must_reindex?(self)
        else

data/lib/algoliasearch/configuration.rb

@@ -5,7 +5,9 @@ module AlgoliaSearch
     end
 
     def configuration=(configuration)
-      @@configuration = configuration.merge(:user_agent => "Algolia for Rails (#{AlgoliaSearch::VERSION}); Algolia for Ruby (#{Algolia::VERSION})")
+      @@configuration = configuration.merge(
+          :user_agent => "Algolia for Rails (#{AlgoliaSearch::VERSION}); Rails (#{Rails::VERSION})"
+      )
       Algolia.init @@configuration
     end
   end

data/lib/algoliasearch/tasks/algoliasearch.rake

@@ -1,9 +1,14 @@
 namespace :algoliasearch do
- 
+
   desc "Reindex all models"
   task :reindex => :environment do
     AlgoliaSearch::Utilities.reindex_all_models
   end
+
+  desc "Set settings to all indexes"
+  task :set_all_settings => :environment do
+    AlgoliaSearch::Utilities.set_settings_all_models
+  end
   
   desc "Clear all indexes"
   task :clear_indexes => :environment do

data/lib/algoliasearch/utilities.rb

@@ -25,6 +25,19 @@ module AlgoliaSearch
           klass.algolia_reindex
         end
       end
+
+      def set_settings_all_models
+        klasses = get_model_classes
+
+        puts ''
+        puts "Pushing settings for #{klasses.count} models: #{klasses.to_sentence}."
+        puts ''
+
+        klasses.each do |klass|
+          puts "Pushing #{klass} settings..."
+          klass.algolia_set_settings
+        end
+      end
     end
   end
 end

data/lib/algoliasearch/version.rb

@@ -1,3 +1,3 @@
 module AlgoliaSearch
-  VERSION = '1.22.0'
+  VERSION = '1.23.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch-rails
 version: !ruby/object:Gem::Version
-  version: 1.22.0
+  version: 1.23.0
 platform: ruby
 authors:
 - Algolia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-21 00:00:00.000000000 Z
+date: 2019-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -188,7 +188,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: AlgoliaSearch integration to your favorite ORM