Workaround to fix classname issues with storyboards and customModule by jlnquere · Pull Request #36 · SwiftGen/templates

jlnquere · 2017-04-15T15:32:09Z

Hey,

Here is the workaround to fix classname issues with storyboards and customModule (as described in #25) :)

Fixes #25

…(as described in SwiftGen#25)

djbe

Please implement this for all storyboard templates, not just the iOS swift3 version.

djbe · 2017-04-16T23:05:25Z


-{% macro className scene %}{% if scene.customClass %}{% if scene.customModule %}{{scene.customModule}}.{% endif %}{{scene.customClass}}{% else %}UI{{scene.baseType}}{% endif %}{% endmacro %}
+{% macro className scene %}{% if scene.customClass %}{% if scene.customModule %}{% if not param.ignoreTargetModule or scene.customModule != env.PRODUCT_MODULE_NAME and scene != param.module %}{{scene.customModule}}.{% endif %}{% endif %}{{scene.customClass}}{% else %}UI{{scene.baseType}}{% endif %}{% endmacro %}
+


Also, no need to add this newline.

jlnquere · 2017-04-17T11:19:57Z

Indeed, I forgot the other templates (sorry). Just updated the PR :)

djbe

Right, so this branch was quite out of date. With the merge, tests are running correctly now.
I noticed an error in the if test when matching param.module, it isn't testing the correct property.

Once #2 lands, this PR needs to add the needed documentation for the ignoreTargetModule parameter.

I'm wondering if we should add tests for this. @AliSoftware thoughts?

djbe · 2017-05-02T23:08:33Z

 // Generated using SwiftGen, by O.Halligon — https://github.com/SwiftGen/SwiftGen

-{% macro className scene %}{% if scene.customClass %}{% if scene.customModule %}{{scene.customModule}}.{% endif %}{{scene.customClass}}{% else %}UI{{scene.baseType}}{% endif %}{% endmacro %}
+{% macro className scene %}{% if scene.customClass %}{% if scene.customModule %}{% if not param.ignoreTargetModule or scene.customModule != env.PRODUCT_MODULE_NAME and scene != param.module %}{{scene.customModule}}.{% endif %}{% endif %}{{scene.customClass}}{% else %}UI{{scene.baseType}}{% endif %}{% endmacro %}


scene != param.module
should be
scene.customModule != param.module

AliSoftware · 2017-05-17T10:17:38Z

Yeah, we totally should test this, specially given how it seems to be some strange behaviour of Xcode with storyboards which might change again in future Xcode version!

ldiqual · 2017-06-12T21:21:18Z

@juli1quere Bump

jlnquere · 2017-06-14T10:22:49Z

In fact, I do not have enough knowledge of Swiftgen to write tests that check this issue :/

djbe · 2017-06-14T10:25:27Z

I'll write some tests if I can find some time this week, no promises though, might be next week.

AliSoftware · 2017-08-13T19:12:11Z

Is this still relevant with the new SwiftGen 5.0 templates? If so, could we finish this PR to include it in the next release?

djbe · 2017-08-13T19:20:17Z

The current templates will always prepend the module to scene classes, even for the target module. In some scenarios, the user might want to disable this, hence this PR.

djbe · 2017-08-17T00:18:30Z

Hmmm, that's annoying... It can't compile our ignore target module files, because it can't find the custom class. The custom class is in an external module, and the import is ignored...

@AliSoftware thoughts? Add something to the filename that says "don't compile this"?

AliSoftware · 2017-08-17T07:02:23Z

Can't we create a stub-env doing the import or something?

djbe · 2017-08-17T10:34:40Z

The thing is, the best way to do this is if we could define the name of the current module when checking/compiling the code. At the time, I searched for a bit but didn't really find out how to, any help there would be useful.

If we can define a module when compiling both the output code + the definitions, I think we'll be able to solve this issue by adding the missing class to definitions.swift so that it's both in the "current" module and an imported one.

djbe · 2017-08-17T12:26:06Z

Allright, @AliSoftware no idea what you'll think of this solution, but it works 😄

AliSoftware · 2017-08-17T19:48:10Z

I think at that point basing the decision on the file name is acceptable. But in the long run I hope we won't have more exception and cases to consider.

Otherwise we might need to make our build tests evolve e.g. use a YAML or JSON file to describe the matrix of additional options needed for each template or whatnot. But for now let's go with name matching.

Implemented changes

ldiqual · 2017-09-07T04:08:07Z

@djbe Is this ready to go? I see that you removed the WIP label but didn't notify the maintainers.

djbe · 2017-09-07T09:35:47Z

Eh, I left it open in case there was more feedback incoming. I suppose this can get merged 👍

ldiqual · 2017-10-11T04:31:41Z

@AliSoftware Sorry to bother you on this PR, but I was wondering if you had an idea of when this fix will get released?

AliSoftware · 2017-10-11T04:44:08Z

Should be included within the next version of SwiftGen next weekend

Workaround to fix classname issues with storyboards and customModule …

df753c9

…(as described in SwiftGen#25)

djbe suggested changes Apr 16, 2017

View reviewed changes

djbe added status: WIP type: enhancement labels Apr 16, 2017

Apply workaround of SwiftGen#25 to all concerned templates

9007870

Merge branch 'master' into master

f9a0fec

djbe previously requested changes May 2, 2017

View reviewed changes

djbe added this to the Nice To Have milestone May 8, 2017

djbe self-assigned this Aug 13, 2017

djbe added 3 commits August 17, 2017 01:36

Rebase on upstream

9cab4d1

add the expected output tests and files

e3c67d7

documentation

70f4aa0

provide an extra definitions file for some cases

f8c873a

djbe modified the milestones: 2.1.0, Nice To Have Aug 17, 2017

Merge branch 'master' of git://github.com/SwiftGen/templates

d10574f

djbe added this to the Nice To Have milestone Aug 20, 2017

djbe removed this from the 2.1.0 milestone Aug 20, 2017

djbe mentioned this pull request Aug 20, 2017

Compile output files using a configuration file for options #75

Closed

djbe and others added 2 commits August 20, 2017 22:40

Merge branch 'master' into master

b8e8c10

fix tests after merge

58ba123

djbe mentioned this pull request Aug 23, 2017

Typed segues on a per scene basis #79

Closed

Merge branch 'master' of git://github.com/SwiftGen/templates

fc98b37

djbe removed the status: WIP label Aug 27, 2017

Merge branch 'master' of git://github.com/SwiftGen/templates

250e83c

djbe force-pushed the master branch from a7eb1f5 to 250e83c Compare August 27, 2017 19:13

changelog entry

0a9a1fd

djbe merged commit 1fbd5b0 into SwiftGen:master Sep 7, 2017

djbe mentioned this pull request Dec 10, 2017

Compile output files using a configuration file for options SwiftGen/SwiftGen#365

Closed


		{% macro className scene %}{% if scene.customClass %}{% if scene.customModule %}{{scene.customModule}}.{% endif %}{{scene.customClass}}{% else %}UI{{scene.baseType}}{% endif %}{% endmacro %}
		{% macro className scene %}{% if scene.customClass %}{% if scene.customModule %}{% if not param.ignoreTargetModule or scene.customModule != env.PRODUCT_MODULE_NAME and scene != param.module %}{{scene.customModule}}.{% endif %}{% endif %}{{scene.customClass}}{% else %}UI{{scene.baseType}}{% endif %}{% endmacro %}

Conversation

jlnquere commented Apr 15, 2017 • edited by djbe Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

djbe left a comment

Choose a reason for hiding this comment

Uh oh!

djbe Apr 16, 2017

Choose a reason for hiding this comment

Uh oh!

jlnquere commented Apr 17, 2017

Uh oh!

djbe left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

djbe May 2, 2017

Choose a reason for hiding this comment

Uh oh!

AliSoftware commented May 17, 2017

Uh oh!

ldiqual commented Jun 12, 2017

Uh oh!

jlnquere commented Jun 14, 2017

Uh oh!

djbe commented Jun 14, 2017

Uh oh!

AliSoftware commented Aug 13, 2017

Uh oh!

djbe commented Aug 13, 2017

Uh oh!

djbe commented Aug 17, 2017

Uh oh!

AliSoftware commented Aug 17, 2017

Uh oh!

djbe commented Aug 17, 2017

Uh oh!

djbe commented Aug 17, 2017

Uh oh!

AliSoftware commented Aug 17, 2017

Uh oh!

ldiqual commented Sep 7, 2017

Uh oh!

djbe commented Sep 7, 2017

Uh oh!

ldiqual commented Oct 11, 2017

Uh oh!

AliSoftware commented Oct 11, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

jlnquere commented Apr 15, 2017 •

edited by djbe

Loading

djbe left a comment •

edited

Loading