Fix issue with Array in the Inline templates #687

fjtrujy · 2020-03-29T12:15:12Z

Description

This PR fixes issues with plists/inline-swift4.stencil or plists/inline-swift5.stencil templates to generate the content of a list that contains arrays.

So far the content of the plist is:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
	<key>Names</key>
	<array>
		<string>Jhon</string>
		<string>Peter</string>
		<string>Nick</string>
	</array>
	<key>Surnames</key>
	<array>
		<string>Smith</string>
		<string>Jhonson</string>
		<string>Williams</string>
	</array>
</dict>
</plist>

And visually it looks:

Then in the .swiftgen.yml I just have somethings as:

.........
plist:
    inputs: Precompile/OriginPlists/
    outputs:
        templateName: inline-swift4
        output: Generated/Plist.swift
.....

When I execute it, it generates wrong data:

internal static let names: [String] = [Jhon, Peter, Nick]
internal static let surnames: [String] = [Smith, Jhonson, Williams]

If you see it misses the quotes in every single element in the array, and in the plist, they are declared as String

Digging into the template I found where the issue "could be", I have created a solution, I tried locally and is working fine, but I don't know if this is breaking something else. Besides I see that the same logic is applied in several templates, so not sure if in these templates is broken as well.

The solution that I applied in the plists/inline-swift4.stencil was:

@@ -55,9 +55,9 @@ import Foundation
     Date(timeIntervalSinceReferenceDate: {{ value.timeIntervalSinceReferenceDate }})
   {% elif metadata.type == "Optional" %}
     nil
-  {% elif metadata.type == "Array" and metadata.element.items %}
-    [{% for itemMetadata in metadata.element.items %}
-      {% call valueBlock value[forloop.counter0] itemMetadata %}
+  {% elif metadata.type == "Array" and value %}
+    [{% for currentValue in value %}
+      {% call valueBlock currentValue metadata.element %}
       {% if not forloop.last %}, {% endif %}
     {% endfor %}]
   {% elif metadata.type == "Dictionary" %}

The new output is:

internal static let names: [String] = ["Jhon", "Peter", "Nick"]
internal static let surnames: [String] = ["Smith", "Jhonson", "Williams"]

🎉 🎉 🎉 🎉 🎉 🎉 🎉

Here you have the reference to the specific github issue that I created time ago. #662

Thanks!

SwiftGen-Eve · 2020-03-29T12:19:29Z

Hey 👋 I'm Eve, the friendly bot watching over SwiftGen 🤖

Thanks a lot for your contribution!

Seems like everything is in order 👍 You did a good job here! 🤝

Generated by 🚫 Danger

AliSoftware · 2020-05-17T13:38:41Z

Thanks for the PR!

It seems you didn't update the tests accordingly (or didn't add a test to cover this case that we missed). Could you add one please?
Also don't forget to credit yourself in the CHANGELOG ;)

@fjtrujy

