Merge pull request #4 from john-mueller/updates

Testing and bundling updates

Updates configuration files to use main branch and more recent Swift versions.

Uses resource bundle for testing, and removes unneeded testing code.
Closes #3

Removes uses of #file in default Hyphenator creation.
Closes #2

Fixes out-of-bounds error in setting Hyphenator properties.

Author: john-mueller

.github/workflows/swiftlint.yml

@@ -2,7 +2,7 @@ name: SwiftLint
 on:
   push:
     branches:
-      - master
+      - main
   pull_request:
     paths:
       - '.github/workflows/swiftlint.yml'
@@ -14,6 +14,6 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - name: SwiftLint
-        uses: norio-nomura/action-swiftlint@3.1.0
+        uses: norio-nomura/action-swiftlint@3.2.1
         with:
           args: --strict

.github/workflows/tests.yml

@@ -2,10 +2,10 @@ name: Tests
 on: 
   push:
     branches: 
-      - master
+      - main
   pull_request:
     branches: 
-      - master
+      - main
 jobs:
   macOS:
     name: macOS
@@ -25,16 +25,16 @@ jobs:
       - uses: actions/checkout@v2
       - name: Setup
         run: |
-          export API_URL="https://swiftenv-api.fuller.li/versions?snapshot=false&platform=ubuntu18.04"
+          export API_URL="https://swiftenv-api.fuller.li/versions?snapshot=false&platform=ubuntu20.04"
           export SWIFT_VERSION="$(curl -H 'Accept: text/plain' "$API_URL" | tail -n1)"
 
           git clone --depth 1 https://github.com/kylef/swiftenv.git ~/.swiftenv
           export SWIFTENV_ROOT="$HOME/.swiftenv"
           export PATH="$SWIFTENV_ROOT/bin:$SWIFTENV_ROOT/shims:$PATH"
           swiftenv install -s
 
-          echo "::set-env name=SWIFT_VERSION::$SWIFT_VERSION"
-          echo "::add-path::$SWIFTENV_ROOT/shims"
+          echo "SWIFT_VERSION=$SWIFT_VERSION" >> $GITHUB_ENV
+          echo "$SWIFTENV_ROOT/shims" >> $GITHUB_PATH
       - name: Version
         run: |
           swift --version

.jazzy.yaml

@@ -3,8 +3,8 @@ swift_build_tool: spm
 author: John Mueller
 author_url: https://john-mueller.github.io/
 module: Hyphenation
-module_version: v0.1.0
-copyright: © 2020 John Mueller
+module_version: v0.2.0
+copyright: © 2020-2021 John Mueller
 github_url: https://github.com/john-mueller/Hyphenation/
 min_acl: public
 theme: fullwidth

Makefile

@@ -7,15 +7,15 @@ test: test-correctness test-thread-safety
 bench: test-performance
 
 test-correctness:
-	HYPHENATION_TEST_TYPE=hyphenation swift test -c debug --enable-test-discovery
+	swift test -c debug --filter CorrectnessTests
 
 test-performance:
 	echo "" > benchmark.txt
-	HYPHENATION_TEST_TYPE=performance swift test -c release --enable-test-discovery > >(tee -a benchmark.txt) 2> >(tee -a benchmark.txt >&2)
+	swift test -c release --filter PerformanceTests > >(tee -a benchmark.txt) 2> >(tee -a benchmark.txt >&2)
 	grep -oE 'test.+?average: [0-9]+\.[0-9]+' benchmark.txt | sed -E "s/]?'.+av/ av/g"
 
 test-thread-safety:
-	HYPHENATION_TEST_TYPE=thread-safety swift test -c debug --sanitize=thread --enable-test-discovery
+	swift test -c debug --filter ThreadSafetyTests --sanitize=thread
 
 publish: test
 	rm -rf .docs

Package.swift

@@ -1,4 +1,4 @@
-// swift-tools-version:5.1
+// swift-tools-version:5.4
 
 // Hyphenation
 // © 2020 John Mueller
@@ -15,24 +15,10 @@ let package = Package(
     ],
     targets: [
         .target(name: "Hyphenation"),
-        .testTarget(name: "HyphenationTests", dependencies: ["Hyphenation"]),
-        .testTarget(name: "PerformanceTests", dependencies: ["Hyphenation"]),
-        .testTarget(name: "ThreadSafetyTests", dependencies: ["Hyphenation"]),
+        .testTarget(
+          name: "HyphenationTests",
+          dependencies: ["Hyphenation"],
+          resources: [.process("TextFiles")]
+        )
     ]
 )
-
-import class Foundation.ProcessInfo
-
-// conditional application of test targets based on environment variable
-switch ProcessInfo.processInfo.environment["HYPHENATION_TEST_TYPE"]?.lowercased() {
-case "hyphenation":
-    package.targets.removeAll(where: { $0.type == .test && $0.name != "HyphenationTests" })
-case "performance":
-    package.targets.removeAll(where: { $0.type == .test && $0.name != "HyphenationTests" })
-    package.targets.first(where: { $0.type == .test })?.path = "Tests/PerformanceTests"
-case "thread-safety":
-    package.targets.removeAll(where: { $0.type == .test && $0.name != "HyphenationTests" })
-    package.targets.first(where: { $0.type == .test })?.path = "Tests/ThreadSafetyTests"
-default:
-    break
-}

README.md

