Implement Populator (#450)

fixtures/Nelmio/Alice/Definition/Fixture/DummyFixture.php

@@ -22,12 +22,11 @@ class DummyFixture implements FixtureInterface
     /**
      * @var string
      */
-    private $reference;
+    private $id;
 
-    public function __construct(string $reference)
+    public function __construct(string $id)
     {
-        $this->id = __CLASS__.'#'.$reference;
-        $this->reference = $reference;
+        $this->id = $id;
     }
 
     /**
@@ -38,14 +37,6 @@ public function getId(): string
         return $this->id;
     }
 
-    /**
-     * @inheritdoc
-     */
-    public function getReference(): string
-    {
-        return $this->reference;
-    }
-
     /**
      * @inheritdoc
      */

fixtures/Nelmio/Alice/Definition/Fixture/FakeFixture.php

@@ -27,14 +27,6 @@ public function getId(): string
         $this->__call();
     }
 
-    /**
-     * @inheritdoc
-     */
-    public function getReference(): string
-    {
-        $this->__call();
-    }
-
     /**
      * @inheritdoc
      */

fixtures/Nelmio/Alice/Generator/Hydrator/FakeHydrator.php

@@ -0,0 +1,30 @@
+<?php
+
+/*
+ * This file is part of the Alice package.
+ *
+ * (c) Nelmio <hello@nelm.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Nelmio\Alice\Generator\Hydrator;
+
+use Nelmio\Alice\Definition\Property;
+use Nelmio\Alice\Generator\HydratorInterface;
+use Nelmio\Alice\NotCallableTrait;
+use Nelmio\Alice\ObjectInterface;
+
+class FakeHydrator implements HydratorInterface
+{
+    use NotCallableTrait;
+
+    /**
+     * @inheritdoc
+     */
+    public function hydrate(ObjectInterface $object, Property $property): ObjectInterface
+    {
+        $this->__call();
+    }
+}

src/Nelmio/Alice/Definition/Fixture/FixtureWithFlags.php

@@ -43,14 +43,6 @@ public function getId(): string
     {
         return $this->fixture->getId();
     }
-
-    /**
-     * @inheritdoc
-     */
-    public function getReference(): string
-    {
-        return $this->fixture->getReference();
-    }
 
     /**
      * @inheritdoc

src/Nelmio/Alice/Definition/Fixture/SimpleFixture.php

@@ -24,11 +24,6 @@ final class SimpleFixture implements FixtureInterface
      */
     private $id;
 
-    /**
-     * @var string
-     */
-    private $reference;
-
     /**
      * @var string
      */
@@ -39,11 +34,10 @@ final class SimpleFixture implements FixtureInterface
      */
     private $specs;
 
-    public function __construct(string $reference, string $className, SpecificationBag $specs)
+    public function __construct(string $id, string $className, SpecificationBag $specs)
     {
-        $this->id = $className.'#'.$reference;
+        $this->id = $id;
         $this->className = $className;
-        $this->reference = $reference;
         $this->specs = $specs;
     }
 
@@ -55,14 +49,6 @@ public function getId(): string
         return $this->id;
     }
 
-    /**
-     * @inheritdoc
-     */
-    public function getReference(): string
-    {
-        return $this->reference;
-    }
-
     /**
      * @inheritdoc
      */

src/Nelmio/Alice/Definition/Fixture/Templating.php

@@ -45,7 +45,7 @@ public function __construct(FixtureWithFlags $fixture)
 
             if ($flag instanceof ExtendFlag) {
                 // Potential flag duplication is handled at the flagbag level
-                $this->extends[] = $flag->getExtendedFixture()->createAbsoluteFrom($fixture);
+                $this->extends[] = $flag->getExtendedFixture();
             }
         }
     }

src/Nelmio/Alice/Definition/Fixture/TemplatingFixture.php

@@ -47,14 +47,6 @@ public function getId(): string
         return $this->fixture->getId();
     }
 
-    /**
-     * @inheritdoc
-     */
-    public function getReference(): string
-    {
-        return $this->fixture->getReference();
-    }
-
     /**
      * @inheritdoc
      */

src/Nelmio/Alice/Definition/Flag/ExtendFlag.php

@@ -38,7 +38,7 @@ final class ExtendFlag implements FlagInterface
     public function __construct(FixtureReference $extendedFixture)
     {
         $this->extendedFixture = $extendedFixture;
-        $this->stringValue = 'extends '.$extendedFixture->getReference();
+        $this->stringValue = 'extends '.$extendedFixture->getId();
     }
 
     public function getExtendedFixture(): FixtureReference

src/Nelmio/Alice/Definition/MethodCall/MethodCallWithReference.php

