Rename meilisearch_settings to ms_index_settings

This should highlight the difference between these settings that concern
the index and meilisearch_options which are rails-specific.

Author: ellnix

lib/meilisearch-rails.rb

@@ -74,13 +74,13 @@ class << base
           alias_method :must_reindex?, :ms_must_reindex? unless method_defined? :must_reindex?
         end
 
-        base.cattr_accessor :meilisearch_options, :meilisearch_settings, :ms_config
+        base.cattr_accessor :meilisearch_options, :ms_index_settings, :ms_config
       end
 
       def meilisearch(options = {}, &block)
-        self.meilisearch_settings = IndexSettings.new(options, &block)
+        self.ms_index_settings = IndexSettings.new(options, &block)
         self.meilisearch_options = {
-          per_page: meilisearch_settings.get_setting(:hitsPerPage) || 20, page: 1
+          per_page: ms_index_settings.get_setting(:hitsPerPage) || 20, page: 1
         }.merge(options)
 
         self.ms_config = ModelConfiguration.new(model_name.to_s.constantize, options)
@@ -333,15 +333,15 @@ def ms_clear_index!(synchronous = false)
       def ms_raw_search(q, params = {})
         index_uid = params.delete(:index) || params.delete('index')
 
-        unless meilisearch_settings.get_setting(:attributes_to_highlight).nil?
-          params[:attributes_to_highlight] = meilisearch_settings.get_setting(:attributes_to_highlight)
+        unless ms_index_settings.get_setting(:attributes_to_highlight).nil?
+          params[:attributes_to_highlight] = ms_index_settings.get_setting(:attributes_to_highlight)
         end
 
-        unless meilisearch_settings.get_setting(:attributes_to_crop).nil?
-          params[:attributes_to_crop] = meilisearch_settings.get_setting(:attributes_to_crop)
+        unless ms_index_settings.get_setting(:attributes_to_crop).nil?
+          params[:attributes_to_crop] = ms_index_settings.get_setting(:attributes_to_crop)
 
-          unless meilisearch_settings.get_setting(:crop_length).nil?
-            params[:crop_length] = meilisearch_settings.get_setting(:crop_length)
+          unless ms_index_settings.get_setting(:crop_length).nil?
+            params[:crop_length] = ms_index_settings.get_setting(:crop_length)
           end
         end
 
@@ -486,8 +486,8 @@ def ms_primary_key_method(options = nil)
 
       protected
 
-      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?
+      def ms_ensure_init(options = meilisearch_options, settings = ms_index_settings, user_configuration = settings.to_settings)
+        raise ArgumentError, 'No `meilisearch` block found in your model.' if ms_index_settings.nil?
 
         @ms_indexes ||= { true => {}, false => {} }
 
@@ -506,7 +506,7 @@ def update_settings_if_changed(index, options, user_configuration)
 
         config = user_configuration.except(:attributes_to_highlight, :attributes_to_crop, :crop_length)
 
-        if !skip_checking_settings?(options) && meilisearch_settings_changed?(server_state, config)
+        if !skip_checking_settings?(options) && ms_index_settings_changed?(server_state, config)
           index.update_settings(user_configuration)
         end
       end
@@ -520,12 +520,12 @@ def ms_checking_disabled?(options)
       end
 
       def ms_configurations
-        raise ArgumentError, 'No `meilisearch` block found in your model.' if meilisearch_settings.nil?
+        raise ArgumentError, 'No `meilisearch` block found in your model.' if ms_index_settings.nil?
 
         if @configurations.nil?
           @configurations = {}
-          @configurations[meilisearch_options] = meilisearch_settings
-          meilisearch_settings.additional_indexes.each do |k, v|
+          @configurations[meilisearch_options] = ms_index_settings
+          ms_index_settings.additional_indexes.each do |k, v|
             @configurations[k] = v
 
             next unless v.additional_indexes.any?
@@ -551,7 +551,7 @@ def ms_pk(options = nil)
         options[:primary_key] || MeiliSearch::Rails::IndexSettings::DEFAULT_PRIMARY_KEY
       end
 
-      def meilisearch_settings_changed?(server_state, user_configuration)
+      def ms_index_settings_changed?(server_state, user_configuration)
         return true if server_state.nil?
 
         user_configuration.transform_keys! { |key| key.to_s.camelize(:lower) }
@@ -560,7 +560,7 @@ def meilisearch_settings_changed?(server_state, user_configuration)
           server = server_state[key]
 
           if user.is_a?(Hash) && server.is_a?(Hash)
-            meilisearch_settings_changed?(server, user)
+            ms_index_settings_changed?(server, user)
           elsif user.is_a?(Array) && server.is_a?(Array)
             user.map(&:to_s).sort! != server.map(&:to_s).sort!
           else

spec/settings_spec.rb

@@ -11,7 +11,7 @@
     context 'when passed a block' do
       it 'uses the block to determine attribute\'s value' do
         m = Namespaced::Model.new(another_private_value: 2)
-        attributes = Namespaced::Model.meilisearch_settings.get_attributes(m)
+        attributes = Namespaced::Model.ms_index_settings.get_attributes(m)
         expect(attributes).to include('customAttr' => 42, 'myid' => m.id)
       end
     end
@@ -109,7 +109,7 @@
   describe 'use_serializer' do
     it 'only uses the attributes from the serializer' do
       o = SerializedDocument.new name: 'test', skip: 'skip me'
-      attributes = SerializedDocument.meilisearch_settings.get_attributes(o)
+      attributes = SerializedDocument.ms_index_settings.get_attributes(o)
       expect(attributes).to eq({ name: 'test' })
     end
   end
@@ -144,7 +144,7 @@
       end
 
       it 'warns the user' do
-        People.meilisearch_settings.add_index(safe_index_uid('searchable_attr_spec')) do
+        People.ms_index_settings.add_index(safe_index_uid('searchable_attr_spec')) do
           attribute :first_name
           searchable_attributes %i[first_name last_name]
         end
@@ -161,7 +161,7 @@
       end
 
       it 'we cannot be certain that it is not defined and don\'t warn the user' do
-        Comment.meilisearch_settings.add_index(safe_index_uid('nested_searchable_attr_spec')) do
+        Comment.ms_index_settings.add_index(safe_index_uid('nested_searchable_attr_spec')) do
           attribute :post do
             { title: post&.title }
           end