meilisearch-rails 0.10.2 → 0.16.0

data/lib/meilisearch-rails.rb

@@ -3,6 +3,7 @@ require 'meilisearch/rails/null_object'
 require 'meilisearch/rails/version'
 require 'meilisearch/rails/utilities'
 require 'meilisearch/rails/errors'
+require 'meilisearch/rails/multi_search'
 
 if defined? Rails
   begin
@@ -19,7 +20,13 @@ end
 
 require 'logger'
 
-module MeiliSearch
+# Workaround for the soft deprecation of MeiliSearch (old spelling)
+# The regular `const_get` method does not seem to work
+# too well with autoload and thus does not pull in methods
+# like `client` which are obviously vital.
+MeiliSearch::Rails = Meilisearch::Rails
+
+module Meilisearch
   module Rails
     autoload :Configuration, 'meilisearch/rails/configuration'
     extend Configuration
@@ -66,6 +73,7 @@ module MeiliSearch
         pagination
         faceting
         typo_tolerance
+        proximity_precision
       ].freeze
 
       CAMELIZE_OPTIONS = %i[pagination faceting typo_tolerance].freeze
@@ -82,6 +90,22 @@ module MeiliSearch
       def initialize(options, &block)
         @options = options
         instance_exec(&block) if block_given?
+        warn_searchable_missing_attributes
+      end
+
+      def warn_searchable_missing_attributes
+        searchables = get_setting(:searchable_attributes)&.map { |searchable| searchable.to_s.split('.').first }
+        attrs = get_setting(:attributes)&.map { |k, _| k.to_s }
+
+        if searchables.present? && attrs.present?
+          (searchables - attrs).each do |missing_searchable|
+            warning = <<~WARNING
+              [meilisearch-rails] #{missing_searchable} declared in searchable_attributes but not in attributes. \
+              Please add it to attributes if it should be searchable.
+            WARNING
+            Meilisearch::Rails.logger.warn(warning)
+          end
+        end
       end
 
       def use_serializer(serializer)
@@ -249,14 +273,15 @@ module MeiliSearch
       # lazy load the ActiveJob class to ensure the
       # queue is initialized before using it
       autoload :MSJob, 'meilisearch/rails/ms_job'
+      autoload :MSCleanUpJob, 'meilisearch/rails/ms_clean_up_job'
     end
 
-    # this class wraps an MeiliSearch::Index document ensuring all raised exceptions
+    # this class wraps an Meilisearch::Index document ensuring all raised exceptions
     # are correctly logged or thrown depending on the `raise_on_failure` option
     class SafeIndex
       def initialize(index_uid, raise_on_failure, options)
-        client = MeiliSearch::Rails.client
-        primary_key = options[:primary_key] || MeiliSearch::Rails::IndexSettings::DEFAULT_PRIMARY_KEY
+        client = Meilisearch::Rails.client
+        primary_key = options[:primary_key] || Meilisearch::Rails::IndexSettings::DEFAULT_PRIMARY_KEY
         @raise_on_failure = raise_on_failure.nil? || raise_on_failure
 
         SafeIndex.log_or_throw(nil, @raise_on_failure) do
@@ -266,7 +291,7 @@ module MeiliSearch
         @index = client.index(index_uid)
       end
 
-      ::MeiliSearch::Index.instance_methods(false).each do |m|
+      ::Meilisearch::Index.instance_methods(false).each do |m|
         define_method(m) do |*args, &block|
           if m == :update_settings
             args[0].delete(:attributes_to_highlight) if args[0][:attributes_to_highlight]
@@ -275,13 +300,22 @@ module MeiliSearch
           end
 
           SafeIndex.log_or_throw(m, @raise_on_failure) do
-            return MeiliSearch::Rails.black_hole unless MeiliSearch::Rails.active?
+            return Meilisearch::Rails.black_hole unless Meilisearch::Rails.active?
 
             @index.send(m, *args, &block)
           end
         end
       end
 
