Skip to content

Commit

Permalink
gtad.yaml, *.mustache: upgrade to GTAD 0.7 beta
Browse files Browse the repository at this point in the history 
That means much more readable templates thanks to GTAD 0.7 in turn using
the upgrade Mustache engine.
  • Loading branch information
@KitsuneRal
KitsuneRal committed Apr 17, 2020
1 parent 753c281 commit 44ea26d
Show file tree
Hide file tree
Showing 3 changed files with 200 additions and 136 deletions.
12 changes: 12 additions & 0 deletions lib/csapi/gtad.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,18 @@ mustache:
joinedParamDef: '{{>maybeCrefType}} {{paramName}}{{>cjoin}}'
passQueryParams: '{{#queryParams}}{{paramName}}{{>cjoin}}{{/queryParams}}'

# Doc-comment blocks. Comment indent is managed by clang-format
# (without clang-format there'd have to be a separate partial definition
# for each indent...)

# For structures that are not supposed to have a summary (e.g., JSON schema)
docCommentShort: |-
{{#description}}
/// {{_}}{{/description}}
docCommentSummary: |-
{{#summary}} \brief {{summary}}
*{{/summary}}
templates:
- "{{base}}.h.mustache"
- "{{base}}.cpp.mustache"
Expand Down
200 changes: 114 additions & 86 deletions lib/csapi/{{base}}.cpp.mustache
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,151 +3,179 @@
{{^models}}
#include "converters.h"{{/models}}
{{#operations}}
{{#producesNonJson?}}
{{#producesNonJson?}}
#include <QtNetwork/QNetworkReply>
{{/producesNonJson?}}
{{/producesNonJson?}}
#include <QtCore/QStringBuilder>
{{/operations}}

using namespace Quotient;

{{#models.model}}
{{#in?}}
void JsonObjectConverter<{{qualifiedName}}>::dumpTo(QJsonObject& jo, const {{qualifiedName}}& pod)
{
{{#propertyMap
}} fillJson(jo, pod.{{nameCamelCase}});
{{/propertyMap}}{{#parents
}} fillJson<{{name}}>(jo, pod);
{{/parents}}{{#vars
}} addParam<{{^required?}}IfNotEmpty{{/required?}}>(jo, QStringLiteral("{{baseName}}"), pod.{{nameCamelCase}});
{{/vars}}
void JsonObjectConverter<{{qualifiedName}}>::dumpTo(
QJsonObject& jo, const {{qualifiedName}}& pod)
{ {{#propertyMap}}
fillJson(jo, pod.{{nameCamelCase}});
{{/propertyMap}}{{#parents}}
fillJson<{{name}}>(jo, pod);
{{/parents}}{{#vars}}
addParam<{{^required?}}IfNotEmpty{{/required?}}>(jo,
QStringLiteral("{{baseName}}"), pod.{{nameCamelCase}});
{{/vars}}
}
{{/in?}}{{#out?}}
void JsonObjectConverter<{{qualifiedName}}>::fillFrom({{>maybeCrefJsonObject}} jo, {{qualifiedName}}& result)
{
{{#parents
}} fillFromJson<{{qualifiedName}}>(jo, result);
{{/parents}}{{#vars
}} fromJson(jo.{{>takeOrValue}}("{{baseName}}"_ls), result.{{nameCamelCase}});
{{/vars}}{{#propertyMap
}} fromJson(jo, result.{{nameCamelCase}});
{{/propertyMap}}
{{/in?}}

{{#out?}}
void JsonObjectConverter<{{qualifiedName}}>::fillFrom(
{{>maybeCrefJsonObject}} jo, {{qualifiedName}}& result)
{ {{#parents}}
fillFromJson<{{qualifiedName}}>(jo, result);
{{/parents}}{{#vars}}
fromJson(jo.{{>takeOrValue}}("{{baseName}}"_ls), result.{{nameCamelCase}});
{{/vars}}{{#propertyMap}}
fromJson(jo, result.{{nameCamelCase}});
{{/propertyMap}}
}
{{/out?}}

{{/models.model}}
{{#operations}}

static const auto basePath = QStringLiteral("{{basePathWithoutHost}}");
{{#operation}}{{#models}}

// Converters
namespace Quotient
{
namespace Quotient {
{{#model}}
template <> struct JsonObjectConverter<{{qualifiedName}}>
{
{{#in?
}} static void dumpTo(QJsonObject& jo, const {{qualifiedName}}& pod)
{
{{#propertyMap
}} fillJson(jo, pod.{{nameCamelCase}});
{{/propertyMap}}{{#parents
}} fillJson<{{name}}>(jo, pod);
{{/parents}}{{#vars
}} addParam<{{^required?}}IfNotEmpty{{/required?}}>(jo, QStringLiteral("{{baseName}}"), pod.{{nameCamelCase}});
{{/vars}}

template <> struct JsonObjectConverter<{{qualifiedName}}> {
{{#in?}}
static void dumpTo(QJsonObject& jo, const {{qualifiedName}}& pod)
{ {{#propertyMap}}
fillJson(jo, pod.{{nameCamelCase}});
{{/propertyMap}}{{#parents}}
fillJson<{{name}}>(jo, pod);
{{/parents}}{{#vars}}
addParam<{{^required?}}IfNotEmpty{{/required?}}>(jo,
QStringLiteral("{{baseName}}"), pod.{{nameCamelCase}});
{{/vars}}
}
{{/in?}}{{#out?
}} static void fillFrom({{>maybeCrefJsonObject}} jo, {{qualifiedName}}& result)
{
{{#parents
}} fillFromJson<{{qualifiedName}}{{!of the parent!}}>(jo, result);
{{/parents}}{{#vars
}} fromJson(jo.{{>takeOrValue}}("{{baseName}}"_ls), result.{{nameCamelCase}});
{{/vars}}{{#propertyMap
}} fromJson(jo, result.{{nameCamelCase}});
{{/propertyMap}}
{{/in?}}
{{#out?}}
static void fillFrom({{>maybeCrefJsonObject}} jo, {{qualifiedName}}& result)
{ {{#parents}}
fillFromJson<{{qualifiedName}}{{!of the parent!}}>(jo, result);
{{/parents}}{{#vars}}
fromJson(jo.{{>takeOrValue}}("{{baseName}}"_ls),
result.{{nameCamelCase}});
{{/vars}}{{#propertyMap}}
fromJson(jo, result.{{nameCamelCase}});
{{/propertyMap}}
}
{{/out?}}
};
{{/model}}
} // namespace QMatrixClient

} // namespace Quotient
{{/models}}
{{#responses}}{{#normalResponse?}}{{#allProperties?}}

class {{camelCaseOperationId}}Job::Private
{
public:{{#allProperties}}
{{>maybeOmittableType}} {{paramName}};{{/allProperties}}
};
{{/allProperties?}}{{/normalResponse?}}{{/responses}}
{{#queryParams?}}
BaseJob::Query queryTo{{camelCaseOperationId}}({{#queryParams}}{{>joinedParamDef}}{{/queryParams}})

BaseJob::Query queryTo{{camelCaseOperationId}}(
{{#queryParams}}{{>joinedParamDef}}{{/queryParams}})
{
BaseJob::Query _q;{{#queryParams}}
addParam<{{^required?}}IfNotEmpty{{/required?}}>(_q, QStringLiteral("{{baseName}}"), {{paramName}});{{/queryParams}}
addParam<{{^required?}}IfNotEmpty{{/required?}}>(_q,
QStringLiteral("{{baseName}}"), {{paramName}});{{/queryParams}}
return _q;
}
{{/queryParams?}}
{{^bodyParams}}
QUrl {{camelCaseOperationId}}Job::makeRequestUrl(QUrl baseUrl{{#allParams?}}, {{#allParams}}{{>joinedParamDef}}{{/allParams}}{{/allParams?}})

QUrl {{camelCaseOperationId}}Job::makeRequestUrl(QUrl baseUrl{{#allParams?}},
{{#allParams}}{{>joinedParamDef}}{{/allParams}}{{/allParams?}})
{
return BaseJob::makeRequestUrl(std::move(baseUrl),
basePath{{#pathParts}} % {{_}}{{/pathParts}}{{#queryParams?}},
queryTo{{camelCaseOperationId}}({{>passQueryParams}}){{/queryParams?}});
}
{{/bodyParams}}
static const auto {{camelCaseOperationId}}JobName = QStringLiteral("{{camelCaseOperationId}}Job");

{{camelCaseOperationId}}Job::{{camelCaseOperationId}}Job({{#allParams}}{{>joinedParamDef}}{{/allParams}})
: BaseJob(HttpVerb::{{#_cap}}{{#_tolower}}{{httpMethod}}{{/_tolower}}{{/_cap}}, {{camelCaseOperationId}}JobName,
basePath{{#pathParts}} % {{_}}{{/pathParts}}{{#queryParams?}},
queryTo{{camelCaseOperationId}}({{>passQueryParams}}){{/queryParams?}}{{#skipAuth}}{{#queryParams?}},
{}{{/queryParams?}}, false{{/skipAuth}}){{#responses}}{{#normalResponse?}}{{#allProperties?}}
, d(new Private){{/allProperties?}}{{/normalResponse?}}{{/responses}}
{
{{#headerParams?}}{{#headerParams
}} setRequestHeader("{{baseName}}", {{paramName}}.toLatin1());{{/headerParams}}
{{/headerParams?}}{{#bodyParams?
}}{{#inlineBody
}} setRequestData(Data({{#consumesNonJson?}}{{nameCamelCase}}{{/consumesNonJson?
}}{{^consumesNonJson?}}toJson({{nameCamelCase}}){{/consumesNonJson?}}));
{{/inlineBody}}{{^inlineBody
}} QJsonObject _data;{{#bodyParams}}
addParam<{{^required?}}IfNotEmpty{{/required?}}>(_data, QStringLiteral("{{baseName}}"), {{paramName}});{{/bodyParams}}
} {{/bodyParams}}

{{camelCaseOperationId}}Job::{{camelCaseOperationId}}Job(
{{#allParams}}{{>joinedParamDef}}{{/allParams}})
: BaseJob(HttpVerb::{{#_cap}}{{#_tolower}}{{httpMethod}}{{/_tolower}}{{/_cap}},
QStringLiteral("{{camelCaseOperationId}}Job"), {{!object name}}
basePath{{#pathParts}} % {{_}}{{/pathParts}} {{!API endpoint}}
{{#queryParams?
}} , queryTo{{camelCaseOperationId}}({{>passQueryParams}})
{{/queryParams?
}}{{#skipAuth}}{{#queryParams?}}, {}{{/queryParams?}}, false{{/skipAuth}} )
{{#responses}}{{#normalResponse?}}{{#allProperties?
}}, d(new Private){{/allProperties?}}{{/normalResponse?}}{{/responses}}
{ {{#headerParams}}
setRequestHeader("{{baseName}}", {{paramName}}.toLatin1());
{{/headerParams}}{{#bodyParams?}}
{{#inlineBody}}
setRequestData(Data({{!avoid extra linebreaks}}{{
#consumesNonJson?}}{{nameCamelCase}}{{/consumesNonJson?}}{{
^consumesNonJson?}}toJson({{nameCamelCase}}){{/consumesNonJson?
}}));
{{/inlineBody}}{{^inlineBody}}
QJsonObject _data;
{{#bodyParams}}
addParam<{{^required?}}IfNotEmpty{{/required?}}>(_data,
QStringLiteral("{{baseName}}"), {{paramName}});
{{/bodyParams}}
setRequestData(_data);
{{/inlineBody}}{{/bodyParams?
}}{{#producesNonJson?
}} setExpectedContentTypes({ {{#produces}}"{{_}}"{{>cjoin}}{{/produces}} });
{{/producesNonJson?}}
{{/inlineBody}}
{{/bodyParams?}}{{#producesNonJson?}}
setExpectedContentTypes({ {{#produces}}"{{_}}"{{>cjoin}}{{/produces}} });
{{/producesNonJson?}}
}
{{#responses}}{{#normalResponse?}}{{#allProperties?}}

{{camelCaseOperationId}}Job::~{{camelCaseOperationId}}Job() = default;
{{#allProperties}}
{{>qualifiedMaybeCrefType}} {{camelCaseOperationId}}Job::{{paramName}}(){{^moveOnly}} const{{/moveOnly}}

{{>qualifiedMaybeCrefType}}
{{camelCaseOperationId}}Job::{{paramName}}(){{^moveOnly}} const{{/moveOnly}}
{
return {{#moveOnly}}std::move({{/moveOnly}}d->{{paramName}}{{#moveOnly}}){{/moveOnly}};
}
{{/allProperties}}

{{#producesNonJson?}}
BaseJob::Status {{camelCaseOperationId}}Job::parseReply(QNetworkReply* reply)
{
{{#headers}}d->{{paramName}} = reply->rawHeader("{{baseName}}");{{! We don't check for required headers yet }}
{{! We don't check for required headers yet }}
{{#headers}}d->{{paramName}} = reply->rawHeader("{{baseName}}");
{{/headers}}{{#properties}}d->{{paramName}} = reply;{{/properties}}
return Success;
}
{{/producesNonJson?}}{{^producesNonJson?}}
BaseJob::Status {{camelCaseOperationId}}Job::parseJson(const QJsonDocument& data)
{
{{#inlineResponse
}} fromJson(data, d->{{paramName}});
{{/inlineResponse}}{{^inlineResponse
}} auto json = data.object();
{{# properties}}{{#required?
}} if (!json.contains("{{baseName}}"_ls))
{{#inlineResponse}}
fromJson(data, d->{{paramName}});
{{/inlineResponse}}{{^inlineResponse}}
auto json = data.object();
{{#properties}}{{#required?}}
if (!json.contains("{{baseName}}"_ls))
return { IncorrectResponse,
"The key '{{baseName}}' not found in the response" };
{{/required?
}} fromJson(json.value("{{baseName}}"_ls), d->{{paramName}});
{{/ properties}}
{{/inlineResponse
}} return Success;
{{/required?}}
fromJson(json.value("{{baseName}}"_ls), d->{{paramName}});
{{/properties}}
{{/inlineResponse}}

return Success;
}
{{/producesNonJson?}}
{{/allProperties?}}{{/normalResponse?}}{{/responses}}
Expand Down
Loading

0 comments on commit 44ea26d

Please sign in to comment.