Merge pull request #28 from Ilyes512/add-missing-factories

erichard · web-flow · commit 773e4cfa1edd · 2024-06-14T13:20:41.000+02:00
Add missing factories
diff --git a/.php_cs.dist.php b/.php_cs.dist.php
@@ -1,5 +1,7 @@
 <?php declare(strict_types=1);
 
+use PhpCsFixer\Fixer\FunctionNotation\NullableTypeDeclarationForDefaultNullValueFixer;
+
 $finder = PhpCsFixer\Finder::create()
     ->in(__DIR__ . '/src')
     ->exclude(__DIR__ . '/tests')
@@ -26,6 +28,7 @@
         'concat_space' => false,
         'declare_strict_types' => true,
         'native_function_invocation' => ['include' => []],
+        'nullable_type_declaration_for_default_null_value' => ['use_nullable_type_declaration' => true],
         PhpCsFixerCustomFixers\Fixer\DeclareAfterOpeningTagFixer::name() => true,
         PhpCsFixerCustomFixers\Fixer\NoDoctrineMigrationsGeneratedCommentFixer::name() => true,
         PhpCsFixerCustomFixers\Fixer\NoImportFromGlobalNamespaceFixer::name() => true,
diff --git a/src/Aggregation/Aggregation.php b/src/Aggregation/Aggregation.php
@@ -107,4 +107,27 @@ public static function topHits(string $name, array $aggregations = []): TopHitsA
     {
         return new TopHitsAggregation($name, $aggregations);
     }
+
+    public static function histogram(string $name, string $field, int $interval): HistogramAggregation
+    {
+        return new HistogramAggregation($name, $field, $interval);
+    }
+
+    /**
+     * @param array<int> $ranges pass desired ranges that will be converted to linear range
+     */
+    public static function ranges(string $name, string $field, array $ranges): RangesAggregation
+    {
+        return new RangesAggregation($name, $field, $ranges);
+    }
+
+    public static function widthHistogram(string $name, string $field, int $buckets): WidthHistogramAggregation
+    {
+        return new WidthHistogramAggregation($name, $field, $buckets);
+    }
+
+    public static function stats(string $name): StatsAggregation
+    {
+        return new StatsAggregation($name);
+    }
 }
diff --git a/src/Aggregation/RangesAggregation.php b/src/Aggregation/RangesAggregation.php
@@ -14,7 +14,7 @@ class RangesAggregation extends AbstractAggregation
      * @param array<int>                 $ranges                  pass desired ranges that will be converted to
      *                                                            linear range
      * @param array<AbstractAggregation> $aggregations
-     * @param bool                       $equalConditionOnToRange Se to true if you want to do a histogram with 0
+     * @param bool                       $equalConditionOnToRange Set to true if you want to do a histogram with 0
      *                                                            - 10, 10 - 15, and correctly count the number
      *                                                            (entry with 10 will be in first and seconds
      *                                                            segment
diff --git a/src/Query/Query.php b/src/Query/Query.php
@@ -49,9 +49,9 @@ public static function range(
         return new RangeQuery($field, $lt, $gt, $lte, $gte);
     }
 
-    public static function nested(string $field, QueryInterface $query): NestedQuery
+    public static function nested(?string $path, QueryInterface $query): NestedQuery
     {
-        return new NestedQuery($field, $query);
+        return new NestedQuery($path, $query);
     }
 
     public static function match(string $field, string $query): MatchQuery
@@ -84,6 +84,11 @@ public static function functionsQuery(string $field): FunctionsQuery
         return new FunctionsQuery($field);
     }
 
+    public static function GeoBoundingBoxQuery(string $field): GeoBoundingBoxQuery
+    {
+        return new GeoBoundingBoxQuery($field);
+    }
+
     /**
      * @param float[]|int[] $position
      */
@@ -105,7 +110,7 @@ public static function prefix(string $field, string $value): PrefixQuery
         return new PrefixQuery($field, $value);
     }
 
-    public static function queryString(string $query, string $defaultField = null): QueryStringQuery
+    public static function queryString(string $query, ?string $defaultField = null): QueryStringQuery
     {
         return new QueryStringQuery($query, $defaultField);
     }
@@ -114,4 +119,17 @@ public static function rankFeature(string $field): RankFeatureQuery
     {
         return new RankFeatureQuery($field);
     }
