Link to entity without requiring manual linkage

Nil Portugues Caldero · Nil Portugues Caldero · commit ef7ec6afb316 · 2016-06-16T15:38:01.000+02:00
diff --git a/composer.json b/composer.json
@@ -14,13 +14,11 @@
     ],
     "require": {
         "php": ">=5.5.0",
-        "nilportugues/api-transformer": "~1.3"
+        "nilportugues/api-transformer": "^1.5"
     },
     "require-dev": {
-        "phpunit/phpunit": "4.4.*",
-        "fabpot/php-cs-fixer": "^1.9",
-        "mmoreram/php-formatter": "dev-master",
-        "satooshi/php-coveralls": "dev-master"
+        "phpunit/phpunit": "4.8.*",
+        "friendsofphp/php-cs-fixer": "^1.9"
     },
     "autoload": {
         "psr-4": {
@@ -31,8 +29,5 @@
         "psr-4": {
             "NilPortugues\\Tests\\Api\\Json\\": "tests/"
         }
-    },
-    "config": {
-        "bin-dir": "bin/"
     }
 }
diff --git a/src/Http/Message/ErrorResponse.php b/src/Http/Message/ErrorResponse.php
@@ -8,6 +8,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace NilPortugues\Api\Json\Http\Message;
 
 use NilPortugues\Api\Http\Message\AbstractResponse;
diff --git a/src/Http/Message/ResourceCreatedResponse.php b/src/Http/Message/ResourceCreatedResponse.php
@@ -8,6 +8,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace NilPortugues\Api\Json\Http\Message;
 
 use NilPortugues\Api\Http\Message\AbstractResponse;
diff --git a/src/Http/Message/ResourceDeletedResponse.php b/src/Http/Message/ResourceDeletedResponse.php
@@ -8,6 +8,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace NilPortugues\Api\Json\Http\Message;
 
 use NilPortugues\Api\Http\Message\AbstractResponse;
diff --git a/src/Http/Message/ResourceNotFoundResponse.php b/src/Http/Message/ResourceNotFoundResponse.php
@@ -8,6 +8,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace NilPortugues\Api\Json\Http\Message;
 
 use NilPortugues\Api\Http\Message\AbstractResponse;
diff --git a/src/Http/Message/ResourcePatchErrorResponse.php b/src/Http/Message/ResourcePatchErrorResponse.php
@@ -8,6 +8,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace NilPortugues\Api\Json\Http\Message;
 
 use NilPortugues\Api\Http\Message\AbstractResponse;
diff --git a/src/Http/Message/ResourcePostErrorResponse.php b/src/Http/Message/ResourcePostErrorResponse.php
@@ -8,6 +8,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace NilPortugues\Api\Json\Http\Message;
 
 use NilPortugues\Api\Http\Message\AbstractResponse;
diff --git a/src/Http/Message/ResourceProcessingResponse.php b/src/Http/Message/ResourceProcessingResponse.php
@@ -8,6 +8,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace NilPortugues\Api\Json\Http\Message;
 
 use NilPortugues\Api\Http\Message\AbstractResponse;
diff --git a/src/Http/Message/ResourceUpdatedResponse.php b/src/Http/Message/ResourceUpdatedResponse.php
@@ -8,6 +8,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace NilPortugues\Api\Json\Http\Message;
 
 use NilPortugues\Api\Http\Message\AbstractResponse;
diff --git a/src/Http/Message/Response.php b/src/Http/Message/Response.php
@@ -8,6 +8,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace NilPortugues\Api\Json\Http\Message;
 
 use NilPortugues\Api\Http\Message\AbstractResponse;
diff --git a/src/Http/Message/UnsupportedActionResponse.php b/src/Http/Message/UnsupportedActionResponse.php
@@ -8,6 +8,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace NilPortugues\Api\Json\Http\Message;
 
 use NilPortugues\Api\Http\Message\AbstractResponse;
diff --git a/src/JsonTransformer.php b/src/JsonTransformer.php
@@ -8,10 +8,11 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace NilPortugues\Api\Json;
 
-use NilPortugues\Api\Mapping\Mapper;
 use NilPortugues\Api\Transformer\Helpers\RecursiveDeleteHelper;
+use NilPortugues\Api\Transformer\Helpers\RecursiveFormatterHelper;
 use NilPortugues\Api\Transformer\Helpers\RecursiveRenamerHelper;
 use NilPortugues\Api\Transformer\Transformer;
 use NilPortugues\Serializer\Serializer;
@@ -24,16 +25,6 @@ class JsonTransformer extends Transformer
     const META_KEY = 'meta';
     const LINKS = 'links';
 
