Skip to content

Commit

Permalink
Remove deprected APIs
Browse files Browse the repository at this point in the history
  • Loading branch information
@kean
kean committed Jun 18, 2020
1 parent cd7603b commit 03800b4
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 300 deletions.
4 changes: 2 additions & 2 deletions Align.playground/Pages/Demo.xcplaygroundpage/Contents.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ class MyViewController : UIViewController {

/// Here's code written using Align

stack.anchors.center.alignWithSuperview()
stack.anchors.edges(.left, .right).pinToSuperviewMargins(relation: .greaterThanOrEqual)
stack.anchors.centerY.align()
stack.anchors.edges.pin(to: view.layoutMarginsGuide, axis: .horizontal, alignment: .center)

logo.text = "⛵️"
title.text = "Welcome to Align!"
Expand Down
2 changes: 1 addition & 1 deletion Align.playground/contents.xcplayground
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<playground version='6.0' target-platform='ios'>
<pages>
<page name='Demo'/>
<page name='Alignments'/>
<page name='Example'/>
</pages>
</playground>
184 changes: 19 additions & 165 deletions Sources/Align.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ public extension LayoutAnchors where Base: LayoutItem {

// MARK: Anchor Collections

var edges: AnchorCollectionEdges { AnchorCollectionEdges(item: base, edges: [.left, .right, .bottom, .top]) }
var edges: AnchorCollectionEdges { AnchorCollectionEdges(item: base) }
var center: AnchorCollectionCenter { AnchorCollectionCenter(x: centerX, y: centerY) }
var size: AnchorCollectionSize { AnchorCollectionSize(width: width, height: height) }
}
Expand Down Expand Up @@ -157,18 +157,29 @@ public extension Anchor where Type: AnchorType.Dimension {
}
}

// MARK: - Anchors (AnchorType.Dimension)

extension Anchor where Type: AnchorType.Dimension {
@discardableResult public func equal(_ constant: CGFloat) -> NSLayoutConstraint {
Constraints.constrain(item: item, attribute: attribute, relatedBy: .equal, constant: constant)
}

@discardableResult public func greaterThanOrEqual(_ constant: CGFloat) -> NSLayoutConstraint {
Constraints.constrain(item: item, attribute: attribute, relatedBy: .greaterThanOrEqual, constant: constant)
}

@discardableResult public func lessThanOrEqual(_ constant: CGFloat) -> NSLayoutConstraint {
Constraints.constrain(item: item, attribute: attribute, relatedBy: .lessThanOrEqual, constant: constant)
}
}

// MARK: - Anchors (AnchorType.Edge)

extension Anchor where Type: AnchorType.Edge {
/// Pins the edge to the respected edges of the given container.
@discardableResult public func pin(to container: LayoutItem? = nil, inset: CGFloat = 0) -> NSLayoutConstraint {
_pin(to: container ?? item.superview!, attribute: attribute, inset: inset, relation: .equal)
}

// Pin the anchor to another layout item.
private func _pin(to item2: Any?, attribute attr2: NSLayoutConstraint.Attribute, inset: CGFloat, relation: NSLayoutConstraint.Relation) -> NSLayoutConstraint {
let isInverted = [.trailing, .right, .bottom].contains(attribute)
return Constraints.constrain(self, toItem: item2, attribute: attr2, constant: (isInverted ? -inset : inset), relation: (isInverted ? relation.inverted : relation))
return Constraints.constrain(self, toItem: container ?? item.superview!, attribute: attribute, constant: (isInverted ? -inset : inset))
}

/// Adds spacing between the current anchors.
Expand All @@ -189,22 +200,6 @@ extension Anchor where Type: AnchorType.Center {
}
}

// MARK: - Anchors (AnchorType.Dimension)

extension Anchor where Type: AnchorType.Dimension {
@discardableResult public func equal(_ constant: CGFloat) -> NSLayoutConstraint {
Constraints.constrain(item: item, attribute: attribute, relatedBy: .equal, constant: constant)
}

@discardableResult public func greaterThanOrEqual(_ constant: CGFloat) -> NSLayoutConstraint {
Constraints.constrain(item: item, attribute: attribute, relatedBy: .greaterThanOrEqual, constant: constant)
}

@discardableResult public func lessThanOrEqual(_ constant: CGFloat) -> NSLayoutConstraint {
Constraints.constrain(item: item, attribute: attribute, relatedBy: .lessThanOrEqual, constant: constant)
}
}

