Merge #237

237: Add snake_case support for query parameters r=curquiza a=brunoocasali

To evict a breaking change I've added support to any kind of formatting let the meilisearch backend tells us if the code is right or wrong.

After some time, we could introduce a deprecation warning and then remove the system that supports this feature.


Co-authored-by: Bruno Casali <[email protected]>

Author: bors[bot]

.code-samples.meilisearch.yaml

@@ -8,9 +8,9 @@ get_one_index_1: |-
 list_all_indexes_1: |-
   client.indexes
 create_an_index_1: |-
-  client.create_index('movies', primaryKey: 'movie_id')
+  client.create_index('movies', primary_key: 'movie_id')
 update_an_index_1: |-
-  client.index('movies').update(primaryKey: 'movie_id')
+  client.index('movies').update(primary_key: 'movie_id')
 delete_an_index_1: |-
   client.delete_index('movies')
 get_one_document_1: |-
@@ -53,7 +53,7 @@ get_settings_1: |-
   client.index('movies').settings
 update_settings_1: |-
   client.index('movies').update_settings({
-    rankingRules: [
+    ranking_rules: [
       'words',
       'typo',
       'proximity',
@@ -63,24 +63,24 @@ update_settings_1: |-
       'release_date:desc',
       'rank:desc'
     ],
-    distinctAttribute: 'movie_id',
-    searchableAttributes: [
+    distinct_attribute: 'movie_id',
+    searchable_attributes: [
       'title',
       'description',
       'genre'
     ],
-    displayedAttributes: [
+    displayed_attributes: [
       'title',
       'description',
       'genre',
       'release_date'
     ],
-    stopWords: [
+    stop_words: [
       'the',
       'a',
       'an'
     ],
-    sortableAttributes: [
+    sortable_attributes: [
       'title',
       'release_date'
     ],
@@ -176,7 +176,7 @@ field_properties_guide_searchable_1: |-
   ])
 field_properties_guide_displayed_1: |-
   client.index('movies').update_settings({
-    displayedAttributes: [
+    displayed_attributes: [
       'title',
       'description',
       'genre',
@@ -207,16 +207,16 @@ search_parameter_guide_limit_1: |-
   })
 search_parameter_guide_retrieve_1: |-
   client.index('movies').search('shifu', {
-    attributesToRetrieve: ['overview', 'title']
+    attributes_to_retrieve: ['overview', 'title']
   })
 search_parameter_guide_crop_1: |-
   client.index('movies').search('shifu', {
-    attributesToCrop: ['overview'],
+    attributes_to_crop: ['overview'],
     cropLength: 10
   })
 search_parameter_guide_highlight_1: |-
   client.index('movies').search('winter feast', {
-    attributesToHighlight: ['overview']
+    attributes_to_highlight: ['overview']
   })
 search_parameter_guide_matches_1: |-
   client.index('movies').search('winter feast', {
@@ -239,15 +239,15 @@ settings_guide_synonyms_1: |-
   })
 settings_guide_stop_words_1: |-
   client.index('movies').update_settings({
-    stopWords: [
+    stop_words: [
       'the',
       'a',
       'an'
     ]
   })
 settings_guide_ranking_rules_1: |-
   client.index('movies').update_settings({
-    rankingRules: [
+    ranking_rules: [
       'words',
       'typo',
       'proximity',
@@ -262,15 +262,15 @@ settings_guide_distinct_1: |-
   client.index('jackets').update_distinct_attribute('product_id')
 settings_guide_searchable_1: |-
   client.index('movies').update_settings({
-    searchableAttributes: [
+    searchable_attributes: [
       'title',
       'description',
       'genre'
     ]
   })
 settings_guide_displayed_1: |-
   client.index('movies').update_settings({
-    displayedAttributes: [
+    displayed_attributes: [
       'title',
       'description',
       'genre',
@@ -332,7 +332,7 @@ faceted_search_filter_1: |-
   })
 faceted_search_facets_distribution_1: |-
   client.index('movies').search('Batman', {
-    facetsDistribution: ['genres']
+    facets_distribution: ['genres']
   })
 faceted_search_walkthrough_filterable_attributes_1: |-
   client.index('movies').update_filterable_attributes([
@@ -347,7 +347,7 @@ faceted_search_walkthrough_filter_1: |-
   })
 faceted_search_walkthrough_facets_distribution_1: |-
   client.index('movies').search('Batman', {
-    facetsDistribution: ['genres']
+    facets_distribution: ['genres']
   })
 post_dump_1: |-
   client.create_dump

README.md

@@ -124,7 +124,7 @@ All the supported options are described in the [search parameters](https://docs.
 ```ruby
 index.search(
   'wonder',
-  attributesToHighlight: ['*']
+  attributes_to_highlight: ['*']
 )
 ```
 

lib/meilisearch/http_request.rb

@@ -54,6 +54,8 @@ def http_delete(relative_path = '')
 
     private
 
+    SNAKE_CASE = /[^a-zA-Z0-9]+(.)/.freeze
+
     def send_request(http_method, relative_path, query_params = nil, body = nil)
       config = http_config(query_params, body)
       begin
@@ -65,7 +67,8 @@ def send_request(http_method, relative_path, query_params = nil, body = nil)
     end
 
     def http_config(query_params, body)
-      body = body.to_json
+      body = transform_attributes(body).to_json
+
       {
         headers: @headers,
         query: query_params,
@@ -75,6 +78,25 @@ def http_config(query_params, body)
       }.compact
     end
 
+    def transform_attributes(body)
+      case body
+      when Array
+        body.map { |item| transform_attributes(item) }
+      when Hash
+        parse(body)
+      else
+        body
+      end
+    end
+
+    def parse(body)
+      body
+        .transform_keys(&:to_s)
+        .transform_keys do |key|
+          key.include?('_') ? key.downcase.gsub(SNAKE_CASE, &:upcase).gsub('_', '') : key
+        end
+    end
+
     def validate(response)
       raise ApiError.new(response.code, response.message, response.body) unless response.success?
 

spec/meilisearch/client/indexes_spec.rb

@@ -126,4 +126,15 @@
     expect(@client.delete_index_if_exists(@uid6)).to eq(false)
     expect(@client.indexes.count).to eq(0)
   end
+
+  context 'with snake_case options' do
+    it 'creates an index without errors' do
+      uid = SecureRandom.uuid
+
+      expect do
+        @client.create_index(uid, primary_key: @primary_key)
+        @client.fetch_index(uid)
+      end.to_not raise_error
+    end
+  end
 end

spec/meilisearch/client/requests_spec.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+RSpec.describe 'MeiliSearch::Client requests' do
+  let(:key) { SecureRandom.uuid }
+
+  before(:each) do
+    @client = MeiliSearch::Client.new(URL, MASTER_KEY)
+
+    expect(MeiliSearch::Client).to receive(:post)
+      .with(kind_of(String), hash_including(body: "{\"primaryKey\":\"#{key}\",\"uid\":\"#{key}\"}"))
+      .and_call_original
+  end
+
+  it 'parses options when they are in a snake_case' do
+    @client.create_index(key, primary_key: key)
+  end
+
+  it 'parses options when they are in a different shape' do
+    @client.create_index(key, priMARy_kEy: key)
+  end
+end

spec/meilisearch/index/search/multi_params_spec.rb

@@ -95,4 +95,22 @@
     expect(response['facetsDistribution']['genre']['fantasy']).to eq(1)
     expect(response['exhaustiveFacetsCount']).to be false
   end
+
+  context 'with snake_case options' do
+    it 'does a custom search with attributes in a unusual formatting' do
+      response = @index.search(
+        'prince',
+        {
+          aTTributes_TO_Crop: ['title'],
+          cropLength: 2,
+          filter: 'genre = adventure',
+          attributes_to_highlight: ['title']
+        }
+      )
+
+      expect(response['hits'].count).to be(1)
+      expect(response['hits'].first).to have_key('_formatted')
+      expect(response['hits'].first['_formatted']['title']).to eq('Petit <em>Prince</em>')
+    end
+  end
 end