Test for the tool

Author: ikhvorost

Sources/SwiftSource/SwiftAccessLevel.swift

@@ -24,7 +24,7 @@
 import SwiftSyntax
 
 
-public enum SwiftAccessLevel: Int {
+public enum SwiftAccessLevel: Int, Decodable {
   case `open`
   case `public`
   case `internal`

Sources/SwiftSource/SwiftComment.swift

@@ -24,34 +24,26 @@
 import SwiftSyntax
 
 
-public struct SwiftComment {
-  private let piece: TriviaPiece
-  
-  public var text: String {
-    switch piece {
-      case .lineComment(let text): return text
-      case .blockComment(let text): return text
-      case .docLineComment(let text): return text
-      case .docBlockComment(let text): return text
-      default: return ""
-    }
-  }
-  
-  public var isDoc: Bool {
-    switch piece {
-      case .docLineComment: fallthrough
-      case .docBlockComment: return true
-      default: return false
-    }
-  }
+public struct SwiftComment: Decodable {
+  public let text: String
+  public var isDoc: Bool
 
   init?(piece: TriviaPiece) {
     switch piece {
-      case .lineComment: fallthrough
-      case .blockComment: fallthrough
-      case .docLineComment: fallthrough
-      case .docBlockComment: self.piece = piece
-      default: return nil
+      case .lineComment(let value):
+        text = value
+        isDoc = false
+      case .blockComment(let value):
+        text = value
+        isDoc = false
+      case .docLineComment(let value):
+        text = value
+        isDoc = true
+      case .docBlockComment(let value):
+        text = value
+        isDoc = true
+      default:
+        return nil
     }
   }
 }

Sources/SwiftSource/SwiftDeclaration.swift

@@ -47,7 +47,7 @@ fileprivate struct StringBuilder {
   }
 }
 
-public struct SwiftDeclaration {
+public struct SwiftDeclaration: Decodable {
   public let comments: [SwiftComment]
   public let accessLevel: SwiftAccessLevel
   public var keyword: SwiftKeyword

Sources/SwiftSource/SwiftKeyword.swift

@@ -24,7 +24,7 @@
 import SwiftSyntax
 
 
-public enum SwiftKeyword: String {
+public enum SwiftKeyword: String, Decodable {
   case actor
   case `associatedtype`
   case `case`

Sources/SwiftSource/SwiftSource.swift

@@ -25,7 +25,7 @@ import Foundation
 import SwiftSyntax
 
 
-public struct SwiftSource {
+public struct SwiftSource: Decodable {
   public let url: URL?
   public let declarations: [SwiftDeclaration]
 

Sources/swift-doc-coverage/main.swift

@@ -54,10 +54,10 @@ struct SwiftDocCoverage: ParsableCommand {
 
   static var configuration = CommandConfiguration(
     abstract: "Generates documentation coverage statistics for Swift files.",
-    version: "1.0.0"
+    version: "1.1.0"
   )
 
-  @Argument(help: "One or more paths to a directory containing Swift files.")
+  @Argument(help: "One or more paths to directories or Swift files.")
   var inputs: [String]
 
   @Option(name: .shortAndLong, help: "An option to skip hidden files.")
@@ -75,11 +75,12 @@ struct SwiftDocCoverage: ParsableCommand {
   @Option(name: .shortAndLong, help: "The file path for generated report.")
   var output: String?
 
+  var sources: [SwiftSource] = []
+  
   mutating func run() throws {
-    var out: Output = TerminalOutput()
-    if let path = output {
-      out = try FileOutput(path: path)
-    }
+    let out: Output = output != nil
+      ? try FileOutput(path: output!)
+      : TerminalOutput()
 
     let urls = try inputs.flatMap {
       try Self.files(path: $0, ext: ".swift", skipsHiddenFiles: skipsHiddenFiles, ignoreFilenameRegex: ignoreFilenameRegex)
@@ -94,7 +95,7 @@ struct SwiftDocCoverage: ParsableCommand {
     let minAccessLevel = minimumAccessLevel.accessLevel.rawValue
 
     // Sources
-    let sources: [SwiftSource] = try urls.map { url in
+    sources = try urls.map { url in
       let sourceTime = Date()
 
       let source = try SwiftSource(fileURL: url)
@@ -142,7 +143,13 @@ struct SwiftDocCoverage: ParsableCommand {
     }
   }
 
-  static func files(path: String, ext: String, skipsHiddenFiles: Bool, ignoreFilenameRegex: String) throws -> [URL]  {
+  static func run(_ arguments: [String]? = nil) throws -> Self {
+    var cmd = try Self.parse(arguments)
+    try cmd.run()
+    return cmd
+  }
+  
+  static func files(path: String, ext: String, skipsHiddenFiles: Bool, ignoreFilenameRegex: String) throws -> [URL] {
     var isDirectory: ObjCBool = false
     guard FileManager.default.fileExists(atPath: path, isDirectory: &isDirectory) else {
       throw "Path not found."

Tests/SwiftDocCoverageTests/Resources/Point.swift

@@ -1,5 +1,5 @@
 import Foundation
 
-struct Point {
+public struct Point {
   var x = 0.0, y = 0.0
 }

Tests/SwiftDocCoverageTests/Resources/Size.swift

@@ -1,5 +1,5 @@
 import Foundation
 
-struct Size {
+public struct Size {
   var width = 0.0, height = 0.0
 }

Tests/SwiftDocCoverageTests/SwiftDocCoverageTests.swift

@@ -1,13 +1,10 @@
 import XCTest
 /*@testable */import SwiftSource
+@testable import swift_doc_coverage
 
-extension String : LocalizedError {
-  public var errorDescription: String? { self }
-}
 
-func tempDirectory() -> URL {
-  let url = URL(fileURLWithPath: NSTemporaryDirectory())
-    .appendingPathComponent(ProcessInfo.processInfo.globallyUniqueString)
+func createTempDirectory() -> URL {
+  let url = URL(fileURLWithPath: NSTemporaryDirectory()).appendingPathComponent(ProcessInfo.processInfo.globallyUniqueString)
   try? FileManager.default.createDirectory(at: url, withIntermediateDirectories: true)
   return url
 }
@@ -424,20 +421,17 @@ final class DocTests: XCTestCase {
 
 final class FileTests: XCTestCase {
 
-  static let directoryURL = Bundle.module.url(forResource: "Resources", withExtension: nil, subdirectory: nil)!
-  static let fileURL =  directoryURL.appendingPathComponent("Rect/Rect.swift")
-  //static let readmeURL =  directoryURL.appendingPathComponent("README.md")
-  //static let emptyDirURL =  directoryURL.appendingPathComponent("Empty")
-  
   func test_no_file() throws {
-    let fileURL =  URL(filePath: Self.directoryURL.appendingPathComponent("File.swift").path)
+    let directoryURL = Bundle.module.url(forResource: "Resources", withExtension: nil, subdirectory: nil)!
+    let fileURL = directoryURL.appendingPathComponent("File.swift")
     XCTAssertThrowsError(try SwiftSource(fileURL: fileURL)) { error in
       XCTAssert(error.localizedDescription == "The file “File.swift” couldn’t be opened because there is no such file.")
     }
   }
 
   func test_file() throws {
-    let source = try SwiftSource(fileURL: Self.fileURL)
+    let fileURL = Bundle.module.url(forResource: "Rect", withExtension: "swift", subdirectory: "Resources/Rect")!
+    let source = try SwiftSource(fileURL: fileURL)
     XCTAssert(source.declarations.count == 4)
   }
 }
@@ -469,53 +463,60 @@ extension Process {
 
 final class ToolTests: XCTestCase {
 
-  lazy var swiftDocCoverageURL: URL = {
+  lazy var executableURL: URL = {
     Bundle(for: Self.self).bundleURL.deletingLastPathComponent().appendingPathComponent("swift-doc-coverage")
   }()
 
   let fileURL = Bundle.module.url(forResource: "Rect", withExtension: "swift", subdirectory: "Resources/Rect")!
 
-  func test_not_found() {
-    let process = Process()
-    do {
-      let output = try process.run(swiftDocCoverageURL, arguments: ["NotFound"])
-      XCTFail(output)
-    }
-    catch {
-      XCTAssert(error.localizedDescription == "Error: Path not found.")
+  func test_no_params() throws {
+    XCTAssertThrowsError(try SwiftDocCoverage.run()) { error in
+      // Error: Missing expected argument '<inputs> ...'
     }
-    XCTAssert(process.terminationStatus == EXIT_FAILURE)
   }
 
-  //  func test_directory() throws {
-  //    let coverage = try Coverage(paths: [Self.directoryURL.path])
-  //    let report = try coverage.report()
-  //
-  //    XCTAssert(report.totalCount == 4)
-  //    XCTAssert(report.totalUndocumentedCount == 2)
-  //    print(report.sources.count == 1)
-  //  }
-  
-  //  func test_empty_directory() throws {
-  //    let tempDirectory = tempDirectory()
-  //    defer { try? FileManager.default.removeItem(at: tempDirectory) }
-  //
-  //    XCTAssertThrowsError(try Coverage(paths: [tempDirectory.path])) { error in
-  //      XCTAssert(error.localizedDescription == "Swift files not found.")
-  //    }
-  //  }
+  func test_no_file() {
+    XCTAssertThrowsError(try SwiftDocCoverage.run(["File.swift"])) { error in
+      XCTAssert(error.localizedDescription == "Path not found.")
+    }
+  }
 
-  //func test_not_found() throws {
-    //    XCTAssertThrowsError(try Coverage(paths: [Self.directoryURL.appendingPathComponent("NotFound").path])) { error in
-    //      XCTAssert(error.localizedDescription == "Path not found.")
-    //    }
-  //}
+  func test_empty_directory() throws {
+    let temp = createTempDirectory()
+    defer { try? FileManager.default.removeItem(at: temp) }
+    
+    XCTAssertThrowsError(try SwiftDocCoverage.run([temp.path])) { error in
+      XCTAssert(error.localizedDescription == "Swift files not found.")
+    }
+  }
+
+  func test_file() throws {
+    let cmd = try SwiftDocCoverage.run([fileURL.path])
+    XCTAssert(cmd.sources.count == 1)
+    XCTAssert(cmd.sources[0].declarations.count == 4)
+  }
 
-  //func test_not_swift_file() throws {
-    //    XCTAssertThrowsError(try Coverage(paths: [Self.readmeURL.path])) { error in
-    //      XCTAssert(error.localizedDescription == "Not swift file.")
-    //    }
-  //}
+  func test_directory() throws {
+    let directoryURL = Bundle.module.url(forResource: "Resources", withExtension: nil, subdirectory: nil)!
+    
+    let cmd = try SwiftDocCoverage.run([directoryURL.path])
+    XCTAssert(cmd.sources.count == 5)
+    
+    XCTAssert(cmd.sources[0].url?.lastPathComponent == "Rect.swift")
+    XCTAssert(cmd.sources[0].declarations.count == 4)
+    
+    XCTAssert(cmd.sources[1].url?.lastPathComponent == "CompactRect.swift")
+    XCTAssert(cmd.sources[1].declarations.count == 4)
+    
+    XCTAssert(cmd.sources[2].url?.lastPathComponent == "AlternativeRect.swift")
+    XCTAssert(cmd.sources[2].declarations.count == 4)
+    
+    XCTAssert(cmd.sources[3].url?.lastPathComponent == "Size.swift")
+    XCTAssert(cmd.sources[3].declarations.count == 2)
+    
+    XCTAssert(cmd.sources[4].url?.lastPathComponent == "Point.swift")
+    XCTAssert(cmd.sources[4].declarations.count == 2)
+  }
 
   //  func test_no_declarations() throws {
   //    let coverage = try Coverage(paths: [Self.fileURL.path], minAccessLevel: .open)
@@ -524,30 +525,14 @@ final class ToolTests: XCTestCase {
   //    }
   //  }
 
-  //  func test_report() throws {
-  //    let coverage = try Coverage(paths: [Self.fileURL.path])
-  //    let report = try coverage.report()
-  //
-  //    XCTAssert(report.totalCount == 4)
-  //    XCTAssert(report.totalUndocumentedCount == 2)
-  //    XCTAssert(report.sources.count == 1)
-  //
-  //    try coverage.reportStatistics()
-  //  }
-  
   func test_output() throws {
     let process = Process()
-    let output = try process.run(swiftDocCoverageURL, arguments: [fileURL.path])
+    let output = try process.run(executableURL, arguments: [fileURL.path])
 
     XCTAssert(process.terminationStatus == EXIT_SUCCESS)
     XCTAssert(output.contains("Total: 50%"))
   }
 
-  //  func test_warnings() throws {
-  //    let coverage = try Coverage(paths: [Self.fileURL.path])
-  //    try coverage.reportWarnings()
-  //  }
-  
   func test_warninigs() throws {
 //    let process = Process()
 //    let output = try process.run(swiftDocCoverageURL, arguments: [fileURL.path, "--report", "warnings"])
@@ -570,12 +555,12 @@ final class ToolTests: XCTestCase {
   }
 
   func test_file_output() throws {
-    let tempDirectory = tempDirectory()
+    let tempDirectory = createTempDirectory()
     let outputFileURL = tempDirectory.appendingPathComponent("report.txt")
     defer { try? FileManager.default.removeItem(at: tempDirectory) }
 
     let process = Process()
-    let output = try process.run(swiftDocCoverageURL, arguments: [fileURL.path, "--output", outputFileURL.path])
+    let output = try process.run(executableURL, arguments: [fileURL.path, "--output", outputFileURL.path])
     XCTAssert(process.terminationStatus == EXIT_SUCCESS)
     XCTAssert(output.isEmpty)