meilisearch-rails 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b992f0ae920706899ea36534585a605e0ce7dcee087bcb5aa5a1fa7f29fbede
-  data.tar.gz: 7d4339178919b50b791f129485dc20646fb7122910073f99a469ef15e3da7452
+  metadata.gz: 2957f44b71394e8f2c6c3e3fa8aa3907b85ef4405c2cbb5230080383eebbe034
+  data.tar.gz: 99ebb927e9194b10746355e5ba3ae44853fa4c1ee2e98f6818e910c073f01b8d
 SHA512:
-  metadata.gz: 202e76dd8aa69ee7440698ac6af2cff4d2b80016f50f39da95c24f40a824f2095a8481b1f6db64d95d07428d406739fa04513c8efa0ee29d0bbe95a6d77f7183
-  data.tar.gz: eba66cf0d9a4a5059c40325e8b848478a0268d3650d8f0aacc41598d68c555f6f793d56c19456f79ed08b08fd748a7a1474b2621cd9b211a7dd1c27502fb685c
+  metadata.gz: '08834c370f32354ad47eb1d904212e8535a5b47f89a705ad3aeb42bf7a4768b0dd51f4198b86855f3691c886ccac850f9ef88e6528433a90a9774d6d3bacff0c'
+  data.tar.gz: 22ac7b9564df2fef7f23b5227578713d095492f615e9fa652c0d1fb55167d1d9188fda65e4b683db8d413cb38086e27930d1dd6077975b088fd89dfbd1ac8114

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)
@@ -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:
@@ -312,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>
@@ -600,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.7.0'
+    VERSION = '0.7.1'
+
+    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
@@ -609,9 +613,6 @@ module MeiliSearch
         #  "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.19'
+  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.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Meili
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-12 00:00:00.000000000 Z
+date: 2022-08-01 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'
+        version: 0.19.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.19'
+        version: 0.19.2
 description: Meilisearch integration for Ruby on Rails. See https://github.com/meilisearch/meilisearch
 email: bonjour@meilisearch.com
 executables: []