Merge pull request #135 from apisearch-io/feature/score-strategy-multi-filter

Added multi-filter score-strategy

Author: mmoreram

.phpunit.result.cache

@@ -183,6 +183,13 @@ class ScoreStrategy implements HttpTransportable
      */
     private $filter;
 
+    /**
+     * Filters.
+     *
+     * @var Filter[]
+     */
+    private $filters = [];
+
     /**
      * @var float
      *
@@ -256,6 +263,14 @@ public function getFilter(): ? Filter
         return $this->filter;
     }
 
+    /**
+     * @return Filter[]
+     */
+    public function getFilters(): array
+    {
+        return $this->filters;
+    }
+
     /**
      * Create empty.
      *
@@ -267,8 +282,6 @@ public static function createDefault(): ScoreStrategy
     }
 
     /**
-     * Create default field scoring.
-     *
      * @param string $field
      * @param float  $factor
      * @param float  $missing
@@ -302,8 +315,6 @@ public static function createFieldBoosting(
     }
 
     /**
-     * Create custom function scoring.
-     *
      * @param string $function
      * @param float  $weight
      * @param Filter $filter
@@ -328,8 +339,6 @@ public static function createCustomFunction(
     }
 
     /**
-     * Create custom function scoring.
-     *
      * @param float  $weight
      * @param Filter $filter
      * @param bool   $matchMainQuery
@@ -350,6 +359,29 @@ public static function createWeightFunction(
         return $scoreStrategy;
     }
 
+    /**
+     * @param float    $weight
+     * @param Filter[] $filters
+     * @param bool     $matchMainQuery
+     *
+     * @return ScoreStrategy
+     */
+    public static function createWeightMultiFilterFunction(
+        float $weight = self::DEFAULT_WEIGHT,
+        array $filters = [],
+        bool $matchMainQuery = true
+    ): ScoreStrategy {
+        $scoreStrategy = self::createDefault();
+        $scoreStrategy->type = 'weight';
+        $scoreStrategy->weight = $weight;
+        $scoreStrategy->filters = array_map(function (Filter $filter) {
+            return self::fixFilterFieldPath($filter);
+        }, $filters);
+        $scoreStrategy->configuration['match_main_query'] = $matchMainQuery;
+
+        return $scoreStrategy;
+    }
+
     /**
      * Create custom function scoring.
      *
@@ -427,6 +459,9 @@ public function toArray(): array
                     ->filter
                     ->toArray()
                 : null),
+            'filters' => array_map(function (Filter $filter) {
+                return $filter->toArray();
+            }, $this->filters),
         ];
     }
 
@@ -448,6 +483,10 @@ public static function createFromArray(array $array)
             ? Filter::createFromArray($array['filter'])
             : null;
 
+        $scoreStrategy->filters = array_map(function (array $filterAsArray) {
+            return Filter::createFromArray($filterAsArray);
+        }, $array['filters'] ?? []);
+
         return $scoreStrategy;
     }
 }

Query/ScoreStrategy.php

@@ -314,7 +314,7 @@ public function toArray(): array
             'highest_active_level' => 0 === $this->highestActiveLevel
                 ? null
                 : $this->highestActiveLevel,
-            'metadata' => $this->metadata
+            'metadata' => $this->metadata,
         ], function ($element) {
             return
             !(

Result/Aggregation.php

@@ -19,6 +19,7 @@
 use Apisearch\Http\HttpAdapter;
 use Apisearch\Http\RetryMap;
 use Apisearch\Http\TCPClient;
+use Apisearch\Tests\ProphecyTrait;
 use PHPUnit\Framework\TestCase;
 use Prophecy\Argument;
 
@@ -27,6 +28,8 @@
  */
 class TCPClientTest extends TestCase
 {
+    use ProphecyTrait;
+
     /**
      * Test n query retries.
      */

Tests/Http/TCPClientTest.php

@@ -0,0 +1,29 @@
+<?php
+
+/*
+ * This file is part of the Apisearch PHP Client.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * Feel free to edit as you please, and have fun.
+ *
+ * @author Marc Morera <[email protected]>
+ */
+
+declare(strict_types=1);
+
+namespace Apisearch\Tests;
+
+use Prophecy\PhpUnit\ProphecyTrait as BaseProphecyTrait;
+
+if (trait_exists(BaseProphecyTrait::class)) {
+    trait ProphecyTrait
+    {
+        use BaseProphecyTrait;
+    }
+} else {
+    trait ProphecyTrait
+    {
+    }
+}

Tests/ProphecyTrait.php

@@ -407,4 +407,28 @@ public function testDecay()
             $scoreStrategy->getScoreMode()
         );
     }
