Merge pull request #2 from CubiclDev/circular-refs

Circular refs

Author: 1blankz7

.gitignore

@@ -1,6 +1,2 @@
-composer.phar
+.idea/
 /vendor/
-
-# Commit your application's lock file https://getcomposer.org/doc/01-basic-usage.md#commit-your-composer-lock-file-to-version-control
-# You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file
-# composer.lock

README.md

@@ -1 +1,13 @@
-# php-object-graph-generator
+# PHP Object Graph Generator
+
+This library helps you creating randomly populated object graphs inside your domain.
+
+## Installation
+
+```
+composer install cubicl/php-object-graph-generator
+```
+
+## Usage
+
+Support for factories, factory methods and constructor calls.

composer.lock

@@ -6,4 +6,9 @@
     convertErrorsToExceptions   = "true"
     convertNoticesToExceptions  = "true"
     convertWarningsToExceptions = "true">
+  <testsuites>
+    <testsuite name="Unit">
+      <directory suffix="Test.php">./tests/</directory>
+    </testsuite>
+  </testsuites>
 </phpunit>

phpunit.xml

@@ -0,0 +1,11 @@
+<?php
+
+namespace Cubicl\ObjectGraphGenerator;
+
+use Cubicl\ObjectGraphGenerator\ObjectGraphGenerator;
+use Faker\Generator;
+
+interface FactoryInterface
+{
+    public function __invoke(ObjectGraphGenerator $objectGraphGenerator, Generator $faker): object;
+}

src/FactoryInterface.php

@@ -17,29 +17,37 @@
 
 class ObjectGraphGenerator
 {
+    private const DEFAULT_SEED = 1;
     private Generator $fakerInstance;
 
     private PropertyInfoExtractor $propertyInfo;
 
-    private array $registry = [];
+    private array $registry;
 
-    public function __construct()
+    public function __construct(array $registry = [])
     {
         $this->fakerInstance = Factory::create();
 
         $phpDocExtractor     = new PhpDocExtractor();
         $reflectionExtractor = new ReflectionExtractor();
         $typeExtractors      = [$phpDocExtractor, $reflectionExtractor];
         $this->propertyInfo  = new PropertyInfoExtractor([], $typeExtractors, [], [], []);
+        $this->fakerInstance->seed(self::DEFAULT_SEED);
+        $this->registry = $registry;
     }
 
-    public function generate(string $className, int $seed): object
+    public function generateWithSeed(string $className, int $seed): object
     {
         $this->fakerInstance->seed($seed);
 
         return $this->generateObject($className);
     }
 
+    public function generate(string $className): object
+    {
+        return $this->generateObject($className);
+    }
+
     /**
      * @param string $className
      *
@@ -139,6 +147,6 @@ private function isInRegistry(string $key): bool
 
     private function getFromRegistry(string $key)
     {
-        return $this->registry[$key]();
+        return $this->registry[$key]($this, $this->fakerInstance);
     }
 }

src/ObjectGraphGenerator.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Cubicl\ObjectGraphGenerator\Tests\Fixture;
+
+class CircularReferenceObjectA
+{
+    /** @var CircularReferenceObjectB|null */
+    private $objectB;
+
+    public function getObjectB(): ?CircularReferenceObjectB
+    {
+        return $this->objectB;
+    }
+
+    public function setObjectB(?CircularReferenceObjectB $objectB): void
+    {
+        $this->objectB = $objectB;
+    }
+}

tests/Fixture/CircularReferenceObjectA.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Cubicl\ObjectGraphGenerator\Tests\Fixture;
+
+class CircularReferenceObjectB
+{
+    /** @var CircularReferenceObjectA|null */
+    private $objectA;
+
+    public function getObjectA(): ?CircularReferenceObjectA
+    {
+        return $this->objectA;
+    }
+
+    public function setObjectA(CircularReferenceObjectA $objectA): void
+    {
+        $this->objectA = $objectA;
+    }
+
+
+}

tests/Fixture/CircularReferenceObjectB.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Cubicl\ObjectGraphGenerator\Tests\Fixture\Factory;
+
+use Cubicl\ObjectGraphGenerator\FactoryInterface;
+use Cubicl\ObjectGraphGenerator\ObjectGraphGenerator;
+use Cubicl\ObjectGraphGenerator\Tests\Fixture\SelfReferencingObjects;
+use Faker\Generator;
+
+class SelfReferencingObjectsFactory implements FactoryInterface
+{
+    public function __invoke(ObjectGraphGenerator $objectGraphGenerator, Generator $faker): SelfReferencingObjects
+    {
+        return new SelfReferencingObjects(null, 1);
+    }
+}

tests/Fixture/Factory/SelfReferencingObjectsFactory.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Cubicl\ObjectGraphGenerator\Tests\Fixture;
+
+class SelfReferencingObjects
+{
+    /** @var SelfReferencingObjects|null */
+    private $reference;
+
+    /** @var int */
+    private $number;
+
+    public function __construct(?SelfReferencingObjects $reference, int $number)
+    {
+        $this->reference = $reference;
+        $this->number    = $number;
+    }
+
+    public function getReference(): ?SelfReferencingObjects
+    {
+        return $this->reference;
+    }
+
+    public function getNumber(): int
+    {
+        return $this->number;
+    }
+
+}