-    /**
-     * @param Mapper $mapper
-     */
-    public function __construct(Mapper $mapper = null)
-    {
-        if (null !== $mapper) {
-            $this->mappings = $mapper->getClassMap();
-        }
-    }
-
     /**
      * @param mixed $value
      *
@@ -86,6 +77,7 @@ private function setResponseLinks(array &$response)
     {
         $links = array_filter(
             array_merge(
+                $this->buildSelfLink($response),
                 $this->buildLinks(),
                 $this->getResponseAdditionalLinks($response, $response[Serializer::CLASS_IDENTIFIER_KEY])
             )
@@ -95,4 +87,181 @@ private function setResponseLinks(array &$response)
             $response[self::LINKS] = $this->addHrefToLinks($links);
         }
     }
+
+    /**
+     * @param array $response
+     *
+     * @return array
+     */
+    protected function buildSelfLink(array &$response)
+    {
+        $link = [];
+
+        if (!empty($type = $response[Serializer::CLASS_IDENTIFIER_KEY])) {
+            list($idValues, $idProperties) = RecursiveFormatterHelper::getIdPropertyAndValues(
+                $this->mappings,
+                $response,
+                $type
+            );
+
+            $href = self::buildUrl(
+                $this->mappings,
+                $idProperties,
+                $idValues,
+                $this->mappings[$type]->getResourceUrl(),
+                $type
+            );
+
+            if ($href != $this->mappings[$type]->getResourceUrl()) {
+                $link[self::SELF_LINK] = $href;
+            }
+        }
+
+        return $link;
+    }
+
+    /**
+     * @param \NilPortugues\Api\Mapping\Mapping[] $mappings
+     * @param                                     $idProperties
+     * @param                                     $idValues
+     * @param                                     $url
+     * @param                                     $type
+     *
+     * @return mixed
+     */
+    protected static function buildUrl(array &$mappings, $idProperties, $idValues, $url, $type)
+    {
+        $outputUrl = \str_replace($idProperties, $idValues, $url);
+
+        if ($outputUrl !== $url) {
+            return $outputUrl;
+        }
+
+        $outputUrl = self::secondPassBuildUrl([$mappings[$type]->getClassAlias()], $idValues, $url);
+
+        if ($outputUrl !== $url) {
+            return $outputUrl;
+        }
+
+        $className = $mappings[$type]->getClassName();
+        $className = \explode('\\', $className);
+        $className = \array_pop($className);
+
+        $outputUrl = self::secondPassBuildUrl([$className], $idValues, $url);
+        if ($outputUrl !== $url) {
+            return $outputUrl;
+        }
+
+        return $url;
+    }
+
+    /**
+     * @param $idPropertyName
+     * @param $idValues
+     * @param $url
+     *
+     * @return mixed
+     */
+    protected static function secondPassBuildUrl($idPropertyName, $idValues, $url)
+    {
+        if (!empty($idPropertyName)) {
+            $outputUrl = self::toCamelCase($idPropertyName, $idValues, $url);
+            if ($url !== $outputUrl) {
+                return $outputUrl;
+            }
+
+            $outputUrl = self::toLowerFirstCamelCase($idPropertyName, $idValues, $url);
+            if ($url !== $outputUrl) {
+                return $outputUrl;
+            }
+
+            $outputUrl = self::toUnderScore($idPropertyName, $idValues, $url);
+            if ($url !== $outputUrl) {
+                return $outputUrl;
+            }
+        }
+
+        return $url;
+    }
+
+    /**
+     * @param $original
+     * @param $idValues
+     * @param $url
+     *
+     * @return mixed
+     */
+    protected static function toCamelCase($original, $idValues, $url)
+    {
+        foreach ($original as &$o) {
+            $o = '{'.self::underscoreToCamelCase(self::camelCaseToUnderscore($o)).'}';
+        }
+
+        return \str_replace($original, $idValues, $url);
+    }
+
+    /**
+     * Converts a underscore string to camelCase.
+     *
+     * @param string $string
+     *
+     * @return string
+     */
+    protected static function underscoreToCamelCase($string)
+    {
+        return \str_replace(' ', '', \ucwords(\strtolower(\str_replace(['_', '-'], ' ', $string))));
+    }
+
+    /**
+     * Transforms a given string from camelCase to under_score style.
+     *
+     * @param string $camel
+     * @param string $splitter
+     *
+     * @return string
+     */
+    protected static function camelCaseToUnderscore($camel, $splitter = '_')
+    {
+        $camel = \preg_replace(
+            '/(?!^)[[:upper:]][[:lower:]]/',
+            '$0',
+            \preg_replace('/(?!^)[[:upper:]]+/', $splitter.'$0', $camel)
+        );
+
+        return \strtolower($camel);
+    }
+
+    /**
+     * @param $original
+     * @param $idValues
+     * @param $url
+     *
+     * @return mixed
+     */
+    protected static function toLowerFirstCamelCase($original, $idValues, $url)
+    {
+        foreach ($original as &$o) {
+            $o = self::underscoreToCamelCase(self::camelCaseToUnderscore($o));
+            $o[0] = \strtolower($o[0]);
+            $o = '{'.$o.'}';
+        }
+
+        return \str_replace($original, $idValues, $url);
+    }
+
+    /**
+     * @param $original
+     * @param $idValues
+     * @param $url
+     *
+     * @return mixed
+     */
+    protected static function toUnderScore($original, $idValues, $url)
+    {
+        foreach ($original as &$o) {
+            $o = '{'.self::camelCaseToUnderscore($o).'}';
+        }
+
+        return \str_replace($original, $idValues, $url);
+    }
 }
