Allow properties mapping in reflected names (#125)

swaggest · Jul 13, 2021 · d99c0ad · d99c0ad
1 parent d0126bd
commit d99c0ad
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -249,11 +249,19 @@ class Order implements ClassStructureContract
         $properties->dateTime->format = Format::DATE_TIME;
         $properties->price = Schema::number();
 
-        $ownerSchema->required[] = self::names()->id;
+        $ownerSchema->setFromRef('#/definitions/order');
 
         // Define default mapping if any
         $ownerSchema->addPropertyMapping('date_time', Order::names()->dateTime);
 
+        // Use mapped name references after the default mapping was configured.
+        $names = self::names($ownerSchema->properties);
+        $ownerSchema->required = array(
+            $names->id,
+            $names->dateTime,
+            $names->price
+        );
+
         // Define additional mapping
         $ownerSchema->addPropertyMapping('DaTe_TiMe', Order::names()->dateTime, self::FANCY_MAPPING);
         $ownerSchema->addPropertyMapping('Id', Order::names()->id, self::FANCY_MAPPING);

diff --git a/src/NameMirror.php b/src/NameMirror.php
@@ -4,8 +4,23 @@
 
 class NameMirror
 {
+    /**
+     * NameMirror constructor.
+     * @param null|string[] $mapping a map of propertyName to dataName
+     */
+    public function __construct($mapping = null)
+    {
+        $this->mapping = $mapping;
+    }
+
+    private $mapping;
+
     public function __get($name)
     {
+        if ($this->mapping !== null && isset($this->mapping[$name])) {
+            return $this->mapping[$name];
+        }
+
         return $name;
     }
 

diff --git a/src/Structure/ClassStructureTrait.php b/src/Structure/ClassStructureTrait.php
@@ -146,8 +146,12 @@ public function jsonSerialize()
     /**
      * @return static|NameMirror
      */
-    public static function names()
+    public static function names(Properties $properties = null, $mapping = Schema::DEFAULT_MAPPING)
     {
+        if ($properties !== null) {
+            return new NameMirror($properties->getDataKeyMap($mapping));
+        }
+
         static $nameflector = null;
         if (null === $nameflector) {
             $nameflector = new NameMirror();

diff --git a/tests/src/Helper/Order.php b/tests/src/Helper/Order.php
@@ -37,16 +37,19 @@ public static function setUpProperties($properties, Schema $ownerSchema)
         $properties->dateTime->format = Format::DATE_TIME;
         $properties->price = Schema::number();
 
-        $ownerSchema->required = array(
-            self::names()->id,
-            'date_time',
-            self::names()->price
-        );
         $ownerSchema->setFromRef('#/definitions/order');
 
         // Define default mapping if any
         $ownerSchema->addPropertyMapping('date_time', Order::names()->dateTime);
 
+        // Use mapped name references after the default mapping was configured.
+        $names = self::names($ownerSchema->properties);
+        $ownerSchema->required = array(
+            $names->id,
+            $names->dateTime,
+            $names->price
+        );
+
         // Define additional mapping
         $ownerSchema->addPropertyMapping('DaTe_TiMe', Order::names()->dateTime, self::FANCY_MAPPING);
         $ownerSchema->addPropertyMapping('Id', Order::names()->id, self::FANCY_MAPPING);