Merge pull request MessageKit#138 from gungorbasa/newAvatarView

New avatar view
tapanprakasht · Sep 22, 2017 · b56dccc · b56dccc
2 parents c816eac + d17a24c
commit b56dccc
Show file tree

Hide file tree

Showing 2 changed files with 147 additions and 50 deletions.
diff --git a/Sources/AvatarView.swift b/Sources/AvatarView.swift
@@ -1,18 +1,18 @@
 /*
  MIT License
- 
+
  Copyright (c) 2017 MessageKit
- 
+
  Permission is hereby granted, free of charge, to any person obtaining a copy
  of this software and associated documentation files (the "Software"), to deal
  in the Software without restriction, including without limitation the rights
  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  copies of the Software, and to permit persons to whom the Software is
  furnished to do so, subject to the following conditions:
- 
+
  The above copyright notice and this permission notice shall be included in all
  copies or substantial portions of the Software.
- 
+
  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
@@ -29,30 +29,81 @@ open class AvatarView: UIView {
     // MARK: - Properties
 
     open var avatar: Avatar = Avatar()
+
     open var imageView = UIImageView()
-
+
+    public var image: UIImage? {
+        return imageView.image
+    }
+
+    open var placeholderFont: UIFont = UIFont.preferredFont(forTextStyle: .caption1) {
+        didSet {
+            set(avatar: avatar)
+        }
+    }
+
+    open var placeholderTextColor: UIColor = .white {
+        didSet {
+            set(avatar: avatar)
+        }
+    }
+
+    open var fontMinimumScaleFactor: CGFloat = 0.5
+
+    open var adjustsFontSizeToFitWidth = true
+
+    private var minimumFontSize: CGFloat {
+        return placeholderFont.pointSize * fontMinimumScaleFactor
+    }
+
+    private var radius: CGFloat?
+
+    // MARK: - Overridden Properties
+    open override var frame: CGRect {
+        didSet {
+            imageView.frame = bounds
+            setCorner(radius: self.radius)
+        }
+    }
+
+    open override var bounds: CGRect {
+        didSet {
+            imageView.frame = bounds
+            setCorner(radius: self.radius)
+        }
+    }
+
     // MARK: - Initializers
-    override init(frame: CGRect) {
+    override public init(frame: CGRect) {
         super.init(frame: frame)
         prepareView()
     }
-    
+
     convenience public init() {
-        let frame = CGRect(x: 0, y: 0, width: 30, height: 30)
-        self.init(frame: frame)
-        prepareView()
+        self.init(frame: .zero)
     }
-
-    private func getImageFrom(initals: String, withColor color: UIColor = UIColor.white, fontSize: CGFloat = 14) -> UIImage {
-        _ = UIGraphicsBeginImageContext(CGSize(width: 30, height: 30))
+
+    private func getImageFrom(initals: String) -> UIImage {
+        let width = frame.width
+        let height = frame.height
+        if width == 0 || height == 0 {return UIImage()}
+        var font = placeholderFont
+
+        _ = UIGraphicsBeginImageContext(CGSize(width: width, height: height))
         let context = UIGraphicsGetCurrentContext()!
-        
+
         //// Text Drawing
-        let textRect = CGRect(x: 5, y: 6, width: 20, height: 20)
+        let textRect = calculateTextRect(outerViewWidth: width, outerViewHeight: height)
+        if adjustsFontSizeToFitWidth,
+            initals.width(considering: textRect.height, and: font) > textRect.width {
+            let newFontSize = calculateFontSize(text: initals, font: font, width: textRect.width, height: textRect.height)
+            font = placeholderFont.withSize(newFontSize)
+        }
+
         let textStyle = NSMutableParagraphStyle()
         textStyle.alignment = .center
-        let textFontAttributes = [NSFontAttributeName: UIFont.systemFont(ofSize: fontSize), NSForegroundColorAttributeName: color, NSParagraphStyleAttributeName: textStyle]
-        
+        let textFontAttributes: [String: Any] = [NSFontAttributeName: font, NSForegroundColorAttributeName: placeholderTextColor, NSParagraphStyleAttributeName: textStyle]
+
         let textTextHeight: CGFloat = initals.boundingRect(with: CGSize(width: textRect.width, height: CGFloat.infinity), options: .usesLineFragmentOrigin, attributes: textFontAttributes, context: nil).height
         context.saveGState()
         context.clip(to: textRect)
@@ -61,47 +112,94 @@ open class AvatarView: UIView {
         guard let renderedImage = UIGraphicsGetImageFromCurrentImageContext() else { assertionFailure("Could not create image from context"); return UIImage()}
         return renderedImage
     }
-
+
+    /**
+     Recursively find the biggest size to fit the text with a given width and height
+     */
+    private func calculateFontSize(text: String, font: UIFont, width: CGFloat, height: CGFloat) -> CGFloat {
+        if text.width(considering: height, and: font) > width {
+            let newFont = font.withSize(font.pointSize - 1)
+            if newFont.pointSize > minimumFontSize {
+                return font.pointSize
+            } else {
+                return calculateFontSize(text: text, font: newFont, width: width, height: height)
+            }
+        }
+        return font.pointSize
+    }
+
+    /**
+     Calculates the inner circle's width.
+     Note: Assumes corner radius cannot be more than width/2 (this creates circle).
+     */
+    private func calculateTextRect(outerViewWidth: CGFloat, outerViewHeight: CGFloat) -> CGRect {
+        guard outerViewWidth > 0 else {
+            return CGRect.zero
+        }
+        let shortEdge = min(outerViewHeight, outerViewWidth)
+        // Converts degree to radian degree and calculate the
+        // Assumes, it is a perfect circle based on the shorter part of ellipsoid
+        // calculate a rectangle
+        let w = shortEdge * sin(CGFloat(45).degreesToRadians) * 2
+        let h = shortEdge * cos(CGFloat(45).degreesToRadians) * 2
+        let startX = (outerViewWidth - w)/2
+        let startY = (outerViewHeight - h)/2
+        // In case the font exactly fits to the region, put 2 pixel both left and right
+        return CGRect(x: startX+2, y: startY, width: w-4, height: h)
+    }
+
     required public init?(coder aDecoder: NSCoder) {
         fatalError("init(coder:) has not been implemented")
     }