diff --git a/tests/Dummy/ComplexObject/Comment.php b/tests/Dummy/ComplexObject/Comment.php
@@ -8,6 +8,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace NilPortugues\Tests\Api\Json\Dummy\ComplexObject;
 
 use NilPortugues\Tests\Api\Json\Dummy\ComplexObject\ValueObject\CommentId;
diff --git a/tests/Dummy/ComplexObject/Post.php b/tests/Dummy/ComplexObject/Post.php
@@ -8,6 +8,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace NilPortugues\Tests\Api\Json\Dummy\ComplexObject;
 
 use NilPortugues\Tests\Api\Json\Dummy\ComplexObject\ValueObject\PostId;
diff --git a/tests/Dummy/ComplexObject/User.php b/tests/Dummy/ComplexObject/User.php
@@ -8,6 +8,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace NilPortugues\Tests\Api\Json\Dummy\ComplexObject;
 
 use NilPortugues\Tests\Api\Json\Dummy\ComplexObject\ValueObject\UserId;
diff --git a/tests/Dummy/ComplexObject/ValueObject/CommentId.php b/tests/Dummy/ComplexObject/ValueObject/CommentId.php
@@ -8,6 +8,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace NilPortugues\Tests\Api\Json\Dummy\ComplexObject\ValueObject;
 
 class CommentId
diff --git a/tests/Dummy/ComplexObject/ValueObject/PostId.php b/tests/Dummy/ComplexObject/ValueObject/PostId.php
@@ -8,6 +8,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace NilPortugues\Tests\Api\Json\Dummy\ComplexObject\ValueObject;
 
 class PostId
diff --git a/tests/Dummy/ComplexObject/ValueObject/UserId.php b/tests/Dummy/ComplexObject/ValueObject/UserId.php
@@ -8,6 +8,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace NilPortugues\Tests\Api\Json\Dummy\ComplexObject\ValueObject;
 
 class UserId
diff --git a/tests/Dummy/DummyTransformer.php b/tests/Dummy/DummyTransformer.php
@@ -8,6 +8,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace NilPortugues\Tests\Api\Json\Dummy;
 
 use NilPortugues\Api\Transformer\Transformer;
diff --git a/tests/Dummy/SimpleObject/Post.php b/tests/Dummy/SimpleObject/Post.php
@@ -8,6 +8,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace NilPortugues\Tests\Api\Json\Dummy\SimpleObject;
 
 class Post
diff --git a/tests/Http/ErrorResponseTest.php b/tests/Http/ErrorResponseTest.php
@@ -8,6 +8,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace NilPortugues\Tests\Api\Json\Http\Message\Json;
 
 use NilPortugues\Api\Json\Http\Message\ErrorResponse;
diff --git a/tests/Http/ResourceCreatedResponseTest.php b/tests/Http/ResourceCreatedResponseTest.php
diff --git a/tests/Http/ResourceDeletedResponseTest.php b/tests/Http/ResourceDeletedResponseTest.php
diff --git a/tests/Http/ResourceNotFoundResponseTest.php b/tests/Http/ResourceNotFoundResponseTest.php
diff --git a/tests/Http/ResourcePatchErrorResponseTest.php b/tests/Http/ResourcePatchErrorResponseTest.php
diff --git a/tests/Http/ResourcePostErrorResponseTest.php b/tests/Http/ResourcePostErrorResponseTest.php
diff --git a/tests/Http/ResourceProcessingResponseTest.php b/tests/Http/ResourceProcessingResponseTest.php
diff --git a/tests/Http/ResourceUpdatedResponseTest.php b/tests/Http/ResourceUpdatedResponseTest.php
diff --git a/tests/Http/ResponseTest.php b/tests/Http/ResponseTest.php
diff --git a/tests/Http/UnsupportedActionResponseTest.php b/tests/Http/UnsupportedActionResponseTest.php
diff --git a/tests/JsonTransformerTest.php b/tests/JsonTransformerTest.php