+
+    public static function exists(string $field): ExistsQuery
+    {
+        return new ExistsQuery($field);
+    }
+
+    /**
+     * @param mixed[]|string[] $fields
+     */
+    public static function simpleQueryString(array $fields, string $query): SimpleQueryStringQuery
+    {
+        return new SimpleQueryStringQuery($fields, $query);
+    }
 }
diff --git a/src/Query/SimpleQueryStringQuery.php b/src/Query/SimpleQueryStringQuery.php
@@ -3,10 +3,12 @@
 namespace Erichard\ElasticQueryBuilder\Query;
 
 use Erichard\ElasticQueryBuilder\Contracts\QueryInterface;
+use Erichard\ElasticQueryBuilder\Features\HasBoost;
 use Erichard\ElasticQueryBuilder\Features\HasMinimumShouldMatch;
 
 class SimpleQueryStringQuery implements QueryInterface
 {
+    use HasBoost;
     use HasMinimumShouldMatch;
 
     /**
@@ -15,7 +17,6 @@ class SimpleQueryStringQuery implements QueryInterface
     public function __construct(
         protected array $fields,
         protected string $query,
-
         private ?string $flags = null,
         private ?bool $fuzzyTranspositions = null,
         private ?int $fuzzyMaxExpansions = null,
@@ -27,7 +28,6 @@ public function __construct(
         private ?string $quoteFieldSuffix = null,
         private ?bool $analyzeWildCard = null,
         private ?bool $autoGenerateSynonymsPhraseQuery = null,
-
         protected array $params = [],
     ) {
         $this->minimumShouldMatch = $minimumShouldMatch;
@@ -36,69 +36,70 @@ public function __construct(
     public function setFlags(string|null $flags): self
     {
         $this->flags = $flags;
+
         return $this;
     }
 
-
     public function setFuzzyTranspositions(bool|null $fuzzyTranspositions): self
     {
         $this->fuzzyTranspositions = $fuzzyTranspositions;
+
         return $this;
     }
 
-
     public function setFuzzyMaxExpansions(int|null $fuzzyMaxExpansions): self
     {
         $this->fuzzyMaxExpansions = $fuzzyMaxExpansions;
+
         return $this;
     }
 
-
     public function setFuzzyPrefixLength(int|null $fuzzyPrefixLength): self
     {
         $this->fuzzyPrefixLength = $fuzzyPrefixLength;
+
         return $this;
     }
 
-
     public function setDefaultOperator(string|null $defaultOperator): self
     {
         $this->defaultOperator = $defaultOperator;
+
         return $this;
     }
 
-
     public function setAnalyzer(string|null $analyzer): self
     {
         $this->analyzer = $analyzer;
+
         return $this;
     }
 
-
     public function setLenient(bool|null $lenient): self
     {
         $this->lenient = $lenient;
+
         return $this;
     }
 
-
     public function setQuoteFieldSuffix(string|null $quoteFieldSuffix): self
     {
         $this->quoteFieldSuffix = $quoteFieldSuffix;
+
         return $this;
     }
 
-
     public function setAnalyzeWildCard(bool|null $analyzeWildCard): self
     {
         $this->analyzeWildCard = $analyzeWildCard;
+
         return $this;
     }
 
-
     public function setAutoGenerateSynonymsPhraseQuery(bool|null $autoGenerateSynonymsPhraseQuery): self
     {
         $this->autoGenerateSynonymsPhraseQuery = $autoGenerateSynonymsPhraseQuery;
+
         return $this;
     }
 
@@ -168,6 +169,7 @@ public function build(): array
         }
 
         $this->buildMinimumShouldMatchTo($data);
+        $this->buildBoostTo($data);
 
         $build = $this->params;
         $build['simple_query_string'] = $data;
diff --git a/tests/Query/GeoBoundingBoxQueryTest.php b/tests/Query/GeoBoundingBoxQueryTest.php
@@ -12,13 +12,13 @@ class GeoBoundingBoxQueryTest extends TestCase
 {
     public function testBuildFailsOnAllNull(): void
     {
-        $this->expectErrorMessage('GeoBoundingBoxQuery needs at least 2 sides set');
+        $this->expectExceptionMessage('GeoBoundingBoxQuery needs at least 2 sides set');
         (new GeoBoundingBoxQuery('test'))->build();
     }
 
     public function testBuildFailsOnOneFilter(): void
     {
-        $this->expectErrorMessage('GeoBoundingBoxQuery needs at least 2 sides set');
+        $this->expectExceptionMessage('GeoBoundingBoxQuery needs at least 2 sides set');
         (new GeoBoundingBoxQuery(field: 'test', topLeft: new GpsPointEntity(1.1, 2.1)))->build();
     }
 
diff --git a/tests/Query/SimpleQueryStringQueryTest.php b/tests/Query/SimpleQueryStringQueryTest.php
@@ -4,7 +4,6 @@
 
 namespace Tests\Erichard\ElasticQueryBuilder\Query;
 
-use Erichard\ElasticQueryBuilder\Query\MultiMatchQuery;
 use Erichard\ElasticQueryBuilder\Query\SimpleQueryStringQuery;
 use PHPUnit\Framework\TestCase;
 
@@ -94,4 +93,49 @@ public function testItBuildTheQueryWithAFuzziness(): void
                 ],
         ], $query->build());
     }
+
+    public function testItBuildTheQueryWithBoost(): void
+    {
+        $query = new SimpleQueryStringQuery(
+            ['subject', 'body'],
+            '~brown fox',
+            'ALL',
+            true,
+            50,
+            0,
+            "1%",
+            "or",
+            "standard",
+            false,
+            "",
+            false,
+            true
+
+        );
+        $query->setBoost(3);
+
+        $this->assertEquals([
+                'simple_query_string' =>
+                    [
+                        'query' => '~brown fox',
+                        'fields' =>
+                            [
+                                'subject',
+                                'body',
+                            ],
+                        'flags' => 'ALL',
+                        'fuzzy_transpositions' => true,
+                        'fuzzy_max_expansions' => 50,
+                        'fuzzy_prefix_length' => 0,
+                        'default_operator' => 'or',
+                        'analyzer' => 'standard',
+                        'lenient' => false,
+                        'quote_field_suffix' => '',
+                        'analyze_wildcard' => false,
+                        'auto_generate_synonyms_phrase_query' => true,
+                        'minimum_should_match' => '1%',
+                        'boost' => 3,
+                    ],
+        ], $query->build()); 
+    }
 }
diff --git a/tests/QueryBuilderTest.php b/tests/QueryBuilderTest.php
@@ -72,7 +72,7 @@ public function testItSetThePitAsString(): void
 
         $query = $queryBuilder->build();
 
-        $this->assertEquals(['id' => 'pit-as-string'], $query['pit']);
+        $this->assertEquals(['id' => 'pit-as-string'], $query['body']['pit']);
     }
 
     public function testItSetThePitAsArray(): void
@@ -83,7 +83,7 @@ public function testItSetThePitAsArray(): void
 
         $query = $queryBuilder->build();
 
-        $this->assertEquals(['id' => 'pit-as-array', 'keep_alive' => '1m'], $query['pit']);
+        $this->assertEquals(['id' => 'pit-as-array', 'keep_alive' => '1m'], $query['body']['pit']);
     }
 
     public function testItAllowToSort(): void

Original file line number	Diff line number	Diff line change
`@@ -49,9 +49,9 @@ public static function range(`
`49`	`49`	`return new RangeQuery($field, $lt, $gt, $lte, $gte);`
`50`	`50`	`}`
`51`	`51`
`52`		`- public static function nested(string $field, QueryInterface $query): NestedQuery`
	`52`	`+ public static function nested(?string $path, QueryInterface $query): NestedQuery`
`53`	`53`	`{`
`54`		`- return new NestedQuery($field, $query);`
	`54`	`+ return new NestedQuery($path, $query);`
`55`	`55`	`}`
`56`	`56`
`57`	`57`	`public static function match(string $field, string $query): MatchQuery`
`@@ -84,6 +84,11 @@ public static function functionsQuery(string $field): FunctionsQuery`
`84`	`84`	`return new FunctionsQuery($field);`
`85`	`85`	`}`
`86`	`86`
	`87`	`+ public static function GeoBoundingBoxQuery(string $field): GeoBoundingBoxQuery`
	`88`	`+ {`
	`89`	`+ return new GeoBoundingBoxQuery($field);`
	`90`	`+ }`
	`91`	`+`
`87`	`92`	`/**`
`88`	`93`	`* @param float[]\|int[] $position`
`89`	`94`	`*/`
`@@ -105,7 +110,7 @@ public static function prefix(string $field, string $value): PrefixQuery`
`105`	`110`	`return new PrefixQuery($field, $value);`
`106`	`111`	`}`
`107`	`112`
`108`		`- public static function queryString(string $query, string $defaultField = null): QueryStringQuery`
	`113`	`+ public static function queryString(string $query, ?string $defaultField = null): QueryStringQuery`
`109`	`114`	`{`
`110`	`115`	`return new QueryStringQuery($query, $defaultField);`
`111`	`116`	`}`
`@@ -114,4 +119,17 @@ public static function rankFeature(string $field): RankFeatureQuery`
`114`	`119`	`{`
`115`	`120`	`return new RankFeatureQuery($field);`
`116`	`121`	`}`
	`122`	`+`
	`123`	`+ public static function exists(string $field): ExistsQuery`
	`124`	`+ {`
	`125`	`+ return new ExistsQuery($field);`
	`126`	`+ }`
	`127`	`+`
	`128`	`+ /**`
	`129`	`+ * @param mixed[]\|string[] $fields`
	`130`	`+ */`
	`131`	`+ public static function simpleQueryString(array $fields, string $query): SimpleQueryStringQuery`
	`132`	`+ {`
	`133`	`+ return new SimpleQueryStringQuery($fields, $query);`
	`134`	`+ }`
`117`	`135`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,10 +3,12 @@`
`3`	`3`	`namespace Erichard\ElasticQueryBuilder\Query;`
`4`	`4`
`5`	`5`	`use Erichard\ElasticQueryBuilder\Contracts\QueryInterface;`
	`6`	`+use Erichard\ElasticQueryBuilder\Features\HasBoost;`
