meilisearch-rails 0.5.2 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2541e903db43e95ae8290c07308159dc9d724949dc1ffa27214df3e52cd37fe6
-  data.tar.gz: 8b4e32b34e9e3c4fbae0e5c21efa20d87e611ebada16889ba01ba236343b0f6d
+  metadata.gz: 2957f44b71394e8f2c6c3e3fa8aa3907b85ef4405c2cbb5230080383eebbe034
+  data.tar.gz: 99ebb927e9194b10746355e5ba3ae44853fa4c1ee2e98f6818e910c073f01b8d
 SHA512:
-  metadata.gz: 1eba16d0d03695d817998c5249a1ad33d343df4816332a63c7e7b220d42cd2734b9d1ed90e1893a12de6b67d5ed4b1f4e4ca8cad21f3d3e206f8e108f3ffc07f
-  data.tar.gz: 53ffa781649f9370e7fe35aa5b7263f8792a7f04ede7c28da6e2f6d85b015ae2fcef236affeea659b11c538385a39ca50fb13dab7857d50e8e76067b813f7dfc
+  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)
@@ -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 -->
 
@@ -170,10 +172,10 @@ Then, as soon as you use the `search` method, the returning results will be pagi
 <%= will_paginate @hits %> # if using will_paginate
 ```
 
-The **number of hits per page defaults to 20**, you can customize it by adding the `hitsPerPage` parameter to your search:
+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', hitsPerPage: 10)
+Book.search('harry potter', hits_per_page: 10)
 ```
 
 #### Extra Configuration <!-- 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:
