algoliasearch-rails 2.2.2 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc15b367cfcf9859a354bc12cc93aa844e32c88147d929a71ed7a9913ced85b4
-  data.tar.gz: 3bdc03e4a7644dbfe306c6d9748c20f8b95e916bd4185059712f735050ed10f6
+  metadata.gz: 6c936268f937121a58b8a141df1d9cb5dc25504ff4c25dc3e4d133060162d326
+  data.tar.gz: 8b2262430fc7edab858ce40e6f46638ceb65ddea27f17b2261e2251c93b725b3
 SHA512:
-  metadata.gz: a1527739dd334bbedce3883a5f664534d91a35ce6948f752e90bd77e418302660e9a3cabbf0f2e67d900bff1335bbad95c047b8954563f278dbf629dc8fac8d5
-  data.tar.gz: 86b196e2196d3730e90a34cbfad5bb32022fdb94ee5160471f1c2b79e8f1302d2095f50a1376b292b613803542767b237fdab70f10c90811ae6c52a0a91ef94a
+  metadata.gz: b54ada522502ea04902a815a185d1c7ee016c121ca711a79db89815c3ebf443dd958b68d9b64c7ae48d6260bd423472234babc11c0e6d43f5f0f17793b601d67
+  data.tar.gz: 7ec62bbe246782b6015be92ec55cf680157116e974c88efc5300f528e7324a437b182e7c6e5cde640d18ae5671b0052fad75338a41ed54e0b307c6a1834eaf77

data/CHANGELOG.MD

@@ -2,6 +2,15 @@
 
 ## [Unreleased](https://github.com/algolia/algoliasearch-rails/compare/2.2.1...master)
 
