Update specs to use snake_case attributes

Author: jmks

spec/meilisearch/client/indexes_spec.rb

@@ -32,7 +32,7 @@
 
     context 'with a primary key' do
       it 'creates an index' do
-        task = client.create_index('books', primaryKey: 'reference_code')
+        task = client.create_index('books', primary_key: 'reference_code')
 
         expect(task['type']).to eq('indexCreation')
 
@@ -46,7 +46,7 @@
       end
 
       it 'creates an index synchronously' do
-        task = client.create_index!('books', primaryKey: 'reference_code')
+        task = client.create_index!('books', primary_key: 'reference_code')
 
         expect(task['type']).to eq('indexCreation')
         expect(task['status']).to eq('succeeded')
@@ -77,7 +77,7 @@
         it 'ignores the uid option' do
           task = client.create_index(
             'books',
-            primaryKey: 'reference_code',
+            primary_key: 'reference_code',
             uid: 'publications'
           )
 
@@ -173,7 +173,7 @@
 
   describe '#fetch_index' do
     it 'fetches index by uid' do
-      client.create_index!('books', primaryKey: 'reference_code')
+      client.create_index!('books', primary_key: 'reference_code')
 
       fetched_index = client.fetch_index('books')
 
@@ -186,7 +186,7 @@
 
   describe '#fetch_raw_index' do
     it 'fetch a specific index raw Hash response based on uid' do
-      client.create_index!('books', primaryKey: 'reference_code')
+      client.create_index!('books', primary_key: 'reference_code')
       index = client.fetch_index('books')
       raw_response = index.fetch_raw_info
 
@@ -202,7 +202,7 @@
 
   describe '#index' do
     it 'returns an index object with the provided uid' do
-      client.create_index!('books', primaryKey: 'reference_code')
+      client.create_index!('books', primary_key: 'reference_code')
       # this index is in memory, without metadata from server
       index = client.index('books')
 

spec/meilisearch/client/keys_spec.rb

@@ -8,15 +8,15 @@
         description: 'A new key to delete docs',
         actions: ['documents.delete'],
         indexes: ['*'],
-        expiresAt: nil
+        expires_at: nil
       }
     end
     let(:add_docs_key_options) do
       {
         description: 'A new key to add docs',
         actions: ['documents.add'],
         indexes: ['*'],
-        expiresAt: nil
+        expires_at: nil
       }
     end
 

spec/meilisearch/index/base_spec.rb

@@ -15,7 +15,7 @@
   end
 
   it 'fetch the raw Hash info of the index' do
-    client.create_index!('books', primaryKey: 'reference_number')
+    client.create_index!('books', primary_key: 'reference_number')
 
     raw_index = client.fetch_raw_index('books')
 
@@ -37,7 +37,7 @@
   end
 
   it 'get primary-key of index if it exists' do
-    client.create_index!('index_with_prirmary_key', primaryKey: 'primary_key')
+    client.create_index!('index_with_prirmary_key', primary_key: 'primary_key')
 
     index = client.fetch_index('index_with_prirmary_key')
     expect(index.primary_key).to eq('primary_key')
@@ -54,7 +54,7 @@
   it 'updates primary-key of index if not defined before' do
     client.create_index!('uid')
 
-    task = client.index('uid').update(primaryKey: 'new_primary_key')
+    task = client.index('uid').update(primary_key: 'new_primary_key')
     expect(task['type']).to eq('indexUpdate')
     client.wait_for_task(task['taskUid'])
 
@@ -70,9 +70,9 @@
   end
 
   it 'updates primary-key of index if has been defined before but there is not docs' do
-    client.create_index!('books', primaryKey: 'reference_number')
+    client.create_index!('books', primary_key: 'reference_number')
 
-    task = client.index('books').update(primaryKey: 'international_standard_book_number')
+    task = client.index('books').update(primary_key: 'international_standard_book_number')
     expect(task['type']).to eq('indexUpdate')
     client.wait_for_task(task['taskUid'])
 
@@ -91,7 +91,7 @@
     index = client.index('uid')
     index.add_documents!({ id: 1, title: 'My Title' })
 
-    task = index.update(primaryKey: 'new_primary_key')
+    task = index.update(primary_key: 'new_primary_key')
     expect(task['type']).to eq('indexUpdate')
     achieved_task = client.wait_for_task(task['taskUid'])
 
@@ -177,7 +177,7 @@
   end
 
   it 'works with method aliases' do
-    client.create_index!('uid', primaryKey: 'primary_key')
+    client.create_index!('uid', primary_key: 'primary_key')
 
     index = client.fetch_index('uid')
     expect(index.method(:fetch_primary_key) == index.method(:get_primary_key)).to be_truthy

spec/meilisearch/index/search/attributes_to_crop_spec.rb

@@ -13,23 +13,23 @@
   before { index.add_documents!(document) }
 
   it 'searches with default cropping params' do