-    
+
     // MARK: - Internal methods
-    
+
     internal func prepareView() {
-        setBackground(color: UIColor.gray)
+        backgroundColor = .gray
         contentMode = .scaleAspectFill
         layer.masksToBounds = true
         clipsToBounds = true
-        addSubview(imageView)
         imageView.contentMode = .scaleAspectFill
         imageView.frame = frame
+        addSubview(imageView)
         imageView.image = avatar.image ?? getImageFrom(initals: avatar.initals)
         setCorner(radius: nil)
     }
-    
+
     // MARK: - Open setters
-    
+
     open func set(avatar: Avatar) {
         imageView.image = avatar.image ?? getImageFrom(initals: avatar.initals)
     }
-
-    open func setBackground(color: UIColor) {
-        backgroundColor = color
-    }
-
+
     open func setCorner(radius: CGFloat?) {
         guard let radius = radius else {
             //if corner radius not set default to Circle
-            layer.cornerRadius = frame.height/2
+            let cornerRadius = min(frame.width, frame.height)
+            layer.cornerRadius = cornerRadius/2
             return
         }
+        self.radius = radius
         layer.cornerRadius = radius
     }
-
-    // MARK: - Open getters
-
-    open func getImage() -> UIImage? {
+
+}
+
+extension FloatingPoint {
+    var degreesToRadians: Self { return self * .pi / 180 }
+    var radiansToDegrees: Self { return self * 180 / .pi }
+}
+
+public extension AvatarView {
+
+    @available(*, deprecated: 0.8.0, message: "setBackground(_:) has been deprecated. Please use the backgroundColor property instead.")
+    public func setBackground(color: UIColor) {
+        backgroundColor = color
+    }
+
+    @available(*, deprecated: 0.8.0, message: "getImage() has been deprecated. Please use the image property instead.")
+    public func getImage() -> UIImage? {
         return imageView.image
     }
+
 }
diff --git a/Tests/AvatarViewTests.swift b/Tests/AvatarViewTests.swift
@@ -26,57 +26,56 @@ import XCTest
 @testable import MessageKit
 
 class AvatarViewTests: XCTestCase {
-
+
+    var avatarView: AvatarView!
+
     override func setUp() {
         super.setUp()
+        avatarView = AvatarView()
+        avatarView.frame.size = CGSize(width: 30, height: 30)
     }
-    
+
     override func tearDown() {
         super.tearDown()
+        avatarView = nil
     }
-    
+
     func testNoParams() {
-        let avatarView = AvatarView()
         XCTAssertEqual(avatarView.avatar.initals, "?")
         XCTAssertEqual(avatarView.layer.cornerRadius, 15.0)
         XCTAssertEqual(avatarView.backgroundColor, UIColor.gray)
     }
-    
+
     func testWithImage() {
-        let avatarView = AvatarView()
         let avatar = Avatar(image: UIImage())
         avatarView.set(avatar: avatar)
         XCTAssertEqual(avatar.initals, "?")
         XCTAssertEqual(avatarView.layer.cornerRadius, 15.0)
         XCTAssertEqual(avatarView.backgroundColor, UIColor.gray)
     }
-    
+
     func testInitalsOnly() {
-        let avatarView = AvatarView()
         let avatar = Avatar(initals: "DL")
         avatarView.set(avatar: avatar)
         XCTAssertEqual(avatar.initals, "DL")
         XCTAssertEqual(avatarView.layer.cornerRadius, 15.0)
         XCTAssertEqual(avatarView.backgroundColor, UIColor.gray)
     }
-    
+
     func testSetBackground() {
-        let avatarView = AvatarView()
         XCTAssertEqual(avatarView.backgroundColor, UIColor.gray)
-        avatarView.setBackground(color: UIColor.red)
+        avatarView.backgroundColor = UIColor.red
         XCTAssertEqual(avatarView.backgroundColor, UIColor.red)
     }
-    
+
     func testGetImage() {
         let image = UIImage()
         let avatar = Avatar(image: image)
-        let avatarView = AvatarView()
         avatarView.set(avatar: avatar)
-        XCTAssertEqual(avatarView.getImage(), image)
+        XCTAssertEqual(avatarView.image, image)
     }
-    
+
     func testRoundedCorners() {
-        let avatarView = AvatarView()
         let avatar = Avatar(image: UIImage())
         avatarView.set(avatar: avatar)
         XCTAssertEqual(avatarView.layer.cornerRadius, 15.0)