Expose StringCatalog target as a library (#48)

* Make StringCatalog initializers public * Expose StringCatalog as a linkable library * Add StringCatalog test * Ensure parser can be used externally * Address PR comments * Update tests.yml
liamnichols · Apr 3, 2024 · ddbda75 · ddbda75
1 parent 05bb5f4
commit ddbda75
Show file tree

Hide file tree

Showing 11 changed files with 188 additions and 2 deletions.
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -38,4 +38,4 @@ jobs:
     - name: Checkout Repo
       uses: actions/checkout@v3
     - name: Run Tests
-      run: xcodebuild clean test -scheme XCStringsTool -destination platform=macOS
+      run: xcodebuild clean test -scheme XCStringsTool-Package -destination platform=macOS
diff --git a/Package.swift b/Package.swift
@@ -16,7 +16,8 @@ let package = Package(
     ],
     products: [
         .executable(name: "xcstrings-tool", targets: ["xcstrings-tool"]),
-        .plugin(name: "XCStringsToolPlugin", targets: ["XCStringsToolPlugin"])
+        .plugin(name: "XCStringsToolPlugin", targets: ["XCStringsToolPlugin"]),
+        .library(name: "StringCatalog", targets: ["StringCatalog"])
     ],
     dependencies: [
         .package(url: "https://github.com/apple/swift-argument-parser.git", from: "1.2.3"),
@@ -110,6 +111,16 @@ let package = Package(
             swiftSettings: [
                 .define("XCSTRINGS_TOOL_ACCESS_LEVEL_PUBLIC")
             ]
+        ),
+
+        .testTarget(
+            name: "StringCatalogTests",
+            dependencies: [
+                .target(name: "StringCatalog")
+            ],
+            resources: [
+                .copy("__Fixtures__")
+            ]
         )
     ]
 )

diff --git a/Sources/StringCatalog/StringCatalog.swift b/Sources/StringCatalog/StringCatalog.swift
@@ -4,6 +4,12 @@ public struct StringCatalog: Codable {
     public var sourceLanguage: StringLanguage
     public var strings: [String: StringEntry]
     public var version: String // TODO: Use a Version type?
+
+    public init(sourceLanguage: StringLanguage, strings: [String : StringEntry], version: String) {
+        self.sourceLanguage = sourceLanguage
+        self.strings = strings
+        self.version = version
+    }
 }
 
 // MARK: - Init

diff --git a/Sources/StringCatalog/Types/StringEntry.swift b/Sources/StringCatalog/Types/StringEntry.swift
@@ -6,4 +6,10 @@ public struct StringEntry: Codable {
     public var comment: String?
     public var extractionState: StringExtractionState?
     public var localizations: Localizations?
+
+    public init(comment: String? = nil, extractionState: StringExtractionState? = nil, localizations: Localizations? = nil) {
+        self.comment = comment
+        self.extractionState = extractionState
+        self.localizations = localizations
+    }
 }
diff --git a/Sources/StringCatalog/Types/StringLocalization.swift b/Sources/StringCatalog/Types/StringLocalization.swift
@@ -4,4 +4,10 @@ public struct StringLocalization: Codable {
     public var stringUnit: StringUnit?
     public var substitutions: [String: StringSubstitution]?
     public var variations: StringVariations?
+
+    public init(stringUnit: StringUnit? = nil, substitutions: [String : StringSubstitution]? = nil, variations: StringVariations? = nil) {
+        self.stringUnit = stringUnit
+        self.substitutions = substitutions
+        self.variations = variations
+    }
 }
diff --git a/Sources/StringCatalog/Types/StringSubstitution.swift b/Sources/StringCatalog/Types/StringSubstitution.swift
@@ -4,4 +4,10 @@ public struct StringSubstitution: Codable {
     public let argNum: Int
     public let formatSpecifier: String
     public let variations: StringVariations?
+
+    public init(argNum: Int, formatSpecifier: String, variations: StringVariations?) {
+        self.argNum = argNum
+        self.formatSpecifier = formatSpecifier
+        self.variations = variations
+    }
 }
diff --git a/Sources/StringCatalog/Types/StringUnit.swift b/Sources/StringCatalog/Types/StringUnit.swift
@@ -3,4 +3,9 @@ import Foundation
 public struct StringUnit: Codable {
     public var state: StringUnitState
     public var value: String
+
+    public init(state: StringUnitState, value: String) {
+        self.state = state
+        self.value = value
+    }
 }
diff --git a/Sources/StringCatalog/Types/StringVariation.swift b/Sources/StringCatalog/Types/StringVariation.swift
@@ -2,4 +2,8 @@ import Foundation
 
 public struct StringVariation: Codable {
     public var stringUnit: StringUnit
+
+    public init(stringUnit: StringUnit) {
+        self.stringUnit = stringUnit
+    }
 }
