Add loading

Author: rctcwyvrn

Sources/RegexBenchmark/BenchmarkResults.swift

@@ -1,6 +1,7 @@
 import Foundation
 
 extension BenchmarkRunner {
+  /// Attempts to save the results to the given path
   func save(to savePath: String) throws {
     let url = URL(fileURLWithPath: savePath, isDirectory: false)
     let parent = url.deletingLastPathComponent()
@@ -10,7 +11,16 @@ extension BenchmarkRunner {
     print("Saving result to \(url.path)")
     try results.save(to: url)
   }
-    
+  
+  /// Attempts to load the results from the given save file
+  mutating func load(from savePath: String) throws {
+    let url = URL(fileURLWithPath: savePath)
+    let result = try SuiteResult.load(from: url)
+    self.results = result
+    print("Loaded results from \(url.path)")
+  }
+  
+  /// Compare this runner's results against the results stored in the given file path
   func compare(against compareFilePath: String, showChart: Bool, saveTo: String?) throws {
     let compareFileURL = URL(fileURLWithPath: compareFilePath)
     let compareResult = try SuiteResult.load(from: compareFileURL)
@@ -33,6 +43,7 @@ extension BenchmarkRunner {
     displayComparisons(compileTimeComparisons, false, against: "saved benchmark result " + compareFile)
   }
 
+  /// Compares Swift Regex benchmark results against NSRegularExpression
   func compareWithNS(showChart: Bool, saveTo: String?) throws {
     let comparisons = results.compareWithNS().filter({$0.diff != nil})
     displayComparisons(comparisons, showChart, against: "NSRegularExpression (via CrossBenchmark)")

Sources/RegexBenchmark/CLI.swift

@@ -10,6 +10,9 @@ struct Runner: ParsableCommand {
 
   @Flag(help: "Debug benchmark regexes")
   var debug = false
+  
+  @Option(help: "Load results from this file instead of rerunning")
+  var load: String?
 
   @Option(help: "The file results should be saved to")
   var save: String?
@@ -34,7 +37,7 @@ struct Runner: ParsableCommand {
 
   mutating func run() throws {
     var runner = BenchmarkRunner.makeRunner(samples, quiet)
-
+    
     if !self.specificBenchmarks.isEmpty {
       runner.suite = runner.suite.filter { b in
         specificBenchmarks.contains { pattern in
@@ -44,24 +47,29 @@ struct Runner: ParsableCommand {
     }
     if debug {
       runner.debug()
+      return
+    }
+    
+    if let loadFile = load {
+      try runner.load(from: loadFile)
     } else {
       if excludeNs {
         runner.suite = runner.suite.filter { b in !b.name.contains("NS") }
       }
       runner.run()
-      if let saveFile = save {
-        try runner.save(to: saveFile)
-      }
-      if saveComparison != nil && compareWithNS && compare != nil {
-        print("Unable to save both comparison results, specify only one compare operation")
-        return
-      }
-      if compareWithNS {
-        try runner.compareWithNS(showChart: showChart, saveTo: saveComparison)
-      }
-      if let compareFile = compare {
-        try runner.compare(against: compareFile, showChart: showChart, saveTo: saveComparison)
-      }
+    }
+    if let saveFile = save {
+      try runner.save(to: saveFile)
+    }
+    if saveComparison != nil && compareWithNS && compare != nil {
+      print("Unable to save both comparison results, specify only one compare operation")
+      return
+    }
+    if compareWithNS {
+      try runner.compareWithNS(showChart: showChart, saveTo: saveComparison)
+    }
+    if let compareFile = compare {
+      try runner.compare(against: compareFile, showChart: showChart, saveTo: saveComparison)
     }
   }
 }