+      # Maually define facet_search due to complications with **opts in ruby 2.*
+      def facet_search(*args, **opts)
+        SafeIndex.log_or_throw(:facet_search, @raise_on_failure) do
+          return Meilisearch::Rails.black_hole unless Meilisearch::Rails.active?
+
+          @index.facet_search(*args, **opts)
+        end
+      end
+
       # special handling of wait_for_task to handle null task_id
       def wait_for_task(task_uid)
         return if task_uid.nil? && !@raise_on_failure # ok
@@ -295,8 +329,8 @@ module MeiliSearch
       def settings(*args)
         SafeIndex.log_or_throw(:settings, @raise_on_failure) do
           @index.settings(*args)
-        rescue ::MeiliSearch::ApiError => e
-          return {} if e.code == 404 # not fatal
+        rescue ::Meilisearch::ApiError => e
+          return {} if e.code == 'index_not_found' # not fatal
 
           raise e
         end
@@ -304,11 +338,11 @@ module MeiliSearch
 
       def self.log_or_throw(method, raise_on_failure, &block)
         yield
-      rescue ::MeiliSearch::TimeoutError, ::MeiliSearch::ApiError => e
+      rescue ::Meilisearch::TimeoutError, ::Meilisearch::ApiError => e
         raise e if raise_on_failure
 
         # log the error
-        MeiliSearch::Rails.logger.info("[meilisearch-rails] #{e.message}")
+        Meilisearch::Rails.logger.info("[meilisearch-rails] #{e.message}")
         # return something
         case method.to_s
         when 'search'
@@ -321,7 +355,7 @@ module MeiliSearch
       end
     end
 
-    # these are the class methods added when MeiliSearch is included
+    # these are the class methods added when Meilisearch is included
     module ClassMethods
       def self.extended(base)
         class << base
@@ -351,7 +385,7 @@ module MeiliSearch
         attr_accessor :formatted
 
         if options.key?(:per_environment)
-          raise BadConfiguration, ':per_environment option should be defined globally on MeiliSearch::Rails.configuration block.'
+          raise BadConfiguration, ':per_environment option should be defined globally on Meilisearch::Rails.configuration block.'
         end
 
         if options[:synchronous] == true
@@ -373,7 +407,11 @@ module MeiliSearch
 
           proc = if options[:enqueue] == true
                    proc do |record, remove|
-                     MSJob.perform_later(record, remove ? 'ms_remove_from_index!' : 'ms_index!')
+                     if remove
+                       MSCleanUpJob.perform_later(record.ms_entries)
+                     else
+                       MSJob.perform_later(record, 'ms_index!')
+                     end
                    end
                  elsif options[:enqueue].respond_to?(:call)
                    options[:enqueue]
@@ -383,7 +421,7 @@ module MeiliSearch
                    raise ArgumentError, "Invalid `enqueue` option: #{options[:enqueue]}"
                  end
           meilisearch_options[:enqueue] = proc do |record, remove|
-            proc.call(record, remove) unless ms_without_auto_index_scope
+            proc.call(record, remove) if ::Meilisearch::Rails.active? && !ms_without_auto_index_scope
           end
         end
         unless options[:auto_index] == false
@@ -445,11 +483,9 @@ module MeiliSearch
               end
             end
           elsif respond_to?(:after_destroy)
-            after_destroy { |searchable| searchable.ms_enqueue_remove_from_index!(ms_synchronous?) }
+            after_commit(on: :destroy) { |searchable| searchable.ms_enqueue_remove_from_index!(ms_synchronous?) }
           end
         end
-
-        warn_searchable_missing_attributes
       end
 
       def ms_without_auto_index(&block)
@@ -469,7 +505,7 @@ module MeiliSearch
         Thread.current["ms_without_auto_index_scope_for_#{model_name}"]
       end
 
