meilisearch-rails 0.10.2 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb990c26e799658b655df059ea7a22b4cfc7511a88e7581d72c27841b736f74f
-  data.tar.gz: c2457a258356732877729a9f110a8f392316a98d725d6d052f2dc64824a3ea2f
+  metadata.gz: 9f9160abd3574add59fc40a7d118ae19acf61c6d1378e732922681e3efba38e7
+  data.tar.gz: 3e1f25e0175a89699880f1225a51f1fca99ebb6fb1f9800f49e81f4c8a4c1357
 SHA512:
-  metadata.gz: 7499509091a149069f1322e3ceec9c789432c3495d8c2754d258bb17c5cc1d70a410ebcd41e1eb76bcbe50b3c9e301044d0a5e6931e94bdd8779eb290e9eaecf
-  data.tar.gz: 68173b7d7767308144b6987c35c9c2fb75806959a6fcdc3ee3545cab88779d24e013dea0ea0b3b0a3182f8fb9bcd5c7e1634aaf89ecd39f4cb7ad21231b95a0b
+  metadata.gz: 3ab450b2fe203297e17b96bf4dc2b6e1289e8fbcb6bd7e000b14092e6136e2c0f089f66af2a0bd88d7df4f0a6a0ab02accee49c40419e1902d86b9583cca8695
+  data.tar.gz: 41eb28679a52abac258559686bf15ea8af79b8dcc814511390a7db7f3cd75fc0062036ba4ef23d687f507c1c82b520c9af6a69ec03b707e80ccea25aab5988ef

data/.rspec

@@ -1 +1,2 @@
 --color
+--require spec_helper

data/Gemfile

@@ -13,17 +13,20 @@ 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'
+  mongoid_version = ENV['MONGOID_VERSION'] || '9.0'
 
   gem 'active_model_serializers'
   gem 'rails', "~> #{rails_version}"
   gem 'sequel', sequel_version
+  gem 'mongoid', "~> #{mongoid_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
@@ -31,8 +34,9 @@ group :test do
   gem 'jdbc-sqlite3', platform: :jruby
   gem 'rspec', '~> 3.0'
   gem 'simplecov', require: 'false'
