Added new protocol for UIViewController to instantiate it from storyboard #860

VatoKo · 2020-06-04T09:47:37Z

Checklist

I checked the Contributing Guidelines before creating this request.
New extensions are written in Swift 5.0.
New extensions support iOS 10.0+ / tvOS 9.0+ / macOS 10.10+ / watchOS 2.0+, or use @available if not.
I have added tests for new extensions, and they passed.
All extensions have a clear comments explaining their functionality, all parameters and return type in English.
All extensions are declared as public.
I have added a changelog entry describing my changes.

…oard

VatoKo · 2020-06-04T09:52:24Z

Here I thought about making extension to UIViewController directly, but then every time you instantiated a custom UIViewController, you would have to cast it to your type as the return type for the function would be 'UIViewController'. In this way that casting won't be necessary.

Sources/SwifterSwift/UIKit/UIViewControllerExtensions.swift

guykogus

@VatoKo I have a similar extension that you can use here, without any extra protocol or anything.

public extension UIViewController {
    class func newFromStoryboard(storyboardName: String = "Main",
                                 storyboardBundle: Bundle? = nil,
                                 identifier: String? = nil) -> Self {
        return UIStoryboard(name: storyboardName, bundle: storyboardBundle)
            .instantiateViewController(withIdentifier: identifier ?? String(describing: self)) as! Self // swiftlint:disable:this force_cast
    }
}

Why don't you adapt that?

VatoKo · 2020-06-04T11:08:46Z

Okay, I'll try. Thanks 😊

VatoKo · 2020-06-04T12:13:57Z

@guykogus I updated the code the way you suggested. Besides, how would you unit test this code?

guykogus

Don't forget to add unit tests and a CHANGELOG entry.

Sources/SwifterSwift/UIKit/UIViewControllerExtensions.swift

LucianoPAlmeida · 2020-06-05T21:43:09Z

@VatoKo There are a couple of swiftlint issues which needs to be addressed

Tests/UIKitTests/UIViewControllerExtensionsTests.swift

Sources/SwifterSwift/UIKit/UIViewControllerExtensions.swift

codecov · 2020-06-08T12:54:28Z

Codecov Report

Merging #860 into master will decrease coverage by 0.02%.
The diff coverage is 83.33%.

@@            Coverage Diff             @@
##           master     #860      +/-   ##
==========================================
- Coverage   95.49%   95.47%   -0.03%     
==========================================
  Files         100      100              
  Lines        3399     3405       +6     
==========================================
+ Hits         3246     3251       +5     
- Misses        153      154       +1

Flag	Coverage Δ
#ios	`95.58% <83.33%> (-0.03%)`	⬇️
#macos	`97.08% <ø> (ø)`
#tvos	`93.56% <83.33%> (-0.02%)`	⬇️

Impacted Files	Coverage Δ
...wifterSwift/UIKit/UIViewControllerExtensions.swift	`95.91% <83.33%> (-1.76%)`	⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 02f65f5...7fdbbe0. Read the comment docs.

Sources/SwifterSwift/UIKit/UIViewControllerExtensions.swift

Tests/UIKitTests/UIViewControllerExtensionsTests.swift

LucianoPAlmeida · 2020-07-01T02:12:43Z

Closing due inactivity, @VatoKo feel free to reopen if you still want to move this forward :)

VatoKo · 2020-07-01T07:29:16Z

@LucianoPAlmeida I was waiting for the final decision from you actually 😄I'll make changes according to the way you suggested.

guykogus

Looking good, but left you a few small points.

CHANGELOG.md

Sources/SwifterSwift/UIKit/UIViewControllerExtensions.swift

Tests/UIKitTests/UIViewControllerExtensionsTests.swift

guykogus · 2020-07-01T09:15:18Z

@guykogus I get "Could not find a storyboard named 'TestStoryboard' in bundle..." error on unit test. I checked already existing unit test where this storyboard is used and those tests are failing too. Any idea what could be causing this?

I'm not really sure. It may be to do with catalyst. You may need to add #if !targetEnvironment(macCatalyst). Give it a try.
Also, make sure that you're open the project in Xcode via the SwifterSwift.xcworkspace file in Finder. If you try to open the project directly from Xcode it will open it as a Swift package, which doesn't support resources (until Xcode 12).

VatoKo · 2020-07-01T09:36:43Z

@guykogus I've always opened the project via SwifterSwift.xcworkspace, no problem with that. Tried #if !targetEnvironment(macCatalyst) check and it's still failing as you can see. 😕

Tests/UIKitTests/UIViewControllerExtensionsTests.swift

Tests/ResourcesTests/MyViewController.swift

LucianoPAlmeida · 2020-07-01T20:43:40Z

We have a problem with the build

Tests/UIKitTests/UIViewControllerExtensionsTests.swift#L59: use of unresolved identifier ‘MyViewController’ 
let myViewController = MyViewController.instantiate(from: "TestStoryboard", bundle: Bundle(for: UIViewControllerExtensionsTests.self))

guykogus · 2020-07-02T08:25:24Z

We have a problem with the build