+## [2.3.1](https://github.com/algolia/algoliasearch-rails/compare/2.3.0...2.3.1)
+### Added
+* Allow ActiveJob queue configuration [`#439`](https://github.com/algolia/algoliasearch-rails/pull/439)
+* allow to configure user agent and other default options [`#438`](https://github.com/algolia/algoliasearch-rails/pull/438)
+
+## [2.3.0](https://github.com/algolia/algoliasearch-rails/compare/2.2.2...2.3.0)
+### Fixed
+* bugfix: don't consider objectID changed when using custom ID through method [`#436`](https://github.com/algolia/algoliasearch-rails/pull/436)
+
 ## [2.2.2](https://github.com/algolia/algoliasearch-rails/compare/2.2.1...2.2.2)
 ### Fixed
 * fix: wrong method name [`#429`](https://github.com/algolia/algoliasearch-rails/pull/429)

data/Gemfile.lock

@@ -1,47 +1,40 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    actioncable (7.0.4.2)
-      actionpack (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
+    actioncable (6.1.4.7)
+      actionpack (= 6.1.4.7)
+      activesupport (= 6.1.4.7)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (7.0.4.2)
-      actionpack (= 7.0.4.2)
-      activejob (= 7.0.4.2)
-      activerecord (= 7.0.4.2)
-      activestorage (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
+    actionmailbox (6.1.4.7)
+      actionpack (= 6.1.4.7)
+      activejob (= 6.1.4.7)
+      activerecord (= 6.1.4.7)
+      activestorage (= 6.1.4.7)
+      activesupport (= 6.1.4.7)
       mail (>= 2.7.1)
-      net-imap
-      net-pop
-      net-smtp
-    actionmailer (7.0.4.2)
-      actionpack (= 7.0.4.2)
-      actionview (= 7.0.4.2)
-      activejob (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
+    actionmailer (6.1.4.7)
+      actionpack (= 6.1.4.7)
+      actionview (= 6.1.4.7)
+      activejob (= 6.1.4.7)
+      activesupport (= 6.1.4.7)
       mail (~> 2.5, >= 2.5.4)
-      net-imap
-      net-pop
-      net-smtp
       rails-dom-testing (~> 2.0)
-    actionpack (7.0.4.2)
-      actionview (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
-      rack (~> 2.0, >= 2.2.0)
+    actionpack (6.1.4.7)
+      actionview (= 6.1.4.7)
+      activesupport (= 6.1.4.7)
+      rack (~> 2.0, >= 2.0.9)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (7.0.4.2)
-      actionpack (= 7.0.4.2)
-      activerecord (= 7.0.4.2)
-      activestorage (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
-      globalid (>= 0.6.0)
+    actiontext (6.1.4.7)
+      actionpack (= 6.1.4.7)
+      activerecord (= 6.1.4.7)
+      activestorage (= 6.1.4.7)
+      activesupport (= 6.1.4.7)
       nokogiri (>= 1.8.5)
-    actionview (7.0.4.2)
-      activesupport (= 7.0.4.2)
+    actionview (6.1.4.7)
+      activesupport (= 6.1.4.7)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
@@ -51,27 +44,28 @@ GEM
       activemodel (>= 4.1, < 7.1)
       case_transform (>= 0.2)
       jsonapi-renderer (>= 0.1.1.beta1, < 0.3)
-    activejob (7.0.4.2)
-      activesupport (= 7.0.4.2)
+    activejob (6.1.4.7)
+      activesupport (= 6.1.4.7)
       globalid (>= 0.3.6)
-    activemodel (7.0.4.2)
-      activesupport (= 7.0.4.2)
-    activerecord (7.0.4.2)
-      activemodel (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
-    activestorage (7.0.4.2)
-      actionpack (= 7.0.4.2)
-      activejob (= 7.0.4.2)
-      activerecord (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
-      marcel (~> 1.0)
+    activemodel (6.1.4.7)
+      activesupport (= 6.1.4.7)
+    activerecord (6.1.4.7)
+      activemodel (= 6.1.4.7)
+      activesupport (= 6.1.4.7)
+    activestorage (6.1.4.7)
+      actionpack (= 6.1.4.7)
+      activejob (= 6.1.4.7)
+      activerecord (= 6.1.4.7)
+      activesupport (= 6.1.4.7)
+      marcel (~> 1.0.0)
       mini_mime (>= 1.1.0)
-    activesupport (7.0.4.2)
+    activesupport (6.1.4.7)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-    algolia (2.3.1)
+      zeitwerk (~> 2.3)
+    algolia (2.3.2)
       faraday (>= 0.15, < 3)
       faraday-net_http_persistent (>= 0.15, < 3)
       multi_json (~> 1.0)
@@ -79,13 +73,13 @@ GEM
     builder (3.2.4)
     case_transform (0.2)
       activesupport
-    concurrent-ruby (1.2.0)
-    connection_pool (2.3.0)
+    concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
     crass (1.0.6)
     date (3.3.3)
     diff-lcs (1.5.0)
     erubi (1.12.0)
-    faraday (2.7.4)
+    faraday (2.7.10)
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-net_http (3.0.2)
@@ -94,16 +88,16 @@ GEM
       net-http-persistent (~> 4.0)
     globalid (1.1.0)
       activesupport (>= 5.0)
-    i18n (1.12.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     json (2.6.3)
     jsonapi-renderer (0.2.2)
     kaminari (0.17.0)
       actionpack (>= 3.0.0)
       activesupport (>= 3.0.0)
-    loofah (2.19.1)
+    loofah (2.21.3)
       crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
+      nokogiri (>= 1.12.0)
     mail (2.8.1)
       mini_mime (>= 0.1.1)
       net-imap
@@ -111,13 +105,13 @@ GEM
       net-smtp
     marcel (1.0.2)
     method_source (1.0.0)
-    mini_mime (1.1.2)
-    mini_portile2 (2.8.1)
-    minitest (5.17.0)
+    mini_mime (1.1.5)
+    mini_portile2 (2.8.4)
+    minitest (5.19.0)
     multi_json (1.15.0)
-    net-http-persistent (4.0.1)
+    net-http-persistent (4.0.2)
       connection_pool (~> 2.2)
-    net-imap (0.3.4)
+    net-imap (0.3.7)
       date
       net-protocol
     net-pop (0.1.2)
@@ -126,72 +120,75 @@ GEM
       timeout
     net-smtp (0.3.3)
       net-protocol
-    nio4r (2.5.8)
-    nokogiri (1.14.2)
+    nio4r (2.5.9)
+    nokogiri (1.13.10)
       mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
     psych (5.1.0)
       stringio
-    racc (1.6.2)
-    rack (2.2.6.2)
-    rack-test (2.0.2)
+    racc (1.7.1)
+    rack (2.2.8)
+    rack-test (2.1.0)
       rack (>= 1.3)
-    rails (7.0.4.2)
-      actioncable (= 7.0.4.2)
-      actionmailbox (= 7.0.4.2)
-      actionmailer (= 7.0.4.2)
-      actionpack (= 7.0.4.2)
-      actiontext (= 7.0.4.2)
-      actionview (= 7.0.4.2)
-      activejob (= 7.0.4.2)
-      activemodel (= 7.0.4.2)
-      activerecord (= 7.0.4.2)
-      activestorage (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
+    rails (6.1.4.7)
+      actioncable (= 6.1.4.7)
+      actionmailbox (= 6.1.4.7)
+      actionmailer (= 6.1.4.7)
+      actionpack (= 6.1.4.7)
+      actiontext (= 6.1.4.7)
+      actionview (= 6.1.4.7)
+      activejob (= 6.1.4.7)
+      activemodel (= 6.1.4.7)
+      activerecord (= 6.1.4.7)
+      activestorage (= 6.1.4.7)
+      activesupport (= 6.1.4.7)
       bundler (>= 1.15.0)
-      railties (= 7.0.4.2)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
+      railties (= 6.1.4.7)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.5.0)
       loofah (~> 2.19, >= 2.19.1)
-    railties (7.0.4.2)
-      actionpack (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
+    railties (6.1.4.7)
+      actionpack (= 6.1.4.7)
+      activesupport (= 6.1.4.7)
       method_source
-      rake (>= 12.2)
+      rake (>= 0.13)
       thor (~> 1.0)
-      zeitwerk (~> 2.5)
-    rake (12.3.3)
+    rake (10.1.1)
     rdoc (6.5.0)
       psych (>= 4.0.0)
     redgreen (1.2.2)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.1)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.3)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
+    rspec (2.99.0)
+      rspec-core (~> 2.99.0)
+      rspec-expectations (~> 2.99.0)
+      rspec-mocks (~> 2.99.0)
+    rspec-core (2.99.2)
+    rspec-expectations (2.99.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.99.4)
     ruby2_keywords (0.0.5)
-    sequel (5.65.0)
+    sequel (5.71.0)
+    sprockets (4.2.0)
+      concurrent-ruby (~> 1.0)
+      rack (>= 2.2.4, < 4)
+    sprockets-rails (3.4.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      sprockets (>= 3.0.0)
     sqlite3 (1.4.4)
-    stringio (3.0.5)
-    thor (1.2.1)
-    timeout (0.3.2)
+    stringio (3.0.6)
+    thor (1.2.2)
+    timeout (0.4.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    websocket-driver (0.7.5)
+    websocket-driver (0.7.6)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
-    will_paginate (3.3.1)
-    zeitwerk (2.6.7)
+    will_paginate (4.0.0)
+    zeitwerk (2.6.11)
 
 PLATFORMS
   ruby
@@ -204,13 +201,12 @@ DEPENDENCIES
   jdbc-sqlite3
   json (>= 1.5.1)
   kaminari (< 1)
-  rails (~> 7.0)
-  rails-html-sanitizer
-  rake (~> 12.2)
+  rails (~> 6.1)
+  rake (~> 10.1.0)
   rdoc
   redgreen
-  rspec (~> 3.0)
-  sequel (~> 5.0)
+  rspec (>= 2.5.0, < 3.0)
+  sequel (>= 4.0)
   sqlite3 (~> 1.4.0)
   will_paginate (>= 2.3.15)
 

data/lib/algoliasearch/algolia_job.rb

@@ -1,6 +1,6 @@
 module AlgoliaSearch
   class AlgoliaJob < ::ActiveJob::Base
-    queue_as :algoliasearch
+    queue_as { AlgoliaSearch.configuration[:queue_name] }
 
     def perform(record, method)
       record.send(method)

data/lib/algoliasearch/configuration.rb

@@ -1,5 +1,10 @@
 module AlgoliaSearch
   module Configuration
+    REQUIRED_CONFIGURATION = {
+      user_agent: "Algolia for Rails (#{AlgoliaSearch::VERSION}); Rails (#{defined?(::Rails::VERSION::STRING) ? ::Rails::VERSION::STRING : 'unknown'})",
+      symbolize_keys: false
+    }
+
     def initialize
       @client = nil
     end
@@ -9,10 +14,11 @@ module AlgoliaSearch
     end
 
     def configuration=(configuration)
-      @@configuration = configuration.merge(
-        :user_agent => "Algolia for Rails (#{AlgoliaSearch::VERSION}); Rails (#{Rails::VERSION::STRING})",
-        :symbolize_keys => false
-      )
+      user_agent = [REQUIRED_CONFIGURATION[:user_agent], configuration[:append_to_user_agent]].compact.join('; ')
+      @@configuration = default_configuration
+                        .merge(configuration)
+                        .merge(REQUIRED_CONFIGURATION)
+                        .merge({ user_agent: user_agent })
     end
 
     def client_opts
@@ -34,5 +40,11 @@ module AlgoliaSearch
     def setup_client
       @client = Algolia::Search::Client.new(Algolia::Search::Config.new(@@configuration), client_opts)
     end
+
+    def default_configuration
+      {
+        queue_name: 'algoliasearch'
+      }
+    end
   end
 end

data/lib/algoliasearch/version.rb

@@ -1,3 +1,3 @@
 module AlgoliaSearch
-  VERSION = '2.2.2'
+  VERSION = '2.3.1'
 end

data/lib/algoliasearch-rails.rb

@@ -753,14 +753,13 @@ module AlgoliaSearch
         next if options[:replica]
         return true if algolia_object_id_changed?(object, options)
         settings.get_attribute_names(object).each do |k|
-          return true if algolia_attribute_changed?(object, k)
-          # return true if !object.respond_to?(changed_method) || object.send(changed_method)
+          return true if algolia_attribute_changed?(object, k, true)
         end
         [options[:if], options[:unless]].each do |condition|
           case condition
           when nil
           when String, Symbol
-            return true if algolia_attribute_changed?(object, condition)
+            return true if algolia_attribute_changed?(object, condition, true)
           else
             # if the :if, :unless condition is a anything else,
             # we have no idea whether we should reindex or not
@@ -837,7 +836,7 @@ module AlgoliaSearch
     end
 
     def algolia_object_id_changed?(o, options = nil)
-      changed = algolia_attribute_changed?(o, algolia_object_id_method(options))
+      changed = algolia_attribute_changed?(o, algolia_object_id_method(options), false)
       changed.nil? ? false : changed
     end
 
@@ -934,7 +933,7 @@ module AlgoliaSearch
       end
     end
 
-    def algolia_attribute_changed?(object, attr_name)
+    def algolia_attribute_changed?(object, attr_name, default)
       # if one of two method is implemented, we return its result
       # true/false means whether it has changed or not
       # +#{attr_name}_changed?+ always defined for automatic attributes but deprecated after Rails 5.2
@@ -963,8 +962,8 @@ module AlgoliaSearch
         return object.send("will_save_change_to_#{attr_name}?")
       end
 
-      # We don't know if the attribute has changed, so conservatively assume it has
-      true
+      # We don't know if the attribute has changed, so return the default passed
+      default
     end
 
     def automatic_changed_method?(object, method_name)

data/spec/spec_helper.rb

@@ -15,6 +15,8 @@ raise "missing ALGOLIA_APPLICATION_ID or ALGOLIA_API_KEY environment variables"
 
 Thread.current[:algolia_hosts] = nil
 
+GlobalID.app = 'algoiasearch-rails'
+
 RSpec.configure do |c|
   c.mock_with :rspec
   c.filter_run :focus => true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch-rails
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 2.3.1
 platform: ruby
 authors:
 - Algolia
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-14 00:00:00.000000000 Z
+date: 2023-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json