Merge pull request #825 from DerManoMann/simplify-short-classnames

Simplify logging of class names using `@OA\xxx` style
zircote · Aug 9, 2020 · 7a1ffb2 · 7a1ffb2
2 parents 24a6a67 + c4007f6
commit 7a1ffb2
Show file tree

Hide file tree

Showing 3 changed files with 56 additions and 13 deletions.
diff --git a/src/Annotations/AbstractAnnotation.php b/src/Annotations/AbstractAnnotation.php
@@ -363,18 +363,14 @@ public function validate($parents = [], $skip = [], $ref = '')
             if (isset(static::$_nested[$class])) {
                 $property = static::$_nested[$class];
                 if (is_array($property)) {
-                    Logger::notice('Only one @'.str_replace('OpenApi\Annotations\\', 'OA\\', get_class($annotation)).'() allowed for '.$this->identity().' multiple found, skipped: '.$annotation->_context);
+                    Logger::notice('Only one '.Logger::shorten(get_class($annotation)).'() allowed for '.$this->identity().' multiple found, skipped: '.$annotation->_context);
                 } else {
-                    Logger::notice('Only one @'.str_replace('OpenApi\Annotations\\', 'OA\\', get_class($annotation)).'() allowed for '.$this->identity()." multiple found in:\n    Using: ".$this->$property->_context."\n  Skipped: ".$annotation->_context);
+                    Logger::notice('Only one '.Logger::shorten(get_class($annotation)).'() allowed for '.$this->identity()." multiple found in:\n    Using: ".$this->$property->_context."\n  Skipped: ".$annotation->_context);
                 }
             } elseif ($annotation instanceof AbstractAnnotation) {
                 $message = 'Unexpected '.$annotation->identity();
-                if (count($class::$_parents)) {
-                    $shortNotations = [];
-                    foreach ($class::$_parents as $_class) {
-                        $shortNotations[] = '@'.str_replace('OpenApi\Annotations\\', 'OA\\', $_class);
-                    }
-                    $message .= ', expected to be inside '.implode(', ', $shortNotations);
+                if ($class::$_parents) {
+                    $message .= ', expected to be inside '.implode(', ', Logger::shorten($class::$_parents));
                 }
                 Logger::notice($message.' in '.$annotation->_context);
             }
@@ -394,7 +390,7 @@ public function validate($parents = [], $skip = [], $ref = '')
             $keyField = $nested[1];
             foreach ($this->$property as $key => $item) {
                 if (is_array($item) && is_numeric($key) === false) {
-                    Logger::notice($this->identity().'->'.$property.' is an object literal, use nested @'.str_replace('OpenApi\\Annotations\\', 'OA\\', $annotationClass).'() annotation(s) in '.$this->_context);
+                    Logger::notice($this->identity().'->'.$property.' is an object literal, use nested '.Logger::shorten($annotationClass).'() annotation(s) in '.$this->_context);
                     $keys[$key] = $item;
                 } elseif ($item->$keyField === UNDEFINED) {
                     Logger::warning($item->identity().' is missing key-field: "'.$keyField.'" in '.$item->_context);
@@ -422,11 +418,11 @@ public function validate($parents = [], $skip = [], $ref = '')
                         $nestedProperty = is_array($nested) ? $nested[0] : $nested;
                         if ($property === $nestedProperty) {
                             if ($this instanceof OpenApi) {
-                                $message = 'Required @'.str_replace('OpenApi\\Annotations\\', 'OA\\', $class).'() not found';
+                                $message = 'Required '.Logger::shorten($class).'() not found';
                             } elseif (is_array($nested)) {
-                                $message = $this->identity().' requires at least one @'.str_replace('OpenApi\\Annotations\\', 'OA\\', $class).'() in '.$this->_context;
+                                $message = $this->identity().' requires at least one '.Logger::shorten($class).'() in '.$this->_context;
                             } else {
-                                $message = $this->identity().' requires a @'.str_replace('OpenApi\\Annotations\\', 'OA\\', $class).'() in '.$this->_context;
+                                $message = $this->identity().' requires a '.Logger::shorten($class).'() in '.$this->_context;
                             }
                             break;
                         }
@@ -529,7 +525,7 @@ protected function _identity($properties)
             }
         }
 
-        return '@'.str_replace('OpenApi\\Annotations\\', 'OA\\', get_class($this)).'('.implode(',', $fields).')';
+        return Logger::shorten(get_class($this)).'('.implode(',', $fields).')';
     }
 
     /**

diff --git a/src/Logger.php b/src/Logger.php
@@ -71,4 +71,21 @@ public static function notice($entry)
     {
         call_user_func(self::getInstance()->log, $entry, E_USER_NOTICE);
     }
+
+    /**
+     * Shorten class name(s).
+     *
+     * @param string|object|[] $classes Class(es) to shorten
+     *
+     * @return string|[] One or more shortened class names
+     */
+    public static function shorten($classes)
+    {
+        $short = [];
+        foreach ((array) $classes as $class) {
+            $short[] = '@'.str_replace('OpenApi\Annotations\\', 'OA\\', $class);
+        }
+
+        return is_array($classes) ? $short : array_pop($short);
+    }
 }
diff --git a/tests/LoggerTest.php b/tests/LoggerTest.php
@@ -0,0 +1,30 @@
+<?php declare(strict_types=1);
+
+/**
+ * @license Apache 2.0
+ */
+
+namespace OpenApi\Tests;
+
+use OpenApi\Annotations\Get;
+use OpenApi\Annotations\Post;
+use OpenApi\Logger;
+
+class LoggerTest extends OpenApiTestCase
+{
+    public function shortenFixtures()
+    {
+        return [
+            [Get::class, '@OA\Get'],
+            [[Get::class, Post::class], ['@OA\Get', '@OA\Post']],
+        ];
+    }
+
+    /**
+     * @dataProvider shortenFixtures
+     */
+    public function testShorten($classes, $expected)
+    {
+        $this->assertEquals($expected, Logger::shorten($classes));
+    }
+}