meilisearch-rails 0.7.3 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 849d3f11092d279468f2303406fac8ed52849490cd5f044d0f111c2731593f76
-  data.tar.gz: 41ec2f87a63e74bb6c4237435490b381f80def5dee0f8393c3a40cd583386a03
+  metadata.gz: 95c22d57895ceb454d6026064d0e27d4f0abcba6cf6e8d30171bde564174bf83
+  data.tar.gz: 45e490dae97786d644cbd0c4bd3f63e84d02b7cffc3b4cb1fc5f393c53a61b80
 SHA512:
-  metadata.gz: c6fb870cced8f9e395f5bbc23404331d932b8ebe92921f9867ce53e4b682a114d4a39a0d319a44395fe9d2e4f5907752ca923febee4503b4fa23df437f2237ab
-  data.tar.gz: d74ded33afca229deb79ed57ab820c0737f1bb2b3f258aafa4155a3d29515e24a0b9cb5680d106d0ebd9e39892f9a9e45aed8a50b934669558b8c9c11d1eddb5
+  metadata.gz: 9cf32c4a4a74f4c29be2e89ed97fc592de962402001473ddfb0a9cbb8d8c258aec87f2ccca18efce1db338e403065df08159e6f31d96d83060cf0815d2c0c2e6
+  data.tar.gz: cdcbc8944ab5be9ddf5e8b60a56620ab843488a8699b81e5df152127d8ce7dab79ab1bfc1430680d3f15b472f121196b248c69fae30c67d9fc405b421da1c010

data/Gemfile

@@ -1,5 +1,7 @@
 source 'https://rubygems.org'
 
+# gem 'meilisearch', path: '../meilisearch-ruby'
+
 gemspec
 
 gem 'rubysl', '~> 2.0', platform: :rbx if defined?(RUBY_ENGINE) && RUBY_ENGINE == 'rbx'

data/README.md

@@ -7,7 +7,7 @@
 <h4 align="center">
   <a href="https://github.com/meilisearch/meilisearch">Meilisearch</a> |
   <a href="https://docs.meilisearch.com">Documentation</a> |
-  <a href="https://slack.meilisearch.com">Slack</a> |
+  <a href="https://discord.meilisearch.com">Discord</a> |
   <a href="https://roadmap.meilisearch.com/tabs/1-under-consideration">Roadmap</a> |
   <a href="https://www.meilisearch.com">Website</a> |
   <a href="https://docs.meilisearch.com/faq">FAQ</a>
@@ -23,18 +23,20 @@
 
 **Meilisearch Rails** is the Meilisearch integration for Ruby on Rails developers.
 