-    response = index.search('galaxy', attributesToCrop: ['*'], cropLength: 6)
+    response = index.search('galaxy', attributes_to_crop: ['*'], crop_length: 6)
 
     expect(response.dig('hits', 0, '_formatted', 'description')).to eq('…Guide to the Galaxy is a…')
   end
 
   it 'searches with custom crop markers' do
-    response = index.search('galaxy', attributesToCrop: ['*'], cropLength: 6, cropMarker: '(ꈍᴗꈍ)')
+    response = index.search('galaxy', attributes_to_crop: ['*'], crop_length: 6, crop_marker: '(ꈍᴗꈍ)')
 
     expect(response.dig('hits', 0, '_formatted', 'description')).to eq('(ꈍᴗꈍ)Guide to the Galaxy is a(ꈍᴗꈍ)')
   end
 
   it 'searches with mixed highlight and crop config' do
     response = index.search(
       'galaxy',
-      attributesToHighlight: ['*'],
-      attributesToCrop: ['*'],
-      highlightPreTag: '<span class="bold">'
+      attributes_to_highlight: ['*'],
+      attributes_to_crop: ['*'],
+      highlight_pre_tag: '<span class="bold">'
     )
 
     expect(response.dig('hits', 0, '_formatted', 'description')).to \
@@ -39,22 +39,22 @@
   it 'searches with highlight tags' do
     response = index.search(
       'galaxy',
-      attributesToHighlight: ['*'],
-      highlightPreTag: '<span>',
-      highlightPostTag: '</span>'
+      attributes_to_highlight: ['*'],
+      highlight_pre_tag: '<span>',
+      highlight_post_tag: '</span>'
     )
 
     expect(response.dig('hits', 0, '_formatted', 'description')).to include('<span>Galaxy</span>')
   end
 
   it 'does a custom search with attributes to crop' do
-    response = index.search('galaxy', { attributesToCrop: ['description'], cropLength: 6 })
+    response = index.search('galaxy', { attributes_to_crop: ['description'], crop_length: 6 })
     expect(response['hits'].first).to have_key('_formatted')
     expect(response['hits'].first['_formatted']['description']).to eq('…Guide to the Galaxy is a…')
   end
 
   it 'does a placehodler search with attributes to crop' do
-    response = index.search('', { attributesToCrop: ['description'], cropLength: 5 })
+    response = index.search('', { attributes_to_crop: ['description'], crop_length: 5 })
     expect(response['hits'].first).to have_key('_formatted')
     expect(response['hits'].first['description']).to eq(document[:description])
     expect(response['hits'].first['_formatted']['description']).to eq("The Hitchhiker's Guide to…")

spec/meilisearch/index/search/attributes_to_highlight.rb

@@ -4,7 +4,7 @@
   include_context 'search books with genre'
 
   it 'does a custom search with highlight' do
-    response = index.search('the', attributesToHighlight: ['title'])
+    response = index.search('the', attributes_to_highlight: ['title'])
     expect(response).to be_a(Hash)
     expect(response.keys).to contain_exactly(*DEFAULT_SEARCH_RESPONSE_KEYS)
     expect(response['hits'].count).to eq(3)
@@ -13,15 +13,15 @@
   end
 
   it 'does a placeholder search with attributes to highlight' do
-    response = index.search('', attributesToHighlight: ['*'])
+    response = index.search('', attributes_to_highlight: ['*'])
     expect(response).to be_a(Hash)
     expect(response.keys).to contain_exactly(*DEFAULT_SEARCH_RESPONSE_KEYS)
     expect(response['hits'].count).to eq(7)
     expect(response['hits'].first).to have_key('_formatted')
   end
 
   it 'does a placeholder search (nil) with attributes to highlight' do
-    response = index.search(nil, attributesToHighlight: ['*'])
+    response = index.search(nil, attributes_to_highlight: ['*'])
     expect(response).to be_a(Hash)
     expect(response.keys).to contain_exactly(*DEFAULT_SEARCH_RESPONSE_KEYS)
     expect(response['hits'].count).to eq(documents.count)

spec/meilisearch/index/search/attributes_to_retrieve_spec.rb

@@ -3,8 +3,8 @@
 RSpec.describe 'MeiliSearch::Index - Search with attributes to retrieve' do
   include_context 'search books with genre'
 
-  it 'does a custom search with one attributesToRetrieve' do
-    response = index.search('the', attributesToRetrieve: ['title'])
+  it 'does a custom search with one attributes_to_retrieve' do
+    response = index.search('the', attributes_to_retrieve: ['title'])
     expect(response).to be_a(Hash)
     expect(response.keys).to contain_exactly(*DEFAULT_SEARCH_RESPONSE_KEYS)
     expect(response['hits'].count).to eq(3)
@@ -13,8 +13,8 @@
     expect(response['hits'].first).not_to have_key('genre')
   end
 
-  it 'does a custom search with multiple attributesToRetrieve' do
-    response = index.search('the', attributesToRetrieve: ['title', 'genre'])
+  it 'does a custom search with multiple attributes_to_retrieve' do
+    response = index.search('the', attributes_to_retrieve: ['title', 'genre'])
     expect(response).to be_a(Hash)
     expect(response.keys).to contain_exactly(*DEFAULT_SEARCH_RESPONSE_KEYS)
     expect(response['hits'].count).to eq(3)
