Use pebble as a template language for generating code

Author: tokuhirom

generate-code.py

@@ -44,6 +44,7 @@ def generate_clients():
                     -cp ./tools/openapi-generator-cli.jar:./generator/target/line-bot-sdk-nodejs-generator-openapi-generator-1.0.0.jar \\
                     org.openapitools.codegen.OpenAPIGenerator \\
                     generate \\
+                    -e pebble \\
                     -g line-bot-sdk-nodejs-generator \\
                     --enable-post-process-file \\
                     -o {output_path} \\
@@ -63,8 +64,10 @@ def generate_webhook():
                     org.openapitools.codegen.OpenAPIGenerator \\
                     generate \\
                     --global-property apiTest=false,modelDocs=false,apiDocs=false \\
+                    -e pebble \\
                     --enable-post-process-file \\
                     -g line-bot-sdk-nodejs-generator \\
+                    --template-dir ./generator/src/main/resources/line-bot-sdk-nodejs-generator \\
                     -o {output_path} \\
                     -i line-openapi/{source_yaml} \\
                   '''

generator/.gitignore

@@ -1,3 +1,4 @@
 target/
 .vscode/
 /out/
+/dependency-reduced-pom.xml

generator/pom.xml

@@ -105,6 +105,19 @@
                     <target>1.8</target>
                 </configuration>
             </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-shade-plugin</artifactId>
+                <version>3.2.4</version>
+                <executions>
+                    <execution>
+                        <phase>package</phase>
+                        <goals>
+                            <goal>shade</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
         </plugins>
     </build>
     <dependencies>
@@ -114,16 +127,21 @@
             <version>${openapi-generator-version}</version>
             <scope>provided</scope>
         </dependency>
+        <dependency>
+            <groupId>io.pebbletemplates</groupId>
+            <artifactId>pebble</artifactId>
+            <version>3.2.1</version>
+        </dependency>
         <dependency>
             <groupId>org.junit.jupiter</groupId>
             <artifactId>junit-jupiter-api</artifactId>
-            <version>5.10.0</version> <!-- JUnit 5 のバージョン -->
+            <version>5.10.0</version>
             <scope>test</scope>
         </dependency>
         <dependency>
             <groupId>org.junit.jupiter</groupId>
             <artifactId>junit-jupiter-engine</artifactId>
-            <version>5.10.0</version> <!-- JUnit 5 のバージョン -->
+            <version>5.10.0</version>
             <scope>test</scope>
         </dependency>
     </dependencies>

generator/src/main/java/line/bot/generator/LineBotSdkNodejsGeneratorGenerator.java

@@ -1,7 +1,5 @@
 package line.bot.generator;
 
-import com.google.common.collect.ImmutableMap;
-import com.samskivert.mustache.Mustache;
 import io.swagger.v3.oas.models.Operation;
 import io.swagger.v3.oas.models.media.Schema;
 import io.swagger.v3.oas.models.responses.ApiResponse;
@@ -10,21 +8,17 @@
 import org.openapitools.codegen.CodegenDiscriminator;
 import org.openapitools.codegen.CodegenModel;
 import org.openapitools.codegen.CodegenOperation;
-import org.openapitools.codegen.CodegenParameter;
 import org.openapitools.codegen.CodegenType;
+import org.openapitools.codegen.SupportingFile;
 import org.openapitools.codegen.languages.TypeScriptNodeClientCodegen;
 import org.openapitools.codegen.model.ModelMap;
 import org.openapitools.codegen.model.ModelsMap;
-import org.openapitools.codegen.model.OperationsMap;
 import org.openapitools.codegen.utils.ModelUtils;
 
 import java.io.File;
 import java.util.HashMap;
-import java.util.List;
 import java.util.Map;
 import java.util.Optional;
-import java.util.regex.Matcher;
-import java.util.regex.Pattern;
 
 // https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractTypeScriptClientCodegen.java
 // https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/TypeScriptNodeClientCodegen.java
@@ -54,26 +48,6 @@ public String getName() {
         return "line-bot-sdk-nodejs-generator";
     }
 
-    /**
-     * Provides an opportunity to inspect and modify operation data before the code is generated.
-     */
-    @Override
-    public OperationsMap postProcessOperationsWithModels(OperationsMap operations, List<ModelMap> allModels) {
-        OperationsMap objs = super.postProcessOperationsWithModels(operations, allModels);
-
-        for (CodegenOperation op : objs.getOperations().getOperation()) {
-            if (op.getHasBodyParam() && op.bodyParam.isFile) {
-                op.vendorExtensions.put("isBinary", true);
-            }
-            if (op.isResponseFile) {
-                op.vendorExtensions.put("isStream", true);
-            }
-        }
-
-        return operations;
-    }
-
-
     public String getHelp() {
         return "Generates a line-bot-sdk-nodejs-generator client library.";
     }
@@ -84,18 +58,29 @@ public LineBotSdkNodejsGeneratorGenerator() {
         embeddedTemplateDir = templateDir = "line-bot-sdk-nodejs-generator";
         typeMapping.put("file", "Blob");
         languageSpecificPrimitives.add("Blob");
-        apiTestTemplateFiles.put("api_test.mustache", ".spec.ts");
+        apiTestTemplateFiles.put("line-bot-sdk-nodejs-generator/api_test.pebble", ".spec.ts");
         cliOptions.add(CliOption.newString(TEST_OUTPUT, "Set output folder for models and APIs tests").defaultValue(DEFAULT_TEST_FOLDER));
+        modelTemplateFiles.remove("model.mustache");
+        modelTemplateFiles.put("line-bot-sdk-nodejs-generator/model.pebble", ".ts");
+        apiTemplateFiles.remove("api-single.mustache");
+        apiTemplateFiles.put("line-bot-sdk-nodejs-generator/api-single.pebble", ".ts");
     }
 
     @Override
     public void processOpts() {
         super.processOpts();
+        supportingFiles.clear();
+
         if (additionalProperties.containsKey(TEST_OUTPUT)) {
             setOutputTestFolder(additionalProperties.get(TEST_OUTPUT).toString());
         }
+
+        supportingFiles.add(new SupportingFile("line-bot-sdk-nodejs-generator/models.pebble", modelPackage().replace('.', File.separatorChar), "models.ts"));
+        supportingFiles.add(new SupportingFile("line-bot-sdk-nodejs-generator/api-all.pebble", apiPackage().replace('.', File.separatorChar), "apis.ts"));
+        supportingFiles.add(new SupportingFile("line-bot-sdk-nodejs-generator/api.pebble", getIndexDirectory(), "api.ts"));
     }
 
+
     @Override
     public String apiTestFileFolder() {
         return (outputTestFolder + File.separator + testFolder + File.separator + apiPackage().replace('.', File.separatorChar)).replace('/', File.separatorChar);
@@ -152,48 +137,6 @@ protected void handleMethodResponse(Operation operation,
         }
     }
 
-    @Override
-    protected ImmutableMap.Builder<String, Mustache.Lambda> addMustacheLambdas() {
-        return super.addMustacheLambdas()
-                .put("endpoint", (fragment, writer) -> {
-                    String text = fragment.execute();
-                    writer.write(this.getEndpointFromClassName(text));
-                })
-                .put("lower", (fragment, writer) -> {
-                    String text = fragment.execute();
-                    writer.write(text.toLowerCase());
-                })
-                .put("pathReplace", ((fragment, writer) -> {
-                    String text = fragment.execute();
-                    writer.write(pathReplacer(text));
-                }));
-    }
-
-    private String getEndpointFromClassName(String className) {
-        if (className.equals("LineModuleAttachClient")) {
-            return "https://manager.line.biz";
-        } else if (className.contains("Blob")) {
-            return "https://api-data.line.me";
-        } else {
-            return "https://api.line.me";
-        }
-    }
-
-    public static String pathReplacer(String template) {
-        Pattern pattern = Pattern.compile("\\{(\\w+)\\}");
-        Matcher matcher = pattern.matcher(template);
-
-        StringBuilder codeBuilder = new StringBuilder();
-        while (matcher.find()) {
-            String key = matcher.group(1);
-            codeBuilder.append(".replace(\"{").append(key).append("}\", String(");
-            codeBuilder.append(key);
-            codeBuilder.append("))");
-        }
-
-        return codeBuilder.toString();
-    }
-
     @Override
     public String getTypeDeclaration(Schema p) {
         if (ModelUtils.isFileSchema(p)) {
@@ -205,4 +148,9 @@ public String getTypeDeclaration(Schema p) {
         }
         return super.getTypeDeclaration(p);
     }
+
+    private String getIndexDirectory() {
+        String indexPackage = modelPackage.substring(0, Math.max(0, modelPackage.lastIndexOf('.')));
+        return indexPackage.replace('.', File.separatorChar);
+    }
 }

generator/src/main/java/line/bot/generator/pebble/EndpointFunction.java

@@ -0,0 +1,28 @@
+package line.bot.generator.pebble;
+
+import io.pebbletemplates.pebble.extension.Function;
+import io.pebbletemplates.pebble.template.EvaluationContext;
+import io.pebbletemplates.pebble.template.PebbleTemplate;
+
+import java.util.Collections;
+import java.util.List;
+import java.util.Map;
+
+public class EndpointFunction implements Function {
+    @Override
+    public List<String> getArgumentNames() {
+        return Collections.singletonList("className");
+    }
+
+    @Override
+    public Object execute(Map<String, Object> args, PebbleTemplate self, EvaluationContext context, int lineNumber) {
+        String className = (String) args.get("className");
+        if (className.equals("LineModuleAttachClient")) {
+            return "https://manager.line.biz";
+        } else if (className.contains("Blob")) {
+            return "https://api-data.line.me";
+        } else {
+            return "https://api.line.me";
+        }
+    }
+}

generator/src/main/java/line/bot/generator/pebble/MyPebbleExtension.java

@@ -0,0 +1,17 @@
+package line.bot.generator.pebble;
+
+import io.pebbletemplates.pebble.extension.AbstractExtension;
+import io.pebbletemplates.pebble.extension.Function;
+import line.bot.generator.pebble.EndpointFunction;
+
+import java.util.HashMap;
+import java.util.Map;
+
+public class MyPebbleExtension extends AbstractExtension {
+    @Override
+    public Map<String, Function> getFunctions() {
+        HashMap<String, Function> map = new HashMap<>();
+        map.put("endpoint", new EndpointFunction());
+        return map;
+    }
+}

generator/src/main/java/line/bot/generator/pebble/PebbleTemplateAdapter.java

@@ -0,0 +1,50 @@
+package line.bot.generator.pebble;
+
+import io.pebbletemplates.pebble.PebbleEngine;
+import io.pebbletemplates.pebble.loader.ClasspathLoader;
+import io.pebbletemplates.pebble.loader.DelegatingLoader;
+import io.pebbletemplates.pebble.loader.FileLoader;
+import org.openapitools.codegen.api.AbstractTemplatingEngineAdapter;
+import org.openapitools.codegen.api.TemplatingExecutor;
+
+import java.io.IOException;
+import java.io.StringWriter;
+import java.util.Arrays;
+import java.util.Map;
+
+public class PebbleTemplateAdapter extends AbstractTemplatingEngineAdapter {
+    private static final String[] EXTENSIONS = new String[]{"pebble"};
+    private final PebbleEngine engine = new PebbleEngine.Builder()
+        .cacheActive(false)
+        .newLineTrimming(false)
+        .loader(new DelegatingLoader(Arrays.asList(
+            new FileLoader(),
+            new ClasspathLoader()
+        )))
+        .autoEscaping(false)
+        .extension(new MyPebbleExtension())
+        .build();
+
+    public PebbleTemplateAdapter() {
+        super();
+    }
+
+    @Override
+    public String getIdentifier() {
+        return "pebble";
+    }
+
+    @Override
+    public String[] getFileExtensions() {
+        return EXTENSIONS;
+    }
+
+    @Override
+    public String compileTemplate(TemplatingExecutor generator, Map<String, Object> bundle, String templateFile) throws IOException {
+        String modifiedTemplate = this.getModifiedFileLocation(templateFile)[0];
+
+        StringWriter writer = new StringWriter();
+        engine.getTemplate(modifiedTemplate).evaluate(writer, bundle);
+        return writer.toString();
+    }
+}

generator/src/main/resources/META-INF/services/org.openapitools.codegen.api.TemplatingEngineAdapter

@@ -0,0 +1 @@
+line.bot.generator.pebble.PebbleTemplateAdapter

generator/src/main/resources/line-bot-sdk-nodejs-generator/api-all.mustache

@@ -0,0 +1,4 @@
+{# @pebvariable name="apiInfo" type="org.openapitools.codegen.model.ApiInfoMap" #}
+{% for api in apiInfo.apis -%}
+export { {{ api.operations.classname }} } from './{{ api.get("classFilename") }}';
+{% endfor %}