Segues support #8

esttorhe · 2015-07-24T23:19:40Z

Fix #3

Done:

Detects the segues from the Storyboard file
Extracting scenes and segues into different arrays to support 1 Scenes extension for UIStoryboard and 1 Segues extension
Only generating segue enums for Storyboards that have at least 1 (others are ignored)
Scene enum and Segue enum are now used instead of Name

Generated code:

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

import Foundation
import UIKit

protocol StoryboardScene : RawRepresentable {
    static var storyboardName : String { get }
    static func storyboard() -> UIStoryboard
    static func initialViewController() -> UIViewController
    func viewController() -> UIViewController
    static func viewController(identifier: Self) -> UIViewController
}

extension StoryboardScene where Self.RawValue == String {
    static func storyboard() -> UIStoryboard {
        return UIStoryboard(name: self.storyboardName, bundle: nil)
    }

    static func initialViewController() -> UIViewController {
        return storyboard().instantiateInitialViewController()!
    }

    func viewController() -> UIViewController {
        return Self.storyboard().instantiateViewControllerWithIdentifier(self.rawValue)
    }
    static func viewController(identifier: Self) -> UIViewController {
        return identifier.viewController()
    }
}

extension UIStoryboard {
    enum Scene {
        enum Wizzard : String, StoryboardScene {
            static let storyboardName = "Wizzard"

            case CreateAccount = "CreateAccount"
            static var createAccountViewController : CreateAccViewController {
                return Wizzard.CreateAccount.viewController() as! CreateAccViewController
            }

            case AcceptCGU = "Accept-CGU"
            static var acceptCGUViewController : UIViewController {
                return Wizzard.AcceptCGU.viewController()
            }

            case ValidatePassword = "Validate_Password"
            static var validatePasswordViewController : UIViewController {
                return Wizzard.ValidatePassword.viewController()
            }

            case Preferences = "Preferences"
            static var preferencesViewController : UIViewController {
                return Wizzard.Preferences.viewController()
            }
        }
        enum Message : String, StoryboardScene {
            static let storyboardName = "Message"

            case Composer = "Composer"
            static var composerViewController : UIViewController {
                return Message.Composer.viewController()
            }

            case URLChooser = "URLChooser"
            static var urlChooserViewController : XXPickerViewController {
                return Message.URLChooser.viewController() as! XXPickerViewController
            }
        }
    }

    enum Segue {
        enum Message : String {
            /// Custom
            case CustomSegue = "Custom"

            /// NonCustom
            case NonCustomSegue = "NonCustom"
        }
    }
}

AliSoftware · 2015-07-24T23:36:34Z

SwiftGen.playground/Pages/Storyboard-Demo.xcplaygroundpage/Contents.swift

@@ -86,4 +101,12 @@ validateVC.title
   not known by the storyboard. But it should work correctly in a real project. */
 // let cgu = UIStoryboard.Name.Wizzard.createAccountViewController

+let segue = UIStoryboard.Segue.Message(rawValue: "CustomSegue")!


Given that your string associated with the .CustomSegue case above is "Custom" not "CustomSegue" I guess this doesn't actually work? Probably forgot to update your example then? (reading that from GitHub so not actually tested here)

You are 💯% correct

Could be a good idea to add an example with real-world code BTW, like how you would use that enum to typically implement prepareForSegue (even in case you need to comment that code if it doesn't work in a Playground context, that'd still be useful for the reader that opens the playground to understand typical usages)

I added this to the end of that Storyboard

/******************************************************************************* This is a «real world» example of how you can benefit from the generated enum; you can easily switch or directly compare the passed int `segue` with the corresponding segues for a specific storyboard. *******************************************************************************/ //override func prepareForSegue(_ segue: UIStoryboardSegue, sender sender: AnyObject?) { // switch UIStoryboard.Segue.Message(rawValue: segue.identifier)! { // case .CustomSegue: // // Prepare for your custom segue transition // case .NonCustomSegue: // // Pass in information to the destination View Controller // } //}

What do you think?

Except for the typo ("the passed int segue"), seems 👌

