change how to id is appended into object

this responsability was moved to Mapper, because the Mapper must know how to id is defined. fix Respect#9
tonicospinelli · Mar 23, 2016 · e523889 · e523889
1 parent 64a9e25
commit e523889
Show file tree

Hide file tree

Showing 15 changed files with 149 additions and 38 deletions.
diff --git a/src/Driver.php b/src/Driver.php
@@ -43,7 +43,7 @@ public function find($collection, array $query = []);
      * @param string $collection
      * @param object $document
      *
-     * @return void
+     * @return string Returns the inserted id for current document.
      */
     public function insert($collection, $document);
 
@@ -70,4 +70,10 @@ public function remove($collection, $criteria);
      * @return array
      */
     public function generateQuery(Collection $collection);
+
+    /**
+     * @param string|int $id
+     * @return string
+     */
+    public function createObjectId($id = null);
 }
diff --git a/src/Driver/DynamoDb/Driver.php b/src/Driver/DynamoDb/Driver.php
@@ -4,7 +4,6 @@
 
 use Aws\DynamoDb\DynamoDbClient;
 use Aws\DynamoDb\Marshaler;
-use Ramsey\Uuid\Uuid;
 use Ramsey\Uuid\UuidFactoryInterface;
 use Respect\Data\CollectionIterator;
 use Respect\Data\Collections\Collection;
@@ -75,6 +74,14 @@ public function setStyle(Stylable $style)
         return $this;
     }
 
+    public function createObjectId($id = null)
+    {
+        if (is_null($id)) {
+            $id = $this->uuid->uuid4()->toString();
+        }
+        return $id;
+    }
+
     /**
      * @param \Iterator $cursor
      *
@@ -154,7 +161,8 @@ protected function getConditionArray(Collection $collection)
         $condition = $collection->getCondition();
 
         if (!is_array($condition)) {
-            $condition = ['_id' => $condition];
+            $identifier = $this->getStyle()->identifier($collection->getName());
+            $condition = [$identifier => $condition];
         }
 
         $conditions = [];
@@ -174,8 +182,7 @@ protected function getConditionArray(Collection $collection)
     }
 
     /**
-     * @param Collection $collection
-     * @param $document
+     * {@inheritdoc}
      */
     public function insert($collection, $document)
     {
@@ -187,12 +194,15 @@ public function insert($collection, $document)
         ];
 
         $this->getConnection()->putItem($args);
+
+        $identifierName = $this->getStyle()->identifier($collection);
+        return $document->{$identifierName};
     }
 
     /**
      * @param Collection $collection
-     * @param $criteria
-     * @param $document
+     * @param            $criteria
+     * @param            $document
      */
     public function update($collection, $criteria, $document)
     {
@@ -207,7 +217,7 @@ public function update($collection, $criteria, $document)
 
     /**
      * @param Collection $collection
-     * @param $criteria
+     * @param            $criteria
      */
     public function remove($collection, $criteria)
     {

diff --git a/src/Driver/MongoDb/AbstractDriver.php b/src/Driver/MongoDb/AbstractDriver.php
@@ -19,13 +19,6 @@ abstract class AbstractDriver implements BaseDriver
      */
     abstract public function getDatabase();
 
-    /**
-     * @param int|string $id
-     *
-     * @return mixed
-     */
-    abstract public function createObjectId($id);
-
     /**
      * {@inheritdoc}
      */

diff --git a/src/Driver/MongoDb/Driver.php b/src/Driver/MongoDb/Driver.php
@@ -144,4 +144,14 @@ public function remove($collection, $criteria)
     {
         $this->getConnection()->remove($collection, $criteria);
     }
+
+    /**
+     * @param string $id
+     * @return string
+     */
+    public function createObjectId($id = null)
+    {
+        return $this->getConnection()->createObjectId($id);
+    }
+
 }
diff --git a/src/Driver/MongoDb/MongoDbDriver.php b/src/Driver/MongoDb/MongoDbDriver.php
@@ -43,7 +43,7 @@ public function getDatabase()
      *
      * @return ObjectID
      */
-    public function createObjectId($id)
+    public function createObjectId($id = null)
     {
         return new ObjectID($id);
     }
@@ -88,15 +88,12 @@ public function find($collection, array $query = [])
     }
 
     /**
-     * @param string $collection
-     * @param $document
-     *
-     * @return void
+     * {@inheritdoc}
      */
     public function insert($collection, $document)
     {
         $result = $this->getDatabase()->selectCollection($collection)->insertOne($document);
-        $document->_id = $result->getInsertedId();
+        return $result->getInsertedId();
     }
 
     public function update($collection, $criteria, $document)