diff --git a/Sources/StringCatalog/Types/StringVariations.swift b/Sources/StringCatalog/Types/StringVariations.swift
@@ -3,6 +3,11 @@ import Foundation
 public struct StringVariations: Codable {
     public let device: DictionaryWrapper<DeviceKey, StringVariation>?
     public let plural: DictionaryWrapper<PluralKey, StringVariation>?
+
+    public init(device: DictionaryWrapper<DeviceKey, StringVariation>?, plural: DictionaryWrapper<PluralKey, StringVariation>?) {
+        self.device = device
+        self.plural = plural
+    }
 }
 
 extension StringVariations {

diff --git a/Tests/StringCatalogTests/StringCatalogTests.swift b/Tests/StringCatalogTests/StringCatalogTests.swift
@@ -0,0 +1,27 @@
+import Foundation
+import XCTest
+import StringCatalog
+
+class StringCatalogTests: XCTestCase {
+    func testCreateCatalog() {
+        let stringUnit = StringUnit(state: .translated, value: "Example value")
+        let variations = StringVariations(device: [.iPad: StringVariation(stringUnit: stringUnit)], plural: [:])
+        let substitutions = ["substitution": StringSubstitution(argNum: 0, formatSpecifier: "%lld", variations: variations)]
+        let localization = StringLocalization(stringUnit: stringUnit, substitutions: substitutions, variations: variations)
+        let entry = StringEntry(comment: "A comment", extractionState: "manual", localizations: [ "en": localization ])
+        _ = StringCatalog(sourceLanguage: "en", strings: ["ExampleKey": entry], version: "1.0")
+    }
+
+    func testParseCatalog() throws {
+        let fixtureUrl = try fixture(named: "Localizable")
+        let catalog = try StringCatalog(contentsOf: fixtureUrl)
+        print(String(describing: catalog))
+    }
+
+    func fixture(named name: String) throws -> URL {
+        let bundle = Bundle.module
+        return try XCTUnwrap(
+            bundle.url(forResource: name, withExtension: "xcstrings", subdirectory: "__Fixtures__")
+        )
+    }
+}
diff --git a/Tests/StringCatalogTests/__Fixtures__/Localizable.xcstrings b/Tests/StringCatalogTests/__Fixtures__/Localizable.xcstrings
@@ -0,0 +1,110 @@
+{
+  "sourceLanguage" : "en",
+  "strings" : {
+    "Empty" : {
+      "extractionState" : "manual"
+    },
+    "Empty.Comment" : {
+      "comment" : "Value is empty but there is a comment",
+      "extractionState" : "manual"
+    },
+    "Key" : {
+      "comment" : "This is a comment",
+      "extractionState" : "manual",
+      "localizations" : {
+        "en" : {
+          "stringUnit" : {
+            "state" : "translated",
+            "value" : "Default Value"
+          }
+        }
+      }
+    },
+    "myDeviceVariant" : {
+      "extractionState" : "manual",
+      "localizations" : {
+        "en" : {
+          "variations" : {
+            "device" : {
+              "ipad" : {
+                "stringUnit" : {
+                  "state" : "needs_review",
+                  "value" : "macOS Original"
+                }
+              },
+              "mac" : {
+                "stringUnit" : {
+                  "state" : "translated",
+                  "value" : "macOS Original"
+                }
+              },
+              "other" : {
+                "stringUnit" : {
+                  "state" : "translated",
+                  "value" : "Multiplatform Original"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "myPlural" : {
+      "extractionState" : "manual",
+      "localizations" : {
+        "en" : {
+          "variations" : {
+            "plural" : {
+              "one" : {
+                "stringUnit" : {
+                  "state" : "translated",
+                  "value" : "I have %lld plural"
+                }
+              },
+              "other" : {
+                "stringUnit" : {
+                  "state" : "translated",
+                  "value" : "I have %lld plurals"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "mySubstitute" : {
+      "extractionState" : "manual",
+      "localizations" : {
+        "en" : {
+          "stringUnit" : {
+            "state" : "translated",
+            "value" : "%lld: People liked %#@count@ posts"
+          },
+          "substitutions" : {
+            "count" : {
+              "argNum" : 2,
+              "formatSpecifier" : "lld",
+              "variations" : {
+                "plural" : {
+                  "one" : {
+                    "stringUnit" : {
+                      "state" : "translated",
+                      "value" : "%arg"
+                    }
+                  },
+                  "other" : {
+                    "stringUnit" : {
+                      "state" : "needs_review",
+                      "value" : "%arg"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "version" : "1.0"
+}