Composition replaced with inheritance for write models

Petr Buchyn · Petr Buchyn · commit afbc1aeabf31 · 2017-05-01T18:40:44.000+03:00
diff --git a/src/Collection.php b/src/Collection.php
@@ -7,7 +7,6 @@
 use MongoDB\Driver\ReadConcern;
 use MongoDB\Driver\ReadPreference;
 use MongoDB\Driver\WriteConcern;
-use Tequila\MongoDB\OptionsResolver\BulkWrite\UpdateDocumentResolver;
 use Tequila\MongoDB\OptionsResolver\CollectionOptionsResolver;
 use Tequila\MongoDB\OptionsResolver\Command\FindOneAndDeleteResolver;
 use Tequila\MongoDB\OptionsResolver\Command\FindOneAndUpdateResolver;
@@ -429,7 +428,7 @@ public function findOneAndReplace(array $filter, $replacement, array $options =
      */
     public function findOneAndUpdate(array $filter, array $update, array $options = [])
     {
-        UpdateDocumentResolver::resolveStatic($update);
+        \Tequila\MongoDB\ensureValidUpdate($update);
 
         $options = ['update' => (object) $update] + FindOneAndUpdateResolver::resolveStatic($options);
 
diff --git a/src/OptionsResolver/BulkWrite/DeleteOptionsResolver.php b/src/OptionsResolver/BulkWrite/DeleteOptionsResolver.php
@@ -5,7 +5,7 @@
 use Tequila\MongoDB\OptionsResolver\Configurator\CollationConfigurator;
 use Tequila\MongoDB\OptionsResolver\OptionsResolver;
 
-class DeleteResolver extends OptionsResolver
+class DeleteOptionsResolver extends OptionsResolver
 {
     protected function configureOptions()
     {
diff --git a/src/OptionsResolver/BulkWrite/UpdateDocumentResolver.php b/src/OptionsResolver/BulkWrite/UpdateDocumentResolver.php
diff --git a/src/OptionsResolver/BulkWrite/UpdateOptionsResolver.php b/src/OptionsResolver/BulkWrite/UpdateOptionsResolver.php
@@ -5,7 +5,7 @@
 use Tequila\MongoDB\OptionsResolver\Configurator\CollationConfigurator;
 use Tequila\MongoDB\OptionsResolver\OptionsResolver;
 
-class UpdateResolver extends OptionsResolver
+class UpdateOptionsResolver extends OptionsResolver
 {
     protected function configureOptions()
     {
@@ -16,7 +16,8 @@ protected function configureOptions()
             'multi',
         ]);
 
-        $this->setAllowedTypes('upsert', 'bool');
-        $this->setAllowedTypes('multi', 'bool');
+        $this
+            ->setAllowedTypes('upsert', 'bool')
+            ->setAllowedTypes('multi', 'bool');
     }
 }
diff --git a/src/OptionsResolver/ReadWriteOptionsResolver.php b/src/OptionsResolver/ReadWriteOptionsResolver.php
diff --git a/src/Write/Model/Delete.php b/src/Write/Model/Delete.php
@@ -3,7 +3,7 @@
 namespace Tequila\MongoDB\Write\Model;
 
 use Tequila\MongoDB\BulkWrite;
-use Tequila\MongoDB\OptionsResolver\BulkWrite\DeleteResolver;
+use Tequila\MongoDB\OptionsResolver\BulkWrite\DeleteOptionsResolver;
 use Tequila\MongoDB\WriteModelInterface;
 
 class Delete implements WriteModelInterface
@@ -25,7 +25,7 @@ class Delete implements WriteModelInterface
     public function __construct(array $filter, array $options = [])
     {
         $this->filter = $filter;
-        $this->options = DeleteResolver::resolveStatic($options);
+        $this->options = DeleteOptionsResolver::resolveStatic($options);
     }
 
     /**
diff --git a/src/Write/Model/DeleteMany.php b/src/Write/Model/DeleteMany.php
@@ -2,20 +2,15 @@
 
 namespace Tequila\MongoDB\Write\Model;
 
-use Tequila\MongoDB\Write\Model\Traits\BulkDeleteTrait;
-use Tequila\MongoDB\WriteModelInterface;
-
-class DeleteMany implements WriteModelInterface
+class DeleteMany extends Delete
 {
-    use BulkDeleteTrait;
-
     /**
      * @param array $filter
      * @param array $options
      */
     public function __construct(array $filter, array $options = [])
     {
         $options = ['limit' => 0] + $options;
-        $this->delete = new Delete($filter, $options);
+        parent::__construct($filter, $options);
     }
 }
diff --git a/src/Write/Model/DeleteOne.php b/src/Write/Model/DeleteOne.php
@@ -2,20 +2,15 @@
 
 namespace Tequila\MongoDB\Write\Model;
 
-use Tequila\MongoDB\Write\Model\Traits\BulkDeleteTrait;
-use Tequila\MongoDB\WriteModelInterface;
-
-class DeleteOne implements WriteModelInterface
+class DeleteOne extends Delete
 {
-    use BulkDeleteTrait;
-
     /**
      * @param array $filter
      * @param array $options
      */
     public function __construct(array $filter, array $options = [])
     {
         $options = ['limit' => 1] + $options;
-        $this->delete = new Delete($filter, $options);
+        parent::__construct($filter, $options);
     }
 }
diff --git a/src/Write/Model/ReplaceOne.php b/src/Write/Model/ReplaceOne.php
@@ -3,14 +3,9 @@
 namespace Tequila\MongoDB\Write\Model;
 
 use Tequila\MongoDB\Exception\InvalidArgumentException;
-use Tequila\MongoDB\Write\Model\Traits\BulkUpdateTrait;
-use function Tequila\MongoDB\ensureValidDocument;
-use Tequila\MongoDB\WriteModelInterface;
 
-class ReplaceOne implements WriteModelInterface
+class ReplaceOne extends Update
 {
-    use BulkUpdateTrait;
-
     /**
      * @param $filter
      * @param array|object $replacement
@@ -28,14 +23,15 @@ public function __construct(array $filter, $replacement, array $options = [])
         }
 
         try {
-            ensureValidDocument($replacement);
+            \Tequila\MongoDB\ensureValidDocument($replacement);
         } catch (InvalidArgumentException $e) {
             throw new InvalidArgumentException(
                 sprintf('Invalid $replacement document: %s', $e->getMessage())
             );
         }
 
         $options = ['multi' => false] + $options;
-        $this->update = new Update($filter, $replacement, $options);
+
+        parent::__construct($filter, $replacement, $options);
     }
 }
diff --git a/src/Write/Model/Traits/BulkDeleteTrait.php b/src/Write/Model/Traits/BulkDeleteTrait.php
diff --git a/src/Write/Model/Traits/BulkUpdateTrait.php b/src/Write/Model/Traits/BulkUpdateTrait.php
diff --git a/src/Write/Model/Update.php b/src/Write/Model/Update.php
@@ -3,7 +3,7 @@
 namespace Tequila\MongoDB\Write\Model;
 
 use Tequila\MongoDB\BulkWrite;
-use Tequila\MongoDB\OptionsResolver\BulkWrite\UpdateResolver;
+use Tequila\MongoDB\OptionsResolver\BulkWrite\UpdateOptionsResolver;
 use Tequila\MongoDB\WriteModelInterface;
 
 class Update implements WriteModelInterface
@@ -32,7 +32,7 @@ public function __construct(array $filter, $update, array $options = [])
     {
         $this->filter = $filter;
         $this->update = $update;
-        $this->options = UpdateResolver::resolveStatic($options);
+        $this->options = UpdateOptionsResolver::resolveStatic($options);
     }
 
     /**
diff --git a/src/Write/Model/UpdateMany.php b/src/Write/Model/UpdateMany.php
@@ -2,24 +2,18 @@
 
 namespace Tequila\MongoDB\Write\Model;
 
-use Tequila\MongoDB\OptionsResolver\BulkWrite\UpdateDocumentResolver;
-use Tequila\MongoDB\Write\Model\Traits\BulkUpdateTrait;
-use Tequila\MongoDB\WriteModelInterface;
-
-class UpdateMany implements WriteModelInterface
+class UpdateMany extends Update
 {
-    use BulkUpdateTrait;
-
     /**
      * @param array $filter
      * @param array $update
      * @param array $options
      */
     public function __construct(array $filter, array $update, array $options = [])
     {
-        $update = UpdateDocumentResolver::resolveStatic($update);
+        \Tequila\MongoDB\ensureValidUpdate($update);
         $options = ['multi' => true] + $options;
 
-        $this->update = new Update($filter, $update, $options);
+        parent::__construct($filter, $update, $options);
     }
 }
diff --git a/src/Write/Model/UpdateOne.php b/src/Write/Model/UpdateOne.php
@@ -2,24 +2,18 @@
 
 namespace Tequila\MongoDB\Write\Model;
 
-use Tequila\MongoDB\OptionsResolver\BulkWrite\UpdateDocumentResolver;
-use Tequila\MongoDB\Write\Model\Traits\BulkUpdateTrait;
-use Tequila\MongoDB\WriteModelInterface;
-
-class UpdateOne implements WriteModelInterface
+class UpdateOne extends Update
 {
-    use BulkUpdateTrait;
-
     /**
      * @param array $filter
      * @param array $update
      * @param array $options
      */
     public function __construct(array $filter, array $update, array $options = [])
     {
-        $update = UpdateDocumentResolver::resolveStatic($update);
+        \Tequila\MongoDB\ensureValidUpdate($update);
         $options = ['multi' => false] + $options;
 
-        $this->update = new Update($filter, $update, $options);
+        parent::__construct($filter, $update, $options);
     }
 }
diff --git a/src/functions.php b/src/functions.php
@@ -25,16 +25,28 @@ function ensureValidDocument($document)
     }
 
     $arrayDocument = (array) $document;