diff --git a/src/Driver/MongoDb/MongoDriver.php b/src/Driver/MongoDb/MongoDriver.php
@@ -2,8 +2,6 @@
 
 namespace Respect\Structural\Driver\MongoDb;
 
-use Respect\Data\Collections\Collection;
-
 class MongoDriver extends AbstractDriver
 {
     /**
@@ -73,7 +71,7 @@ public function find($collection, array $query = [])
      *
      * @return \MongoId|\MongoInt32
      */
-    public function createObjectId($id)
+    public function createObjectId($id = null)
     {
         if (is_int($id)) {
             return new \MongoInt32($id);
@@ -83,14 +81,13 @@ public function createObjectId($id)
     }
 
     /**
-     * @param Collection $collection
-     * @param $document
-     *
-     * @return void
+     * {@inheritdoc}
      */
     public function insert($collection, $document)
     {
         $this->getDatabase()->selectCollection($collection)->insert($document);
+        $identifierName = $this->getStyle()->identifier($collection);
+        return $document->{$identifierName};
     }
 
     public function update($collection, $criteria, $document)

diff --git a/src/Mapper.php b/src/Mapper.php
@@ -3,6 +3,7 @@
 namespace Respect\Structural;
 
 use Exception;
+use Ramsey\Uuid\UuidFactoryInterface;
 use Respect\Data\AbstractMapper;
 use Respect\Data\CollectionIterator;
 use Respect\Data\Collections as c;
@@ -15,20 +16,30 @@ class Mapper extends AbstractMapper implements
     c\Mixable,
     c\Typable
 {
+    const ATTRIBUTTE_AUTO_GENERATE_ID = 'auto_generate_id';
+    const ATTRIBUTTE_AUTO_IDENTIFIER_HANDLER = 'auto_identifier_handler';
+
     /** @var \Respect\Structural\Driver Holds our connector* */
     protected $driver;
 
     /** @var string Namespace to look for entities * */
     public $entityNamespace = '\\';
 
+    /**
+     * @var array
+     */
+    protected $options;
+
     /**
      * @param Driver $driver
+     * @param array  $options
      */
-    public function __construct(Driver $driver)
+    public function __construct(Driver $driver, array $options = [])
     {
         parent::__construct();
 
         $this->driver = $driver;
+        $this->options = $options;
     }
 
     /**
@@ -157,6 +168,12 @@ protected function rawUpdate(array $columns, Collection $collection)
     protected function rawInsert(Collection $collection, $entity = null)
     {
         $name = $collection->getName();
+
+        $identifier = $this->getStyle()->identifier($name);
+
+        $generatedId = $this->driver->createObjectId();
+        $entity->{$identifier} = $generatedId;
+
         $this->driver->insert($name, $entity);
     }
 
@@ -395,4 +412,34 @@ public function getStyle()
     {
         return $this->driver->getStyle();
     }
+
+    /**
+     * @return bool
+     */
+    protected function isIdentifierAutoGenerated()
+    {
+        if (isset($this->options[self::ATTRIBUTTE_AUTO_GENERATE_ID])) {
+            return (bool) $this->options[self::ATTRIBUTTE_AUTO_GENERATE_ID];
+        }
+        return false;
+    }
+
+    /**
+     * @return UuidFactoryInterface
+     * @throws Mapper\Exception
+     */
+    protected function getIdentifierHandler()
+    {
+        $name = self::ATTRIBUTTE_AUTO_IDENTIFIER_HANDLER;
+
+        if (!$this->isIdentifierAutoGenerated()) {
+            throw \Respect\Structural\Mapper\Exception::disabledGenerateIdentifier();
+        }
+
+        if (!$this->options[$name] instanceof UuidFactoryInterface) {
+            throw \Respect\Structural\Mapper\Exception::notValidIdGenerator(get_class($this->options[$name]));
+        }
+
+        return $this->options[$name];
+    }
 }
diff --git a/src/Mapper/Exception.php b/src/Mapper/Exception.php
@@ -0,0 +1,20 @@
+<?php
+
+namespace Respect\Structural\Mapper;
+
+use Ramsey\Uuid\UuidFactoryInterface;
+use Respect\Structural\Mapper;
+
+class Exception extends \Exception
+{
+    public static function disabledGenerateIdentifier()
+    {
+        $name = Mapper::ATTRIBUTTE_AUTO_GENERATE_ID;
+        return new self("The id generator is disabled. Add a {$name} in options.");
+    }
+
+    public static function notValidIdGenerator($className)
+    {
+        return new self("The id generator is not and instance of " . UuidFactoryInterface::class . ", given a {$className}");
+    }
+}
diff --git a/tests/Driver/DynamoDb/DriverTest.php b/tests/Driver/DynamoDb/DriverTest.php
@@ -129,4 +129,11 @@ public function provideGenerateQueryShouldUsePartialResultSets()
             ]
         ];
     }
