Priority enum by Shehryar · Pull Request #345 · SnapKit/SnapKit

Shehryar · 2016-10-04T15:06:29Z

This adds an enum for priority based constraints allowing users to write priority as:

.priority(level: .low)

Based on the issue #324

MP0w

Can't approve as I'm not that experienced with the SnapKit codebase but the implementation LGTM, probably someone should decide if the old methods can be removed or not.
CI is failed but it's just the usual random erro 65 😞
I would add few tests to make sure the implementation of Strideable is correct

MP0w · 2016-10-06T08:35:08Z

+
+        public init?(rawValue: Float) {
+            // TODO:
+            // constrain to 0 <= x <= 1000


since it's a failable initializer we should return nil for invalid priority (not completely sure that <0 or >1000 is invalid...)

MP0w · 2016-10-06T08:38:09Z

+            case .low:
+                return 250.0
+            case .medium:
+                return 500.0


looks like was 501 for macOS?

MP0w · 2016-10-06T08:40:36Z

-
-    @available(*, deprecated:3.0, message:"Use priority(_ amount: ConstraintPriorityTarget) instead.")
-    @discardableResult
-    public func priorityMedium() -> ConstraintMakerFinalizable {


Maybe we have to keep (but change the implementation) those deprecated methods? Otherwise will need to be a Breaking Change version

robertjpayne · 2016-10-15T06:38:40Z

I agree with most of @MP0w's comments

Shehryar · 2016-10-17T15:02:34Z

Will update this PR soon

…leted methods

Shehryar · 2016-10-28T15:54:34Z

PR is updated! @robertjpayne @MP0w

Shehryar · 2016-10-31T17:40:06Z

still the same exit code 65 error

Shehryar · 2016-11-08T22:26:11Z

TODO: Need to update this again so the old methods can use the new enum values instead of hardcoded values.

MP0w · 2016-11-09T12:49:10Z

+            self = .custom(value: rawValue)
+        }
+
+        var macOSMedium: Float {


I would make it private or use it inline directly. The naming could be something different ? or is this because other platform don't really have medium priority? (AFAIK)

It's mainly because the other platform don't really have a medium priority

MP0w

Ah, also we should change the deprecation message of thew old methods (priorityRequired(), etc) to suggest the new way

Shehryar · 2016-12-21T18:56:49Z

@robertjpayne please re-review! Should I update the warning messages? Or are those good to go?

MP0w · 2017-01-10T23:14:36Z

Any update?

MP0w · 2017-01-10T23:17:01Z


 public class ConstraintMakerPriortizable: ConstraintMakerFinalizable {

+    public enum Priority: Strideable, RawRepresentable, Equatable {


Oh, IMHO this enum should not be inside ConstraintMakerPriortizable.
We don't want to write ConstraintMakerPriortizable.Priority right?

MP0w · 2017-01-10T23:19:37Z


-    @available(*, deprecated:3.0, message:"Use priority(_ amount: ConstraintPriorityTarget) instead.")
+    @discardableResult
+    public func priority(level: Priority) -> ConstraintMakerFinalizable {


Not a fan of the label level.
.priority(.low) feels the natural candidate

MP0w · 2017-01-10T23:22:23Z

-    @available(*, deprecated:3.0, message:"Use priority(_ amount: ConstraintPriorityTarget) instead.")
+    @discardableResult
+    public func priority(level: Priority) -> ConstraintMakerFinalizable {
+        return self.priority(level: ConstraintMakerPriortizable.Priority(rawValue: level.rawValue)!)


Isn't this a loop??! (It's late but really looks like)
Also don't see the point of initializing a priority with another priority...

robertjpayne · 2017-01-19T03:22:26Z

I'll get around to this sorry! I've been insanely busy.

MP0w · 2017-02-10T11:18:19Z

@robertjpayne Hey! Sorry to push but I feel like this improves the APIs and I'm missing it.
Let me know if I can help with anything to merge this pull request.
I also have a couple of other things that would like to be improved or make it easier to use, will open issues ASAP

robertjpayne · 2017-02-11T09:55:28Z

Hey everyone @MP0w included I've merged this but I've also made some tweaks:

Moved the Priority enum to a `ConstraintPriority` struct

There's good reasons to make this a struct rather than an enum. For starters much like enums static members on a struct can be used shorthand:

public struct ConstraintPriority {
    public static var required: ConstraintPriority {...}
}
...
public func priority(_ amount: ConstraintPriority)
...
.priority(.required)

Using a struct also allows users to define their own cases e.g.:

extension ConstraintPriority {
    public var almostRequired: ConstraintPriority { return 999.0 }
}

And ConstraintPriority conforms to expressible by float literal so you do not have to use an initialiser to create it from a float literal value.

Left the priority function that accepts a ConstraintPriorityTarget

I've left this API in for niceties to not break people's code. This is still useful because anything can conform to that protocol and be allowed in the priority function.

Thanks again for your contribution! 👍

robertjpayne · 2017-02-11T09:56:20Z

Also I removed the stride able conformance, I can't see how that is actually useful? Is there a solid use case for that?

EDIT: actually I can see how one may one .required.advance(by: -1)

EDIT2: priority(.required.advance(by: -1) actually produces a compile error so I've again removed the strideable API, If you have to offset a named priority get the raw value and DIY it or add an extra named static case as an extension!

* make 'layoutConstraints' public again (#382) * Fix wrong function call within contentCompressionResistanceHorizontalPriority (#387) * Missing property topMargin on ConstraintMakerExtendable (#393) This pull request adds the missing property "topMargin" to ConstraintMakerExtendable class. * Switched main target build settings' "skip install" default settings to YES. (#391) * Add an isActive API to Constraint * Priority enum (#345) * Adds ConstraintPriority enum to ConstraintMakerPrioritizable * Constraints priority is now more robust * Adds priority enum function * Fixes compile error * Adds failable initializer. Custom macOS medium priority. Adds back deleted methods * Updates depracation messages * Improve Priority API's * Add extra protocol conformances to ConstraintPriority * Tweak priority API's for offseting * Tweak priority API's some more and add tests * Prepare for release

MP0w · 2017-02-11T17:51:54Z

I see the change to struct, the reason for strideable is that you are able to use for example priority(.low + 1), this improves a lot the usage IMHO.
I tested it back then and it worked

MP0w · 2017-02-11T17:53:24Z

That was the implementation #324 (comment)
Might need adaption with a struct

robertjpayne · 2017-02-16T20:20:26Z

@MP0w I couldn't get it to work w/o ambiguous API errors on the struct, I think it worked on the enum because enum cases are slightly different than static members for shorthand mode.

MP0w · 2017-02-16T20:28:05Z

I will try it out, otherwise would you reconsider using an enum? It can still be extended with static vars that return .custom(value) if the only argument was the extensibility

MP0w · 2017-02-16T20:38:14Z

@robertjpayne I tested it in a playground and seems to work https://gist.github.com/MP0w/4cd6df5558f8db2729035c0a25203398
Do you remember any specific issue? Should I try to create a PR?

Shehryar added 5 commits September 21, 2016 11:40

Adds ConstraintPriority enum to ConstraintMakerPrioritizable

12c2fff

Merge remote-tracking branch 'upstream/develop' into develop

276bd19

Constraints priority is now more robust

0e29fa7

Adds priority enum function

69d0c84

Fixes compile error

9cd93f1

Shehryar mentioned this pull request Oct 4, 2016

Feature request: Priority enum #324

Closed

3 tasks

MP0w reviewed Oct 6, 2016

View reviewed changes

Adds failable initializer. Custom macOS medium priority. Adds back de…

64e42f3

…leted methods

MP0w reviewed Nov 9, 2016

View reviewed changes

MP0w reviewed Nov 11, 2016

View reviewed changes

Shehryar added 2 commits December 21, 2016 13:49

Merge remote-tracking branch 'upstream/develop' into develop

bd52875

Updates depracation messages

e1bf943

MP0w suggested changes Jan 10, 2017

View reviewed changes

Merge branch 'develop' into develop

aca6a82

robertjpayne merged commit a7053ad into SnapKit:develop Feb 11, 2017

robertjpayne mentioned this pull request Feb 11, 2017

Release v3.2.0 (#403) #404

Merged


		public class ConstraintMakerPriortizable: ConstraintMakerFinalizable {

		public enum Priority: Strideable, RawRepresentable, Equatable {

Uh oh!

Conversation

Shehryar commented Oct 4, 2016

Uh oh!

MP0w left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

robertjpayne commented Oct 15, 2016

Uh oh!

Shehryar commented Oct 17, 2016

Uh oh!

Shehryar commented Oct 28, 2016

Uh oh!

Shehryar commented Oct 31, 2016

Uh oh!

Shehryar commented Nov 8, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MP0w left a comment

Choose a reason for hiding this comment

Uh oh!

Shehryar commented Dec 21, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MP0w commented Jan 10, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

robertjpayne commented Jan 19, 2017

Uh oh!

MP0w commented Feb 10, 2017

Uh oh!

robertjpayne commented Feb 11, 2017

Moved the Priority enum to a ConstraintPriority struct

Left the priority function that accepts a ConstraintPriorityTarget

Uh oh!

robertjpayne commented Feb 11, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MP0w commented Feb 11, 2017

Uh oh!

MP0w commented Feb 11, 2017

Uh oh!

robertjpayne commented Feb 16, 2017

Uh oh!

MP0w commented Feb 16, 2017

Uh oh!

MP0w commented Feb 16, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Shehryar commented Dec 21, 2016 •

edited

Loading

Moved the Priority enum to a `ConstraintPriority` struct

robertjpayne commented Feb 11, 2017 •

edited

Loading

MP0w commented Feb 16, 2017 •

edited

Loading