meilisearch-rails 0.14.2 → 0.14.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dab897ac0b83c33721dc40eab5be2d2cc5013c14380a1d47df590f44339433fc
-  data.tar.gz: d99e1fd1970915a665a328233df77bf526f0510478fa2087b502a6224e8a2635
+  metadata.gz: babcf0719c23af9294b52e76c7549cacf9baeb578221c18cf2be53db5bbeaaa1
+  data.tar.gz: 33aee866b13502a67657a5803d395fbcebe737456e2f45e812b1312074b5b7df
 SHA512:
-  metadata.gz: 67e71e231498dd94223096fd3bb02a7f79a8861a4a013f3a628ee3141db3436e323df1cd671caeb20937fe39533c558bd540c4eceae6f6b69713a3af8ceb1a93
-  data.tar.gz: 23ac15e8d4d42a1af5d9f2c38e84b9e7c810979af2ca8264eb818b80aaaf84d2ad973512857f2c40c0708dee82a6d67ddc2097e542cc71c4e64f7bc1cb72edbe
+  metadata.gz: 230fc45c263f5aa10ff137eba952673eed221a33bae3ae1c5cb7cfe35adbdc50d9399feaeaf20c7766fd78bf0c29ed440de08880de8f5c2e9d7889bcf6d107c5
+  data.tar.gz: 18bbbc7a7fd9cb64bf1f2429234c10c56b1c3c88a044909a3b01f1e4ceb276449f61cc6ceb52148131c44b8d5dfbeeb09438953dff15ff9857b3d9e7864e2ccd

data/README.md

@@ -241,22 +241,7 @@ multi_search_results = MeiliSearch::Rails.multi_search(
 )
 ```
 
-You can iterate through the results with `.each` or `.each_result`:
-
-```erb
-<% multi_search_results.each do |record| %>
-  <p><%= record.title %></p>
-  <p><%= record.author %></p>
-<% end %>
-
-<p>Harry Potter and the Philosopher's Stone</p>
-<p>J. K. Rowling</p>
-<p>Harry Potter and the Chamber of Secrets</p>
-<p>J. K. Rowling</p>
-<p>Attack on Titan</p>
-<p>Iseyama</p>
-```
-
+Use `#each_result` to loop through pairs of your provided keys and the results:
 ```erb
 <% multi_search_results.each_result do |klass, results| %>
   <p><%= klass.name.pluralize %></p>
@@ -280,6 +265,59 @@ You can iterate through the results with `.each` or `.each_result`:
 </ul>
 ```
 