-      def ms_reindex!(batch_size = MeiliSearch::Rails::IndexSettings::DEFAULT_BATCH_SIZE, synchronous = false)
+      def ms_reindex!(batch_size = Meilisearch::Rails::IndexSettings::DEFAULT_BATCH_SIZE, synchronous = false)
         return if ms_without_auto_index_scope
 
         ms_configurations.each do |options, settings|
@@ -526,7 +562,8 @@ module MeiliSearch
       def ms_index!(document, synchronous = false)
         return if ms_without_auto_index_scope
 
-        ms_configurations.each do |options, settings|
+        # MS tasks to be returned
+        ms_configurations.map do |options, settings|
           next if ms_indexing_disabled?(options)
 
           primary_key = ms_primary_key_of(document, options)
@@ -538,20 +575,32 @@ module MeiliSearch
             doc = doc.merge ms_pk(options) => primary_key
 
             if synchronous || options[:synchronous]
-              index.add_documents!(doc)
+              index.add_documents(doc).await
             else
               index.add_documents(doc)
             end
           elsif ms_conditional_index?(options) && primary_key.present?
             # remove non-indexable documents
             if synchronous || options[:synchronous]
-              index.delete_document!(primary_key)
+              index.delete_document(primary_key).await
             else
               index.delete_document(primary_key)
             end
           end
+        end.compact
+      end
+
+      def ms_entries_for(document:, synchronous:)
+        primary_key = ms_primary_key_of(document)
+        raise ArgumentError, 'Cannot index a record without a primary key' if primary_key.blank?
+
+        ms_configurations.filter_map do |options, settings|
+          {
+            synchronous: synchronous || options[:synchronous],
+            index_uid: ms_index_uid(options),
+            primary_key: primary_key
+          }.with_indifferent_access unless ms_indexing_disabled?(options)
         end
-        nil
       end
 
       def ms_remove_from_index!(document, synchronous = false)
@@ -565,7 +614,7 @@ module MeiliSearch
 
           index = ms_ensure_init(options, settings)
           if synchronous || options[:synchronous]
-            index.delete_document!(primary_key)
+            index.delete_document(primary_key).await
           else
             index.delete_document(primary_key)
           end
@@ -578,8 +627,8 @@ module MeiliSearch
           next if ms_indexing_disabled?(options)
 
           index = ms_ensure_init(options, settings)
-          synchronous || options[:synchronous] ? index.delete_all_documents! : index.delete_all_documents
-          @ms_indexes[MeiliSearch::Rails.active?][settings] = nil
+          synchronous || options[:synchronous] ? index.delete_all_documents.await : index.delete_all_documents
+          @ms_indexes[Meilisearch::Rails.active?][settings] = nil
         end
         nil
       end
@@ -623,7 +672,7 @@ module MeiliSearch
       end
 
       def ms_search(query, params = {})
-        if MeiliSearch::Rails.configuration[:pagination_backend]
+        if Meilisearch::Rails.configuration[:pagination_backend]
           %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
@@ -647,6 +696,8 @@ module MeiliSearch
         # 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)
+                                   elsif Utilities.mongo_model?(self)
+                                     fields.keys.exclude?(condition_key.to_s)
                                    else
                                      meilisearch_options[:type].columns.map(&:name).map(&:to_s).exclude?(condition_key.to_s)
                                    end
@@ -693,7 +744,7 @@ module MeiliSearch
 
       def ms_index_uid(options = nil)
         options ||= meilisearch_options
-        global_options ||= MeiliSearch::Rails.configuration
+        global_options ||= Meilisearch::Rails.configuration
 
         name = options[:index_uid] || model_name.to_s.gsub('::', '_')
         name = "#{name}_#{::Rails.env}" if global_options[:per_environment]
@@ -733,35 +784,45 @@ module MeiliSearch
         false
       end
 
+      def ms_primary_key_method(options = nil)
+        options ||= meilisearch_options
+        options[:primary_key] || options[:id] || (Utilities.mongo_model?(self) ? :_id : :id)
+      end
+
       protected
 
