Merge pull request #20 from juliand665/master

More Abstraction and Additional Clock Test Cases

Author: bugKrusha

CodeChallenge.xcodeproj/project.pbxproj

@@ -12,7 +12,6 @@
 		1B49C0501E0850D90094121E /* BugKrushaBulletMatchEntry.swift in Sources */ = {isa = PBXBuildFile; fileRef = 1B49C04F1E0850D90094121E /* BugKrushaBulletMatchEntry.swift */; };
 		1B49C0531E0855C90094121E /* BulletMatchTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 1B49C0521E0855C90094121E /* BulletMatchTests.swift */; };
 		1B4ECDA51E08267B00767EBD /* BulletMatch.swift in Sources */ = {isa = PBXBuildFile; fileRef = 1B4ECDA41E08267B00767EBD /* BulletMatch.swift */; };
-		1B5C1BC51E1EB242002E9254 /* markings_short.json in Resources */ = {isa = PBXBuildFile; fileRef = 1B5C1BC41E1EB242002E9254 /* markings_short.json */; };
 		1B9E113F1E005A7C00B9FA5A /* Clock.swift in Sources */ = {isa = PBXBuildFile; fileRef = 1B9E113E1E005A7C00B9FA5A /* Clock.swift */; };
 		1B9E11411E006A2B00B9FA5A /* BugKrushaClockEntry.swift in Sources */ = {isa = PBXBuildFile; fileRef = 1B9E11401E006A2B00B9FA5A /* BugKrushaClockEntry.swift */; };
 		1B9E11461E006F0800B9FA5A /* ClockTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 1B9E11451E006F0800B9FA5A /* ClockTests.swift */; };
@@ -40,6 +39,8 @@
 		9489866A1BE5CFB000D34976 /* CodeChallengeType.swift in Sources */ = {isa = PBXBuildFile; fileRef = 948986691BE5CFB000D34976 /* CodeChallengeType.swift */; };
 		948986701BE5D28500D34976 /* ExampleCodeChallenge.swift in Sources */ = {isa = PBXBuildFile; fileRef = 9489866F1BE5D28500D34976 /* ExampleCodeChallenge.swift */; };
 		94FB98CA1BE1B5D800228845 /* TwoSumChallenge.swift in Sources */ = {isa = PBXBuildFile; fileRef = 94FB98C91BE1B5D800228845 /* TwoSumChallenge.swift */; };
+		953445F81E21ED03008AC0B3 /* BulletMatch_dataset.json in Resources */ = {isa = PBXBuildFile; fileRef = 953445F71E21ED03008AC0B3 /* BulletMatch_dataset.json */; };
+		953445FA1E21ED07008AC0B3 /* Clock_dataset.json in Resources */ = {isa = PBXBuildFile; fileRef = 953445F91E21ED07008AC0B3 /* Clock_dataset.json */; };
 		9572008E1E1F19F9006BB4D6 /* juliand665BulletMatchEntry.swift in Sources */ = {isa = PBXBuildFile; fileRef = 9572008D1E1F19F9006BB4D6 /* juliand665BulletMatchEntry.swift */; };
 		957200991E206A35006BB4D6 /* juliand665LetterCombinationOfPhoneNumberEntry.swift in Sources */ = {isa = PBXBuildFile; fileRef = 957200981E206A35006BB4D6 /* juliand665LetterCombinationOfPhoneNumberEntry.swift */; };
 		9572009C1E206A4B006BB4D6 /* juliand665LSWRCEntry.swift in Sources */ = {isa = PBXBuildFile; fileRef = 9572009B1E206A4B006BB4D6 /* juliand665LSWRCEntry.swift */; };
