Adopt swift-format (#12)

- Update to `swift-tools-version:6.0` - Adopt `swift-format` - Switch from custom `.unixPath()` to Foundation's `.path` - Add more tests --------- Co-authored-by: Mahdi Bahrami <[email protected]>
vapor-community · Sep 29, 2024 · 939492b · 939492b
1 parent af8b8d0
commit 939492b
Show file tree

Hide file tree

Showing 52 changed files with 1,175 additions and 620 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -7,6 +7,15 @@ on:
  push: { branches: [ main ] }
 
 jobs:
+ lint:
+ runs-on: ubuntu-latest
+ container: swift:noble
+ steps:
+ - name: Check out PassKit
+ uses: actions/checkout@v4
+ - name: Run format lint check
+ run: swift format lint --strict --recursive --parallel .
+
  unit-tests:
  uses: vapor/ci/.github/workflows/run-unit-tests.yml@main
  secrets:

diff --git a/.spi.yml b/.spi.yml
@@ -1,4 +1,5 @@
 version: 1
 builder:
  configs:
- - documentation_targets: [PassKit, Passes, Orders]
+ - documentation_targets: [PassKit, Passes, Orders]
+ swift_version: 6.0
diff --git a/.swift-format b/.swift-format
@@ -0,0 +1,70 @@
+{
+ "fileScopedDeclarationPrivacy": {
+ "accessLevel": "private"
+ },
+ "indentation": {
+ "spaces": 4
+ },
+ "indentConditionalCompilationBlocks": true,
+ "indentSwitchCaseLabels": false,
+ "lineBreakAroundMultilineExpressionChainComponents": false,
+ "lineBreakBeforeControlFlowKeywords": false,
+ "lineBreakBeforeEachArgument": false,
+ "lineBreakBeforeEachGenericRequirement": false,
+ "lineLength": 100,
+ "maximumBlankLines": 1,
+ "multiElementCollectionTrailingCommas": true,
+ "noAssignmentInExpressions": {
+ "allowedFunctions": [
+ "XCTAssertNoThrow"
+ ]
+ },
+ "prioritizeKeepingFunctionOutputTogether": false,
+ "respectsExistingLineBreaks": true,
+ "rules": {
+ "AllPublicDeclarationsHaveDocumentation": false,
+ "AlwaysUseLiteralForEmptyCollectionInit": false,
+ "AlwaysUseLowerCamelCase": true,
+ "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,
+ "NoPlaygroundLiterals": true,
+ "NoVoidReturnOnFunctionSignature": true,
+ "OmitExplicitReturns": false,
+ "OneCasePerLine": true,
+ "OneVariableDeclarationPerLine": true,
+ "OnlyOneTrailingClosureArgument": true,
+ "OrderedImports": true,
+ "ReplaceForEachWithForLoop": true,
+ "ReturnVoidInsteadOfEmptyTuple": true,
+ "TypeNamesShouldBeCapitalized": true,
+ "UseEarlyExits": false,
+ "UseExplicitNilCheckInConditions": true,
+ "UseLetInEveryBoundCaseVariable": true,
+ "UseShorthandTypeNames": true,
+ "UseSingleLinePropertyGetter": true,
+ "UseSynthesizedInitializer": true,
+ "UseTripleSlashForDocumentationComments": true,
+ "UseWhereClausesInForLoops": false,
+ "ValidateDocumentationComments": false
+ },
+ "spacesAroundRangeFormationOperators": false,
+ "tabWidth": 8,
+ "version": 1
+}
diff --git a/Package.swift b/Package.swift
@@ -1,20 +1,20 @@
-// swift-tools-version:5.10
+// swift-tools-version:6.0
 import PackageDescription
 
 let package = Package(
  name: "PassKit",
  platforms: [
- .macOS(.v13)
+ .macOS(.v14)
  ],
  products: [
  .library(name: "Passes", targets: ["Passes"]),
  .library(name: "Orders", targets: ["Orders"]),
  ],
  dependencies: [
- .package(url: "https://github.com/vapor/vapor.git", from: "4.103.1"),
+ .package(url: "https://github.com/vapor/vapor.git", from: "4.105.2"),
  .package(url: "https://github.com/vapor/fluent.git", from: "4.11.0"),
  .package(url: "https://github.com/vapor/apns.git", from: "4.2.0"),
- .package(url: "https://github.com/vapor-community/Zip.git", from: "2.2.0"),
+ .package(url: "https://github.com/vapor-community/Zip.git", from: "2.2.3"),
  .package(url: "https://github.com/apple/swift-certificates.git", from: "1.5.0"),
  // used in tests
  .package(url: "https://github.com/vapor/fluent-sqlite-driver.git", from: "4.7.4"),
@@ -34,14 +34,14 @@ let package = Package(
  .target(
  name: "Passes",
  dependencies: [
- .target(name: "PassKit"),
+ .target(name: "PassKit")
  ],
  swiftSettings: swiftSettings
  ),
  .target(
  name: "Orders",
  dependencies: [
- .target(name: "PassKit"),
+ .target(name: "PassKit")
  ],
  swiftSettings: swiftSettings
  ),
@@ -54,7 +54,7 @@ let package = Package(
  .product(name: "FluentSQLiteDriver", package: "fluent-sqlite-driver"),
  ],
  resources: [
- .copy("Templates"),
+ .copy("Templates")
  ],
  swiftSettings: swiftSettings
  ),
@@ -67,18 +67,16 @@ let package = Package(
  .product(name: "FluentSQLiteDriver", package: "fluent-sqlite-driver"),
  ],
  resources: [
- .copy("Templates"),
+ .copy("Templates")
  ],
  swiftSettings: swiftSettings
  ),
  ]
 )
 
