Adding unit tests and documentation

Author: virginiapujols-yml

Sources/YMatterType/Elements/TextStyleLabel.swift

@@ -8,44 +8,66 @@
 
 import SwiftUI
 
+/// A singe line text label that supports `Typography` for SwiftUI.
 public struct TextStyleLabel: View {
-    private let text: String
-    private let typography: Typography
-    private let configureTypographyText: ((TypographyLabel) -> Void)?
+    /// The text that the label displays.
+    let text: String
+    
+    /// Typography to be used for this label's text
+    let typography: Typography
+    
+    /// A closure that gets called on the init and refresh of the View
+    /// This closure allows you to provide additional configuration to the `TypographyLabel`
+    let configureTextStyleLabel: ((TypographyLabel) -> Void)?
 
-    public init(_ text: String,
-                typography: Typography,
-                configuration: ((TypographyLabel) -> Void)? = nil) {
-        self.typography = typography
-        self.text = text
-        self.configureTypographyText = configuration
+    /// The content and behavior of the view.
+    public var body: some View {
+        TypographyLabelRepresentable(
+            text: text,
+            typography: typography,
+            configureTextStyleLabel: configureTextStyleLabel
+        )
+        .fixedSize(horizontal: false, vertical: true)
     }
 
-    public var body: some View {
-        TypographyLabelRepresentable(text,
-                                     typography: typography,
-                                     configuration: configureTypographyText)
-            .fixedSize(horizontal: false, vertical: true)
+    /// Initializes a `TextStyleLabel` instance with the specified parameters
+    /// - Parameters:
+    ///   - text: The text that the label displays
+    ///   - typography: Typography to be used for this label's text
+    ///   - configuration: A closure that gets called on the init and refresh of the View
+    public init(
+        _ text: String,
+        typography: Typography,
+        configuration: ((TypographyLabel) -> Void)? = nil
+    ) {
+        self.typography = typography
+        self.text = text
+        self.configureTextStyleLabel = configuration
     }
 }
 
-public extension TextStyleLabel {
+extension TextStyleLabel {
+    /// A wrapper for a UIKit TypographyLabel view that allows to integrate that view into a SwiftUI view hierarchy.
     struct TypographyLabelRepresentable: UIViewRepresentable {
-        public typealias UIViewType = TypographyLabel
-
-        private let typography: Typography
-        private let text: String
-        private let configureText: ((TypographyLabel) -> Void)?
+        /// The type of view to present.
+        typealias UIViewType = TypographyLabel
 
-        public init(_ text: String,
-                    typography: Typography,
-                    configuration: ((TypographyLabel) -> Void)? = nil) {
-            self.typography = typography
-            self.text = text
-            self.configureText = configuration
-        }
+        /// The text that the label displays.
+        let text: String
 
-        public func makeUIView(context: Context) -> TypographyLabel {
+        /// Typography to be used for this label's text
+        let typography: Typography
+        
+        /// A closure that gets called on the init and refresh of the View
+        let configureTextStyleLabel: ((TypographyLabel) -> Void)?
+
+        /// Creates the view object and configures its initial state.
+        ///
+        /// - Parameter context: A context structure containing information about
+        ///   the current state of the system.
+        ///
+        /// - Returns: `TypographyLabel` view configured with the provided information.
+        func makeUIView(context: Context) -> TypographyLabel {
             let label = TypographyLabel(typography: typography)
             label.text = text
 
@@ -54,14 +76,21 @@ public extension TextStyleLabel {
             label.setContentCompressionResistancePriority(.defaultLow, for: .horizontal)
             label.setContentCompressionResistancePriority(.defaultLow, for: .vertical)
 
-            configureText?(label)
+            configureTextStyleLabel?(label)
             return label
         }
 
-        public func updateUIView(_ uiView: TypographyLabel, context: Context) {
+        /// Updates the state of the specified view with new information from
+        /// SwiftUI.
+        ///
+        /// - Parameters:
+        ///   - uiView: `TypographyLabel` view.
+        ///   - context: A context structure containing information about the current
+        ///     state of the system.
+        func updateUIView(_ uiView: TypographyLabel, context: Context) {
             uiView.typography = typography
             uiView.text = text
-            configureText?(uiView)
+            configureTextStyleLabel?(uiView)
         }
     }
 }

Tests/YMatterTypeTests/Elements/TextStyleLabelTests.swift

@@ -0,0 +1,76 @@
+//
+//  TextStyleLabelTests.swift
+//  YMatterTypeTests
+//
+//  Created by Virginia Pujols on 1/26/23.
+//  Copyright © 2023 Y Media Labs. All rights reserved.
+//
+
+import XCTest
+@testable import YMatterType
+
+final class TextStyleLabelTests: XCTestCase {
+    enum Constants {
+        static let helloWorldText = "Hello, World"
+        static let fontSize = CGFloat.random(in: 10...60)
+    }
+    
+    func testTextStyleLabelSingleLine() throws {
+        let fontSize = Constants.fontSize
+        let expectedTypography = Typography.systemLabel.fontSize(fontSize)
+        let expectedText = Constants.helloWorldText
+        
+        let label = TypographyLabel(typography: expectedTypography)
+        let labelConfig = { (label: TypographyLabel) in
+            label.lineBreakMode = .byTruncatingMiddle
+        }
+        labelConfig(label)
+
+        // Given a TextStyleLabel with a single line of text
+        let sut = TextStyleLabel(expectedText, typography: expectedTypography)
+        
+        // we expect a value
+        XCTAssertNotNil(sut)
+        
+        // we expect the text to match the expected
+        XCTAssertEqual(sut.text, expectedText)
+        
+        // we expect the font to match the expected
+        XCTAssertEqual(sut.typography.fontSize, fontSize)
+        
+        // we expect the configuration closusure to update the label
+        XCTAssertEqual(label.lineBreakMode, .byTruncatingMiddle)
+    }
+
+    func testTypographyLabelRepresentable() throws {
+        let fontSize = Constants.fontSize
+
+        let expectedTypography = Typography.systemLabel.fontSize(fontSize)
+        let expectedText = Constants.helloWorldText
+
+        let label = TypographyLabel(typography: expectedTypography)
+        let labelConfig = { (label: TypographyLabel) in
+            label.textColor = .darkText
+        }
+        labelConfig(label)
+
+        // Given a TypographyLabelRepresentable with a single line of text
+        let sut = TextStyleLabel.TypographyLabelRepresentable(
+            text: expectedText,
+            typography: expectedTypography,
+            configureTextStyleLabel: nil
+        )
+
+        // we expect a value
+        XCTAssertNotNil(sut)
+        
+        // we expect the text to match the expected
+        XCTAssertEqual(sut.text, expectedText)
+        
+        // we expect the font to match the expected
+        XCTAssertEqual(sut.typography.fontSize, fontSize)
+        
+        // we expect the configuration closusure to update the label
+        XCTAssertEqual(label.textColor, .darkText)
+    }
+}