-      def ms_ensure_init(options = nil, settings = nil, index_settings = nil)
+      def ms_ensure_init(options = meilisearch_options, settings = meilisearch_settings, user_configuration = settings.to_settings)
         raise ArgumentError, 'No `meilisearch` block found in your model.' if meilisearch_settings.nil?
 
         @ms_indexes ||= { true => {}, false => {} }
 
-        options ||= meilisearch_options
-        settings ||= meilisearch_settings
+        @ms_indexes[Meilisearch::Rails.active?][settings] ||= SafeIndex.new(ms_index_uid(options), meilisearch_options[:raise_on_failure], meilisearch_options)
 
-        return @ms_indexes[MeiliSearch::Rails.active?][settings] if @ms_indexes[MeiliSearch::Rails.active?][settings]
+        update_settings_if_changed(@ms_indexes[Meilisearch::Rails.active?][settings], options, user_configuration)
 
-        @ms_indexes[MeiliSearch::Rails.active?][settings] = SafeIndex.new(ms_index_uid(options), meilisearch_options[:raise_on_failure], meilisearch_options)
+        @ms_indexes[Meilisearch::Rails.active?][settings]
+      end
 
-        current_settings = @ms_indexes[MeiliSearch::Rails.active?][settings].settings(getVersion: 1) rescue nil # if the index doesn't exist
+      private
 
-        index_settings ||= settings.to_settings
-        index_settings = options[:primary_settings].to_settings.merge(index_settings) if options[:inherit]
+      def update_settings_if_changed(index, options, user_configuration)
+        server_state = index.settings
+        user_configuration = options[:primary_settings].to_settings.merge(user_configuration) if options[:inherit]
 
-        options[:check_settings] = true if options[:check_settings].nil?
+        config = user_configuration.except(:attributes_to_highlight, :attributes_to_crop, :crop_length)
 
-        if !ms_indexing_disabled?(options) && options[:check_settings] && meilisearch_settings_changed?(current_settings, index_settings)
-          @ms_indexes[MeiliSearch::Rails.active?][settings].update_settings(index_settings)
+        if !skip_checking_settings?(options) && meilisearch_settings_changed?(server_state, config)
+          index.update_settings(user_configuration)
         end
+      end
 
-        @ms_indexes[MeiliSearch::Rails.active?][settings]
+      def skip_checking_settings?(options)
+        ms_indexing_disabled?(options) || ms_checking_disabled?(options)
       end
 
-      private
+      def ms_checking_disabled?(options)
+        options[:check_settings] == false
+      end
 
       def ms_configurations
         raise ArgumentError, 'No `meilisearch` block found in your model.' if meilisearch_settings.nil?
@@ -782,11 +843,6 @@ module MeiliSearch
         @configurations
       end
 
-      def ms_primary_key_method(options = nil)
-        options ||= meilisearch_options
-        options[:primary_key] || options[:id] || :id
-      end
-
       def ms_primary_key_of(doc, options = nil)
         doc.send(ms_primary_key_method(options)).to_s
       end
@@ -797,22 +853,25 @@ module MeiliSearch
       end
 
       def ms_pk(options = nil)
-        options[:primary_key] || MeiliSearch::Rails::IndexSettings::DEFAULT_PRIMARY_KEY
+        options[:primary_key] || Meilisearch::Rails::IndexSettings::DEFAULT_PRIMARY_KEY
       end
 
-      def meilisearch_settings_changed?(prev, current)
-        return true if prev.nil?
+      def meilisearch_settings_changed?(server_state, user_configuration)
+        return true if server_state.nil?
+
+        user_configuration.transform_keys! { |key| key.to_s.camelize(:lower) }
 