+    $firstFieldName = key($arrayDocument);
+    if (!preg_match('/^[^$][^\.]*$/', $firstFieldName)) {
+        throw new InvalidArgumentException(
+            sprintf(
+                'Invalid field name "%s": field names cannot start with a dollar sign ("$") and cannot contain dots.',
+                $firstFieldName
+            )
+        );
+    }
+}
+
+function ensureValidUpdate(array $update)
+{
+    $firstOperator = key($update);
 
-    foreach ($arrayDocument as $fieldName => $value) {
-        if (!preg_match('/^[^$][^\.]*$/', $fieldName)) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    'Invalid field name "%s": field names cannot start with a dollar sign ("$") and cannot contain dots.',
-                    $fieldName
-                )
-            );
-        }
+    if ('$' !== substr($firstOperator, 0, 1)) {
+        throw new InvalidArgumentException(
+            sprintf(
+                'Invalid $update document: first key "%s" is not an update operator.',
+                $firstOperator
+            )
+        );
     }
 }
 

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`	`use Tequila\MongoDB\OptionsResolver\Configurator\CollationConfigurator;`
`6`	`6`	`use Tequila\MongoDB\OptionsResolver\OptionsResolver;`
`7`	`7`
`8`		`-class DeleteResolver extends OptionsResolver`
	`8`	`+class DeleteOptionsResolver extends OptionsResolver`
`9`	`9`	`{`
`10`	`10`	`protected function configureOptions()`
`11`	`11`	`{`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`namespace Tequila\MongoDB\Write\Model;`
`4`	`4`
`5`	`5`	`use Tequila\MongoDB\BulkWrite;`
`6`		`-use Tequila\MongoDB\OptionsResolver\BulkWrite\DeleteResolver;`
	`6`	`+use Tequila\MongoDB\OptionsResolver\BulkWrite\DeleteOptionsResolver;`
`7`	`7`	`use Tequila\MongoDB\WriteModelInterface;`
`8`	`8`
`9`	`9`	`class Delete implements WriteModelInterface`
`@@ -25,7 +25,7 @@ class Delete implements WriteModelInterface`
`25`	`25`	`public function __construct(array $filter, array $options = [])`
`26`	`26`	`{`
`27`	`27`	`$this->filter = $filter;`
`28`		`- $this->options = DeleteResolver::resolveStatic($options);`
	`28`	`+ $this->options = DeleteOptionsResolver::resolveStatic($options);`
`29`	`29`	`}`
`30`	`30`
`31`	`31`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -2,20 +2,15 @@`
`2`	`2`
`3`	`3`	`namespace Tequila\MongoDB\Write\Model;`
`4`	`4`
`5`		`-use Tequila\MongoDB\Write\Model\Traits\BulkDeleteTrait;`
`6`		`-use Tequila\MongoDB\WriteModelInterface;`
`7`		`-`
`8`		`-class DeleteMany implements WriteModelInterface`
	`5`	`+class DeleteMany extends Delete`
`9`	`6`	`{`
`10`		`- use BulkDeleteTrait;`
`11`		`-`
`12`	`7`	`/**`
`13`	`8`	`* @param array $filter`
`14`	`9`	`* @param array $options`
`15`	`10`	`*/`
`16`	`11`	`public function __construct(array $filter, array $options = [])`
`17`	`12`	`{`
`18`	`13`	`$options = ['limit' => 0] + $options;`
`19`		`- $this->delete = new Delete($filter, $options);`
	`14`	`+ parent::__construct($filter, $options);`
`20`	`15`	`}`
`21`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,14 +3,9 @@`
`3`	`3`	`namespace Tequila\MongoDB\Write\Model;`
`4`	`4`
`5`	`5`	`use Tequila\MongoDB\Exception\InvalidArgumentException;`
`6`		`-use Tequila\MongoDB\Write\Model\Traits\BulkUpdateTrait;`
`7`		`-use function Tequila\MongoDB\ensureValidDocument;`
`8`		`-use Tequila\MongoDB\WriteModelInterface;`
`9`	`6`
`10`		`-class ReplaceOne implements WriteModelInterface`
	`7`	`+class ReplaceOne extends Update`
`11`	`8`	`{`
`12`		`- use BulkUpdateTrait;`
`13`		`-`
`14`	`9`	`/**`
`15`	`10`	`* @param $filter`
`16`	`11`	`* @param array\|object $replacement`
`@@ -28,14 +23,15 @@ public function __construct(array $filter, $replacement, array $options = [])`
`28`	`23`	`}`
`29`	`24`
`30`	`25`	`try {`
`31`		`- ensureValidDocument($replacement);`
	`26`	`+ \Tequila\MongoDB\ensureValidDocument($replacement);`
`32`	`27`	`} catch (InvalidArgumentException $e) {`
`33`	`28`	`throw new InvalidArgumentException(`
`34`	`29`	`sprintf('Invalid $replacement document: %s', $e->getMessage())`
`35`	`30`	`);`
`36`	`31`	`}`
`37`	`32`
`38`	`33`	`$options = ['multi' => false] + $options;`
`39`		`- $this->update = new Update($filter, $replacement, $options);`
	`34`	`+`
	`35`	`+ parent::__construct($filter, $replacement, $options);`
`40`	`36`	`}`
`41`	`37`	`}`