Merge #551

551: Add code samples and tests for distinct search parameter r=curquiza a=andre-m-dev

# Pull Request

## Related issue
Fixes #547

## What does this PR do?
- Distinct search parameter added

## PR checklist
Please check if your PR fulfills the following requirements:
- [x] Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
- [x] Have you read the contributing guidelines?
- [x] Have you made sure that the title is accurate and descriptive of the changes?


Co-authored-by: Andre <>

Author: meili-bors[bot]

.code-samples.meilisearch.yaml

@@ -653,3 +653,17 @@ update_search_cutoff_1: |-
   client.index('movies').update_search_cutoff_ms(150)
 reset_search_cutoff_1: |-
   client.index('movies').reset_search_cutoff_ms
+search_parameter_reference_distinct_1: |-
+  client.index('INDEX_NAME').search('QUERY TERMS', {
+    distinct: 'ATTRIBUTE_A'
+  })
+distinct_attribute_guide_filterable_1: |-
+  client.index('products').update_filterable_attributes([
+    'product_id',
+    'sku',
+    'url'
+  ])
+distinct_attribute_guide_distinct_parameter_1: |-
+  client.index('products').search('white shirt', {
+    distinct: 'sku'
+  })

spec/meilisearch/index/search/attributes_to_highlight_spec.rb

@@ -7,7 +7,7 @@
     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)
+    expect(response['hits'].count).to eq(4)
     expect(response['hits'].first).to have_key('_formatted')
     expect(response['hits'].first['_formatted']['title']).to eq('<em>The</em> Hobbit')
   end
@@ -16,7 +16,7 @@
     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'].count).to eq(8)
     expect(response['hits'].first).to have_key('_formatted')
   end
 

spec/meilisearch/index/search/attributes_to_retrieve_spec.rb

@@ -7,7 +7,7 @@
     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)
+    expect(response['hits'].count).to eq(4)
     expect(response['hits'].first).to have_key('title')
     expect(response['hits'].first).not_to have_key('objectId')
     expect(response['hits'].first).not_to have_key('genre')
@@ -17,7 +17,7 @@
     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)
+    expect(response['hits'].count).to eq(4)
     expect(response['hits'].first).to have_key('title')
     expect(response['hits'].first).not_to have_key('objectId')
     expect(response['hits'].first).to have_key('genre')
@@ -27,7 +27,7 @@
     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)
+    expect(response['hits'].count).to eq(4)
     expect(response['hits'].first).to have_key('objectId')
     expect(response['hits'].first).to have_key('title')
     expect(response['hits'].first).to have_key('genre')

spec/meilisearch/index/search/distinct_spec.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+RSpec.describe 'MeiliSearch::Index - Distinct search' do
+  include_context 'search books with genre'
+
+  before do
+    index.update_filterable_attributes(['genre']).await
+  end
+
+  it 'does a search without distinct' do
+    response = index.search('harry potter')
+    expect(response['hits'].count).to eq(2)
+  end
+
+  it 'does a custom search with distinct' do
+    response = index.search('harry potter', { distinct: 'genre' })
+    expect(response['hits'].count).to eq(1)
+  end
+end

spec/meilisearch/index/search/q_spec.rb

@@ -64,7 +64,7 @@
     response = index.search('coco "harry"')
     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'].count).to eq(2)
     expect(response['hits'].first['objectId']).to eq(4)
     expect(response['hits'].first).not_to have_key('_formatted')
   end

spec/support/books_contexts.rb

@@ -4,12 +4,13 @@
   let(:index) { client.index('books') }
   let(:documents) do
     [
-      { objectId: 123,  title: 'Pride and Prejudice',                    genre: 'romance' },
-      { objectId: 456,  title: 'Le Petit Prince',                        genre: 'adventure' },
-      { objectId: 1,    title: 'Alice In Wonderland',                    genre: 'adventure' },
-      { objectId: 2,    title: 'Le Rouge et le Noir',                    genre: 'romance' },
-      { objectId: 1344, title: 'The Hobbit',                             genre: 'adventure' },
-      { objectId: 4,    title: 'Harry Potter and the Half-Blood Prince', genre: 'fantasy' },
+      { objectId: 123,  title: 'Pride and Prejudice',                     genre: 'romance' },
+      { objectId: 456,  title: 'Le Petit Prince',                         genre: 'adventure' },
+      { objectId: 1,    title: 'Alice In Wonderland',                     genre: 'adventure' },
+      { objectId: 2,    title: 'Le Rouge et le Noir',                     genre: 'romance' },
+      { objectId: 1344, title: 'The Hobbit',                              genre: 'adventure' },
+      { objectId: 4,    title: 'Harry Potter and the Half-Blood Prince',  genre: 'fantasy' },
+      { objectId: 7,    title: 'Harry Potter and the Chamber of Secrets', genre: 'fantasy' },
       { objectId: 42,   title: 'The Hitchhiker\'s Guide to the Galaxy' }
     ]
   end