meilisearch-rails 0.6.0 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0d3aeaf9f6e2549c11cdcd7cf5920fecb819fb1b2f03a25af11c19a5dd09444
-  data.tar.gz: 0af07156e3e3ea69d492745f806751e2213ad7148553f57396528ad54fa3f02a
+  metadata.gz: affe6d35bf6c1c626570b32ae605e3b1e826c16c86e87d9ea4cc2e67cb4c1512
+  data.tar.gz: b950799c5e8296d5fcbc2e194480cbbc4fa5a60b704708db55859f7d0a6d8e4c
 SHA512:
-  metadata.gz: a49c6d3b48de31033515e61c9fd182842d5d7d7ba90e140b6447339eeb6473139f3de4f1c3428f48a9176f3c36c5080ebc198897f4b53900f74e416bb817eaf1
-  data.tar.gz: 63805d38ba88e0b020a0a147cce244ec35a0fb2a93715ff5b62df77ca87021b2b11581647626b2c76eaddc26ad15ab0a8e9d4e82c7e1895095829b7cce74965c
+  metadata.gz: 7a84a8fbbb00122c28c90c5573f1e5a93a3012a89f516ea35df68eba294aea20b7e169906400ad27b17d281359a2d3fb5933eda1338aecb2941e206b21b00002
+  data.tar.gz: c735267b627ef2100fc0cdd52bffa8d323d634b865c5ef5ba870d3839f8e2a0d03244e5478a056a26295fbd827c6ecbbd40a2994df8805fa194925add4c8533a

data/README.md

