algoliasearch-rails 2.3.0 → 2.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91a3c57ba564afcd15833841c0c4dad105b1889179281b43e59a1adcb5c3acd2
-  data.tar.gz: d8bdac6cdf53cb6f095e1d485c6ceff1d94a17c6d649d76cefd29dca37d65172
+  metadata.gz: 2f1f301750d7affc346eea8252c11e98722a8ac4c82be59fb8a248a69fa459ce
+  data.tar.gz: ce9e1536025efd0f881b6e45be3db203d7dc0eafc6f4b0d07cf8f9b8aea95761
 SHA512:
-  metadata.gz: 13fe3ebce7b706de4324f0ee1f5fea8fdcfb6913445cc56a24a337868ac9f98edd173b5559a58921b73156d1dfe5d56fd3bd302666923966e5a1c4328369b5ec
-  data.tar.gz: f6237c40c513bacdb78ebd307668c0ae478c4e20f600a5d9ac10ca164ab2082e9515d9061177e5b93faf9ffebafbe4c864f80851c9466ac23565f4a7dadc83b4
+  metadata.gz: d9de7d8769fc9c19adbfbe70cef64e643c5d25d55774962d041962f570826566dd518a550fd23f73f4293bcdf5e1d048af354d2c9dc1c41ebe574dac64b5d996
+  data.tar.gz: '05787dce080a885c00ae4efdff6a9b4f26e2109979845ec8405d78f27f5c9757c30e77b814cb0f6957b49f8787cd468df15c8c8369091d80f39adc83e33f1adf'

data/CHANGELOG.MD

@@ -2,7 +2,16 @@
 
 ## [Unreleased](https://github.com/algolia/algoliasearch-rails/compare/2.2.1...master)
 
-## [2.2.2](https://github.com/algolia/algoliasearch-rails/compare/2.2.2...2.3.0)
+## [2.3.2](https://github.com/algolia/algoliasearch-rails/compare/2.3.1...2.3.2)
+### Added
+* Support for Pagy pagination provider [`#443`](https://github.com/algolia/algoliasearch-rails/pull/443)
+
+## [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)
 

data/Gemfile

@@ -34,5 +34,6 @@ end
 group :test, :development do
   gem 'will_paginate', '>= 2.3.15'
   gem 'kaminari', '< 1'
+  gem 'pagy'
 end
 

data/algoliasearch-rails.gemspec

@@ -33,6 +33,7 @@ Gem::Specification.new do |s|
     "lib/algoliasearch/configuration.rb",
     "lib/algoliasearch/pagination.rb",
     "lib/algoliasearch/pagination/kaminari.rb",
+    "lib/algoliasearch/pagination/pagy.rb",
     "lib/algoliasearch/pagination/will_paginate.rb",
     "lib/algoliasearch/railtie.rb",
     "lib/algoliasearch/tasks/algoliasearch.rake",
@@ -81,6 +82,7 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<algolia>, ["< 3.0.0"])
       s.add_development_dependency(%q<will_paginate>, [">= 2.3.15"])
       s.add_development_dependency(%q<kaminari>, [">= 0"])
+      s.add_development_dependency(%q<pagy>, [">= 0"])
       s.add_development_dependency "rake"
       s.add_development_dependency "rdoc"
     else

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/pagination/pagy.rb

@@ -0,0 +1,22 @@
+unless defined? Pagy
+  raise(AlgoliaSearch::BadConfiguration, "AlgoliaSearch: Please add 'pagy' to your Gemfile to use Pagy pagination backend")
+end
+
+module AlgoliaSearch
+  module Pagination
+    class Pagy
+      def self.create(results, total_hits, options = {})
+        vars = {
+          count: total_hits,
+          page: options[:page],
+          items: options[:per_page]
+        }
+
+        pagy = ::Pagy.new(vars)
+        [pagy, results]
+      end
+    end
+
+  end
+end
+

data/lib/algoliasearch/pagination.rb

@@ -3,6 +3,7 @@ module AlgoliaSearch
 
     autoload :WillPaginate, 'algoliasearch/pagination/will_paginate'
     autoload :Kaminari, 'algoliasearch/pagination/kaminari'
+    autoload :Pagy, 'algoliasearch/pagination/pagy'
 
     def self.create(results, total_hits, options = {})
       return results if AlgoliaSearch.configuration[:pagination_backend].nil?

data/lib/algoliasearch/version.rb

@@ -1,3 +1,3 @@
 module AlgoliaSearch
-  VERSION = '2.3.0'
+  VERSION = '2.3.2'
 end

data/lib/algoliasearch-rails.rb

@@ -683,7 +683,7 @@ module AlgoliaSearch
 
     def algolia_search(q, params = {})
       if AlgoliaSearch.configuration[:pagination_backend]
-        # kaminari and will_paginate start pagination at 1, Algolia starts at 0
+        # kaminari, will_paginate, and pagy start pagination at 1, Algolia starts at 0
         params[:page] = (params.delete('page') || params.delete(:page)).to_i
         params[:page] -= 1 if params[:page].to_i > 0
       end

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.3.0
+  version: 2.3.2
 platform: ruby
 authors:
 - Algolia
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-12 00:00:00.000000000 Z
+date: 2024-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pagy
+  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
@@ -117,6 +131,7 @@ files:
 - lib/algoliasearch/configuration.rb
 - lib/algoliasearch/pagination.rb
 - lib/algoliasearch/pagination/kaminari.rb
+- lib/algoliasearch/pagination/pagy.rb
 - lib/algoliasearch/pagination/will_paginate.rb
 - lib/algoliasearch/railtie.rb
 - lib/algoliasearch/tasks/algoliasearch.rake