Merge pull request #164 from antoinelamy/feature/sizeToFit

Remove sizeToFit() from SizeCalculable protocol

Author: lucdion

Example/PinLayoutSample.xcodeproj/project.pbxproj

@@ -75,13 +75,6 @@
 			remoteGlobalIDString = 249EFE831E64FB4C00165E39;
 			remoteInfo = PinLayoutTests;
 		};
-		2439CC291E6658C3003326FB /* PBXContainerItemProxy */ = {
-			isa = PBXContainerItemProxy;
-			containerPortal = 2439CC1E1E665858003326FB /* PinLayout.xcodeproj */;
-			proxyType = 1;
-			remoteGlobalIDString = 249EFE791E64FB4C00165E39;
-			remoteInfo = PinLayout;
-		};
 		24DA374E1EF7F90700D1AB2F /* PBXContainerItemProxy */ = {
 			isa = PBXContainerItemProxy;
 			containerPortal = 2439CC1E1E665858003326FB /* PinLayout.xcodeproj */;
@@ -111,7 +104,6 @@
 			remoteInfo = "PinLayoutTests-tvOS";
 		};
 /* End PBXContainerItemProxy section */
-
 /* Begin PBXFileReference section */
 		241637701F8E4BC200EE703A /* IntroObjectiveCViewController.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = IntroObjectiveCViewController.h; sourceTree = "<group>"; };
 		241637711F8E4BC200EE703A /* IntroObjectiveCViewController.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = IntroObjectiveCViewController.m; sourceTree = "<group>"; };
@@ -499,7 +491,6 @@
 			buildRules = (
 			);
 			dependencies = (
-				2439CC2A1E6658C3003326FB /* PBXTargetDependency */,
 			);
 			name = PinLayoutSample;
 			productName = PinLayoutSample;
@@ -716,14 +707,6 @@
 		};
 /* End PBXSourcesBuildPhase section */
 