Tests/UIKitTests/UIViewControllerExtensionsTests.swift#L59: use of unresolved identifier ‘MyViewController’ 
let myViewController = MyViewController.instantiate(from: "TestStoryboard", bundle: Bundle(for: UIViewControllerExtensionsTests.self))

Do you have any more context for this error?

LucianoPAlmeida · 2020-07-02T10:26:08Z

Nope, I just copied what danger is saying :)

VatoKo · 2020-07-02T15:21:11Z

I don't have such problem. The code compiles and even passes the test successfully.

LucianoPAlmeida · 2020-07-02T15:49:40Z

Ok I'll take a look ASAP :)

SwifterSwiftBot · 2020-07-03T00:43:57Z

	4 Messages
📖	Thank you for submitting a pull request to SwifterSwift. The team will review your submission as soon as possible.
📖	iOS: Executed 680 tests, with 0 failures (0 unexpected) in 22.793 (24.513) seconds
📖	tvOS: Executed 645 tests, with 0 failures (0 unexpected) in 3.711 (4.152) seconds
📖	macOS: Executed 511 tests, with 0 failures (0 unexpected) in 6.251 (6.489) seconds

Generated by 🚫 Danger

guykogus · 2020-07-03T14:17:24Z

@VatoKo I went ahead and fixed it for you. I was actually curious to see if I could push to your fork. I guess I can cos I have superpowers? 😅

The main issue was for the tvOS tests. We needed a separate storyboard for tvOS, since storyboards aren't cross-platform.

VatoKo · 2020-07-03T15:13:25Z

@guykogus I guess I have to say thank you 😄

LucianoPAlmeida

Great

* 'master' of https://github.com/SwifterSwift/SwifterSwift: (79 commits) Helper functions for scrolling to the edges or by page of a scroll view (SwifterSwift#888) Add XCTest extension for comparing Color objects (SwifterSwift#889) Fix swiftlint error (SwifterSwift#894) Bump kramdown from 2.1.0 to 2.3.0 (SwifterSwift#891) Added note for UIView.addShadow() (SwifterSwift#890) loadFromNib(withClass) (SwifterSwift#885) constraint finders (widthConstraint, heightConstraint, leadingConstraint, trailingConstraint, topConstraint, bottomConstraint) (SwifterSwift#886) added String.regexEscaped (SwifterSwift#883) Make √ generic for FloatingPoint values (SwifterSwift#880) Update UITextField extensions (SwifterSwift#878) Added `masksToBounds` (IBInspectable) extension (SwifterSwift#877) Reinstate debounce function (SwifterSwift#869) `RandomAccessCollection`/`Collection` generalisations (SwifterSwift#863) Added HKActivitySummary extensions (SwifterSwift#875) Added new method for easily instantiating a view controller from a storyboard (SwifterSwift#860) Clean up code (SwifterSwift#864) fixed "".truncated crashed (SwifterSwift#866) Deprecated map(by:), compactMap(by:), filter(by:) (SwifterSwift#862) Overloaded 'contains' operator for string regex matching (SwifterSwift#858) Added convenient wrapper to asyncAfter (SwifterSwift#859) ... # Conflicts: # Sources/SwifterSwift/AppKit/NSColorExtensions.swift # Sources/SwifterSwift/AppKit/NSImageExtensions.swift # Sources/SwifterSwift/AppKit/NSViewExtensions.swift # Sources/SwifterSwift/CoreGraphics/CGColorExtensions.swift # Sources/SwifterSwift/CoreGraphics/CGFloatExtensions.swift # Sources/SwifterSwift/CoreGraphics/CGPointExtensions.swift # Sources/SwifterSwift/CoreGraphics/CGSizeExtensions.swift # Sources/SwifterSwift/Foundation/NSAttributedStringExtensions.swift # Sources/SwifterSwift/SwiftStdlib/StringExtensions.swift # SwifterSwift.xcodeproj/project.pbxproj # Tests/AppKitTests/NSColorExtensionsTests.swift # Tests/SwiftStdlibTests/StringExtensionsTests.swift

Added new protocol for UIViewController to instantiate it from storyb…

12ebdb8

…oard

LucianoPAlmeida reviewed Jun 4, 2020

View reviewed changes

Sources/SwifterSwift/UIKit/UIViewControllerExtensions.swift Outdated Show resolved Hide resolved

VatoKo closed this Jun 4, 2020

guykogus reviewed Jun 4, 2020

View reviewed changes

VatoKo reopened this Jun 4, 2020

Refactored instantiate method to use without using the protocol

59f170a

guykogus requested changes Jun 4, 2020

View reviewed changes

Sources/SwifterSwift/UIKit/UIViewControllerExtensions.swift Outdated Show resolved Hide resolved

Sources/SwifterSwift/UIKit/UIViewControllerExtensions.swift Outdated Show resolved Hide resolved

VatoKo added 4 commits June 4, 2020 17:28

Made minor changes, added entry to changelog

8303069

Merge branch 'master' into instantiate-view-controller

d58f127

Added unit test for instantiate function

41911d5

Resolved merge

83a9b5f