@@ -65,7 +66,6 @@
 		1B49C04F1E0850D90094121E /* BugKrushaBulletMatchEntry.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; name = BugKrushaBulletMatchEntry.swift; path = BulletMatch/Entries/BugKrushaBulletMatchEntry.swift; sourceTree = "<group>"; };
 		1B49C0521E0855C90094121E /* BulletMatchTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = BulletMatchTests.swift; sourceTree = "<group>"; };
 		1B4ECDA41E08267B00767EBD /* BulletMatch.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; name = BulletMatch.swift; path = BulletMatch/BulletMatch.swift; sourceTree = "<group>"; };
-		1B5C1BC41E1EB242002E9254 /* markings_short.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; path = markings_short.json; sourceTree = "<group>"; };
 		1B9E113E1E005A7C00B9FA5A /* Clock.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = Clock.swift; sourceTree = "<group>"; };
 		1B9E11401E006A2B00B9FA5A /* BugKrushaClockEntry.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = BugKrushaClockEntry.swift; sourceTree = "<group>"; };
 		1B9E11451E006F0800B9FA5A /* ClockTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = ClockTests.swift; sourceTree = "<group>"; };
@@ -96,6 +96,8 @@
 		948986691BE5CFB000D34976 /* CodeChallengeType.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = CodeChallengeType.swift; sourceTree = "<group>"; };
 		9489866F1BE5D28500D34976 /* ExampleCodeChallenge.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = ExampleCodeChallenge.swift; sourceTree = "<group>"; };
 		94FB98C91BE1B5D800228845 /* TwoSumChallenge.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = TwoSumChallenge.swift; sourceTree = "<group>"; };
+		953445F71E21ED03008AC0B3 /* BulletMatch_dataset.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; name = BulletMatch_dataset.json; path = BulletMatch/BulletMatch_dataset.json; sourceTree = "<group>"; };
+		953445F91E21ED07008AC0B3 /* Clock_dataset.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; path = Clock_dataset.json; sourceTree = "<group>"; };
 		9572008D1E1F19F9006BB4D6 /* juliand665BulletMatchEntry.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; name = juliand665BulletMatchEntry.swift; path = BulletMatch/Entries/juliand665BulletMatchEntry.swift; sourceTree = "<group>"; };
 		957200981E206A35006BB4D6 /* juliand665LetterCombinationOfPhoneNumberEntry.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = juliand665LetterCombinationOfPhoneNumberEntry.swift; sourceTree = "<group>"; };
 		9572009B1E206A4B006BB4D6 /* juliand665LSWRCEntry.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = juliand665LSWRCEntry.swift; sourceTree = "<group>"; };
@@ -150,6 +152,7 @@
 			children = (
 				1B49C0511E0850DD0094121E /* Entries */,
 				1B4ECDA41E08267B00767EBD /* BulletMatch.swift */,
+				953445F71E21ED03008AC0B3 /* BulletMatch_dataset.json */,
 			);
 			name = BulletMatch;
 			sourceTree = "<group>";
@@ -173,17 +176,11 @@
 			children = (
 				1B9E11421E006A2F00B9FA5A /* Entries */,
 				1B9E113E1E005A7C00B9FA5A /* Clock.swift */,
+				953445F91E21ED07008AC0B3 /* Clock_dataset.json */,
 			);
 			path = Clock;
 			sourceTree = "<group>";
 		};