[SwiftGen#687](SwiftGen#687) [@fjtrujy](https://github.com/fjtrujy) Fix issue with Array in the Inline templates

@fjtrujy

[SwiftGen#687](SwiftGen#687) [@fjtrujy](https://github.com/fjtrujy)

@fjtrujy

[SwiftGen#687](SwiftGen#687) [@fjtrujy](https://github.com/fjtrujy)

CHANGELOG.md

@fjtrujy

[SwiftGen#687](SwiftGen#687) [@fjtrujy](https://github.com/fjtrujy)

@fjtrujy

[SwiftGen#687](SwiftGen#687) [@fjtrujy](https://github.com/fjtrujy)

fjtrujy · 2020-05-18T08:53:54Z

Hello,
@AliSoftware I will try to create a proper test to fix this issue.
Thanks!

# Conflicts: # CHANGELOG.md # templates/plist/inline-swift4.stencil # templates/plist/inline-swift5.stencil

djbe · 2020-06-20T01:01:10Z

I actually started updating this PR, and noticed the same change could be applied to json/yaml inline templates.
Then after generating code (and adding a test case), I also noticed that this fix actually breaks code generation for mixed arrays ([Any]).
~~Furthermore, I tried testing the old template with the given test case, and it just works...~~

~~Added my findings to #662, will need more testing to see if we actually need a PR.~~
Edit: I wasn't pressing the right test shortcut 🤦

…back to element metadata

djbe · 2020-06-20T01:37:05Z

Clarification for these latest changes:

Old template assumed that there was always going to be metadata.element.items[...], which isn't true for homogeneous arrays such as [String]
The initial fix always passed along metadata.element, which isn't correct for mixed arrays, where we need the right metadata for each item.
Correct solution is to try to use metadata for specific item, and fallback to general element metadata.

fjtrujy · 2020-06-22T07:21:07Z

Thanks @djbe for progressing with the work.
I was not able to finish it.
Thanks again

# Conflicts: # CHANGELOG.md

AliSoftware

The fix for the particular problem looks good to me.

But I think we might have another issue (and likely not just with strings in arrays but with strings in general) when they contain escaped quotes…
(Feel free to decide if it's better to either fix this in this current PR or to split that in a separate one)

Tests/Fixtures/Resources/YAML/good/mapping.yaml

fjtrujy mentioned this pull request Mar 29, 2020

Plist and inline-swift template not working with Arrays #662

Closed

AliSoftware added the status: awaiting input label May 17, 2020

djbe added this to the 6.2.1 milestone May 17, 2020

fjtrujy pushed a commit to fjtrujy/SwiftGen that referenced this pull request May 18, 2020

* Fix issue with Array in the Inline templates.

c478e30

[SwiftGen#687](SwiftGen#687) [@fjtrujy](https://github.com/fjtrujy) Fix issue with Array in the Inline templates

fjtrujy force-pushed the develop branch from e1f8b86 to c478e30 Compare May 18, 2020 07:33

fjtrujy pushed a commit to fjtrujy/SwiftGen that referenced this pull request May 18, 2020

* Plist: Fix issue with Array in the Inline templates.

a960981

[SwiftGen#687](SwiftGen#687) [@fjtrujy](https://github.com/fjtrujy)

fjtrujy force-pushed the develop branch from c478e30 to a960981 Compare May 18, 2020 07:37

fjtrujy pushed a commit to fjtrujy/SwiftGen that referenced this pull request May 18, 2020

* Plist: Fix issue with Array in the Inline templates.

850bb4c

[SwiftGen#687](SwiftGen#687) [@fjtrujy](https://github.com/fjtrujy)

fjtrujy force-pushed the develop branch from a960981 to 850bb4c Compare May 18, 2020 07:38

SwiftGen-Eve reviewed May 18, 2020

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

fjtrujy pushed a commit to fjtrujy/SwiftGen that referenced this pull request May 18, 2020

* Plist: Fix issue with Array in the Inline templates.

4481992

[SwiftGen#687](SwiftGen#687) [@fjtrujy](https://github.com/fjtrujy)

fjtrujy force-pushed the develop branch from 850bb4c to 4481992 Compare May 18, 2020 07:44

* Plist: Fix issue with Array in the Inline templates.

656ea0d

[SwiftGen#687](SwiftGen#687) [@fjtrujy](https://github.com/fjtrujy)

fjtrujy force-pushed the develop branch from 4481992 to 656ea0d Compare May 18, 2020 08:19

Merge branch 'develop' into fjtrujy-develop

2e2aa21

# Conflicts: # CHANGELOG.md # templates/plist/inline-swift4.stencil # templates/plist/inline-swift5.stencil

djbe added 4 commits June 20, 2020 03:27

Ensure we pass along array item metadata if available, otherwise fall…

3ef7d45

…back to element metadata

Apply same fixes to JSON & YAML inline templates

6a05288

Add some test cases

241f304

Generate output

cb702c9

djbe added type: bug/fix and removed status: awaiting input labels Jun 20, 2020

Update changelog entry

4ef56eb

djbe force-pushed the develop branch from d4ce51f to 4ef56eb Compare June 20, 2020 01:35

Merge branch 'develop' into fjtrujy-develop

f3a4335

# Conflicts: # CHANGELOG.md

djbe requested a review from AliSoftware June 23, 2020 22:06

djbe mentioned this pull request Jun 24, 2020

SwiftGen 6.2.1 #731

Closed

12 tasks

AliSoftware reviewed Jun 24, 2020

View reviewed changes

Tests/Fixtures/Resources/YAML/good/mapping.yaml Show resolved Hide resolved

AliSoftware approved these changes Jun 24, 2020

View reviewed changes

djbe merged commit 59fd59d into SwiftGen:develop Jun 24, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fix issue with Array in the Inline templates #687

Fix issue with Array in the Inline templates #687

Uh oh!

fjtrujy commented Mar 29, 2020

Uh oh!

SwiftGen-Eve commented Mar 29, 2020 •

edited

Loading

Uh oh!

AliSoftware commented May 17, 2020

Uh oh!

Uh oh!

fjtrujy commented May 18, 2020

Uh oh!

djbe commented Jun 20, 2020 •

edited

Loading

Uh oh!

djbe commented Jun 20, 2020

Uh oh!

fjtrujy commented Jun 22, 2020

Uh oh!

AliSoftware left a comment

Uh oh!

Uh oh!

Uh oh!

Fix issue with Array in the Inline templates #687

Fix issue with Array in the Inline templates #687

Uh oh!

Conversation

fjtrujy commented Mar 29, 2020

Description

Uh oh!

SwiftGen-Eve commented Mar 29, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

AliSoftware commented May 17, 2020

Uh oh!

Uh oh!

fjtrujy commented May 18, 2020

Uh oh!

djbe commented Jun 20, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

djbe commented Jun 20, 2020

Uh oh!

fjtrujy commented Jun 22, 2020

Uh oh!

AliSoftware left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

SwiftGen-Eve commented Mar 29, 2020 •

edited

Loading

djbe commented Jun 20, 2020 •

edited

Loading