added automatic multiline attribute conversions for long annotations

Author: eceltov

app/helpers/MetaFormats/AnnotationToAttributeConverter.php

@@ -32,6 +32,8 @@ private static function shortenClass(string $className)
         return end($tokens);
     }
 
+    private static array $attributeParenthesesBuilders = [];
+
     /**
      * Converts an array of preg_replace_callback matches to an attribute string.
      * @param array $matches An array of matches, with empty captures as NULL (PREG_UNMATCHED_AS_NULL flag).
@@ -117,7 +119,8 @@ private static function regexCaptureToAttributeCallback(array $matches)
         }
 
         $paramAttributeClass = self::shortenClass(Param::class);
-        return "#[{$paramAttributeClass}{$parenthesesBuilder->toString()}]";
+        self::$attributeParenthesesBuilders[] = $parenthesesBuilder;
+        return "#[{$paramAttributeClass}]";
     }
 
     private static function checkValidationNullability(string $validation): bool
@@ -230,6 +233,7 @@ public static function convertFile(string $path)
     {
         // read file and replace @Param annotations with attributes
         $content = file_get_contents($path);
+        self::$attributeParenthesesBuilders = [];
         $withInterleavedAttributes = preg_replace_callback(self::$postRegex, function ($matches) {
             return self::regexCaptureToAttributeCallback($matches);
         }, $content, -1, $count, PREG_UNMATCHED_AS_NULL);
@@ -257,10 +261,16 @@ public static function convertFile(string $path)
             // detected the end of the comment block "*/", flush attribute lines
             } elseif (trim($line) === "*/") {
                 $lines[] = $line;
-                foreach ($attributeLinesBuffer as $attributeLine) {
-                    // the attribute lines are shifted by one space to the right (due to the comment block origin)
-                    $lines[] = substr($attributeLine, 1);
+                for ($i = 0; $i < count($attributeLinesBuffer); $i++) {
+                    $parenthesesBuilder = self::$attributeParenthesesBuilders[$i];
+                    $attributeLine = "    #[{$paramAttributeClass}{$parenthesesBuilder->toString()}]";
+                    // change to multiline if the line is too long
+                    if (strlen($attributeLine) > 120) {
+                        $attributeLine = "    #[{$paramAttributeClass}{$parenthesesBuilder->toMultilineString(4)}]";
+                    }
+                    $lines[] = $attributeLine;
                 }
+
                 $attributeLinesBuffer = [];
             } else {
                 $lines[] = $line;

app/helpers/Swagger/ParenthesesBuilder.php

@@ -48,6 +48,23 @@ public function addValue(string $value): ParenthesesBuilder
 
     public function toString(): string
     {
-        return '(' . implode(', ', $this->tokens) . ')';
+        return "(" . implode(", ", $this->tokens) . ")";
+    }
+
+    private static function spaces(int $count): string
+    {
+        return str_repeat(" ", $count);
+    }
+
+    private const CODEBASE_INDENTATION = 4;
+    public function toMultilineString(int $initialIndentation): string
+    {
+        // do not add indentation to the first line
+        $str = "(\n";
+        foreach ($this->tokens as $token) {
+            $str .= self::spaces($initialIndentation + self::CODEBASE_INDENTATION) . $token . ",\n";
+        }
+        $str .= self::spaces($initialIndentation) . ")";
+        return $str;
     }
 }