Merge #352

352: Add faceting settings customization r=brunoocasali a=voloyev

# Pull Request

## What does this PR do?
Fixes #346 

## PR checklist
Please check if your PR fulfills the following requirements:
- [x] Does this PR fix an existing issue?
- [x] Have you read the contributing guidelines?
- [x] Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!


Co-authored-by: Volodymyr Yevtushenko <[email protected]>

Author: meili-bors[bot]

.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2022-07-27 12:41:01 UTC using RuboCop version 1.32.0.
+# on 2022-07-27 15:08:15 UTC using RuboCop version 1.32.0.
 # 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
@@ -14,16 +14,16 @@ Gemspec/RequireMFA:
   Exclude:
     - 'meilisearch.gemspec'
 
-# Offense count: 45
+# Offense count: 46
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 # IgnoredMethods: refine
 Metrics/BlockLength:
-  Max: 597
+  Max: 626
 
 # Offense count: 2
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 305
+  Max: 317
 
 # Offense count: 1
 # Configuration parameters: Max, CountKeywordArgs.

lib/meilisearch/index.rb

@@ -411,5 +411,20 @@ def update_typo_tolerance(typo_tolerance_attributes)
     def reset_typo_tolerance
       http_delete("/indexes/#{@uid}/settings/typo-tolerance")
     end
+
+    def faceting
+      http_get("/indexes/#{@uid}/settings/faceting")
+    end
+    alias get_faceting faceting
+
+    def update_faceting(faceting_attributes)
+      attributes = Utils.transform_attributes(faceting_attributes)
+      http_patch("/indexes/#{@uid}/settings/faceting", attributes)
+    end
+    alias faceting= update_faceting
+
+    def reset_faceting
+      http_delete("/indexes/#{@uid}/settings/faceting")
+    end
   end
 end

spec/meilisearch/index/settings_spec.rb

@@ -776,4 +776,45 @@ def update_synonyms(index, synonyms)
       expect(index.typo_tolerance).to eq(default_typo_tolerance)
     end
   end
+
+  context 'On faceting' do
+    let(:index) { client.index(uid) }
+    let(:faceting) { { maxValuesPerFacet: 333 } }
+    let(:default_faceting) { { maxValuesPerFacet: 100 } }
+
+    before { client.create_index!(uid) }
+
+    it 'gets default values of faceting' do
+      settings = index.faceting.transform_keys(&:to_sym)
+
+      expect(settings).to eq(default_faceting)
+    end
+
+    it 'updates faceting' do
+      update_task = index.update_faceting(faceting)
+      client.wait_for_task(update_task['taskUid'])
+
+      expect(index.faceting.transform_keys(&:to_sym)).to eq(faceting)
+    end
+
+    it 'updates faceting at null' do
+      update_task = index.update_faceting(faceting)
+      client.wait_for_task(update_task['taskUid'])
+
+      update_task = index.update_faceting(nil)
+      client.wait_for_task(update_task['taskUid'])
+
+      expect(index.faceting.transform_keys(&:to_sym)).to eq(default_faceting)
+    end
+
+    it 'resets faceting' do
+      update_task = index.update_faceting(faceting)
+      client.wait_for_task(update_task['taskUid'])
+
+      reset_task = index.reset_faceting
+      client.wait_for_task(reset_task['taskUid'])
+
+      expect(index.faceting.transform_keys(&:to_sym)).to eq(default_faceting)
+    end
+  end
 end