Rework package

.github/workflows/swift.yml

@@ -18,5 +18,5 @@ jobs:
     - uses: actions/checkout@v3
     - name: Build
       run: swift build -v
-    - name: Run tests
-      run: swift test -v
+    - name: Run tests with release configurations
+      run: swift test -v -c release

.swiftpm/xcode/xcshareddata/xcbaselines/PersianJustifyTests.xcbaseline/599589E8-9A65-4A13-A7CA-EA286CFECAE6.plist

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>classNames</key>
+	<dict>
+		<key>MeasurementTests</key>
+		<dict>
+			<key>testPerformance()</key>
+			<dict>
+				<key>com.apple.dt.XCTMetric_Memory.physical</key>
+				<dict>
+					<key>baselineAverage</key>
+					<real>13.107200</real>
+					<key>baselineIntegrationDisplayName</key>
+					<string>Local Baseline</string>
+				</dict>
+			</dict>
+		</dict>
+	</dict>
+</dict>
+</plist>

.swiftpm/xcode/xcshareddata/xcbaselines/PersianJustifyTests.xcbaseline/99F2CE76-E54F-4D94-A4E3-79239E11F46F.plist

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>classNames</key>
+	<dict>
+		<key>MeasurementTests</key>
+		<dict>
+			<key>testPerformance()</key>
+			<dict>
+				<key>com.apple.dt.XCTMetric_CPU.cycles</key>
+				<dict>
+					<key>baselineAverage</key>
+					<real>3585.980600</real>
+					<key>baselineIntegrationDisplayName</key>
+					<string>Local Baseline</string>
+				</dict>
+			</dict>
+		</dict>
+	</dict>
+</dict>
+</plist>

.swiftpm/xcode/xcshareddata/xcbaselines/PersianJustifyTests.xcbaseline/Info.plist

@@ -0,0 +1,64 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>runDestinationsByUUID</key>
+	<dict>
+		<key>599589E8-9A65-4A13-A7CA-EA286CFECAE6</key>
+		<dict>
+			<key>localComputer</key>
+			<dict>
+				<key>busSpeedInMHz</key>
+				<integer>0</integer>
+				<key>cpuCount</key>
+				<integer>1</integer>
+				<key>cpuKind</key>
+				<string>Apple M1 Pro</string>
+				<key>cpuSpeedInMHz</key>
+				<integer>0</integer>
+				<key>logicalCPUCoresPerPackage</key>
+				<integer>10</integer>
+				<key>modelCode</key>
+				<string>MacBookPro18,1</string>
+				<key>physicalCPUCoresPerPackage</key>
+				<integer>10</integer>
+				<key>platformIdentifier</key>
+				<string>com.apple.platform.macosx</string>
+			</dict>
+			<key>targetArchitecture</key>
+			<string>arm64e</string>
+		</dict>
+		<key>99F2CE76-E54F-4D94-A4E3-79239E11F46F</key>
+		<dict>
+			<key>localComputer</key>
+			<dict>
+				<key>busSpeedInMHz</key>
+				<integer>0</integer>
+				<key>cpuCount</key>
+				<integer>1</integer>
+				<key>cpuKind</key>
+				<string>Apple M1 Pro</string>
+				<key>cpuSpeedInMHz</key>
+				<integer>0</integer>
+				<key>logicalCPUCoresPerPackage</key>
+				<integer>10</integer>
+				<key>modelCode</key>
+				<string>MacBookPro18,1</string>
+				<key>physicalCPUCoresPerPackage</key>
+				<integer>10</integer>
+				<key>platformIdentifier</key>
+				<string>com.apple.platform.macosx</string>
+			</dict>
+			<key>targetArchitecture</key>
+			<string>arm64</string>
+			<key>targetDevice</key>
+			<dict>
+				<key>modelCode</key>
+				<string>iPhone16,1</string>
+				<key>platformIdentifier</key>
+				<string>com.apple.platform.iphonesimulator</string>
+			</dict>
+		</dict>
+	</dict>
+</dict>
+</plist>

Package.swift

