Merge pull request #470 from meilisearch/jmks-deprecate-camel-case-attributes

Jmks deprecate camel case attributes

Author: brunoocasali

.rubocop_todo.yml

@@ -23,7 +23,7 @@ Metrics/BlockLength:
 # Offense count: 2
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 327
+  Max: 328
 
 # Offense count: 1
 # Configuration parameters: Max, CountKeywordArgs.

docker-compose.yml

@@ -22,7 +22,7 @@ services:
       - bundle:/vendor/bundle
 
   meilisearch:
-    image: getmeili/meilisearch:v1.3.0
+    image: getmeili/meilisearch:latest
     ports:
       - "7700"
     environment:

lib/meilisearch/client.rb

@@ -31,7 +31,7 @@ def indexes(options = {})
 
     # Usage:
     # client.create_index('indexUID')
-    # client.create_index('indexUID', primaryKey: 'id')
+    # client.create_index('indexUID', primary_key: 'id')
     def create_index(index_uid, options = {})
       body = Utils.transform_attributes(options.merge(uid: index_uid))
 

lib/meilisearch/index.rb

@@ -221,8 +221,9 @@ def delete_all_documents!
     ### SEARCH
 
     def search(query, options = {})
-      parsed_options = Utils.transform_attributes({ q: query.to_s }.merge(options.compact))
+      attributes = { q: query.to_s }.merge(options.compact)
 
+      parsed_options = Utils.transform_attributes(attributes)
       response = http_post "/indexes/#{@uid}/search", parsed_options
 
       response['nbHits'] ||= response['estimatedTotalHits'] unless response.key?('totalPages')

lib/meilisearch/utils.rb

@@ -9,6 +9,7 @@ def self.transform_attributes(body)
       when Array
         body.map { |item| transform_attributes(item) }
       when Hash
+        warn_on_non_conforming_attribute_names(body)
         parse(body)
       else
         body
@@ -52,6 +53,21 @@ def self.version_error_handler(method_name)
       raise e.class, message_builder(e.message, method_name)
     end
 
+    def self.warn_on_non_conforming_attribute_names(body)
+      return if body.nil?
+
+      non_snake_case = body.keys.grep_v(/^[a-z0-9_]+$/)
+      return if non_snake_case.empty?
+
+      message = <<~MSG
+        Attributes will be expected to be snake_case in future versions of Meilisearch Ruby.
+
+        Non-conforming attributes: #{non_snake_case.join(', ')}
+      MSG
+
+      warn(message)
+    end
+
     private_class_method :parse, :message_builder
   end
 end

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/client/requests_spec.rb

@@ -16,12 +16,4 @@
     expect(index.uid).to eq(key)
     expect(index.primary_key).to eq(key)
   end
-
-  it 'parses options when they are in a different shape' do
-    client.create_index!(key, priMARy_kEy: key)
-
-    index = client.fetch_index(key)
-    expect(index.uid).to eq(key)
-    expect(index.primary_key).to eq(key)
-  end
 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…")