Use Stencil Templating engine to create service files #153

adam-fowler · 2019-07-29T07:49:11Z

Uses https://github.com/stencilproject/Stencil to create service files.

Stencil templates are in CodeGenerator/Templates folder.
CodeGenerator.swift now generates the dictionaries to send to Stencil
Did a general code tidy up
The Code Generator is not dependent on aws-sdk-swift-core anymore
I added a few minor features while doing this
Markup deprecated AWS commands
Added xml namespaces where needed

Currently disabled

This is so I can compare with newly generated files which are built from template files and seem to require a new line at the end

Updated stencils to get them to be as accurate to original output

One difference in ElasticBeanstalk_Shapes.swift where the parameters p99 and p999 are ordered differently

- Changed AUTOMATICALLY GENERATED message to point to swft-aws - Removed newline near end of api files - Tidied up template files to make them easier to read - Sort variables by their lowercase version

I made an addition to Stencil which removes newlines immediately after blocks. Using this I could then clean up the stencil templates to make them a lot easier to read. Unfortunately development on Stencil seems to have gone quiet so forked the repository and made the change locally.

Yasumoto

Some minor questions; this is amazing!

To make sure I'm understanding, we now split this into two phases. The first builds up the contexts, then we drop those into the stencil templates.

This looks so great! Thanks for leading the charge here!!

Yasumoto · 2019-08-07T03:49:58Z

CodeGenerator/Package.swift

-        .package(url: "https://github.com/swift-aws/aws-sdk-swift-core.git", .branch("master")),
-        .package(url: "https://github.com/IBM-Swift/SwiftyJSON.git", .upToNextMajor(from: "17.0.2"))
+        .package(url: "https://github.com/IBM-Swift/SwiftyJSON.git", .upToNextMajor(from: "17.0.2")),
+        .package(url: "https://github.com/adam-fowler/Stencil.git", .upToNextMajor(from: "0.13.4"))


And to confirm, the plan is to move back to upstream once this is merged, yah? (thanks for finding + fixing!)

stencilproject/Stencil#281

I have one other more important change, that implements the clearing of whitespace based on changes from another pull request. I struggled to merge that into the head so re-implemented it. It is more important that that PR is merged into the head of Stencil. For now when this goes into aws-sdk-swift I was going to create a fork Stencil with my changes into swift-aws so the code is centralised.

Yasumoto · 2019-08-07T03:50:24Z

CodeGenerator/Package.swift

