meilisearch-rails 0.14.2 → 0.15.0

data/lib/meilisearch/rails/multi_search/federated_search_result.rb

@@ -0,0 +1,78 @@
+require 'active_support/core_ext/module/delegation'
+
+module Meilisearch
+  module Rails
+    class FederatedSearchResult
+      attr_reader :metadata, :hits
+
+      def initialize(searches, raw_results)
+        hits = raw_results.delete('hits')
+        @hits = load_hits(hits, searches.to_a)
+        @metadata = raw_results
+      end
+
+      include Enumerable
+
+      delegate :each, :to_a, :to_ary, :empty?, :[], :first, :last, to: :@hits
+
+      private
+
+      def load_hits(hits, searches)
+        hits_by_pos = hits.group_by { |hit| hit['_federation']['queriesPosition'] }
+
+        keys_and_records_by_pos = hits_by_pos.to_h do |pos, group_hits|
+          search_target, search_opts = searches[pos]
+
+          scope = if search_opts[:scope]
+                    search_opts[:scope]
+                  elsif search_target.instance_of?(Class)
+                    search_target
+                  end
+
+          if scope.present?
+            [pos, load_results(scope, group_hits)]
+          else
+            [pos, [nil, group_hits]]
+          end
+        end
+
+        hits.filter_map do |hit|
+          hit_cond_key, recs_by_id = keys_and_records_by_pos[hit['_federation']['queriesPosition']]
+
+          if hit_cond_key.present?
+            record = recs_by_id[hit[hit_cond_key.to_s].to_s]
+            record&.formatted = hit['_formatted']
+            record
+          else
+            hit
+          end
+        end
+      end
+
+      def load_results(scope, hits)
+        klass = scope.respond_to?(:model) ? scope.model : scope
+
+        pk_method = klass.ms_primary_key_method
+        pk_method = pk_method.in if Utilities.mongo_model?(klass)
+
+        condition_key = pk_is_virtual?(klass, pk_method) ? klass.primary_key : pk_method
+
+        hits_by_id = hits.index_by { |hit| hit[condition_key.to_s] }
+
+        records = scope.where(condition_key => hits_by_id.keys)
+
+        results_by_id = records.index_by do |record|
+          record.send(condition_key).to_s
+        end
+
+        [condition_key, results_by_id]
+      end
+
+      def pk_is_virtual?(model_class, pk_method)
+        model_class.columns
+                   .map(&(Utilities.sequel_model?(model_class) ? :to_s : :name))
+                   .exclude?(pk_method.to_s)
+      end
+    end
+  end
+end

data/lib/meilisearch/rails/multi_search/multi_search_result.rb

@@ -0,0 +1,115 @@
+module Meilisearch
+  module Rails
+    class MultiSearchResult
+      attr_reader :metadata
+
+      def initialize(searches, raw_results)
+        @results = {}
+        @metadata = {}
+
+        searches.zip(raw_results['results']).each do |(target, search_options), result|
+          results_class = if search_options[:class_name]
+                            Meilisearch::Rails.logger.warn(
+                              '[meilisearch-rails] The :class_name option in multi search is deprecated, please use :scope instead.'
+                            )
+
+                            search_options[:class_name].constantize
+                          elsif target.instance_of?(Class)
+                            target
+                          elsif search_options[:scope]
+                            search_options[:scope]
+                          end
+
+          @results[target] = results_class ? load_results(results_class, result, scope: search_options[:scope]) : result['hits']
+
+          @metadata[target] = result.except('hits')
+        end
+      end
+
+      include Enumerable
+
+      def each_hit(&block)
+        Meilisearch::Rails.logger.warn(
+          <<~DEPRECATION
+            [meilisearch-rails] Flattening multi search results is deprecated.
+            If you do not want the results to be grouped, please use federated search instead.
+          DEPRECATION
+        )
+
+        @results.each_value do |results|
+          results.each(&block)
+        end
+      end
+
+      def each(&block)
+        Meilisearch::Rails.logger.info(
+          <<~INFO
+            [meilisearch-rails] #each on a multi search now iterates through grouped results.
+            If you do not want the results to be grouped, please use federated search instead.
+            To quickly go back to the old deprecated behavior, use `#each_hit`.
+          INFO
+        )
+
+        @results.each(&block)
+      end
+
+      def each_result(&block)
+        @results.each(&block)
+      end
+
+      def to_a
+        Meilisearch::Rails.logger.warn(
+          <<~DEPRECATION
+            [meilisearch-rails] Flattening multi search results is deprecated.
+            If you do not want the results to be grouped, please use federated search instead.
+          DEPRECATION
+        )
+        @results.values.flatten(1)
+      end
+      alias to_ary to_a
+
+      def to_h
+        @results
+      end
+      alias to_hash to_h
+
+      private
+
+      def load_results(klass, result, scope:)
+        scope ||= klass
+
+        pk_method = klass.ms_primary_key_method
+        pk_method = pk_method.in if Utilities.mongo_model?(klass)
+
+        condition_key = pk_is_virtual?(klass, pk_method) ? klass.primary_key : pk_method
+
+        hits_by_id =
+          result['hits'].index_by { |hit| hit[condition_key.to_s] }
+
+        records = scope.where(condition_key => hits_by_id.keys)
+
+        if records.respond_to? :in_order_of
+          records.in_order_of(condition_key, hits_by_id.keys).each do |record|
+            record.formatted = hits_by_id[record.send(condition_key).to_s]['_formatted']
+          end
+        else
+          results_by_id = records.index_by do |hit|
+            hit.send(condition_key).to_s
+          end
+
+          result['hits'].filter_map do |hit|
+            record = results_by_id[hit[condition_key.to_s].to_s]
+            record&.formatted = hit['_formatted']
+            record
+          end
+        end
+      end
+
+      def pk_is_virtual?(model_class, pk_method)
+        model_class.columns
+                   .map(&(Utilities.sequel_model?(model_class) ? :to_s : :name))
+                   .exclude?(pk_method.to_s)
+      end
+    end
+  end
+end

