Merge branch 'main' into fix-matching-strategy-spec

Author: curquiza

.code-samples.meilisearch.yaml

@@ -14,7 +14,12 @@ delete_documents_by_filter_1: |-
 get_documents_1: |-
   client.index('movies').get_documents(limit: 2, filter: 'genres = action')
 getting_started_faceting: |-
-  client.index('movies').update_faceting(max_values_per_facet: 2)
+  client.index('movies').update_faceting({
+    max_values_per_facet: 2,
+    sort_facet_values_by: {
+      genres: 'count'
+    }
+  })
 getting_started_pagination: |-
   client.index('movies').update_pagination(max_total_hits: 500)
 synonyms_guide_1: |-
@@ -74,9 +79,15 @@ update_pagination_settings_1: |-
 reset_pagination_settings_1: |-
   index('books').reset_pagination
 get_faceting_settings_1: |-
-  index('books').faceting
+  client.index('books').faceting
 update_faceting_settings_1: |-
-  index('books').update_faceting({ max_values_per_facet: 2 })
+  client.index('books').update_faceting({
+    max_values_per_facet: 2,
+    sort_facet_values_by: {
+      '*': 'alpha',
+      genres: 'count'
+    }
+  })
 reset_faceting_settings_1: |-
   index('books').reset_faceting
 get_one_index_1: |-
