Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix nested filters when generating examples for PHP, JS and Python #603

Merged
merged 2 commits into from
Jan 15, 2023
Merged

Fix nested filters when generating examples for PHP, JS and Python #603

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ecfd1a1
Fix nested filters when generating examples for PHP, JS and Python
AdamiecRadek Jan 13, 2023
c6b2e89
Fix phpstan error
AdamiecRadek Jan 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions phpunit.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@
<testsuite name="Unit Tests 4">
<file>tests/Unit/ValidationRuleParsingTest.php</file>
<file>tests/Unit/HtmlWriterTest.php</file>
<file>tests/Unit/WritingUtilsTest.php</file>
</testsuite>
</testsuites>
</phpunit>
82 changes: 53 additions & 29 deletions src/Tools/WritingUtils.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,8 @@ public static function printQueryParamsAsString(array $cleanQueryParams): string
* custom braces (eg "[]", default: "{}"),
* custom quotes (eg ', default: "),
* custom indentation, line endings etc.
* Expands/simplifies arrays {key: [1, 2,]} becomes {"key[]": "1"}
* Expands hashes {key: {a: 1, b: 2}} becomes {"key[a]": "1", "key[b]": "2"}
* Expands/simplifies arrays {key: [1, 2,]} becomes {"key[0]": "1","key[1]": "2"}
* Expands hashes {key: {a: 1, b: 2, c: {e: 3}}} becomes {"key[a]": "1", "key[b]": "2", "key[c][e]": "3"}
*
* @param array $cleanQueryParams
* @param string $quote
Expand All @@ -95,37 +95,61 @@ public static function printQueryParamsAsKeyValue(
int $closingBraceIndentation = 0,
string $startLinesWith = '',
string $endLinesWith = ','
): string
{
): string {
$output = isset($braces[0]) ? "{$braces[0]}\n" : '';
foreach ($cleanQueryParams as $parameter => $value) {
if (!is_array($value)) {
$output .= str_repeat(" ", $spacesIndentation);
// Example: -----"param_name": "value"----
$formattedValue = gettype($value) === "boolean" ? ($value ? 1 : 0) : $value;
$output .= "$startLinesWith$quote$parameter$quote$delimiter $quote$formattedValue$quote$endLinesWith\n";
} else {
if (count($value) == 0) {
continue;
}
if (array_keys($value)[0] === 0) {
// List query param (eg filter[]=haha should become "filter[]": "haha")
$output .= str_repeat(" ", $spacesIndentation);
$output .= "$startLinesWith$quote$parameter" . "[]$quote$delimiter $quote$value[0]$quote$endLinesWith\n";
} else {
// Hash query param (eg filter[name]=john should become "filter[name]": "john")
foreach ($value as $item => $itemValue) {
$output .= str_repeat(" ", $spacesIndentation);
$output .= "$startLinesWith$quote$parameter" . "[$item]$quote$delimiter $quote$itemValue$quote$endLinesWith\n";
}
}
}
$output .= self::printSingleQueryParamAsKeyValue($value, $spacesIndentation, $startLinesWith, $quote,
$parameter, $delimiter, $endLinesWith);
}

$closing = isset($braces[1]) ? str_repeat(" ", $closingBraceIndentation) . "{$braces[1]}" : '';
return $output . $closing;
}

/**
* @param mixed $value
* @param int $spacesIndentation
* @param string $startLinesWith
* @param string $quote
* @param string $parameter
* @param string $delimiter
* @param string $endLinesWith
* @return string
*/
protected static function printSingleQueryParamAsKeyValue(
mixed $value, int $spacesIndentation, string $startLinesWith, string $quote,
string $parameter, string $delimiter, string $endLinesWith
): string {

if (!is_array($value)) {
$output = str_repeat(" ", $spacesIndentation);
// Example: -----"param_name": "value"----
$formattedValue = is_bool($value) ? ($value ? 1 : 0) : $value;
$output .= "$startLinesWith$quote$parameter$quote$delimiter $quote$formattedValue$quote$endLinesWith\n";
} else {
$output = '';
if (count($value) == 0) {
return $output;
}

// List query param (eg filter[]=haha should become "filter[0]": "haha")
// Hash query param (eg filter[name]=john should become "filter[name]": "john")
// Hash query param (eg filter[info][name]=john should become "filter[info][name]": "john")
foreach ($value as $item => $itemValue) {
$parameterString = sprintf('%s[%s]', $parameter, $item);
if (is_array($itemValue)) {
$output .= static::printSingleQueryParamAsKeyValue($itemValue, $spacesIndentation, $startLinesWith,
$quote, $parameterString, $delimiter, $endLinesWith);
} else {
$output .= str_repeat(" ", $spacesIndentation);
$output .= sprintf("%s%s%s%s%s %s%s%s%s\n", $startLinesWith, $quote, $parameterString, $quote,
$delimiter, $quote, $itemValue, $quote, $endLinesWith);
}
}
}
return $output;
}

/**
* Expand a request parameter into one or more parameters to be used when sending as form-data.
* A primitive value like ("name", "John") is returned as ["name" => "John"]
Expand All @@ -151,12 +175,12 @@ public static function getParameterNamesAndValuesForFormData(string $parameter,
$params = [];
$expanded = self::getParameterNamesAndValuesForFormData('', $value[0]);
foreach ($expanded as $fieldName => $itemValue) {
$paramName = $parameter.'[]'.$fieldName;
$paramName = $parameter . '[]' . $fieldName;
$params[$paramName] = $itemValue;
}
return $params;
}
return [$parameter.'[]' => $value[0]];
return [$parameter . '[]' => $value[0]];
}

// Transform hashes
Expand All @@ -165,7 +189,7 @@ public static function getParameterNamesAndValuesForFormData(string $parameter,
if (is_array($itemValue)) {
$expanded = self::getParameterNamesAndValuesForFormData('', $itemValue);
foreach ($expanded as $fieldName => $subItemValue) {
$paramName = $parameter . "[$item]".$fieldName;
$paramName = $parameter . "[$item]" . $fieldName;
$params[$paramName] = $subItemValue;
}
} else {
Expand Down Expand Up @@ -219,6 +243,6 @@ public static function getListOfValuesAsFriendlyHtmlString(array $list = [], str
public static function getVersionedAsset(string $assetPath): string
{
$index = strrpos($assetPath, ".");
return substr_replace($assetPath, '-'.Scribe::VERSION, $index, 0);
return substr_replace($assetPath, '-' . Scribe::VERSION, $index, 0);
}
}
84 changes: 84 additions & 0 deletions tests/Unit/WritingUtilsTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
<?php

namespace Knuckles\Scribe\Tests\Unit;

use Knuckles\Scribe\Tests\BaseLaravelTest;
use Knuckles\Scribe\Tools\WritingUtils;

class WritingUtilsTest extends BaseLaravelTest
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No idea why I didn't have a test for this class already, so thanks for this. Now I need to add tests for the other things in that file.😅

{
/** @test */
public function print_query_params_as_key_value_js()
{
$queryParams = WritingUtils::printQueryParamsAsKeyValue($this->getQueryParams());
$this->assertEquals(<<<EOL
{
"name query": "name value",
"list query[0]": "list element 1",
"list query[1]": "list element 2",
"nested query[nested query level 1 array][nested query level 2 list][0]": "nested level 2 list element 1",
"nested query[nested query level 1 array][nested query level 2 list][1]": "nested level 2 list element 2",
"nested query[nested query level 1 array][nested query level 2 query]": "name nested 2",
"nested query[nested query level 1 query]": "name nested 1",
}
EOL, $queryParams);

}

/** @test */
public function print_query_params_as_key_value_php()
{
$queryParams = WritingUtils::printQueryParamsAsKeyValue($this->getQueryParams(), "'", "=>", 4, "[]");
$this->assertEquals(<<<EOL
[
'name query'=> 'name value',
'list query[0]'=> 'list element 1',
'list query[1]'=> 'list element 2',
'nested query[nested query level 1 array][nested query level 2 list][0]'=> 'nested level 2 list element 1',
'nested query[nested query level 1 array][nested query level 2 list][1]'=> 'nested level 2 list element 2',
'nested query[nested query level 1 array][nested query level 2 query]'=> 'name nested 2',
'nested query[nested query level 1 query]'=> 'name nested 1',
]
EOL, $queryParams);

}

/** @test */
public function print_query_params_as_key_value_python()
{
$queryParams = WritingUtils::printQueryParamsAsKeyValue($this->getQueryParams(), "'", ":", 2, "{}");
$this->assertEquals(<<<EOL
{
'name query': 'name value',
'list query[0]': 'list element 1',
'list query[1]': 'list element 2',
'nested query[nested query level 1 array][nested query level 2 list][0]': 'nested level 2 list element 1',
'nested query[nested query level 1 array][nested query level 2 list][1]': 'nested level 2 list element 2',
'nested query[nested query level 1 array][nested query level 2 query]': 'name nested 2',
'nested query[nested query level 1 query]': 'name nested 1',
}
EOL, $queryParams);

}

private function getQueryParams(): array
{
return [
'name query' => 'name value',
'list query' => [
'list element 1',
'list element 2',
],
'nested query' => [
'nested query level 1 array' => [
'nested query level 2 list' => [
'nested level 2 list element 1',
'nested level 2 list element 2',
],
'nested query level 2 query' => 'name nested 2',
],
'nested query level 1 query' => 'name nested 1'
],
];
}
}