@@ -30,6 +30,7 @@
 - [📖 Documentation](#-documentation)
 - [🤖 Compatibility with Meilisearch](#-compatibility-with-meilisearch)
 - [🚀 Getting Started](#-getting-started)
+- [Compatibility](#-compatibility)
 - [⚙️ Settings](#️-settings)
 - [🔍 Custom search](#-custom-search)
 - [🪛 Options](#-options)
@@ -43,6 +44,7 @@
     - [Relations](#relations)
     - [Sanitize attributes](#sanitize-attributes)
     - [UTF-8 encoding](#utf-8-encoding)
+    - [Eager loading](#eager-loading)
   - [Manual operations](#manual-operations)
     - [Indexing & deletion](#indexing--deletion)
     - [Access the underlying index object](#access-the-underlying-index-object)
@@ -58,7 +60,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.27.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.27.0).
+This package only guarantees the compatibility with the [version v0.28.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.28.0).
 
 ## 🔧 Installation <!-- omit in toc -->
 
@@ -190,6 +192,10 @@ MeiliSearch::Rails.configuration = {
 }
 ```
 
+## Compatibility
+
+If your model already has methods that meilisearch-rails defines such as `search` and `index`, they will not be redefined. You can target the meilisearch-rails-defined methods by prefixing with `ms_`, e.g. `Book.ms_search('harry potter')`.
+
 ## ⚙️ Settings
 
 You can configure the index settings by adding them inside the `meilisearch` block as shown below:
@@ -262,19 +268,7 @@ end
 
 #### Index UID according to the environment <!-- omit in toc -->
 
-You can suffix the index UID with the current Rails environment using one of the following options:
-
-By defining directly in your model:
-
-```ruby
-class Book < ActiveRecord::Base
-  include MeiliSearch::Rails
-
-  meilisearch per_environment: true
-end
-```
-
-Or setting it globally:
+You can suffix the index UID with the current Rails environment by setting it globally:
 
 ```ruby
 MeiliSearch::Rails.configuration = {
@@ -284,7 +278,7 @@ MeiliSearch::Rails.configuration = {
 }
 ```
 
-Both options will make your index name look like this `"Book_#{Rails.env}"`.
+This way your index UID will look like this `"Book_#{Rails.env}"`.
 
 ### Index configuration
 
@@ -324,15 +318,33 @@ end
 
 By default, the primary key is based on your record's id. You can change this behavior by specifying the `primary_key:` option.
 
-Note that the primary key must have a **unique value**.
+Note that the primary key must return a **unique value** otherwise your data could be overwritten.
 
 ```ruby
 class Book < ActiveRecord::Base
   include MeiliSearch::Rails
 
-  meilisearch primary_key: 'ISBN'
+  meilisearch primary_key: :isbn # isbn is a column in your table definition.
+end
+```
+
+You can also set the `primary_key` as a method, this method will be evaluated in runtime, and its return 
+will be used as the reference to the document when Meilisearch needs it.
+
+```rb
+class Book < ActiveRecord::Base
+  include MeiliSearch::Rails
+
+  meilisearch primary_key: :my_custom_ms_id
+
+  private
+
+  def my_custom_ms_id
+    "isbn_#{primary_key}" # ensure this return is unique, otherwise you'll lose data.
+  end
 end
 ```
+
 #### Conditional indexing
 
 You can control if a record must be indexed by using the `if:` or `unless:` options.<br>
@@ -612,6 +624,20 @@ class Book < ActiveRecord::Base
 end
 ```
 
+#### Eager loading
+
+You can eager load associations using `meilisearch_import` scope.
+
+```ruby
+class Author < ActiveRecord::Base
+  include MeiliSearch::Rails
+
+  has_many :books
+
+  scope :meilisearch_import, -> { includes(:books) }
+end
+```
+
 ### Manual operations
 
 #### Indexing & deletion

data/lib/meilisearch/rails/configuration.rb

@@ -16,6 +16,7 @@ module MeiliSearch
           configuration[:meilisearch_host] || 'http://localhost:7700',
           configuration[:meilisearch_api_key],
           configuration.slice(:timeout, :max_retries)
+                       .merge(client_agents: MeiliSearch::Rails.qualified_version)
         )
       end
     end

data/lib/meilisearch/rails/version.rb

@@ -2,6 +2,10 @@
 
 module MeiliSearch
   module Rails
-    VERSION = '0.6.0'
+    VERSION = '0.7.2'
+
+    def self.qualified_version
+      "Meilisearch Rails (v#{VERSION})"
+    end
   end
 end

data/lib/meilisearch-rails.rb

@@ -233,9 +233,13 @@ module MeiliSearch
       def initialize(index_uid, raise_on_failure, options)
         client = MeiliSearch::Rails.client
         primary_key = options[:primary_key] || MeiliSearch::Rails::IndexSettings::DEFAULT_PRIMARY_KEY
-        client.create_index(index_uid, { primaryKey: primary_key })
-        @index = client.index(index_uid)
         @raise_on_failure = raise_on_failure.nil? || raise_on_failure
+
+        SafeIndex.log_or_throw(nil, @raise_on_failure) do
+          client.create_index(index_uid, { primary_key: primary_key })
+        end
+
+        @index = client.index(index_uid)
       end
 
       ::MeiliSearch::Index.instance_methods(false).each do |m|
@@ -273,7 +277,7 @@ module MeiliSearch
 
       def self.log_or_throw(method, raise_on_failure, &block)
         yield
-      rescue ::MeiliSearch::ApiError => e
+      rescue ::MeiliSearch::TimeoutError, ::MeiliSearch::ApiError => e
         raise e if raise_on_failure
 
         # log the error
@@ -282,7 +286,7 @@ module MeiliSearch
         case method.to_s
         when 'search'
           # some attributes are required
-          { 'hits' => [], 'hitsPerPage' => 0, 'page' => 0, 'facetsDistribution' => {}, 'error' => e }
+          { 'hits' => [], 'hitsPerPage' => 0, 'page' => 0, 'facetDistribution' => {}, 'error' => e }
         else
           # empty answer
           { 'error' => e }
@@ -460,7 +464,7 @@ module MeiliSearch
             end
             last_task = index.add_documents(documents)
           end
-          index.wait_for_task(last_task['uid']) if last_task && (synchronous || options[:synchronous])
+          index.wait_for_task(last_task['taskUid']) if last_task && (synchronous || options[:synchronous])
         end
         nil
       end
@@ -476,7 +480,7 @@ module MeiliSearch
 
           index = SafeIndex.new(ms_index_uid(options), true, options)
           task = index.update_settings(final_settings)
-          index.wait_for_task(task['uid']) if synchronous
+          index.wait_for_task(task['taskUid']) if synchronous
         end
       end
 
@@ -486,7 +490,7 @@ module MeiliSearch
 
           index = ms_ensure_init(options, settings)
           task = index.add_documents(documents.map { |d| settings.get_attributes(d).merge ms_pk(options) => ms_primary_key_of(d, options) })
-          index.wait_for_task(task['uid']) if synchronous || options[:synchronous]
+          index.wait_for_task(task['taskUid']) if synchronous || options[:synchronous]
         end
       end
 
@@ -583,7 +587,7 @@ module MeiliSearch
         end
 
         def ms_facets_distribution
-          @ms_json['facetsDistribution']
+          @ms_json['facetDistribution']
         end
 
         private
@@ -595,23 +599,20 @@ 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) }
 
-          params.delete(:page)
-          params.delete(:hitsPerPage)
           params[:limit] = 200
         end
 
         # Returns raw json hits as follows:
-        # {"hits"=>[{"id"=>"13", "href"=>"apple", "name"=>"iphone"}], "offset"=>0, "limit"=>|| 20, "nbHits"=>1,
-        #  "exhaustiveNbHits"=>false, "processingTimeMs"=>0, "query"=>"iphone"}
+        # {"hits"=>[{"id"=>"13", "href"=>"apple", "name"=>"iphone"}], "offset"=>0, "limit"=>|| 20, "estimatedTotalHits"=>1,
+        #  "processingTimeMs"=>0, "query"=>"iphone"}
         json = ms_raw_search(query, params)
 
-        # Returns the ids of the hits: 13
-        hit_ids = json['hits'].map { |hit| hit[ms_pk(meilisearch_options).to_s] }
-
         # condition_key gets the primary key of the document; looks for "id" on the options
         condition_key = if defined?(::Mongoid::Document) && include?(::Mongoid::Document)
                           ms_primary_key_method.in
@@ -619,6 +620,23 @@ module MeiliSearch
                           ms_primary_key_method
                         end
 
+        # The condition_key must be a valid column otherwise, the `.where` below will not work
+        # Since we provide a way to customize the primary_key value, `ms_pk(meilisearch_options)` may not
+        # respond with a valid database column. The blocks below prevent that from happening.
+        has_virtual_column_as_pk = if defined?(::Sequel::Model) && self < Sequel::Model
+                                     meilisearch_options[:type].columns.map(&:to_s).exclude?(condition_key.to_s)
+                                   else
+                                     meilisearch_options[:type].columns.map(&:name).map(&:to_s).exclude?(condition_key.to_s)
+                                   end
+
+        condition_key = meilisearch_options[:type].primary_key if has_virtual_column_as_pk
+
+        hit_ids = if has_virtual_column_as_pk
+                    json['hits'].map { |hit| hit[condition_key] }
+                  else
+                    json['hits'].map { |hit| hit[ms_pk(meilisearch_options).to_s] }
+                  end
+
         # meilisearch_options[:type] refers to the Model name (e.g. Product)
         # results_by_id creates a hash with the primaryKey of the document (id) as the key and doc itself as the value
         # {"13"=>#<Product id: 13, name: "iphone", href: "apple", tags: nil, type: nil,
@@ -827,7 +845,8 @@ module MeiliSearch
 
       def ms_find_in_batches(batch_size, &block)
         if (defined?(::ActiveRecord) && ancestors.include?(::ActiveRecord::Base)) || respond_to?(:find_in_batches)
-          find_in_batches(batch_size: batch_size, &block)
+          scope = respond_to?(:meilisearch_import) ? meilisearch_import : all
+          scope.find_in_batches(batch_size: batch_size, &block)
         elsif defined?(::Sequel::Model) && self < Sequel::Model
           dataset.extension(:pagination).each_page(batch_size, &block)
         else

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.18'
+  s.add_dependency 'meilisearch', '~> 0.19.2'
 end

metadata

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