Migrate Translation Content to SwiftUI

quran · Feb 3, 2024 · 4b0a70b · 4b0a70b
1 parent 5547188
commit 4b0a70b
Show file tree

Hide file tree

Showing 666 changed files with 1,675 additions and 105,177 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -33,4 +33,4 @@ jobs:
         run: sudo xcode-select -s "/Applications/Xcode_15.1.app"
 
       - name: Build
-        run: set -o pipefail &&  xcrun xcodebuild build -workspace Example/QuranEngineApp.xcworkspace -scheme QuranEngineApp -sdk "iphonesimulator" -destination 'generic/platform=iOS' CODE_SIGN_IDENTITY="" CODE_SIGNING_REQUIRED=NO | xcpretty
+        run: set -o pipefail &&  xcrun xcodebuild build -project Example/QuranEngineApp.xcodeproj -scheme QuranEngineApp -sdk "iphonesimulator" -destination 'generic/platform=iOS' CODE_SIGN_IDENTITY="" CODE_SIGNING_REQUIRED=NO | xcpretty
diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/AnnotationsService.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/AnnotationsService.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1430"
+   LastUpgradeVersion = "1510"
    version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"

diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/AppStructureFeature.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/AppStructureFeature.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1430"
+   LastUpgradeVersion = "1510"
    version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"

diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/BatchDownloader.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/BatchDownloader.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1430"
+   LastUpgradeVersion = "1510"
    version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"

diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/BookmarksFeature.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/BookmarksFeature.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1430"
+   LastUpgradeVersion = "1510"
    version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"

diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/Caching.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/Caching.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1430"
+   LastUpgradeVersion = "1510"
    version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"

diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/Crashing.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/Crashing.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1430"
+   LastUpgradeVersion = "1510"
    version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"

diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/HomeFeature.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/HomeFeature.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1430"
+   LastUpgradeVersion = "1510"
    version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"

diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/LastPagePersistence.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/LastPagePersistence.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1430"
+   LastUpgradeVersion = "1510"
    version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"

diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/Localization.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/Localization.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1430"
+   LastUpgradeVersion = "1510"
    version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"

diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/NoorUI.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/NoorUI.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1430"
+   LastUpgradeVersion = "1510"
    version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"

diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/NotePersistence.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/NotePersistence.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1430"
+   LastUpgradeVersion = "1510"
    version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"

diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/NotesFeature.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/NotesFeature.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1430"
+   LastUpgradeVersion = "1510"
    version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"

diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/PageBookmarkPersistence.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/PageBookmarkPersistence.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1430"
+   LastUpgradeVersion = "1510"
    version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"

diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/Preferences.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/Preferences.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1430"
+   LastUpgradeVersion = "1510"
    version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"

diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/QuranAudioKit.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/QuranAudioKit.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1430"
+   LastUpgradeVersion = "1510"
    version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"

diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/QuranEngine-Package.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/QuranEngine-Package.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1430"
+   LastUpgradeVersion = "1510"
    version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"

diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/QuranKit.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/QuranKit.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1430"
+   LastUpgradeVersion = "1510"
    version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"

diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/QuranPagesFeature.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/QuranPagesFeature.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1430"
+   LastUpgradeVersion = "1510"
    version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"

diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/QuranTextKit.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/QuranTextKit.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1430"
+   LastUpgradeVersion = "1510"
    version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"

diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/QuranTextKitTests.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/QuranTextKitTests.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1430"
+   LastUpgradeVersion = "1510"
    version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"

diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/QuranTranslationFeature.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/QuranTranslationFeature.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1430"
+   LastUpgradeVersion = "1510"
    version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"

diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/ReadingSelectorFeature.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/ReadingSelectorFeature.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1430"
+   LastUpgradeVersion = "1510"
    version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"

diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/ReadingService.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/ReadingService.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1430"
+   LastUpgradeVersion = "1510"
    version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"

diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/ReciterListFeature.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/ReciterListFeature.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1430"
+   LastUpgradeVersion = "1510"
    version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"

diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/SearchFeature.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/SearchFeature.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1430"
+   LastUpgradeVersion = "1510"
    version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"

diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/SettingsFeature.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/SettingsFeature.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1430"
+   LastUpgradeVersion = "1510"
    version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"

diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/SystemDependencies.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/SystemDependencies.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1430"
+   LastUpgradeVersion = "1510"
    version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"

diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/SystemDependenciesFake.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/SystemDependenciesFake.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1430"
+   LastUpgradeVersion = "1510"
    version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"

diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/Timing.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/Timing.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1430"
+   LastUpgradeVersion = "1510"
    version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"

diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/TranslationService.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/TranslationService.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1430"
+   LastUpgradeVersion = "1510"
    version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"

diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/TranslationsFeature.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/TranslationsFeature.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1430"
+   LastUpgradeVersion = "1510"
    version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"

diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/UIx.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/UIx.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1430"
+   LastUpgradeVersion = "1510"
    version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"

diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/Utilities.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/Utilities.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1430"
+   LastUpgradeVersion = "1510"
    version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"

diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/UtilitiesTests.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/UtilitiesTests.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1430"
+   LastUpgradeVersion = "1510"
    version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"

diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/VLogging.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/VLogging.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1430"
+   LastUpgradeVersion = "1510"
    version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"

diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/VersionUpdater.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/VersionUpdater.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1430"
+   LastUpgradeVersion = "1510"
    version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"

diff --git a/Core/Localization/Resources/en.lproj/Localizable.strings b/Core/Localization/Resources/en.lproj/Localizable.strings
@@ -30,6 +30,9 @@
 "translation.translator" = "Translator: ";
 "translation.text.see-referenced-verse" = "See ayah %d.";
 "translation.text.read-more" = "Read more";
+"translation.text.ayah-number" = "%d:%d";
+"translation.text.footnote-number" = "[%d]";
+"translation.text.footnote-title" = "Footnote #%d";
 "error.translation.text-retrieval" = "Oops! Something went wrong. We couldn't retrieve the translation.";
 "error.translation.text-not-available" = "No translation available for this Ayah.";
 

diff --git a/Core/Utilities/Sources/Extensions/String+Chunking.swift b/Core/Utilities/Sources/Extensions/String+Chunking.swift
@@ -13,8 +13,12 @@ extension String {
     }
 
     public func chunkRanges(maxChunkSize: Int) -> [Range<String.Index>] {
+        chunkRanges(range: startIndex ..< endIndex, maxChunkSize: maxChunkSize)
+    }
+
+    public func chunkRanges(range: Range<String.Index>, maxChunkSize: Int) -> [Range<String.Index>] {
         var chunks: [Range<String.Index>] = []
-        chunkText(self, range: startIndex ..< endIndex, maxChunkSize: maxChunkSize, strategy: .paragraph, chunks: &chunks)
+        chunkText(self, range: range, maxChunkSize: maxChunkSize, strategy: .paragraph, chunks: &chunks)
         return chunks
     }
 }

diff --git a/Core/Utilities/Sources/Features/Pair.swift b/Core/Utilities/Sources/Features/Pair.swift
@@ -0,0 +1,21 @@
+//
+//  Pair.swift
+//
+//
+//  Created by Mohamed Afifi on 2024-02-02.
+//
+
+import Foundation
+
+public struct Pair<First, Second> {
+    public var first: First
+    public var second: Second
+
+    public init(_ first: First, _ second: Second) {
+        self.first = first
+        self.second = second
+    }
+}
+
+extension Pair: Equatable where First: Equatable, Second: Equatable { }
+extension Pair: Hashable where First: Hashable, Second: Hashable { }
diff --git a/Core/VLogging/Logger.swift b/Core/VLogging/Logger.swift
@@ -7,4 +7,4 @@
 
 import Logging
 
-public let logger = Logger(label: "default")
+public let logger = Logger(label: "quran-ios")
diff --git a/Domain/AnnotationsService/Sources/NoteService.swift b/Domain/AnnotationsService/Sources/NoteService.swift
@@ -14,6 +14,7 @@ import NotePersistence
 import Preferences
 import QuranAnnotations
 import QuranKit
+import QuranText
 import QuranTextKit
 
 public struct NoteService {
@@ -89,7 +90,7 @@ public struct NoteService {
     private var lastUsedHighlightColor: Note.Color
 
     private func textDictionaryForVerses(_ verses: [AyahNumber]) async throws -> [AyahNumber: String] {
-        let translatedVerses = try await textService.textForVerses(verses, translations: [])
+        let translatedVerses: TranslatedVerses = try await textService.textForVerses(verses, translations: [])
         return Dictionary(zip(verses, translatedVerses.verses).map { ($0, $1.arabicText) }, uniquingKeysWith: { x, _ in x })
     }
 }