Merge pull request #8 from mattt/swift-5.5

Update to Swift 5.5

Author: tomerd

Package.swift

@@ -1,10 +1,10 @@
-// swift-tools-version:4.0
+// swift-tools-version:5.5
 // The swift-tools-version declares the minimum version of Swift required to build this package.
 
 /*
  This source file is part of the Swift.org open source project
 
- Copyright 2015 Apple Inc. and the Swift project authors
+ Copyright 2015 – 2021 Apple Inc. and the Swift project authors
  Licensed under Apache License v2.0 with Runtime Library Exception
 
  See http://swift.org/LICENSE.txt for license information
@@ -15,18 +15,34 @@ import PackageDescription
 
 let package = Package(
     name: "dealer",
+    platforms: [
+        .macOS(.v11)
+    ],
     products: [
-        .executable(name: "Dealer", targets: ["Dealer"]),
+        .executable(name: "dealer", targets: ["dealer"]),
     ],
     dependencies: [
         // Dependencies declare other packages that this package depends on.
-        .package(url: "https://github.com/apple/example-package-deckofplayingcards.git", from: "3.0.0"),
+        .package(url: "https://github.com/apple/example-package-deckofplayingcards.git",
+                 from: "3.0.0"),
+        .package(url: "https://github.com/apple/swift-argument-parser.git",
+                 from: "0.4.4"),
     ],
     targets: [
         // Targets are the basic building blocks of a package. A target can define a module or a test suite.
         // Targets can depend on other targets in this package, and on products in packages which this package depends on.
-        .target(
-            name: "Dealer",
-            dependencies: ["DeckOfPlayingCards"]),
+        .executableTarget(
+            name: "dealer",
+            dependencies: [
+                .product(name: "DeckOfPlayingCards",
+                         package: "example-package-deckofplayingcards"),
+                .product(name: "ArgumentParser",
+                         package: "swift-argument-parser")
+            ]),
+        .testTarget(
+            name: "DealerTests",
+            dependencies: [
+                .byName(name: "dealer")
+            ]),
     ]
 )

Sources/Dealer/main.swift

@@ -0,0 +1,67 @@
+/*
+ This source file is part of the Swift.org open source project
+
+ Copyright 2015 – 2021 Apple Inc. and the Swift project authors
+ Licensed under Apache License v2.0 with Runtime Library Exception
+
+ See http://swift.org/LICENSE.txt for license information
+ See http://swift.org/CONTRIBUTORS.txt for Swift project authors
+*/
+
+#if os(Linux)
+import Glibc
+#endif
+
+import Foundation
+import DeckOfPlayingCards
+import PlayingCard
+import ArgumentParser
+
+@main
+struct Deal: ParsableCommand {
+    enum Error: Swift.Error, CustomStringConvertible {
+        case notEnoughCards
+
+        var description: String {
+            switch self {
+            case .notEnoughCards:
+                return "Not enough cards"
+            }
+        }
+    }
+
+    static var configuration = CommandConfiguration(
+            abstract: "Shuffles a deck of playing cards and deals a number of cards.",
+            discussion: """
+                For each count argument, prints a line of tab-delimited cards to stdout,
+                or if there aren't enough cards remaining,
+                prints "Not enough cards" to stderr and exits with a nonzero status.
+                """)
+
+    @Argument(help: .init("The number of cards to deal at a time.",
+                          valueName: "count"))
+    var counts: [UInt]
+
+    mutating func run() throws {
+        #if os(Linux)
+        srandom(UInt32(clock()))
+        #endif
+
+        var deck = Deck.standard52CardDeck()
+        deck.shuffle()
+
+        for count in counts {
+            var cards: [PlayingCard] = []
+
+            for _ in 0..<count {
+                guard let card = deck.deal() else {
+                    Self.exit(withError: Error.notEnoughCards)
+                }
+
+                cards.append(card)
+            }
+
+            print(cards.map(\.description).joined(separator: "\t"))
+        }
+    }
+}

Sources/dealer/Deal.swift

@@ -0,0 +1,103 @@
+/*
+ This source file is part of the Swift.org open source project
+
+ Copyright 2021 Apple Inc. and the Swift project authors
+ Licensed under Apache License v2.0 with Runtime Library Exception
+
+ See http://swift.org/LICENSE.txt for license information
+ See http://swift.org/CONTRIBUTORS.txt for Swift project authors
+*/
+
+import XCTest
+import class Foundation.Bundle
+
+final class DealerTests: XCTestCase {
+    func testUsage() throws {
+        let (status, output, error) = try execute(with: ["--help"])
+        XCTAssertEqual(status, EXIT_SUCCESS)
+        XCTAssert(output?.starts(with: "OVERVIEW: Shuffles a deck of playing cards and deals a number of cards.") ?? false)
+        XCTAssertEqual(error, "")
+    }
+
+    func testDealOneCard() throws {
+        let (status, output, error) = try execute(with: ["1"])
+        XCTAssertEqual(status, EXIT_SUCCESS)
+        XCTAssertEqual(output?.filter(\.isPlayingCardSuit).count, 1)
+
+        XCTAssertEqual(error, "")
+    }
+
+    func testDealTenCards() throws {
+        let (status, output, error) = try execute(with: ["10"])
+        XCTAssertEqual(status, EXIT_SUCCESS)
+        XCTAssertEqual(output?.filter(\.isPlayingCardSuit).count, 10)
+
+        XCTAssertEqual(error, "")
+    }
+
+    func testDealThirteenCardsFourTimes() throws {
+        let (status, output, error) = try execute(with: ["13", "13", "13", "13"])
+        XCTAssertEqual(status, EXIT_SUCCESS)
+        XCTAssertEqual(output?.filter(\.isPlayingCardSuit).count, 52)
+        XCTAssertEqual(output?.filter(\.isNewline).count, 4)
+
+        XCTAssertEqual(error, "")
+    }
+
+    func testDealOneHundredCards() throws {
+        let (status, output, error) = try execute(with: ["100"])
+        XCTAssertNotEqual(status, EXIT_SUCCESS)
+        XCTAssertEqual(output, "")
+        XCTAssertEqual(error, "Error: Not enough cards\n")
+    }
+
+    /// Returns path to the built products directory.
+    var productsDirectory: URL {
+      #if os(macOS)
+        for bundle in Bundle.allBundles where bundle.bundlePath.hasSuffix(".xctest") {
+            return bundle.bundleURL.deletingLastPathComponent()
+        }
+        fatalError("couldn't find the products directory")
+      #else
+        return Bundle.main.bundleURL
+      #endif
+    }
+
+    private func execute(with arguments: [String] = []) throws -> (status: Int32, output: String?, error: String?) {
+        let process = Process()
+        process.executableURL = productsDirectory.appendingPathComponent("dealer")
+        process.arguments = arguments
+
+        let outputPipe = Pipe()
+        process.standardOutput = outputPipe
+
+        let errorPipe = Pipe()
+        process.standardError = errorPipe
+
+        try process.run()
+        process.waitUntilExit()
+
+        let status = process.terminationStatus
+
+        let outputData = outputPipe.fileHandleForReading.readDataToEndOfFile()
+        let output = String(data: outputData, encoding: .utf8)
+
+        let errorData = errorPipe.fileHandleForReading.readDataToEndOfFile()
+        let error = String(data: errorData, encoding: .utf8)
+
+        return (status, output, error)
+    }
+}
+
+// MARK: -
+
+private extension Character {
+    var isPlayingCardSuit: Bool {
+        switch self {
+        case "♠︎", "♡", "♢", "♣︎":
+            return true
+        default:
+            return false
+        }
+    }
+}