@@ -53,7 +53,7 @@ public function __construct(ServiceReferenceInterface $caller, string $method, a
         $this->caller = $caller;
         $this->method = $method;
         $this->arguments = $arguments;
-        $this->stringValue = $caller->getReference().$method;
+        $this->stringValue = $caller->getId().$method;
     }
 
     /**

src/Nelmio/Alice/Definition/Object/SimpleObject.php

@@ -43,7 +43,17 @@ public function __construct(string $reference, $instance)
         $this->reference = $reference;
         $this->instance = $instance;
     }
-
+
+    /**
+     * @param \object $newInstance
+     *
+     * @return SimpleObject
+     */
+    public function withInstance($newInstance): self
+    {
+        return new self($this->reference, $newInstance);
+    }
+
     public function getReference(): string
     {
         return $this->reference;
@@ -56,7 +66,7 @@ public function getInstance()
     {
         return clone $this->instance;
     }
-    
+
     public function __clone()
     {
         $this->instance = clone $this->instance;

src/Nelmio/Alice/Definition/Property.php

@@ -40,6 +40,16 @@ public function __construct(string $name, $value)
         $this->value = $value;
     }
 
+    /**
+     * param ValueInterface|mixed $value
+     *
+     * @return self
+     */
+    public function withValue($value): self
+    {
+        return new self($this->name, $value);
+    }
+
     public function getName(): string
     {
         return $this->name;

src/Nelmio/Alice/Definition/PropertyBag.php

@@ -11,7 +11,9 @@
 
 namespace Nelmio\Alice\Definition;
 
-final class PropertyBag
+use Traversable;
+
+final class PropertyBag implements \IteratorAggregate
 {
     /**
      * @var Property[]
@@ -43,4 +45,12 @@ public function mergeWith(self $propertyBag): self
 
         return $clone;
     }
+
+    /**
+     * @inheritdoc
+     */
+    public function getIterator()
+    {
+        return new \ArrayIterator(array_values($this->properties));
+    }
 }

src/Nelmio/Alice/Definition/ServiceReference/FixtureReference.php

@@ -12,56 +12,27 @@
 namespace Nelmio\Alice\Definition\ServiceReference;
 
 use Nelmio\Alice\Definition\ServiceReferenceInterface;
-use Nelmio\Alice\FixtureInterface;
 
 /**
- * Value object to point to refer to a fixture. The reference can be relative, e.g. 'user_base' (fixture reference) or
- * absolute e.g. 'Nelmio\Alice\User#user_base' (fixture ID).
+ * Value object to point to refer to a fixture.
  */
 final class FixtureReference implements ServiceReferenceInterface
 {
     /**
      * @var string
      */
-    private $reference;
+    private $id;
 
     /**
-     * @param string $reference
+     * @param string $fixtureId
      */
-    public function __construct(string $reference)
+    public function __construct(string $fixtureId)
     {
-        $this->reference = $reference;
+        $this->id = $fixtureId;
     }
 
-    /**
-     * A fixture reference may be relative, e.g. 'user_base' (fixture reference). By giving it a fixture, this method
-     * creates a new reference which will be absolute, e.g. 'Nelmio\Alice\User#user_base' (fixture ID.
-     *
-     * @param FixtureInterface $fixture
-     *
-     * @return self
-     */
-    public function createAbsoluteFrom(FixtureInterface $fixture): self
-    {
-        if (false !== strpos($this->reference, '#')) {
-            throw new \BadMethodCallException(
-                sprintf(
-                    'Attempted to make the reference "%s" absolute from the fixture of ID "%s", however the reference '.
-                    'is already absolute.',
-                    $this->reference,
-                    $fixture->getId()
-                )
-            );
-        }
-
-        $clone = clone $this;
-        $clone->reference = $fixture->getClassName().'#'.$this->reference;
-
-        return $clone;
-    }
-
-    public function getReference(): string
+    public function getId(): string
     {
-        return $this->reference;
+        return $this->id;
     }
 }

src/Nelmio/Alice/Definition/ServiceReference/InstantiatedReference.php

@@ -31,7 +31,7 @@ public function __construct(string $reference)
         $this->reference = $reference;
     }
 
-    public function getReference(): string
+    public function getId(): string
     {
         return $this->reference;
     }

src/Nelmio/Alice/Definition/ServiceReference/StaticReference.php

@@ -31,7 +31,7 @@ public function __construct(string $reference)
         $this->reference = $reference;
     }
 
-    public function getReference(): string
+    public function getId(): string
     {
         return $this->reference;
     }

src/Nelmio/Alice/Definition/ServiceReferenceInterface.php

@@ -17,5 +17,5 @@
  */
 interface ServiceReferenceInterface
 {
-    public function getReference(): string;
+    public function getId(): string;
 }

src/Nelmio/Alice/Exception/Generator/Instantiator/InstantiationException.php

@@ -21,7 +21,7 @@ public static function create(FixtureInterface $fixture, \Throwable $previous)
         return new static(
             sprintf(
                 'Could no instantiate fixture "%s".',
-                $fixture->getReference()
+                $fixture->getId()
             ),
             0,
             $previous

src/Nelmio/Alice/Exception/Generator/Instantiator/InstantiatorNotFoundException.php

@@ -21,7 +21,7 @@ public static function create(FixtureInterface $fixture): self
         return new static(
             sprintf(
                 'No suitable instantiator found for the fixture "%s".',
-                $fixture->getReference()
+                $fixture->getId()
             )
         );
     }

src/Nelmio/Alice/FixtureInterface.php

@@ -18,16 +18,10 @@
  */
 interface FixtureInterface
 {
-    /**
-     * @return string Unique across a whole fixture set, mainly used to build unique values. By default is
-     *                'className#reference'
-     */
-    public function getId(): string;
-
     /**
      * @return string e.g. 'dummy0'. May contain flags depending of the implementation.
      */
-    public function getReference(): string;
+    public function getId(): string;
 
     /**
      * @return string FQCN. May contain flags depending of the implementation.