Merge pull request #61 from mvar/update_to_array_structure

Include query type in query's toArray() response

src/Query/Span/SpanNotQuery.php

@@ -15,6 +15,10 @@ use ONGR\ElasticsearchDSL\ParametersTrait;
 
 /**
  * Elasticsearch Span not query.
+ *
+ * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-not-query.html
+ *
+ * @todo Add options support
  */
 class SpanNotQuery implements SpanQueryInterface
 {
@@ -56,10 +60,10 @@ class SpanNotQuery implements SpanQueryInterface
     public function toArray()
     {
         $query = [
-            'include' => [$this->include->getType() => $this->include->toArray()],
-            'exclude' => [$this->exclude->getType() => $this->exclude->toArray()],
+            'include' => $this->include->toArray(),
+            'exclude' => $this->exclude->toArray(),
         ];
 
-        return $query;
+        return [$this->getType() => $query];
     }
 }

src/Query/Span/SpanOrQuery.php

@@ -15,6 +15,8 @@ use ONGR\ElasticsearchDSL\ParametersTrait;
 
 /**
  * Elasticsearch span or query.
+ *
+ * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-or-query.html
  */
 class SpanOrQuery implements SpanQueryInterface
 {
@@ -70,10 +72,10 @@ class SpanOrQuery implements SpanQueryInterface
     {
         $query = [];
         foreach ($this->queries as $type) {
-            $query['clauses'][] = [$type->getType() => $type->toArray()];
+            $query['clauses'][] = $type->toArray();
         }
         $output = $this->processArray($query);
 
-        return $output;
+        return [$this->getType() => $output];
     }
 }

src/Query/Span/SpanTermQuery.php

@@ -15,6 +15,8 @@ use ONGR\ElasticsearchDSL\Query\TermQuery;
 
 /**
  * Elasticsearch span_term query class.
+ *
+ * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-term-query.html
  */
 class SpanTermQuery extends TermQuery implements SpanQueryInterface
 {

src/Query/TermQuery.php

@@ -70,6 +70,6 @@ class TermQuery implements BuilderInterface
             $this->field => $query,
         ];
 
-        return $output;
+        return [$this->getType() => $output];
     }
 }

src/Query/TermsQuery.php

@@ -66,6 +66,6 @@ class TermsQuery implements BuilderInterface
 
         $output = $this->processArray($query);
 
-        return $output;
+        return [$this->getType() => $output];
     }
 }

src/Query/TypeQuery.php

@@ -49,7 +49,9 @@ class TypeQuery implements BuilderInterface
     public function toArray()
     {
         return [
-            'value' => $this->type,
+            $this->getType() => [
+                'value' => $this->type,
+            ],
         ];
     }
 }

src/Query/WildcardQuery.php

@@ -64,6 +64,6 @@ class WildcardQuery implements BuilderInterface
             $this->field => $this->processArray($query),
         ];
 
-        return $output;
+        return [$this->getType() => $output];
     }
 }

src/SearchEndpoint/PostFilterEndpoint.php

@@ -32,9 +32,7 @@ class PostFilterEndpoint extends FilterEndpoint
             return null;
         }
 
