loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity

Load TemplatingEngineAdapter via Service Provider (#2755)

Browse Source
This commit is contained in:
Jim Schubert
2019-04-29 15:17:11 -04:00
committed by GitHub
parent 1dd3188361
commit baf0e85216
8 changed files with 161 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
modules/openapi-generator-core/src/main/java/org/openapitools/codegen/api/AbstractTemplatingEngineAdapter.java
View File

@@ -1,3 +1,19 @@
/*
* Copyright 2019 OpenAPI-Generator Contributors (https://openapi-generator.tech)
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.openapitools.codegen.api;
import java.util.Locale;

23
modules/openapi-generator-core/src/main/java/org/openapitools/codegen/api/TemplatingEngineAdapter.java
View File

@@ -1,3 +1,19 @@
/*
* Copyright 2019 OpenAPI-Generator Contributors (https://openapi-generator.tech)
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.openapitools.codegen.api;
import java.io.IOException;
@@ -8,6 +24,13 @@ import java.util.Map;
*/
public interface TemplatingEngineAdapter{
/**
* Provides an identifier used to load the adapter. This could be a name, uuid, or any other string.
*
* @return A string identifier.
*/
String getIdentifier();
/**
* Compiles a template into a string
*

16
modules/openapi-generator-core/src/main/java/org/openapitools/codegen/api/TemplatingGenerator.java
View File

@@ -1,3 +1,19 @@
/*
* Copyright 2019 OpenAPI-Generator Contributors (https://openapi-generator.tech)
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.openapitools.codegen.api;
/**

43
modules/openapi-generator/src/main/java/org/openapitools/codegen/TemplatingEngineLoader.java Normal file
View File

@@ -0,0 +1,43 @@
/*
* Copyright 2019 OpenAPI-Generator Contributors (https://openapi-generator.tech)
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.openapitools.codegen;
import org.openapitools.codegen.api.TemplatingEngineAdapter;
import java.util.Locale;
import java.util.ServiceLoader;
public class TemplatingEngineLoader {
public static TemplatingEngineAdapter byIdentifier(String id) {
ServiceLoader<TemplatingEngineAdapter> loader = ServiceLoader.load(TemplatingEngineAdapter.class, TemplatingEngineLoader.class.getClassLoader());
StringBuilder sb = new StringBuilder();
for (TemplatingEngineAdapter templatingEngineAdapter : loader) {
if (id.equals(templatingEngineAdapter.getIdentifier())) {
return templatingEngineAdapter;
}
sb.append(templatingEngineAdapter.getIdentifier()).append("\n");
}
try {
// Attempt to load skipping SPI
return (TemplatingEngineAdapter) Class.forName(id).getDeclaredConstructor().newInstance();
} catch (Exception e) {
throw new RuntimeException(String.format(Locale.ROOT, "Couldn't load template engine adapter %s. Available options: \n%s", id, sb.toString()), e);
}
}
}

14
modules/openapi-generator/src/main/java/org/openapitools/codegen/config/CodegenConfigurator.java
View File

@@ -30,6 +30,7 @@ import io.swagger.v3.parser.core.models.SwaggerParseResult;
import org.apache.commons.io.FilenameUtils;
import org.apache.commons.lang3.Validate;
import org.openapitools.codegen.*;
import org.openapitools.codegen.api.TemplatingEngineAdapter;
import org.openapitools.codegen.auth.AuthParser;
import org.openapitools.codegen.languages.*;
import org.openapitools.codegen.templating.HandlebarsEngineAdapter;
@@ -579,12 +580,15 @@ public class CodegenConfigurator implements Serializable {
config.setLibrary(library);
}
// Built-in templates are mustache, but allow users to use a simplified handlebars engine for their custom templates.
if (isEmpty(templatingEngineName) || templatingEngineName.equals("mustache")) {
config.setTemplatingEngine(new MustacheEngineAdapter());
} else if (templatingEngineName.equals("handlebars")) {
config.setTemplatingEngine(new HandlebarsEngineAdapter());
String templatingEngineId;
if (isEmpty(templatingEngineName)) {
// Built-in templates are mustache, but allow users to use a simplified handlebars engine for their custom templates.
templatingEngineId = "mustache";
}
else { templatingEngineId = templatingEngineName; }
TemplatingEngineAdapter templatingEngine = TemplatingEngineLoader.byIdentifier(templatingEngineId);
config.setTemplatingEngine(templatingEngine);
config.additionalProperties().putAll(additionalProperties);

26
modules/openapi-generator/src/main/java/org/openapitools/codegen/templating/HandlebarsEngineAdapter.java
View File

@@ -1,3 +1,19 @@
/*
* Copyright 2019 OpenAPI-Generator Contributors (https://openapi-generator.tech)
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.openapitools.codegen.templating;
import com.github.jknack.handlebars.Context;
@@ -27,6 +43,16 @@ public class HandlebarsEngineAdapter extends AbstractTemplatingEngineAdapter {
static Logger LOGGER = LoggerFactory.getLogger(HandlebarsEngineAdapter.class);
private final String[] extensions = new String[]{"handlebars", "hbs"};
/**
* Provides an identifier used to load the adapter. This could be a name, uuid, or any other string.
*
* @return A string identifier.
*/
@Override
public String getIdentifier() {
return "handlebars";
}
public String compileTemplate(TemplatingGenerator generator,
Map<String, Object> bundle, String templateFile) throws IOException {
TemplateLoader loader = new AbstractTemplateLoader() {

26
modules/openapi-generator/src/main/java/org/openapitools/codegen/templating/MustacheEngineAdapter.java
View File

@@ -1,3 +1,19 @@
/*
* Copyright 2019 OpenAPI-Generator Contributors (https://openapi-generator.tech)
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.openapitools.codegen.templating;
import com.samskivert.mustache.Mustache;
@@ -13,6 +29,16 @@ import java.util.Map;
public class MustacheEngineAdapter implements TemplatingEngineAdapter {
/**
* Provides an identifier used to load the adapter. This could be a name, uuid, or any other string.
*
* @return A string identifier.
*/
@Override
public String getIdentifier() {
return "mustache";
}
public String[] extensions = new String[]{"mustache"};
Mustache.Compiler compiler = Mustache.compiler();

2
modules/openapi-generator/src/main/resources/META-INF/services/org.openapitools.codegen.api.TemplatingEngineAdapter Normal file
View File

@@ -0,0 +1,2 @@
org.openapitools.codegen.templating.MustacheEngineAdapter
org.openapitools.codegen.templating.HandlebarsEngineAdapter