Switch to DOM-based XML parser #18

djbe · 2017-03-26T13:33:10Z

Tried SWXMLHash, but it doesn't support XPath queries, which removes one of the main advantages of DOM-based parsing, and is needed for finding segue connections in a storyboard.

We could use the built in (NS)XMLDocument parser, but it has a higher memory footprint, and antiquated syntax. Still, if we don't want the dependency, we can always switch to the built in Foundation parser.

Fixes #17.

djbe · 2017-04-24T22:49:45Z

Sources/Parsers/StoryboardParser.swift

@@ -28,90 +28,70 @@ public final class StoryboardParser {
    let customModule: String?
  }

+  enum XMLScene {


This is the only bit I'm not too happy with. I first had an XML enum, with inside it separate enums for paths, tags and attributes, but then swiftlint started complaining about nested types. ¯\_(ツ)_/¯

Yeah, not that big a deal imho, as long as we use …Path, …Tag & …Attribute suffixes, we don't have that many constants here to justify having structured constants at all cost, that's ok

AliSoftware

Mainly OK, just a couple of questions/remarks overall but otherwise LGTM

AliSoftware · 2017-05-21T20:41:35Z

Sources/Parsers/ColorsFileParser.swift

-      throw ColorsParserError.invalidFile(reason: reason)
+    for color in document.xpath(XML.colorPath) {
+      let value = color.stringValue
+      guard let name = color["name"], !name.isEmpty else { continue }


Shouldn't we throw an error if the name attribute is missing or empty?

We probably should. My initial try for this was to keep functionality as it is, but we might as wel fix some stuff while we're at it.

AliSoftware · 2017-05-21T20:48:26Z

Sources/Parsers/StoryboardParser.swift

+        scenes.insert(Scene(storyboardID: id,
+                            tag: scene.tag ?? "",
+                            customClass: customClass,
+                            customModule: customModule))


I know we didn't consider that case in the old code either, but what if (for some reason or maybe a malformed Storyboard) we have a scene which have no storyboardIdentifier attribute, is it normal that we skip it? It shouldn't happen in normal cases I think, but given how Xcode generate some strange stuff with storyboards sometimes (see the issue with customModule in the other PR), maybe consider it? I don't know what would be best in that case though (ignoring it or generating a constant with an empty storyboardID?) or if that really matters or if I'm just nitpicking as often 😉

Scenes can have no storyboardIdentifier, in that case they're anonymous scenes. Usually such scenes are connected via segues to other scenes. Anonymous scenes cannot be directly instantiated from code, exactly because they don't have an identifier.

In all my projects, most of my scenes don't have an identifier exactly because they're all connected via segues. Only some of them have an identifier, and those correctly appear in the swiftgen generated file.

Right makes sense 👍

AliSoftware · 2017-05-21T20:51:16Z

Sources/Parsers/StoryboardParser.swift

@@ -28,90 +28,70 @@ public final class StoryboardParser {
    let customModule: String?
  }

+  enum XMLScene {
+    static let path = "/document/scenes/scene/objects/*[@sceneMemberID=\"viewController\"]"


I'd maybe rather name that constant sceneXPath rather than just path?

Also, using @sceneMemberID is a new logic, isn't it? We didn't use the sceneMemberID to identify scenes in the previous SAX version of our parsing did we? Maybe that's all right but just want to make sure we're not over-restricting there in case there's some use case and strange storyboards out there which don't have that attribute on scenes

You're right that it's new logic, before we were just taking the first item in the objects array. But that actually lead to issue #17, where sometimes viewController isn't the first item in the array. Instead we now search for the actual viewcontroller in that logic, thus the @sceneMemberID.

AliSoftware · 2017-05-21T20:52:34Z

Sources/Parsers/StoryboardParser.swift

@@ -28,90 +28,70 @@ public final class StoryboardParser {
    let customModule: String?
  }

+  enum XMLScene {


Yeah, not that big a deal imho, as long as we use …Path, …Tag & …Attribute suffixes, we don't have that many constants here to justify having structured constants at all cost, that's ok

AliSoftware · 2017-05-21T22:01:06Z

Sources/Parsers/ColorsFileParser.swift

      let value = color.stringValue
-      guard let name = color["name"], !name.isEmpty else { continue }
+      guard let name = color["name"], !name.isEmpty else {
+        throw ColorsParserError.invalidFile(reason: "Invalid structure, color must have a name.")


"… color \(value) must have a name …" to help identify in the error message which line on the XML we're taking about?

You want to add the xml line number? I don't think we have access to that.

Edit: Nvm, you want to display the parsed value, gotcha.

Yeah just inserting the value in the error message 😉 (sorry it wasn't super clear ^^)

AliSoftware · 2017-05-21T22:02:31Z

Sources/Parsers/StoryboardParser.swift

+        scenes.insert(Scene(storyboardID: id,
+                            tag: scene.tag ?? "",
+                            customClass: customClass,
+                            customModule: customModule))


Right makes sense 👍

djbe mentioned this pull request Apr 2, 2017

SwiftGen 4.2.1 SwiftGen/SwiftGen#286

Closed

18 tasks

djbe force-pushed the feature/new-xml-parser branch from 1147548 to 943240d Compare April 12, 2017 13:43

djbe added the type: internal label Apr 12, 2017

djbe mentioned this pull request Apr 12, 2017

Storyboards enum generation can be incomplete depending of the xml structure of storyboard file #17

Closed

djbe force-pushed the feature/new-xml-parser branch from 943240d to 4f62ed2 Compare April 24, 2017 19:53

djbe commented Apr 24, 2017

View reviewed changes

djbe force-pushed the feature/new-xml-parser branch 2 times, most recently from c21d73d to 22fa6b3 Compare May 7, 2017 00:08

djbe added this to the 1.1.0 milestone May 7, 2017

djbe force-pushed the feature/new-xml-parser branch from 22fa6b3 to 80f5beb Compare May 7, 2017 22:27

djbe modified the milestones: 2.0.0, 1.1.0 May 8, 2017

AliSoftware mentioned this pull request May 10, 2017

Reuse identifier #16

Open

djbe force-pushed the feature/new-xml-parser branch 2 times, most recently from 4e67c50 to 9929356 Compare May 10, 2017 15:59

djbe added 5 commits May 17, 2017 17:02

Add Fuzi

83879e8

use fuzi in color parser

4a4ea4d

Adapt storyboard parser to use dom xml parser

b465b11

use moar constants

a45704d

fix swiftlint warnings

34f2143

djbe force-pushed the feature/new-xml-parser branch from 9929356 to 34f2143 Compare May 17, 2017 15:02

djbe requested a review from AliSoftware May 17, 2017 15:02

AliSoftware reviewed May 21, 2017

View reviewed changes

rename xpath constants

722f189

djbe mentioned this pull request May 21, 2017

Fixture change for SwiftGenKit#18 SwiftGen/templates#48

Merged

AliSoftware reviewed May 21, 2017

View reviewed changes

throw error if color has no name

403403c

djbe force-pushed the feature/new-xml-parser branch from b438714 to 403403c Compare May 21, 2017 22:06

align submodule

44f59a1

djbe merged commit 763a82b into master May 22, 2017

djbe deleted the feature/new-xml-parser branch May 22, 2017 00:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Switch to DOM-based XML parser #18

Switch to DOM-based XML parser #18

djbe commented Mar 26, 2017 •

edited

Loading

djbe Apr 24, 2017 •

edited by AliSoftware

Loading

AliSoftware May 21, 2017

AliSoftware left a comment

AliSoftware May 21, 2017

djbe May 21, 2017

AliSoftware May 21, 2017

djbe May 21, 2017

AliSoftware May 21, 2017

AliSoftware May 21, 2017

djbe May 21, 2017

AliSoftware May 21, 2017

AliSoftware May 21, 2017 •

edited

Loading

djbe May 21, 2017

AliSoftware May 21, 2017

AliSoftware May 21, 2017

Switch to DOM-based XML parser #18

Switch to DOM-based XML parser #18

Conversation

djbe commented Mar 26, 2017 • edited Loading

djbe Apr 24, 2017 • edited by AliSoftware Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AliSoftware 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

AliSoftware May 21, 2017 • edited Loading

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

djbe commented Mar 26, 2017 •

edited

Loading

djbe Apr 24, 2017 •

edited by AliSoftware

Loading

AliSoftware May 21, 2017 •

edited

Loading