-        $filter = $this->getBool();
-
-        return [$filter->getType() => $filter->toArray()];
+        return $this->getBool()->toArray();
     }
 
     /**

src/SearchEndpoint/QueryEndpoint.php

@@ -52,7 +52,7 @@ class QueryEndpoint extends AbstractSearchEndpoint implements OrderedNormalizerI
             return null;
         }
 
-        return [$this->bool->getType() => $this->bool->toArray()];
+        return $this->bool->toArray();
     }
 
     /**

src/Sort/FieldSort.php

@@ -92,9 +92,7 @@ class FieldSort implements BuilderInterface
             $fieldValues = array_merge(
                 $this->params,
                 [
-                    'nested_filter' => [
-                        $this->nestedFilter->getType() => $this->nestedFilter->toArray(),
-                    ],
+                    'nested_filter' => $this->nestedFilter->toArray(),
                 ]
             );
         } else {
@@ -105,6 +103,6 @@ class FieldSort implements BuilderInterface
             $this->field => empty($fieldValues) ? new \stdClass() : $fieldValues,
         ];
 
-        return $output;
+        return [$this->getType() => $output];
     }
 }

tests/Aggregation/FilterAggregationTest.php

@@ -36,9 +36,7 @@ class FilterAggregationTest extends \PHPUnit_Framework_TestCase
         $aggregation->setFilter($filter);
 
         $result = [
-            'filter' => [
-                $filter->getType() => $filter->toArray(),
-            ],
+            'filter' => $filter->toArray(),
         ];
 
         $out[] = [
@@ -54,9 +52,7 @@ class FilterAggregationTest extends \PHPUnit_Framework_TestCase
         $aggregation->addAggregation($histogramAgg);
 
         $result = [
-            'filter' => [
-                $filter->getType() => $filter->toArray(),
-            ],
+            'filter' => $filter->toArray(),
             'aggregations' => [
                 $histogramAgg->getName() => $histogramAgg->toArray(),
             ],
@@ -78,9 +74,7 @@ class FilterAggregationTest extends \PHPUnit_Framework_TestCase
         $aggregation->setFilter($boolFilter);
 
         $result = [
-            'filter' => [
-                $boolFilter->getType() => $boolFilter->toArray(),
-            ],
+            'filter' => $boolFilter->toArray(),
         ];
 
 
@@ -147,11 +141,9 @@ class FilterAggregationTest extends \PHPUnit_Framework_TestCase
     {
         $matchAllFilter = new MatchAllQuery();
         $aggregation = new FilterAggregation('test', $matchAllFilter);
-        $this->assertSame(
+        $this->assertEquals(
             [
-                'filter' => [
-                    $matchAllFilter->getType() => $matchAllFilter->toArray(),
-                ],
+                'filter' => $matchAllFilter->toArray(),
             ],
             $aggregation->toArray()
         );

tests/Query/BoolQueryTest.php

@@ -20,14 +20,6 @@ use ONGR\ElasticsearchDSL\Query\TermQuery;
  */
 class BoolQueryTest extends \PHPUnit_Framework_TestCase
 {
-    /**
-     * Tests isRelevant method.
-     */
-    public function testIsRelevant()
-    {
-        $bool = new BoolQuery();
-        $this->assertTrue($bool->isRelevant());
-    }
     /**
      * Test for addToBool() without setting a correct bool operator.
      *
@@ -50,24 +42,26 @@ class BoolQueryTest extends \PHPUnit_Framework_TestCase
         $bool->add(new TermQuery('key2', 'value2'), BoolQuery::MUST);
         $bool->add(new TermQuery('key3', 'value3'), BoolQuery::MUST_NOT);
         $expected = [
-            'should' => [
-                [
-                    'term' => [
-                        'key1' => 'value1',
+            'bool' => [
+                'should' => [
+                    [
+                        'term' => [
+                            'key1' => 'value1',
+                        ],
                     ],
                 ],
-            ],
-            'must' => [
-                [
-                    'term' => [
-                        'key2' => 'value2',
+                'must' => [
+                    [
+                        'term' => [
+                            'key2' => 'value2',
+                        ],
                     ],
                 ],
-            ],
-            'must_not' => [
-                [
-                    'term' => [
-                        'key3' => 'value3',
+                'must_not' => [
+                    [
+                        'term' => [
+                            'key3' => 'value3',
+                        ],
                     ],
                 ],
             ],
@@ -75,16 +69,6 @@ class BoolQueryTest extends \PHPUnit_Framework_TestCase
         $this->assertEquals($expected, $bool->toArray());
     }
 
-    /**
-     * Test getType method.
-     */
-    public function testBoolGetType()
-    {
-        $bool = new BoolQuery();
-        $result = $bool->getType();
-        $this->assertEquals('bool', $result);
-    }
-
     /**
      * Tests bool query in filter context.
      */
@@ -94,21 +78,38 @@ class BoolQueryTest extends \PHPUnit_Framework_TestCase
         $bool->add(new TermQuery('key1', 'value1'), BoolQuery::FILTER);
         $bool->add(new TermQuery('key2', 'value2'), BoolQuery::MUST);
         $expected = [
-            'filter' => [
-                [
-                    'term' => [
-                        'key1' => 'value1',
+            'bool' => [
+                'filter' => [
+                    [
+                        'term' => [
+                            'key1' => 'value1',
+                        ],
                     ],
                 ],
-            ],
-            'must' => [
-                [
-                    'term' => [
-                        'key2' => 'value2',
+                'must' => [
+                    [
+                        'term' => [
+                            'key2' => 'value2',
+                        ],
                     ],
                 ],
             ],
         ];
         $this->assertEquals($expected, $bool->toArray());
     }
+
+    /**
+     * Test if simplified structure is returned in case single MUST query given.
+     */
+    public function testSingleMust()
+    {
+        $bool = new BoolQuery();
+        $bool->add(new TermQuery('key2', 'value2'), BoolQuery::MUST);
+        $expected = [
+            'term' => [
+                'key2' => 'value2',
+            ],
+        ];
+        $this->assertEquals($expected, $bool->toArray());
+    }
 }

tests/Query/ExistsQueryTest.php

@@ -19,11 +19,11 @@ use ONGR\ElasticsearchDSL\Query\ExistsQuery;
 class ExistsQueryTest extends \PHPUnit_Framework_TestCase
 {
     /**
-     * Tests ExistsQuery#toArray() method.
+     * Tests toArray() method.
      */
     public function testToArray()
     {
         $query = new ExistsQuery('bar');
-        $this->assertEquals(['field' => 'bar'], $query->toArray());
+        $this->assertEquals(['exists' => ['field' => 'bar']], $query->toArray());
     }
 }

tests/Query/FunctionScoreQueryTest.php

@@ -33,7 +33,7 @@ class FunctionScoreQueryTest extends \PHPUnit_Framework_TestCase
             [
                 'seed' => null,
                 'expectedArray' => [
-                    'query' => [ null => null ],
+                    'query' => null,
                     'functions' => [
                         [
                             'random_score' => new \stdClass(),
@@ -45,7 +45,7 @@ class FunctionScoreQueryTest extends \PHPUnit_Framework_TestCase
             [
                 'seed' => 'someSeed',
                 'expectedArray' => [
-                    'query' => [ null => null ],
+                    'query' => null,
                     'functions' => [
                         [
                             'random_score' => [ 'seed' => 'someSeed'],
@@ -72,7 +72,7 @@ class FunctionScoreQueryTest extends \PHPUnit_Framework_TestCase
         $functionScoreQuery = new FunctionScoreQuery($matchAllQuery);
         $functionScoreQuery->addRandomFunction($seed);
 
-        $this->assertEquals($expectedArray, $functionScoreQuery->toArray());
+        $this->assertEquals(['function_score' => $expectedArray], $functionScoreQuery->toArray());
     }
     
     /**
@@ -86,9 +86,9 @@ class FunctionScoreQueryTest extends \PHPUnit_Framework_TestCase
         $functionScoreQuery->addFieldValueFactorFunction('field1', 2);
         $functionScoreQuery->addFieldValueFactorFunction('field2', 1.5, 'ln');
 
-        $this->assertSame(
+        $this->assertEquals(
             [
-                'query' => [null => null],
+                'query' => null,
                 'functions' => [
                     [
                         'field_value_factor' => [
@@ -106,7 +106,7 @@ class FunctionScoreQueryTest extends \PHPUnit_Framework_TestCase
                     ],
                 ],
             ],
-            $functionScoreQuery->toArray()
+            $functionScoreQuery->toArray()['function_score']
         );
     }
 }

tests/Query/FuzzyLikeThisQueryTest.php

-<?php
-
-/*
- * This file is part of the ONGR package.
- *
- * (c) NFQ Technologies UAB <info@nfq.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-namespace ONGR\ElasticsearchDSL\Tests\Query;
-
-use ONGR\ElasticsearchDSL\Query\FuzzyLikeThisQuery;
-
-/**
- * Class FuzzyLikeThisQueryTest.
- */
-class FuzzyLikeThisQueryTest extends \PHPUnit_Framework_TestCase
-{
-    /**
-     * Tests if toArray returns data in correct format with right data from constructor.
-     */
-    public function testQuery()
-    {
-        $fuzzyLikeThisQuery = new FuzzyLikeThisQuery(
-            ['name.first', 'name.last'],
-            'text like this one',
-            [ 'max_query_terms' => 12 ]
-        );
-
-        $this->assertSame(
-            [
-                'fields' => ['name.first', 'name.last'],
-                'like_text' => 'text like this one',
-                'max_query_terms' => 12,
-            ],
-            $fuzzyLikeThisQuery->toArray()
-        );
-    }
-
-    /**
-     * Tests if correct type is returned.
-     */
-    public function testGetType()
-    {
-        /** @var FuzzyLikeThisQuery $fuzzyLikeThisQuery */
-        $fuzzyLikeThisQuery = $this->getMockBuilder('ONGR\ElasticsearchDSL\Query\FuzzyLikeThisQuery')
-            ->disableOriginalConstructor()
-            ->setMethods(null)
-            ->getMock();
-
-        $this->assertEquals('fuzzy_like_this', $fuzzyLikeThisQuery->getType());
-    }
-
-    /**
-     * Tests if query accepts single field as string.
-     */
-    public function testSingleField()
-    {
-        $fuzzyLikeThisQuery = new FuzzyLikeThisQuery(
-            'name.first',
-            'text like this one',
-            [ 'max_query_terms' => 12 ]
-        );
-
-        $this->assertSame(
-            [
-                'fields' => ['name.first'],
-                'like_text' => 'text like this one',
-                'max_query_terms' => 12,
-            ],
-            $fuzzyLikeThisQuery->toArray()
-        );
-    }
-}

tests/Query/GeoBoundingBoxQueryTest.php

@@ -82,6 +82,6 @@ class GeoBoundingBoxQueryTest extends \PHPUnit_Framework_TestCase
     {
         $query = new GeoBoundingBoxQuery($field, $values, $parameters);
         $result = $query->toArray();
-        $this->assertEquals($expected, $result);
+        $this->assertEquals(['geo_bounding_box' => $expected], $result);
     }
 }

tests/Query/GeoDistanceQueryTest.php

@@ -57,6 +57,6 @@ class GeoDistanceQueryTest extends \PHPUnit_Framework_TestCase
     {
         $query = new GeoDistanceQuery($field, $distance, $location, $parameters);
         $result = $query->toArray();
-        $this->assertEquals($expected, $result);
+        $this->assertEquals(['geo_distance' => $expected], $result);
     }
 }

tests/Query/GeoDistanceRangeQueryTest.php

@@ -57,6 +57,6 @@ class GeoDistanceRangeQueryTest extends \PHPUnit_Framework_TestCase
     {
         $query = new GeoDistanceRangeQuery($field, $range, $location, $parameters);
         $result = $query->toArray();
-        $this->assertEquals($expected, $result);
+        $this->assertEquals(['geo_distance_range' => $expected], $result);
     }
 }

tests/Query/GeoPolygonQueryTest.php

@@ -83,6 +83,6 @@ class GeoPolygonQueryTest extends \PHPUnit_Framework_TestCase
     {
         $filter = new GeoPolygonQuery($field, $points, $parameters);
         $result = $filter->toArray();
-        $this->assertEquals($expected, $result);
+        $this->assertEquals(['geo_polygon' => $expected], $result);
     }
 }

tests/Query/GeoShapeQueryTest.php

@@ -24,13 +24,15 @@ class GeoShapeQueryTest extends \PHPUnit_Framework_TestCase
         $filter->addShape('location', 'envelope', [[13, 53], [14, 52]]);
 
         $expected = [
-            'location' => [
-                'shape' => [
-                    'type' => 'envelope',
-                    'coordinates' => [[13, 53], [14, 52]],
+            'geo_shape' => [
+                'location' => [
+                    'shape' => [
+                        'type' => 'envelope',
+                        'coordinates' => [[13, 53], [14, 52]],
+                    ],
                 ],
+                'param1' => 'value1',
             ],
-            'param1' => 'value1',
         ];
 
         $this->assertEquals($expected, $filter->toArray());
@@ -45,15 +47,17 @@ class GeoShapeQueryTest extends \PHPUnit_Framework_TestCase
         $filter->addPreIndexedShape('location', 'DEU', 'countries', 'shapes', 'location');
 
         $expected = [
-            'location' => [
-                'indexed_shape' => [
-                    'id' => 'DEU',
-                    'type' => 'countries',
-                    'index' => 'shapes',
-                    'path' => 'location',
+            'geo_shape' => [
+                'location' => [
+                    'indexed_shape' => [
+                        'id' => 'DEU',
+                        'type' => 'countries',
+                        'index' => 'shapes',
+                        'path' => 'location',
+                    ],
                 ],
+                'param1' => 'value1',
             ],
-            'param1' => 'value1',
         ];
 
         $this->assertEquals($expected, $filter->toArray());