[Issue 9386] Add Swift 5 code generator and templates #9731

plam4u · 2019-09-25T12:19:10Z

PR checklist

Read the contribution guidelines.
Ran the shell script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh and ./bin/security/{LANG}-petstore.sh if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in .\bin\windows\.
Filed the PR against the correct branch: 3.0.0 branch for changes related to OpenAPI spec 3.0. Default: master.
Copied the technical committee to review the pull request if your PR is targeting a particular programming language.

Description of the PR

This PR copies the swift4 code generator and templates to swift5. A new language option for the command-line is registered - swift5. All the compile issues are fixed and the tests are executed to make sure it works. The updates apply to the default implementation only. I haven't touched the RxSwift or ObjC implementations.

Changes done

clone all the swift 4 code generators, templates and tests to swift 5
fix any compilation errors (update Alamofire dependency and migrate Swift 4.2 to Swift 5.0)

plam4u · 2019-09-25T12:23:05Z

@HugoMario who is the right person to check this PR?

tovkal · 2019-09-25T12:53:24Z

Great work! I have been waiting for Swift 5 support for so long at #9386. Hopefully this can be merged soon

HugoMario · 2019-10-03T09:16:19Z

thanks a lot, please let me know once you want your changes be merged

HugoMario · 2019-10-03T09:34:23Z

@plam4u , let me find out who in team can help us with that.

HugoMario · 2019-10-03T09:36:33Z

hey @4brunu, would you help us reviewing this PR?

4brunu · 2019-10-03T09:49:04Z

modules/swagger-codegen/src/main/resources/swift5/Podspec.mustache

