├── .gitignore ├── LICENSE.txt ├── Package.swift ├── README.md ├── Sources └── PlayingCard │ ├── PlayingCard.swift │ ├── Rank.swift │ └── Suit.swift └── Tests ├── LinuxMain.swift └── PlayingCardTests ├── CardTests.swift ├── RankTests.swift ├── SuitTests.swift └── XCTestManifests.swift /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | /.build 3 | /Packages 4 | /*.xcodeproj 5 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /Package.swift: -------------------------------------------------------------------------------- 1 | // swift-tools-version:4.0 2 | // The swift-tools-version declares the minimum version of Swift required to build this package. 3 | 4 | /* 5 | This source file is part of the Swift.org open source project 6 | 7 | Copyright 2015 Apple Inc. and the Swift project authors 8 | Licensed under Apache License v2.0 with Runtime Library Exception 9 | 10 | See http://swift.org/LICENSE.txt for license information 11 | See http://swift.org/CONTRIBUTORS.txt for Swift project authors 12 | */ 13 | 14 | import PackageDescription 15 | 16 | let package = Package( 17 | name: "PlayingCard", 18 | products: [ 19 | .library(name: "PlayingCard", targets: ["PlayingCard"]), 20 | ], 21 | targets: [ 22 | .target( 23 | name: "PlayingCard", 24 | dependencies: []), 25 | .testTarget( 26 | name: "PlayingCardTests", 27 | dependencies: ["PlayingCard"]), 28 | ] 29 | ) 30 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Swift Example: Package Playingcard 2 | 3 | This example package will be cloned and built as a dependency if you build the `Dealer` example: 4 | 5 | git clone https://github.com/apple/example-package-dealer.git 6 | cd example-package-dealer 7 | swift run Dealer 8 | -------------------------------------------------------------------------------- /Sources/PlayingCard/PlayingCard.swift: -------------------------------------------------------------------------------- 1 | /* 2 | This source file is part of the Swift.org open source project 3 | 4 | Copyright 2015 Apple Inc. and the Swift project authors 5 | Licensed under Apache License v2.0 with Runtime Library Exception 6 | 7 | See http://swift.org/LICENSE.txt for license information 8 | See http://swift.org/CONTRIBUTORS.txt for Swift project authors 9 | */ 10 | 11 | /// The representation of a playing card. 12 | /// 13 | /// A playing card has a rank and a suit, and can be compared to another playing card. 14 | public struct PlayingCard: Equatable, Hashable { 15 | public let rank: Rank 16 | public let suit: Suit 17 | 18 | /// Creates a new playing card. 19 | /// 20 | /// - Parameters: 21 | /// - rank: The rank of the playing card. 22 | /// - suit: The suit of the playing card. 23 | public init(rank: Rank, suit: Suit) { 24 | self.rank = rank 25 | self.suit = suit 26 | } 27 | } 28 | 29 | // MARK: - Comparable 30 | 31 | /// An extension that performs comparisons between playing cards. 32 | extension PlayingCard: Comparable { 33 | /// Returns a Boolean value indicating whether the left playing card is less than the right playing card. 34 | public static func <(lhs: PlayingCard, rhs: PlayingCard) -> Bool { 35 | return lhs.rank == rhs.rank ? lhs.suit < rhs.suit : lhs.rank < rhs.rank 36 | } 37 | 38 | /// Returns a Boolean value indicating whether the left playing card is greater than the right playing card. 39 | public static func >(lhs: PlayingCard, rhs: PlayingCard) -> Bool { 40 | return lhs.rank == rhs.rank ? lhs.suit > rhs.suit : lhs.rank > rhs.rank 41 | } 42 | } 43 | 44 | // MARK: - CustomStringConvertible 45 | 46 | /// An extension that provides a human-readable description of a playing card. 47 | extension PlayingCard: CustomStringConvertible { 48 | /// The playing card's description. 49 | public var description: String { 50 | return "\(suit) \(rank)" 51 | } 52 | } 53 | -------------------------------------------------------------------------------- /Sources/PlayingCard/Rank.swift: -------------------------------------------------------------------------------- 1 | /* 2 | This source file is part of the Swift.org open source project 3 | 4 | Copyright 2015 Apple Inc. and the Swift project authors 5 | Licensed under Apache License v2.0 with Runtime Library Exception 6 | 7 | See http://swift.org/LICENSE.txt for license information 8 | See http://swift.org/CONTRIBUTORS.txt for Swift project authors 9 | */ 10 | 11 | /// An enumeration that defines the rank of a playing card. 12 | public enum Rank: Int, CaseIterable { 13 | case two = 2 14 | case three, four, five, six, seven, eight, nine, ten 15 | case jack, queen, king, ace 16 | } 17 | 18 | // MARK: - Comparable 19 | 20 | /// An extension that allows comparisons between ranks. 21 | extension Rank: Comparable { 22 | public static func <(lhs: Rank, rhs: Rank) -> Bool { 23 | switch (lhs, rhs) { 24 | case (_, _) where lhs == rhs: 25 | return false 26 | case (.ace, _): 27 | return false 28 | default: 29 | return lhs.rawValue < rhs.rawValue 30 | } 31 | } 32 | } 33 | 34 | // MARK: - CustomStringConvertible 35 | 36 | /// An extension that provides a human-readable description of a rank. 37 | extension Rank: CustomStringConvertible { 38 | public var description: String { 39 | switch self { 40 | case .ace: return "A" 41 | case .jack: return "J" 42 | case .queen: return "Q" 43 | case .king: return "K" 44 | default: 45 | return "\(rawValue)" 46 | } 47 | } 48 | } 49 | -------------------------------------------------------------------------------- /Sources/PlayingCard/Suit.swift: -------------------------------------------------------------------------------- 1 | /* 2 | This source file is part of the Swift.org open source project 3 | 4 | Copyright 2015 Apple Inc. and the Swift project authors 5 | Licensed under Apache License v2.0 with Runtime Library Exception 6 | 7 | See http://swift.org/LICENSE.txt for license information 8 | See http://swift.org/CONTRIBUTORS.txt for Swift project authors 9 | */ 10 | 11 | /// An enumeration that defines the suit of a playing card. 12 | public enum Suit: String, CaseIterable { 13 | case spades, hearts, diamonds, clubs 14 | } 15 | 16 | // MARK: - Comparable 17 | 18 | /// An extension that allows comparisons between suits. 19 | extension Suit: Comparable { 20 | public static func <(lhs: Suit, rhs: Suit) -> Bool { 21 | switch (lhs, rhs) { 22 | case (_, _) where lhs == rhs: 23 | return false 24 | case (.spades, _), 25 | (.hearts, .diamonds), (.hearts, .clubs), 26 | (.diamonds, .clubs): 27 | return false 28 | default: 29 | return true 30 | } 31 | } 32 | } 33 | 34 | // MARK: - CustomStringConvertible 35 | 36 | /// An extension that provides a human-readable description of a suit. 37 | extension Suit: CustomStringConvertible { 38 | public var description: String { 39 | switch self { 40 | case .spades: return "♠︎" 41 | case .hearts: return "♡" 42 | case .diamonds: return "♢" 43 | case .clubs: return "♣︎" 44 | } 45 | } 46 | } 47 | -------------------------------------------------------------------------------- /Tests/LinuxMain.swift: -------------------------------------------------------------------------------- 1 | /* 2 | This source file is part of the Swift.org open source project 3 | 4 | Copyright (c) 2014 - 2016 Apple Inc. and the Swift project authors 5 | Licensed under Apache License v2.0 with Runtime Library Exception 6 | 7 | See http://swift.org/LICENSE.txt for license information 8 | See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors 9 | */ 10 | 11 | 12 | import XCTest 13 | 14 | import PlayingCardTests 15 | 16 | var tests = [XCTestCaseEntry]() 17 | tests += PlayingCardTests.allTests() 18 | XCTMain(tests) 19 | -------------------------------------------------------------------------------- /Tests/PlayingCardTests/CardTests.swift: -------------------------------------------------------------------------------- 1 | /* 2 | This source file is part of the Swift.org open source project 3 | 4 | Copyright (c) 2014 - 2016 Apple Inc. and the Swift project authors 5 | Licensed under Apache License v2.0 with Runtime Library Exception 6 | 7 | See http://swift.org/LICENSE.txt for license information 8 | See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors 9 | */ 10 | 11 | @testable import PlayingCard 12 | import XCTest 13 | 14 | class CardTests: XCTestCase { 15 | 16 | func testCardSingle() { 17 | let card1 = PlayingCard(rank: .queen, suit: .diamonds) 18 | let card2 = PlayingCard(rank: .king, suit: .diamonds) 19 | let card3 = PlayingCard(rank: .ace, suit: .clubs) 20 | let card4 = PlayingCard(rank: .queen, suit: .diamonds) 21 | let card5 = PlayingCard(rank: .queen, suit: .clubs) 22 | 23 | XCTAssertGreaterThan(card2, card1) 24 | XCTAssertLessThan(card1, card2) 25 | XCTAssertGreaterThan(card3, card2) 26 | XCTAssertLessThan(card2, card3) 27 | XCTAssertEqual(card1, card4) 28 | XCTAssertGreaterThan(card4, card5) 29 | XCTAssertLessThan(card5, card4) 30 | } 31 | 32 | func testCardStringEquality() { 33 | let card1 = PlayingCard(rank: .jack, suit: .clubs) 34 | let card2 = PlayingCard(rank: .two, suit: .hearts) 35 | let card3 = PlayingCard(rank: .queen, suit: .diamonds) 36 | 37 | XCTAssertEqual(String(describing: card1), "♣︎ J") 38 | XCTAssertEqual(String(describing: card2), "♡ 2") 39 | XCTAssertEqual(String(describing: card3), "♢ Q") 40 | } 41 | 42 | static var allTests = [ 43 | ("testCardSingle", testCardSingle), 44 | ("testCardStringEquality", testCardStringEquality) 45 | ] 46 | } 47 | -------------------------------------------------------------------------------- /Tests/PlayingCardTests/RankTests.swift: -------------------------------------------------------------------------------- 1 | /* 2 | This source file is part of the Swift.org open source project 3 | 4 | Copyright (c) 2014 - 2016 Apple Inc. and the Swift project authors 5 | Licensed under Apache License v2.0 with Runtime Library Exception 6 | 7 | See http://swift.org/LICENSE.txt for license information 8 | See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors 9 | */ 10 | 11 | @testable import PlayingCard 12 | import XCTest 13 | 14 | class RankTests: XCTestCase { 15 | 16 | func testRankStringEquality() { 17 | let numbers = [2,3,4,5,6,7,8,9,10] 18 | let suits = numbers.map{Rank(rawValue:$0)}.flatMap{$0}.map{Int(String(describing: $0)) ?? 0} 19 | 20 | XCTAssertEqual(String(describing: Rank.ace), "A") 21 | XCTAssertEqual(String(describing: Rank.jack), "J") 22 | XCTAssertEqual(String(describing: Rank.queen), "Q") 23 | XCTAssertEqual(String(describing: Rank.king), "K") 24 | XCTAssertEqual(numbers, suits) 25 | } 26 | 27 | func testRankComparable() { 28 | XCTAssertGreaterThan(Rank.ace, Rank.two) 29 | XCTAssertGreaterThan(Rank.ace, Rank.king) 30 | XCTAssertGreaterThan(Rank.king, Rank.queen) 31 | XCTAssertGreaterThan(Rank.queen, Rank.jack) 32 | XCTAssertGreaterThan(Rank.jack, Rank.ten) 33 | } 34 | 35 | static var allTests = [ 36 | ("testRankStringEquality", testRankStringEquality), 37 | ("testRankComparable", testRankComparable), 38 | ] 39 | } 40 | -------------------------------------------------------------------------------- /Tests/PlayingCardTests/SuitTests.swift: -------------------------------------------------------------------------------- 1 | /* 2 | This source file is part of the Swift.org open source project 3 | 4 | Copyright (c) 2014 - 2016 Apple Inc. and the Swift project authors 5 | Licensed under Apache License v2.0 with Runtime Library Exception 6 | 7 | See http://swift.org/LICENSE.txt for license information 8 | See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors 9 | */ 10 | 11 | @testable import PlayingCard 12 | import XCTest 13 | 14 | class SuitTests: XCTestCase { 15 | 16 | func testSuitStringEquality() { 17 | XCTAssertEqual(String(describing: Suit.spades), "♠︎") 18 | XCTAssertEqual(String(describing: Suit.hearts), "♡") 19 | XCTAssertEqual(String(describing: Suit.diamonds), "♢") 20 | XCTAssertEqual(String(describing: Suit.clubs), "♣︎") 21 | } 22 | 23 | func testSuitComparable() { 24 | XCTAssertGreaterThan(Suit.spades, Suit.diamonds) 25 | XCTAssertGreaterThan(Suit.hearts, Suit.diamonds ) 26 | XCTAssertGreaterThan(Suit.hearts, Suit.clubs) 27 | XCTAssertGreaterThan(Suit.diamonds, Suit.clubs) 28 | } 29 | 30 | static var allTests = [ 31 | ("testSuitStringEquality", testSuitStringEquality), 32 | ("testSuitComparable", testSuitComparable), 33 | ] 34 | } 35 | -------------------------------------------------------------------------------- /Tests/PlayingCardTests/XCTestManifests.swift: -------------------------------------------------------------------------------- 1 | /* 2 | This source file is part of the Swift.org open source project 3 | 4 | Copyright 2015 - 2016 Apple Inc. and the Swift project authors 5 | Licensed under Apache License v2.0 with Runtime Library Exception 6 | 7 | See http://swift.org/LICENSE.txt for license information 8 | See http://swift.org/CONTRIBUTORS.txt for Swift project authors 9 | */ 10 | 11 | import XCTest 12 | 13 | #if !os(macOS) 14 | public func allTests() -> [XCTestCaseEntry] { 15 | return [ 16 | testCase(CardTests.allTests), 17 | testCase(RankTests.allTests), 18 | testCase(SuitTests.allTests), 19 | ] 20 | } 21 | #endif 22 | --------------------------------------------------------------------------------