AliSoftware · 2015-07-24T23:42:37Z

SwiftGen.playground/Sources/SwiftGenStoryboardEnumBuilder.swift

+                readyForFirstObject = false
+              case "connections":
+                readyForConnections = true
+              case _ where readyForConnections:


why not case "segue" where readyForConnections, just to be sure to only grab segue nodes here?

Note that I used _ for the objects case above because they can actually be of various type, like viewController or tableViewController etc, but I don't think that could actually be the case for segue… And I even wonder if that <connection> node doesn't also contain IBOutlets if any, may be worth adding some in the demo storyboard to check that out.

We would have to add then a custom view controller class to connect the IBOutlets there which in turn would «bloat» the Storyboard.

But is worth checking that the <connections> won't ever contain stuff other than segues and perhaps clean up that piece of the code.

Yeah, good point. Probably don't do it in the storyboard actually shipped with the playground & code, but still worth checking in a storyboard created aside 😉

(That's why we need #2 to add tests 😄 )

Just checked on another project of mine and here's a Storyboard scene with outlets

<connections> <outlet property="hairlineView" destination="VRg-OY-4IC" id="PuB-XN-okm"/> <outlet property="portTextField" destination="6b3-TB-J53" id="Ks7-gi-ZD7"/> <outlet property="serverTextField" destination="Lfy-mJ-Msa" id="apH-fb-2cT"/> <segue destination="Z5I-uz-FR0" kind="show" identifier="ShowClientsSegue" id="cml-0d-ha0"/> </connections>

Ah I knew I've seen those outlets here some times back! Better add that "segue" in the case then!

AliSoftware · 2015-07-24T23:53:35Z

SwiftGen.playground/Sources/SwiftGenStoryboardEnumBuilder.swift

@@ -4,7 +4,8 @@ import Foundation

 public final class SwiftGenStoryboardEnumBuilder {
    private typealias Scene = (storyboardID: String, customClass: String?)


We should probably rename that tuple to something else for consistency, to give it a name that can both fit for Scenes and Segues (and then use identifier for the first entry name, instead of storyboardID)

Argh… seems like I discarded that change…

I had it like StoryboardElement or UIElement can't remember and the first parameter was actually identifier :/

Which name would you rather use? or none of the above?

StoryboardElement seems ok. Entry could do it too I guess.
I see the idea behind UIElement but think it's took generic (and somehow makes me think about AccessibilityElement, not sure why)

Or… we could also add another typealias, even if it's equal to the same tuple type, just to clarify things (and to be more flexible if some day we need to add another parameter to that tuple for scenes but not segues or the other way around)?

I explored adding an extra typealias but thought it would be weird.

Honestly you suggesting it kinds of validates my first thought.

Let me add it and commit that.

This ~~d773bd8~~a4a62a8 should take care of this

Added for readability since both tuples are exactly the same but makes reading the code easier.

AliSoftware · 2015-07-25T00:04:42Z

SwiftGen.playground/Sources/SwiftGenStoryboardEnumBuilder.swift

@@ -70,17 +83,19 @@ public final class SwiftGenStoryboardEnumBuilder {
        }
    }

-    public func build(enumName enumName: String? = "Name", indentation indent : SwiftGenIndentation = .Spaces(4)) -> String {
+    public func build(scenesEnumName enumName: String? = "Scene", seguesEnumName: String? = "Segue", indentation indent : SwiftGenIndentation = .Spaces(4)) -> String {


Now that we have two different enums, it doesn't even make sense anymore to let the option to the user to not provide an enumName (which so far was possible and generated all the enums for the Scenes at the root of the UIStoryboard extension). So we better migrate those two parameters to non-optional Strings

Changed here 3983edc

I left default values though just in case

Yup, those default values are still good to keep 😃

Since there's 2 different enums now it is «required» to pass the names of both of them.

- Added back the `scenesEnumName` explicit name to the `build` method. - Added a `case segue` to the `switch` due to the `outlets` added in the `connections` node.

AliSoftware · 2015-07-25T00:27:14Z

Seems good from here now, will merge tomorrow after some good sleep.
007 can deserve his 🍸 😉

AliSoftware · 2015-07-25T00:36:27Z

SwiftGen.playground/Sources/SwiftGenStoryboardEnumBuilder.swift

-        for (name, scenes) in storyboards {
+
+        /// Scenes
+        let s = t


Now that those params are not optional anymore and those intermediate enums can't be omitted, this s can go away and be replaced by t everywhere

@AliSoftware

As noted by @AliSoftware it is not necessary since its «derived» from the `enum`s name. (most likely).

@AliSoftware

- Replaced uses of `s` in favor of all `t`s - As suggested by @AliSoftware assigning the `rawValue` of the segue enum cases to `segue.segueID`

[SwiftGen-Storyboard] Add Segues to the generated enums

esttorhe added 3 commits July 24, 2015 17:15

Generate segues enum.

d773bd8

Added 2 segues; 1 custom & 1 default

a6e13d6

Updated to demonstrate segues support

8b9dfac

AliSoftware reviewed Jul 24, 2015
View reviewed changes

Fixed example to correctly show it working.

e5a6dd6

AliSoftware reviewed Jul 24, 2015
View reviewed changes

esttorhe added 2 commits July 24, 2015 17:49

Added real world usage to the example.

fee904f

Added param to specify scenes enum name.

3b988df

AliSoftware reviewed Jul 24, 2015
View reviewed changes

Separating Scene & Segue tuples

a4a62a8

Added for readability since both tuples are exactly the same but makes reading the code easier.

AliSoftware reviewed Jul 25, 2015
View reviewed changes

esttorhe added 2 commits July 24, 2015 18:09

Removed «optional»ity from parameters

3983edc

Since there's 2 different enums now it is «required» to pass the names of both of them.

Minor fixes

4b809ae

- Added back the `scenesEnumName` explicit name to the `build` method. - Added a `case segue` to the `switch` due to the `outlets` added in the `connections` node.

AliSoftware reviewed Jul 25, 2015
View reviewed changes

AliSoftware mentioned this pull request Jul 25, 2015

Find a way to distribute binaries w/ versioning (Homebrew?) #1

Closed

esttorhe added 2 commits July 24, 2015 19:43

Removed Segue sufix.

a1bb006

As noted by @AliSoftware it is not necessary since its «derived» from the `enum`s name. (most likely).

Housekeeping changes

5c5e2b0

- Replaced uses of `s` in favor of all `t`s - As suggested by @AliSoftware assigning the `rawValue` of the segue enum cases to `segue.segueID`

AliSoftware added a commit that referenced this pull request Jul 25, 2015

Merge pull request #8 from esttorhe/master

1990d29

[SwiftGen-Storyboard] Add Segues to the generated enums

AliSoftware merged commit 1990d29 into SwiftGen:master Jul 25, 2015

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Segues support #8

Segues support #8

esttorhe commented Jul 24, 2015

AliSoftware Jul 24, 2015

esttorhe Jul 24, 2015

AliSoftware Jul 24, 2015

esttorhe Jul 24, 2015

AliSoftware Jul 24, 2015

AliSoftware Jul 24, 2015

esttorhe Jul 24, 2015

AliSoftware Jul 24, 2015

esttorhe Jul 24, 2015

AliSoftware Jul 25, 2015

AliSoftware Jul 24, 2015

esttorhe Jul 24, 2015

AliSoftware Jul 24, 2015

esttorhe Jul 25, 2015

esttorhe Jul 25, 2015

AliSoftware Jul 25, 2015

AliSoftware Jul 25, 2015

esttorhe Jul 25, 2015

AliSoftware Jul 25, 2015

AliSoftware commented Jul 25, 2015

AliSoftware Jul 25, 2015

		@@ -4,7 +4,8 @@ import Foundation

		public final class SwiftGenStoryboardEnumBuilder {
		private typealias Scene = (storyboardID: String, customClass: String?)

Segues support #8

Segues support #8

Conversation

esttorhe commented Jul 24, 2015

Fix #3

Done:

Generated code:

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

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 commented Jul 25, 2015

Choose a reason for hiding this comment