data/lib/meilisearch/rails/multi_search.rb

@@ -1,31 +1,72 @@
-require_relative 'multi_search/result'
+require_relative 'multi_search/multi_search_result'
+require_relative 'multi_search/federated_search_result'
 
-module MeiliSearch
+module Meilisearch
   module Rails
     class << self
       def multi_search(searches)
         search_parameters = searches.map do |(index_target, options)|
+          model_class = options[:scope].respond_to?(:model) ? options[:scope].model : options[:scope]
+          index_target = options.delete(:index_uid) || model_class || index_target
+
           paginate(options) if pagination_enabled?
           normalize(options, index_target)
         end
 
-        MultiSearchResult.new(searches, client.multi_search(search_parameters))
+        MultiSearchResult.new(searches, client.multi_search(queries: search_parameters))
+      end
+
+      def federated_search(queries:, federation: {})
+        if federation.nil?
+          Meilisearch::Rails.logger.warn(
+            '[meilisearch-rails] In federated_search, `nil` is an invalid `:federation` option. To explicitly use defaults, pass `{}`.'
+          )
+
+          federation = {}
+        end
+
+        queries.map! { |item| [nil, item] } if queries.is_a?(Array)
+
+        cleaned_queries = queries.filter_map do |(index_target, options)|
+          model_class = options[:scope].respond_to?(:model) ? options[:scope].model : options[:scope]
+          index_target = options.delete(:index_uid) || index_target || model_class
+
+          strip_pagination_options(options)
+          normalize(options, index_target)
+        end
+
+        raw_results = client.multi_search(queries: cleaned_queries, federation: federation)
+
+        FederatedSearchResult.new(queries, raw_results)
       end
 
       private
 
       def normalize(options, index_target)
+        index_target = index_uid_from_target(index_target)
+
+        return nil if index_target.nil?
+
         options
-          .except(:class_name)
-          .merge!(index_uid: index_uid_from_target(index_target))
+          .except(:class_name, :scope)
+          .merge!(index_uid: index_target)
       end
 
       def index_uid_from_target(index_target)
         case index_target
         when String, Symbol
           index_target
-        else
-          index_target.index.uid
+        when Class
+          if index_target.respond_to?(:index)
+            index_target.index.uid
+          else
+            Meilisearch::Rails.logger.warn <<~MODEL_NOT_INDEXED
+              [meilisearch-rails] This class was passed to a multi/federated search but it does not have an #index: #{index_target}
+              [meilisearch-rails] Are you sure it has a `meilisearch` block?
+            MODEL_NOT_INDEXED
+
+            nil
+          end
         end
       end
 
@@ -41,8 +82,22 @@ module MeiliSearch
         options[:page] ||= 1
       end
 