-		1BB33E9E1E15BA5200C83E3F /* Resources */ = {
-			isa = PBXGroup;
-			children = (
-			);
-			path = Resources;
-			sourceTree = "<group>";
-		};
 		9272E19A1BD7F6560030B403 = {
 			isa = PBXGroup;
 			children = (
@@ -225,8 +222,6 @@
 		94350F591BE5D5C1003592FB /* Challenges */ = {
 			isa = PBXGroup;
 			children = (
-				1B5C1BC41E1EB242002E9254 /* markings_short.json */,
-				1BB33E9E1E15BA5200C83E3F /* Resources */,
 				1B9E11471E010A3500B9FA5A /* Clock */,
 				94350F661BE5EB21003592FB /* TwoSum */,
 				944CFCD61BE72AEB00FD2E41 /* LetterCombinationsOfPhoneNumber */,
@@ -410,7 +405,8 @@
 			isa = PBXResourcesBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
-				1B5C1BC51E1EB242002E9254 /* markings_short.json in Resources */,
+				953445F81E21ED03008AC0B3 /* BulletMatch_dataset.json in Resources */,
+				953445FA1E21ED07008AC0B3 /* Clock_dataset.json in Resources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};

CodeChallenge/Base/CodeChallengeType.swift

@@ -8,11 +8,13 @@
 
 import Foundation
 
+// MARK: - Challenge Definition
+
 /**
  Protocol for defining a new Challenge.
 
  This protocol defines the Input/Output types for the Entry's `block` property. HINT: Use a tuple for multiple inputs! It also defines the interface that whatever will run the challenges (currently our tests) uses to run the entries and verify their output.
-*/
+ */
 protocol CodeChallengeType {
     /// The type for the input(s) for the challenge.
     associatedtype InputType
@@ -27,17 +29,104 @@ protocol CodeChallengeType {
 
     /**
      A function to generate the dataset that the entries will be run against. Each `InputType` in the returned array will be run by each entry multiple times and then averaged in the results.
-    */
+     */
     func generateDataset() -> [InputType]
 
     /**
      A function which verifies the output from running an entry's block with the given input.
 
      - Returns: True if the output is valid, false if not.
-    */
+     */
     func verifyOutput(_ output: OutputType, forInput input: InputType) -> Bool
 }
 
+/**
+ Convenient protocol for defining challenges that verify entries using a JSON file.
+ 
+ Fields required by `JSONBasedChallenge`:
+ - `fileName`
+ - `verificationData`
+ 
+ Fields required by `CodeChallengeType`:
+ - `title`
+ - `entries`
+ - `InputType`
+ - `OutputType`
+ 
+ In most cases, this should take over `generateDataset` and `verifyOutput` for you.
+ The more your types are simple `String`s, the less methods you'll have to implement yourself.
+ */
+protocol JSONBasedChallenge: class, CodeChallengeType {
+    
+    /// The type the output is encoded as in the JSON file. This can usually be inferred from methods you define; you shouldn't have to add it manually.
+    associatedtype RawOutputType
+    
+    /// The name of the JSON file. You shouldn't need to add any path components in here.
+    /// Recommended placement of the JSON file is in your challenge folder.
+    var fileName: String { get }
+    
+    /// You have to implement this yourself, since protocols can't store anything for you. The types should match those of the JSON file.
+    var verificationData: [String: RawOutputType] { get set }
+    
+    
+    /// Converts the JSON key into an input for the challenge. (Used for dataset generation.)
+    /// 
+    /// If your `InputType` is `String`, you don't have to implement this.
+    ///
+    /// - Parameter raw: Raw input from the JSON file
+    /// - Returns: Input to feed into entries
+    func input(from raw: String) -> InputType
+    
+    /// Converts the challenge input back into raw JSON. (Used for output verification.)
+    /// 
+    /// If your `InputType` is `String`, you don't have to implement this.
+    ///
+    /// - Parameter input: Input used for the entry
+    /// - Returns: Raw input, as in the JSON file, to use for accessing `verificationData`
+    func raw(from input: InputType) -> String
+}
+
+// Default Implementations
+
+extension JSONBasedChallenge {
+    
+    func generateDataset() -> [InputType] {
+        // Extract data from JSON file
+        let bundle = Bundle(for: Self.self)
+        guard
+            let dataUrl = bundle.url(forResource: fileName, withExtension: "json"),
+            let data = try? Data(contentsOf: dataUrl),
+            let jsonObjects = try? JSONSerialization.jsonObject(with: data, options: .allowFragments),
+            let vd = jsonObjects as? [String: RawOutputType] else { fatalError() }
+        
+        verificationData = vd
+        
+        // Map key `String`s to `InputType`
+        return vd.keys.map { input(from: $0) }
+    }
+}
+
+extension JSONBasedChallenge where OutputType: Equatable, RawOutputType == OutputType {
+    
+    func verifyOutput(_ output: OutputType, forInput input: InputType) -> Bool {
+        guard let expected = verificationData[raw(from: input)] else { return false }
+        return expected == output
+    }
+}
+
+extension JSONBasedChallenge where InputType == String {
+    
+    func input(from raw: String) -> InputType {
+        return raw
+    }
+    
+    func raw(from input: InputType) -> String {
+        return input
+    }
+}
+
+// MARK: - Entry Definition
+
 /// An entry for a `CodeChallengeType`.
 struct CodeChallengeEntry<ChallengeType: CodeChallengeType> {
     /// This entry's author's name.
@@ -47,6 +136,8 @@ struct CodeChallengeEntry<ChallengeType: CodeChallengeType> {
     let block: (ChallengeType.InputType) -> ChallengeType.OutputType
 }
 
+// MARK: - Test Evaluation
+
 /// A structure to hold the result of a single run of an Entry's `block`.
 struct CodeChallengeResult<ChallengeType: CodeChallengeType> {
     /// The name of the Entry's participant
@@ -103,7 +194,7 @@ struct AccumulatedChallengeResult<ChallengeType: CodeChallengeType> {
 
     /**
      Create a new AccumulatedChallengeResult from the given set of results. The time properties will be calculated using the given parameters to this init.
-    */
+     */
     init(name: String, results: [CodeChallengeResult<ChallengeType>], successes: Int, failures: Int) {
         self.name = name
         self.results = results
@@ -133,7 +224,7 @@ extension CodeChallengeType {
      This function calls `generateDataset()` and then runs each input in the dataset through each entry in the `entries` multiple times, concurrently. It then processes all of the `CodeChallengeResult`s into `AcummulatedChallengeResult`s for each participant and returns them sorted by `totalTime`.
 
      - Returns: An array of `AcummulatedChallengeResult`s for each participant sorted by `averageTime`.
-    */
+     */
     func runAll() -> [AccumulatedResultType] {
 
         // Generate the dataset, everybody gets the same one

CodeChallenge/Challenges/BulletMatch/BulletMatch.swift

@@ -7,77 +7,63 @@
 //
 
 import Foundation
-/**
-Forensic specialists examine spent cartridges for unique
-markings left by parts of a gun. They can then compare
-these markings to the ones in any gun to determine if there
-is a match. A match means that the bullet was fired from 
-that gun.
-
-Given two markings, one from a spent cartridge and the other
-from a suspected weapon, both as Strings, return true if they match
-and false if they don't.
-
-EXAMPLES:
-Match, returns true
-"| |||  |   |" and
-"| |||  |   |"
 
-Match, returns true though one is rotated. Bullets can be rotated.
-Your solution should account for the possible rotation of bullets.
-"|| ||| | " and
-" | || |||"
-
-Doesn't match, returns false
-"| |||  |   |" and
-"||| |  |   |"
+/**
+ Forensic specialists examine spent cartridges for unique
+ markings left by parts of a gun. They can then compare
+ these markings to the ones in any gun to determine if there
+ is a match. A match means that the bullet was fired from 
+ that gun.
+ 
+ Given two markings, one from a spent cartridge and the other
+ from a suspected weapon, both as Strings, return true if they match
+ and false if they don't.
+ 
+ EXAMPLES:
+ Match, returns true
+ "| |||  |   |" and
+ "| |||  |   |"
+ 
+ Match, returns true though one is rotated. Bullets can be rotated.
+ Your solution should account for the possible rotation of bullets.
+ "|| ||| | " and
+ " | || |||"
+ 
+ Doesn't match, returns false
+ "| |||  |   |" and
+ "||| |  |   |"
 
  NOTE: Markings cannot be flipped. 
  "| ||" is not a match for
  "|| |"
-
-Problem adapted from http://bit.ly/2h57Wxe
-*/
-
-final class BulletChallenge: CodeChallengeType {
+ 
+ Problem adapted from http://bit.ly/2h57Wxe
+ */
+final class BulletChallenge: JSONBasedChallenge {
     typealias InputType = (bulletMarkings: String, gunMarkings: String)
     typealias OutputType = Bool
 
     var title = "Bullet Challenge"
-    private let separator = "#"
+    
+    // no `protected` access level (darn you, swift gods!)
+    let fileName = "BulletMatch_dataset"
+    var verificationData: [String : OutputType] = [:]
 
     var entries: [CodeChallengeEntry<BulletChallenge>] = [
         bugKrushaBulletMatchEntry,
         codesmanBulletMatchEntry,
         juliand665BulletMatchEntry,
-        matthijsBulletMatchEntry,
+        matthijsBulletMatchEntry
     ]
 
-    func generateDataset() -> [InputType] {
-        let bundle = Bundle(for: BulletChallenge.self)
-        guard
-            let dataUrl = bundle.url(forResource: "markings_short", withExtension: "json"),
-            let data = try? Data(contentsOf: dataUrl),
-            let jsonObjects = try? JSONSerialization.jsonObject(with: data, options: .allowFragments),
-            let vd = jsonObjects as? [String: Bool]
-            else { fatalError() }
-        
-        verificationData = vd
-        let markings = verificationData.keys.map { key -> (String, String) in
-            let components = key.components(separatedBy: self.separator)
-            let gunMarkings = components[1]
-            let bulletMarkings = components[0]
-            return (bulletMarkings: bulletMarkings, gunMarkings: gunMarkings)
-        }
-
-        return Array(markings)
+    func input(from raw: String) -> InputType {
+        let components = raw.components(separatedBy: "#")
+        let gunMarkings = components[1]
+        let bulletMarkings = components[0]
+        return (bulletMarkings: bulletMarkings, gunMarkings: gunMarkings)
     }
 
-    func verifyOutput(_ output: Bool, forInput input: (bulletMarkings: String, gunMarkings: String)) -> Bool {
-        return verificationData[input.bulletMarkings + separator + input.gunMarkings] == output
+    func raw(from input: InputType) -> String {
+        return "\(input.bulletMarkings)#\(input.gunMarkings)"
     }
 }
-
-private var verificationData = [String: Bool]()
-
-

CodeChallenge/Challenges/markings_short.json renamed to CodeChallenge/Challenges/BulletMatch/BulletMatch_dataset.json

@@ -8,17 +8,19 @@
 
 import Foundation
 
-let juliand665BulletMatchEntry = CodeChallengeEntry<BulletChallenge>(name: "juliand665") { (bullet, gun) in
-	var bul = bullet
-	
-	for _ in 1 ... bul.characters.count {
-		// equate
-		if bul == gun {
-			return true
-		}
-		// rotate
-		bul.characters.append(bul.characters.popFirst()!)
-	}
-	
-	return false
+let juliand665BulletMatchEntry = CodeChallengeEntry<BulletChallenge>(name: "juliand665", block: compare)
+
+private func compare(bullet: String, gun: String) -> Bool {
+    var bul = bullet
+    
+    for _ in 1 ... bul.characters.count {
+        // equate
+        if bul == gun {
+            return true
+        }
+        // rotate
+        bul.characters.append(bul.characters.popFirst()!)
+    }
+    
+    return false
 }