@@ -37,7 +37,7 @@ Hyphenation is installed via the [Swift Package Manager](https://swift.org/packa
 let package = Package(
     ...
     dependencies: [
-        .package(url: "https://github.com/john-mueller/Hyphenation.git", from: "0.1.0")
+        .package(url: "https://github.com/john-mueller/Hyphenation.git", from: "0.2.0")
     ],
     ...
 )
@@ -149,9 +149,8 @@ When filing an issue, please do your best to provide reproducable steps and an e
 In the case of a pull request, please take note of the following steps:
 
 1. `swiftlint` should produce no warnings when run in the project directory. This is checked by CI, but I also recommend linting locally if possible (instructions for installation in the [SwiftLint repo](https://github.com/realm/SwiftLint#installation)).
-2. If you have added or renamed test cases, run `make generate-linuxmain` in the project directory. This will ensure all tests are run on both macOS and Linux.
-3. Make sure `make test` results in no errors. This runs the tests in the `HyphenationTests` and `ThreadSafetyTests` targets.
-4. If changing any internal implementations, please run `make bench` both with and without your changes, to check for any speed regressions. This runs the tests in the `PerformanceTests` target.
+2. Make sure `make test` results in no errors. This runs the tests in the `CorrectnessTests` and `ThreadSafetyTests` files.
+3. If changing any internal implementations, please run `make bench` both with and without your changes, to check for any speed regressions. This runs the tests in the `PerformanceTests` file.
 
 ## License
 

Sources/Hyphenation/API/Hyphenator.swift

@@ -57,11 +57,11 @@ public final class Hyphenator {
     // MARK: Properties
 
     /// The minimum character count for a word to be hyphenated.
-    public var minLength = 5 { didSet { clearCache() } }
+    public var minLength: UInt = 5 { didSet { clearCache() } }
     /// The minimum number of characters between the beginning of the word and a hyphenation point.
-    public var minLeading = 2 { didSet { clearCache() } }
+    public var minLeading: UInt = 2 { didSet { clearCache() } }
     /// The minimum number of characters between the end of the word and a hyphenation point.
-    public var minTrailing = 3 { didSet { clearCache() } }
+    public var minTrailing: UInt = 3 { didSet { clearCache() } }
     /// The character to insert at each hyphenation point.
     public var separator: Character = "\u{00AD}" { didSet { clearCache() } }
 
@@ -313,8 +313,8 @@ extension Hyphenator {
     ///   - priorities: The mapping from pattern locations to hyphenation priorities.
     private func separating(_ word: String, using priorities: [Location: Priority]) -> String {
         var hyphenatedWord = word
-        let minIndex = word.index(word.startIndex, offsetBy: minLeading)
-        let maxIndex = word.index(word.endIndex, offsetBy: -minTrailing)
+        let minIndex = word.index(word.startIndex, offsetBy: minLeading.clampedBetween(low: 0, high: word.count))
+        let maxIndex = word.index(word.endIndex, offsetBy: -minTrailing.clampedBetween(low: 0, high: word.count))
 
         for location in priorities.filter({ location, priority in
             if priority.isMultiple(of: 2) { return false }
@@ -329,6 +329,16 @@ extension Hyphenator {
     }
 }
 
+// MARK: Validation Extensions
+
+extension UInt {
+    /// Converts to `Int` safely and clamps result between two values (inclusive).
+    fileprivate func clampedBetween(low: Int, high: Int) -> Int {
+        let thing = (self <= Int.max) ? Int(self) : Int.max
+        return Swift.max(low, Swift.min(high, thing))
+    }
+}
+
 // MARK: Typealiases
 
 extension Hyphenator {

Sources/Hyphenation/API/PatternParsingError.swift

@@ -10,7 +10,7 @@
 public enum PatternParsingError: Error, Equatable {
     /// A pattern string which did not contain at least one letter and one digit from between 1 and 9, inclusive.
     case deficientPattern(String)
-    /// A pattern string which contained a character that was not alphabetic, a digits 1-9, or a period.
+    /// A pattern string which contained a character that was not alphabetic, a digit 1-9, or a period.
     case invalidCharacter(String)
     /// A pattern string which contained multiple consecutive digits.
     case consecutiveDigits(String)

Sources/Hyphenation/Internal/ExceptionDictionary.swift

@@ -134,13 +134,6 @@ extension ExceptionDictionary {
 // MARK: Default exceptions
 
 extension ExceptionDictionary {
-    /// A URL refering to a file containing the default English exceptions.
-    private static let defaultFileURL = URL(fileURLWithPath: #file)
-        .deletingLastPathComponent()
-        .deletingLastPathComponent()
-        .appendingPathComponent("Patterns/hyph-en-us.hyp.txt")
-
     /// An `ExceptionDictionary` containing the default English exceptions.
-    private static var defaultDictionary = try! ExceptionDictionary(fileURL: defaultFileURL)
-    // swiftlint:disable:previous force_try
+    private static var defaultDictionary = ExceptionDictionary(string: .defaultExceptions)
 }

Sources/Hyphenation/Internal/PatternDictionary.swift

@@ -83,14 +83,8 @@ internal final class PatternDictionary: Copyable {
 // MARK: Default patterns
 
 extension PatternDictionary {
-    /// A URL refering to a file containing the default English patterns.
-    private static let defaultFileURL = URL(fileURLWithPath: #file)
-        .deletingLastPathComponent()
-        .deletingLastPathComponent()
-        .appendingPathComponent("Patterns/hyph-en-us.pat.txt")
-
     /// A `PatternDictionary` containing the default English patterns.
-    private static var defaultDictionary = try! PatternDictionary(fileURL: defaultFileURL)
+    private static var defaultDictionary = try! PatternDictionary(string: .defaultPatterns)
     // swiftlint:disable:previous force_try
 
     /// The length of the longest identifier in the default dictionary.