`6`	`7`	`use Erichard\ElasticQueryBuilder\Features\HasMinimumShouldMatch;`
`7`	`8`
`8`	`9`	`class SimpleQueryStringQuery implements QueryInterface`
`9`	`10`	`{`
	`11`	`+ use HasBoost;`
`10`	`12`	`use HasMinimumShouldMatch;`
`11`	`13`
`12`	`14`	`/**`
`@@ -15,7 +17,6 @@ class SimpleQueryStringQuery implements QueryInterface`
`15`	`17`	`public function __construct(`
`16`	`18`	`protected array $fields,`
`17`	`19`	`protected string $query,`
`18`		`-`
`19`	`20`	`private ?string $flags = null,`
`20`	`21`	`private ?bool $fuzzyTranspositions = null,`
`21`	`22`	`private ?int $fuzzyMaxExpansions = null,`
`@@ -27,7 +28,6 @@ public function __construct(`
`27`	`28`	`private ?string $quoteFieldSuffix = null,`
`28`	`29`	`private ?bool $analyzeWildCard = null,`
`29`	`30`	`private ?bool $autoGenerateSynonymsPhraseQuery = null,`
`30`		`-`
`31`	`31`	`protected array $params = [],`
`32`	`32`	`) {`
`33`	`33`	`$this->minimumShouldMatch = $minimumShouldMatch;`
`@@ -36,69 +36,70 @@ public function __construct(`
`36`	`36`	`public function setFlags(string\|null $flags): self`
`37`	`37`	`{`
`38`	`38`	`$this->flags = $flags;`
	`39`	`+`
