Add support for paragraphIndent and paragraphSpacing

Author: Mark Pospesel

Sources/YMatterType/Extensions/UIKit/NSParagraphStyle+lineSpacing.swift

@@ -39,10 +39,27 @@ extension NSParagraphStyle {
     /// Combines line height with the existing style
     /// - Parameter lineHeight: the line height to use
     /// - Returns: Current paragraph style combined with minimumLineHeight and maximumLineHeight both set to lineHeight
-    public func styleWithLineHeight(_ lineHeight: CGFloat) -> NSParagraphStyle {
+
+    /// Combines line height with the existing style
+    /// - Parameters:
+    ///   - lineHeight: the line height to use
+    ///   - indent: the indent to use (ignored if `0`)
+    ///   - spacing: the spacing to use (ignored if `0`)
+    /// - Returns: Current paragraph style combined with line height and (if non-zero) indent and spacing
+    public func styleWithLineHeight(
+        _ lineHeight: CGFloat,
+        indent: CGFloat = 0,
+        spacing: CGFloat = 0
+    ) -> NSParagraphStyle {
         let paragraphStyle = (mutableCopy() as? NSMutableParagraphStyle) ?? NSMutableParagraphStyle()
         paragraphStyle.minimumLineHeight = lineHeight
         paragraphStyle.maximumLineHeight = lineHeight
+        if indent != 0 {
+            paragraphStyle.firstLineHeadIndent = indent
+        }
+        if spacing != 0 {
+            paragraphStyle.paragraphSpacing = spacing
+        }
         return paragraphStyle
     }
 }

Sources/YMatterType/Typography/Typography+Font.swift

@@ -76,6 +76,8 @@ extension Typography {
             lineHeight: scaledLineHeight,
             baselineOffset: baselineOffset,
             kerning: letterSpacing,
+            paragraphIndent: paragraphIndent,
+            paragraphSpacing: paragraphSpacing,
             textCase: textCase,
             textDecoration: textDecoration
         )

Sources/YMatterType/Typography/Typography+Mutators.swift

@@ -19,6 +19,8 @@ public extension Typography {
             fontSize: fontSize,
             lineHeight: lineHeight,
             letterSpacing: letterSpacing,
+            paragraphIndent: paragraphIndent,
+            paragraphSpacing: paragraphSpacing,
             textCase: textCase,
             textDecoration: textDecoration,
             textStyle: textStyle,
@@ -36,6 +38,8 @@ public extension Typography {
             fontSize: fontSize,
             lineHeight: lineHeight,
             letterSpacing: letterSpacing,
+            paragraphIndent: paragraphIndent,
+            paragraphSpacing: paragraphSpacing,
             textCase: textCase,
             textDecoration: textDecoration,
             textStyle: textStyle,
@@ -53,6 +57,8 @@ public extension Typography {
             fontSize: fontSize,
             lineHeight: lineHeight,
             letterSpacing: letterSpacing,
+            paragraphIndent: paragraphIndent,
+            paragraphSpacing: paragraphSpacing,
             textCase: textCase,
             textDecoration: textDecoration,
             textStyle: textStyle,
@@ -72,6 +78,8 @@ public extension Typography {
             fontSize: fontSize,
             lineHeight: lineHeight,
             letterSpacing: value,
+            paragraphIndent: paragraphIndent,
+            paragraphSpacing: paragraphSpacing,
             textCase: textCase,
             textDecoration: textDecoration,
             textStyle: textStyle,
@@ -91,6 +99,8 @@ public extension Typography {
             fontSize: fontSize,
             lineHeight: lineHeight,
             letterSpacing: letterSpacing,
+            paragraphIndent: paragraphIndent,
+            paragraphSpacing: paragraphSpacing,
             textCase: value,
             textDecoration: textDecoration,
             textStyle: textStyle,
@@ -110,6 +120,8 @@ public extension Typography {
             fontSize: fontSize,
             lineHeight: lineHeight,
             letterSpacing: letterSpacing,
+            paragraphIndent: paragraphIndent,
+            paragraphSpacing: paragraphSpacing,
             textCase: textCase,
             textDecoration: value,
             textStyle: textStyle,

Sources/YMatterType/Typography/Typography.swift

@@ -20,6 +20,10 @@ public struct Typography {
     public let lineHeight: CGFloat
     /// Letter spacing (in points, not percentage)
     public let letterSpacing: CGFloat
+    /// Paragraph indent (in points)
+    public let paragraphIndent: CGFloat
+    /// Paragraph spacing (in points)
+    public let paragraphSpacing: CGFloat
     /// Text case
     public let textCase: TextCase
     /// Text decoration (none, underline, or strikethrough)
@@ -37,6 +41,8 @@ public struct Typography {
     ///   - fontSize: font size to use
     ///   - lineHeight: line height to use
     ///   - chaacterSpacing: letter spacing to use (defaults to `0`)
+    ///   - paragraphIndent: paragraph indent to use (defaults to `0`)
+    ///   - paragraphSpacing: paragraph spacing to use (defaults to `0`)
     ///   - textCase: text case to apply (defaults to `.none`)
     ///   - textDecoration: text decoration to apply (defaults to `.none`)
     ///   - textStyle: text style to use for scaling (defaults to `.body`)
@@ -47,6 +53,8 @@ public struct Typography {
         fontSize: CGFloat,
         lineHeight: CGFloat,
         letterSpacing: CGFloat = 0,
+        paragraphIndent: CGFloat = 0,
+        paragraphSpacing: CGFloat = 0,
         textCase: TextCase = .none,
         textDecoration: TextDecoration = .none,
         textStyle: UIFont.TextStyle = .body,
@@ -57,6 +65,8 @@ public struct Typography {
         self.fontSize = fontSize
         self.lineHeight = lineHeight
         self.letterSpacing = letterSpacing
+        self.paragraphIndent = paragraphIndent
+        self.paragraphSpacing = paragraphSpacing
         self.textCase = textCase
         self.textDecoration = textDecoration
         self.textStyle = textStyle
@@ -71,6 +81,8 @@ public struct Typography {
     ///   - fontSize: font size to use
     ///   - lineHeight: line height to use
     ///   - chaacterSpacing: letter spacing to use (defaults to `0`)
+    ///   - paragraphIndent: paragraph indent to use (defaults to `0`)
+    ///   - paragraphSpacing: paragraph spacing to use (defaults to `0`)
     ///   - textCase: text case to apply (defaults to `.none`)
     ///   - textDecoration: text decoration to apply (defaults to `.none`)
     ///   - textStyle: text style to use for scaling (defaults to `.body`)
@@ -82,6 +94,8 @@ public struct Typography {
         fontSize: CGFloat,
         lineHeight: CGFloat,
         letterSpacing: CGFloat = 0,
+        paragraphIndent: CGFloat = 0,
+        paragraphSpacing: CGFloat = 0,
         textCase: TextCase = .none,
         textDecoration: TextDecoration = .none,
         textStyle: UIFont.TextStyle = .body,
@@ -93,6 +107,8 @@ public struct Typography {
             fontSize: fontSize,
             lineHeight: lineHeight,
             letterSpacing: letterSpacing,
+            paragraphIndent: paragraphIndent,
+            paragraphSpacing: paragraphSpacing,
             textCase: textCase,
             textDecoration: textDecoration,
             textStyle: textStyle,

Sources/YMatterType/Typography/TypographyLayout.swift

@@ -24,6 +24,12 @@ public struct TypographyLayout {
     /// Kerning to apply for letter spacing with this font
     public let kerning: CGFloat
 
+    /// Paragraph indent to apply
+    public let paragraphIndent: CGFloat
+
+    /// Paragraph spacing to apply
+    public let paragraphSpacing: CGFloat
+    
     /// Text case to apply to text
     public let textCase: Typography.TextCase
 
@@ -41,16 +47,20 @@ public struct TypographyLayout {
         lineHeight: CGFloat,
         baselineOffset: CGFloat,
         kerning: CGFloat,
+        paragraphIndent: CGFloat,
+        paragraphSpacing: CGFloat,
         textCase: Typography.TextCase,
         textDecoration: Typography.TextDecoration
     ) {
         self.font = font
         self.lineHeight = lineHeight
         self.baselineOffset = baselineOffset
         self.kerning = kerning
+        self.paragraphIndent = paragraphIndent
+        self.paragraphSpacing = paragraphSpacing
         self.textCase = textCase
         self.textDecoration = textDecoration
-        self.paragraphStyle = NSParagraphStyle.default.styleWithLineHeight(lineHeight)
+        self.paragraphStyle = NSParagraphStyle.default.styleWithLineHeight(lineHeight, indent: paragraphIndent, spacing: paragraphSpacing)
     }
 }
 

Tests/YMatterTypeTests/Elements/TypographyButtonTests.swift

@@ -53,18 +53,19 @@ final class TypographyButtonTests: TypographyElementTests {
     }
 
     func testMultiLine() {
-        let sut = makeSUT()
+        let spacing = CGFloat(Int.random(in: 1..<10))
+        let sut = makeSUT(spacing: spacing)
         sut.titleLabel?.numberOfLines = 0
 
         // Given a label with text that spans multiple lines
         [2, 3, 5, 8, 13].forEach {
             let array: [String] = Array(repeating: "Hello World", count: $0)
             sut.setTitle(array.joined(separator: "\n"), for: .normal)
 
-            // we expect label height to be a multiple of lineHeight
+            // we expect label height to be a multiple of lineHeight + paragraph spacing
             XCTAssertEqual(
                 sut.intrinsicContentSize.height,
-                sut.typography.lineHeight * CGFloat($0) + sut.contentEdgeInsets.vertical
+                sut.typography.lineHeight * CGFloat($0) + sut.contentEdgeInsets.vertical + spacing * CGFloat($0 - 1)
             )
             // after calling sizeToFit we expect bounds to equal intrinsicContentSize
             sut.sizeToFit()
@@ -409,12 +410,13 @@ final class TypographyButtonTests: TypographyElementTests {
 }
 
 private extension TypographyButtonTests {
-    func makeSUT(file: StaticString = #filePath, line: UInt = #line) -> MockButton {
+    func makeSUT(spacing: CGFloat = 0, file: StaticString = #filePath, line: UInt = #line) -> MockButton {
         let typography = Typography(
             fontFamily: Typography.sfProText,
             fontWeight: .regular,
             fontSize: 16,
             lineHeight: 24,
+            paragraphSpacing: spacing,
             isFixed: true
         )
         let sut = MockButton(typography: typography)

Tests/YMatterTypeTests/Elements/TypographyLabelTests.swift

@@ -46,16 +46,17 @@ final class TypographyLabelTests: TypographyElementTests {
     }
 
     func testMultiLine() {
-        let sut = makeSUT()
+        let spacing = CGFloat(Int.random(in: 1..<10))
+        let sut = makeSUT(spacing: spacing)
         sut.numberOfLines = 0
 
         // Given a label with text that spans multiple lines
         [2, 3, 5, 8, 13].forEach {
             let array: [String] = Array(repeating: "Hello World", count: $0)
             sut.text = array.joined(separator: "\n")
 
-            // we expect label height to be a multiple of lineHeight
-            XCTAssertEqual(sut.intrinsicContentSize.height, sut.typography.lineHeight * CGFloat($0))
+            // we expect label height to be a multiple of lineHeight + paragraph spacing
+            XCTAssertEqual(sut.intrinsicContentSize.height, sut.typography.lineHeight * CGFloat($0) + spacing * CGFloat($0 - 1))
             // after calling sizeToFit we expect bounds to equal intrinsicContentSize
             sut.sizeToFit()
             XCTAssertEqual(sut.intrinsicContentSize, sut.bounds.size)
@@ -322,15 +323,39 @@ final class TypographyLabelTests: TypographyElementTests {
         sut.attributedText = NSAttributedString(string: "first name", attributes: [.underlineStyle: 1])
         XCTAssertEqual(sut.attributedText?.string, "First Name")
     }
+
+    func testParagraphIndent() {
+        // Given
+        let indent = CGFloat(Int.random(in: 1..<10))
+        let sut = makeSUT()
+        let sut2 = makeSUT(indent: indent)
+
+        // When
+        sut.text = "Hello World"
+        sut2.text = "Hello World"
+
+        // Then
+        XCTAssertEqual(
+            sut.intrinsicContentSize.width + indent,
+            sut2.intrinsicContentSize.width
+        )
+    }
 }
 
 private extension TypographyLabelTests {
-    func makeSUT(file: StaticString = #filePath, line: UInt = #line) -> MockLabel {
+    func makeSUT(
+        indent: CGFloat = 0,
+        spacing: CGFloat = 0,
+        file: StaticString = #filePath,
+        line: UInt = #line
+    ) -> MockLabel {
         let typography = Typography(
             fontFamily: Typography.sfProDisplay,
             fontWeight: .regular,
             fontSize: 24,
             lineHeight: 32,
+            paragraphIndent: indent,
+            paragraphSpacing: spacing,
             isFixed: true
         )
         let sut = MockLabel(typography: typography)

Tests/YMatterTypeTests/Elements/TypographyTextViewTests.swift

@@ -47,12 +47,13 @@ final class TypographyTextViewTests: TypographyElementTests {
     func testMultiLine() {
         [2, 3, 5, 8, 13].forEach {
             // Given a text view with text that spans multiple lines
-            let sut = makeSUT()
+            let spacing = CGFloat(Int.random(in: 1..<10))
+            let sut = makeSUT(spacing: spacing)
             let array: [String] = Array(repeating: "Hello World", count: $0)
             sut.text = array.joined(separator: "\n")
 
-            // we expect label height to be a multiple of lineHeight
-            XCTAssertEqual(sut.intrinsicContentSize.height, sut.typography.lineHeight * CGFloat($0))
+            // we expect label height to be a multiple of lineHeight + paragraph spacing
+            XCTAssertEqual(sut.intrinsicContentSize.height, sut.typography.lineHeight * CGFloat($0) + spacing * CGFloat($0 - 1))
             // after calling sizeToFit we expect bounds to equal intrinsicContentSize
             sut.sizeToFit()
             XCTAssertEqual(sut.intrinsicContentSize, sut.bounds.size)
@@ -285,8 +286,17 @@ final class TypographyTextViewTests: TypographyElementTests {
 }
 
 private extension TypographyTextViewTests {
-    func makeSUT(file: StaticString = #filePath, line: UInt = #line) -> MockTextView {
-        let sut = MockTextView(typography: .title2.fixed)
+    func makeSUT(spacing: CGFloat = 0, file: StaticString = #filePath, line: UInt = #line) -> MockTextView {
+        let typography = Typography(
+            fontFamily: Typography.sfProDisplay,
+            fontWeight: .semibold,
+            fontSize: 22,
+            lineHeight: 28,
+            paragraphSpacing: spacing,
+            textStyle: .title2,
+            isFixed: true
+        )
+        let sut = MockTextView(typography: typography)
         sut.isScrollEnabled = false
         trackForMemoryLeak(sut, file: file, line: line)
         return sut

Tests/YMatterTypeTests/Extensions/UIKit/NSParagraphStyle+lineSpacingTests.swift

@@ -39,14 +39,24 @@ final class NSParagraphStyleLineSpacingTests: XCTestCase {
     func testStyleWithLineHeight() {
         let (sut, _, _, _, lineHeights) = makeSUT()
         lineHeights.forEach {
-            let style1 = sut.styleWithLineHeight($0)
-            let style2 = NSParagraphStyle.default.styleWithLineHeight($0)
-            let style3 = NonMutableParagraphStyle().styleWithLineHeight($0)
+            let indent = CGFloat(Int.random(in: 1..<10))
+            let spacing = CGFloat(Int.random(in: 10..<32))
+            let style1 = sut.styleWithLineHeight($0, indent: indent, spacing: spacing)
+            let style2 = NSParagraphStyle.default.styleWithLineHeight($0, indent: indent)
+            let style3 = NonMutableParagraphStyle().styleWithLineHeight($0, spacing: spacing)
 
             for style in [style1, style2, style3] {
                 XCTAssertEqual(style.minimumLineHeight, $0)
                 XCTAssertEqual(style.maximumLineHeight, $0)
             }
+
+            XCTAssertEqual(style1.firstLineHeadIndent, indent)
+            XCTAssertEqual(style2.firstLineHeadIndent, indent)
+            XCTAssertEqual(style3.firstLineHeadIndent, .zero)
+
+            XCTAssertEqual(style1.paragraphSpacing, spacing)
+            XCTAssertEqual(style2.paragraphSpacing, .zero)
+            XCTAssertEqual(style3.paragraphSpacing, spacing)
         }
     }
 }

Tests/YMatterTypeTests/Helpers/Typography+YMatterTypeTests.swift

@@ -64,6 +64,8 @@ extension Typography {
         fontWeight: .regular,
         fontSize: 15,
         lineHeight: 20,
+        paragraphIndent: 8,
+        paragraphSpacing: 10,
         textStyle: .body
     )
 
@@ -73,6 +75,8 @@ extension Typography {
         fontWeight: .regular,
         fontSize: 14,
         lineHeight: 20,
+        paragraphIndent: 8,
+        paragraphSpacing: 8,
         textStyle: .callout
     )