Implemented nullable association using empty

Tharos · Mar 2, 2017 · 330005d · 330005d
1 parent c5b56dd
commit 330005d
Show file tree

Hide file tree

Showing 3 changed files with 107 additions and 16 deletions.
diff --git a/src/Schematic/Entry.php b/src/Schematic/Entry.php
@@ -11,6 +11,7 @@ class Entry
 	const INDEX_ENTRYCLASS = 0;
 	const INDEX_MULTIPLICITY = 1;
 	const INDEX_EMBEDDING = 2;
+	const INDEX_NULLABLE = 3;
 
 	/**
 	 * @var array
@@ -64,18 +65,19 @@ private static function parseAssociations($class)
 
 		foreach (static::$associations as $association => $entryClass) {
 			$matches = [];
-			$result = preg_match('#^([^.[\]]+)(\.[^.[\]]*)?(\[\])?$#', $association, $matches);
+			$result = preg_match('#^(\?)?([^.[\]]+)(\.[^.[\]]*)?(\[\])?$#', $association, $matches);
 
-			if ($result === 0 || (!empty($matches[2]) && !empty($matches[3]))) {
+			if ($result === 0 || (!empty($matches[3]) && !empty($matches[4]))) {
 				throw new InvalidArgumentException('Invalid association definition given: ' . $association);
 			}
 
-			self::$parsedAssociations[$class][$matches[1]] = [
+			self::$parsedAssociations[$class][$matches[2]] = [
 				self::INDEX_ENTRYCLASS => $entryClass,
-				self::INDEX_MULTIPLICITY => !empty($matches[3]),
-				self::INDEX_EMBEDDING => !empty($matches[2]) ?
-					($matches[2] === '.' ? $matches[1] . '_' : substr($matches[2], 1)) :
+				self::INDEX_MULTIPLICITY => !empty($matches[4]),
+				self::INDEX_EMBEDDING => !empty($matches[3]) ?
+					($matches[3] === '.' ? $matches[2] . '_' : substr($matches[3], 1)) :
 					FALSE,
+				self::INDEX_NULLABLE => !empty($matches[1]),
 			];
 		}
 	}
@@ -101,15 +103,18 @@ public function __get($name)
 			$this->readEmbeddedEntry($association[self::INDEX_EMBEDDING]) :
 			$this->readData($name);
 
-		if ($data === NULL) {
+		if (!$association[self::INDEX_MULTIPLICITY] && (
+		    $data === NULL
+            || ($association[self::INDEX_NULLABLE] && empty($data))
+        )) {
 			return $this->data[$name] = NULL;
 		}
 
 		$entryClass = $association[self::INDEX_ENTRYCLASS];
 		$entriesClass = $this->entriesClass;
 
 		return $this->data[$name] = $association[self::INDEX_MULTIPLICITY] ?
-			new $entriesClass($data, $entryClass) :
+			new $entriesClass((array) $data, $entryClass) :
 			new $entryClass($data, $this->entriesClass);
 	}
 

diff --git a/tests/SchematicTests/EntryTest.phpt b/tests/SchematicTests/EntryTest.phpt
@@ -55,8 +55,35 @@ class EntryTest extends TestCase
 		Assert::same(100, $order->customer->id);
 	}
 
+    /**
+     * @dataProvider provideDataNullableRelation
+     */
+	public function testEntriesAccessToNullableParameter($customer)
+	{
+		$order = new Order([
+			'customer' => $customer,
+			'orderItems' => [],
+		]);
+		Assert::null($order->customer);
+	}
+
 
-	public function testEntriesClass()
+    public function provideDataNullableRelation()
+	{
+	    return [
+	        [[]],
+	        [false],
+	        [null],
+	        [0],
+	        [0.0],
+	        [''],
+        ];
+	}
+
+    /**
+     * @dataProvider provideDataNullableCollection
+     */
+	public function testEntriesClass($lastCollectionValue)
 	{
 		$order = new Order([
 			'orderItems' => [
@@ -71,6 +98,10 @@ class EntryTest extends TestCase
 					'id' => 2,
 					'tags' => [],
 				],
+				[
+					'id' => 3,
+					'tags' => $lastCollectionValue,
+				],
 			],
 		], CustomEntries::class);
 
@@ -79,18 +110,37 @@ class EntryTest extends TestCase
 		$orderItems = $order->orderItems->toArray();
 		/** @var OrderItem $firstOrderItem */
 		$firstOrderItem = reset($orderItems);
+		/** @var OrderItem $lastOrderItem */
+		$lastOrderItem = end($orderItems);
 
 		Assert::type(CustomEntries::class, $firstOrderItem->tags);
+		Assert::type(CustomEntries::class, $lastOrderItem->tags);
 	}
 
 
-	public function testEmbeddedEntries()
+	public function provideDataNullableCollection()
+	{
+	    return [
+	        [[]],
+	        [false],
+	        [null],
+	        [0],
+	        [0.0],
+	        [''],
+        ];
+	}
+
+    /**
+     * @dataProvider provideDataNullableCustomer
+     */
+	public function testEmbeddedEntries($customerId, $customerName)
 	{
 		$book = new Book([
 			'id' => 12,
 			'title' => 'PHP: The Bad Parts',
 			'tag_name' => 'bestseller',
-			'customer_id' => 20,
+			'customer_id' => $customerId,
+			'customer_name' => $customerName,
 			'a_firstname' => 'John',
 			'a_surname' => 'Doe',
 		]);
@@ -99,7 +149,41 @@ class EntryTest extends TestCase
 		Assert::same('bestseller', $book->tag->name);
 
 		Assert::type(Customer::class, $book->customer);
-		Assert::same(20, $book->customer->id);
+		Assert::same($customerId, $book->customer->id);
+		Assert::same($customerName, $book->customer->name);
+
+		Assert::type(Author::class, $book->author);
+		Assert::same('John', $book->author->firstname);
+		Assert::same('Doe', $book->author->surname);
+	}
+
+
+    public function provideDataNullableCustomer()
+	{
+	    return [
+	        [20, 'Jack'],
+	        [null, 'Jack'],
+	        [20, null],
+        ];
+	}
+
+
+	public function testNullableEmbeddedEntries()
+	{
+		$book = new Book([
+			'id' => 12,
+			'title' => 'PHP: The Bad Parts',
+			'tag_name' => 'bestseller',
+			'customer_id' => null,
+			'customer_name' => null,
+			'a_firstname' => 'John',
+			'a_surname' => 'Doe',
+		]);
+
+		Assert::type(Tag::class, $book->tag);
+		Assert::same('bestseller', $book->tag->name);
+
+		Assert::null($book->customer);
 
 		Assert::type(Author::class, $book->author);
 		Assert::same('John', $book->author->firstname);

diff --git a/tests/SchematicTests/entries.php b/tests/SchematicTests/entries.php
@@ -26,7 +26,7 @@ class Order extends Identified
 {
 
 	protected static $associations = [
-		'customer' => Customer::class,
+		'?customer' => Customer::class,
 		'orderItems[]' => OrderItem::class,
 	];
 
@@ -40,12 +40,14 @@ class OrderItem extends Identified
 {
 
 	protected static $associations = [
-		'tags[]' => Tag::class,
+		'?tags[]' => Tag::class,
 	];
 
 }
 
-
+/**
+ * @property-read string|null $name
+ */
 class Customer extends Identified
 {
 
@@ -88,7 +90,7 @@ class Book extends Identified
 
 	protected static $associations = [
 		'tag.' => Tag::class,
-		'customer.' => Customer::class,
+		'?customer.' => Customer::class,
 		'author.a_' => Author::class,
 	];