`39`	`40`	`return $this;`
`40`	`41`	`}`
`41`	`42`
`42`		`-`
`43`	`43`	`public function setFuzzyTranspositions(bool\|null $fuzzyTranspositions): self`
`44`	`44`	`{`
`45`	`45`	`$this->fuzzyTranspositions = $fuzzyTranspositions;`
	`46`	`+`
`46`	`47`	`return $this;`
`47`	`48`	`}`
`48`	`49`
`49`		`-`
`50`	`50`	`public function setFuzzyMaxExpansions(int\|null $fuzzyMaxExpansions): self`
`51`	`51`	`{`
`52`	`52`	`$this->fuzzyMaxExpansions = $fuzzyMaxExpansions;`
	`53`	`+`
`53`	`54`	`return $this;`
`54`	`55`	`}`
`55`	`56`
`56`		`-`
`57`	`57`	`public function setFuzzyPrefixLength(int\|null $fuzzyPrefixLength): self`
`58`	`58`	`{`
`59`	`59`	`$this->fuzzyPrefixLength = $fuzzyPrefixLength;`
	`60`	`+`
`60`	`61`	`return $this;`
`61`	`62`	`}`
`62`	`63`
`63`		`-`
`64`	`64`	`public function setDefaultOperator(string\|null $defaultOperator): self`
`65`	`65`	`{`
`66`	`66`	`$this->defaultOperator = $defaultOperator;`
	`67`	`+`
