Update from Hummingbird Project Template (#5)

* Update from hummingbird-project-template 572d468b2cabeca286314c5a35196bd42445c8ef

* swift-format

* Remove .swiftformat

---------

Co-authored-by: adam-fowler <adam-fowler@users.noreply.github.com>
Co-authored-by: Adam Fowler <adamfowler71@gmail.com>

Author: hummingbird-automation[bot]

.github/workflows/validate.yml

@@ -8,16 +8,12 @@ concurrency:
 
 jobs:
   validate:
-    runs-on: macOS-latest
+    runs-on: ubuntu-latest
     timeout-minutes: 15
     steps:
     - name: Checkout
       uses: actions/checkout@v4
       with:
         fetch-depth: 1
-    - name: Install Dependencies
-      run: |
-        brew install mint
-        mint install NickLockwood/SwiftFormat@0.53.10 --no-link
     - name: run script
       run: ./scripts/validate.sh

.swift-format

@@ -0,0 +1,63 @@
+{
+  "version" : 1,
+  "indentation" : {
+    "spaces" : 4
+  },
+  "tabWidth" : 4,
+  "fileScopedDeclarationPrivacy" : {
+    "accessLevel" : "private"
+  },
+  "spacesAroundRangeFormationOperators" : false,
+  "indentConditionalCompilationBlocks" : false,
+  "indentSwitchCaseLabels" : false,
+  "lineBreakAroundMultilineExpressionChainComponents" : false,
+  "lineBreakBeforeControlFlowKeywords" : false,
+  "lineBreakBeforeEachArgument" : true,
+  "lineBreakBeforeEachGenericRequirement" : true,
+  "lineLength" : 150,
+  "maximumBlankLines" : 1,
+  "respectsExistingLineBreaks" : true,
+  "prioritizeKeepingFunctionOutputTogether" : true,
+  "multiElementCollectionTrailingCommas" : true,
+  "rules" : {
+    "AllPublicDeclarationsHaveDocumentation" : false,
+    "AlwaysUseLiteralForEmptyCollectionInit" : false,
+    "AlwaysUseLowerCamelCase" : false,
+    "AmbiguousTrailingClosureOverload" : true,
+    "BeginDocumentationCommentWithOneLineSummary" : false,
+    "DoNotUseSemicolons" : true,
+    "DontRepeatTypeInStaticProperties" : true,
+    "FileScopedDeclarationPrivacy" : true,
+    "FullyIndirectEnum" : true,
+    "GroupNumericLiterals" : true,
+    "IdentifiersMustBeASCII" : true,
+    "NeverForceUnwrap" : false,
+    "NeverUseForceTry" : false,
+    "NeverUseImplicitlyUnwrappedOptionals" : false,
+    "NoAccessLevelOnExtensionDeclaration" : true,
+    "NoAssignmentInExpressions" : true,
+    "NoBlockComments" : true,
+    "NoCasesWithOnlyFallthrough" : true,
+    "NoEmptyTrailingClosureParentheses" : true,
+    "NoLabelsInCasePatterns" : true,
+    "NoLeadingUnderscores" : false,
+    "NoParensAroundConditions" : true,
+    "NoVoidReturnOnFunctionSignature" : true,
+    "OmitExplicitReturns" : true,
+    "OneCasePerLine" : true,
+    "OneVariableDeclarationPerLine" : true,
+    "OnlyOneTrailingClosureArgument" : true,
+    "OrderedImports" : true,
+    "ReplaceForEachWithForLoop" : true,
+    "ReturnVoidInsteadOfEmptyTuple" : true,
+    "UseEarlyExits" : false,
+    "UseExplicitNilCheckInConditions" : false,
+    "UseLetInEveryBoundCaseVariable" : false,
+    "UseShorthandTypeNames" : true,
+    "UseSingleLinePropertyGetter" : false,
+    "UseSynthesizedInitializer" : false,
+    "UseTripleSlashForDocumentationComments" : true,
+    "UseWhereClausesInForLoops" : false,
+    "ValidateDocumentationComments" : false
+  }
+}

.swiftformat

@@ -28,4 +28,4 @@ The main development branch of the repository is  `main`.
 
 ### Formatting
 
-We use Nick Lockwood's SwiftFormat for formatting code. PRs will not be accepted if they haven't be formatted. The current version of SwiftFormat we are using is v0.53.10.
+We use Apple's swift-format for formatting code. PRs will not be accepted if they haven't be formatted.

CONTRIBUTING.md

@@ -6,7 +6,7 @@ let package = Package(
     name: "swift-jobs-postgres",
     platforms: [.macOS(.v14), .iOS(.v17), .tvOS(.v17)],
     products: [
-        .library(name: "JobsPostgres", targets: ["JobsPostgres"]),
+        .library(name: "JobsPostgres", targets: ["JobsPostgres"])
     ],
     dependencies: [
         .package(url: "https://github.com/hummingbird-project/swift-jobs.git", from: "1.0.0-beta.4"),
@@ -25,7 +25,7 @@ let package = Package(
         .testTarget(
             name: "JobsPostgresTests",
             dependencies: [
-                "JobsPostgres",
+                "JobsPostgres"
             ]
         ),
     ]

Package.swift

@@ -122,7 +122,11 @@ public final class PostgresJobQueue: JobQueueDriver {
             _ = try await self.client.withConnection { connection in
                 self.logger.info("Update Jobs at initialization")
                 try await self.updateJobsOnInit(withStatus: .pending, onInit: self.configuration.pendingJobsInitialization, connection: connection)
-                try await self.updateJobsOnInit(withStatus: .processing, onInit: self.configuration.processingJobsInitialization, connection: connection)
+                try await self.updateJobsOnInit(
+                    withStatus: .processing,
+                    onInit: self.configuration.processingJobsInitialization,
+                    connection: connection
+                )
                 try await self.updateJobsOnInit(withStatus: .failed, onInit: self.configuration.failedJobsInitialization, connection: connection)
             }
         } catch let error as PSQLError {
@@ -229,14 +233,20 @@ public final class PostgresJobQueue: JobQueueDriver {
             }
             return try result.get()
         } catch let error as PSQLError {
-            logger.error("Failed to get job from queue", metadata: [
-                "error": "\(String(reflecting: error))",
-            ])
+            logger.error(
+                "Failed to get job from queue",
+                metadata: [
+                    "error": "\(String(reflecting: error))"
+                ]
+            )
             throw error
         } catch let error as JobQueueError {
-            logger.error("Job failed", metadata: [
-                "error": "\(String(reflecting: error))",
-            ])
+            logger.error(
+                "Job failed",
+                metadata: [
+                    "error": "\(String(reflecting: error))"
+                ]
+            )
             throw error
         }
     }
@@ -342,7 +352,7 @@ extension PostgresJobQueue {
     }
 
     public func makeAsyncIterator() -> AsyncIterator {
-        return .init(queue: self)
+        .init(queue: self)
     }
 }
 
@@ -353,7 +363,12 @@ extension JobQueueDriver where Self == PostgresJobQueue {
     ///   - migrations: Database migration collection to add postgres job queue migrations to
     ///   - configuration: Queue configuration
     ///   - logger: Logger used by queue
-    public static func postgres(client: PostgresClient, migrations: DatabaseMigrations, configuration: PostgresJobQueue.Configuration = .init(), logger: Logger) async -> Self {
+    public static func postgres(
+        client: PostgresClient,
+        migrations: DatabaseMigrations,
+        configuration: PostgresJobQueue.Configuration = .init(),
+        logger: Logger
+    ) async -> Self {
         await Self(client: client, migrations: migrations, configuration: configuration, logger: logger)
     }
 }

Sources/JobsPostgres/PostgresJobsQueue.swift

@@ -14,15 +14,16 @@
 
 import Atomics
 import Jobs
-@testable import JobsPostgres
 import NIOConcurrencyHelpers
 import PostgresMigrations
 import PostgresNIO
 import ServiceLifecycle
 import XCTest
 
+@testable import JobsPostgres
+
 func getPostgresConfiguration() async throws -> PostgresClient.Configuration {
-    return .init(
+    .init(
         host: ProcessInfo.processInfo.environment["POSTGRES_HOSTNAME"] ?? "localhost",
         port: 5432,
         username: ProcessInfo.processInfo.environment["POSTGRES_USER"] ?? "test_user",
@@ -48,7 +49,11 @@ final class JobsTests: XCTestCase {
         #endif
     }
 
-    func createJobQueue(numWorkers: Int, configuration: PostgresJobQueue.Configuration, function: String = #function) async throws -> JobQueue<PostgresJobQueue> {
+    func createJobQueue(
+        numWorkers: Int,
+        configuration: PostgresJobQueue.Configuration,
+        function: String = #function
+    ) async throws -> JobQueue<PostgresJobQueue> {
         let logger = {
             var logger = Logger(label: function)
             logger.logLevel = .debug
@@ -181,7 +186,8 @@ final class JobsTests: XCTestCase {
                 id: jobIdentifer,
                 parameters: 1,
                 options: .init(
-                    delayUntil: Date.now.addingTimeInterval(1))
+                    delayUntil: Date.now.addingTimeInterval(1)
+                )
             )
             try await jobQueue.push(id: jobIdentifer2, parameters: 5)
 
@@ -361,7 +367,10 @@ final class JobsTests: XCTestCase {
             succeededExpectation.fulfill()
             finished.store(true, ordering: .relaxed)
         }
-        let jobQueue = try await createJobQueue(numWorkers: 1, configuration: .init(pendingJobsInitialization: .remove, failedJobsInitialization: .rerun))
+        let jobQueue = try await createJobQueue(
+            numWorkers: 1,
+            configuration: .init(pendingJobsInitialization: .remove, failedJobsInitialization: .rerun)
+        )
         jobQueue.registerJob(job)
         try await self.testJobQueue(jobQueue: jobQueue, revertMigrations: true) { jobQueue in
             // stall to give onInit a chance to run, so it can remove any pendng jobs

Tests/JobsPostgresTests/JobsTests.swift

@@ -31,22 +31,16 @@ SWIFT_FORMAT_VERSION=0.53.10
 set -eu
 here="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 
-which swiftformat > /dev/null 2>&1 || (echo "swiftformat not installed. You can install it using 'brew install swiftformat'" ; exit -1)
-
 function replace_acceptable_years() {
     # this needs to replace all acceptable forms with 'YEARS'
     sed -e 's/20[12][0-9]-20[12][0-9]/YEARS/' -e 's/20[12][0-9]/YEARS/' -e '/^#!/ d'
 }
 
 printf "=> Checking format... "
 FIRST_OUT="$(git status --porcelain)"
-if [[ -n "${CI-""}" ]]; then
-  printf "(using v$(mint run NickLockwood/SwiftFormat@"$SWIFT_FORMAT_VERSION" --version)) "
-  mint run NickLockwood/SwiftFormat@"$SWIFT_FORMAT_VERSION" . > /dev/null 2>&1
-else
-  printf "(using v$(swiftformat --version)) "
-  swiftformat . > /dev/null 2>&1
-fi
+git ls-files -z '*.swift' | xargs -0 swift format format --parallel --in-place
+git diff --exit-code '*.swift'
+
 SECOND_OUT="$(git status --porcelain)"
 if [[ "$FIRST_OUT" != "$SECOND_OUT" ]]; then
   printf "\033[0;31mformatting issues!\033[0m\n"
@@ -55,29 +49,30 @@ if [[ "$FIRST_OUT" != "$SECOND_OUT" ]]; then
 else
   printf "\033[0;32mokay.\033[0m\n"
 fi
-exit
 printf "=> Checking license headers... "
 tmp=$(mktemp /tmp/.soto-core-sanity_XXXXXX)
 
+exit 0
+
 for language in swift-or-c; do
   declare -a matching_files
   declare -a exceptions
   expections=( )
   matching_files=( -name '*' )
   case "$language" in
       swift-or-c)
-        exceptions=( -path '*Sources/INIParser/*' -o -path '*Sources/CSotoExpat/*' -o -path '*Benchmark/.build/*' -o -name Package.swift)
+        exceptions=( -path '*/Benchmarks/.build/*' -o -name Package.swift)
         matching_files=( -name '*.swift' -o -name '*.c' -o -name '*.h' )
         cat > "$tmp" <<"EOF"
 //===----------------------------------------------------------------------===//
 //
-// This source file is part of the Hummingbird open source project
+// This source file is part of the Hummingbird server framework project
 //
 // Copyright (c) YEARS the Hummingbird authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information
-// See CONTRIBUTORS.txt for the list of Hummingbird authors
+// See hummingbird/CONTRIBUTORS.txt for the list of Hummingbird authors
 //
 // SPDX-License-Identifier: Apache-2.0
 //
@@ -89,13 +84,13 @@ EOF
         cat > "$tmp" <<"EOF"
 ##===----------------------------------------------------------------------===##
 ##
-## This source file is part of the Hummingbird open source project
+## This source file is part of the Hummingbird server framework project
 ##
 ## Copyright (c) YEARS the Hummingbird authors
 ## Licensed under Apache License v2.0
 ##
 ## See LICENSE.txt for license information
-## See CONTRIBUTORS.txt for the list of Hummingbird authors
+## See hummingbird/CONTRIBUTORS.txt for the list of Hummingbird authors
 ##
 ## SPDX-License-Identifier: Apache-2.0
 ##