Merge branch 'master' of https://github.com/Firesphere/silverstripe-solr-search

Author: Firesphere

docs/03-Usage.md

@@ -259,6 +259,9 @@ Looking at the `tests` folder, there is a `TestIndexFour`. This index is not loa
 To search, here's an example using all the features, and setting the resulting outcome from the search
 onto the current `Controller` to be useable in templates.
 
+More advanced filter options are available, see the [Advanced filters & excludes](04-Advanced-Options/05-Filters-excludes.md)
+page for more information.
+
 ```php
 class SearchController extends PageController
 {

docs/04-Advanced-Options/05-Filters-excludes.md

@@ -0,0 +1,40 @@
+# Advanced filters & excludes
+
+When performing a search, in addition to simple single-value and array-of-value filters, it’s possible
+to build more complex filter/exclude criteria. Some examples of this include:
+
+- Range filters (greater than/less than)
+- Geospatial search
+- Partial match filters (starts with/ends with)
+
+## Usage
+
+Advanced search/exclude filters are constructed from `Criteria` objects, from the [MinimalCode Solr
+Search Criteria](https://github.com/minimalcode-org/search) package. More information and usage 
+examples are available [here](https://github.com/minimalcode-org/minimalcode-parent/wiki/4.1-Solr-Search-%28Php%29).
+
+When passing a `Criteria` object to `addFilter` or `addExclude`, the first argument (usually the
+field name) can be set to any string value.
+
+```php
+$query = new BaseQuery();
+
+// Simple date filter - exclude any pages which have an embargo date in the future
+$criteria = Criteria::where('SiteTree_Embargo')
+    ->greaterThanEqual('NOW');
+$query->addExclude('embargo', $criteria);
+
+// Starts with/ends with filter
+$criteria = Criteria::where('SiteTree_Title')
+    ->startsWith('prefix')
+    ->endsWith('suffix');
+$query->addFilter('title-partial-match', $criteria);
+
+// Nested criteria
+$topLevel = Criteria::where('SiteTree_ParentID')
+    ->is(0);
+$criteria = Criteria::where('SiteTree_Title')
+    ->startsWith('test')
+    ->andWhere($topLevel);
+$query->addFilter('top-level-test-pages', $criteria);
+```

docs/index.md

@@ -12,6 +12,7 @@ Advanced searching for SilverStripe with Solr. Versions 4-8+ are supported.
     02. [Boosting](04-Advanced-Options/02-Boosting.md)
     03. [Fuzzy search](04-Advanced-Options/03-Fuzzy-search.md)
     04. [Elevation [WIP]](04-Advanced-Options/04-Elevation.md)
+    05. [Advanced filters & excludes](04-Advanced-Options/05-Filters-excludes.md)
 05. [Customisation](05-Customisation.md)
 06. [CMS Usage](06-CMS-Usage.md)
 07. [Debugging](07-Debugging.md)

src/Traits/QueryComponentTraits/QueryComponentFilterTrait.php

@@ -33,15 +33,32 @@ trait QueryComponentFilterTrait
      */
     protected $clientQuery;
 
+    /**
+     * Convert a field/value filter pair to a Criteria object that can build part of a Solr query.
+     * If a Criteria object is passed as the value, it will be returned unmodified.
+     *
+     * @param string $field
+     * @param mixed $value
+     * @return Criteria
+     */
+    protected function buildCriteriaFilter(string $field, $value): Criteria
+    {
+        if ($value instanceof Criteria) {
+            return $value;
+        }
+
+        $value = (array)$value;
+        return Criteria::where($field)->in($value);
+    }
+
     /**
      * Create filter queries
      */
     protected function buildFilters(): void
     {
         $filters = $this->query->getFilter();
         foreach ($filters as $field => $value) {
-            $value = is_array($value) ? $value : [$value];
-            $criteria = Criteria::where($field)->in($value);
+            $criteria = $this->buildCriteriaFilter($field, $value);
             $this->clientQuery->createFilterQuery('filter-' . $field)
                 ->setQuery($criteria->getQuery());
         }
@@ -93,10 +110,8 @@ protected function buildExcludes(): void
     {
         $filters = $this->query->getExclude();
         foreach ($filters as $field => $value) {
-            $value = is_array($value) ? $value : [$value];
-            $criteria = Criteria::where($field)
-                ->in($value)
-                ->not();
+            $criteria = $this->buildCriteriaFilter($field, $value);
+            $criteria = $criteria->not(); // Negate the filter as we're excluding
             $this->clientQuery->createFilterQuery('exclude-' . $field)
                 ->setQuery($criteria->getQuery());
         }

src/Traits/QueryTraits/BaseQueryTrait.php

@@ -10,6 +10,8 @@
 
 namespace Firesphere\SolrSearch\Traits;
 
+use Minimalcode\Search\Criteria;
+
 /**
  * Trait BaseQueryTrait Extraction from the BaseQuery class to keep things readable.
  *
@@ -83,7 +85,7 @@ public function addTerm(string $term, array $fields = [], int $boost = 0, $fuzzy
      * Adds filters to filter on by value
      *
      * @param string $field Field to filter on
-     * @param string|array $value Value for this field
+     * @param string|array|Criteria $value Value for this field
      * @return $this
      */
     public function addFilter($field, $value): self
@@ -112,7 +114,7 @@ public function addField($field): self
      * Exclude fields from the search action
      *
      * @param string $field
-     * @param string|array $value
+     * @param string|array|Criteria $value
      * @return $this
      */
     public function addExclude($field, $value): self

tests/unit/QueryComponentFactoryTest.php

@@ -8,15 +8,20 @@
 use Firesphere\SolrSearch\Factories\QueryComponentFactory;
 use Firesphere\SolrSearch\Indexes\BaseIndex;
 use Firesphere\SolrSearch\Queries\BaseQuery;
+use Minimalcode\Search\Criteria;
 use Page;
+use ReflectionMethod;
 use SilverStripe\Core\Config\Config;
 use SilverStripe\Core\Injector\Injector;
 use SilverStripe\Dev\SapphireTest;
 use Solarium\Core\Query\Helper;
+use Solarium\QueryType\Select\Query\FilterQuery;
+use Solarium\QueryType\Select\Query\Query;
 
 class QueryComponentFactoryTest extends SapphireTest
 {
     protected static $fixture_file = '../fixtures/DataResolver.yml';
+
     protected static $extra_dataobjects = [
         TestObject::class,
         TestPage::class,
@@ -28,6 +33,17 @@ class QueryComponentFactoryTest extends SapphireTest
      */
     protected $factory;
 
+    protected function setUp()
+    {
+        parent::setUp();
+        Injector::inst()->get(Page::class)->requireDefaultRecords();
+        foreach (self::$extra_dataobjects as $className) {
+            Config::modify()->merge($className, 'extensions', [DataObjectExtension::class]);
+        }
+        $this->factory = new QueryComponentFactory();
+        $this->factory->setIndex(Injector::inst()->get(CircleCITestIndex::class));
+    }
+
     public function testBuildQuery()
     {
         $index = new CircleCITestIndex();
@@ -61,7 +77,6 @@ public function testBuildQuery()
         $this->assertInternalType('array', $this->factory->getBoostTerms());
     }
 
-
     public function testEscapeTerms()
     {
         $term = '"test me" help';
@@ -72,19 +87,104 @@ public function testEscapeTerms()
         $this->assertEquals('"test me" help', $escaped);
 
         $term = 'help me';
-
         $this->assertEquals('help me', $this->factory->escapeSearch($term));
     }
 
+    public function testBuildCriteriaFilter()
+    {
+        $reflectionMethod = new ReflectionMethod(QueryComponentFactory::class, 'buildCriteriaFilter');
+        $reflectionMethod->setAccessible(true);
+
+        /** @var Criteria $criteria */
+        $criteria = $reflectionMethod->invoke(new QueryComponentFactory(), 'TestField', 'TestValue');
+        $this->assertInstanceOf(Criteria::class, $criteria);
+        $this->assertEquals('TestField:TestValue', $criteria->getQuery());
+
+        $criteria = $reflectionMethod->invoke(new QueryComponentFactory(), 'TestField', ['Arr1', 'Arr2']);
+        $this->assertInstanceOf(Criteria::class, $criteria);
+        $this->assertEquals('TestField:(Arr1 Arr2)', $criteria->getQuery());
+
+        $criteriaValue = Criteria::where('TestField')->is('TestValue');
+        $criteria = $reflectionMethod->invoke(new QueryComponentFactory(), 'TestField', $criteriaValue);
+        $this->assertInstanceOf(Criteria::class, $criteria);
+        $this->assertSame($criteriaValue, $criteria);
+    }
 
-    protected function setUp()
+    public function testFilterAndExcludeStrings()
     {
-        parent::setUp();
-        Injector::inst()->get(Page::class)->requireDefaultRecords();
-        foreach (self::$extra_dataobjects as $className) {
-            Config::modify()->merge($className, 'extensions', [DataObjectExtension::class]);
-        }
-        $this->factory = new QueryComponentFactory();
-        $this->factory->setIndex(Injector::inst()->get(CircleCITestIndex::class));
+        $mockFilterQuery = $this->createMock(FilterQuery::class);
+        $mockFilterQuery->expects($this->once())
+            ->method('setQuery')
+            ->with($this->equalTo('TestFilterField:TestFilterValue'));
+        $mockExcludeQuery = $this->createMock(FilterQuery::class);
+        $mockExcludeQuery->expects($this->once())
+            ->method('setQuery')
+            ->with($this->equalTo('-TestExcludeField:TestExcludeValue'));
+
+        $mockClientQuery = new class extends Query {
+            public $mockFilterQuery;
+            public $mockExcludeQuery;
+            public function createFilterQuery($options = null): FilterQuery
+            {
+                if ($options === 'filter-TestFilterField') {
+                    return $this->mockFilterQuery;
+                } elseif ($options === 'exclude-TestExcludeField') {
+                    return $this->mockExcludeQuery;
+                }
+
+                return parent::createFilterQuery($options);
+            }
+        };
+        $mockClientQuery->mockFilterQuery = $mockFilterQuery;
+        $mockClientQuery->mockExcludeQuery = $mockExcludeQuery;
+
+        $baseQuery = new BaseQuery();
+        $baseQuery->addFilter('TestFilterField', 'TestFilterValue');
+        $baseQuery->addExclude('TestExcludeField', 'TestExcludeValue');
+
+        $factory = new QueryComponentFactory();
+        $factory->setIndex(Injector::inst()->get(CircleCITestIndex::class));
+        $factory->setQuery($baseQuery);
+        $factory->setClientQuery($mockClientQuery);
+        $factory->buildQuery();
+    }
+
+    public function testFilterAndExcludeCriteria()
+    {
+        $mockFilterQuery = $this->createMock(FilterQuery::class);
+        $mockFilterQuery->expects($this->once())
+            ->method('setQuery')
+            ->with($this->equalTo('TestFilterField:TestFilterValue'));
+        $mockExcludeQuery = $this->createMock(FilterQuery::class);
+        $mockExcludeQuery->expects($this->once())
+            ->method('setQuery')
+            ->with($this->equalTo('-TestExcludeField:TestExcludeValue'));
+
+        $mockClientQuery = new class extends Query {
+            public $mockFilterQuery;
+            public $mockExcludeQuery;
+            public function createFilterQuery($options = null): FilterQuery
+            {
+                if ($options === 'filter-TestFilterField') {
+                    return $this->mockFilterQuery;
+                } elseif ($options === 'exclude-TestExcludeField') {
+                    return $this->mockExcludeQuery;
+                }
+
+                return parent::createFilterQuery($options);
+            }
+        };
+        $mockClientQuery->mockFilterQuery = $mockFilterQuery;
+        $mockClientQuery->mockExcludeQuery = $mockExcludeQuery;
+
+        $baseQuery = new BaseQuery();
+        $baseQuery->addFilter('TestFilterField', Criteria::where('TestFilterField')->is('TestFilterValue'));
+        $baseQuery->addExclude('TestExcludeField', Criteria::where('TestExcludeField')->is('TestExcludeValue'));
+
+        $factory = new QueryComponentFactory();
+        $factory->setIndex(Injector::inst()->get(CircleCITestIndex::class));
+        $factory->setQuery($baseQuery);
+        $factory->setClientQuery($mockClientQuery);
+        $factory->buildQuery();
     }
 }