-        current.each do |k, v|
-          prev_v = prev[k.to_s]
-          if v.is_a?(Array) && prev_v.is_a?(Array)
-            # compare array of strings, avoiding symbols VS strings comparison
-            return true if v.map(&:to_s) != prev_v.map(&:to_s)
-          elsif prev_v != v
-            return true
+        user_configuration.any? do |key, user|
+          server = server_state[key]
+
+          if user.is_a?(Hash) && server.is_a?(Hash)
+            meilisearch_settings_changed?(server, user)
+          elsif user.is_a?(Array) && server.is_a?(Array)
+            user.map(&:to_s).sort! != server.map(&:to_s).sort!
+          else
+            user.to_s != server.to_s
           end
         end
-        false
       end
 
       def ms_conditional_index?(options = nil)
@@ -864,19 +923,6 @@ module MeiliSearch
         # We don't know if the attribute has changed, so conservatively assume it has
         true
       end
-
-      def warn_searchable_missing_attributes
-        searchables = meilisearch_settings.get_setting(:searchable_attributes)
-        attrs = meilisearch_settings.get_setting(:attributes)&.keys
-
-        if searchables.present? && attrs.present?
-          (searchables.map(&:to_s) - attrs.map(&:to_s)).each do |missing_searchable|
-            MeiliSearch::Rails.logger.warn(
-              "[meilisearch-rails] #{name}##{missing_searchable} declared in searchable_attributes but not in attributes. Please add it to attributes if it should be searchable."
-            )
-          end
-        end
-      end
     end
 
     # these are the instance methods included
@@ -923,6 +969,10 @@ module MeiliSearch
         @ms_synchronous
       end
 
+      def ms_entries(synchronous = false)
+        self.class.ms_entries_for(document: self, synchronous: synchronous || ms_synchronous?)
+      end
+
       private
 
       def ms_mark_synchronous

data/meilisearch-rails.gemspec

@@ -5,7 +5,7 @@ require 'meilisearch/rails/version'
 
 Gem::Specification.new do |s|
   s.name = 'meilisearch-rails'
-  s.version = MeiliSearch::Rails::VERSION
+  s.version = Meilisearch::Rails::VERSION
 
   s.authors = ['Meili']
   s.email = 'bonjour@meilisearch.com'
@@ -32,7 +32,8 @@ Gem::Specification.new do |s|
     'Rakefile'
   ]
 
-  s.required_ruby_version = '>= 2.6.0'
+  s.required_ruby_version = '>= 3.0.0'
 
-  s.add_dependency 'meilisearch', '~> 0.26.0'
+  s.add_dependency 'meilisearch', '~> 0.32.0'
+  s.add_dependency 'mutex_m', '~> 0.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: meilisearch-rails
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 0.16.0
 platform: ruby
 authors:
 - Meili
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-11 00:00:00.000000000 Z
+date: 2025-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: meilisearch
@@ -16,14 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.26.0
+        version: 0.32.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.26.0
+        version: 0.32.0
+- !ruby/object:Gem::Dependency
+  name: mutex_m
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 description: Meilisearch integration for Ruby on Rails. See https://github.com/meilisearch/meilisearch
 email: bonjour@meilisearch.com
 executables: []
@@ -40,7 +54,11 @@ files:
 - lib/meilisearch-rails.rb
 - lib/meilisearch/rails/configuration.rb
 - lib/meilisearch/rails/errors.rb
+- lib/meilisearch/rails/ms_clean_up_job.rb
 - lib/meilisearch/rails/ms_job.rb
+- lib/meilisearch/rails/multi_search.rb
+- lib/meilisearch/rails/multi_search/federated_search_result.rb
+- lib/meilisearch/rails/multi_search/multi_search_result.rb
 - lib/meilisearch/rails/null_object.rb
 - lib/meilisearch/rails/pagination.rb
 - lib/meilisearch/rails/pagination/kaminari.rb
@@ -55,7 +73,7 @@ homepage: https://github.com/meilisearch/meilisearch-rails
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -63,15 +81,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.4.19
+signing_key:
 specification_version: 4
 summary: Meilisearch integration for Ruby on Rails.
 test_files: []