Add value function to expression language to allow existence checks (#173)

Author: wachterjohannes

.github/workflows/test-application.yaml

@@ -16,6 +16,7 @@ jobs:
             SYMFONY_DEPRECATIONS_HELPER: weak
             COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
             ELASTICSEARCH_VERSION: ${{ matrix.elasticsearch-version }}
+            SYMFONY_MAX_PHPUNIT_VERSION: ${{ matrix.max-phpunit-version }}
 
         strategy:
             fail-fast: false
@@ -28,6 +29,7 @@ jobs:
                       dependency-versions: 'lowest'
                       tools: 'composer:v1'
                       php-cs-fixer: false
+                      max-phpunit-version: '7'
 
                     - php-version: '7.3'
                       elasticsearch-version: '2.4.6'
@@ -36,6 +38,7 @@ jobs:
                       dependency-versions: 'highest'
                       tools: 'composer:v2'
                       php-cs-fixer: false
+                      max-phpunit-version: '7'
 
                     - php-version: '7.4'
                       elasticsearch-version: '2.4.6'
@@ -44,6 +47,7 @@ jobs:
                       dependency-versions: 'highest'
                       tools: 'composer:v2'
                       php-cs-fixer: true
+                      max-phpunit-version: '7'
 
                     - php-version: '8.0'
                       elasticsearch-version: '7.11.1'
@@ -52,6 +56,7 @@ jobs:
                       dependency-versions: 'highest'
                       tools: 'composer:v2'
                       php-cs-fixer: false
+                      max-phpunit-version: '8'
 
                     - php-version: '8.1'
                       elasticsearch-version: '7.11.1'
@@ -60,6 +65,7 @@ jobs:
                       dependency-versions: 'highest'
                       tools: 'composer:v2'
                       php-cs-fixer: false
+                      max-phpunit-version: '8'
 
                     - php-version: '8.1'
                       elasticsearch-version: '7.11.1'
@@ -68,6 +74,7 @@ jobs:
                       dependency-versions: 'highest'
                       tools: 'composer:v2'
                       php-cs-fixer: false
+                      max-phpunit-version: '8'
 
         services:
             elasticsearch:

Search/ExpressionLanguage/MassiveSearchExpressionLanguage.php

@@ -25,6 +25,7 @@ protected function registerFunctions()
 
         $this->addFunction($this->createJoinFunction());
         $this->addFunction($this->createMapFunction());
+        $this->addFunction($this->createValueFunction());
     }
 
     /**
@@ -82,4 +83,30 @@ function(array $values, $elements, $expression) {
             }
         );
     }
+
+    /**
+     * Value returns the value of the variable. If the variable does not exists a default will be returned.
+     *
+     * For example:
+     *
+     *   massive_search_value("expression", {"hidden": false}) = array('hidden' => true);
+     *
+     * @return ExpressionFunction
+     */
+    private function createValueFunction()
+    {
+        return new ExpressionFunction(
+            'massive_search_value',
+            function($elements, $expression) {
+                throw new \Exception('Value function does not support compilation');
+            },
+            function(array $values, $variable, $default) {
+                if (isset($values[$variable])) {
+                    return $values[$variable];
+                }
+
+                return $default;
+            }
+        );
+    }
 }

Search/ObjectToDocumentConverter.php

