Added collapsing by field

Author: babenkoivan

README.md

@@ -195,6 +195,8 @@ App\MyModel::search('phone')
     ->where('color', 'red')
     // sort
     ->orderBy('price', 'asc')
+    // collapse by field
+    ->collapse('brand')
     // set offset
     ->from(0)
     // set limit

src/Builders/FilterBuilder.php

@@ -15,6 +15,11 @@ class FilterBuilder extends Builder
 
     public $offset;
 
+    /**
+     * @var string
+     */
+    public $collapse;
+
     public function __construct($model, $callback = null)
     {
         $this->model = $model;
@@ -235,4 +240,15 @@ public function paginate($perPage = null, $pageName = 'page', $page = null)
 
         return $paginator;
     }
+
+    /**
+     * @param string $field
+     * @return $this
+     */
+    public function collapse(string $field)
+    {
+        $this->collapse = $field;
+
+        return $this;
+    }
 }

src/ElasticEngine.php

@@ -76,17 +76,12 @@ protected function buildSearchQueryPayload(Builder $builder, $queryPayload, arra
 
         $payload = (new TypePayload($builder->model))
             ->setIfNotEmpty('body.query.bool', $queryPayload)
+            ->setIfNotEmpty('body.collapse.field', $builder->collapse)
             ->setIfNotEmpty('body.sort', $builder->orders)
             ->setIfNotEmpty('body.explain', $options['explain'] ?? null)
-            ->setIfNotEmpty('body.profile', $options['profile'] ?? null);
-
-        if (isset($builder->offset)) {
-            $payload->set('body.from', $builder->offset);
-        }
-
-        if (isset($builder->limit)) {
-            $payload->set('body.size', $builder->limit);
-        }
+            ->setIfNotEmpty('body.profile', $options['profile'] ?? null)
+            ->setIfNotNull('body.from', $builder->offset)
+            ->setIfNotNull('body.size', $builder->limit);
 
         return $payload->get();
     }

src/Payloads/RawPayload.php

@@ -24,6 +24,20 @@ public function setIfNotEmpty($key, $value)
         return $this->set($key, $value);
     }
 
+    /**
+     * @param string $key
+     * @param mixed $value
+     * @return $this
+     */
+    public function setIfNotNull(string $key, $value)
+    {
+        if (is_null($value)) {
+            return $this;
+        }
+
+        return $this->set($key, $value);
+    }
+
     public function has($key)
     {
         return array_has($this->payload, $key);

tests/Builders/FilterBuilderTest.php

@@ -316,12 +316,12 @@ public function testWhereGeoPolygon()
     {
         $this
             ->builder
-            ->whereGeoPolygon('foo', [[-70, 40],[-80, 30],[-90, 20]]);
+            ->whereGeoPolygon('foo', [[-70, 40], [-80, 30], [-90, 20]]);
 
         $this->assertEquals(
             [
                 'must' => [
-                    ['geo_polygon' => ['foo' => ['points' => [[-70, 40],[-80, 30],[-90, 20]]]]]
+                    ['geo_polygon' => ['foo' => ['points' => [[-70, 40], [-80, 30], [-90, 20]]]]]
                 ],
                 'must_not' => []
             ],
@@ -373,4 +373,16 @@ public function testFrom()
             $this->builder->offset
         );
     }
+
+    public function testCollapse()
+    {
+        $this
+            ->builder
+            ->collapse('foo');
+
+        $this->assertEquals(
+            'foo',
+            $this->builder->collapse
+        );
+    }
 }

tests/ElasticEngineTest.php

@@ -35,7 +35,7 @@ public function testBuildSearchQueryPayloadCollection()
 
         $searchBuilder = (new SearchBuilder($model, 'foo'))
             ->rule(SearchRule::class)
-            ->rule(function(SearchBuilder $searchBuilder) {
+            ->rule(function (SearchBuilder $searchBuilder) {
                 return [
                     'must' => [
                         'match' => [
@@ -46,6 +46,7 @@ public function testBuildSearchQueryPayloadCollection()
             })
             ->where('id', '>', 20)
             ->orderBy('id', 'asc')
+            ->collapse('brand')
             ->take(10)
             ->from(100);
 
@@ -81,6 +82,9 @@ public function testBuildSearchQueryPayloadCollection()
                                 ]
                             ]
                         ],
+                        'collapse' => [
+                            'field' => 'brand'
+                        ],
                         'sort' => [
                             [
                                 'id' => 'asc'
@@ -116,6 +120,9 @@ public function testBuildSearchQueryPayloadCollection()
                                 ]
                             ]
                         ],
+                        'collapse' => [
+                            'field' => 'brand'
+                        ],
                         'sort' => [
                             [
                                 'id' => 'asc'

tests/Payloads/RawPayloadTest.php

@@ -34,6 +34,28 @@ public function testSetIfNotEmpty()
         );
     }
 
+    public function testSetIfNotNull()
+    {
+        $payload = (new RawPayload())
+            ->setIfNotNull('null', null)
+            ->setIfNotNull('false', false)
+            ->setIfNotNull('zero', 0)
+            ->setIfNotNull('empty_array', [])
+            ->setIfNotNull('empty_string', '')
+            ->setIfNotNull('foo', 'bar');
+
+        $this->assertEquals(
+            [
+                'false' => false,
+                'zero' => 0,
+                'empty_array' => [],
+                'empty_string' => '',
+                'foo' => 'bar'
+            ],
+            $payload->get()
+        );
+    }
+
     public function testHas()
     {
         $payload = (new RawPayload())