Breaking changes for 2.0 #168

Zandor300 · 2019-03-04T18:45:21Z

Fixes #149
Closes #130
Fixes #167
Fixes #165
Closes #174 (Both Swift 5 and the @unknown in switch)
Closes #159

Fixes #164 not being defined in the gyb file.
Fixes #166 not being defined in the gyb file.

Changelog

Breaking changes

The original Device() constructor has been made private in favour of using Device.current to match UIDevice.current.
The enum values for the iPhone Xs, iPhone Xs Max and iPhone Xʀ have been renamed to be .iPhoneXS, .iPhoneXSMax and .iPhoneXR to match proper formatting.
.description for the iPhone Xs, iPhone Xs Max and iPhone Xʀ have been changed to contain small caps formatting for the s and the ʀ part.
.description for the iPad 5 and iPad 6 have been changed to the proper names; iPad (5th generation) and iPad (6th generation).
.name, .systemName, .systemVersion, .model, .localizedModel, .batteryState and .batteryLevel will now all return nil when you try to get its value when the device you are getting it from isn't the current one. (eg. Device.iPad6.name while running on iPad 5)

New features

Updated to Swift 5!
New .allDevicesWithRoundedDisplayCorners and .hasRoundedDisplayCorners values to check if a device has rounded display corners. (eg. iPhone Xs and iPad Pro (3rd generation))
new .allDevicesWithSensorHousing and .hasSensorHousing values to check if a device has a screen cutout for the sensor housing. (eg. iPhone Xs)

Bugfixes

.isPad and .isPhone are now giving correct outputs again.


        Add boolean and array functions to check if the device has a sensor h…

…ousing.


        Move variables together.


        Rename allDevicesWithASensorHousing to allDevicesWithSensorHousing.


        Merge remote-tracking branch 'upstream/master'


        Create allDevicesWithRoundedDisplayCorners and hasRoundedDisplayCorne…

…rs variables.


        Create branch for 2.0 changes.


        Rename iPhone Xs to XS and Xr to XR (fixes #149)


        Fixed generation of allDevicesWithSensorHousing and hasSensorHousing …

…through the gyb file.


        Check if device is current.


        Fixed formatting.


        Check for current device in isZoomed.


        Add documentation to the isCurrent variable.


        Add static current variable and make the initialiser private.


        Revert commit used to create the patch branch in my fork.


        Fixed readme so that it also contains the rename of XS and XR.


        Check for isCurrent on the isPhone and isPad variables when DeviceKit…

… hasn't been updated for a new device yet. (Fixes #165)

dennisweissmann · 2019-03-05T07:23:43Z

Wow thank you for that PR :)

Thanks for the fix of #164, that looks awesome, totally missed that yesterday, that’s definitely the way to go!

This is also a todo list for me since I’m mobile only this month and I don’t know off the top of my head:

are Device.instance and Device.current the same thing? If so lets either remove .current since init() already does the right thing (right?!) or go 100% your approach and replace .instance with .current
thanks for fixing the cases, that’s great! (Should we use the “small capital letters” R and S if at all possible?
should those early-return-if’s be guards?

Thank you for working on this!

Zandor300 · 2019-03-05T07:54:37Z

I think .current indicates better that it is the current device the code is running on. .instance is currently private anyway.
I think there might be problems with some peoples applications if we move to using Xʀ and Xs but I might be wrong. I think it is a cool feature but maybe having a separate String variable for getting the small capital name may prevent problems?
That will definitely be cleaner looking 👍


        Change device description to use small caps on iPhone XS (Max) and iP…

…hone XR.

Zandor300 · 2019-03-05T08:03:54Z

Just changed it to using small caps in 3297936.


        Changed all if !isCurrent statements to guards.

Zandor300 · 2019-03-05T08:09:21Z

Also slapped in those guards: d8b5102


        Remove .instance and the initialiser and completely move over to .cur…

…rent.

Zandor300 · 2019-03-05T08:18:08Z

Just changed everything over to solely .current, you may look at it if you like it and if you don't just change my commit: 05cac80

Zandor300 · 2019-03-05T08:23:26Z

Just noticed; Small caps s is just the same as a lowercase s.

dennisweissmann · 2019-03-05T08:50:53Z

You are awesome! 😎 that is super cool Zander! I really like it :)


        Fixed names of iPad 3, 4, 5 and 6.


        Fix #166 not being added through the gyb file.


        Fix documentation inside code to use Device.current instead of the co…

…nstructor.


        Fixed readme to use Device.current instead of the constructor.

Source/Device.generated.swift

devicekit-danger-bot · 2019-03-29T18:53:53Z

Source/Device.generated.swift

@@ -617,9 +615,10 @@ public enum Device {
      return Device.realDevice(from: self)
    }

