Merge test refactoring into main

New test has been added while PR #350 was being finished.

Author: ellnix

.github/workflows/tests.yml

@@ -36,8 +36,9 @@ jobs:
         run: bundle exec rspec
       - name: Upload coverage reports to Codecov
         uses: codecov/codecov-action@v4
-        env:
-          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+        if: matrix.ruby-version == '3.1' && matrix.rails-version == '7.0'
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
 
   linter_check:
     name: linter-check

.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2024-01-10 10:49:28 UTC using RuboCop version 1.27.0.
+# on 2024-04-08 13:44:25 UTC using RuboCop version 1.27.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -67,7 +67,7 @@ Lint/UnusedMethodArgument:
   Exclude:
     - 'lib/meilisearch-rails.rb'
 
-# Offense count: 11
+# Offense count: 12
 # Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
   Max: 104
@@ -81,14 +81,14 @@ Metrics/BlockLength:
 # Offense count: 1
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 156
+  Max: 157
 
 # Offense count: 8
 # Configuration parameters: IgnoredMethods.
 Metrics/CyclomaticComplexity:
   Max: 27
 
-# Offense count: 16
+# Offense count: 18
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 Metrics/MethodLength:
   Max: 103
@@ -128,13 +128,7 @@ RSpec/BeforeAfterAll:
   Exclude:
     - 'spec/integration_spec.rb'
 
-# Offense count: 7
-# Configuration parameters: IgnoredMetadata.
-RSpec/DescribeClass:
-  Exclude:
-    - 'spec/integration_spec.rb'
-
-# Offense count: 46
+# Offense count: 56
 # Configuration parameters: CountAsOne.
 RSpec/ExampleLength:
   Max: 19
@@ -154,24 +148,11 @@ RSpec/InstanceVariable:
   Exclude:
     - 'spec/integration_spec.rb'
 
-# Offense count: 1
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: have_received, receive
-RSpec/MessageSpies:
-  Exclude:
-    - 'spec/integration_spec.rb'
-
 # Offense count: 1
 RSpec/MultipleDescribes:
   Exclude:
     - 'spec/integration_spec.rb'
 
-# Offense count: 1
-# This cop supports safe auto-correction (--auto-correct).
-RSpec/MultipleSubjects:
-  Exclude:
-    - 'spec/ms_clean_up_job_spec.rb'
-
 # Offense count: 1
 # Configuration parameters: IgnoreNameless, IgnoreSymbolicNames.
 RSpec/VerifiedDoubles:
@@ -231,7 +212,7 @@ Style/OptionalBooleanParameter:
   Exclude:
     - 'lib/meilisearch-rails.rb'
 
-# Offense count: 13
+# Offense count: 11
 # This cop supports safe auto-correction (--auto-correct).
 # Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
 # SupportedStyles: single_quotes, double_quotes
@@ -248,7 +229,7 @@ Style/TrailingCommaInArguments:
   Exclude:
     - 'spec/integration_spec.rb'
 
-# Offense count: 19
+# Offense count: 20
 # This cop supports safe auto-correction (--auto-correct).
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https

Gemfile

@@ -31,7 +31,7 @@ group :test do
   gem 'jdbc-sqlite3', platform: :jruby
   gem 'rspec', '~> 3.0'
   gem 'simplecov', require: 'false'
-  gem 'codecov', require: 'false'
+  gem 'simplecov-cobertura', require: 'false'
   gem 'threads'
 
   gem 'byebug'

README.md

@@ -207,6 +207,7 @@ class Book < ApplicationRecord
     crop_length 10
     faceting max_values_per_facet: 2000
     pagination max_total_hits: 1000
+    proximity_precision 'byWord'
   end
 end
 ```
@@ -230,7 +231,7 @@ harry_book.formatted # => {"id"=>"1", "name"=>"<em>Harry</em> Potter", "descript
 👉 Don't forget that `attributes_to_highlight`, `attributes_to_crop`, and
 `crop_length` can be set up in the `meilisearch` block of your model.
 
-## 🔍 Sorted search
+### 🔍 Sorted search
 
 As an example of how to use the sort option, here is how you could achieve
 returning all books sorted by title in ascending order:

docker-compose.yml

@@ -1,5 +1,3 @@
-version: "3.7"
-
 volumes:
   bundle:
   play_bundle:

lib/meilisearch-rails.rb

@@ -67,6 +67,7 @@ class IndexSettings
         pagination
         faceting
         typo_tolerance
+        proximity_precision
       ].freeze
 
       CAMELIZE_OPTIONS = %i[pagination faceting typo_tolerance].freeze
@@ -588,7 +589,7 @@ def ms_entries_for(document:, synchronous:)
         ms_configurations.filter_map do |options, settings|
           {
             synchronous: synchronous || options[:synchronous],
-            index_uid: options[:index_uid],
+            index_uid: ms_index_uid(options),
             primary_key: primary_key
           }.with_indifferent_access unless ms_indexing_disabled?(options)
         end

lib/meilisearch/rails/multi_search/result.rb

@@ -30,8 +30,8 @@ def each_hit(&block)
       end
       alias each each_hit
 
-      def each_result
-        @results.each
+      def each_result(&block)
+        @results.each(&block)
       end
 
       def to_a

lib/meilisearch/rails/version.rb

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

spec/integration_spec.rb

@@ -20,3 +20,42 @@
   end
 end
 
+describe 'proximity_precision' do
+  before do
+    stub_const(
+      'OtherColor',
+      Class.new do
+        include ActiveModel::Model
+        include MeiliSearch::Rails
+      end
+    )
+  end
+
+  context 'when the value is byWord' do
+    before do
+      OtherColor.meilisearch synchronize: true, index_uid: safe_index_uid('OtherColors') do
+        proximity_precision 'byWord'
+      end
+    end
+
+    it 'sets the value byWord to proximity precision' do
+      AsyncHelper.await_last_task
+      expect(OtherColor.index.get_settings['proximityPrecision']).to eq('byWord')
+    end
+  end
+
+  context 'when the value is byAttribute' do
+    before do
+      OtherColor.meilisearch synchronize: true, index_uid: safe_index_uid('OtherColors') do
+        proximity_precision 'byAttribute'
+      end
+    end
+
+    it 'sets the value byAttribute to proximity precision' do
+      OtherColor.index.get_settings # induce update_settings
+      AsyncHelper.await_last_task
+      expect(OtherColor.index.get_settings['proximityPrecision']).to eq('byAttribute')
+    end
+  end
+end
+

spec/ms_clean_up_job_spec.rb

@@ -23,7 +23,7 @@ def create_indexed_record
   end
 
   let(:record_entries) do
-    record.ms_entries(true).each { |h| h[:index_uid] += '_test' }
+    record.ms_entries(true)
   end
 
   let(:indexes) do