meilisearch-rails 0.10.2 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb990c26e799658b655df059ea7a22b4cfc7511a88e7581d72c27841b736f74f
-  data.tar.gz: c2457a258356732877729a9f110a8f392316a98d725d6d052f2dc64824a3ea2f
+  metadata.gz: 215428bdb5e437c3a906e1246444dc7e2afce9d2b52646790de1d55d0490783f
+  data.tar.gz: 412f8d56c952a330a9b3473602aca9ac0fee6789a3a3632f65340c7c85524637
 SHA512:
-  metadata.gz: 7499509091a149069f1322e3ceec9c789432c3495d8c2754d258bb17c5cc1d70a410ebcd41e1eb76bcbe50b3c9e301044d0a5e6931e94bdd8779eb290e9eaecf
-  data.tar.gz: 68173b7d7767308144b6987c35c9c2fb75806959a6fcdc3ee3545cab88779d24e013dea0ea0b3b0a3182f8fb9bcd5c7e1634aaf89ecd39f4cb7ad21231b95a0b
+  metadata.gz: ad8f9e4489c11dd3b2a522b134921232fbe2b66946f57ebf6be0c18ccd0643490379fb483d0a2ecf3371a427ff442809801130308e8f11fdedc7d6869a8d14c5
+  data.tar.gz: 5473ca9c267a3dfada14258db095d86c2e3618d356afc29ecf60c6975b067078cac91d8cc84c3e0b0bf8b5f227496d95830d77ed41923d0deeb313165b0b37df

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021-2022 Meili SAS
+Copyright (c) 2021-2024 Meili SAS
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/lib/meilisearch/rails/ms_clean_up_job.rb

@@ -0,0 +1,19 @@
+module MeiliSearch
+  module Rails
+    class MSCleanUpJob < ::ActiveJob::Base
+      queue_as :meilisearch
+
+      def perform(documents)
+        documents.each do |document|
+          index = MeiliSearch::Rails.client.index(document[:index_uid])
+
+          if document[:synchronous]
+            index.delete_document!(document[:primary_key])
+          else
+            index.delete_document(document[:primary_key])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/meilisearch/rails/pagination.rb

@@ -18,7 +18,7 @@ module MeiliSearch
 
       def self.log_pagy_error
         MeiliSearch::Rails.logger
-          .warning('[meilisearch-rails] Remove `pagination_backend: :pagy` from your initializer, `pagy` it is not required for `pagy`')
+          .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)

data/lib/meilisearch/rails/version.rb

@@ -2,7 +2,7 @@
 
 module MeiliSearch
   module Rails
-    VERSION = '0.10.2'
+    VERSION = '0.11.0'
 
     def self.qualified_version
       "Meilisearch Rails (v#{VERSION})"

data/lib/meilisearch-rails.rb

@@ -249,6 +249,7 @@ 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
@@ -260,7 +261,7 @@ module MeiliSearch
         @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 })
+          client.create_index!(index_uid, { primary_key: primary_key })
         end
 
         @index = client.index(index_uid)
@@ -282,6 +283,15 @@ module MeiliSearch
         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
@@ -373,7 +383,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]
@@ -445,7 +459,7 @@ module MeiliSearch
               end
             end
           elsif respond_to?(:after_destroy)
-            after_destroy { |searchable| searchable.ms_enqueue_remove_from_index!(ms_synchronous?) }
+            after_destroy_commit { |searchable| searchable.ms_enqueue_remove_from_index!(ms_synchronous?) }
           end
         end
 
@@ -526,7 +540,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)
@@ -550,8 +565,20 @@ module MeiliSearch
               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: options[:index_uid],
+            primary_key: primary_key
+          }.with_indifferent_access unless ms_indexing_disabled?(options)
         end
-        nil
       end
 
       def ms_remove_from_index!(document, synchronous = false)
@@ -735,33 +762,38 @@ module MeiliSearch
 
       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?
@@ -800,19 +832,22 @@ module MeiliSearch
         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?
 
-        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.transform_keys! { |key| key.to_s.camelize(:lower) }
+
+        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) != server.map(&:to_s)
+          else
+            user.to_s != server.to_s
           end
         end
-        false
       end
 
       def ms_conditional_index?(options = nil)
@@ -923,6 +958,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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: meilisearch-rails
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 0.11.0
 platform: ruby
 authors:
 - Meili
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-12-11 00:00:00.000000000 Z
+date: 2024-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: meilisearch
@@ -40,6 +40,7 @@ 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/null_object.rb
 - lib/meilisearch/rails/pagination.rb