-  gem 'codecov', 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-2022 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,12 +32,13 @@
 ## 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)
 - [⚙️ Settings](#️-settings)
 - [🔍 Custom search](#-custom-search)
+- [🔍🔍 Multi search](#-multi-search)
+- [🔍🔍 Federated search](#-federated-search)
 - [🪛 Options](#-options)
   - [Meilisearch configuration & environment](#meilisearch-configuration--environment)
   - [Pagination with `kaminari` or `will_paginate`](#backend-pagination-with-kaminari-or-will_paginate-)
@@ -65,17 +66,13 @@ 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.
 
 ## 🔧 Installation <!-- omit in toc -->
 
-This package requires Ruby version 2.7.0 or later and Rails 6.1 or later. It may work in older versions but it is not officially supported.
+This package requires Ruby version 3.0 or later and Rails 6.1 or later. It may work in older versions but it is not officially supported.
 
 With `gem` in command line:
 ```bash
@@ -91,16 +88,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
 
@@ -109,7 +99,7 @@ NB: you can also download Meilisearch from **Homebrew** or **APT**.
 Create a new file `config/initializers/meilisearch.rb` to setup your `MEILISEARCH_HOST` and `MEILISEARCH_API_KEY`
 
 ```ruby
-MeiliSearch::Rails.configuration = {
+Meilisearch::Rails.configuration = {
   meilisearch_url: ENV.fetch('MEILISEARCH_HOST', 'http://localhost:7700'),
   meilisearch_api_key: ENV.fetch('MEILISEARCH_API_KEY', 'YourMeilisearchAPIKey')
 }
@@ -131,7 +121,7 @@ The following code will create a `Book` index and add search capabilities to you
 
 ```ruby
 class Book < ActiveRecord::Base
-  include MeiliSearch::Rails
+  include Meilisearch::Rails
 
   meilisearch do
     attribute :title, :author # only the attributes 'title', and 'author' will be sent to Meilisearch
@@ -165,7 +155,7 @@ Requests made to Meilisearch may timeout and retry. To adapt the behavior to
 your needs, you can change the parameters during configuration:
 
 ```ruby
-MeiliSearch::Rails.configuration = {
+Meilisearch::Rails.configuration = {
   meilisearch_url: 'YourMeilisearchUrl',
   meilisearch_api_key: 'YourMeilisearchAPIKey',
   timeout: 2,
@@ -183,7 +173,7 @@ You can configure the index settings by adding them inside the `meilisearch` blo
 
 ```ruby
 class Book < ApplicationRecord
-  include MeiliSearch::Rails
+  include Meilisearch::Rails
 
   meilisearch do
     searchable_attributes [:title, :author, :publisher, :description]
@@ -206,6 +196,7 @@ class Book < ApplicationRecord
     crop_length 10
     faceting max_values_per_facet: 2000
     pagination max_total_hits: 1000
+    proximity_precision 'byWord'
   end
 end
 ```
@@ -229,7 +220,7 @@ harry_book.formatted # => {"id"=>"1", "name"=>"<em>Harry</em> Potter", "descript
 👉 Don't forget that `attributes_to_highlight`, `attributes_to_crop`, and
 `crop_length` can be set up in the `meilisearch` block of your model.
 
-## 🔍 Sorted search
+### 🔍 Sorted search
 
 As an example of how to use the sort option, here is how you could achieve
 returning all books sorted by title in ascending order:
@@ -240,6 +231,265 @@ Book.search('*', sort: ['title:asc'])
 
 👉 Don't forget to set up the `sortable_attributes` option in the `meilisearch` block of your model.
 
+## 🔍🔍 Multi search
+
+Meilisearch supports searching multiple models at the same time (see [🔍 Custom search](#-custom-search) for search options):
+
+```ruby
+multi_search_results = Meilisearch::Rails.multi_search(
+  Book => { q: 'Harry' },
+  Manga => { q: 'Attack' }
+)
+```
+
+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>
+
+  <ul>
+    <% results.each do |record| %>
+      <li><%= record.title %></li>
+    <% end %>
+  </ul>
+<% end %>
+
+
+<p>Books</p>
+<ul>
+  <li>Harry Potter and the Philosopher's Stone</li>
+  <li>Harry Potter and the Chamber of Secrets</li>
+</ul>
+<p>Mangas</p>
+<ul>
+  <li>Attack on Titan</li>
+</ul>
+```
+
+Records are loaded when the keys are models, or when `:scope` option is passed:
+
+```ruby
+multi_search_results = Meilisearch::Rails.multi_search(
+  # scope may be a relation
+  'books' => { q: 'Harry', scope: Book.all },
+  # or a model
+  'mangas' => { q: 'Attack', scope: 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', scope: Book, index_uid: 'books_production' },
+  'japanese' => { q: 'Attack', scope: 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, scope: Manga, filters: 'genre:isekai', index_uid: 'mangas_production' }
+  'Shounen Manga' => { q: query, scope: Manga, filters: 'genre:shounen', index_uid: 'mangas_production' }
+  'Steampunk Manga' => { q: query, scope: 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).
+
+## 🔍🔍 Federated search
+
+Federated search is similar to multi search, except that results are not grouped but sorted by ranking rules.
+
+```ruby
+results = Meilisearch::Rails.federated_search(
+  queries: [
+    { q: 'Harry', scope: Book.all },
+    { q: 'Attack on Titan', scope: Manga.all }
+  ]
+)
+```
+
+An enumerable `FederatedSearchResult` is returned, which can be iterated through with `#each`:
+
+```erb
+<ul>
+  <% results.each do |record| %>
+    <li><%= record.title %></li>
+  <% end %>
+</ul>
+
+
+<ul>
+  <!-- Attack on Titan appears first even though it was specified second, 
+       it's ranked higher because it's a closer match -->
+  <li>Attack on Titan</li>
+  <li>Harry Potter and the Philosopher's Stone</li>
+  <li>Harry Potter and the Chamber of Secrets</li>
+</ul>
+```
+
+The `queries` parameter may be a multi-search style hash with keys that are either classes, index names, or neither:
+
+```ruby
+results = Meilisearch::Rails.federated_search(
+  queries: {
+    Book => { q: 'Harry' },
+    Manga => { q: 'Attack on Titan' }
+  }
+)
+```
+
+```ruby
+results = Meilisearch::Rails.federated_search(
+  queries: {
+    'books_production' => { q: 'Harry', scope: Book.all },
+    'mangas_production' => { q: 'Attack on Titan', scope: Manga.all }
+  }
+)
+```
+
+```ruby
+results = Meilisearch::Rails.federated_search(
+  queries: {
+    'potter' => { q: 'Harry', scope: Book.all, index_uid: 'books_production' },
+    'titan' => { q: 'Attack on Titan', scope: Manga.all, index_uid: 'mangas_production' }
+  }
+)
+```
+
+### Loading records <!-- omit in toc -->
+
+Records are loaded when the `:scope` option is passed (may be a model or a relation), 
+or when a hash query is used with models as keys:
+
+```ruby
+results = Meilisearch::Rails.federated_search(
+  queries: [
+    { q: 'Harry', scope: Book },
+    { q: 'Attack on Titan', scope: Manga },
+  ]
+)
+```
+
+```ruby
+results = Meilisearch::Rails.federated_search(
+  queries: {
+    Book => { q: 'Harry' },
+    Manga => { q: 'Attack on Titan' }
+  }
+)
+```
+
+If the model is not provided, hashes are returned!
+
+### Scoping records <!-- omit in toc -->
+
+Any relation passed as `:scope` is used as the starting point when loading records:
+
+```ruby
+results = Meilisearch::Rails.federated_search(
+  queries: [
+    { q: 'Harry', scope: Book.where('year <= 2006') },
+    { q: 'Attack on Titan', scope: Manga.where(author: Author.find_by(name: 'Iseyama')) },
+  ]
+)
+```
+
+### Specifying the search index <!-- omit in toc -->
+
+In order of precedence, to figure out which index to search, Meilisearch Rails will check:
+
+1. `index_uid` options
+   ```ruby
+   results = Meilisearch::Rails.federated_search(
+     queries: [
+       # Searching the 'fantasy_books' index
+       { q: 'Harry', scope: Book, index_uid: 'fantasy_books' },
+     ]
+   )
+   ```
+2. The index associated with the model
+   ```ruby
+   results = Meilisearch::Rails.federated_search(
+     queries: [
+       # Searching the index associated with the Book model
+       # i. e. Book.index.uid
+       { q: 'Harry', scope: Book },
+     ]
+   )
+   ```
+3. The key when using hash queries
+   ```ruby
+   results = Meilisearch::Rails.federated_search(
+     queries: {
+       # Searching index 'books_production'
+       books_production: { q: 'Harry', scope: Book },
+     }
+   )
+   ```
+
+### Pagination and other options <!-- omit in toc -->
+
+In addition to queries, federated search also accepts `:federation` parameters which allow for finer control of the search:
+
+```ruby
+results = Meilisearch::Rails.federated_search(
+  queries: [
+    { q: 'Harry', scope: Book },
+    { q: 'Attack on Titan', scope: Manga },
+  ],
+  federation: { offset: 10, limit: 5 }
+)
+```
+See a full list of accepted options in [the meilisearch documentation](https://www.meilisearch.com/docs/reference/api/multi_search#federation).
+
+#### Metadata <!-- omit in toc -->
+
+The returned result from a federated search includes a `.metadata` attribute you can use to access everything other than the search hits:
+
+```ruby
+result.metadata
+# {
+#   "processingTimeMs" => 0,
+#   "limit" => 20,
+#   "offset" => 0,
+#   "estimatedTotalHits" => 2,
+#   "semanticHitCount": 0
+# }
+```
+
+The metadata contains facet stats and pagination stats, among others. See the full response in [the documentation](https://www.meilisearch.com/docs/reference/api/multi_search#federated-multi-search-requests).
+
+More details on federated search (such as available `federation:` options) can be found on [the official multi search documentation](https://www.meilisearch.com/docs/reference/api/multi_search).
+
 ## 🪛 Options
 
 ### Meilisearch configuration & environment
@@ -253,7 +503,7 @@ This gem supports:
 Specify the `:pagination_backend` in the configuration file:
 
 ```ruby
-MeiliSearch::Rails.configuration = {
+Meilisearch::Rails.configuration = {
   meilisearch_url: 'YourMeilisearchUrl',
   meilisearch_api_key: 'YourMeilisearchAPIKey',
   pagination_backend: :kaminari # :will_paginate
@@ -302,7 +552,7 @@ Then in your model you must extend `Pagy::Meilisearch`:
 
 ```rb
 class Book < ApplicationRecord
-  include MeiliSearch::Rails
+  include Meilisearch::Rails
   extend Pagy::Meilisearch
 
   meilisearch # ...
@@ -323,7 +573,7 @@ end
 <%== pagy_nav(@pagy) %>
 ```
 
-:warning: There is no need to set `pagination_backend` in the configuration block `MeiliSearch::Rails.configuration` for `pagy`.
+:warning: There is no need to set `pagination_backend` in the configuration block `Meilisearch::Rails.configuration` for `pagy`.
 
 Check [`ddnexus/pagy`](https://ddnexus.github.io/pagy/extras/meilisearch) for more information.
 
@@ -335,7 +585,7 @@ you have multiple ways to achieve this.
 By adding `active: false` in the configuration initializer:
 
 ```ruby
-MeiliSearch::Rails.configuration = {
+Meilisearch::Rails.configuration = {
   meilisearch_url: 'YourMeilisearchUrl',
   meilisearch_api_key: 'YourMeilisearchAPIKey',
   active: false
@@ -345,11 +595,11 @@ MeiliSearch::Rails.configuration = {
 Or you can disable programmatically:
 
 ```ruby
-MeiliSearch::Rails.deactivate! # all the following HTTP calls will be dismissed.
+Meilisearch::Rails.deactivate! # all the following HTTP calls will be dismissed.
 
 # or you can pass a block to it:
 
-MeiliSearch::Rails.deactivate! do
+Meilisearch::Rails.deactivate! do
   # every Meilisearch call here will be dismissed, no error will be raised.
   # after the block, Meilisearch state will be active. 
 end
@@ -358,7 +608,7 @@ end
 You can also activate if you deactivated earlier:
 
 ```ruby
-MeiliSearch::Rails.activate!
+Meilisearch::Rails.activate!
 ```
 
 :warning: These calls are persistent, so prefer to use the method with the block. This way, you will not forget to activate it afterward.
@@ -369,7 +619,7 @@ By default, the **index_uid** will be the class name, e.g. `Book`. You can custo
 
 ```ruby
 class Book < ActiveRecord::Base
-  include MeiliSearch::Rails
+  include Meilisearch::Rails
 
   meilisearch index_uid: 'MyCustomUID'
 end
@@ -380,7 +630,7 @@ end
 You can suffix the index UID with the current Rails environment by setting it globally:
 
 ```ruby
-MeiliSearch::Rails.configuration = {
+Meilisearch::Rails.configuration = {
   meilisearch_url: 'YourMeilisearchUrl',
   meilisearch_api_key: 'YourMeilisearchAPIKey',
   per_environment: true
@@ -399,7 +649,7 @@ You can add a custom attribute by using the `add_attribute` option or by using a
 
 ```ruby
 class Author < ApplicationRecord
-  include MeiliSearch::Rails
+  include Meilisearch::Rails
 
   meilisearch do
     attribute :first_name, :last_name
@@ -431,7 +681,7 @@ Note that the primary key must return a **unique value** otherwise your data cou
 
 ```ruby
 class Book < ActiveRecord::Base
-  include MeiliSearch::Rails
+  include Meilisearch::Rails
 
   meilisearch primary_key: :isbn # isbn is a column in your table definition.
 end
@@ -442,7 +692,7 @@ will be used as the reference to the document when Meilisearch needs it.
 
 ```rb
 class Book < ActiveRecord::Base
-  include MeiliSearch::Rails
+  include Meilisearch::Rails
 
   meilisearch primary_key: :my_custom_ms_id
 
@@ -461,7 +711,7 @@ As soon as you use those constraints, `add_documents` and `delete_documents` cal
 
 ```ruby
 class Book < ActiveRecord::Base
-  include MeiliSearch::Rails
+  include Meilisearch::Rails
 
   meilisearch if: :published?, unless: :premium?
 
@@ -484,7 +734,7 @@ You can index a record in several indexes using the `add_index` option:
 
 ```ruby
 class Book < ActiveRecord::Base
-  include MeiliSearch::Rails
+  include Meilisearch::Rails
 
   PUBLIC_INDEX_UID = 'Books'
   SECURED_INDEX_UID = 'PrivateBooks'
@@ -513,7 +763,7 @@ You may want to share an index between several models. You'll need to ensure you
 
 ```ruby
 class Cat < ActiveRecord::Base
-  include MeiliSearch::Rails
+  include Meilisearch::Rails
 
   meilisearch index_uid: 'Animals', primary_key: :ms_id
 
@@ -525,7 +775,7 @@ class Cat < ActiveRecord::Base
 end
 
 class Dog < ActiveRecord::Base
-  include MeiliSearch::Rails
+  include Meilisearch::Rails
 
   meilisearch index_uid: 'Animals', primary_key: :ms_id
 
@@ -543,7 +793,7 @@ You can configure the auto-indexing & auto-removal process to use a queue to per
 
 ```ruby
 class Book < ActiveRecord::Base
-  include MeiliSearch::Rails
+  include Meilisearch::Rails
 
   meilisearch enqueue: true # ActiveJob will be triggered using a `meilisearch` queue
 end
@@ -557,7 +807,7 @@ With **ActiveJob**:
 
 ```ruby
 class Book < ActiveRecord::Base
-  include MeiliSearch::Rails
+  include Meilisearch::Rails
 
   meilisearch enqueue: :trigger_job do
     attribute :title, :author, :description
@@ -587,7 +837,7 @@ With [**Sidekiq**](https://github.com/mperham/sidekiq):
 
 ```ruby
 class Book < ActiveRecord::Base
-  include MeiliSearch::Rails
+  include Meilisearch::Rails
 
   meilisearch enqueue: :trigger_sidekiq_job do
     attribute :title, :author, :description
@@ -617,7 +867,7 @@ With [**DelayedJob**](https://github.com/collectiveidea/delayed_job):
 
 ```ruby
 class Book < ActiveRecord::Base
-  include MeiliSearch::Rails
+  include Meilisearch::Rails
 
   meilisearch enqueue: :trigger_delayed_job do
     attribute :title, :author, :description
@@ -641,7 +891,7 @@ Extend a change to a related record.
 
 ```ruby
 class Author < ActiveRecord::Base
-  include MeiliSearch::Rails
+  include Meilisearch::Rails
 
   has_many :books
   # If your association uses belongs_to
@@ -651,7 +901,7 @@ class Author < ActiveRecord::Base
 end
 
 class Book < ActiveRecord::Base
-  include MeiliSearch::Rails
+  include Meilisearch::Rails
 
   belongs_to :author
   after_touch :index!
@@ -670,7 +920,7 @@ With **Sequel**, you can use the `touch` plugin to propagate changes.
 ```ruby
 # app/models/author.rb
 class Author < Sequel::Model
-  include MeiliSearch::Rails
+  include Meilisearch::Rails
 
   one_to_many :books
 
@@ -692,7 +942,7 @@ end
 
 # app/models/book.rb
 class Book < Sequel::Model
-  include MeiliSearch::Rails
+  include Meilisearch::Rails
 
   many_to_one :author
   after_touch :index!
@@ -715,7 +965,7 @@ You can strip all HTML tags from your attributes with the `sanitize` option.
 
 ```ruby
 class Book < ActiveRecord::Base
-  include MeiliSearch::Rails
+  include Meilisearch::Rails
 
   meilisearch sanitize: true
 end
@@ -727,7 +977,7 @@ You can force the UTF-8 encoding of all your attributes using the `force_utf8_en
 
 ```ruby
 class Book < ActiveRecord::Base
-  include MeiliSearch::Rails
+  include Meilisearch::Rails
 
   meilisearch force_utf8_encoding: true
 end
@@ -739,7 +989,7 @@ You can eager load associations using `meilisearch_import` scope.
 
 ```ruby
 class Author < ActiveRecord::Base
-  include MeiliSearch::Rails
+  include Meilisearch::Rails
 
   has_many :books
 
@@ -792,7 +1042,7 @@ You can disable exceptions that could be raised while trying to reach Meilisearc
 
 ```ruby
 class Book < ActiveRecord::Base
-  include MeiliSearch::Rails
+  include Meilisearch::Rails
 
   # Only raise exceptions in development environment.
   meilisearch raise_on_failure: Rails.env.development?
@@ -807,7 +1057,7 @@ You can force indexing and removing to be synchronous by setting the following o
 
 ```ruby
 class Book < ActiveRecord::Base
-  include MeiliSearch::Rails
+  include Meilisearch::Rails
 
   meilisearch synchronous: true
 end
@@ -820,7 +1070,7 @@ You can disable auto-indexing and auto-removing setting the following options:
 
 ```ruby
 class Book < ActiveRecord::Base
-  include MeiliSearch::Rails
+  include Meilisearch::Rails
 
   meilisearch auto_index: false, auto_remove: false
 end