-/* Begin PBXTargetDependency section */
-		2439CC2A1E6658C3003326FB /* PBXTargetDependency */ = {
-			isa = PBXTargetDependency;
-			name = PinLayout;
-			targetProxy = 2439CC291E6658C3003326FB /* PBXContainerItemProxy */;
-		};
-/* End PBXTargetDependency section */
-
 /* Begin PBXVariantGroup section */
 		249EFE4B1E64FAFE00165E39 /* LaunchScreen.storyboard */ = {
 			isa = PBXVariantGroup;

Example/PinLayoutSample/UI/Common/BasicView.swift

@@ -51,7 +51,10 @@ class BasicView: UIView {
 
     override func sizeThatFits(_ size: CGSize) -> CGSize {
         var newSize = CGSize()
-        if size.width != CGFloat.greatestFiniteMagnitude {
+        if size.width != CGFloat.greatestFiniteMagnitude && size.height != CGFloat.greatestFiniteMagnitude {
+            newSize.width = 35
+            newSize.height = 45
+        } else if size.width != CGFloat.greatestFiniteMagnitude {
             newSize.width = size.width + sizeThatFitSizeOffset
             newSize.height = sizeThatFitsExpectedArea / newSize.width
         } else if size.height != CGFloat.greatestFiniteMagnitude {
@@ -64,8 +67,4 @@ class BasicView: UIView {
 
         return newSize
     }
-
-    override func sizeToFit() {
-        pin.width(35).height(45)
-    }
 }

README.md

@@ -888,7 +888,7 @@ The resulting size will always respect [`minWidth`/`maxWidth`/`minHeight`/`maxHe
 **Methods:**
 
 * **`sizeToFit()`**  
-The method adjust the view's size based on the result of the method `UIView.sizeToFit()`. Particularly useful for controls/views that have an intrinsic size (label, button, ...).
+The method adjust the view's size based on it's content requirements so that it uses the most appropriate amount of space. This fit type has the same effect as calling **sizeToFit()** on a view. The resulting size come from sizeThatFits(..) being called with the current view bounds. Particularly useful for controls/views that have an intrinsic size (label, button, ...).
 
 * **`sizeToFit(: FitType)`**  
 The method adjust the view's size based on the result of the method `sizeThatFits(:CGSize)`.  
@@ -1777,7 +1777,7 @@ PinLayout can layout **NSView**'s on macOS. All PinLayout's properties and metho
 
 * PinLayout supports **only views that have a parent (superview) using a flipped coordinate system**, i.e. views for which  the computed property `var isFlipped: Bool` returns true. In a flipped coordinate system, the origin is in the upper-left corner of the view and y-values extend downward. UIKit use this coordinate system. In a non-flipped coordinate system (default mode), the origin is in the lower-left corner of the view and positive y-values extend upward. See [Apple's documentation for more information about `NSView.isFlipped`](https://developer.apple.com/documentation/appkit/nsview/1483532-isflipped). The support of non-flipped coordinate system will be added soon.
 
-* [`sizeToFit(:FitType)`](#sizeToFit) is supported only for instances that inherits from NSControl. Support for [`sizeToFit(:FitType)`](#sizeToFit) can be added to your custom NSView subclasses, just make those views conform to the `SizeCalculable` protocol and implement the two required functions.
+* [`sizeToFit(:FitType)`](#sizeToFit) is supported only for instances that inherits from NSControl. Support for [`sizeToFit(:FitType)`](#sizeToFit) can be added to your custom NSView subclasses, just make those views conform to the `SizeCalculable` protocol and implement the required `sizeThatFits(:CGSize)` function.
 
 * [`NSView.pin.safeArea` and ](#safeAreaInsets) property is not available, AppKit doesn't have an `UIView.safeAreaInsets` equivalent.
 
@@ -1793,7 +1793,7 @@ PinLayout can layout **NSView**'s on macOS. All PinLayout's properties and metho
 
 PinLayout can layouts **CALayer**'s. All PinLayout's properties and methods are available, with the following exceptions:
 
-* [`sizeToFit(:FitType)`](#sizeToFit) is not supported. Support for [`sizeToFit(:FitType)`](#sizeToFit) can be added to your custom CALayer subclasses, just make those layers conform to the `SizeCalculable` protocol and implement the two required functions.
+* [`sizeToFit(:FitType)`](#sizeToFit) is not supported. Support for [`sizeToFit(:FitType)`](#sizeToFit) can be added to your custom CALayer subclasses, just make those layers conform to the `SizeCalculable` protocol and implement the required `sizeThatFits(:CGSize)` function.
 * [`CALayer.pin.safeArea` and `CALayer.pin.readableMargins`](#safeAreaInsets) properties are not available.
 * [`aspectRatio()`](#aspect_ratio) with no parameters
 

Sources/Impl/PinLayout+Layouting.swift

@@ -199,10 +199,8 @@ extension PinLayout {
 
         if let adjustSizeType = adjustSizeType {
             switch adjustSizeType {
-            case .fitTypeWidth, .fitTypeHeight, .fitTypeWidthFlexible, .fitTypeHeightFlexible:
+            case .fitTypeWidth, .fitTypeHeight, .fitTypeWidthFlexible, .fitTypeHeightFlexible, .fitTypeContent:
                 size = computeSizeToFit(adjustSizeType: adjustSizeType, size: size)
-            case .sizeToFit:
-                size = computeSizeToFit(size: size)
             case .aspectRatio(let ratio):
                 size = computeAspectRatio(ratio, size: size)
             }
@@ -236,17 +234,6 @@ extension PinLayout {
         return size
     }
 
-    private func computeSizeToFit(size: Size) -> Size {
-        guard let sizeCalculableView = view as? SizeCalculable else {
-            assertionFailure("Should not occurs, protocol conformance is checked before assigning adjustSizeType")
-            return size
-        }
-        sizeCalculableView.sizeToFit()
-
-        let viewRect = view.getRect(keepTransform: keepTransform)
-        return Size(width: viewRect.width, height: viewRect.height)
-    }
-
     private func computeSizeToFit(adjustSizeType: AdjustSizeType, size: Size) -> Size {
         guard let sizeCalculableView = view as? SizeCalculable else {
             assertionFailure("Should not occurs, protocol conformance is checked before assigning adjustSizeType")
@@ -271,22 +258,31 @@ extension PinLayout {
             } else {
                 fitHeight = view.getRect(keepTransform: keepTransform).height
             }
+        case .fitTypeContent:
+            let fitSize = view.getRect(keepTransform: keepTransform).size
+            fitWidth = fitSize.width
+            fitHeight = fitSize.height
         default:
             assertionFailure("Should not occured")
         }
 
         let sizeThatFits = sizeCalculableView.sizeThatFits(CGSize(width: fitWidth, height: fitHeight))
 
-        if fitWidth != .greatestFiniteMagnitude {
-            size.width = adjustSizeType.isFlexible ? sizeThatFits.width : fitWidth
-        } else {
-            size.width = sizeThatFits.width
-        }
+        switch adjustSizeType {
+        case .fitTypeWidth, .fitTypeWidthFlexible, .fitTypeHeight, .fitTypeHeightFlexible, .aspectRatio(_):
+            if fitWidth != .greatestFiniteMagnitude {
+                size.width = adjustSizeType.isFlexible ? sizeThatFits.width : fitWidth
+            } else {
+                size.width = sizeThatFits.width
+            }
 
-        if fitHeight != .greatestFiniteMagnitude {
-            size.height = adjustSizeType.isFlexible ? sizeThatFits.height : fitHeight
-        } else {
-            size.height = sizeThatFits.height
+            if fitHeight != .greatestFiniteMagnitude {
+                size.height = adjustSizeType.isFlexible ? sizeThatFits.height : fitHeight
+            } else {
+                size.height = sizeThatFits.height
+            }
+        case .fitTypeContent:
+            size = Size(width: sizeThatFits.width, height: sizeThatFits.height)
         }
 
         return size

Sources/ObjectiveC/PinLayoutObjC.swift

@@ -288,6 +288,8 @@ import AppKit
     @discardableResult func aspectRatio() -> PinLayoutObjC
     #endif
 
+    @discardableResult func sizeToFit() -> PinLayoutObjC
+
     @discardableResult func sizeToFit(_ fitType: Fit) -> PinLayoutObjC
 
     //
@@ -396,4 +398,5 @@ import AppKit
     case height
     case widthFlexible
     case heightFlexible
+    case content
 }

Sources/ObjectiveC/PinLayoutObjCImpl.swift

@@ -679,13 +679,18 @@ import AppKit
     }
     #endif
 
+    func sizeToFit() -> PinLayoutObjC {
+        return sizeToFit(.content)
+    }
+
     func sizeToFit(_ fitType: Fit) -> PinLayoutObjC {
         let type: FitType
         switch fitType {
         case .width: type = .width
         case .height: type = .height
         case .widthFlexible: type = .widthFlexible
         case .heightFlexible: type = .heightFlexible
+        case .content: type = .content
         }
         _ = impl?.sizeToFit(type)
         return self

Sources/PinLayout+Size.swift

@@ -28,8 +28,7 @@ enum AdjustSizeType {
     case fitTypeHeight
     case fitTypeWidthFlexible
     case fitTypeHeightFlexible
-
-    case sizeToFit
+    case fitTypeContent
 
     case aspectRatio(CGFloat)
 
@@ -47,7 +46,7 @@ enum AdjustSizeType {
         switch self {
         case .fitTypeWidth, .fitTypeHeight,
              .fitTypeWidthFlexible, .fitTypeHeightFlexible,
-             .sizeToFit:
+             .fitTypeContent:
             return true
         case .aspectRatio(_):
             return false
@@ -72,6 +71,7 @@ extension FitType {
         case .height: return .fitTypeHeight
         case .widthFlexible: return .fitTypeWidthFlexible
         case .heightFlexible: return .fitTypeHeightFlexible
+        case .content: return .fitTypeContent
         }
     }
 }
@@ -217,15 +217,9 @@ extension PinLayout {
      ```
      */
     @discardableResult
-    public func sizeToFit(_ fitType: FitType) -> PinLayout {
+    public func sizeToFit(_ fitType: FitType = .content) -> PinLayout {
         return setAdjustSizeType(fitType.toAdjustSizeType(), { return "sizeToFit(\(fitType.description))" })
-    }
-
-    @discardableResult
-    public func sizeToFit() -> PinLayout {
-        return setAdjustSizeType(.sizeToFit, { return "sizeToFit()" })
-    }
-}
+    }}
 
 //
 // MARK: Private methods
@@ -261,10 +255,8 @@ extension PinLayout {
         guard let adjustSizeType = adjustSizeType else { return }
         let conflict: String
         switch adjustSizeType {
-        case .fitTypeWidth, .fitTypeHeight, .fitTypeWidthFlexible, .fitTypeHeightFlexible:
+        case .fitTypeWidth, .fitTypeHeight, .fitTypeWidthFlexible, .fitTypeHeightFlexible, .fitTypeContent:
             conflict = "sizeToFit(\(adjustSizeType.toFitType()!.description))."
-        case .sizeToFit:
-            conflict = "sizeToFit()"
         case .aspectRatio(let ratio):
             conflict = "aspectRatio(\(ratio))"
         }

Sources/SizeCalculable.swift

@@ -25,5 +25,4 @@ import AppKit
 
 public protocol SizeCalculable {
     func sizeThatFits(_ size: CGSize) -> CGSize
-    func sizeToFit()
 }

Sources/Types+Description.swift

@@ -68,6 +68,7 @@ extension FitType {
         case .height: return ".height"
         case .widthFlexible: return ".widthFlexible"
         case .heightFlexible: return ".heightFlexible"
+        case .content: return ""
         }
     }
 }

Sources/Types.swift

@@ -176,6 +176,13 @@ public enum FitType {
      sizeThatFits(..) method result.
      */
     case heightFlexible
+
+    /**
+     Adjust the view's size based on it's content size requirements so that it uses the
+     most appropriate amount of space. This fit type has the same effect as calling **sizeToFit()** on a view.
+     The resulting size come from sizeThatFits(..) being called with the current view bounds.
+     */
+    case content
 }
 
 public enum WrapType {