@@ -23,8 +23,8 @@
     expect(response['hits'].first).to have_key('genre')
   end
 
-  it 'does a custom search with all attributesToRetrieve' do
-    response = index.search('the', attributesToRetrieve: ['*'])
+  it 'does a custom search with all attributes_to_retrieve' do
+    response = index.search('the', attributes_to_retrieve: ['*'])
     expect(response).to be_a(Hash)
     expect(response.keys).to contain_exactly(*DEFAULT_SEARCH_RESPONSE_KEYS)
     expect(response['hits'].count).to eq(3)
@@ -33,8 +33,8 @@
     expect(response['hits'].first).to have_key('genre')
   end
 
-  it 'does a placeholder search with one attributesToRetrieve' do
-    response = index.search('', attributesToRetrieve: ['title'])
+  it 'does a placeholder search with one attributes_to_retrieve' do
+    response = index.search('', attributes_to_retrieve: ['title'])
     expect(response).to be_a(Hash)
     expect(response.keys).to contain_exactly(*DEFAULT_SEARCH_RESPONSE_KEYS)
     expect(response['hits'].count).to eq(documents.count)
@@ -43,8 +43,8 @@
     expect(response['hits'].first).not_to have_key('genre')
   end
 
-  it 'does a placeholder search with multiple attributesToRetrieve' do
-    response = index.search('', attributesToRetrieve: ['title', 'genre'])
+  it 'does a placeholder search with multiple attributes_to_retrieve' do
+    response = index.search('', attributes_to_retrieve: ['title', 'genre'])
     expect(response).to be_a(Hash)
     expect(response.keys).to contain_exactly(*DEFAULT_SEARCH_RESPONSE_KEYS)
     expect(response['hits'].count).to eq(documents.count)
@@ -53,8 +53,8 @@
     expect(response['hits'].first).to have_key('genre')
   end
 
-  it 'does a placeholder search with all attributesToRetrieve' do
-    response = index.search('', attributesToRetrieve: ['*'])
+  it 'does a placeholder search with all attributes_to_retrieve' do
+    response = index.search('', attributes_to_retrieve: ['*'])
     expect(response).to be_a(Hash)
     expect(response.keys).to contain_exactly(*DEFAULT_SEARCH_RESPONSE_KEYS)
     expect(response['hits'].count).to eq(documents.count)

spec/meilisearch/index/search/multi_params_spec.rb

@@ -11,18 +11,18 @@
   it 'does a custom search with attributes to crop, filter and attributes to highlight' do
     response = index.search('prince',
                             {
-                              attributesToCrop: ['title'],
-                              cropLength: 2,
+                              attributes_to_crop: ['title'],
+                              crop_length: 2,
                               filter: 'genre = adventure',
-                              attributesToHighlight: ['title']
+                              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
 
-  it 'does a custom search with attributesToRetrieve and a limit' do
-    response = index.search('the', attributesToRetrieve: ['title', 'genre'], limit: 2)
+  it 'does a custom search with attributes_to_retrieve and a limit' do
+    response = index.search('the', attributes_to_retrieve: ['title', 'genre'], limit: 2)
     expect(response).to be_a(Hash)
     expect(response.keys).to contain_exactly(*DEFAULT_SEARCH_RESPONSE_KEYS)
     expect(response['hits'].count).to eq(2)
@@ -37,21 +37,21 @@
   end
 
   it 'does a custom search with limit and attributes to highlight' do
-    response = index.search('the', { limit: 1, attributesToHighlight: ['*'] })
+    response = index.search('the', { limit: 1, attributes_to_highlight: ['*'] })
     expect(response).to be_a(Hash)
     expect(response.keys).to contain_exactly(*DEFAULT_SEARCH_RESPONSE_KEYS)
     expect(response['hits'].count).to eq(1)
     expect(response['hits'].first).to have_key('_formatted')
   end
 
-  it 'does a custom search with filter, attributesToRetrieve and attributesToHighlight' do
+  it 'does a custom search with filter, attributes_to_retrieve and attributes_to_highlight' do
     response = index.update_filterable_attributes(['genre'])
     index.wait_for_task(response['taskUid'])
     response = index.search('prinec',
                             {
                               filter: ['genre = fantasy'],
-                              attributesToRetrieve: ['title'],
-                              attributesToHighlight: ['*']
+                              attributes_to_retrieve: ['title'],
+                              attributes_to_highlight: ['*']
                             })
     expect(response.keys).to contain_exactly(*DEFAULT_SEARCH_RESPONSE_KEYS)
     expect(response['estimatedTotalHits']).to eq(1)
@@ -86,7 +86,7 @@
         'prince',
         {
           aTTributes_TO_Crop: ['title'],
-          cropLength: 2,
+          crop_length: 2,
           filter: 'genre = adventure',
           attributes_to_highlight: ['title']
         }