+
+    public function provideDataToInsert()
+    {
+        return [
+            'data with id' => [(object) ['name' => 'Test', '_id' => uniqid()]],
+        ];
+    }
 }
diff --git a/tests/Driver/DynamoDb/StyleTest.php b/tests/Driver/DynamoDb/StyleTest.php
@@ -1,12 +1,12 @@
 <?php
 
-namespace Respect\Structural\tests\Driver\DynamoDb;
+namespace Respect\Structural\Tests\Driver\DynamoDb;
 
 use Respect\Structural\Driver\DynamoDb\Style;
 
 class StyleTest extends \PHPUnit_Framework_TestCase
 {
-    public function testShouldRetrieveIdenfier()
+    public function testShouldRetrieveIdentifier()
     {
         $this->assertEquals('_id', (new Style())->identifier('id'));
     }

diff --git a/tests/Driver/MongoDb/DriverTest.php b/tests/Driver/MongoDb/DriverTest.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Respect\Structural\tests\Driver\MongoDb;
+namespace Respect\Structural\Tests\Driver\MongoDb;
 
 use Respect\Data\Collections\Collection;
 use Respect\Structural\Driver\MongoDb\Driver;

diff --git a/tests/Driver/MongoDb/MongoDbDriverTest.php b/tests/Driver/MongoDb/MongoDbDriverTest.php
@@ -182,4 +182,11 @@ public function provideCollectionAndSearchShouldRetrieveFilledResult()
             ],
         ];
     }
+    public function provideDataToInsert()
+    {
+        return [
+            'data without id' => [(object) ['name' => 'Test']],
+        ];
+    }
+
 }
diff --git a/tests/Driver/MongoDb/MongoDriverTest.php b/tests/Driver/MongoDb/MongoDriverTest.php
@@ -170,4 +170,12 @@ public function provideCollectionAndSearchShouldRetrieveFilledResult()
             ],
         ];
     }
+
+    public function provideDataToInsert()
+    {
+        return [
+            'data without id' => [(object) ['name' => 'Test']],
+        ];
+    }
+
 }
diff --git a/tests/Driver/TestCase.php b/tests/Driver/TestCase.php
@@ -76,6 +76,11 @@ abstract public function provideGenerateQueryShouldUsePartialResultSets();
      */
     abstract public function provideCollectionAndSearchShouldRetrieveFilledResult();
 
+    /**
+     * @return array
+     */
+    abstract public function provideDataToInsert();
+
     /**
      * @param string $method
      * @param mixed  $result
@@ -185,14 +190,15 @@ public function testGenerateQueryShouldUsePartialResultSets(Collection $mappedCo
         $this->assertEquals($expectedResult, $result);
     }
 
-    public function testInsertDataShouldRetrieveId()
+    /**
+     * @param $document
+     * @dataProvider provideDataToInsert
+     */
+    public function testInsertDataShouldRetrieveId($document)
     {
-        $data = new \stdClass();
-        $data->name = 'Test';
-
-        $this->createDriver($this->getMockConnectionInsertOne())->insert('author', $data);
+        $id = $this->createDriver($this->getMockConnectionInsertOne())->insert('author', $document);
 
-        $this->assertObjectHasAttribute('_id', $data);
+        $this->assertNotEmpty($id);
     }
 
     public function testUpdateDataShouldWithSuccess()

diff --git a/tests/MapperTest.php b/tests/MapperTest.php
@@ -11,11 +11,14 @@ class MapperTest extends \PHPUnit_Framework_TestCase
     public function testInsertANewDocument()
     {
         $style = $this->getMockForAbstractClass(Stylable::class);
+        $style->expects($this->once())->method('identifier')->willReturn('id');
 
         $driver = $this->getMockForAbstractClass(Driver::class);
         $driver->expects($this->once())->method('insert')->willReturnCallback(function ($collection, $document) {
             $document->id = 1;
         });
+        $driver->expects($this->once())->method('getStyle')->willReturn($style);
+
 
         $mapper = new Mapper($driver);