`67`	`68`	`return $this;`
`68`	`69`	`}`
`69`	`70`
`70`		`-`
`71`	`71`	`public function setAnalyzer(string\|null $analyzer): self`
`72`	`72`	`{`
`73`	`73`	`$this->analyzer = $analyzer;`
	`74`	`+`
`74`	`75`	`return $this;`
`75`	`76`	`}`
`76`	`77`
`77`		`-`
`78`	`78`	`public function setLenient(bool\|null $lenient): self`
`79`	`79`	`{`
`80`	`80`	`$this->lenient = $lenient;`
	`81`	`+`
`81`	`82`	`return $this;`
`82`	`83`	`}`
`83`	`84`
`84`		`-`
`85`	`85`	`public function setQuoteFieldSuffix(string\|null $quoteFieldSuffix): self`
`86`	`86`	`{`
`87`	`87`	`$this->quoteFieldSuffix = $quoteFieldSuffix;`
	`88`	`+`
`88`	`89`	`return $this;`
`89`	`90`	`}`
`90`	`91`
`91`		`-`
`92`	`92`	`public function setAnalyzeWildCard(bool\|null $analyzeWildCard): self`
`93`	`93`	`{`
`94`	`94`	`$this->analyzeWildCard = $analyzeWildCard;`
	`95`	`+`
`95`	`96`	`return $this;`
`96`	`97`	`}`
`97`	`98`
`98`		`-`
`99`	`99`	`public function setAutoGenerateSynonymsPhraseQuery(bool\|null $autoGenerateSynonymsPhraseQuery): self`
`100`	`100`	`{`
`101`	`101`	`$this->autoGenerateSynonymsPhraseQuery = $autoGenerateSynonymsPhraseQuery;`
	`102`	`+`
`102`	`103`	`return $this;`
`103`	`104`	`}`
`104`	`105`
`@@ -168,6 +169,7 @@ public function build(): array`
`168`	`169`	`}`
`169`	`170`
`170`	`171`	`$this->buildMinimumShouldMatchTo($data);`
	`172`	`+ $this->buildBoostTo($data);`
`171`	`173`
`172`	`174`	`$build = $this->params;`
`173`	`175`	`$build['simple_query_string'] = $data;`
Original file line number	Diff line number	Diff line change
`@@ -12,13 +12,13 @@ class GeoBoundingBoxQueryTest extends TestCase`
`12`	`12`	`{`
`13`	`13`	`public function testBuildFailsOnAllNull(): void`
`14`	`14`	`{`
`15`		`- $this->expectErrorMessage('GeoBoundingBoxQuery needs at least 2 sides set');`
	`15`	`+ $this->expectExceptionMessage('GeoBoundingBoxQuery needs at least 2 sides set');`
`16`	`16`	`(new GeoBoundingBoxQuery('test'))->build();`
`17`	`17`	`}`
`18`	`18`
`19`	`19`	`public function testBuildFailsOnOneFilter(): void`
`20`	`20`	`{`
`21`		`- $this->expectErrorMessage('GeoBoundingBoxQuery needs at least 2 sides set');`
	`21`	`+ $this->expectExceptionMessage('GeoBoundingBoxQuery needs at least 2 sides set');`
`22`	`22`	`(new GeoBoundingBoxQuery(field: 'test', topLeft: new GpsPointEntity(1.1, 2.1)))->build();`
`23`	`23`	`}`
`24`	`24`
Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,7 @@ public function testItSetThePitAsString(): void`
`72`	`72`
`73`	`73`	`$query = $queryBuilder->build();`
`74`	`74`
`75`		`- $this->assertEquals(['id' => 'pit-as-string'], $query['pit']);`
	`75`	`+ $this->assertEquals(['id' => 'pit-as-string'], $query['body']['pit']);`
`76`	`76`	`}`
`77`	`77`
`78`	`78`	`public function testItSetThePitAsArray(): void`
`@@ -83,7 +83,7 @@ public function testItSetThePitAsArray(): void`
`83`	`83`
`84`	`84`	`$query = $queryBuilder->build();`
`85`	`85`
`86`		`- $this->assertEquals(['id' => 'pit-as-array', 'keep_alive' => '1m'], $query['pit']);`
	`86`	`+ $this->assertEquals(['id' => 'pit-as-array', 'keep_alive' => '1m'], $query['body']['pit']);`
`87`	`87`	`}`
`88`	`88`
`89`	`89`	`public function testItAllowToSort(): void`