// MARK: - AnchorCollectionEdges

public struct Alignmment {
Expand Down Expand Up @@ -236,12 +231,11 @@ public struct Alignmment {

public struct AnchorCollectionEdges {
let item: LayoutItem
let edges: [LayoutEdge]
var isAbsolute = false

// By default, edges use locale-specific `.leading` and `.trailing`
public func absolute() -> AnchorCollectionEdges {
AnchorCollectionEdges(item: item, edges: edges, isAbsolute: true)
AnchorCollectionEdges(item: item, isAbsolute: true)
}

#if os(iOS) || os(tvOS)
Expand Down Expand Up @@ -415,31 +409,6 @@ public extension NSEdgeInsets {
}
#endif

public enum LayoutEdge {
case top, bottom, leading, trailing, left, right

var attribute: NSLayoutConstraint.Attribute {
switch self {
case .top: return .top; case .bottom: return .bottom
case .leading: return .leading; case .trailing: return .trailing
case .left: return .left; case .right: return .right
}
}
}

#if os(iOS) || os(tvOS)
extension NSLayoutConstraint.Attribute {
var toMargin: NSLayoutConstraint.Attribute {
switch self {
case .top: return .topMargin; case .bottom: return .bottomMargin
case .leading: return .leadingMargin; case .trailing: return .trailingMargin
case .left: return .leftMargin case .right: return .rightMargin
default: return self
}
}
}
#endif

extension NSLayoutConstraint.Relation {
var inverted: NSLayoutConstraint.Relation {
switch self {
Expand All @@ -461,118 +430,3 @@ extension EdgeInsets {
}
}
}

// MARK: - Deprecated

public extension LayoutItem {
@available(*, deprecated, message: "Renamed to `anchors`")
@nonobjc var al: LayoutAnchors<Self> { LayoutAnchors(base: self) }
}

public extension LayoutAnchors where Base: LayoutItem {
@available(*, deprecated, message: "Please use `pin()` instead. Instead of selecting specific edges, pass an `axis` in the `pin()` method as a parameter. See README.md for more information.")
func edges(_ edges: LayoutEdge...) -> AnchorCollectionEdges { AnchorCollectionEdges(item: base, edges: edges) }
}

extension Anchor where Type: AnchorType.Edge {
@available(*, deprecated, message: "Please use `pin()` instead. Instead of selecting specific edges, pass an `axis` in the `pin()` method as a parameter. See README.md for more information.")
@discardableResult public func pin(to container: LayoutItem? = nil, inset: CGFloat = 0, relation: NSLayoutConstraint.Relation) -> NSLayoutConstraint {
_pin(to: container ?? item.superview!, attribute: attribute, inset: inset, relation: relation)
}

@available(*, deprecated, message: "Please use `pin()` instead. Instead of selecting specific edges, pass an `axis` in the `pin()` method as a parameter. See README.md for more information.")
@discardableResult public func pinToSuperview(inset: CGFloat = 0, relation: NSLayoutConstraint.Relation = .equal) -> NSLayoutConstraint {
_pin(to: item.superview!, attribute: attribute, inset: inset, relation: relation)
}

#if os(iOS) || os(tvOS)
@available(*, deprecated, message: "Please use `pin()` instead. Instead of selecting specific edges, pass an `axis` in the `pin()` method as a parameter. See README.md for more information.")
@discardableResult public func pinToSuperviewMargin(inset: CGFloat = 0, relation: NSLayoutConstraint.Relation = .equal) -> NSLayoutConstraint {
_pin(to: item.superview!, attribute: attribute.toMargin, inset: inset, relation: relation)
}

@available(*, deprecated, message: "Please use `pin()` instead. Instead of selecting specific edges, pass an `axis` in the `pin()` method as a parameter. See README.md for more information.")
@discardableResult public func pinToSafeArea(of vc: UIViewController, inset: CGFloat = 0, relation: NSLayoutConstraint.Relation = .equal) -> NSLayoutConstraint {
return _pin(to: vc.view.safeAreaLayoutGuide, attribute: attribute, inset: inset, relation: relation)
}
#endif
}

public extension AnchorCollectionEdges {
private var anchors: [Anchor<AnchorType.Edge, Any>] { edges.map { Anchor(item, $0.attribute) } }

/// Pins the edges of the view to the edges of the superview so the the view
/// fills the available space in a container.
@available(*, deprecated, message: "Please use `pin()` instead. `relation` was replaced with a new `alignment` option. See README.md for more information.")
@discardableResult func pinToSuperview(insets: EdgeInsets = .zero, relation: NSLayoutConstraint.Relation = .equal) -> [NSLayoutConstraint] {
anchors.map { $0.pinToSuperview(inset: insets.inset(for: $0.attribute), relation: relation) }
}

#if os(iOS) || os(tvOS)
/// Pins the edges of the view to the margins of the superview so the the view
/// fills the available space in a container.
@available(*, deprecated, message: "Please use `pin(to: superview.layoutMarginsGuide)` instead. `relation` was replaced with a new `alignment` option. See README.md for more information.")
@discardableResult func pinToSuperviewMargins(insets: EdgeInsets = .zero, relation: NSLayoutConstraint.Relation = .equal) -> [NSLayoutConstraint] {
anchors.map { $0.pinToSuperviewMargin(inset: insets.inset(for: $0.attribute), relation: relation) }
}

/// Pins the edges to the safe area of the view controller.
@available(*, deprecated, message: "Please use `pin(to: vc.view.safeAreaLayoutGuide)` instead. `relation` was replaced with a new `alignment` option. See README.md for more information.")
@discardableResult func pinToSafeArea(of vc: UIViewController, insets: UIEdgeInsets = .zero, relation: NSLayoutConstraint.Relation = .equal) -> [NSLayoutConstraint] {
anchors.map { $0.pinToSafeArea(of: vc, inset: insets.inset(for: $0.attribute), relation: relation) }
}
#endif
}

extension Anchor where Type: AnchorType.Alignment {
@available(*, deprecated, message: "Please use `equal`, `greaterThanOrEqual`, `lessThanOrEqual` instead")
@discardableResult public func align<Type: AnchorType.Alignment>(with anchor: Anchor<Type, Axis>, relation: NSLayoutConstraint.Relation = .equal) -> NSLayoutConstraint {
Constraints.constrain(self, anchor, relation: relation)
}
}

public extension Anchor where Type: AnchorType.Center {
@available(*, deprecated, message: "Please use `align`.")
@discardableResult func alignWithSuperview(offset: CGFloat = 0, relation: NSLayoutConstraint.Relation = .equal) -> NSLayoutConstraint {
Constraints.constrain(self, toItem: item.superview!, attribute: attribute, constant: offset, relation: relation)
}
}

public extension Anchor where Type: AnchorType.Dimension {
@available(*, deprecated, message: "Please use `equal`, `greaterThanOrEqual`, `lessThanOrEqual` instead")
@discardableResult func set(_ constant: CGFloat, relation: NSLayoutConstraint.Relation = .equal) -> NSLayoutConstraint {
Constraints.constrain(item: item, attribute: attribute, relatedBy: relation, constant: constant)
}

@available(*, deprecated, message: "Please use `equal`, `greaterThanOrEqual`, `lessThanOrEqual` instead")
@discardableResult func match<Axis>(_ anchor: Anchor<AnchorType.Dimension, Axis>, relation: NSLayoutConstraint.Relation = .equal) -> NSLayoutConstraint {
Constraints.constrain(self, anchor, relation: relation)
}
}

// MARK: - AnchorCollectionSize

public extension AnchorCollectionSize {
@available(*, deprecated, message: "Please use `equal`, `greaterThanOrEqual`, `lessThanOrEqual` instead")
@discardableResult func set(_ size: CGSize, relation: NSLayoutConstraint.Relation = .equal) -> [NSLayoutConstraint] {
[width.set(size.width, relation: relation), height.set(size.height, relation: relation)]
}

@available(*, deprecated, message: "Please use `equal`, `greaterThanOrEqual`, `lessThanOrEqual` instead")
@discardableResult func match(_ anchors: AnchorCollectionSize, insets: CGSize = .zero, multiplier: CGFloat = 1, relation: NSLayoutConstraint.Relation = .equal) -> [NSLayoutConstraint] {
[width.match(anchors.width * multiplier - insets.width, relation: relation),
height.match(anchors.height * multiplier - insets.height, relation: relation)]
}
}

public extension AnchorCollectionCenter {
@available(*, deprecated, message: "Please use `align` instead")
@discardableResult func alignWithSuperview() -> [NSLayoutConstraint] {
[x.align(), y.align()]
}

@available(*, deprecated, message: "Please use `align` instead")
@discardableResult func align(with anchors: AnchorCollectionCenter) -> [NSLayoutConstraint] {
[x.equal(anchors.x), y.equal(anchors.y)]
}
}
73 changes: 0 additions & 73 deletions Tests/AnchorAlignmentTests.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,37 +52,6 @@ class AnchorAlignmentTests: XCTestCase {
}
}

@available(*, deprecated)
func testTopAlignWithDeprecated() {
test("align top with the same edge") {
let c = view.anchors.top.align(with: container.anchors.top)
XCTAssertEqualConstraints(c, NSLayoutConstraint(item: view, attribute: .top, toItem: container, attribute: .top))
}

test("align top with the other edge") {
let c = view.anchors.top.align(with: container.anchors.bottom)
XCTAssertEqualConstraints(c, NSLayoutConstraint(item: view, attribute: .top, toItem: container, attribute: .bottom))
}

test("align top with the center") {
let c = view.anchors.top.align(with: container.anchors.centerY)
XCTAssertEqualConstraints(c, NSLayoutConstraint(item: view, attribute: .top, toItem: container, attribute: .centerY))
}

test("align top with offset, relation, multiplier") {
let c = view.anchors.top.align(with: container.anchors.top * 2 + 10, relation: .greaterThanOrEqual)
XCTAssertEqualConstraints(c, NSLayoutConstraint(
item: view,
attribute: .top,
relatedBy: .greaterThanOrEqual,
toItem: container,
attribute: .top,
multiplier: 2,
constant: 10
))
}
}

func testAlignDifferentAnchors() {
test("align bottom") {
let c = view.anchors.bottom.equal(container.anchors.bottom)
Expand Down Expand Up @@ -124,48 +93,6 @@ class AnchorAlignmentTests: XCTestCase {
}
}

@available(*, deprecated)
func testAlignDifferentAnchorsDeprecated() {
test("align bottom") {
let c = view.anchors.bottom.align(with: container.anchors.bottom)
XCTAssertEqualConstraints(c, NSLayoutConstraint(item: view, attribute: .bottom, toItem: container, attribute: .bottom))
}

test("align leading") {
let c = view.anchors.leading.align(with: container.anchors.leading)
XCTAssertEqualConstraints(c, NSLayoutConstraint(item: view, attribute: .leading, toItem: container, attribute: .leading))
}

test("align trailing") {
let c = view.anchors.trailing.align(with: container.anchors.trailing)
XCTAssertEqualConstraints(c, NSLayoutConstraint(item: view, attribute: .trailing, toItem: container, attribute: .trailing))
}

test("align left with left") {
let c = view.anchors.left.align(with: container.anchors.left)
XCTAssertEqualConstraints(c, NSLayoutConstraint(item: view, attribute: .left, toItem: container, attribute: .left))
}

test("align right with left") {
let c = view.anchors.right.align(with: container.anchors.left)
XCTAssertEqualConstraints(c, NSLayoutConstraint(item: view, attribute: .right, toItem: container, attribute: .left))
}

test("align firstBaseline with firstBaseline") {
XCTAssertEqualConstraints(
view.anchors.firstBaseline.align(with: container.anchors.firstBaseline),
NSLayoutConstraint(item: view, attribute: .firstBaseline, toItem: container, attribute: .firstBaseline)
)
}

test("align lastBaseline with top") {
XCTAssertEqualConstraints(
view.anchors.lastBaseline.align(with: container.anchors.top),
NSLayoutConstraint(item: view, attribute: .lastBaseline, toItem: container, attribute: .top)
)
}
}

func testSpacing() {
test("bottom to top") {
XCTAssertEqualConstraints(
Expand Down
Loading

0 comments on commit 03800b4

Please sign in to comment.