diff --git a/README.md b/README.md new file mode 100644 index 0000000..ee46c4d --- /dev/null +++ b/README.md @@ -0,0 +1,95 @@ +# endgen +This is a converter tool that reads a DSL and generates output files. + +Endgen is Open Source Software using the [Apache Software License v2.0](http://www.apache.org/licenses/LICENSE-2.0) + +## Motivation + +The motivation behind this tool is that I wanted to generate boilerplate code for handling HTTP Endpoints (hence the +endgen name). + +I had one project written in Scala using the [Tapir](https://tapir.softwaremill.com/) library. Another Java project +using [Spring](https://docs.spring.io/spring-framework/docs/3.2.x/spring-framework-reference/html/mvc.html) Boot. +In both of these projects had a very simple endpoints only supporting POST, taking some datatype as payload and using +the same response type. + +That's a lot of boilerplate, especially in the Scala case where the payload datatype had to be written in several +separate files (for endpoint-definitions, circe serializer support etc). + +So I wrote a [DSL](https://en.wikipedia.org/wiki/Domain-specific_language) parsed by an [ANTLR4](https://www.antlr.org) +parser and a code generator using [freemarker](https://freemarker.apache.org). + +## DSL example + +In the simplest form the DSL looks like this +``` +/some/endpoint <- SomeType(foo:String) +``` + +This gets parsed into an [AST](https://en.wikipedia.org/wiki/Abstract_syntax_tree) which is this case holds a list of +Path segments and a data strucutre representing the input/body type. + +## Code generation example + +When the parser is done reading the DSL it will look in a directory for [freemarker](https://freemarker.apache.org) +templates. For each template it finds it sends in the AST. The resulting file (per template) is written to an +output directory. + +The idea being that you can take these files and probably adapt them before checking them into your project. Endgen +does not aim to be a roundtrip tool (i.e. reading the generated source, or being smart in updating them etc). It is also +a very limited DSL, you can for example not express what type of HTTP Verb to use or declare response codes. There are +no plans to extend the DSL to do that either. + +## DSL + +This is the ANTLR grammar for the root of the DSL + +```antlrv4 +document : generatorconfig? (namedTypeDeclaration|endpoint)* ; +``` +Meaning that the DSL file has an optional `generatorconfig` block at the top. Then you can write either; a type +definition, or an endpoint declaration, as many times as you like. + +Here is an example: +``` +{ + package: se.rutdev.senash, + ending: .scala +} + +/some/endpoint <- SomeType(foo:String) + +Embedded(foo:Bar) +/some/other/endpoint <- (bar:Seq[Embedded]) +``` + +This consists of a config block with 2 items, the 'package' and the 'ending' deinfition. These are available to be used +in the freemarker template as a Map of String-keys to String-values. + +`/some/endpoint <- SomeType(foo:String)` is an endpoint declaration. It declares one endpoint that have a request body +data type called `SomeType` that has a field called `foo` of the type `String`. + +The DSL uses Scala convention of writing data types after the field name separated by a colon. Of course the DSL parser +does not know anything about java or scala types, as far as it is concerned these are 2 strings and the first one is +just named field-name and the other string is named field-type. + +`Embedded(foo:Bar)` is a `namedTypeDeclaration` which is parsed the same way as the request type above. But isn't tied +to a specific endpoint. + +`/some/other/endpoint <- (bar:Seq[Embedded])` is another endpoint declaration. However this time the request body is +not named in the DSL. But all datatypes must have a name so it will simply name it after the last path segment and +tack on the string 'Request' at the end. So the AST till contain a datatype named `endpointRequest` with a field named +`bar` and a type-field with the value `Seq[Embedded]`. + +Again, the parser does not care about, or know anything about what code is generated, so it has not semantic knowledge +if these are actual datatypes in the code it generates or if they make sense in java/scala/lua/rust or whatever you +decide to generate in the templates. + +The only 'semantic' validation the parser performs is to check that not two types have the same name. + +### DSL config + +The only key in the config block the generator looks at is called `ending`, this will be used as the file ending for +the resulting file of applying the freemarker template. + +## Generating \ No newline at end of file diff --git a/endpoints-templates/Codecs.ftl b/endpoints-templates/Codecs.ftl index 428ac59..f11070f 100644 --- a/endpoints-templates/Codecs.ftl +++ b/endpoints-templates/Codecs.ftl @@ -1,3 +1,16 @@ +// Copyright 2025 "Johan Maasing" +// +// 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 ${config.package} object Codecs: diff --git a/endpoints-templates/Endpoints.ftl b/endpoints-templates/Endpoints.ftl index 344f846..a68864c 100644 --- a/endpoints-templates/Endpoints.ftl +++ b/endpoints-templates/Endpoints.ftl @@ -1,18 +1,32 @@ +// Copyright 2025 "Johan Maasing" +// +// 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 ${config.package} -class Endpoints(override val config: OAuthUtils.OAuthConfig) extends framework.service.api.Endpoints with RutTapir with RutUtilsCodec: - type ApiEndpoint[I, O] = OAuthEndpoint[RequestMeta.OAuthRequestMeta, I, ProblemDetail, O] - +class Endpoints: <#list endpoints as endpoint> val ${endpoint.inputType?uncap_first}Endpoint = ApiEndpoint[${endpoint.inputType?cap_first}, VersionedResponse] = <#list endpoint.paths.paths> - apiV1Endpoint + baseEndpoint .post <#items as segment> .in("${segment}") .in(jsonBody[${endpoint.inputType?cap_first}]) - .out(jsonBody[VersionedResponse]) - + <#if endpoint.outputType.isPresent()> + .out(jsonBody[${endpoint.outputType.get()?cap_first}]) + <#else> + .out(jsonBody[DefaultResponse]) + \ No newline at end of file diff --git a/endpoints-templates/Protocol.ftl b/endpoints-templates/Protocol.ftl index f1e323a..faa5d55 100644 --- a/endpoints-templates/Protocol.ftl +++ b/endpoints-templates/Protocol.ftl @@ -1,3 +1,16 @@ +// Copyright 2025 "Johan Maasing" +// +// 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 ${config.package} object Protocol: diff --git a/license.txt b/license.txt new file mode 100644 index 0000000..4947287 --- /dev/null +++ b/license.txt @@ -0,0 +1,177 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS \ No newline at end of file diff --git a/parser/pom.xml b/parser/pom.xml index 1f7e1d8..1bd7d29 100644 --- a/parser/pom.xml +++ b/parser/pom.xml @@ -1,4 +1,19 @@ + diff --git a/parser/src/main/antlr4/nu/zoom/dsl/parser/Endpoints.g4 b/parser/src/main/antlr4/nu/zoom/dsl/parser/Endpoints.g4 index fb8878e..4f47bf8 100644 --- a/parser/src/main/antlr4/nu/zoom/dsl/parser/Endpoints.g4 +++ b/parser/src/main/antlr4/nu/zoom/dsl/parser/Endpoints.g4 @@ -1,3 +1,16 @@ +// Copyright 2025 "Johan Maasing" +// +// 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. grammar Endpoints; document : generatorconfig? (namedTypeDeclaration|endpoint)* ; generatorconfig : '{' (configitem)? (',' configitem)* '}'; @@ -25,7 +38,7 @@ fragment DOT : '.' ; fragment COMMENT_BEGIN : '/*' ; fragment COMMENT_END : '*/' ; WS : [ \t\n\r]+ -> skip; -COMMENT : COMMENT_BEGIN ~[/]* COMMENT_END -> skip; +COMMENT : COMMENT_BEGIN .*? COMMENT_END -> skip; REQUEST_PREFIX : '<-' ; RESPONSE_PREFIX : '->' ; SLASH : '/' ; diff --git a/parser/src/main/java/nu/zoom/dsl/ast/DocumentNode.java b/parser/src/main/java/nu/zoom/dsl/ast/DocumentNode.java index dfa3608..24ac244 100644 --- a/parser/src/main/java/nu/zoom/dsl/ast/DocumentNode.java +++ b/parser/src/main/java/nu/zoom/dsl/ast/DocumentNode.java @@ -1,3 +1,16 @@ +// Copyright 2025 "Johan Maasing" +// +// 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 nu.zoom.dsl.ast; import java.util.List; diff --git a/parser/src/main/java/nu/zoom/dsl/ast/EndpointNode.java b/parser/src/main/java/nu/zoom/dsl/ast/EndpointNode.java index cb0fd6f..69a33d5 100644 --- a/parser/src/main/java/nu/zoom/dsl/ast/EndpointNode.java +++ b/parser/src/main/java/nu/zoom/dsl/ast/EndpointNode.java @@ -1,6 +1,22 @@ +// Copyright 2025 "Johan Maasing" +// +// 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 nu.zoom.dsl.ast; +import java.util.Optional; + public record EndpointNode( PathsNode paths, - String inputType) { + String inputType, + Optional outputType) { } diff --git a/parser/src/main/java/nu/zoom/dsl/ast/EndpointsVisitorTransformer.java b/parser/src/main/java/nu/zoom/dsl/ast/EndpointsVisitorTransformer.java index d2a84b1..5d846d6 100644 --- a/parser/src/main/java/nu/zoom/dsl/ast/EndpointsVisitorTransformer.java +++ b/parser/src/main/java/nu/zoom/dsl/ast/EndpointsVisitorTransformer.java @@ -1,3 +1,16 @@ +// Copyright 2025 "Johan Maasing" +// +// 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 nu.zoom.dsl.ast; import nu.zoom.dsl.parser.EndpointsBaseVisitor; @@ -55,7 +68,16 @@ public class EndpointsVisitorTransformer extends EndpointsBaseVisitor segments) { - EndpointsParser.RequestBodyContext requestBodyContext = ctx.requestBody() ; + var endpoint = new EndpointNode( + new PathsNode(segments), + getRequestTypeName(ctx, segments), + getRepsonseTypeName(ctx, segments) + ); + this.endpoints.add(endpoint); + } + + private String getRequestTypeName(EndpointsParser.EndpointContext ctx, List segments) { + EndpointsParser.RequestBodyContext requestBodyContext = ctx.requestBody(); String requestTypeName = null ; // request can be either a named type declaration, an anonymous type declaration or a type reference if (requestBodyContext.namedTypeDeclaration() != null) { @@ -72,8 +94,25 @@ public class EndpointsVisitorTransformer extends EndpointsBaseVisitor getRepsonseTypeName(EndpointsParser.EndpointContext ctx, List segments) { + var responseBodyContext = ctx.responseBody(); + if (responseBodyContext != null) { + if (responseBodyContext.namedTypeDeclaration() != null) { + var compoundTypeNode = extractCompoundTypeNode(responseBodyContext.namedTypeDeclaration()); + return Optional.of(compoundTypeNode.name()); + } else if (responseBodyContext.typeDeclaration() != null) { + var typeFields = extractTypeFields(responseBodyContext.typeDeclaration().typeField()); + String responseTypeName = segments.getLast() + "Response"; + addDatatType(new TypeNode(responseTypeName, typeFields), ctx.start.getLine()); + return Optional.of(responseTypeName); + } else if (responseBodyContext.IDENTIFIER() != null) { + return Optional.of(responseBodyContext.IDENTIFIER().getText()); + } + } + return Optional.empty(); } private TypeNode extractCompoundTypeNode(EndpointsParser.NamedTypeDeclarationContext ctx) { diff --git a/parser/src/main/java/nu/zoom/dsl/ast/FieldNode.java b/parser/src/main/java/nu/zoom/dsl/ast/FieldNode.java index bde0328..47bf97e 100644 --- a/parser/src/main/java/nu/zoom/dsl/ast/FieldNode.java +++ b/parser/src/main/java/nu/zoom/dsl/ast/FieldNode.java @@ -1,3 +1,16 @@ +// Copyright 2025 "Johan Maasing" +// +// 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 nu.zoom.dsl.ast; public record FieldNode(String name, String type) { diff --git a/parser/src/main/java/nu/zoom/dsl/ast/ParseException.java b/parser/src/main/java/nu/zoom/dsl/ast/ParseException.java index d9dde07..5327598 100644 --- a/parser/src/main/java/nu/zoom/dsl/ast/ParseException.java +++ b/parser/src/main/java/nu/zoom/dsl/ast/ParseException.java @@ -1,3 +1,16 @@ +// Copyright 2025 "Johan Maasing" +// +// 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 nu.zoom.dsl.ast; public class ParseException extends RuntimeException { diff --git a/parser/src/main/java/nu/zoom/dsl/ast/ParserWrapper.java b/parser/src/main/java/nu/zoom/dsl/ast/ParserWrapper.java index ba32240..2252cac 100644 --- a/parser/src/main/java/nu/zoom/dsl/ast/ParserWrapper.java +++ b/parser/src/main/java/nu/zoom/dsl/ast/ParserWrapper.java @@ -1,3 +1,16 @@ +// Copyright 2025 "Johan Maasing" +// +// 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 nu.zoom.dsl.ast; import nu.zoom.dsl.parser.EndpointsLexer; diff --git a/parser/src/main/java/nu/zoom/dsl/ast/PathsNode.java b/parser/src/main/java/nu/zoom/dsl/ast/PathsNode.java index 313a28c..1408953 100644 --- a/parser/src/main/java/nu/zoom/dsl/ast/PathsNode.java +++ b/parser/src/main/java/nu/zoom/dsl/ast/PathsNode.java @@ -1,3 +1,16 @@ +// Copyright 2025 "Johan Maasing" +// +// 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 nu.zoom.dsl.ast; import java.util.List; diff --git a/parser/src/main/java/nu/zoom/dsl/ast/TypeNode.java b/parser/src/main/java/nu/zoom/dsl/ast/TypeNode.java index 6b7eb25..7fd653b 100644 --- a/parser/src/main/java/nu/zoom/dsl/ast/TypeNode.java +++ b/parser/src/main/java/nu/zoom/dsl/ast/TypeNode.java @@ -1,3 +1,16 @@ +// Copyright 2025 "Johan Maasing" +// +// 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 nu.zoom.dsl.ast; import java.util.List; diff --git a/parser/src/main/java/nu/zoom/dsl/cli/EndpointsCLI.java b/parser/src/main/java/nu/zoom/dsl/cli/EndpointsCLI.java index d9246cb..1e3cee5 100644 --- a/parser/src/main/java/nu/zoom/dsl/cli/EndpointsCLI.java +++ b/parser/src/main/java/nu/zoom/dsl/cli/EndpointsCLI.java @@ -1,3 +1,16 @@ +// Copyright 2025 "Johan Maasing" +// +// 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 nu.zoom.dsl.cli; import nu.zoom.dsl.ast.DocumentNode; diff --git a/parser/src/main/java/nu/zoom/dsl/freemarker/Generator.java b/parser/src/main/java/nu/zoom/dsl/freemarker/Generator.java index adcb48c..bb1a29a 100644 --- a/parser/src/main/java/nu/zoom/dsl/freemarker/Generator.java +++ b/parser/src/main/java/nu/zoom/dsl/freemarker/Generator.java @@ -1,3 +1,16 @@ +// Copyright 2025 "Johan Maasing" +// +// 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 nu.zoom.dsl.freemarker; import freemarker.template.Configuration; @@ -39,8 +52,9 @@ public class Generator { List templates = files.filter(p -> p.toString().endsWith(".ftl")).toList() ; ArrayList out = new ArrayList<>(); for (Path template : templates) { - // TODO file ending - Path outpath = outputDir.resolve(outputFilenameFromTemplate(template.getFileName())); + String configEnding = this.data.config().get("ending") ; + String ending = configEnding != null ? configEnding.trim() : ""; + Path outpath = outputDir.resolve(outputFilenameFromTemplate(template.getFileName(), ending)); Template ftl = this.cfg.getTemplate(template.getFileName().toString()) ; try (var outw = Files.newBufferedWriter(outpath, StandardCharsets.UTF_8)) { ftl.process(this.data, outw); @@ -51,7 +65,7 @@ public class Generator { } } - private String outputFilenameFromTemplate(Path template) { - return template.getFileName().toString().replace(".ftl", ".scala"); + private String outputFilenameFromTemplate(Path template, String ending) { + return template.getFileName().toString().replace(".ftl", ending); } } diff --git a/pom.xml b/pom.xml index 2ede1fb..85d9e3d 100644 --- a/pom.xml +++ b/pom.xml @@ -1,4 +1,19 @@ + diff --git a/test01.endpoints b/test01.endpoints index 73844f0..e2db8ab 100644 --- a/test01.endpoints +++ b/test01.endpoints @@ -1,9 +1,29 @@ -{ some: configvalue, someother:value, - package: se.rutdev.senash +/* + Copyright 2025 "Johan Maasing" + + 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. +*/ + +{ + some: configvalue, + someother: value, + package: se.rutdev.senash, + ending: .scala } /some/endpoint <- SomeType(foo:String) Embedded(foo:Bar) /some/other/endpoint <- (bar:Seq[Embedded]) -/yet/other/endpoint2 <- (bar2:Seq[AType]) +/yet/other/endpoint2 <- (bar2:Seq[AType]) -> NamedResponse(foo:Bar) AType(data: java.util.List) +/yet/other/endpoint3 <- (bar2:Seq[AType]) -> (foo:Bar)