Add "ignore_missing" option to concerned processors (#2001)

* Use trait for ignore_missing processor option

* Add option to concerned processors

* Add changelog

* Add tests

CHANGELOG.md

@@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased](https://github.com/ruflin/Elastica/compare/7.1.2...master)
 ### Backward Compatibility Breaks
 ### Added
+* Added `ignore_missing` option to `lowercase`, `remove`, `trim` and `uppercase` processors [#2001](https://github.com/ruflin/Elastica/pull/2001)
 ### Changed
 ### Deprecated
 ### Removed

src/Processor/AttachmentProcessor.php

@@ -11,6 +11,8 @@
  */
 class AttachmentProcessor extends AbstractProcessor
 {
+    use Traits\IgnoreMissingTrait;
+
     public const DEFAULT_TARGET_FIELD_VALUE = 'attachment';
     public const DEFAULT_INDEXED_CHARS_VALUE = 100000;
     public const DEFAULT_IGNORE_MISSING_VALUE = false;
@@ -59,14 +61,4 @@ public function setProperties(array $properties): self
     {
         return $this->setParam('properties', $properties);
     }
-
-    /**
-     * Set ignore_missing. Default value false.
-     *
-     * @return $this
-     */
-    public function setIgnoreMissing(bool $ignoreMissing): self
-    {
-        return $this->setParam('ignore_missing', $ignoreMissing);
-    }
 }

src/Processor/ConvertProcessor.php

@@ -11,6 +11,8 @@
  */
 class ConvertProcessor extends AbstractProcessor
 {
+    use Traits\IgnoreMissingTrait;
+
     public const DEFAULT_TARGET_FIELD_VALUE = 'field';
     public const DEFAULT_IGNORE_MISSING_VALUE = false;
 
@@ -49,16 +51,4 @@ public function setTargetField(string $targetField): self
     {
         return $this->setParam('target_field', $targetField);
     }
-
-    /**
-     * Set ignore_missing. Default value false.
-     *
-     * @param bool $ignoreMissing only these values are allowed (integer|float|string|boolean|auto)
-     *
-     * @return $this
-     */
-    public function setIgnoreMissing(bool $ignoreMissing): self
-    {
-        return $this->setParam('ignore_missing', $ignoreMissing);
-    }
 }

src/Processor/ForeachProcessor.php

@@ -12,6 +12,8 @@
  */
 class ForeachProcessor extends AbstractProcessor
 {
+    use Traits\IgnoreMissingTrait;
+
     public const DEFAULT_IGNORE_MISSING_VALUE = false;
 
     /**
@@ -60,16 +62,4 @@ public function setRawProcessor(array $processor): self
     {
         return $this->setParam('processor', $processor);
     }
-
-    /**
-     * Set ignore_missing. Default value false.
-     *
-     * If true and field does not exist or is null, the processor quietly exits without modifying the document
-     *
-     * @return $this
-     */
-    public function setIgnoreMissing(bool $ignoreMissing): self
-    {
-        return $this->setParam('ignore_missing', $ignoreMissing);
-    }
 }

src/Processor/KvProcessor.php

@@ -11,6 +11,8 @@
  */
 class KvProcessor extends AbstractProcessor
 {
+    use Traits\IgnoreMissingTrait;
+
     public const DEFAULT_TARGET_FIELD_VALUE = null;
     public const DEFAULT_IGNORE_MISSING_VALUE = false;
 
@@ -80,16 +82,4 @@ public function setExcludeKeys(array $listOfKeys): self
     {
         return $this->setParam('exclude_keys', $listOfKeys);
     }
-
-    /**
-     * Set ignore_missing. Default value false.
-     *
-     * @param bool $ignoreMissing only these values are allowed (integer|float|string|boolean|auto)
-     *
-     * @return $this
-     */
-    public function setIgnoreMissing(bool $ignoreMissing): self
-    {
-        return $this->setParam('ignore_missing', $ignoreMissing);
-    }
 }

src/Processor/LowercaseProcessor.php

@@ -11,6 +11,8 @@
  */
 class LowercaseProcessor extends AbstractProcessor
 {
+    use Traits\IgnoreMissingTrait;
+
     public function __construct(string $field)
     {
         $this->setField($field);

src/Processor/RemoveProcessor.php

@@ -11,6 +11,8 @@
  */
 class RemoveProcessor extends AbstractProcessor
 {
+    use Traits\IgnoreMissingTrait;
+
     /**
      * @param array|string $field
      */

src/Processor/RenameProcessor.php

@@ -11,6 +11,8 @@
  */
 class RenameProcessor extends AbstractProcessor
 {
+    use Traits\IgnoreMissingTrait;
+
     public const DEFAULT_IGNORE_MISSING_VALUE = false;
 
     public function __construct(string $field, string $targetField)
@@ -38,16 +40,4 @@ public function setTargetField(string $targetField): self
     {
         return $this->setParam('target_field', $targetField);
     }
-
-    /**
-     * Set ignore_missing. Default value false.
-     *
-     * @param bool $ignoreMissing only these values are allowed (integer|float|string|boolean|auto)
-     *
-     * @return $this
-     */
-    public function setIgnoreMissing(bool $ignoreMissing): self
-    {
-        return $this->setParam('ignore_missing', $ignoreMissing);
-    }
 }

src/Processor/SplitProcessor.php

@@ -11,6 +11,8 @@
  */
 class SplitProcessor extends AbstractProcessor
 {
+    use Traits\IgnoreMissingTrait;
+
     public const DEFAULT_IGNORE_MISSING_VALUE = false;
 
     public function __construct(string $field, string $separator)
@@ -38,16 +40,4 @@ public function setSeparator(string $separator): self
     {
         return $this->setParam('separator', $separator);
     }
-
-    /**
-     * Set ignore_missing. Default value false.
-     *
-     * @param bool $ignoreMissing only these values are allowed (integer|float|string|boolean|auto)
-     *
-     * @return $this
-     */
-    public function setIgnoreMissing(bool $ignoreMissing): self
-    {
-        return $this->setParam('ignore_missing', $ignoreMissing);
-    }
 }

src/Processor/Traits/IgnoreMissingTrait.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Elastica\Processor\Traits;
+
+trait IgnoreMissingTrait
+{
+    /**
+     * Set "ignore_missing" option.
+     */
+    public function setIgnoreMissing(bool $ignoreMissing): self
+    {
+        return $this->setParam('ignore_missing', $ignoreMissing);
+    }
+}

src/Processor/TrimProcessor.php

@@ -11,6 +11,8 @@
  */
 class TrimProcessor extends AbstractProcessor
 {
+    use Traits\IgnoreMissingTrait;
+
     public function __construct(string $field)
     {
         $this->setField($field);

src/Processor/UppercaseProcessor.php

@@ -11,6 +11,8 @@
  */
 class UppercaseProcessor extends AbstractProcessor
 {
+    use Traits\IgnoreMissingTrait;
+
     public function __construct(string $field)
     {
         $this->setField($field);

tests/Processor/LowercaseProcessorTest.php

@@ -28,6 +28,25 @@ public function testLowercase(): void
         $this->assertEquals($expected, $processor->toArray());
     }
 
+    /**
+     * @group unit
+     */
+    public function testLowercaseWithNonDefaultOptions(): void
+    {
+        $processor = (new LowercaseProcessor('foo'))
+            ->setIgnoreMissing(true)
+        ;
+
+        $expected = [
+            'lowercase' => [
+                'field' => 'foo',
+                'ignore_missing' => true,
+            ],
+        ];
+
+        $this->assertEquals($expected, $processor->toArray());
+    }
+
     /**
      * @group functional
      */

tests/Processor/RemoveProcessorTest.php

@@ -28,6 +28,25 @@ public function testRemove(): void
         $this->assertEquals($expected, $processor->toArray());
     }
 
+    /**
+     * @group unit
+     */
+    public function testRemoveWithNonDefaultOptions(): void
+    {
+        $processor = (new RemoveProcessor('foo'))
+            ->setIgnoreMissing(true)
+        ;
+
+        $expected = [
+            'remove' => [
+                'field' => 'foo',
+                'ignore_missing' => true,
+            ],
+        ];
+
+        $this->assertEquals($expected, $processor->toArray());
+    }
+
     /**
      * @group unit
      */

tests/Processor/TrimProcessorTest.php

@@ -28,6 +28,25 @@ public function testTrim(): void
         $this->assertEquals($expected, $processor->toArray());
     }
 
+    /**
+     * @group unit
+     */
+    public function testTrimWithNonDefaultOptions(): void
+    {
+        $processor = (new TrimProcessor('foo'))
+            ->setIgnoreMissing(true)
+        ;
+
+        $expected = [
+            'trim' => [
+                'field' => 'foo',
+                'ignore_missing' => true,
+            ],
+        ];
+
+        $this->assertEquals($expected, $processor->toArray());
+    }
+
     /**
      * @group functional
      */

tests/Processor/UppercaseProcessorTest.php

@@ -28,6 +28,25 @@ public function testUppercase(): void
         $this->assertEquals($expected, $processor->toArray());
     }
 
+    /**
+     * @group unit
+     */
+    public function testUppercaseWithNonDefaultOptions(): void
+    {
+        $processor = (new UppercaseProcessor('foo'))
+            ->setIgnoreMissing(true)
+        ;
+
+        $expected = [
+            'uppercase' => [
+                'field' => 'foo',
+                'ignore_missing' => true,
+            ],
+        ];
+
+        $this->assertEquals($expected, $processor->toArray());
+    }
+
     /**
      * @group functional
      */