Improve warning log output

Author: Luc Dion

Example/PinLayoutSample/UI/Examples/AutoAdjustingSizeView/AutoAdjustingSizeView.swift

@@ -82,7 +82,7 @@ class AutoAdjustingSizeView: BaseView {
         row1Item2.pin.right(of: row1Item1, aligned: .top).bottomRight().margin(0, 2, 2, 2)
 
         row2.pin.below(of: row1, aligned: .left).size(of: row1).marginTop(10)
-        row2Item1.pin.top().right().bottom().width(150).width(25%).margin(2)
+        row2Item1.pin.top().bottom().right().width(150).margin(2)
         row2Item2.pin.left(of: row2Item1, aligned: .top).left().bottom().margin(0, 2, 2, 2)
 
         row3.pin.below(of: row2, aligned: .left).size(of: row1).marginTop(10)

Example/PinLayoutSample/UI/Examples/Intro/IntroView.swift

@@ -62,7 +62,7 @@ class IntroView: BaseView {
         let containerInsets = safeArea.minInsets(UIEdgeInsets(top: 10, left: 10, bottom: 0, right: 10))
         contentView.pin.all().margin(containerInsets)
 
-        logo.pin.top().left().size(100).aspectRatio().marginTop(10)
+        logo.pin.top().left().width(100).aspectRatio().marginTop(10)
         segmented.pin.after(of: logo, aligned: .top).right().marginLeft(10)
         textLabel.pin.below(of: segmented, aligned: .left).width(of: segmented).pinEdges().marginTop(10).sizeToFit(.width)
         separatorView.pin.below(of: [logo, textLabel], aligned: .left).right(to: segmented.edge.right).marginTop(10)

Example/PinLayoutSample/UI/Examples/IntroObjectiveC/IntroObjectiveCView.m

@@ -32,6 +32,8 @@ @implementation IntroObjectiveCView {
 
 - (id)initWithFrame:(CGRect)frame {
     if ((self = [super initWithFrame:frame])) {
+        Pin.logMissingLayoutCalls = true;
+        
         topLayoutGuide = 0;
         self.backgroundColor = UIColor.whiteColor;
 
@@ -56,6 +58,10 @@ - (id)initWithFrame:(CGRect)frame {
     return self;
 }
 
+- (void)dealloc {
+    Pin.logMissingLayoutCalls = false;
+}
+
 - (void) layoutSubviews {
     [super layoutSubviews];
 

Sources/Impl/PinLayoutImpl+Warning.swift

@@ -52,19 +52,25 @@ extension PinLayoutImpl {
 
     internal func warnPropertyAlreadySet(_ propertyName: String, propertyValue: CGFloat, _ context: Context) {
         guard Pin.logWarnings else { return }
-        displayWarning("PinLayout Conflict: \(context()) won't be applied since it value has already been set to \(propertyValue).")
+        displayWarning("PinLayout Conflict: \(context()) won't be applied since it value has already been set to \(propertyValue.description).")
     }
 
     internal func warnPropertyAlreadySet(_ propertyName: String, propertyValue: CGSize, _ context: Context) {
         guard Pin.logWarnings else { return }
-        displayWarning("PinLayout Conflict: \(context()) won't be applied since it value has already been set to CGSize(width: \(propertyValue.width), height: \(propertyValue.height)).")
+        displayWarning("PinLayout Conflict: \(context()) won't be applied since it value has already been set to CGSize(width: \(propertyValue.width.description), height: \(propertyValue.height.description)).")
     }
 
     internal func warnConflict(_ context: Context, _ properties: [String: Any]) {
         guard Pin.logWarnings else { return }
         var warning = "PinLayout Conflict: \(context()) won't be applied since it conflicts with the following already set properties:"
         properties.forEach { (property) in
-            warning += "\n \(property.key): \(property.value)"
+            warning += "\n \(property.key): "
+            
+            if let floatValue = property.value as? CGFloat {
+                warning += "\(floatValue.description)"
+            } else {
+                warning += "\(property.value)"
+            }
         }
 
         displayWarning(warning)

Sources/Impl/PinLayoutImpl.swift

@@ -69,8 +69,8 @@ class PinLayoutImpl: PinLayout {
     }
 
     deinit {
-        if !isLayouted && Pin.warnMissingLayoutCalls {
-            warn("PinLayout commands have been issued without calling the 'layout()' method to complete the layout. (These warnings can be disabled by setting Pin.warnMissingLayoutCalls to false)")
+        if !isLayouted && Pin.logMissingLayoutCalls {
+            warn("PinLayout commands have been issued without calling the 'layout()' method to complete the layout. (These warnings can be disabled by setting Pin.logMissingLayoutCalls to false)")
         }
         apply()
     }
@@ -91,7 +91,7 @@ class PinLayoutImpl: PinLayout {
 
     @discardableResult
     func top(_ percent: Percent) -> PinLayout {
-        func context() -> String { return "top(\(percent))" }
+        func context() -> String { return "top(\(percent.description))" }
         guard let layoutSuperview = layoutSuperview(context) else { return self }
         setTop(percent.of(layoutSuperview.frame.height), context)
         return self
@@ -109,7 +109,7 @@ class PinLayoutImpl: PinLayout {
 
     @discardableResult
     func left(_ percent: Percent) -> PinLayout {
-        return left(percent, { return "left(\(percent))" })
+        return left(percent, { return "left(\(percent.description))" })
     }
 
     @discardableResult
@@ -126,7 +126,7 @@ class PinLayoutImpl: PinLayout {
 
     @discardableResult
     func start(_ percent: Percent) -> PinLayout {
-        func context() -> String { return "start(\(percent))" }
+        func context() -> String { return "start(\(percent.description))" }
         return isLTR() ? left(percent, context) : right(percent, context)
     }
 
@@ -141,7 +141,7 @@ class PinLayoutImpl: PinLayout {
 
     @discardableResult
     func bottom(_ percent: Percent) -> PinLayout {
-        func context() -> String { return "bottom(\(percent))" }
+        func context() -> String { return "bottom(\(percent.description))" }
         guard let layoutSuperview = layoutSuperview(context) else { return self }
         bottom(percent.of(layoutSuperview.frame.height), context)
         return self
@@ -158,7 +158,7 @@ class PinLayoutImpl: PinLayout {
 
     @discardableResult
     func right(_ percent: Percent) -> PinLayout {
-        return right(percent, { return "right(\(percent))" })
+        return right(percent, { return "right(\(percent.description))" })
     }
 
     @discardableResult func end() -> PinLayout {
@@ -174,7 +174,7 @@ class PinLayoutImpl: PinLayout {
 
     @discardableResult
     func end(_ percent: Percent) -> PinLayout {
-        func context() -> String { return "end(\(percent))" }
+        func context() -> String { return "end(\(percent.description))" }
         return isLTR() ? right(percent, context) : left(percent, context)
     }
 
@@ -196,7 +196,7 @@ class PinLayoutImpl: PinLayout {
 
     @discardableResult
     func hCenter(_ percent: Percent) -> PinLayout {
-        func context() -> String { return "hCenter(\(percent))" }
+        func context() -> String { return "hCenter(\(percent.description))" }
         guard let layoutSuperview = layoutSuperview(context) else { return self }
         setHorizontalCenter((layoutSuperview.frame.width / 2) + percent.of(layoutSuperview.frame.width), context)
         return self
@@ -220,7 +220,7 @@ class PinLayoutImpl: PinLayout {
 
     @discardableResult
     func vCenter(_ percent: Percent) -> PinLayout {
-        func context() -> String { return "vCenter(\(percent))" }
+        func context() -> String { return "vCenter(\(percent.description))" }
         guard let layoutSuperview = layoutSuperview(context) else { return self }
         setVerticalCenter((layoutSuperview.frame.height / 2) + percent.of(layoutSuperview.frame.height), context)
         return self
@@ -607,7 +607,7 @@ class PinLayoutImpl: PinLayout {
 
     @discardableResult
     func width(_ percent: Percent) -> PinLayout {
-        func context() -> String { return "width(\(percent))" }
+        func context() -> String { return "width(\(percent.description))" }
         guard let layoutSuperview = layoutSuperview(context) else { return self }
         return setWidth(percent.of(layoutSuperview.frame.width), context)
     }
@@ -625,7 +625,7 @@ class PinLayoutImpl: PinLayout {
 
     @discardableResult
     func minWidth(_ percent: Percent) -> PinLayout {
-        func context() -> String { return "minWidth(\(percent))" }
+        func context() -> String { return "minWidth(\(percent.description))" }
         guard let layoutSuperview = layoutSuperview(context) else { return self }
         return setMinWidth(percent.of(layoutSuperview.frame.width), context)
     }
@@ -638,7 +638,7 @@ class PinLayoutImpl: PinLayout {
 
     @discardableResult
     func maxWidth(_ percent: Percent) -> PinLayout {
-        func context() -> String { return "maxWidth(\(percent))" }
+        func context() -> String { return "maxWidth(\(percent.description))" }
         guard let layoutSuperview = layoutSuperview(context) else { return self }
         return setMaxWidth(percent.of(layoutSuperview.frame.width), context)
     }
@@ -650,7 +650,7 @@ class PinLayoutImpl: PinLayout {
 
     @discardableResult
     func height(_ percent: Percent) -> PinLayout {
-        func context() -> String { return "height(\(percent))" }
+        func context() -> String { return "height(\(percent.description))" }
         guard let layoutSuperview = layoutSuperview(context) else { return self }
         return setHeight(percent.of(layoutSuperview.frame.height), context)
     }
@@ -668,7 +668,7 @@ class PinLayoutImpl: PinLayout {
 
     @discardableResult
     func minHeight(_ percent: Percent) -> PinLayout {
-        func context() -> String { return "minHeight(\(percent))" }
+        func context() -> String { return "minHeight(\(percent.description))" }
         guard let layoutSuperview = layoutSuperview(context) else { return self }
         return setMinHeight(percent.of(layoutSuperview.frame.height), context)
     }
@@ -681,7 +681,7 @@ class PinLayoutImpl: PinLayout {
 
     @discardableResult
     func maxHeight(_ percent: Percent) -> PinLayout {
-        func context() -> String { return "maxHeight(\(percent))" }
+        func context() -> String { return "maxHeight(\(percent.description))" }
         guard let layoutSuperview = layoutSuperview(context) else { return self }
         return setMaxHeight(percent.of(layoutSuperview.frame.height), context)
     }
@@ -701,7 +701,7 @@ class PinLayoutImpl: PinLayout {
 
     @discardableResult
     func size(_ percent: Percent) -> PinLayout {
-        func context() -> String { return "size(\(percent))" }
+        func context() -> String { return "size(\(percent.description))" }
         guard let layoutSuperview = layoutSuperview(context) else { return self }
         let size = CGSize(width: percent.of(layoutSuperview.frame.width), height: percent.of(layoutSuperview.frame.height))
         return setSize(size, context)

Sources/Impl/TypesImpl.swift

@@ -182,7 +182,21 @@ extension Percent {
         return rhs * value / 100
     }
     public var description: String {
-        return "\(value)%"
+        if value.truncatingRemainder(dividingBy: 1) == 0.0 {
+            return "\(Int(value))%"
+        } else {
+            return "\(value)%"
+        }
+    }
+}
+    
+extension CGFloat {
+    public var description: String {
+        if self.truncatingRemainder(dividingBy: 1) == 0.0 {
+            return "\(Int(self))"
+        } else {
+            return "\(self)"
+        }
     }
 }
 

Tests/LayoutMethodSpec.swift

@@ -39,7 +39,7 @@ class LayoutMethodSpec: QuickSpec {
 
         beforeEach {
             Pin.lastWarningText = nil
-            Pin.warnMissingLayoutCalls = false
+            Pin.logMissingLayoutCalls = false
 
             viewController = UIViewController()
 
@@ -53,7 +53,7 @@ class LayoutMethodSpec: QuickSpec {
         }
 
         afterEach {
-            Pin.warnMissingLayoutCalls = false
+            Pin.logMissingLayoutCalls = false
         }
 
         //
@@ -71,8 +71,8 @@ class LayoutMethodSpec: QuickSpec {
                 expect(aView.frame).to(equal(CGRect(x: 0.0, y: 100.0, width: 400.0, height: 60.0)))
             }
 
-            it("should warn if layout() is not called when Pin.warnMissingLayoutCalls is set to true") {
-                Pin.warnMissingLayoutCalls = true
+            it("should warn if layout() is not called when Pin.logMissingLayoutCalls is set to true") {
+                Pin.logMissingLayoutCalls = true
 
                 aView.pin.left().right()
                 expect(Pin.lastWarningText).to(contain(["PinLayout commands have been issued without calling the 'layout()' method"]))

Tests/ObjectiveCSpec.m

@@ -22,7 +22,7 @@
     __block UIView* aView = nil;
 
     beforeEach(^{
-        Pin.warnMissingLayoutCalls = false;
+        Pin.logMissingLayoutCalls = false;
         Pin.lastWarningText = nil;
 
         viewController = [[UIViewController alloc] initWithNibName:nil bundle:nil];
@@ -35,7 +35,7 @@
     });
 
     afterEach(^{
-        Pin.warnMissingLayoutCalls = false;
+        Pin.logMissingLayoutCalls = false;
     });
 
     describe(@"its click", ^{
@@ -44,15 +44,15 @@
             expect(@(aView.frame)).to(equal(@(CGRectMake(40, 10, 100, 60))));
         });
 
-        it(@"using Pin.warnMissingLayoutCalls", ^{
-            Pin.warnMissingLayoutCalls = true;
+        it(@"using Pin.logMissingLayoutCalls", ^{
+            Pin.logMissingLayoutCalls = true;
             [[aView pinObjc] top:10];
             expect(@(aView.frame)).to(equal(@(CGRectMake(40, 10, 100, 60))));
             expect(Pin.lastWarningText).to(contain(@"PinLayout commands have been issued without calling the 'layout()' method to complete the layout"));
         });
 
-        it(@"using Pin.warnMissingLayoutCalls set to false", ^{
-            Pin.warnMissingLayoutCalls = false;
+        it(@"using Pin.logMissingLayoutCalls set to false", ^{
+            Pin.logMissingLayoutCalls = false;
             [[[aView pinObjc] top:10] layout];
             expect(@(aView.frame)).to(equal(@(CGRectMake(40, 10, 100, 60))));
             expect(Pin.lastWarningText).to(beNil());

Tests/PinEdgesSpec.swift

@@ -482,20 +482,20 @@ class PinEdgesSpec: QuickSpec {
 
             it("should warn") {
                 aView.pin.top(20).all()
-                expect(Pin.lastWarningText).to(contain(["all() top coordinate", "won't be applied", "already been set to 20.0"]))
+                expect(Pin.lastWarningText).to(contain(["all() top coordinate", "won't be applied", "already been set to 20"]))
             }
             it("should warn") {
                 aView.pin.left(20).all()
-                expect(Pin.lastWarningText).to(contain(["all() left coordinate", "won't be applied", "already been set to 20.0"]))
+                expect(Pin.lastWarningText).to(contain(["all() left coordinate", "won't be applied", "already been set to 20"]))
             }
             it("should warn") {
                 aView.pin.right(20).all()
-                expect(Pin.lastWarningText).to(contain(["all() right coordinate", "won't be applied", "already been set to 20.0"]))
+                expect(Pin.lastWarningText).to(contain(["all() right coordinate", "won't be applied", "already been set to 20"]))
             }
 
             it("should warn") {
                 aView.pin.bottom(20).all()
-                expect(Pin.lastWarningText).to(contain(["all() bottom coordinate", "won't be applied", "already been set to 20.0"]))
+                expect(Pin.lastWarningText).to(contain(["all() bottom coordinate", "won't be applied", "already been set to 20"]))
             }
         }
 
@@ -525,11 +525,11 @@ class PinEdgesSpec: QuickSpec {
 
             it("should warn") {
                 aView.pin.left(20).horizontally()
-                expect(Pin.lastWarningText).to(contain(["horizontally() left coordinate", "won't be applied", "already been set to 20.0"]))
+                expect(Pin.lastWarningText).to(contain(["horizontally() left coordinate", "won't be applied", "already been set to 20"]))
             }
             it("should warn") {
                 aView.pin.right(20).horizontally()
-                expect(Pin.lastWarningText).to(contain(["horizontally() right coordinate", "won't be applied", "already been set to 20.0"]))
+                expect(Pin.lastWarningText).to(contain(["horizontally() right coordinate", "won't be applied", "already been set to 20"]))
             }
         }
 
@@ -559,11 +559,11 @@ class PinEdgesSpec: QuickSpec {
 
             it("should warn") {
                 aView.pin.top(20).vertically()
-                expect(Pin.lastWarningText).to(contain(["vertically() top coordinate", "won't be applied", "already been set to 20.0"]))
+                expect(Pin.lastWarningText).to(contain(["vertically() top coordinate", "won't be applied", "already been set to 20"]))
             }
             it("should warn") {
                 aView.pin.bottom(20).vertically()
-                expect(Pin.lastWarningText).to(contain(["vertically() bottom coordinate", "won't be applied", "already been set to 20.0"]))
+                expect(Pin.lastWarningText).to(contain(["vertically() bottom coordinate", "won't be applied", "already been set to 20"]))
             }
         }
     }