-**Meilisearch** is an open-source search engine. [Discover what Meilisearch is!](https://github.com/meilisearch/meilisearch)
+**Meilisearch** is an open-source search engine. [Learn more about Meilisearch.](https://github.com/meilisearch/meilisearch)
 
 ## Table of Contents <!-- omit in toc -->
 
 - [📖 Documentation](#-documentation)
 - [🤖 Compatibility with Meilisearch](#-compatibility-with-meilisearch)
-- [🚀 Getting Started](#-getting-started)
+- [🚀 Getting started](#-getting-started)
 - [Compatibility](#-compatibility)
 - [⚙️ Settings](#️-settings)
 - [🔍 Custom search](#-custom-search)
 - [🪛 Options](#-options)
   - [Meilisearch configuration & environment](#meilisearch-configuration--environment)
+  - [Pagination with `kaminari` or `will_paginate`](#backend-pagination-with-kaminari-or-will_paginate-)
+  - [Pagination with `pagy`](#backend-pagination-with-pagy-)
   - [Index configuration](#index-configuration)
     - [Custom attribute definition](#custom-attribute-definition)
     - [Custom primary key](#custom-primary-key)
@@ -60,7 +62,7 @@ To learn more about Meilisearch, check out our [Documentation](https://docs.meil
 
 ## 🤖 Compatibility with Meilisearch
 
-This package only guarantees the compatibility with the [version v0.28.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.28.0).
+This package only guarantees the compatibility with the [version v1.0.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v1.0.0).
 
 ## 🔧 Installation <!-- omit in toc -->
 
@@ -91,7 +93,7 @@ docker run -it --rm -p 7700:7700 getmeili/meilisearch:latest meilisearch --maste
 
 NB: you can also download Meilisearch from **Homebrew** or **APT**.
 
-## 🚀 Getting Started
+## 🚀 Getting started
 
 #### Configuration <!-- omit in toc -->
 
@@ -99,7 +101,7 @@ Create a new file `config/initializers/meilisearch.rb` to setup your `MEILISEARC
 
 ```ruby
 MeiliSearch::Rails.configuration = {
-  meilisearch_host: 'YourMeilisearchHost', # example: http://localhost:7700
+  meilisearch_url: 'YourMeilisearchUrl', # example: http://localhost:7700
   meilisearch_api_key: 'YourMeilisearchAPIKey',
 }
 ```
@@ -138,46 +140,6 @@ hits.each do |hit|
 end
 ```
 
-#### Backend Pagination <!-- omit in toc -->
-
-This gem supports:
-- [kaminari](https://github.com/amatsuda/kaminari)
-- [pagy](https://github.com/ddnexus/pagy)
-- [will_paginate](https://github.com/mislav/will_paginate).
-
-Specify the `:pagination_backend` in the configuration file:
-
-```ruby
-MeiliSearch::Rails.configuration = {
-  meilisearch_host: 'YourMeilisearchHost',
-  meilisearch_api_key: 'YourMeilisearchAPIKey',
-  pagination_backend: :kaminari #:will_paginate
-}
-```
-
-Then, as soon as you use the `search` method, the returning results will be paginated:
-
-```ruby
-# controller
-@hits = Book.search('harry potter')
-
-# views
-<% @hits.each do |hit| %>
-  <%= hit.title %>
-  <%= hit.author %>
-<% end %>
-
-<%= paginate @hits %> # if using kaminari
-
-<%= will_paginate @hits %> # if using will_paginate
-```
-
-The **number of hits per page defaults to 20**, you can customize it by adding the `hits_per_page` parameter to your search:
-
-```ruby
-Book.search('harry potter', hits_per_page: 10)
-```
-
 #### Extra Configuration <!-- omit in toc -->
 
 Requests made to Meilisearch may timeout and retry. To adapt the behavior to
@@ -185,7 +147,7 @@ your needs, you can change the parameters during configuration:
 
 ```ruby
 MeiliSearch::Rails.configuration = {
-  meilisearch_host: 'YourMeilisearchHost',
+  meilisearch_url: 'YourMeilisearchUrl',
   meilisearch_api_key: 'YourMeilisearchAPIKey',
   timeout: 2,
   max_retries: 1,
@@ -223,6 +185,7 @@ class Book < ApplicationRecord
     attributes_to_highlight ['*']
     attributes_to_crop [:description]
     crop_length 10
+    pagination max_total_hits: 1000
   end
 end
 ```
@@ -236,6 +199,13 @@ All the supported options are described in the [search parameters](https://docs.
 ```ruby
 Book.search('Harry', attributes_to_highlight: ['*'])
 ```
+
+Then it's possible to retrieve the highlighted or cropped value by using the `formatted` method available in the object.
+
+```ruby
+harry_book.formatted # => {"id"=>"1", "name"=>"<em>Harry</em> Potter", "description"=>…
+```
+
 👉 Don't forget that `attributes_to_highlight`, `attributes_to_crop`, and
 `crop_length` can be set up in the `meilisearch` block of your model.
 
@@ -254,6 +224,89 @@ Book.search('*', sort: ['title:asc'])
 
 ### Meilisearch configuration & environment
 
+### Backend Pagination with `kaminari` or `will_paginate` <!-- omit in toc -->
+
+This gem supports:
+- [kaminari](https://github.com/amatsuda/kaminari)
+- [will_paginate](https://github.com/mislav/will_paginate)
+
+Specify the `:pagination_backend` in the configuration file:
+
+```ruby
+MeiliSearch::Rails.configuration = {
+  meilisearch_url: 'YourMeilisearchUrl',
+  meilisearch_api_key: 'YourMeilisearchAPIKey',
+  pagination_backend: :kaminari # :will_paginate
+}
+```
+
+Then, as soon as you use the `search` method, the returning results will be paginated:
+
+```ruby
+# controller
+@hits = Book.search('harry potter')
+
+# views
+<% @hits.each do |hit| %>
+  <%= hit.title %>
+  <%= hit.author %>
+<% end %>
+
+<%= paginate @hits %> # if using kaminari
+
+<%= will_paginate @hits %> # if using will_paginate
+```
+
+The **number of hits per page defaults to 20**, you can customize it by adding the `hits_per_page` parameter to your search:
+
+```ruby
+Book.search('harry potter', hits_per_page: 10)
+```
+
+### Backend Pagination with `pagy` <!-- omit in toc -->
+
+This gem supports [pagy](https://github.com/ddnexus/pagy) to paginate your search results.
+
+To use `pagy` with your `meilisearch-rails` you need to:
+
+Add the `pagy` gem to your Gemfile.
+Create a new initializer `pagy.rb` with this:
+
+```rb
+# config/initializers/pagy.rb
+
+require 'pagy/extras/meilisearch'
+```
+
+Then in your model you must extend `Pagy::Meilisearch`:
+
+```rb
+class Book < ApplicationRecord
+  include MeiliSearch::Rails
+  extend Pagy::Meilisearch
+
+  meilisearch # ...
+end
+```
+
+And in your controller and view:
+
+```rb
+# controllers/books_controller.rb
+def search
+  hits = Book.pagy_search(params[:query])
+  @pagy, @hits = pagy_meilisearch(hits, items: 25)
+end
+
+
+# views/books/search.html.rb
+<%== pagy_nav(@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.
+
 #### Deactivate Meilisearch in certain moments
 
 By default HTTP connections to the Meilisearch URL is always active, but sometimes you want to disable the HTTP requests in a particular moment or environment.<br>
@@ -263,7 +316,7 @@ By adding `active: false` in the configuration initializer:
 
 ```ruby
 MeiliSearch::Rails.configuration = {
-  meilisearch_host: 'YourMeilisearchHost',
+  meilisearch_url: 'YourMeilisearchUrl',
   meilisearch_api_key: 'YourMeilisearchAPIKey',
   active: false
 }
@@ -308,7 +361,7 @@ You can suffix the index UID with the current Rails environment by setting it gl
 
 ```ruby
 MeiliSearch::Rails.configuration = {
-  meilisearch_host: 'YourMeilisearchHost',
+  meilisearch_url: 'YourMeilisearchUrl',
   meilisearch_api_key: 'YourMeilisearchAPIKey',
   per_environment: true
 }

data/lib/meilisearch/rails/configuration.rb

@@ -45,7 +45,7 @@ module MeiliSearch
         return black_hole unless active?
 
         ::MeiliSearch::Client.new(
-          configuration[:meilisearch_host] || 'http://localhost:7700',
+          configuration[:meilisearch_url] || 'http://localhost:7700',
           configuration[:meilisearch_api_key],
           configuration.slice(:timeout, :max_retries)
                        .merge(client_agents: MeiliSearch::Rails.qualified_version)

data/lib/meilisearch/rails/errors.rb

@@ -7,7 +7,7 @@ module MeiliSearch
     class NotConfigured < StandardError
       def message
         'Please configure Meilisearch. Set MeiliSearch::Rails.configuration = ' \
-          "{meilisearch_host: 'YOUR_MEILISEARCH_HOST', meilisearch_api_key: 'YOUR_API_KEY'}"
+          "{meilisearch_url: 'YOUR_MEILISEARCH_URL', meilisearch_api_key: 'YOUR_API_KEY'}"
       end
     end
   end

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

@@ -17,30 +17,18 @@ module MeiliSearch
           end
         end
 
-        def limit(_num)
-          # noop
-          self
-        end
-
-        def offset(_num)
-          # noop
-          self
-        end
+        def self.create(results, total_hits, options = {})
+          offset = ((options[:page] - 1) * options[:per_page])
+          array = new results, limit: options[:per_page], offset: offset, total_count: total_hits
 
-        class << self
-          def create(results, total_hits, options = {})
-            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 = ([nil] * offset) + results
-              array = new results, offset: offset, limit: options[:per_page], total_count: total_hits
-            end
-
-            array
+          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
           end
+
+          array
         end
       end
     end

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

@@ -11,9 +11,7 @@ module MeiliSearch
       class WillPaginate
         def self.create(results, total_hits, options = {})
           ::WillPaginate::Collection.create(options[:page], options[:per_page], total_hits) do |pager|
-            start = (options[:page] - 1) * options[:per_page]
-            paginated_results = results[start, options[:per_page]]
-            pager.replace paginated_results
+            pager.replace results
           end
         end
       end

data/lib/meilisearch/rails/pagination.rb

@@ -5,15 +5,28 @@ module MeiliSearch
       autoload :Kaminari, 'meilisearch/rails/pagination/kaminari'
 
       def self.create(results, total_hits, options = {})
-        return results if MeiliSearch::Rails.configuration[:pagination_backend].nil?
+        pagination_backend = MeiliSearch::Rails.configuration[:pagination_backend]
 
-        begin
-          backend = MeiliSearch::Rails.configuration[:pagination_backend].to_s.classify
+        if pagination_backend.nil? || (is_pagy = pagination_backend.to_s == 'pagy')
+          log_pagy_error if is_pagy
 
-          ::MeiliSearch::Rails::Pagination.const_get(backend).create(results, total_hits, options)
-        rescue NameError
-          raise(BadConfiguration, 'Unknown pagination backend')
+          return results
         end
+
+        load_pagination!(pagination_backend, results, total_hits, options)
+      end
+
+      def self.log_pagy_error
+        (::Rails.logger || Logger.new($stdout))
+          .warning('[meilisearch-rails] Remove `pagination_backend: :pagy` from your initializer, `pagy` it is not required for `pagy`')
+      end
+
+      def self.load_pagination!(pagination_backend, results, total_hits, options)
+        ::MeiliSearch::Rails::Pagination
+          .const_get(pagination_backend.to_s.classify)
+          .create(results, total_hits, options)
+      rescue NameError
+        raise(BadConfiguration, 'Invalid `pagination_backend:` configuration, check your initializer.')
       end
     end
   end

data/lib/meilisearch/rails/version.rb

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

data/lib/meilisearch-rails.rb

@@ -59,8 +59,11 @@ module MeiliSearch
         attributesToHighlight
         attributesToCrop
         cropLength
+        pagination
       ].freeze
 
+      CAMELIZE_OPTIONS = %i[pagination].freeze
+
       OPTIONS.each do |option|
         define_method option do |value|
           instance_variable_set("@#{option}", value)
@@ -199,7 +202,13 @@ module MeiliSearch
         settings = {}
         OPTIONS.each do |k|
           v = get_setting(k)
-          settings[k] = v unless v.nil?
+          next if v.nil?
+
+          settings[k] = if CAMELIZE_OPTIONS.include?(k) && v.is_a?(Hash)
+                          v.transform_keys { |key| key.to_s.camelize(:lower) }
+                        else
+                          v
+                        end
         end
         settings
       end
@@ -284,7 +293,7 @@ module MeiliSearch
         raise e if raise_on_failure
 
         # log the error
-        (::Rails.logger || Logger.new($stdout)).error("[meilisearch-rails] #{e.message}")
+        (::Rails.logger || Logger.new($stdout)).info("[meilisearch-rails] #{e.message}")
         # return something
         case method.to_s
         when 'search'
@@ -602,18 +611,15 @@ module MeiliSearch
 
       def ms_search(query, params = {})
         if MeiliSearch::Rails.configuration[:pagination_backend]
-          page = params[:page].nil? ? params[:page] : params[:page].to_i
-          hits_per_page = params[:hitsPerPage].nil? ? params[:hitsPerPage] : params[:hitsPerPage].to_i
-          hits_per_page ||= params[:hits_per_page].nil? ? params[:hits_per_page] : params[:hits_per_page].to_i
-
-          %i[page hitsPerPage hits_per_page].each { |param| params.delete(param) }
+          %i[page hitsPerPage hits_per_page].each do |key|
+            params[key.to_s.underscore.to_sym] = params[key].to_i if params.key?(key)
+          end
 
-          params[:limit] = 200
+          # It is required to activate the finite pagination in Meilisearch v0.30 (or newer),
+          # to have at least `hits_per_page` defined or `page` in the search request.
+          params[:page] ||= 1
         end
 
-        # Returns raw json hits as follows:
-        # {"hits"=>[{"id"=>"13", "href"=>"apple", "name"=>"iphone"}], "offset"=>0, "limit"=>|| 20, "estimatedTotalHits"=>1,
-        #  "processingTimeMs"=>0, "query"=>"iphone"}
         json = ms_raw_search(query, params)
 
         # condition_key gets the primary key of the document; looks for "id" on the options
@@ -656,11 +662,7 @@ module MeiliSearch
           end
         end.compact
 
-        total_hits = json['hits'].length
-        hits_per_page ||= 20
-        page ||= 1
-
-        res = MeiliSearch::Rails::Pagination.create(results, total_hits, meilisearch_options.merge(page: page, per_page: hits_per_page))
+        res = Pagination.create(results, json['totalHits'], meilisearch_options.merge(page: json['page'], per_page: json['hitsPerPage']))
         res.extend(AdditionalMethods)
         res.send(:ms_init_raw_answer, json)
         res

data/meilisearch-rails.gemspec

@@ -34,5 +34,5 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 2.6.0'
 
-  s.add_dependency 'meilisearch', '~> 0.19.2'
+  s.add_dependency 'meilisearch', '~> 0.22.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: meilisearch-rails
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.8.1
 platform: ruby
 authors:
 - Meili
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-28 00:00:00.000000000 Z
+date: 2023-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: meilisearch
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.2
+        version: 0.22.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.2
+        version: 0.22.0
 description: Meilisearch integration for Ruby on Rails. See https://github.com/meilisearch/meilisearch
 email: bonjour@meilisearch.com
 executables: []