Repository Public License
1// ORIX Alarm2// File: Packages/AlarmCore/Tests/AlarmCoreTests/WordScrambleEngineTests.swift3// Description: Word Scramble engine tests: bundled list hygiene, determinism, scrambles, anagram acceptance and accent-exact validation.4//5// Author: Simon-Pierre Boucher6// Contact: contact@spboucher.ai7import XCTest8@testable import AlarmCore910final class WordScrambleEngineTests: XCTestCase {11 // MARK: Lists1213 func testListsAreCleanAndLargeEnough() {14 for language in WordLanguage.allCases {15 var seenInLanguage = Set<String>()16 for tier in WordScrambleEngine.tiers {17 let words = WordScrambleEngine.words(language: language, tier: tier)18 let name = WordScrambleEngine.resourceName(language: language, tier: tier)19 XCTAssertGreaterThanOrEqual(words.count, 120, name)20 XCTAssertEqual(Set(words).count, words.count, "\(name) has duplicates")21 let bounds = WordScrambleEngine.lengthBounds(tier: tier)22 for word in words {23 XCTAssertTrue(bounds.contains(word.count), "\(name): \(word) has \(word.count) letters")24 XCTAssertTrue(word.allSatisfy { $0.isLetter && $0.isLowercase }, "\(name): \(word) must be lowercase letters only")25 XCTAssertTrue(word.allSatisfy { $0.unicodeScalars.count == 1 }, "\(name): \(word) must be precomposed")26 XCTAssertEqual(word, WordScrambleEngine.normalize(word), "\(name): \(word)")27 XCTAssertGreaterThan(Set(word).count, 2, "\(name): \(word) cannot be scrambled meaningfully")28 XCTAssertTrue(seenInLanguage.insert(word).inserted, "\(word) appears in two \(language.rawValue) tiers")29 if language == .english { XCTAssertTrue(word.allSatisfy(\.isASCII), "\(name): \(word)") }30 }31 }32 for level in 1...4 {33 XCTAssertGreaterThanOrEqual(WordScrambleEngine.candidates(language: language, level: level).count, 40, "\(language.rawValue) level \(level)")34 }35 }36 }3738 func testFileContentsAreStoredNormalised() throws {39 for language in WordLanguage.allCases {40 for tier in WordScrambleEngine.tiers {41 let name = WordScrambleEngine.resourceName(language: language, tier: tier)42 let url = try XCTUnwrap(Bundle.module.url(forResource: name, withExtension: "txt"), name)43 let text = try String(contentsOf: url, encoding: .utf8)44 XCTAssertEqual(text.unicodeScalars.elementsEqual(text.precomposedStringWithCanonicalMapping.unicodeScalars), true, "\(name) is not NFC")45 XCTAssertEqual(text, text.lowercased(), name)46 }47 }48 }4950 func testTiersAndLevels() {51 XCTAssertEqual((1...4).map { WordScrambleEngine.tier(level: $0) }, [1, 2, 3, 3])52 let three = WordScrambleEngine.candidates(language: .french, level: 3), four = WordScrambleEngine.candidates(language: .french, level: 4)53 XCTAssertGreaterThan(four.map(\.count).min()!, three.map(\.count).max()!, "level 4 uses longer words")54 XCTAssertTrue(Set(three).isDisjoint(with: four))55 XCTAssertTrue(WordScrambleEngine.words(language: .french, tier: 1).contains { $0.contains("é") })56 XCTAssertTrue(WordScrambleEngine.words(language: .french, tier: 1).contains("cœur"))57 }5859 // MARK: Puzzles6061 func testDeterministic() {62 for language in WordLanguage.allCases {63 for level in 1...4 {64 for round in 0..<10 {65 XCTAssertEqual(WordScrambleEngine.generate(level: level, round: round, seed: 11, language: language),66 WordScrambleEngine.generate(level: level, round: round, seed: 11, language: language))67 }68 }69 }70 XCTAssertEqual(WordScrambleEngine.generate(level: 2, round: 1, seed: 4), WordScrambleEngine.generate(level: 2, round: 1, seed: 4, language: .english))71 XCTAssertNotEqual((0..<8).map { WordScrambleEngine.generate(level: 2, round: $0, seed: 1).word },72 (0..<8).map { WordScrambleEngine.generate(level: 2, round: $0, seed: 2).word })73 }7475 func testValidityOverManyPuzzles() {76 for language in WordLanguage.allCases {77 for level in 1...4 {78 let list = Set(WordScrambleEngine.words(language: language, tier: WordScrambleEngine.tier(level: level)))79 for i in 0..<2_500 {80 let puzzle = WordScrambleEngine.generate(level: level, round: i % 10, seed: UInt64(i) &* 49_979_687, language: language)81 XCTAssertEqual(puzzle.language, language)82 XCTAssertTrue(list.contains(puzzle.word))83 XCTAssertTrue(WordScrambleEngine.lengthBounds(level: level).contains(puzzle.word.count), puzzle.word)84 XCTAssertEqual(puzzle.scrambled.sorted(), Array(puzzle.word).sorted(), "the scramble uses exactly the word's letters")85 XCTAssertNotEqual(String(puzzle.scrambled), puzzle.word)86 XCTAssertFalse(puzzle.accepted.contains(String(puzzle.scrambled)), "the scramble must not already be an answer")87 XCTAssertTrue(puzzle.accepted.contains(puzzle.word))88 XCTAssertTrue(puzzle.accepted.allSatisfy { list.contains($0) && $0.sorted() == puzzle.word.sorted() })89 XCTAssertTrue(WordScrambleEngine.validate(puzzle, answer: puzzle.word))90 XCTAssertTrue(WordScrambleEngine.validate(puzzle, answer: puzzle.word.uppercased()))91 XCTAssertFalse(WordScrambleEngine.validate(puzzle, answer: String(puzzle.scrambled)))92 XCTAssertFalse(WordScrambleEngine.validate(puzzle, answer: String(puzzle.word.dropLast())))93 XCTAssertFalse(WordScrambleEngine.validate(puzzle, answer: ""))94 }95 }96 }97 }9899 func testRoundsOfOneMissionUseDifferentWords() {100 for language in WordLanguage.allCases {101 for level in 1...4 {102 for seed in 0..<100 as Range<UInt64> {103 let words = (0..<10).map { WordScrambleEngine.generate(level: level, round: $0, seed: seed, language: language).word }104 XCTAssertEqual(Set(words).count, 10)105 }106 }107 }108 }109110 func testAnagramsFromTheSameListAreAccepted() throws {111 // "earth" and "heart" are both in the first English tier; "chien" and "niche" in the first French tier.112 for (language, a, b) in [(WordLanguage.english, "earth", "heart"), (.french, "chien", "niche")] {113 var found = false114 for seed in 0..<400 as Range<UInt64> where !found {115 for round in 0..<10 {116 let puzzle = WordScrambleEngine.generate(level: 1, round: round, seed: seed, language: language)117 guard puzzle.word == a || puzzle.word == b else { continue }118 found = true119 XCTAssertEqual(Set(puzzle.accepted), [a, b])120 XCTAssertTrue(WordScrambleEngine.validate(puzzle, answer: a))121 XCTAssertTrue(WordScrambleEngine.validate(puzzle, answer: b))122 XCTAssertFalse([a, b].contains(String(puzzle.scrambled)))123 }124 }125 XCTAssertTrue(found, "no puzzle drew \(a)/\(b)")126 }127 }128129 func testComparisonIsAccentExactAndCaseInsensitive() {130 let puzzle = WordScrambleEngine.Puzzle(language: .french, word: "école", scrambled: Array("léoce"), accepted: ["école"])131 XCTAssertTrue(WordScrambleEngine.validate(puzzle, answer: "école"))132 XCTAssertTrue(WordScrambleEngine.validate(puzzle, answer: "ÉCOLE"))133 XCTAssertTrue(WordScrambleEngine.validate(puzzle, answer: "e\u{301}cole"), "decomposed input is normalised to NFC")134 XCTAssertTrue(WordScrambleEngine.validate(puzzle, answer: " École\n"))135 XCTAssertFalse(WordScrambleEngine.validate(puzzle, answer: "ecole"), "a missing accent is a different word")136 XCTAssertFalse(WordScrambleEngine.validate(puzzle, answer: "ècole"))137 let heart = WordScrambleEngine.Puzzle(language: .french, word: "cœur", scrambled: Array("rucœ"), accepted: ["cœur"])138 XCTAssertTrue(WordScrambleEngine.validate(heart, answer: "CŒUR"))139 XCTAssertFalse(WordScrambleEngine.validate(heart, answer: "coeur"))140 }141}142