@@ -6,20 +6,20 @@ import PackageDescription
 let package = Package(
     name: "PersianJustify",
     products: [
-        // Products define the executables and libraries a package produces, making them visible to other packages.
         .library(
             name: "PersianJustify",
-            targets: ["PersianJustify"]),
+            targets: ["PersianJustify"]
+        ),
     ],
     dependencies: [
         .package(url: "https://github.com/ArtSabintsev/FontBlaster", from: "5.3.0"),
         .package(url: "https://github.com/pointfreeco/swift-snapshot-testing", from: "1.15.4"),
     ],
     targets: [
-        // Targets are the basic building blocks of a package, defining a module or a test suite.
-        // Targets can depend on other targets in this package and products from dependencies.
         .target(
-            name: "PersianJustify"),
+            name: "PersianJustify",
+            path: "Sources"
+        ),
         .testTarget(
             name: "PersianJustifyTests",
             dependencies: [

Sources/ArabicCharacterEvaluator.swift

@@ -0,0 +1,17 @@
+import class Foundation.NSPredicate
+
+/// Regex that will be used against an arbitrary string,
+/// to identify if it's in Arabic.
+private let arabicRegex = "(?s).*\\p{Arabic}.*"
+
+/// Wrapper around a predicate that will encapsulate the logic of identifying if a given string is in Arabic.
+struct ArabicCharacterEvaluator {
+    private static let _predicate = NSPredicate(format: "SELF MATCHES %@", arabicRegex)
+
+    func evaluate(with character: Character) -> Bool {
+        // Character must be converted to string before being fed to predicate.
+        let stringRepresentation = String(character)
+
+        return Self._predicate.evaluate(with: stringRepresentation)
+    }
+}

Sources/Characters/ExtenderCharacter.swift

@@ -0,0 +1,14 @@
+import Foundation
+
+/// Wrapper around a character which is used to extend some characters in `Farsi`.
+struct ExtenderCharacter {
+    private static let _character: Character = "ـ" // Persian underline
+
+    static var stringRepresentation: String {
+        String(Self._character)
+    }
+
+    static var wordRepresentation: Word {
+        Word(stringRepresentation)
+    }
+}

Sources/Characters/LineBreakCharacter.swift

@@ -0,0 +1,32 @@
+import Foundation
+
+/// Wrapper around a character which is used to break a line.
+struct LineBreakCharacter {
+    fileprivate static let _character: Character = "\n"
+
+    static var stringRepresentation: String {
+        String(LineBreakCharacter._character)
+    }
+
+    static var attributedStringRepresentation: NSAttributedString {
+        NSAttributedString(string: stringRepresentation)
+    }
+
+    static func + (lhs: LineBreakCharacter, rhs: LineBreakCharacter) -> String {
+        stringRepresentation + stringRepresentation
+    }
+
+    static func + (lhs: String, rhs: LineBreakCharacter) -> String {
+        lhs + stringRepresentation
+    }
+}
+
+extension String {
+    func replacingOccurrences(of target: String, with replacement: LineBreakCharacter) -> String {
+        replacingOccurrences(of: target, with: LineBreakCharacter.stringRepresentation)
+    }
+
+    func splitWithLineSeparator() -> [Substring] {
+        split(separator: LineBreakCharacter._character)
+    }
+}

Sources/Characters/MiniSpaceCharacter.swift

@@ -0,0 +1,18 @@
+import Foundation
+
+/// Wrapper around a character which is used to add a small spacer between characters in `Farsi`.
+struct MiniSpaceCharacter {
+    private static let _character: Character = "‌"
+
+    static var stringRepresentation: String {
+        String(Self._character)
+    }
+
+    static func + (lhs: MiniSpaceCharacter, rhs: MiniSpaceCharacter) -> String {
+        stringRepresentation + stringRepresentation
+    }
+
+    static func + (lhs: String, rhs: MiniSpaceCharacter) -> String {
+        lhs + stringRepresentation
+    }
+}

Sources/Characters/SpaceCharacter.swift

@@ -0,0 +1,30 @@
+import Foundation
+
+/// Wrapper around a character which is used to append a space.
+struct SpaceCharacter {
+    fileprivate static let _character: Character = " "
+
+    static var stringRepresentation: String {
+        String(Self._character)
+    }
+
+    static var attributedStringRepresentation: NSAttributedString {
+        NSAttributedString(string: stringRepresentation)
+    }
+
+    static func + (lhs: String, rhs: SpaceCharacter) -> String {
+        lhs + stringRepresentation
+    }
+}
+
+extension NSMutableAttributedString {
+    func appendSpaceCharacter() {
+        append(SpaceCharacter.attributedStringRepresentation)
+    }
+}
+
+extension String.SubSequence {
+    func splitWithSpaceSeparator() -> [Substring] {
+        split(separator: SpaceCharacter._character)
+    }
+}

Sources/CoreTextExtensible/Line.swift

@@ -0,0 +1,127 @@
+import Foundation
+
+#if canImport(UIKit)
+import class UIKit.NSMutableParagraphStyle
+import enum UIKit.NSTextAlignment
+#elseif canImport(AppKit)
+import class AppKit.NSMutableParagraphStyle
+import enum AppKit.NSTextAlignment
+#endif
+
+/// Wrapper around a line.
+/// Object will extend line capabilities and encapsulate logics related to justifying a line.
+struct Line {
+    private let _line: String.SubSequence
+
+    init(_ line: String.SubSequence) {
+        self._line = line
+    }
+
+    init(_ line: String) {
+        self._line = String.SubSequence(line)
+    }
+
+    var stringRepresentation: String {
+        String(_line)
+    }
+
+    /// Get every word in a line.
+    func getWords() -> [Word] {
+        _line.splitWithSpaceSeparator()
+            .map { Word($0) }
+    }
+
+    /// Re-aligns a line based on proposed width and given font.
+    func justify(
+        in proposedWidth: CGFloat,
+        isLastLineInParagraph: Bool,
+        font: Font
+    ) -> NSMutableAttributedString {
+        let words = getWords()
+
+        lazy var emptySpace: CGFloat = {
+            let totalWordsWidth = words.getRequiredWidth(with: font)
+
+            return proposedWidth - totalWordsWidth
+        }()
+
+        lazy var requiredExtender: CGFloat = {
+            let singleExtenderWidth = ExtenderCharacter
+                .wordRepresentation
+                .getWordWidth(font: font, isRequiredSpace: false)
+
+            let extractedExpr = emptySpace / singleExtenderWidth
+            return Swift.max(extractedExpr, 0)
+        }()
+
+        let supportedExtenderWords = words.filter { $0.canSupportExtender }
+
+        if isLastLineInParagraph {
+            // May not required justify.
+            return NSMutableAttributedString(string: stringRepresentation)
+        } else {
+            lazy var isManyExtendersRequired = CGFloat(supportedExtenderWords.count) < requiredExtender
+
+            let requiredExtend: CGFloat
+
+            if isManyExtendersRequired {
+                requiredExtend = emptySpace / CGFloat(supportedExtenderWords.count)
+            } else if requiredExtender > 0 && supportedExtenderWords.count > 0 {
+                requiredExtend = max(requiredExtender * 0.1, 0)
+            } else {
+                return NSMutableAttributedString(string: stringRepresentation)
+            }
+
+            return getExtendedWords(
+                words: supportedExtenderWords,
+                requiredExtend: requiredExtend * 0.2,
+                font: font
+            )
+        }
+    }
+
+    private func getExtendedWords(
+        words: [Word],
+        requiredExtend: CGFloat,
+        font: Font
+    ) -> NSMutableAttributedString {
+        let style: NSMutableParagraphStyle = {
+            let style = NSMutableParagraphStyle()
+            style.alignment = NSTextAlignment.justified
+            style.baseWritingDirection = .rightToLeft
+            return style
+        }()
+
+        let totalRange = NSRange(location: 0, length: _line.utf16.count)
+
+        let attributedText = NSMutableAttributedString(string: stringRepresentation)
+        attributedText.setAttributes([NSAttributedString.Key.font: font], range: totalRange)
+
+        for word in words {
+            let range = getRange(of: word)
+            attributedText.addAttribute(NSAttributedString.Key.kern, value: requiredExtend, range: range)
+            attributedText.addAttributes([NSAttributedString.Key.paragraphStyle: style], range: range)
+        }
+
+        return attributedText
+    }
+
+    private func getRange(of word: Word) -> NSRange {
+        (_line as NSString).range(of: word.stringRepresentation, options: .widthInsensitive)
+    }
+}
+
+extension [Word] {
+    /// Method that will determine if a given word can fit inside the line based on proposed width.
+    func hasRoomForNextWord(nextWord: Word, proposedWidth: CGFloat, font: Font) -> Bool {
+        let requiredWidth = nextWord.getWordWidth(font: font)
+        let currentWidth = getRequiredWidth(with: font)
+        return (currentWidth + requiredWidth) <= proposedWidth
+    }
+
+    /// Method that will calculate required width for words.
+    fileprivate func getRequiredWidth(with font: Font) -> CGFloat {
+        map { $0.getWordWidth(font: font) }
+            .reduce(0, +)
+    }
+}