-    public var isZoomed: Bool {
+    public var isZoomed: Bool? {
+      guard isCurrent else { return nil }
      // TODO: Longterm we need a better solution for this!


⚠️ TODOs should be resolved (Longterm we need a better solu…).

devicekit-danger-bot · 2019-03-29T18:53:55Z

	1 Error
🚫	Please rebase to get rid of the merge commits in this PR

	2 Warnings
⚠️	Plist changed, don’t forget to localize your plist values
⚠️	Source/Device.generated.swift#L1172 - Prefer empty collection over optional collection.

SwiftLint found issues

Warnings

File	Line	Reason
Device.generated.swift	618	Prefer non-optional booleans over optional booleans.
Device.generated.swift	1172	Prefer empty collection over optional collection.
Device.generated.swift	620	TODOs should be resolved (Longterm we need a better solu...).

Generated by 🚫 Danger


        Fixed trailing whitespace violations.


        Disable the function_body_length rule on mapToDevice(String).

Since this function is generated with a switch for all devices, this needs to be this long.


        Use Xcode 10.2 to build and test the project.

This is required because Swift 5 isn't supported in Xcode 10.1.

dennisweissmann · 2019-03-29T21:58:06Z

We can set something like this up, sure, but since I won’t have the time to contribute or manage very much going forward, I’d like to leave that up to @denisenepraunig


        Set .swift-version to 5.0

denisenepraunig · 2019-03-30T10:56:15Z

@Zandor300 I am fine with WhatsApp or Telegram for direct communication - for questions I have to Dennis I will contact him directly. You can drop me a mail with your number to denise dot nepraunig at gmail dot com.


        Fixed description tests.


        Add iPad (6th gen), iPad Air (3rd gen) and iPad Mini (5th gen) to the…

… description test.


        Merge branch 'patch-1' of https://github.com/Zandor300/DeviceKit into…

… patch-1


        Fixed one test that still used Device().


        Created new test to prevent #165 from happening again.


        Merge branch 'master' into patch-1


        Disable the function_body_length swiftlint rule on the testDescriptio…

…n().


        Added a bunch of tech specs and image links where missing.


        Fixed spacing and another couple urls.


        Add Swift 5 information to the readme.

denisenepraunig

Looks good to me 😊

robbiet480 · 2019-04-05T05:26:48Z

Another warning that needs fixing:

/Users/robbiet480/Repos/HomeAssistant/home-assistant-iOS/Pods/DeviceKit/Source/Device.generated.swift:994:9: Switch covers known cases, but 'WKInterfaceDeviceBatteryState' may have additional unknown values, possibly added in future versions


        Add a default case to the switch to cover future additions to WKInter…

…faceDeviceBatteryState. (Thanks robbiet480)

Zandor300 · 2019-04-05T06:02:28Z

@robbiet480 Thanks for the catch! Fixed it in 11353eb.

robbiet480 · 2019-04-08T03:56:35Z

@denisenepraunig LGTM!

Zandor300 added 16 commits Feb 28, 2019

Add boolean and array functions to check if the device has a sensor h…

Loading status checks…

16383c5

…ousing.

Move variables together.

Verified

This commit was created on GitHub.com and signed with a verified signature using GitHub’s key.

GPG key ID: 4AEE18F83AFDEB23 Learn about signing commits

Loading status checks…

6bd7410

Rename allDevicesWithASensorHousing to allDevicesWithSensorHousing.

Verified

This commit was created on GitHub.com and signed with a verified signature using GitHub’s key.

GPG key ID: 4AEE18F83AFDEB23 Learn about signing commits

Loading status checks…

8fc0c1f

Merge remote-tracking branch 'upstream/master'

eb4f624

Create allDevicesWithRoundedDisplayCorners and hasRoundedDisplayCorne…

Loading status checks…

3a8bd5e

…rs variables.

Create branch for 2.0 changes.

Verified

This commit was created on GitHub.com and signed with a verified signature using GitHub’s key.

GPG key ID: 4AEE18F83AFDEB23 Learn about signing commits

60ecca4

Rename iPhone Xs to XS and Xr to XR (fixes #149)

3b5c2ad

Fixed generation of allDevicesWithSensorHousing and hasSensorHousing …

374ff4e

…through the gyb file.

Check if device is current.

29d2090

Fixed formatting.

7fd93ec

Check for current device in isZoomed.

7a5b4e9

Add documentation to the isCurrent variable.

19cc90f

Add static current variable and make the initialiser private.

6d71f31

Revert commit used to create the patch branch in my fork.

e72edc5

Fixed readme so that it also contains the rename of XS and XR.

fa65674

Check for isCurrent on the isPhone and isPad variables when DeviceKit…

f2145b8

… hasn't been updated for a new device yet. (Fixes #165)

Change device description to use small caps on iPhone XS (Max) and iP…

3297936

…hone XR.

Changed all if !isCurrent statements to guards.

d8b5102

Remove .instance and the initialiser and completely move over to .cur…

05cac80

…rent.

Zandor300 added 4 commits Mar 5, 2019

Fixed names of iPad 3, 4, 5 and 6.

463b708

Fix #166 not being added through the gyb file.

c834fe5

Fix documentation inside code to use Device.current instead of the co…

5458bb7

…nstructor.

Fixed readme to use Device.current instead of the constructor.

e43df4f

devicekit-danger-bot reviewed Mar 29, 2019

View changes

Source/Device.generated.swift Show resolved Hide resolved

devicekit-danger-bot reviewed Mar 29, 2019

View changes

This comment was marked as spam.

Sign in to view

Zandor300 added 3 commits Mar 29, 2019

Fixed trailing whitespace violations.

149fc52

Disable the function_body_length rule on mapToDevice(String).

Loading status checks…

93dcd67

Since this function is generated with a switch for all devices, this needs to be this long.

Use Xcode 10.2 to build and test the project.

Loading status checks…

123a950

This is required because Swift 5 isn't supported in Xcode 10.1.

Set .swift-version to 5.0

Verified

This commit was created on GitHub.com and signed with a verified signature using GitHub’s key.

GPG key ID: 4AEE18F83AFDEB23 Learn about signing commits

Loading status checks…

dbe45bd

Zandor300 added 10 commits Mar 30, 2019

Fixed description tests.

a0601cd

Add iPad (6th gen), iPad Air (3rd gen) and iPad Mini (5th gen) to the…

e8448b9

… description test.

Merge branch 'patch-1' of https://github.com/Zandor300/DeviceKit into…

Loading status checks…

1a8610f

… patch-1

Fixed one test that still used Device().

Loading status checks…

416e764

Created new test to prevent #165 from happening again.

Loading status checks…

3526e3f

Merge branch 'master' into patch-1

Verified

This commit was created on GitHub.com and signed with a verified signature using GitHub’s key.

GPG key ID: 4AEE18F83AFDEB23 Learn about signing commits

Loading status checks…

42395a1

Disable the function_body_length swiftlint rule on the testDescriptio…

Loading status checks…

5689963

…n().

Added a bunch of tech specs and image links where missing.

ea46929

Fixed spacing and another couple urls.

Loading status checks…

3667112

Add Swift 5 information to the readme.

Verified

This commit was created on GitHub.com and signed with a verified signature using GitHub’s key.

GPG key ID: 4AEE18F83AFDEB23 Learn about signing commits

Loading status checks…

c2a10c3

denisenepraunig reviewed Apr 1, 2019

View changes

Add a default case to the switch to cover future additions to WKInter…

Loading status checks…

11353eb

…faceDeviceBatteryState. (Thanks robbiet480)

Zandor300 dismissed denisenepraunig’s stale review via 11353eb Apr 5, 2019

robbiet480 approved these changes Apr 8, 2019

View changes

Zandor300 mentioned this pull request Apr 10, 2019

Add property to determine if device is compatible with Apple Pencil #177

Closed

denisenepraunig merged commit 802e405 into devicekit:master Apr 10, 2019
1 check failed

1 check failed

continuous-integration/travis-ci/pr The Travis CI build failed
Details

devicekit / DeviceKit

Breaking changes for 2.0 #168

Breaking changes for 2.0 #168

Zandor300 commented Mar 4, 2019 •

edited

dennisweissmann commented Mar 5, 2019

Zandor300 commented Mar 5, 2019

Zandor300 commented Mar 5, 2019

Zandor300 commented Mar 5, 2019

Zandor300 commented Mar 5, 2019

Zandor300 commented Mar 5, 2019

dennisweissmann commented Mar 5, 2019

This comment has been minimized.

This comment was marked as spam.

devicekit-danger-bot commented Mar 29, 2019 •

edited

dennisweissmann commented Mar 29, 2019

denisenepraunig commented Mar 30, 2019

denisenepraunig left a comment

robbiet480 commented Apr 5, 2019

Zandor300 commented Apr 5, 2019

robbiet480 commented Apr 8, 2019

devicekit / DeviceKit

Join GitHub today

Breaking changes for 2.0 #168

Breaking changes for 2.0 #168

Conversation

Zandor300 commented Mar 4, 2019 • edited

Changelog

Breaking changes

New features

Bugfixes

dennisweissmann commented Mar 5, 2019

Zandor300 commented Mar 5, 2019

Zandor300 commented Mar 5, 2019

Zandor300 commented Mar 5, 2019

Zandor300 commented Mar 5, 2019

Zandor300 commented Mar 5, 2019

dennisweissmann commented Mar 5, 2019

This comment has been minimized.

devicekit-danger-bot Mar 29, 2019

This comment was marked as spam.

devicekit-danger-bot commented Mar 29, 2019 • edited

SwiftLint found issues

Warnings

dennisweissmann commented Mar 29, 2019

denisenepraunig commented Mar 30, 2019

denisenepraunig left a comment

robbiet480 commented Apr 5, 2019

Zandor300 commented Apr 5, 2019

robbiet480 commented Apr 8, 2019

Zandor300 commented Mar 4, 2019 •

edited

devicekit-danger-bot commented Mar 29, 2019 •

edited