@@ -181,7 +181,7 @@ private function populateDocument(
             $type = $mapping['type'];
             /** @var FieldInterface $mappingField */
             $mappingField = $mapping['field'];
-            $condition = method_exists($mappingField, 'getCondition') ? $mappingField->getCondition() : null;
+            $condition = \method_exists($mappingField, 'getCondition') ? $mappingField->getCondition() : null;
             $validField = $condition ? $this->fieldEvaluator->evaluateCondition($object, $condition) : true;
 
             if (false === $validField) {

Tests/Functional/BaseTestCase.php

@@ -22,13 +22,13 @@ abstract class BaseTestCase extends TestCase
 {
     private $kernels = [];
 
-    public function setUp()
+    protected function setUp()
     {
         AppKernel::resetEnvironment();
         AppKernel::installDistEnvironment();
     }
 
-    public function tearDown()
+    protected function tearDown()
     {
         AppKernel::resetEnvironment();
     }

Tests/ProphecyTrait.php

@@ -0,0 +1,16 @@
+<?php
+
+/*
+ * This file is part of the MassiveSearchBundle
+ *
+ * (c) MASSIVE ART WebServices GmbH
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Prophecy\PhpUnit;
+
+trait ProphecyTrait
+{
+}

Tests/Unit/Command/PurgeCommandTest.php

@@ -15,12 +15,15 @@
 use Massive\Bundle\SearchBundle\Search\SearchManagerInterface;
 use PHPUnit\Framework\TestCase;
 use Prophecy\Argument;
+use Prophecy\PhpUnit\ProphecyTrait;
 use Symfony\Component\Console\Application;
 use Symfony\Component\Console\Helper\QuestionHelper;
 use Symfony\Component\Console\Tester\CommandTester;
 
 class PurgeCommandTest extends TestCase
 {
+    use ProphecyTrait;
+
     /**
      * @var SearchManagerInterface
      */

Tests/Unit/Command/ReindexCommandTest.php

@@ -17,8 +17,10 @@
 use Massive\Bundle\SearchBundle\Search\Reindex\ReindexProviderRegistry;
 use Massive\Bundle\SearchBundle\Search\Reindex\ResumeManagerInterface;
 use Massive\Bundle\SearchBundle\Search\SearchManager;
+use Massive\Bundle\SearchBundle\Search\SearchManagerInterface;
 use PHPUnit\Framework\TestCase;
 use Prophecy\Argument;
+use Prophecy\PhpUnit\ProphecyTrait;
 use Symfony\Component\Console\Application;
 use Symfony\Component\Console\Helper\QuestionHelper;
 use Symfony\Component\Console\Input\InputInterface;
@@ -28,6 +30,8 @@
 
 class ReindexCommandTest extends TestCase
 {
+    use ProphecyTrait;
+
     /**
      * @var ResumeManagerInterface
      */
@@ -95,7 +99,7 @@ public function testCheckpointAsk()
             Argument::type(OutputInterface::class),
             Argument::type(ConfirmationQuestion::class),
             true
-        )->shouldBeCalled();
+        )->shouldBeCalled()->willReturn(true);
         $this->execute('prod', []);
     }
 

Tests/Unit/Search/Adapter/ZendLuceneAdapterTest.php

@@ -17,10 +17,13 @@
 use Massive\Bundle\SearchBundle\Search\Field;
 use Massive\Bundle\SearchBundle\Search\SearchQuery;
 use PHPUnit\Framework\TestCase;
+use Prophecy\PhpUnit\ProphecyTrait;
 use Symfony\Component\Filesystem\Filesystem;
 
 class ZendLuceneAdapterTest extends TestCase
 {
+    use ProphecyTrait;
+
     /**
      * @var string
      */

Tests/Unit/Search/Converter/ConverterManagerTest.php

@@ -17,9 +17,12 @@
 use Massive\Bundle\SearchBundle\Search\Document;
 use PHPUnit\Framework\TestCase;
 use Prophecy\Argument;
+use Prophecy\PhpUnit\ProphecyTrait;
 
 class ConverterManagerTest extends TestCase
 {
+    use ProphecyTrait;
+
     public function testConvert()
     {
         $document = $this->prophesize(Document::class);

Tests/Unit/Search/Decorator/IndexNameDecoratorTest.php

@@ -16,9 +16,12 @@
 use Massive\Bundle\SearchBundle\Search\Metadata\FieldEvaluator;
 use Massive\Bundle\SearchBundle\Search\Metadata\IndexMetadataInterface;
 use PHPUnit\Framework\TestCase;
+use Prophecy\PhpUnit\ProphecyTrait;
 
 class IndexNameDecoratorTest extends TestCase
 {
+    use ProphecyTrait;
+
     /**
      * @var FieldEvaluator
      */