+  s.source_files = '{{projectName}}/Classes/**/*.swift'{{#usePromiseKit}}
+  s.dependency 'PromiseKit/CorePromise', '~> 4.4.0'{{/usePromiseKit}}{{#useRxSwift}}
+  s.dependency 'RxSwift', '~> 4.0'{{/useRxSwift}}
+  s.dependency 'Alamofire', '~> 4.5.0'


@plam4u the version of Alomofire included in podspec doesn't compile with Xcode 11 and Swift 5.1.

I needed to upgrade from s.dependency 'Alamofire', '~> 4.5.0' to s.dependency 'Alamofire', '~> 4.9.0'.

Can you also update the podspec please?

@plam4u the version of Alomofire included in podspec doesn't compile with Xcode 11 and Swift 5.1.

I needed to upgrade from 4.5.0 to 4.9.0.

Can you update the podspec please?

4brunu · 2019-10-03T09:58:18Z

modules/swagger-codegen/src/main/resources/swift5/modelObject.mustache

+    }
+{{/hasVars}}
+{{#additionalPropertiesType}}
+    public var additionalProperties: [String:{{{additionalPropertiesType}}}] = [:]


This doesn't work with the additionalProperties of the type 'Any' because it outputs two errors.

Protocol type 'Any' cannot conform to 'Encodable' because only concrete types can conform to protocols
Protocol type 'Any' cannot conform to 'Decodable' because only concrete types can conform to protocols

Here is an example of the generated code
import Foundation
public struct ProblemDetails: Codable {

public var type: String? public var title: String? public var status: Int? public var detail: String? public var instance: String? public init(type: String?, title: String?, status: Int?, detail: String?, instance: String?) { self.type = type self.title = title self.status = status self.detail = detail self.instance = instance } public var additionalProperties: [String:Any] = [:] public subscript(key: String) -> Any? { get { if let value = additionalProperties[key] { return value } return nil } set { additionalProperties[key] = newValue } } // Encodable protocol methods public func encode(to encoder: Encoder) throws { var container = encoder.container(keyedBy: String.self) try container.encodeIfPresent(type, forKey: "type") try container.encodeIfPresent(title, forKey: "title") try container.encodeIfPresent(status, forKey: "status") try container.encodeIfPresent(detail, forKey: "detail") try container.encodeIfPresent(instance, forKey: "instance") try container.encodeMap(additionalProperties) // build error here. `Protocol type 'Any' cannot conform to 'Encodable' because only concrete types can conform to protocols ` } // Decodable protocol methods public init(from decoder: Decoder) throws { let container = try decoder.container(keyedBy: String.self) type = try container.decodeIfPresent(String.self, forKey: "type") title = try container.decodeIfPresent(String.self, forKey: "title") status = try container.decodeIfPresent(Int.self, forKey: "status") detail = try container.decodeIfPresent(String.self, forKey: "detail") instance = try container.decodeIfPresent(String.self, forKey: "instance") var nonAdditionalPropertyKeys = Set<String>() nonAdditionalPropertyKeys.insert("type") nonAdditionalPropertyKeys.insert("title") nonAdditionalPropertyKeys.insert("status") nonAdditionalPropertyKeys.insert("detail") nonAdditionalPropertyKeys.insert("instance") additionalProperties = try container.decodeMap(Any.self, excludedKeys: nonAdditionalPropertyKeys) // build error here. `Protocol type 'Any' cannot conform to 'Decodable' because only concrete types can conform to protocols` }

}

One possible solution is using AnyCodable instead of Any

4brunu · 2019-10-03T10:00:25Z

Those two are the issues that I found (I already send them to @plam4u in #9386)

andreashaese · 2019-10-07T08:06:44Z

As I wrote elsewhere, could we use Result as the return/callback type instead of (T?, Error?) tuples? I think that would make it even better.

Make return types Void instead of Any

Cleanup Swift 5 classes

Fix imports in Swift5Codegen

4brunu · 2019-10-24T15:47:26Z

modules/swagger-codegen/src/main/resources/swift5/Podspec.mustache

+  s.source_files = '{{projectName}}/Classes/**/*.swift'{{#usePromiseKit}}
+  s.dependency 'PromiseKit/CorePromise', '~> 4.4.0'{{/usePromiseKit}}{{#useRxSwift}}
+  s.dependency 'RxSwift', '~> 4.0'{{/useRxSwift}}
+  s.dependency 'Alamofire', '~> 4.5.0'


@plam4u the version of Alomofire included in podspec doesn't compile with Xcode 11 and Swift 5.1.

I needed to upgrade from 4.5.0 to 4.9.0.

Can you update the podspec please?

4brunu · 2019-10-24T15:49:19Z

modules/swagger-codegen/src/main/resources/swift5/Cartfile.mustache

@@ -0,0 +1,3 @@
+github "Alamofire/Alamofire" ~> 4.5.0{{#usePromiseKit}}


@plam4u the version of Alomofire included in podspec doesn't compile with Xcode 11 and Swift 5.1.

I needed to upgrade from 4.5.0 to 4.9.0.

Can you also update the Cartfile please?

4brunu · 2019-10-24T16:02:50Z

The command ./bin/swift5-all.sh it's ending with an error:

...
#### Swift4Test Swift API client (default) ####
OpenJDK 64-Bit Server VM warning: ignoring option MaxPermSize=256M; support was removed in 8.0
[main] INFO io.swagger.parser.Swagger20Parser - reading from modules/swagger-codegen/src/test/resources/2_0/swift5Test.json
[main] INFO io.swagger.parser.Swagger20Parser - reading from modules/swagger-codegen/src/test/resources/2_0/swift5Test.json
[main] ERROR io.swagger.parser.SwaggerCompatConverter - failed to read resource listing
java.lang.RuntimeException: Could not find modules/swagger-codegen/src/test/resources/2_0/swift5Test.json on the classpath
	at io.swagger.parser.util.ClasspathHelper.loadFileFromClasspath(ClasspathHelper.java:31)
	at io.swagger.parser.SwaggerCompatConverter.readResourceListing(SwaggerCompatConverter.java:207)
	at io.swagger.parser.SwaggerCompatConverter.read(SwaggerCompatConverter.java:123)
	at io.swagger.parser.SwaggerParser.read(SwaggerParser.java:83)
	at io.swagger.codegen.config.CodegenConfigurator.toClientOptInput(CodegenConfigurator.java:431)
	at io.swagger.codegen.cmd.Generate.run(Generate.java:283)
	at io.swagger.codegen.SwaggerCodegen.main(SwaggerCodegen.java:35)
[main] WARN io.swagger.codegen.ignore.CodegenIgnoreProcessor - Output directory does not exist, or is inaccessible. No file (.swagger-codegen-ignore) will be evaluated.
Exception in thread "main" java.lang.RuntimeException: missing swagger input or config!
	at io.swagger.codegen.DefaultGenerator.generate(DefaultGenerator.java:755)
	at io.swagger.codegen.cmd.Generate.run(Generate.java:285)
	at io.swagger.codegen.SwaggerCodegen.main(SwaggerCodegen.java:35)

Update Alamofire dependency

Issue 9386 alamofire

Update swift5 CodableHelper

HugoMario · 2019-10-26T20:25:31Z

@4brunu, this last error it's something that can be fixed on codegen side. i can help with that

HugoMario · 2019-10-26T20:26:25Z

what do you guys think about merging this PR now and address new issue in a different tickets? so others developer can propose PR too?

4brunu · 2019-10-26T22:08:24Z

@HugoMario I think the last error it's now fixed with the last commits and my concernes about the Alamofire version are also fixed.
For me you can now merge this PR.

HugoMario · 2019-10-26T22:26:12Z

oh great, thanks for letting me know @4brunu

HugoMario · 2019-10-26T22:27:04Z

thanks a lot @plam4u !!!!!!!!!!!! for this PR

plam4u · 2019-10-27T07:03:27Z

Thank you for looking into it, guys!
Thanks to @tovkal for implementing all the last changes and fixes.

@plam4u

It appears that swagger-api#9731 is merged and adds Swift 5 (5.x?) support which it would be nice to call out in the Readme, if accurate. May want to add @plam4u (https://github.com/plam4u) to the Template Creator list, but I didn't want to do that without checking with them.

Plamen Andreev added 6 commits September 25, 2019 09:43

Create swift5 folder (a copy of swift4)

bb21d1b

Set project version to Swift 5

1e80c77

Update Alamofire to Swift 5 compatible version

c97943a

Migrate sample project to Swift 5

739ac01

Create swift5 templates folder (a copy of swift4)

4c4e500

Create swift5 generator with updated templates

1d93f45

plam4u changed the title ~~Issue 9386~~ [Issue 9386] Add Swift5 code generator Sep 25, 2019

plam4u changed the title ~~[Issue 9386] Add Swift5 code generator~~ [Issue 9386] Add Swift 5 Sep 25, 2019

plam4u changed the title ~~[Issue 9386] Add Swift 5~~ [Issue 9386] Add Swift 5 code generator and templates Sep 25, 2019

This was referenced Sep 25, 2019

Swift 5 support #9386

Closed

Add swift5 codegen #9330

Open

Delete temp folder left by mistake

42ad411

HugoMario added this to the v2.4.9 milestone Sep 25, 2019

4brunu suggested changes Oct 3, 2019

View reviewed changes

tovkal and others added 8 commits October 19, 2019 12:28

Cleanup Swift 5 classes

d1f66b0

Make return types Void instead of Any

985ee0a

Merge pull request #2 from Tovkal/issue-9386-fix-any-codable

4293af3

Make return types Void instead of Any

Merge branch 'issue-9386' into issue-9386-code-cleanup

14e21b6

Merge pull request #1 from Tovkal/issue-9386-code-cleanup

6793597

Cleanup Swift 5 classes

Merge branch 'master' into issue-9386

79eb55a

Fix imports in Swift5Codegen

f380876

Merge pull request #3 from Tovkal/issue-9386-fix-imports

3c10361

Fix imports in Swift5Codegen

4brunu reviewed Oct 24, 2019

View reviewed changes

Update Alamofire dependency

0d32173

plam4u and others added 8 commits October 24, 2019 18:03

Merge pull request #4 from Tovkal/issue-9386-alamofire

320c8e0

Update Alamofire dependency

Update Alamofire version in Cartfile

56d6940

Add missing swift5 test json

b7be602

Generated Swift 5 sample files

8556859

Merge branch 'master' into issue-9386

9b89d3d

Merge pull request #5 from Tovkal/issue-9386-alamofire

7ddbe80

Issue 9386 alamofire

Update swift5 CodableHelper

559abbe

Merge pull request #6 from Tovkal/issue-9386-update-date-helper

af0f0ae

Update swift5 CodableHelper

HugoMario merged commit fc72545 into swagger-api:master Oct 26, 2019

haikusw mentioned this pull request Nov 3, 2019

Update Readme to indicate Swift 5 support #9828

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Issue 9386] Add Swift 5 code generator and templates #9731

[Issue 9386] Add Swift 5 code generator and templates #9731

plam4u commented Sep 25, 2019 •

edited

Loading

plam4u commented Sep 25, 2019

tovkal commented Sep 25, 2019 •

edited

Loading

HugoMario commented Oct 3, 2019

HugoMario commented Oct 3, 2019

HugoMario commented Oct 3, 2019

4brunu Oct 3, 2019 •

edited

Loading

4brunu Oct 24, 2019

4brunu Oct 3, 2019

4brunu commented Oct 3, 2019

andreashaese commented Oct 7, 2019

4brunu Oct 24, 2019

4brunu Oct 24, 2019

4brunu commented Oct 24, 2019

HugoMario commented Oct 26, 2019

HugoMario commented Oct 26, 2019

4brunu commented Oct 26, 2019

HugoMario commented Oct 26, 2019

HugoMario commented Oct 26, 2019

plam4u commented Oct 27, 2019

		@@ -0,0 +1,3 @@
		github "Alamofire/Alamofire" ~> 4.5.0{{#usePromiseKit}}

[Issue 9386] Add Swift 5 code generator and templates #9731

[Issue 9386] Add Swift 5 code generator and templates #9731

Conversation

plam4u commented Sep 25, 2019 • edited Loading

PR checklist

Description of the PR

plam4u commented Sep 25, 2019

tovkal commented Sep 25, 2019 • edited Loading

HugoMario commented Oct 3, 2019

HugoMario commented Oct 3, 2019

HugoMario commented Oct 3, 2019

4brunu Oct 3, 2019 • edited Loading

Choose a reason for hiding this comment

4brunu Oct 24, 2019

Choose a reason for hiding this comment

4brunu Oct 3, 2019

Choose a reason for hiding this comment

4brunu commented Oct 3, 2019

andreashaese commented Oct 7, 2019

4brunu Oct 24, 2019

Choose a reason for hiding this comment

4brunu Oct 24, 2019

Choose a reason for hiding this comment

4brunu commented Oct 24, 2019

HugoMario commented Oct 26, 2019

HugoMario commented Oct 26, 2019

4brunu commented Oct 26, 2019

HugoMario commented Oct 26, 2019

HugoMario commented Oct 26, 2019

plam4u commented Oct 27, 2019

plam4u commented Sep 25, 2019 •

edited

Loading

tovkal commented Sep 25, 2019 •

edited

Loading

4brunu Oct 3, 2019 •

edited

Loading