-var swiftSettings: [SwiftSetting] { [
- .enableUpcomingFeature("ExistentialAny"),
- .enableUpcomingFeature("ConciseMagicFile"),
- .enableUpcomingFeature("ForwardTrailingClosures"),
- .enableUpcomingFeature("DisableOutwardActorInference"),
- .enableUpcomingFeature("StrictConcurrency"),
- .enableExperimentalFeature("StrictConcurrency=complete"),
-] }
+var swiftSettings: [SwiftSetting] {
+ [
+ .enableUpcomingFeature("ExistentialAny"),
+ .enableUpcomingFeature("FullTypedThrows"),
+ ]
+}
diff --git a/Sources/Orders/DTOs/OrderJSON.swift b/Sources/Orders/DTOs/OrderJSON.swift
@@ -13,35 +13,35 @@ public struct OrderJSON {
  public protocol Properties: Encodable {
  /// The date and time when the customer created the order, in RFC 3339 format.
  var createdAt: String { get }
- 
+
  /// A unique order identifier scoped to your order type identifier.
  ///
  /// In combination with the order type identifier, this uniquely identifies an order within the system and isn’t displayed to the user.
  var orderIdentifier: String { get }
- 
+
  /// A URL where the customer can manage the order.
  var orderManagementURL: String { get }
- 
+
  /// The type of order this bundle represents.
  ///
  /// Currently the only supported value is `ecommerce`.
  var orderType: OrderType { get }
- 
+
  /// An identifier for the order type associated with the order.
  ///
  /// The value must correspond with your signing certificate and isn’t displayed to the user.
  var orderTypeIdentifier: String { get }
- 
+
  /// A high-level status of the order, used for display purposes.
  ///
  /// The system considers orders with status `completed` or `cancelled` closed.
  var status: OrderStatus { get }
- 
+
  /// The version of the schema used for the order.
  ///
  /// The current version is `1`.
  var schemaVersion: SchemaVersion { get }
- 
+
  /// The date and time when the order was last updated, in RFC 3339 format.
  ///
  /// This should equal the `createdAt` time, if the order hasn’t had any updates.
@@ -58,10 +58,10 @@ extension OrderJSON {
  public protocol Merchant: Encodable {
  /// The localized display name of the merchant.
  var displayName: String { get }
- 
+
  /// The Apple Merchant Identifier for this merchant, generated at `developer.apple.com`.
  var merchantIdentifier: String { get }
- 
+
  /// The URL for the merchant’s website or landing page.
  var url: String { get }
  }
@@ -74,10 +74,10 @@ extension OrderJSON {
  public protocol Barcode: Encodable {
  /// The format of the barcode.
  var format: BarcodeFormat { get }
- 
+
  /// The contents of the barcode.
  var message: String { get }
- 
+
  /// The text encoding of the barcode message.
  ///
  /// Typically this is `iso-8859-1`, but you may specify an alternative encoding if required.

diff --git a/Sources/Orders/Middleware/AppleOrderMiddleware.swift b/Sources/Orders/Middleware/AppleOrderMiddleware.swift
@@ -5,15 +5,19 @@
 // Created by Francesco Paolo Severino on 30/06/24.
 //
 
-import Vapor
 import FluentKit
+import Vapor
 
 struct AppleOrderMiddleware<O: OrderModel>: AsyncMiddleware {
- func respond(to request: Request, chainingTo next: any AsyncResponder) async throws -> Response {
- guard let auth = request.headers["Authorization"].first?.replacingOccurrences(of: "AppleOrder ", with: ""),
- let _ = try await O.query(on: request.db)
+ func respond(
+ to request: Request, chainingTo next: any AsyncResponder
+ ) async throws -> Response {
+ guard
+ let auth = request.headers["Authorization"].first?.replacingOccurrences(
+ of: "AppleOrder ", with: ""),
+ (try await O.query(on: request.db)
  .filter(\._$authenticationToken == auth)
- .first()
+ .first()) != nil
  else {
  throw Abort(.unauthorized)
  }

diff --git a/Sources/Orders/Models/Concrete Models/Order.swift b/Sources/Orders/Models/Concrete Models/Order.swift
@@ -5,8 +5,8 @@
 // Created by Francesco Paolo Severino on 30/06/24.
 //
 
-import Foundation
 import FluentKit
+import Foundation
 
 /// The `Model` that stores Wallet orders.
 final public class Order: OrderModel, @unchecked Sendable {
@@ -35,7 +35,7 @@ final public class Order: OrderModel, @unchecked Sendable {
  @Field(key: Order.FieldKeys.authenticationToken)
  public var authenticationToken: String
 
- public required init() { }
+ public required init() {}
 
  public required init(orderTypeIdentifier: String, authenticationToken: String) {
  self.orderTypeIdentifier = orderTypeIdentifier

diff --git a/Sources/Orders/Models/Concrete Models/OrdersDevice.swift b/Sources/Orders/Models/Concrete Models/OrdersDevice.swift
@@ -38,7 +38,9 @@ extension OrdersDevice: AsyncMigration {
  .field(.id, .int, .identifier(auto: true))
  .field(OrdersDevice.FieldKeys.pushToken, .string, .required)
  .field(OrdersDevice.FieldKeys.deviceLibraryIdentifier, .string, .required)
- .unique(on: OrdersDevice.FieldKeys.pushToken, OrdersDevice.FieldKeys.deviceLibraryIdentifier)
+ .unique(
+ on: OrdersDevice.FieldKeys.pushToken, OrdersDevice.FieldKeys.deviceLibraryIdentifier
+ )
  .create()
  }
 

diff --git a/Sources/Orders/Models/Concrete Models/OrdersErrorLog.swift b/Sources/Orders/Models/Concrete Models/OrdersErrorLog.swift
@@ -5,10 +5,11 @@
 // Created by Francesco Paolo Severino on 30/06/24.
 //
 
-import struct Foundation.Date
 import FluentKit
 import PassKit
 
+import struct Foundation.Date
+
 /// The `Model` that stores Wallet orders error logs.
 final public class OrdersErrorLog: ErrorLogModel, @unchecked Sendable {
  /// The schema name of the error log model.

diff --git a/Sources/Orders/Models/Concrete Models/OrdersRegistration.swift b/Sources/Orders/Models/Concrete Models/OrdersRegistration.swift
@@ -33,8 +33,14 @@ extension OrdersRegistration: AsyncMigration {
  public func prepare(on database: any Database) async throws {
  try await database.schema(Self.schema)
  .field(.id, .int, .identifier(auto: true))
- .field(OrdersRegistration.FieldKeys.deviceID, .int, .required, .references(DeviceType.schema, .id, onDelete: .cascade))
- .field(OrdersRegistration.FieldKeys.orderID, .uuid, .required, .references(OrderType.schema, .id, onDelete: .cascade))
+ .field(
+ OrdersRegistration.FieldKeys.deviceID, .int, .required,
+ .references(DeviceType.schema, .id, onDelete: .cascade)
+ )
+ .field(
+ OrdersRegistration.FieldKeys.orderID, .uuid, .required,
+ .references(OrderType.schema, .id, onDelete: .cascade)
+ )
  .create()
  }
 

diff --git a/Sources/Orders/Models/OrderDataModel.swift b/Sources/Orders/Models/OrderDataModel.swift
@@ -15,11 +15,12 @@ public protocol OrderDataModel: Model {
  var order: OrderType { get set }
 }
 
-internal extension OrderDataModel {
+extension OrderDataModel {
  var _$order: Parent<OrderType> {
  guard let mirror = Mirror(reflecting: self).descendant("_order"),
- let order = mirror as? Parent<OrderType> else {
- fatalError("order property must be declared using @Parent")
+ let order = mirror as? Parent<OrderType>
+ else {
+ fatalError("order property must be declared using @Parent")
  }
 
  return order