Merge branch 'main' into conjugation-declension

Author: catreedle

.pre-commit-config.yaml

@@ -20,10 +20,9 @@ repos:
       - id: trailing-whitespace
       - id: end-of-file-fixer
       - id: check-yaml
-      # - id: check-added-large-files
 
   - repo: https://github.com/realm/SwiftLint
-    rev: 0.62.2
+    rev: 0.63.1
     hooks:
       - id: swiftlint
         name: run swiftlint linting check

CONTRIBUTING.md

@@ -16,6 +16,7 @@ If you have questions or would like to communicate with the team, please [join u
 - [Learning the tech stack](#learning-the-tech)
 - [Development environment](#dev-env)
   - [Note on debugging](#note-on-debugging)
+- [Build Schemes Selection](#build-scheme)
 - [Testing](#testing)
 - [Issues and projects](#issues-projects)
 - [Bug reports](#bug-reports)
@@ -126,16 +127,19 @@ pre-commit install
 
 4. Open the Scribe-iOS directory in Xcode
 
-5. In order to run Scribe on an emulator:
+5. The application has 2 build schemes, Conjugate and Scribe for the verb conjugation and the language keyboards applications
+   - There are other build schemes for individual keyboard which don't need to be selected unless you're trying to debug a keyboard
+   - More about this could be read in the [Build Schemes Selection](#build-scheme) section
 
+6. In order to run Scribe on an emulator:
    - Read the [documentation from Apple](https://developer.apple.com/documentation/xcode/running-your-app-in-the-simulator-or-on-a-device) if need be
    - In the top bar select Scribe as the scheme
    - If you're debugging you'll need to select the keyboard you're testing as the scheme (see the [note on debugging](#note-on-debugging) below)
    - Select a device to run the app on
    - Press the run button marked `Start the active scheme`
    - From here code edits that are made will be reflected in the app each time the active scheme is restarted
 
-6. Build the developer documentation by selecting `Product` > `Build Documentation` (^⇧⌘D)
+7. Build the developer documentation by selecting `Product` > `Build Documentation` (^⇧⌘D)
 
 > [!NOTE]
 > Feel free to contact the team in the [iOS room on Matrix](https://matrix.to/#/#ScribeiOS:matrix.org) if you're having problems getting your environment setup!
@@ -152,6 +156,17 @@ The Xcode debugger often doesn't work as expected for Scribe as the keyboards th
 - When you get a window telling you to "choose an app to run", don't choose Scribe as you might expect, but instead scroll down and select Xcode Previews
 - Occasionally you'll be met with just a black screen on startup, in which case you can press Home (or ⇧-⌘-H) and then go directly to Scribe or an app for keyboard testing
 
+<a id="build-scheme"></a>
+
+## Build Schemes Selection [`⇧`](#contents)
+
+The project includes two build schemes, each corresponding to a different application.There are other targets corresponding to the individual keyboards which are shipped within the `Scribe` target.
+
+Build schemes can be selected from the top bar next to device selection.
+
+1. Scribe → Scribe Language Keyboards app (IME)
+2. Conjugate → Scribe Conjugate verb conjugation app
+
 <a id="testing"></a>
 
 ## Testing [`⇧`](#contents)

Keyboards/DataManager/ContractManager.swift

@@ -1,9 +1,9 @@
 // SPDX-License-Identifier: GPL-3.0-or-later
 import Foundation
 
-/** ContractManager is responsible for loading and caching DataContract instances
- based on language codes.
-*/
+/**
+ * ContractManager is responsible for loading and caching DataContract instances based on language codes.
+ */
 class ContractManager {
     static let shared = ContractManager()
     private var contractCache: [String: DataContract] = [:]
@@ -18,7 +18,7 @@ class ContractManager {
             return cached
         }
 
-        // Load JSON file (e.g., "de.json", "en.json", "es.json")
+        // Load JSON file (e.g., "de.json", "en.json", "es.json").
         guard let jsonResourcePath = Bundle.main.path(
             forResource: languageCode,
             ofType: "json"

Keyboards/DataManager/DataContract.swift

@@ -1,8 +1,9 @@
 // SPDX-License-Identifier: GPL-3.0-or-later
 import Foundation
 
-/** DataContract represents the structure of the data used in the application.
-*/
+/**
+ * DataContract represents the structure of the data used in the application.
+ */
 struct DataContract: Codable {
     let numbers: [String: String]?
     let genders: GenderContract?

Keyboards/DataManager/GenderManager.swift

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: GPL-3.0-or-later
 import Foundation
 
-/// Manages gender query logic based on data contracts
+/// Manages gender query logic based on data contracts.
 class GenderManager {
   static let shared = GenderManager()
 
@@ -14,11 +14,12 @@ class GenderManager {
     let fallbackGender: String?
   }
 
-  /**Builds the appropriate gender queries based on the contract structure
-    - Parameters:
-        - word: The word to query
-        - contract: The data contract defining gender structure
-    - Returns: Array of query info objects to execute
+  /**
+   * Builds the appropriate gender queries based on the contract structure
+   * - Parameters:
+   *   - word: The word to query
+   *   - contract: The data contract defining gender structure
+   * - Returns: Array of query info objects to execute
   */
   func buildGenderQueries(word: String, contract: DataContract) -> [GenderQueryInfo] {
 
@@ -35,21 +36,21 @@ class GenderManager {
     return []
   }
 
-  // MARK: - Private Helper Methods
+  // MARK: Private Helper Methods
 
-  /// Checks if the data contract defines a single, canonical gender column
+  /// Checks if the data contract defines a single, canonical gender column.
   private func hasCanonicalGender(_ contract: DataContract) -> Bool {
     return contract.genders?.canonical?.first?.isEmpty == false
   }
 
-  /// Checks if the data contract defines separate columns for masculine and feminine genders
+  /// Checks if the data contract defines separate columns for masculine and feminine genders.
   private func hasMasculineFeminine(_ contract: DataContract) -> Bool {
     let hasMasculine = !(contract.genders?.masculines?.isEmpty ?? true)
     let hasFeminine = !(contract.genders?.feminines?.isEmpty ?? true)
     return hasMasculine && hasFeminine
   }
 
-  /// Builds query for canonical gender structure
+  /// Builds query for canonical gender structure.
   private func buildCanonicalQuery(word: String, contract: DataContract) -> GenderQueryInfo? {
     guard let nounCol = contract.numbers?.keys.first,
           let genderCol = contract.genders?.canonical?.first else {
@@ -70,11 +71,11 @@ class GenderManager {
     )
   }
 
-  /// Builds queries for masculine/feminine gender structure
+  /// Builds queries for masculine/feminine gender structure.
   private func buildMasculineFeminineQueries(word: String, contract: DataContract) -> [GenderQueryInfo] {
     var queries: [GenderQueryInfo] = []
 
-    // Masculine column query
+    // Masculine column query.
     if let masculineCol = contract.genders?.masculines?.first {
       let query = """
                 SELECT `\(masculineCol)` FROM nouns
@@ -88,7 +89,7 @@ class GenderManager {
       ))
     }
 
-    // Feminine column query
+    // Feminine column query.
     if let feminineCol = contract.genders?.feminines?.first {
       let query = """
                 SELECT `\(feminineCol)` FROM nouns

Keyboards/DataManager/LanguageDBManager.swift

@@ -291,15 +291,15 @@ extension LanguageDBManager {
         args: StatementArguments(queryInfo.args)
       )
 
-      // For canonical gender: results are the actual genders
+      // For canonical gender: results are the actual genders.
       if queryInfo.fallbackGender == nil {
         for gender in results where !gender.isEmpty {
           if !allGenders.contains(gender) {
             allGenders.append(gender)
           }
         }
       }
-      // For masculine/feminine: if any result, use fallback
+      // For masculine/feminine: if any result, use fallback.
       else {
         if !results.isEmpty && !results[0].isEmpty,
            let fallback = queryInfo.fallbackGender,
@@ -359,7 +359,7 @@ extension LanguageDBManager {
 
   /// Query preposition form of word in `prepositions`.
   func queryPrepForm(of word: String) -> [String] {
-    // Check if this language's database has grammaticalCase column
+    // Check if this language's database has grammaticalCase column.
     guard hasGrammaticalCaseColumn() else {
       return [""]
     }
@@ -440,11 +440,8 @@ extension LanguageDBManager {
   /// Query specific form of word in `verbs`.
   ///
   /// - Parameters:
-  ///   - word: The value to search for
-  ///   - identifierColumn: The column to search in (default: "infinitive" or "verb" for Swedish)
   ///   - outputCols: Specific form want to output
-  func queryVerb(of word: String, identifierColumn: String? = nil, with outputCols: [String]) -> [String] {
-    let columnName = identifierColumn ?? ((controllerLanguage == "Swedish") ? "verb" : "infinitive")
+  func queryVerb(of word: String, with outputCols: [String]) -> [String] {
     let query = """
     SELECT
       *

Keyboards/DataManager/PluralManager.swift

@@ -13,11 +13,12 @@ class PluralManager {
     let args: [String]
   }
 
-  /**Builds a query to find the plural form of a word based on the contract structure
-   - Parameters:
-   - word: The singular word to find the plural for
-   - contract: The data contract defining the database structure
-   - Returns: Query info to execute, or nil if contract is invalid
+  /**
+   * Builds a query to find the plural form of a word based on the contract structure
+   * - Parameters:
+   * - word: The singular word to find the plural for
+   * - contract: The data contract defining the database structure
+   * - Returns: Query info to execute, or nil if contract is invalid
    */
   func buildPluralQuery(word: String, contract: DataContract?) -> [PluralQueryInfo] {  // ← Return array!
     guard let contract = contract,
@@ -29,7 +30,7 @@ class PluralManager {
 
     var queries: [PluralQueryInfo] = []
 
-    // Build a query for EACH singular/plural pair
+    // Build a query for EACH singular/plural pair.
     for (singularCol, pluralCol) in numbers {
       let query = """
             SELECT `\(singularCol)`, `\(pluralCol)`
@@ -47,9 +48,10 @@ class PluralManager {
     return queries
   }
 
-  /**Builds a query to get all plural forms for a language
-   - Parameter contract: The data contract defining plural columns
-   - Returns: Query info to execute, or nil if contract is invalid
+  /**
+   * Builds a query to get all plural forms for a language
+   * - Parameter contract: The data contract defining plural columns.
+   * - Returns: Query info to execute, or nil if contract is invalid.
    */
   func buildAllPluralsQuery(contract: DataContract?) -> PluralQueryInfo? {
     guard let contract = contract,

Keyboards/KeyboardsBase/KeyboardViewController.swift

@@ -1471,7 +1471,7 @@ class KeyboardViewController: UIInputViewController {
       // Drop non-unique values in case the lexicon has added words that were already present.
       LanguageDBManager.shared.deleteNonUniqueAutocompletions()
 
-      // Load plural words for the current language
+      // Load plural words for the current language.
       if let allPlurals = LanguageDBManager.shared.queryAllPluralForms() {
         pluralWords = Set(allPlurals.map { $0.lowercased() })
       }

Keyboards/KeyboardsBase/ScribeFunctionality/Annotate.swift

@@ -32,7 +32,7 @@ let prepAnnotationConversionDict = [
   "Russian": ["Acc": "Вин", "Dat": "Дат", "Gen": "Род", "Loc": "Мес", "Pre": "Пре", "Ins": "Инс"]
 ]
 
-// Converts full gender names to abbreviations (e.g., "feminine" → "F")
+// Converts full gender names to abbreviations (e.g., "feminine" → "F").
 func convertFullGenderToAbbr(_ genderFull: String) -> String {
   let genderMap: [String: String] = [
     "feminine": "F",
@@ -46,7 +46,7 @@ func convertFullGenderToAbbr(_ genderFull: String) -> String {
   return genderMap[genderFull.lowercased()] ?? genderFull
 }
 
-// Converts full preposition to abbreviations
+// Converts full preposition to abbreviations.
 func convertFullPrepositionToAbbr(_ prepositionFull: String) -> String {
   let prepositionMap: [String: String] = [
     "genitive case": "Gen",
@@ -72,7 +72,7 @@ func wordAnnotation(wordToAnnotate: String, KVC: KeyboardViewController) {
   // Get gender(s)
   let nounForm = LanguageDBManager.shared.queryNounForm(of: wordToAnnotate)[0]
   if !nounForm.isEmpty {
-    // nounForm might already be "M/F" if multiple genders found
+    // nounForm might already be "M/F" if multiple genders found.
     genderAnnotations = nounForm.components(separatedBy: "/")
   }
 
@@ -81,13 +81,13 @@ func wordAnnotation(wordToAnnotate: String, KVC: KeyboardViewController) {
     pluralAnnotation = "PL"
   }
 
-  // Combine: gender(s) first, then PL if applicable
+  // Combine: gender(s) first, then PL if applicable.
   var allAnnotations = genderAnnotations
   if let pl = pluralAnnotation, !allAnnotations.contains("PL") {
     allAnnotations.append(pl)
   }
 
-  // Join back with "/"
+  // Join back with "/".
   let combinedNounForm = allAnnotations.joined(separator: "/")
 
   prepAnnotationForm = LanguageDBManager.shared.queryPrepForm(of: wordToAnnotate.lowercased())[0]
@@ -171,7 +171,7 @@ func wordAnnotation(wordToAnnotate: String, KVC: KeyboardViewController) {
 
         if ["feminine", "masculine", "neuter", "common"].contains(annotationToDisplay.lowercased()) {
           annotationToDisplay = convertFullGenderToAbbr(annotationToDisplay)
-          annotationsToAssign[i] = annotationToDisplay  // Update the array too
+          annotationsToAssign[i] = annotationToDisplay  // update the array too
         }
 
         if nounFormToColorDict.keys.contains(annotationToDisplay) {

README.md

@@ -38,6 +38,7 @@ Check out Scribe's [architecture diagrams](https://github.com/scribe-org/Organiz
 - [Contributing](#contributing)
 - [Environment Setup](#environment-setup)
 - [App Setup](#app-setup)
+  - [Codebase Overview](#codebase-overview)
 - [Supported Languages](#supported-languages)
 - [Keyboard Features](#keyboard-features)
 - [Featured By](#featured-by)
@@ -177,7 +178,6 @@ pre-commit install
 4. Open the Scribe-iOS directory in Xcode
 
 5. In order to run Scribe on an emulator:
-
    - Read the [documentation from Apple](https://developer.apple.com/documentation/xcode/running-your-app-in-simulator-or-on-a-device) if need be
    - In the top bar select Scribe as the scheme
    - If you're debugging you'll need to select the keyboard you're testing as the scheme (see the [note on debugging](#note-on-debugging) below)
@@ -198,6 +198,21 @@ pre-commit install
 
 # App Setup [`⇧`](#contents)
 
+<a id="codebase-overview"></a>
+
+### Codebase Overview
+
+The Scribe-iOS codebase consists of two separate applications.
+
+- Keyboard Application — the Scribe Language Keyboards application (IME)
+
+- Conjugate Application — the Scribe verb conjugations application
+
+To select each variant you should select the scheme from the top bar next to device selection.
+
+1. Scribe → Scribe Language Keyboards app (IME)
+2. Conjugate → Scribe Conjugate verb conjugation app
+
 Users access Scribe language keyboards through the following:
 
 - Download **Scribe - Language Keyboards** from the [App Store](https://apps.apple.com/app/scribe-language-keyboards/id1596613886)