@@ -311,7 +322,7 @@ search_parameter_guide_crop_1: |-
 search_parameter_guide_crop_marker_1: |-
   client.index('movies').search('shifu', {
     attributes_to_crop: ['overview'],
-    crop_marker: "[…]"
+    crop_marker: '[…]'
   })
 search_parameter_guide_highlight_1: |-
   client.index('movies').search('winter feast', {
@@ -350,11 +361,6 @@ add_movies_json_1: |-
   movies_json = File.read('movies.json')
   movies = JSON.parse(movies_json)
   client.index('movies').add_documents(movies)
-documents_guide_add_movie_1: |-
-  client.index('movies').add_documents([{
-    movie_id: '123sq178',
-    title: 'Amelie Poulain'
-  }])
 getting_started_add_documents_md: |-
   ```bash
   $ bundle add meilisearch
@@ -388,26 +394,6 @@ faceted_search_1: |-
   client.index('books').search('classic', {
     facets: ['genres', 'rating', 'language']
   })
-faceted_search_2: |-
-  client.multi_search([
-    {
-      indexUid: 'books',
-      facets: ['language', 'genres', 'author', 'format'],
-      filter: [['language = English', 'language = French'], ['genres = Fiction']]
-    },
-    {
-      indexUid: 'books',
-      facets: ['language'],
-      filter: [['genres = Fiction']]
-    },
-    {
-      indexUid: 'books',
-      facets: ['genres'],
-      filter: [['language = English', 'language = French']]
-    }
-  ])
-faceted_search_facets_1: |-
-  client.index('movies').search('Batman', { facets: ['genres'] })
 faceted_search_walkthrough_filter_1: |-
   client.index('movies').search('thriller', {
     filter: [['genres = Horror', 'genres = Mystery'], 'director = "Jordan Peele"']
@@ -549,9 +535,6 @@ getting_started_update_displayed_attributes: |-
     'overview',
     'poster'
   ])
-getting_started_communicating_with_a_protected_instance: |-
-  client = MeiliSearch::Client.new('http://localhost:7700', 'apiKey')
-  client.index('movies').search
 getting_started_add_meteorites: |-
   file = File.read('meteorites.json')
   json = JSON.parse(file)
@@ -609,10 +592,38 @@ typo_tolerance_guide_4: |-
       two_typos: 10
     }
   })
+search_parameter_guide_facet_stats_1: |-
+  client.index('movie_ratings').search('Batman', {
+    facets: ['genres', 'rating']
+  })
 multi_search_1: |-
   client.multi_search([
     { index_uid: 'books', q: 'prince' },
     { index_uid: 'movies', q: 'pooh', limit: 5 }
     { index_uid: 'movies', q: 'nemo', limit: 5 }
     { index_uid: 'movie_ratings', q: 'us' }
   ])
+facet_search_2: |-
+  client.index('books').update_faceting(
+    sort_facet_values_by: {
+      genres: 'count'
+    }
+  )
+get_dictionary_1: |-
+  client.index('books').dictionary
+update_dictionary_1: |-
+  client.index('books').update_dictionary(['J. R. R.', 'W. E. B.'])
+reset_dictionary_1: |-
+  client.index('books').reset_dictionary
+get_separator_tokens_1: |-
+  client.index('articles').separator_tokens
+update_separator_tokens_1: |-
+  client.index('articles').update_separator_tokens(['|', '…'])
+reset_separator_tokens_1: |-
+  client.index('articles').reset_separator_tokens
+get_non_separator_tokens_1: |-
+  client.index('articles').non_separator_tokens
+update_non_separator_tokens_1: |-
+  client.index('articles').update_non_separator_tokens(['@', '#'])
+reset_non_separator_tokens_1: |-
+  client.index('articles').reset_non_separator_tokens

.github/workflows/gempush.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-20.04
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Ruby 2.6
         uses: actions/setup-ruby@v1
         with:

.github/workflows/pre-release-tests.yml

@@ -17,7 +17,7 @@ jobs:
     name: integration-tests-against-rc (ruby ${{ matrix.ruby-version }})
     runs-on: ubuntu-20.04
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Ruby ${{ matrix.ruby-version }}
         uses: ruby/setup-ruby@v1
         with:

.github/workflows/tests.yml

@@ -21,7 +21,7 @@ jobs:
     name: integration-tests (ruby ${{ matrix.ruby-version }})
     runs-on: ubuntu-20.04
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Ruby ${{ matrix.ruby-version }}
         uses: ruby/setup-ruby@v1
         with:
@@ -41,7 +41,7 @@ jobs:
     name: linter-check
     runs-on: ubuntu-20.04
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
@@ -55,7 +55,7 @@ jobs:
     name: Yaml linting check
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Yaml lint check
         uses: ibiqlik/action-yamllint@v3
         with:

.rubocop_todo.yml

@@ -1,29 +1,21 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2023-05-20 02:24:12 UTC using RuboCop version 1.50.2.
+# on 2023-10-10 14:01:22 UTC using RuboCop version 1.50.2.
 # 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
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: Severity, Include.
-# Include: **/*.gemspec
-Gemspec/RequireMFA:
-  Exclude:
-    - 'meilisearch.gemspec'
-
-# Offense count: 47
+# Offense count: 52
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 # AllowedMethods: refine
 Metrics/BlockLength:
-  Max: 624
+  Max: 671
 
 # Offense count: 2
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 328
+  Max: 358
 
 # Offense count: 1
 # Configuration parameters: Max, CountKeywordArgs.

lib/meilisearch/error.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
 module MeiliSearch
-  class ApiError < StandardError
+  class Error < StandardError
+  end
+
+  class ApiError < Error
     # :http_code    # e.g. 400, 404...
     # :http_message # e.g. Bad Request, Not Found...
     # :http_body    # The response body received from the MeiliSearch API
@@ -45,7 +48,7 @@ def details
     end
   end
 
-  class CommunicationError < StandardError
+  class CommunicationError < Error
     attr_reader :message
 
     def initialize(message)
@@ -54,7 +57,7 @@ def initialize(message)
     end
   end
 
-  class TimeoutError < StandardError
+  class TimeoutError < Error
     attr_reader :message
 
     def initialize(message = nil)
@@ -64,8 +67,8 @@ def initialize(message = nil)
   end
 
   module TenantToken
-    class ExpireOrInvalidSignature < StandardError; end
-    class InvalidApiKey < StandardError; end
-    class InvalidSearchRules < StandardError; end
+    class ExpireOrInvalidSignature < MeiliSearch::Error; end
+    class InvalidApiKey < MeiliSearch::Error; end
+    class InvalidSearchRules < MeiliSearch::Error; end
   end
 end

lib/meilisearch/index.rb

@@ -461,5 +461,49 @@ def update_faceting(faceting_attributes)
     def reset_faceting
       http_delete("/indexes/#{@uid}/settings/faceting")
     end
+
+    ### SETTINGS - DICTIONARY
+
+    def dictionary
+      http_get("/indexes/#{@uid}/settings/dictionary")
+    end
+
+    def update_dictionary(dictionary_attributes)
+      attributes = Utils.transform_attributes(dictionary_attributes)
+      http_put("/indexes/#{@uid}/settings/dictionary", attributes)
+    end
+
+    def reset_dictionary
+      http_delete("/indexes/#{@uid}/settings/dictionary")
+    end
+    ### SETTINGS - SEPARATOR TOKENS
+
+    def separator_tokens
+      http_get("/indexes/#{@uid}/settings/separator-tokens")
+    end
+
+    def update_separator_tokens(separator_tokens_attributes)
+      attributes = Utils.transform_attributes(separator_tokens_attributes)
+      http_put("/indexes/#{@uid}/settings/separator-tokens", attributes)
+    end
+
+    def reset_separator_tokens
+      http_delete("/indexes/#{@uid}/settings/separator-tokens")
+    end
+
+    ### SETTINGS - NON SEPARATOR TOKENS
+
+    def non_separator_tokens
+      http_get("/indexes/#{@uid}/settings/non-separator-tokens")
+    end
+
+    def update_non_separator_tokens(non_separator_tokens_attributes)
+      attributes = Utils.transform_attributes(non_separator_tokens_attributes)
+      http_put("/indexes/#{@uid}/settings/non-separator-tokens", attributes)
+    end
+
+    def reset_non_separator_tokens
+      http_delete("/indexes/#{@uid}/settings/non-separator-tokens")
+    end
   end
 end

spec/meilisearch/client/errors_spec.rb

@@ -1,6 +1,17 @@
 # frozen_string_literal: true
 
 RSpec.describe 'MeiliSearch::Client - Errors' do
+  describe 'MeiliSearch::Error' do
+    it 'catches all other errors' do
+      expect(MeiliSearch::TimeoutError.ancestors).to include(MeiliSearch::Error)
+      expect(MeiliSearch::CommunicationError.ancestors).to include(MeiliSearch::Error)
+      expect(MeiliSearch::ApiError.ancestors).to include(MeiliSearch::Error)
+      expect(MeiliSearch::TenantToken::InvalidApiKey.ancestors).to include(MeiliSearch::Error)
+      expect(MeiliSearch::TenantToken::InvalidSearchRules.ancestors).to include(MeiliSearch::Error)
+      expect(MeiliSearch::TenantToken::ExpireOrInvalidSignature.ancestors).to include(MeiliSearch::Error)
+    end
+  end
+
   context 'when request takes to long to answer' do
     it 'raises MeiliSearch::TimeoutError' do
       timed_client = MeiliSearch::Client.new(URL, MASTER_KEY, { timeout: 0.000001 })