Skip to content

Updates to Workflow Templates #100

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 5, 2021
Merged

Updates to Workflow Templates #100

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b456e4b
* Added ability to create a workflow without a worker
monishsyed Sep 6, 2021
067a285
Separating templates to default(without worker), with RxSwift Worker …
monishsyed Sep 6, 2021
0e42d35
Removing symlinks and adding copies of ___FILEBASENAME___Workflow.swift
monishsyed Sep 8, 2021
733177f
Changed default selection for worker type from RxSwift to ReactiveSwift
monishsyed Sep 9, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 0 additions & 18 deletions ...template/___FILEBASENAME___Workflow.swift → .../Default/___FILEBASENAME___Workflow.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
// ___FILEHEADER___

import ReactiveSwift
import Workflow
import WorkflowReactiveSwift
import WorkflowUI

// MARK: Input and Output
Expand Down Expand Up @@ -37,22 +35,6 @@ extension ___VARIABLE_productName___Workflow {
}
}

// MARK: Workers

extension ___VARIABLE_productName___Workflow {
struct ___VARIABLE_productName___Worker: Worker {
enum Output {}

func run() -> SignalProducer<Output, Never> {
fatalError()
}

func isEquivalent(to otherWorker: ___VARIABLE_productName___Worker) -> Bool {
return true
}
}
}

// MARK: Rendering

extension ___VARIABLE_productName___Workflow {
Expand Down
42 changes: 41 additions & 1 deletion Tooling/Templates/Workflow (Verbose).xctemplate/TemplateInfo.plist
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,52 @@
<key>Name</key>
<string>Name:</string>
<key>Description</key>
<string>The name of the workflow to create. "Workflow" will be appended to the name.</string>
<string>The name of the workflow to create. &quot;Workflow&quot; will be appended to the name.</string>
<key>Type</key>
<string>text</string>
<key>Default</key>
<string>HelloWorld</string>
</dict>
<dict>
<key>Identifier</key>
<string>generateWorker</string>
<key>Required</key>
<true/>
<key>Name</key>
<string>Also create a Worker</string>
<key>Description</key>
<string>Workers define a unit of asynchronous work</string>
<key>Type</key>
<string>checkbox</string>
<key>Default</key>
<string>false</string>
</dict>
<dict>
<key>Identifier</key>
<string>streamType</string>
<key>Required</key>
<true/>
<key>Name</key>
<string>Uses:</string>
<key>Description</key>
<string>Whether to use RxSwift or ReactiveSwift</string>
<key>Type</key>
<string>popup</string>
<key>Default</key>
<string>RxSwift</string>
<key>RequiredOptions</key>
<dict>
<key>generateWorker</key>
<array>
<string>true</string>
</array>
</dict>
<key>Values</key>
<array>
<string>RxSwift</string>
<string>ReactiveSwift</string>
</array>
</dict>
</array>
</dict>
</plist>
22 changes: 22 additions & 0 deletions .../Workflow (Verbose).xctemplate/generateWorkerReactiveSwift/___FILEBASENAME___Worker.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
// ___FILEHEADER___

import ReactiveSwift
import Workflow
import WorkflowReactiveSwift
import WorkflowUI

// MARK: Workers

extension ___VARIABLE_productName___Workflow {
struct ___VARIABLE_productName___Worker: Worker {
enum Output {}

func run() -> SignalProducer<Output, Never> {
fatalError()
}

func isEquivalent(to otherWorker: ___VARIABLE_productName___Worker) -> Bool {
return true
}
}
}
1 change: 1 addition & 0 deletions ...orkflow (Verbose).xctemplate/generateWorkerReactiveSwift/___FILEBASENAME___Workflow.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/Users/monishsyed/Development/Personal/workflow-swift/Tooling/Templates/Workflow (Verbose).xctemplate/Default/___FILEBASENAME___Workflow.swift
22 changes: 22 additions & 0 deletions ...plates/Workflow (Verbose).xctemplate/generateWorkerRxSwift/___FILEBASENAME___Worker.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
// ___FILEHEADER___

import RxSwift
import Workflow
import WorkflowRxSwift
import WorkflowUI

// MARK: Workers

extension ___VARIABLE_productName___Workflow {
struct ___VARIABLE_productName___Worker: Worker {
enum Output {}

func run() -> Observable<Output> {
fatalError()
}

func isEquivalent(to otherWorker: ___VARIABLE_productName___Worker) -> Bool {
return true
}
}
}
1 change: 1 addition & 0 deletions ...ates/Workflow (Verbose).xctemplate/generateWorkerRxSwift/___FILEBASENAME___Workflow.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/Users/monishsyed/Development/Personal/workflow-swift/Tooling/Templates/Workflow (Verbose).xctemplate/Default/___FILEBASENAME___Workflow.swift
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need this file? The pathname should be relative.

Copy link
Contributor Author

@monishsyed monishsyed Sep 8, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the symlink for the original file that resides under Tooling/Templates/Workflow (Verbose).xctemplate/Default/. Even though I had created the symlink with the relative path, seems like symlinks cannot resolve relative paths and so symlinks have to have absolute path ALWAYS.

Why was symlink created in the first place?

It was created to overcome a limitation that we have with xcode files templates i.e files templates cannot be inherited from other templates (project templates can have ancestors though but not file templates) and therefore when creating a template that has RxSwift/ReactiveSwift worker enabled, both ___FILEBASENAME___Workflow.swift and __FILEBASENAME___Worker.swift has to be provided inside generateWorkerRxSwift and generateWorkerReactiveSwift. This leaves us in a situation where ___FILEBASENAME___Workflow.swift will have 3 identical copies and any changes to ___FILEBASENAME___Workflow.swift would require updates to all 3. Symlinks was one solution since it allows you to create aliases for these files. But as you can see, symlinks don't work with relative paths unfortunately :(

What are other options to avoid duplication of ___FILEBASENAME___Workflow.swift?

  1. Maybe just have one copy ___FILEBASENAME___Workflow.swift in Default and run copy commands as part of install-xcode-templates.sh script that copies it in generateWorkerRxSwift and generateWorkerReactiveSwift. Downside is without running the script, the template is pretty much broken. Ideally script should only be there to help you install templates.
  2. Generate the full templates through scripts. May need a bit of work there.
  3. Keep 3 copies of ___FILEBASENAME___Workflow.swift if we don’t anticipate changes to the templates often. I think it should ok for 1.0.0.

What do you all think?

P.S: For workflow template to work correctly, the file/directory structure should look like this

Screen Shot 2021-09-08 at 6 18 04 PM

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Went ahead and added back copies of ___FILEBASENAME___Workflow.swift for now