+Records are loaded when the keys are models, or when `:class_name` option is passed:
+
+```ruby
+multi_search_results = MeiliSearch::Rails.multi_search(
+  'books' => { q: 'Harry', class_name: 'Book' },
+  'mangas' => { q: 'Attack', class_name: 'Manga' }
+)
+```
+
+Otherwise, hashes are returned.
+
+The index to search is inferred from the model if the key is a model, if the key is a string the key is assumed to be the index unless the `:index_uid` option is passed:
+
+```ruby
+multi_search_results = MeiliSearch::Rails.multi_search(
+  'western' => { q: 'Harry', class_name: 'Book', index_uid: 'books_production' },
+  'japanese' => { q: 'Attack', class_name: 'Manga', index_uid: 'mangas_production' }
+)
+```
+
+### Multi search the same index <!-- omit in toc -->
+
+You can search the same index multiple times by specifying `:index_uid`:
+
+```ruby
+query = 'hero'
+multi_search_results = MeiliSearch::Rails.multi_search(
+  'Isekai Manga' => { q: query, class_name: 'Manga', filters: 'genre:isekai', index_uid: 'mangas_production' }
+  'Shounen Manga' => { q: query, class_name: 'Manga', filters: 'genre:shounen', index_uid: 'mangas_production' }
+  'Steampunk Manga' => { q: query, class_name: 'Manga', filters: 'genre:steampunk', index_uid: 'mangas_production' }
+)
+```
+
+### Deprecated #each <!-- omit in toc -->
+
+**DEPRECATED:** You used to be able to iterate through a flattened collection with `.each`:
+
+```erb
+<% multi_search_results.each do |record| %>
+  <p><%= record.title %></p>
+  <p><%= record.author %></p>
+<% end %>
+
+<p>Harry Potter and the Philosopher's Stone</p>
+<p>J. K. Rowling</p>
+<p>Harry Potter and the Chamber of Secrets</p>
+<p>J. K. Rowling</p>
+<p>Attack on Titan</p>
+<p>Iseyama</p>
+```
+
+But this has been deprecated in favor of **federated search**.
+
 See the [official multi search documentation](https://www.meilisearch.com/docs/reference/api/multi_search).
 
 ## 🪛 Options

data/lib/meilisearch/rails/multi_search/result.rb

@@ -7,34 +7,57 @@ module MeiliSearch
         @results = {}
         @metadata = {}
 
-        searches.zip(raw_results['results']).each do |(index_target, search_options), result|
-          index_target = search_options[:class_name].constantize if search_options[:class_name]
+        searches.zip(raw_results['results']).each do |(target, search_options), result|
+          results_class = if search_options[:class_name]
+                            search_options[:class_name].constantize
+                          elsif target.instance_of?(Class)
+                            target
+                          end
 
-          @results[index_target] = case index_target
-                                   when String, Symbol
-                                     result['hits']
-                                   else
-                                     load_results(index_target, result)
-                                   end
+          @results[target] = results_class ? load_results(results_class, result) : result['hits']
 
-          @metadata[index_target] = result.except('hits')
+          @metadata[target] = result.except('hits')
         end
       end
 
       include Enumerable
 
       def each_hit(&block)
-        @results.each do |_index_target, results|
+        MeiliSearch::Rails.logger.warn(
+          <<~DEPRECATION
+            [meilisearch-rails] Flattening multi search results is deprecated.
+            If you do not want the results to be grouped, please use federated search instead.
+          DEPRECATION
+        )
+
+        @results.each_value do |results|
           results.each(&block)
         end
       end
-      alias each each_hit
+
+      def each(&block)
+        MeiliSearch::Rails.logger.info(
+          <<~INFO
+            [meilisearch-rails] #each on a multi search now iterates through grouped results.
+            If you do not want the results to be grouped, please use federated search instead.
+            To quickly go back to the old deprecated behavior, use `#each_hit`.
+          INFO
+        )
+
+        @results.each(&block)
+      end
 
       def each_result(&block)
         @results.each(&block)
       end
 
       def to_a
+        MeiliSearch::Rails.logger.warn(
+          <<~DEPRECATION
+            [meilisearch-rails] Flattening multi search results is deprecated.
+            If you do not want the results to be grouped, please use federated search instead.
+          DEPRECATION
+        )
         @results.values.flatten(1)
       end
       alias to_ary to_a

data/lib/meilisearch/rails/multi_search.rb

@@ -5,6 +5,8 @@ module MeiliSearch
     class << self
       def multi_search(searches)
         search_parameters = searches.map do |(index_target, options)|
+          index_target = options.delete(:index_uid) || index_target
+
           paginate(options) if pagination_enabled?
           normalize(options, index_target)
         end

data/lib/meilisearch/rails/pagination/kaminari.rb

@@ -18,11 +18,14 @@ module MeiliSearch
         end
 
         def self.create(results, total_hits, options = {})
-          offset = ((options[:page] - 1) * options[:per_page])
-          total_hits = 0 if total_hits.nil?
-          offset = 0 if offset.nil?
-          limit = 0 if options[:per_page].nil?
-          array = new results, limit: limit, offset: offset, total_count: total_hits
+          unless MeiliSearch::Rails.active?
+            total_hits = 0
+            options[:page] = 1
+            options[:per_page] = 1
+          end
+
+          offset = (options[:page] - 1) * options[:per_page]
+          array = new results, limit: options[:per_page], offset: offset, total_count: total_hits
 
           if array.empty? && !results.empty?
             # since Kaminari 0.16.0, you need to pad the results with nil values so it matches the offset param

data/lib/meilisearch/rails/pagination/will_paginate.rb

@@ -10,6 +10,12 @@ module MeiliSearch
     module Pagination
       class WillPaginate
         def self.create(results, total_hits, options = {})
+          unless MeiliSearch::Rails.active?
+            total_hits = 0
+            options[:page] = 1
+            options[:per_page] = 1
+          end
+
           ::WillPaginate::Collection.create(options[:page], options[:per_page], total_hits) do |pager|
             pager.replace results
           end

data/lib/meilisearch/rails/version.rb

@@ -2,7 +2,7 @@
 
 module MeiliSearch
   module Rails
-    VERSION = '0.14.2'
+    VERSION = '0.14.3'
 
     def self.qualified_version
       "Meilisearch Rails (v#{VERSION})"

data/lib/meilisearch-rails.rb

@@ -415,7 +415,7 @@ module MeiliSearch
                    raise ArgumentError, "Invalid `enqueue` option: #{options[:enqueue]}"
                  end
           meilisearch_options[:enqueue] = proc do |record, remove|
-            proc.call(record, remove) unless ms_without_auto_index_scope
+            proc.call(record, remove) if ::MeiliSearch::Rails.active? && !ms_without_auto_index_scope
           end
         end
         unless options[:auto_index] == false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: meilisearch-rails
 version: !ruby/object:Gem::Version
-  version: 0.14.2
+  version: 0.14.3
 platform: ruby
 authors:
 - Meili
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-15 00:00:00.000000000 Z
+date: 2025-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: meilisearch