RetailCRM-Mirror/graphql-php
1
0
Fork 0
mirror of https://github.com/retailcrm/graphql-php.git synced 2024-11-25 14:26:08 +03:00
Code Issues Projects Releases Wiki Activity

Use multi-line block for trailing quote

Browse Source 
ref: fdc10bb918 (diff-ebaed8492e8d884ee4f2255e39909568)
This commit is contained in:
Daniel Tschinder 2018-06-25 14:26:53 +02:00
parent a032367e26
commit 6e64983f82
2 changed files with 117 additions and 80 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
src/Utils/SchemaPrinter.php
View File

@ -275,15 +275,35 @@ class SchemaPrinter
return self::printDescriptionWithComments($lines, $indentation, $firstInBlock);
}
$description = ($indentation && !$firstInBlock) ? "\n" : '';
if (count($lines) === 1 && mb_strlen($lines[0]) < 70) {
$description .= $indentation . '"""' . self::escapeQuote($lines[0]) . "\"\"\"\n";
return $description;
$description = ($indentation && !$firstInBlock)
? "\n" . $indentation . '"""'
: $indentation . '"""';
// In some circumstances, a single line can be used for the description.
if (
count($lines) === 1 &&
mb_strlen($lines[0]) < 70 &&
substr($lines[0], -1) !== '"'
) {
return $description . self::escapeQuote($lines[0]) . "\"\"\"\n";
}
$description .= $indentation . "\"\"\"\n";
foreach ($lines as $line) {
$description .= $indentation . self::escapeQuote($line) . "\n";
// Format a multi-line block quote to account for leading space.
$hasLeadingSpace = isset($lines[0]) &&
(
substr($lines[0], 0, 1) === ' ' ||
substr($lines[0], 0, 1) === '\t'
);
if (!$hasLeadingSpace) {
$description .= "\n";
}
$lineLength = count($lines);
for ($i = 0; $i < $lineLength; $i++) {
if ($i !== 0 || !$hasLeadingSpace) {
$description .= $indentation;
}
$description .= self::escapeQuote($lines[$i]) . "\n";
}
$description .= $indentation . "\"\"\"\n";

163
tests/Utils/SchemaPrinterTest.php
View File

@ -11,6 +11,7 @@ use GraphQL\Type\Definition\ObjectType;
use GraphQL\Type\Definition\Type;
use GraphQL\Type\Definition\EnumType;
use GraphQL\Type\Definition\UnionType;
use GraphQL\Utils\BuildSchema;
use GraphQL\Utils\SchemaPrinter;
class SchemaPrinterTest extends \PHPUnit_Framework_TestCase
@ -24,13 +25,13 @@ class SchemaPrinterTest extends \PHPUnit_Framework_TestCase
private function printSingleFieldSchema($fieldConfig)
{
$root = new ObjectType([
'name' => 'Root',
$query = new ObjectType([
'name' => 'Query',
'fields' => [
'singleField' => $fieldConfig
]
]);
return $this->printForTest(new Schema(['query' => $root]));
return $this->printForTest(new Schema(['query' => $query]));
}
/**
@ -42,11 +43,7 @@ class SchemaPrinterTest extends \PHPUnit_Framework_TestCase
'type' => Type::string()
]);
$this->assertEquals('
schema {
query: Root
}
type Root {
type Query {
singleField: String
}
', $output);
@ -61,11 +58,7 @@ type Root {
'type' => Type::listOf(Type::string())
]);
$this->assertEquals('
schema {
query: Root
}
type Root {
type Query {
singleField: [String]
}
', $output);
@ -80,11 +73,7 @@ type Root {
'type' => Type::nonNull(Type::string())
]);
$this->assertEquals('
schema {
query: Root
}
type Root {
type Query {
singleField: String!
}
', $output);
@ -99,11 +88,7 @@ type Root {
'type' => Type::nonNull(Type::listOf(Type::string()))
]);
$this->assertEquals('
schema {
query: Root
}
type Root {
type Query {
singleField: [String]!
}
', $output);
@ -118,11 +103,7 @@ type Root {
'type' => Type::listOf(Type::nonNull(Type::string()))
]);
$this->assertEquals('
schema {
query: Root
}
type Root {
type Query {
singleField: [String!]
}
', $output);
@ -137,11 +118,7 @@ type Root {
'type' => Type::nonNull(Type::listOf(Type::nonNull(Type::string())))
]);
$this->assertEquals('
schema {
query: Root
}
type Root {
type Query {
singleField: [String!]!
}
', $output);
@ -189,11 +166,7 @@ type Root {
'args' => ['argOne' => ['type' => Type::int()]]
]);
$this->assertEquals('
schema {
query: Root
}
type Root {
type Query {
singleField(argOne: Int): String
}
', $output);
@ -209,11 +182,7 @@ type Root {
'args' => ['argOne' => ['type' => Type::int(), 'defaultValue' => 2]]
]);
$this->assertEquals('
schema {
query: Root
}
type Root {
type Query {
singleField(argOne: Int = 2): String
}
', $output);
@ -229,11 +198,7 @@ type Root {
'args' => ['argOne' => ['type' => Type::int(), 'defaultValue' => null]]
]);
$this->assertEquals('
schema {
query: Root
}
type Root {
type Query {
singleField(argOne: Int = null): String
}
', $output);
@ -249,11 +214,7 @@ type Root {
'args' => ['argOne' => ['type' => Type::nonNull(Type::int())]]
]);
$this->assertEquals('
schema {
query: Root
}
type Root {
type Query {
singleField(argOne: Int!): String
}
', $output);
@ -272,11 +233,7 @@ type Root {
]
]);
$this->assertEquals('
schema {
query: Root
}
type Root {
type Query {
singleField(argOne: Int, argTwo: String): String
}
', $output);
@ -296,11 +253,7 @@ type Root {
]
]);
$this->assertEquals('
schema {
query: Root
}
type Root {
type Query {
singleField(argOne: Int = 1, argTwo: String, argThree: Boolean): String
}
', $output);
@ -320,11 +273,7 @@ type Root {
]
]);
$this->assertEquals('
schema {
query: Root
}
type Root {
type Query {
singleField(argOne: Int, argTwo: String = "foo", argThree: Boolean): String
}
', $output);
@ -344,11 +293,7 @@ type Root {
]
]);
$this->assertEquals('
schema {
query: Root
}
type Root {
type Query {
singleField(argOne: Int, argTwo: String, argThree: Boolean = false): String
}
', $output);
@ -661,6 +606,78 @@ type Query {
', $output);
}
/**
* @it One-line prints a short description
*/
public function testOneLinePrintsAShortDescription()
{
$description = 'This field is awesome';
$output = $this->printSingleFieldSchema([
"type" => Type::string(),
"description" => $description
]);
$this->assertEquals('
type Query {
"""This field is awesome"""
singleField: String
}
', $output);
$recreatedRoot = BuildSchema::build($output)->getTypeMap()['Query'];
$recreatedField = $recreatedRoot->getFields()['singleField'];
$this->assertEquals($description, $recreatedField->description);
}
/**
* @it Does not one-line print a description that ends with a quote
*/
public function testDoesNotOneLinePrintADescriptionThatEndsWithAQuote()
{
$description = 'This field is "awesome"';
$output = $this->printSingleFieldSchema([
"type" => Type::string(),
"description" => $description
]);
$this->assertEquals('
type Query {
"""
This field is "awesome"
"""
singleField: String
}
', $output);
$recreatedRoot = BuildSchema::build($output)->getTypeMap()['Query'];
$recreatedField = $recreatedRoot->getFields()['singleField'];
$this->assertEquals($description, $recreatedField->description);
}
/**
* @it Preserves leading spaces when printing a description
*/
public function testPReservesLeadingSpacesWhenPrintingADescription()
{
$description = ' This field is "awesome"';
$output = $this->printSingleFieldSchema([
"type" => Type::string(),
"description" => $description
]);
$this->assertEquals('
type Query {
""" This field is "awesome"
"""
singleField: String
}
', $output);
$recreatedRoot = BuildSchema::build($output)->getTypeMap()['Query'];
$recreatedField = $recreatedRoot->getFields()['singleField'];
$this->assertEquals($description, $recreatedField->description);
}
/**
* @it Print Introspection Schema
*/