meilisearch-rails 0.14.1 → 0.14.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24559c8e70fcdaef7392de52e689ed37427c1e87a8981e693f123c8b7348d75a
-  data.tar.gz: 415f7739643c82925fa54dc3b6a3d2dcf182d66969010fc84d3cf64a9444fc37
+  metadata.gz: babcf0719c23af9294b52e76c7549cacf9baeb578221c18cf2be53db5bbeaaa1
+  data.tar.gz: 33aee866b13502a67657a5803d395fbcebe737456e2f45e812b1312074b5b7df
 SHA512:
-  metadata.gz: ce2015617e15a63f5d9fa39686b92272e83fb70c8ae66144847aa712ac51341ff1f56073006936fb568996105ee45142cedccfb5123befd79a033312efd37173
-  data.tar.gz: a906f6cc4bb10f6de8c38e19ab4225ffc7a1009517dedf0849972af3a6df50d6518371e66660477a8eb92291266bfea23e5ae135ebc3ca6f611e9e17828a4429
+  metadata.gz: 230fc45c263f5aa10ff137eba952673eed221a33bae3ae1c5cb7cfe35adbdc50d9399feaeaf20c7766fd78bf0c29ed440de08880de8f5c2e9d7889bcf6d107c5
+  data.tar.gz: 18bbbc7a7fd9cb64bf1f2429234c10c56b1c3c88a044909a3b01f1e4ceb276449f61cc6ceb52148131c44b8d5dfbeeb09438953dff15ff9857b3d9e7864e2ccd

data/Gemfile

@@ -13,17 +13,18 @@ group :development do
 end
 
 group :test do
-  rails_version = ENV['RAILS_VERSION'] || '6.1'
+  rails_version = ENV['RAILS_VERSION'] || '7.1'
   sequel_version = ENV['SEQUEL_VERSION'] ? "~> #{ENV['SEQUEL_VERSION']}" : '>= 4.0'
 
   gem 'active_model_serializers'
   gem 'rails', "~> #{rails_version}"
   gem 'sequel', sequel_version
 
-  if Gem::Version.new(rails_version) >= Gem::Version.new('6.0')
-    gem 'sqlite3', '~> 1.4.0', platform: %i[rbx ruby]
+  # remove when deprecate rails 6
+  if Gem::Version.new(rails_version) >= Gem::Version.new('7.0')
+    gem 'sqlite3', '~> 2', platform: %i[rbx ruby]
   else
-    gem 'sqlite3', '< 1.4.0', platform: %i[rbx ruby]
+    gem 'sqlite3', '< 2', platform: %i[rbx ruby]
   end
 
   gem 'activerecord-jdbc-adapter', platform: :jruby
@@ -33,6 +34,7 @@ group :test do
   gem 'simplecov', require: 'false'
   gem 'simplecov-cobertura', require: 'false'
   gem 'threads'
+  gem 'logger'
 
   gem 'byebug'
   gem 'dotenv', '~> 2.7', '>= 2.7.6'

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021-2024 Meili SAS
+Copyright (c) 2021-2025 Meili SAS
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -32,7 +32,6 @@
 ## Table of Contents <!-- omit in TOC -->
 
 - [📖 Documentation](#-documentation)
-- [⚡ Supercharge your Meilisearch experience](#-supercharge-your-meilisearch-experience)
 - [🤖 Compatibility with Meilisearch](#-compatibility-with-meilisearch)
 - [🚀 Getting started](#-getting-started)
 - [Compatibility](#-compatibility)
@@ -66,10 +65,6 @@ The whole usage of this gem is detailed in this README.
 
 To learn more about Meilisearch, check out our [Documentation](https://www.meilisearch.com/docs/learn/tutorials/getting_started.html) or our [API References](https://www.meilisearch.com/docs/reference/api/).
 
-## ⚡ Supercharge your Meilisearch experience
-
-Say goodbye to server deployment and manual updates with [Meilisearch Cloud](https://www.meilisearch.com/pricing?utm_campaign=oss&utm_source=integration&utm_medium=meilisearch-rails). No credit card required.
-
 ## 🤖 Compatibility with Meilisearch
 
 This package guarantees compatibility with [version v1.x of Meilisearch](https://github.com/meilisearch/meilisearch/releases/latest), but some features may not be present. Please check the [issues](https://github.com/meilisearch/meilisearch-rails/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+label%3Aenhancement) for more info.
@@ -92,16 +87,9 @@ gem 'meilisearch-rails'
 
 ### Run Meilisearch <!-- omit in toc -->
 
-There are many easy ways to [download and run a Meilisearch instance](https://www.meilisearch.com/docs/reference/features/installation.html#download-and-launch).
-
-For example, if you use Docker:
-
-```bash
-docker pull getmeili/meilisearch:latest # Fetch the latest version of Meilisearch image from Docker Hub
-docker run -it --rm -p 7700:7700 getmeili/meilisearch:latest meilisearch --master-key=masterKey
-```
+⚡️ **Launch, scale, and streamline in minutes with Meilisearch Cloud**—no maintenance, no commitment, cancel anytime. [Try it free now](https://cloud.meilisearch.com/login?utm_campaign=oss&utm_source=github&utm_medium=meilisearch-rails).
 
-NB: you can also download Meilisearch from **Homebrew** or **APT**.
+🪨  Prefer to self-host? [Download and deploy](https://www.meilisearch.com/docs/learn/self_hosted/getting_started_with_self_hosted_meilisearch?utm_campaign=oss&utm_source=github&utm_medium=meilisearch-rails) our fast, open-source search engine on your own infrastructure.
 
 ## 🚀 Getting started
 
@@ -253,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>
@@ -292,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,14 +18,20 @@ module MeiliSearch
         end
 
         def self.create(results, total_hits, options = {})
-          offset = ((options[:page] - 1) * options[:per_page])
+          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
             # otherwise you'll get an empty array: https://github.com/amatsuda/kaminari/commit/29fdcfa8865f2021f710adaedb41b7a7b081e34d
             results = Array.new(offset) + results
-            array = new results, offset: offset, limit: options[:per_page], total_count: total_hits
+            array = new results, offset: offset, limit: limit, total_count: total_hits
           end
 
           array

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.1'
+    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

data/meilisearch-rails.gemspec

@@ -34,5 +34,6 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 3.0.0'
 
-  s.add_dependency 'meilisearch', '~> 0.28'
+  s.add_dependency 'meilisearch', '~> 0.28.4'
+  s.add_dependency 'mutex_m', '~> 0.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: meilisearch-rails
 version: !ruby/object:Gem::Version
-  version: 0.14.1
+  version: 0.14.3
 platform: ruby
 authors:
 - Meili
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-25 00:00:00.000000000 Z
+date: 2025-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: meilisearch
@@ -16,14 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.28'
+        version: 0.28.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.28'
+        version: 0.28.4
+- !ruby/object:Gem::Dependency
+  name: mutex_m
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 description: Meilisearch integration for Ruby on Rails. See https://github.com/meilisearch/meilisearch
 email: bonjour@meilisearch.com
 executables: []
@@ -58,7 +72,7 @@ homepage: https://github.com/meilisearch/meilisearch-rails
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -74,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.4.19
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Meilisearch integration for Ruby on Rails.
 test_files: []