guykogus requested changes Jun 8, 2020

View reviewed changes

Tests/UIKitTests/UIViewControllerExtensionsTests.swift Outdated Show resolved Hide resolved

Tests/UIKitTests/UIViewControllerExtensionsTests.swift Outdated Show resolved Hide resolved

Tests/UIKitTests/UIViewControllerExtensionsTests.swift Outdated Show resolved Hide resolved

LucianoPAlmeida reviewed Jun 8, 2020

View reviewed changes

Sources/SwifterSwift/UIKit/UIViewControllerExtensions.swift Outdated Show resolved Hide resolved

VatoKo added 2 commits June 8, 2020 16:40

Minor refactor

ae08cfb

Added preconditionFailure check while instantiting view controller

90c7a0a

guykogus requested changes Jun 8, 2020

View reviewed changes

Sources/SwifterSwift/UIKit/UIViewControllerExtensions.swift Outdated Show resolved Hide resolved

Fixed spacing issues

3618c1e

guykogus reviewed Jun 8, 2020

View reviewed changes

Tests/UIKitTests/UIViewControllerExtensionsTests.swift Outdated Show resolved Hide resolved

LucianoPAlmeida closed this Jul 1, 2020

VatoKo reopened this Jul 1, 2020

VatoKo added 2 commits July 1, 2020 11:30

Modified unit test for instantiate function

eae020c

Merge branch 'master' into instantiate-view-controller

096a60b

guykogus requested changes Jul 1, 2020

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

Sources/SwifterSwift/UIKit/UIViewControllerExtensions.swift Outdated Show resolved Hide resolved

Tests/UIKitTests/UIViewControllerExtensionsTests.swift Outdated Show resolved Hide resolved

VatoKo added 2 commits July 1, 2020 13:22

Refactor instantiate unit test

71fcedf

Resolve merge

f64ee86

guykogus reviewed Jul 1, 2020

View reviewed changes

Tests/UIKitTests/UIViewControllerExtensionsTests.swift Outdated Show resolved Hide resolved

guykogus reviewed Jul 1, 2020

View reviewed changes

Tests/UIKitTests/UIViewControllerExtensionsTests.swift Outdated Show resolved Hide resolved

Tests/UIKitTests/UIViewControllerExtensionsTests.swift Show resolved Hide resolved

Fixed unit test failing

7ac8aa7

guykogus reviewed Jul 1, 2020

View reviewed changes

Tests/UIKitTests/UIViewControllerExtensionsTests.swift Outdated Show resolved Hide resolved

Remove targetEnvironment check

ed2bcd4

guykogus approved these changes Jul 1, 2020

View reviewed changes

guykogus requested changes Jul 1, 2020

View reviewed changes

Tests/ResourcesTests/MyViewController.swift Outdated Show resolved Hide resolved

Fixed build for Linux

74cc125

guykogus previously approved these changes Jul 1, 2020

View reviewed changes

LucianoPAlmeida previously approved these changes Jul 1, 2020

View reviewed changes

SwifterSwift deleted a comment from SwifterSwiftBot Jul 3, 2020

Fix unit tests

7fdbbe0

guykogus dismissed stale reviews from LucianoPAlmeida and themself via 7fdbbe0 July 3, 2020 14:15

LucianoPAlmeida approved these changes Jul 3, 2020

View reviewed changes

guykogus approved these changes Jul 3, 2020

View reviewed changes

guykogus merged commit f75ea86 into SwifterSwift:master Jul 3, 2020

Added new protocol for UIViewController to instantiate it from storyboard #860

Added new protocol for UIViewController to instantiate it from storyboard #860

Uh oh!

Conversation

VatoKo commented Jun 4, 2020 • edited by guykogus Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Uh oh!

VatoKo commented Jun 4, 2020

Uh oh!

Uh oh!

guykogus left a comment

Choose a reason for hiding this comment

Uh oh!

VatoKo commented Jun 4, 2020

Uh oh!

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

Uh oh!

Uh oh!

guykogus left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

LucianoPAlmeida commented Jun 5, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

LucianoPAlmeida commented Jul 1, 2020

Uh oh!

VatoKo commented Jul 1, 2020

Uh oh!

guykogus left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

guykogus commented Jul 1, 2020

Uh oh!

VatoKo commented Jul 1, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

LucianoPAlmeida commented Jul 1, 2020

Uh oh!

guykogus commented Jul 2, 2020

Uh oh!

LucianoPAlmeida commented Jul 2, 2020

Uh oh!

VatoKo commented Jul 2, 2020

Uh oh!

LucianoPAlmeida commented Jul 2, 2020

Uh oh!

SwifterSwiftBot commented Jul 3, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

guykogus commented Jul 3, 2020

Uh oh!

VatoKo commented Jul 3, 2020

Uh oh!

LucianoPAlmeida left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

VatoKo commented Jun 4, 2020 •

edited by guykogus

Loading

VatoKo commented Jun 4, 2020 •

edited

Loading

codecov bot commented Jun 8, 2020 •

edited

Loading

SwifterSwiftBot commented Jul 3, 2020 •

edited

Loading