+      def strip_pagination_options(options)
+        pagination_options = %w[page hitsPerPage hits_per_page limit offset].select do |key|
+          options.delete(key) || options.delete(key.to_sym)
+        end
+
+        return if pagination_options.empty?
+
+        Meilisearch::Rails.logger.warn <<~WRONG_PAGINATION
+          [meilisearch-rails] Pagination options in federated search must apply to whole federation.
+          [meilisearch-rails] These options have been removed: #{pagination_options.join(', ')}.
+          [meilisearch-rails] Please pass them after queries, in the `federation:` option.
+        WRONG_PAGINATION
+      end
+
       def pagination_enabled?
-        MeiliSearch::Rails.configuration[:pagination_backend]
+        Meilisearch::Rails.configuration[:pagination_backend]
       end
     end
   end

data/lib/meilisearch/rails/null_object.rb

@@ -1,6 +1,6 @@
 require 'singleton'
 
-module MeiliSearch
+module Meilisearch
   module Rails
     class NullObject
       include Singleton

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

@@ -1,11 +1,11 @@
 unless defined? Kaminari
-  raise(MeiliSearch::BadConfiguration,
+  raise(Meilisearch::BadConfiguration,
         "Meilisearch: Please add 'kaminari' to your Gemfile to use kaminari pagination backend")
 end
 
 require 'kaminari/models/array_extension'
 
-module MeiliSearch
+module Meilisearch
   module Rails
     module Pagination
       class Kaminari < ::Kaminari::PaginatableArray
@@ -18,11 +18,14 @@ module MeiliSearch
         end
 
         def self.create(results, total_hits, options = {})
-          offset = ((options[:page] - 1) * options[:per_page])
-          total_hits = 0 if total_hits.nil?
-          offset = 0 if offset.nil?
-          limit = 0 if options[:per_page].nil?
-          array = new results, limit: limit, offset: offset, total_count: total_hits
+          unless Meilisearch::Rails.active?
+            total_hits = 0
+            options[:page] = 1
+            options[:per_page] = 1
+          end
+
+          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

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

@@ -1,15 +1,21 @@
 begin
   require 'will_paginate/collection'
 rescue LoadError
-  raise(MeiliSearch::BadConfiguration,
-        "MeiliSearch: Please add 'will_paginate' to your Gemfile to use will_paginate pagination backend")
+  raise(Meilisearch::BadConfiguration,
+        "Meilisearch: Please add 'will_paginate' to your Gemfile to use will_paginate pagination backend")
 end
 
-module MeiliSearch
+module Meilisearch
   module Rails
     module Pagination
       class WillPaginate
         def self.create(results, total_hits, options = {})
+          unless Meilisearch::Rails.active?
+            total_hits = 0
+            options[:page] = 1
+            options[:per_page] = 1
+          end
+
           ::WillPaginate::Collection.create(options[:page], options[:per_page], total_hits) do |pager|
             pager.replace results
           end

data/lib/meilisearch/rails/pagination.rb

@@ -1,11 +1,11 @@
-module MeiliSearch
+module Meilisearch
   module Rails
     module Pagination
       autoload :WillPaginate, 'meilisearch/rails/pagination/will_paginate'
       autoload :Kaminari, 'meilisearch/rails/pagination/kaminari'
 
       def self.create(results, total_hits, options = {})
-        pagination_backend = MeiliSearch::Rails.configuration[:pagination_backend]
+        pagination_backend = Meilisearch::Rails.configuration[:pagination_backend]
 
         if pagination_backend.nil? || (is_pagy = pagination_backend.to_s == 'pagy')
           log_pagy_error if is_pagy
@@ -17,12 +17,12 @@ module MeiliSearch
       end
 
       def self.log_pagy_error
-        MeiliSearch::Rails.logger
+        Meilisearch::Rails.logger
           .warn('[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
+        ::Meilisearch::Rails::Pagination
           .const_get(pagination_backend.to_s.classify)
           .create(results, total_hits, options)
       rescue NameError

data/lib/meilisearch/rails/railtie.rb

@@ -1,6 +1,6 @@
 require 'rails'
 
-module MeiliSearch
+module Meilisearch
   module Rails
     class Railtie < ::Rails::Railtie
       rake_tasks do

data/lib/meilisearch/rails/tasks/meilisearch.rake

@@ -3,21 +3,21 @@ namespace :meilisearch do
   task reindex: :environment do
     puts 'Reindexing all Meilisearch models'
 
-    MeiliSearch::Rails::Utilities.reindex_all_models
+    Meilisearch::Rails::Utilities.reindex_all_models
   end
 
   desc 'Set settings to all indexes'
   task set_all_settings: :environment do
     puts 'Set settings in all Meilisearch models'
 
-    MeiliSearch::Rails::Utilities.set_settings_all_models
+    Meilisearch::Rails::Utilities.set_settings_all_models
   end
 
   desc 'Clear all indexes'
   task clear_indexes: :environment do
     puts 'Clearing indexes from all Meilisearch models'
 
-    MeiliSearch::Rails::Utilities.clear_all_indexes
+    Meilisearch::Rails::Utilities.clear_all_indexes
   end
 
   desc 'Create initializer file'

data/lib/meilisearch/rails/templates/initializer.rb

@@ -1,4 +1,4 @@
-MeiliSearch::Rails.configuration = {
+Meilisearch::Rails.configuration = {
   meilisearch_url: ENV.fetch('MEILISEARCH_HOST', 'http://localhost:7700'),
   meilisearch_api_key: ENV.fetch('MEILISEARCH_API_KEY', 'YourMeilisearchAPIKey')
 }

data/lib/meilisearch/rails/utilities.rb

@@ -1,4 +1,4 @@
-module MeiliSearch
+module Meilisearch
   module Rails
     module Utilities
       class << self
@@ -8,7 +8,7 @@ module MeiliSearch
           elsif ::Rails.application
             ::Rails.application.eager_load!
           end
-          klasses = MeiliSearch::Rails.instance_variable_get(:@included_in)
+          klasses = Meilisearch::Rails.instance_variable_get(:@included_in)
           (klasses + klasses.map(&:descendants).flatten).uniq
         end
 

data/lib/meilisearch/rails/version.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-module MeiliSearch
+module Meilisearch
   module Rails
-    VERSION = '0.14.2'
+    VERSION = '0.15.0'
 
     def self.qualified_version
       "Meilisearch Rails (v#{VERSION})"

data/lib/meilisearch-rails.rb

@@ -20,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
@@ -97,7 +103,7 @@ module MeiliSearch
               [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)
+            Meilisearch::Rails.logger.warn(warning)
           end
         end
       end
@@ -270,12 +276,12 @@ module MeiliSearch
       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
@@ -285,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]
@@ -294,7 +300,7 @@ 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
@@ -304,7 +310,7 @@ module MeiliSearch
       # 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?
+          return Meilisearch::Rails.black_hole unless Meilisearch::Rails.active?
 
           @index.facet_search(*args, **opts)
         end
@@ -323,7 +329,7 @@ module MeiliSearch
       def settings(*args)
         SafeIndex.log_or_throw(:settings, @raise_on_failure) do
           @index.settings(*args)
-        rescue ::MeiliSearch::ApiError => e
+        rescue ::Meilisearch::ApiError => e
           return {} if e.code == 'index_not_found' # not fatal
 
           raise e
@@ -332,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'
@@ -349,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
@@ -379,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
@@ -415,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
@@ -499,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|
@@ -622,7 +628,7 @@ module MeiliSearch
 
           index = ms_ensure_init(options, settings)
           synchronous || options[:synchronous] ? index.delete_all_documents.await : index.delete_all_documents
-          @ms_indexes[MeiliSearch::Rails.active?][settings] = nil
+          @ms_indexes[Meilisearch::Rails.active?][settings] = nil
         end
         nil
       end
@@ -666,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
@@ -736,7 +742,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]
@@ -788,11 +794,11 @@ module MeiliSearch
 
         @ms_indexes ||= { true => {}, false => {} }
 
-        @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] ||= SafeIndex.new(ms_index_uid(options), meilisearch_options[:raise_on_failure], meilisearch_options)
 
-        update_settings_if_changed(@ms_indexes[MeiliSearch::Rails.active?][settings], options, user_configuration)
+        update_settings_if_changed(@ms_indexes[Meilisearch::Rails.active?][settings], options, user_configuration)
 
-        @ms_indexes[MeiliSearch::Rails.active?][settings]
+        @ms_indexes[Meilisearch::Rails.active?][settings]
       end
 
       private
@@ -845,7 +851,7 @@ 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?(server_state, user_configuration)

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'
@@ -34,6 +34,6 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 3.0.0'
 
-  s.add_dependency 'meilisearch', '~> 0.28.4'
+  s.add_dependency 'meilisearch', '~> 0.31.0'
   s.add_dependency 'mutex_m', '~> 0.2'
 end