Merge pull request #12 from GitHawkApp/readability

Improve API readability

Author: rnystrom

StyledText/StyledTextRenderer.swift

@@ -78,14 +78,14 @@ public final class StyledTextRenderer {
         return size
     }
 
-    public func size(width: CGFloat) -> CGSize {
+    public func size(in width: CGFloat = .greatestFiniteMagnitude) -> CGSize {
         os_unfair_lock_lock(&lock)
         defer { os_unfair_lock_unlock(&lock) }
         return _size(StyledTextRenderCacheKey(width: width, attributedText: storage, backgroundColor: backgroundColor))
     }
 
-    public func viewSize(width: CGFloat) -> CGSize {
-        return size(width: width).resized(inset: inset)
+    public func viewSize(in width: CGFloat = .greatestFiniteMagnitude) -> CGSize {
+        return size(in: width).resized(inset: inset)
     }
 
     private static let globalBitmapCache = LRUCache<StyledTextRenderCacheKey, CGImage>(
@@ -94,7 +94,7 @@ public final class StyledTextRenderer {
         clearOnWarning: true
     )
 
-    public func render(width: CGFloat) -> (image: CGImage?, size: CGSize) {
+    public func render(for width: CGFloat) -> (image: CGImage?, size: CGSize) {
         os_unfair_lock_lock(&lock)
         defer { os_unfair_lock_unlock(&lock) }
 
@@ -142,8 +142,8 @@ public final class StyledTextRenderer {
         width: CGFloat
         ) -> StyledTextRenderer {
         switch option {
-        case .size: let _ = size(width: width)
-        case .bitmap: let _ = render(width: width)
+        case .size: let _ = size(in: width)
+        case .bitmap: let _ = render(for: width)
         }
         return self
     }

StyledText/StyledTextView.swift

@@ -163,16 +163,16 @@ open class StyledTextView: UIView {
 
     // MARK: Public API
 
-    open func configure(renderer: StyledTextRenderer, width: CGFloat) {
+    open func configure(with renderer: StyledTextRenderer, width: CGFloat) {
         self.renderer = renderer
         layer.contentsScale = renderer.scale
-        reposition(width: width)
+        reposition(for: width)
         accessibilityLabel = renderer.string.allText
     }
 
-    open func reposition(width: CGFloat) {
+    open func reposition(for width: CGFloat) {
         guard let renderer = self.renderer else { return }
-        let result = renderer.render(width: width)
+        let result = renderer.render(for: width)
         layer.contents = result.image
         frame = CGRect(origin: CGPoint(x: renderer.inset.left, y: renderer.inset.top), size: result.size)
     }

StyledTextTests/StyledTextRendererSnapshotTests.swift

@@ -13,8 +13,8 @@ import Snap_swift
 extension UIView {
 
     func mount(width: CGFloat, renderer: StyledTextRenderer) -> UIView {
-        frame = CGRect(origin: .zero, size: renderer.size(width: width))
-        layer.contents = renderer.render(width: width).image
+        frame = CGRect(origin: .zero, size: renderer.size(in: width))
+        layer.contents = renderer.render(for: width).image
         return self
     }