@@ -228,7 +234,7 @@ Check the dedicated section of the documentation, for more information on the [s
 All the supported options are described in the [search parameters](https://docs.meilisearch.com/reference/features/search_parameters.html) section of the documentation.
 
 ```ruby
-Book.search('Harry', attributesToHighlight: ['*'])
+Book.search('Harry', attributes_to_highlight: ['*'])
 ```
 👉 Don't forget that `attributes_to_highlight`, `attributes_to_crop`, and
 `crop_length` can be set up in the `meilisearch` block of your model.
@@ -256,24 +262,24 @@ By default, the **index_uid** will be the class name, e.g. `Book`. You can custo
 class Book < ActiveRecord::Base
   include MeiliSearch::Rails
 
-  meilisearch index_uid: 'MyCustomUID' do
-  end
+  meilisearch index_uid: 'MyCustomUID'
 end
 ```
 
 #### Index UID according to the environment <!-- omit in toc -->
 
-You can suffix the index UID with the current Rails environment using the following option:
+You can suffix the index UID with the current Rails environment by setting it globally:
 
 ```ruby
-class Book < ActiveRecord::Base
-  include MeiliSearch::Rails
-
-  meilisearch per_environment: true do # The index UID will be "Book_#{Rails.env}"
-  end
-end
+MeiliSearch::Rails.configuration = {
+  meilisearch_host: 'YourMeilisearchHost',
+  meilisearch_api_key: 'YourMeilisearchAPIKey',
+  per_environment: true
+}
 ```
 
+This way your index UID will look like this `"Book_#{Rails.env}"`.
+
 ### Index configuration
 
 #### Custom attribute definition
@@ -312,16 +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' do
+  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>
@@ -331,8 +354,7 @@ As soon as you use those constraints, `add_documents` and `delete_documents` cal
 class Book < ActiveRecord::Base
   include MeiliSearch::Rails
 
-  meilisearch if: :published?, unless: :premium? do
-  end
+  meilisearch if: :published?, unless: :premium?
 
   def published?
     # [...]
@@ -369,6 +391,7 @@ class Book < ActiveRecord::Base
   end
 
   private
+
   def public?
     released? && !premium?
   end
@@ -383,10 +406,10 @@ You may want to share an index between several models. You'll need to ensure you
 class Cat < ActiveRecord::Base
   include MeiliSearch::Rails
 
-  meilisearch index_uid: 'Animals', primary_key: :ms_id do
-  end
+  meilisearch index_uid: 'Animals', primary_key: :ms_id
 
   private
+
   def ms_id
     "cat_#{primary_key}" # ensure the cats & dogs primary_keys are not conflicting
   end
@@ -395,10 +418,10 @@ end
 class Dog < ActiveRecord::Base
   include MeiliSearch::Rails
 
-  meilisearch index_uid: 'Animals', primary_key: :ms_id do
-  end
+  meilisearch index_uid: 'Animals', primary_key: :ms_id
 
   private
+
   def ms_id
     "dog_#{primary_key}" # ensure the cats & dogs primary_keys are not conflicting
   end
@@ -413,8 +436,7 @@ You can configure the auto-indexing & auto-removal process to use a queue to per
 class Book < ActiveRecord::Base
   include MeiliSearch::Rails
 
-  meilisearch enqueue: true do # ActiveJob will be triggered using a `meilisearch` queue
-  end
+  meilisearch enqueue: true # ActiveJob will be triggered using a `meilisearch` queue
 end
 ```
 
@@ -586,8 +608,7 @@ You can strip all HTML tags from your attributes with the `sanitize` option.
 class Book < ActiveRecord::Base
   include MeiliSearch::Rails
 
-  meilisearch sanitize: true do
-  end
+  meilisearch sanitize: true
 end
 ```
 
@@ -599,8 +620,21 @@ You can force the UTF-8 encoding of all your attributes using the `force_utf8_en
 class Book < ActiveRecord::Base
   include MeiliSearch::Rails
 
-  meilisearch force_utf8_encoding: true do
-  end
+  meilisearch force_utf8_encoding: true
+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
 ```
 
@@ -652,8 +686,7 @@ class Book < ActiveRecord::Base
   include MeiliSearch::Rails
 
   # Only raise exceptions in development environment.
-  meilisearch raise_on_failure: Rails.env.development? do
-  end
+  meilisearch raise_on_failure: Rails.env.development?
 end
 ```
 
@@ -667,8 +700,7 @@ You can force indexing and removing to be synchronous by setting the following o
 class Book < ActiveRecord::Base
   include MeiliSearch::Rails
 
-  meilisearch synchronous: true do
-  end
+  meilisearch synchronous: true
 end
 ```
 🚨 This is only recommended for testing purposes, the gem will call the `wait_for_task` method that will stop your code execution until the asynchronous task has been processed by MeilSearch.
@@ -681,8 +713,7 @@ You can disable auto-indexing and auto-removing setting the following options:
 class Book < ActiveRecord::Base
   include MeiliSearch::Rails
 
-  meilisearch auto_index: false, auto_remove: false do
-  end
+  meilisearch auto_index: false, auto_remove: false
 end
 ```
 

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.5.2'
+    VERSION = '0.7.1'
+
+    def self.qualified_version
+      "Meilisearch Rails (v#{VERSION})"
+    end
   end
 end

data/lib/meilisearch-rails.rb

@@ -105,7 +105,7 @@ module MeiliSearch
       end
 
       def sequel?(document)
-        defined?(::Sequel) && document.class < ::Sequel::Model
+        defined?(::Sequel::Model) && document.class < ::Sequel::Model
       end
 
       def active_record?(document)
@@ -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 }
@@ -319,8 +323,12 @@ module MeiliSearch
 
         attr_accessor :formatted
 
+        if options.key?(:per_environment)
+          raise BadConfiguration, ':per_environment option should be defined globally on MeiliSearch::Rails.configuration block.'
+        end
+
         if options[:synchronous] == true
-          if defined?(::Sequel) && self < Sequel::Model
+          if defined?(::Sequel::Model) && self < Sequel::Model
             class_eval do
               copy_after_validation = instance_method(:after_validation)
               define_method(:after_validation) do |*args|
@@ -352,7 +360,7 @@ module MeiliSearch
           end
         end
         unless options[:auto_index] == false
-          if defined?(::Sequel) && self < Sequel::Model
+          if defined?(::Sequel::Model) && self < Sequel::Model
             class_eval do
               copy_after_validation = instance_method(:after_validation)
               copy_before_save = instance_method(:before_save)
@@ -399,7 +407,7 @@ module MeiliSearch
           end
         end
         unless options[:auto_remove] == false
-          if defined?(::Sequel) && self < Sequel::Model
+          if defined?(::Sequel::Model) && self < Sequel::Model
             class_eval do
               copy_after_destroy = instance_method(:after_destroy)
 
@@ -456,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
@@ -472,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
 
@@ -482,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
 
@@ -579,7 +587,7 @@ module MeiliSearch
         end
 
         def ms_facets_distribution
-          @ms_json['facetsDistribution']
+          @ms_json['facetDistribution']
         end
 
         private
@@ -601,13 +609,10 @@ module MeiliSearch
         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
@@ -615,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,
@@ -653,8 +675,11 @@ module MeiliSearch
 
       def ms_index_uid(options = nil)
         options ||= meilisearch_options
+        global_options ||= MeiliSearch::Rails.configuration
+
         name = options[:index_uid] || model_name.to_s.gsub('::', '_')
-        name = "#{name}_#{::Rails.env}" if options[:per_environment]
+        name = "#{name}_#{::Rails.env}" if global_options[:per_environment]
+
         name
       end
 
@@ -820,8 +845,9 @@ 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)
-        elsif defined?(::Sequel) && self < Sequel::Model
+          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
           # don't worry, mongoid has its own underlying cursor/streaming mechanism
@@ -903,7 +929,7 @@ module MeiliSearch
         # ms_must_reindex flag is reset after every commit as part. If we must reindex at any point in
         # a transaction, keep flag set until it is explicitly unset
         @ms_must_reindex ||=
-          if defined?(::Sequel) && is_a?(Sequel::Model)
+          if defined?(::Sequel::Model) && is_a?(Sequel::Model)
             new? || self.class.ms_must_reindex?(self)
           else
             new_record? || self.class.ms_must_reindex?(self)

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.5.2
+  version: 0.7.1
 platform: ruby
 authors:
 - Meili
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-18 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.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: []