Merge pull request #75 from mirego/improve_warnings_info

Warning now display more context information

Author: Luc Dion

Podfile

@@ -3,13 +3,15 @@ use_frameworks!
 workspace 'PinLayout.xcworkspace'
 
 target 'PinLayoutTests' do
+  platform :ios, "8.0"
   project 'PinLayout.xcodeproj'
 
   pod 'Quick'
   pod 'Nimble', :inhibit_warnings => true
 end
 
 target 'PinLayoutSample' do
+  platform :ios, "8.0"
   project 'Example/PinLayoutSample.xcodeproj'
 
   # Debug only

Sources/Impl/UnitTests.swift

@@ -25,7 +25,7 @@
 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 // POSSIBILITY OF SUCH DAMAGE.
 
-import Foundation
+import UIKit
 
 public var _pinlayoutUnitTestLastWarning: String?
 

Sources/Percent.swift

@@ -25,7 +25,7 @@
 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 // POSSIBILITY OF SUCH DAMAGE.
 
-import Foundation
+import UIKit
 
 public struct Percent {
     let value: CGFloat

Sources/PinLayoutImpl+Warning.swift

@@ -15,44 +15,44 @@ extension PinLayoutImpl {
 
     internal func relativeEdgeContext(method: String, edge: VerticalEdge) -> String {
         let edge = edge as! VerticalEdgeImpl
-        return "\(method)(to: \(edge.type.rawValue), of: \(edge.view))"
+        return "\(method)(to: .\(edge.type.rawValue), of: \(viewDescription(edge.view)))"
     }
 
     internal func relativeEdgeContext(method: String, edge: HorizontalEdge) -> String {
         let edge = edge as! HorizontalEdgeImpl
-        return "\(method)(to: \(edge.type.rawValue), of: \(edge.view))"
+        return "\(method)(to: .\(edge.type.rawValue), of: \(viewDescription(edge.view))"
     }
 
     internal func relativeAnchorContext(method: String, anchor: Anchor) -> String {
         let anchor = anchor as! AnchorImpl
-        return "\(method)(to: \(anchor.type.rawValue), of: \(anchor.view))"
+        return "\(method)(to: .\(anchor.type.rawValue), of: \(viewDescription(anchor.view)))"
     }
 
     internal func warn(_ text: String, _ context: Context) {
         guard Pin.logWarnings else { return }
-        warn("\(context()) won't be applied, \(text)\n")
+        warn("\(context()) won't be applied, \(text)")
     }
 
     internal func warn(_ text: String) {
         guard Pin.logWarnings else { return }
-        displayWarning("\n👉 PinLayout Warning: \(text)\n")
+        displayWarning("PinLayout Warning: \(text)")
     }
 
     internal func warnPropertyAlreadySet(_ propertyName: String, propertyValue: CGFloat, _ context: Context) {
         guard Pin.logWarnings else { return }
-        displayWarning("\n👉 PinLayout Conflict: \(context()) won't be applied since it value has already been set to \(propertyValue).\n")
+        displayWarning("PinLayout Conflict: \(context()) won't be applied since it value has already been set to \(propertyValue).")
     }
 
     internal func warnPropertyAlreadySet(_ propertyName: String, propertyValue: CGSize, _ context: Context) {
         guard Pin.logWarnings else { return }
-        displayWarning("\n👉 PinLayout Conflict: \(context()) won't be applied since it value has already been set to CGSize(width: \(propertyValue.width), height: \(propertyValue.height)).\n")
+        displayWarning("PinLayout Conflict: \(context()) won't be applied since it value has already been set to CGSize(width: \(propertyValue.width), height: \(propertyValue.height)).")
     }
 
     internal func warnConflict(_ context: Context, _ properties: [String: CGFloat]) {
         guard Pin.logWarnings else { return }
-        var warning = "\n👉 PinLayout Conflict: \(context()) won't be applied since it conflicts with the following already set properties:\n"
+        var warning = "PinLayout Conflict: \(context()) won't be applied since it conflicts with the following already set properties:"
         properties.forEach { (property) in
-            warning += " \(property.key): \(property.value)\n"
+            warning += "\n \(property.key): \(property.value)"
         }
 
         displayWarning(warning)
@@ -83,12 +83,31 @@ extension PinLayoutImpl {
     }
 
     internal func displayWarning(_ text: String) {
-        print(text)
+        var displayText = "\n👉 \(text)"
+        displayText += "\n   (Layouted view info: Type: \(viewName(view)), Frame: \(view.frame)"
+        
+        var currentView = view
+        var hierarchy: [String] = []
+        while let parent = currentView.superview {
+            hierarchy.insert("\(type(of: parent))", at: 0)
+            currentView = parent
+        }
+        if hierarchy.count > 0 {
+            displayText += ", Superviews: \(hierarchy.flatMap({ $0 }).joined(separator: " -> "))"
+        }
+        
+        displayText += ", Tag: \(view.tag))\n"
+        
+        print(displayText)
         _pinlayoutUnitTestLastWarning = text
     }
 
     internal func viewDescription(_ view: UIView) -> String {
-        return "\"\(view.description)\""
+        return "(\(viewName(view)), Frame: \(view.frame))"
+    }
+    
+    internal func viewName(_ view: UIView) -> String {
+        return "\(type(of: view))"
     }
 }
 

Sources/PinLayoutImpl.swift

@@ -576,7 +576,7 @@ class PinLayoutImpl: PinLayout {
 
     @discardableResult
     func width(of view: UIView) -> PinLayout {
-        return setWidth(view.frame.width, { return "width(of: \(view))" })
+        return setWidth(view.frame.width, { return "width(of: \(viewDescription(view)))" })
     }
 
     @discardableResult
@@ -619,7 +619,7 @@ class PinLayoutImpl: PinLayout {
 
     @discardableResult
     func height(of view: UIView) -> PinLayout {
-        return setHeight(view.frame.height, { return "height(of: \(view))" })
+        return setHeight(view.frame.height, { return "height(of: \(viewDescription(view)))" })
     }
 
     @discardableResult
@@ -671,7 +671,7 @@ class PinLayoutImpl: PinLayout {
 
     @discardableResult
     func size(of view: UIView) -> PinLayout {
-        func context() -> String { return "size(of \(view))" }
+        func context() -> String { return "size(of \(viewDescription(view)))" }
         return setSize(view.frame.size, context)
     }
 
@@ -808,7 +808,7 @@ extension PinLayoutImpl {
         if let superview = referenceView.superview {
             return superview
         } else {
-            warn("the reference view \(viewDescription(referenceView)) is invalid. UIViews must be added as a sub-view before being used as a reference.", context)
+            warn("the reference view \(viewDescription(referenceView)) must be added as a sub-view before being used as a reference.", context)
             return nil
         }
     }
@@ -914,10 +914,12 @@ extension PinLayoutImpl {
 
     fileprivate func handlePinEdges() {
         guard shouldPinEdges else { return }
-        if let width = applyMinMax(toWidth: width) {
-            if _left != nil && _right != nil {
-                warn("pinEdges() won't be applied horizontally, left and right coordinates are already set.")
-            } else if let left = _left {
+        guard _top == nil || _bottom == nil || _left == nil || _right == nil else {
+            return warn("pinEdges() won't be applied, top, left, bottom and right coordinates are already set.")
+        }
+        
+        if let width = applyMinMax(toWidth: width), _left == nil || _right == nil  {
+            if let left = _left {
                 // convert the width into a right
                 assert(self._right == nil)
                 self._right = left + width
@@ -938,10 +940,8 @@ extension PinLayoutImpl {
             }
         }
 
-        if let height = applyMinMax(toHeight: height) {
-            if _top != nil && _bottom != nil {
-                warn("pinEdges() won't be applied vertically, top and bottom coordinates are already set.")
-            } else if let top = _top {
+        if let height = applyMinMax(toHeight: height), _top == nil || _bottom == nil {
+            if let top = _top {
                 // convert the height into a bottom
                 assert(self._bottom == nil)
                 self._bottom = top + height

Tests/WarningSpec.swift

@@ -64,16 +64,10 @@ class WarningSpec: QuickSpec {
         // pinEdges warnings
         //
         describe("pinEdges() should warn ") {
-            it("test when left & right & width is set") {
-                aView.pin.left().right().width(100%).pinEdges()
-                expect(aView.frame).to(equal(CGRect(x: 0.0, y: 100.0, width: 400.0, height: 60.0)))
-                expect(_pinlayoutUnitTestLastWarning).to(contain(["pinEdges()", "won't be applied", "horizontally"]))
-            }
-            
-            it("test when top & bottom & height is set") {
-                aView.pin.top().bottom().height(100%).pinEdges()
-                expect(aView.frame).to(equal(CGRect(x: 40.0, y: 0.0, width: 100.0, height: 400.0)))
-                expect(_pinlayoutUnitTestLastWarning).to(contain(["pinEdges()", "won't be applied", "vertically"]))
+            it("test when top, left, bottom and right is set") {
+                aView.pin.top().bottom().left().right().width(100%).pinEdges()
+                expect(aView.frame).to(equal(CGRect(x: 0.0, y: 0.0, width: 400.0, height: 400.0)))
+                expect(_pinlayoutUnitTestLastWarning).to(contain(["pinEdges()", "won't be applied", "top, left, bottom and right coordinates are already set"]))
             }
         }
     }