Add utils function to warn on non-snake case attributes

Author: jmks

lib/meilisearch/utils.rb

@@ -52,6 +52,20 @@ 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)
+      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.
+
+        Non-conforming attributes: #{non_snake_case.join(', ')}
+      MSG
+
+      warn(message)
+    end
+
     private_class_method :parse, :message_builder
   end
 end

spec/meilisearch/utils_spec.rb

@@ -71,5 +71,31 @@
         end
       end.to raise_error(MeiliSearch::CommunicationError, /that `my_method` call requires/)
     end
+
+    describe '.warn_on_non_conforming_attribute_names' do
+      it 'warns when using camelCase attributes' do
+        attrs = { attributesToHighlight: ['field'] }
+
+        expect do
+          Utils.warn_on_non_conforming_attribute_names(attrs)
+        end.to output(include('Attributes will be expected to be snake_case', 'attributesToHighlight')).to_stderr
+      end
+
+      it 'warns when using a mixed case' do
+        attrs = { distinct_ATTribute: 'title' }
+
+        expect do
+          Utils.warn_on_non_conforming_attribute_names(attrs)
+        end.to output(include('Attributes will be expected to be snake_case', 'distinct_ATTribute')).to_stderr
+      end
+
+      it 'does not warn when using snake_case' do
+        attrs = { q: 'query', attributes_to_highlight: ['field'] }
+
+        expect do
+          Utils.warn_on_non_conforming_attribute_names(attrs)
+        end.not_to output.to_stderr
+      end
+    end
   end
 end