@@ -7,10 +7,10 @@ let package = Package(
        .executable(name: "aws-sdk-swift-codegen", targets: ["CodeGenerator"])
    ],
    dependencies: [
-        .package(url: "https://github.com/swift-aws/aws-sdk-swift-core.git", .branch("master")),


So awesome 👏

Yasumoto · 2019-08-07T03:54:21Z

CodeGenerator/Sources/CodeGenerator/AWSService.swift

@@ -254,6 +258,7 @@ struct AWSService {
        var shapes = [Shape]()
        for (key, json) in apiJSON["shapes"].dictionaryValue {
            do {
+                //if json["deprecated"].bool == true { continue }


Yasumoto · 2019-08-07T03:56:57Z

CodeGenerator/Sources/CodeGenerator/CodeGenerator.swift

+        case .string(_):
+            return "String"
+        case .integer(_):
+            return "Int32"


I think we should just use Int if possible, yah?

Unless you need to work with a specific size of integer, always use Int for integer values in your code.
— Section on Int

Yeah gonna do that in a later change

Yasumoto · 2019-08-07T03:59:10Z

CodeGenerator/Sources/CodeGenerator/CodeGenerator.swift

-        return "let \(name.toSwiftVariableCase()): \(swiftTypeName)\(optionalSuffix)"
+
+    struct OperationContext {
+        let comment : [String.SubSequence]


A minor nit, how come the space before the :?

I guess that's something I've always done. Can change if required

adam-fowler · 2019-08-07T06:55:48Z

So yes you are correct. We build up the contexts and then these are 'rendered' using the stencil templates. The dictionary keys / structure member names, correspond to the names used in the templates.

Yasumoto

Thanks!

If partition endpoint is set ensure all regions setup their endpoint correctly

jonnymacs

brilliant!

adam-fowler added 16 commits July 12, 2019 07:37

Use Stencil for generating AWS service source files

393adcd

Currently disabled

Added newline at end of all service files

44e5f70

This is so I can compare with newly generated files which are built from template files and seem to require a new line at the end

Comments are output as arrays

be9a80b

Updated stencils to get them to be as accurate to original output

Update ordering of variables, so I can replicate with stencil templates

7112e8e

Stencil version of files are now almost 99.9999% the same

6f7f327

One difference in ElasticBeanstalk_Shapes.swift where the parameters p99 and p999 are ordered differently

Formatting changes to service files

eaa0b1e

- Changed AUTOMATICALLY GENERATED message to point to swft-aws - Removed newline near end of api files - Tidied up template files to make them easier to read - Sort variables by their lowercase version

typo

2fddc0e

Remove deprecated member variables

5f49914

Flag deprecated API calls

a016fbc

Removed old code generation code, tidied up

900a818

Use context in stencil include to simplify struct and enum templates

f373013

Merge branch 'master' into stencil

1dc4a1f

Rebuilt files

d8f3a54

Use structures instead of dictionaries to store contexts

de06734

Removed dependency on aws-sdk-swift-core

bad4126

Merge branch 'master' into stencil

ed2a213

adam-fowler requested a review from jonnymacs July 29, 2019 07:49

adam-fowler assigned Yasumoto and unassigned Yasumoto Jul 29, 2019

adam-fowler requested a review from Yasumoto July 29, 2019 07:49

adam-fowler added 3 commits July 29, 2019 10:07

Output _xmlNamespace variable

27d5ec6

Update tests to include xmlNamespaces

de138e5

adam-fowler mentioned this pull request Aug 1, 2019

Add validation code to AWSShapes #155

Merged

Yasumoto approved these changes Aug 7, 2019

View reviewed changes

syntax changes

197d93e

Yasumoto approved these changes Aug 7, 2019

View reviewed changes

adam-fowler added 2 commits August 13, 2019 16:16

Added regions to BucketLocationConstraint

d4cbde8

Stop partition endpoint overwriting region endpoint

7457913

If partition endpoint is set ensure all regions setup their endpoint correctly

jonnymacs approved these changes Aug 17, 2019

View reviewed changes

Use the version of stencil forked into swift-aws

ba0cded

adam-fowler merged commit b92ee54 into soto-project:master Aug 17, 2019

adam-fowler deleted the stencil branch August 17, 2019 21:46

adam-fowler mentioned this pull request Aug 17, 2019

Generating codes with more clean templating #60

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use Stencil Templating engine to create service files #153

Use Stencil Templating engine to create service files #153

adam-fowler commented Jul 29, 2019 •

edited

Loading

Yasumoto left a comment

Yasumoto Aug 7, 2019

adam-fowler Aug 7, 2019

Yasumoto Aug 7, 2019

Yasumoto Aug 7, 2019

adam-fowler Aug 7, 2019

Yasumoto Aug 7, 2019

adam-fowler Aug 7, 2019

Yasumoto Aug 7, 2019

adam-fowler Aug 7, 2019

adam-fowler commented Aug 7, 2019

Yasumoto left a comment

jonnymacs left a comment

Use Stencil Templating engine to create service files #153

Use Stencil Templating engine to create service files #153

Conversation

adam-fowler commented Jul 29, 2019 • edited Loading

Yasumoto left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adam-fowler commented Aug 7, 2019

Yasumoto left a comment

Choose a reason for hiding this comment

jonnymacs left a comment

Choose a reason for hiding this comment

adam-fowler commented Jul 29, 2019 •

edited

Loading