+
+    public function testWeightMultiFilter()
+    {
+        $scoreStrategy = ScoreStrategy::createWeightMultiFilterFunction(
+            20,
+            [],
+            true
+        );
+
+        $this->assertNull($scoreStrategy->getFilter());
+        $this->assertEmpty($scoreStrategy->getFilters());
+
+        $scoreStrategy = ScoreStrategy::createWeightMultiFilterFunction(
+            20,
+            [
+                Filter::create('1', ['2'], Filter::AT_LEAST_ONE, Filter::TYPE_FIELD),
+                Filter::create('2', ['2'], Filter::AT_LEAST_ONE, Filter::TYPE_FIELD),
+            ],
+            true
+        );
+
+        $this->assertNull($scoreStrategy->getFilter());
+        $this->assertCount(2, $scoreStrategy->getFilters());
+    }
 }

Tests/Query/ScoreStrategyTest.php

@@ -23,6 +23,7 @@
 use Apisearch\Query\Query;
 use Apisearch\Repository\HttpRepository;
 use Apisearch\Repository\RepositoryReference;
+use Apisearch\Tests\ProphecyTrait;
 use PHPUnit\Framework\TestCase;
 use Prophecy\Argument;
 
@@ -31,6 +32,8 @@
  */
 class HttpRepositoryTest extends TestCase
 {
+    use ProphecyTrait;
+
     /**
      * Test add, delete and query items by UUID.
      */

Tests/Repository/HttpRepositoryTest.php

@@ -37,7 +37,7 @@ public function testConstruct()
             ['1', '2'],
             [
                 'a' => 1,
-                'b' => 2
+                'b' => 2,
             ]
         );
 
@@ -52,7 +52,7 @@ public function testConstruct()
         $this->assertFalse($aggregation->isEmpty());
         $this->assertEquals([
             'a' => 1,
-            'b' => 2
+            'b' => 2,
         ], $aggregation->getMetadata());
     }
 
@@ -193,7 +193,7 @@ public function testToArrayDefaultValues()
      */
     public function testToArrayAllValues()
     {
-        $aggregation = new Aggregation('name', Filter::MUST_ALL, 100, ['1'], ['a' => 1, 'b' => 2 ]);
+        $aggregation = new Aggregation('name', Filter::MUST_ALL, 100, ['1'], ['a' => 1, 'b' => 2]);
         $aggregation->addCounter('1', 10);
         $aggregation->addCounter('2', 10);
         $this->assertEquals(
@@ -208,7 +208,7 @@ public function testToArrayAllValues()
                     '1',
                 ],
                 'total_elements' => 100,
-                'metadata' => ['a' => 1, 'b' => 2 ]
+                'metadata' => ['a' => 1, 'b' => 2],
             ],
             $aggregation->toArray()
         );
@@ -242,7 +242,7 @@ public function testCreateFromArrayAllValues()
                 '1',
             ],
             'total_elements' => 100,
-            'metadata' => ['a' => 1, 'b' => 2 ]
+            'metadata' => ['a' => 1, 'b' => 2],
         ]);
         $this->assertEquals('agg1', $aggregation->getName());
         $this->assertCount(2, $aggregation->getCounters());

Tests/Result/AggregationTest.php

@@ -17,7 +17,8 @@
         "nesbot/carbon": "^1.22 || ^2.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "^7 | ^9"
+        "phpunit/phpunit": "^7 | ^9",
+        "phpspec/prophecy-phpunit": "^1 | ^2"
     },
     "autoload": {
         "psr-4": {

composer.json

@@ -1,31 +1,31 @@
 <?xml version="1.0" encoding="UTF-8"?>
-
-<phpunit backupGlobals="false"
-         backupStaticAttributes="false"
-         colors="true"
-         convertErrorsToExceptions="false"
-         convertNoticesToExceptions="false"
-         convertWarningsToExceptions="false"
-         processIsolation="false"
-         stopOnFailure="true"
-         bootstrap="vendor/autoload.php"
+<phpunit
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        backupGlobals="false"
+        backupStaticAttributes="false"
+        colors="true"
+        convertErrorsToExceptions="false"
+        convertNoticesToExceptions="false"
+        convertWarningsToExceptions="false"
+        processIsolation="false"
+        stopOnFailure="true"
+        bootstrap="vendor/autoload.php"
+        xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd"
 >
-    <testsuites>
-        <testsuite name="Test Suite">
-            <directory>./Tests</directory>
-        </testsuite>
-    </testsuites>
-
-    <filter>
-        <whitelist>
-            <directory>./</directory>
-            <exclude>
-                <directory>./Tests/</directory>
-                <directory>./Resources/</directory>
-                <directory>./DependencyInjection/</directory>
-                <directory>./vendor/</directory>
-            </exclude>
-        </whitelist>
-    </filter>
-
-</phpunit>
+  <coverage>
+    <include>
+      <directory>./</directory>
+    </include>
+    <exclude>
+      <directory>./Tests/</directory>
+      <directory>./Resources/</directory>
+      <directory>./DependencyInjection/</directory>
+      <directory>./vendor/</directory>
+    </exclude>
+  </coverage>
+  <testsuites>
+    <testsuite name="Test Suite">
+      <directory>./Tests</directory>
+    </testsuite>
+  </testsuites>
+</phpunit>