Fix: ignore regex, access level for enum cases

Author: ikhvorost

Sources/SwiftSource/SwiftDeclaration.swift

@@ -82,9 +82,9 @@ public struct SwiftDeclaration: Codable {
     }
   }
 
-  init(decl: DeclProtocol, path: String?, location: SourceLocation) {
+  init(decl: DeclProtocol, accessLevel: SwiftAccessLevel?, path: String?, location: SourceLocation) {
     self.comments = decl.comments
-    self.accessLevel = decl.accessLevel
+    self.accessLevel = accessLevel ?? decl.accessLevel
     self.keyword = decl.keyword
     self.name = Self.buildName(decl: decl, path: path).removingNewLines()
     self.line = location.line

Sources/SwiftSource/Visitor.swift

@@ -37,14 +37,14 @@ class Visitor: SyntaxVisitor {
     walk(sourceFile)
   }
 
-  func append(decl: DeclProtocol) {
+  func append(decl: DeclProtocol, accessLevel: SwiftAccessLevel? = nil) {
     let startLocation = decl.startLocation(converter: converter, afterLeadingTrivia: true)
 
     let path: String? = context.count > 0
       ? context.map { $0.name.trimmedDescription }.joined(separator: ".")
       : nil
 
-    let declaration = SwiftDeclaration(decl: decl, path: path, location: startLocation)
+    let declaration = SwiftDeclaration(decl: decl, accessLevel: accessLevel, path: path, location: startLocation)
     declarations.append(declaration)
   }
 
@@ -147,7 +147,9 @@ class Visitor: SyntaxVisitor {
   }
 
   override func visit(_ node: EnumCaseDeclSyntax) -> SyntaxVisitorContinueKind {
-    append(decl: node)
+    let enumDecl = context.last as? EnumDeclSyntax
+    assert(enumDecl != nil)
+    append(decl: node, accessLevel: enumDecl?.accessLevel)
     return .skipChildren
   }
 

Sources/swift-doc-coverage/main.swift

@@ -73,7 +73,7 @@ struct SwiftDocCoverage: ParsableCommand {
   var skipsHiddenFiles: Bool = true
 
   @Option(name: .shortAndLong, help: "Skip source code files with file paths that match the given regular expression.")
-  var ignoreFilenameRegex: String = ""
+  var ignoreRegex: String = ""
 
   @Option(name: .shortAndLong, help: "The minimum access level of the symbols considered for coverage statistics: \(AccessLevel.open), \(AccessLevel.public), \(AccessLevel.internal), \(AccessLevel.fileprivate), \(AccessLevel.private).")
   var minimumAccessLevel: AccessLevel = .public
@@ -85,7 +85,7 @@ struct SwiftDocCoverage: ParsableCommand {
   var output: String?
 
   private enum CodingKeys: String, CodingKey {
-    case inputs, skipsHiddenFiles, ignoreFilenameRegex, minimumAccessLevel, report, output
+    case inputs, skipsHiddenFiles, ignoreRegex, minimumAccessLevel, report, output
   }
 
   var sources: [SwiftSource] = []
@@ -108,7 +108,7 @@ struct SwiftDocCoverage: ParsableCommand {
     }
 
     let urls = try inputs.flatMap {
-      try Self.files(path: $0, ext: ".swift", skipsHiddenFiles: skipsHiddenFiles, ignoreFilenameRegex: ignoreFilenameRegex)
+      try Self.files(path: $0, ext: ".swift", skipsHiddenFiles: skipsHiddenFiles, ignoreRegex: ignoreRegex)
     }
 
     guard urls.count > 0 else {
@@ -173,7 +173,7 @@ struct SwiftDocCoverage: ParsableCommand {
     return cmd
   }
 
-  static func files(path: String, ext: String, skipsHiddenFiles: Bool, ignoreFilenameRegex: String) throws -> [URL] {
+  static func files(path: String, ext: String, skipsHiddenFiles: Bool, ignoreRegex: String) throws -> [URL] {
     var isDirectory: ObjCBool = false
     guard FileManager.default.fileExists(atPath: path, isDirectory: &isDirectory) else {
       throw Errors.pathNotFound
@@ -182,9 +182,9 @@ struct SwiftDocCoverage: ParsableCommand {
     if isDirectory.boolValue {
       var urls = [URL]()
 
-      let regex: NSRegularExpression? = ignoreFilenameRegex.isEmpty
+      let regex: NSRegularExpression? = ignoreRegex.isEmpty
         ? nil
-        : try NSRegularExpression(pattern: ignoreFilenameRegex)
+        : try NSRegularExpression(pattern: ignoreRegex)
 
       let url = URL(fileURLWithPath: path)
       let resourceKeys = Set<URLResourceKey>([.nameKey, .isDirectoryKey])
@@ -201,9 +201,8 @@ struct SwiftDocCoverage: ParsableCommand {
 
           // Skip by regex
           if let regex = regex {
-            let fileName = fileURL.lastPathComponent
-            let range = NSRange(fileName.startIndex..., in: fileName)
-            if regex.firstMatch(in: fileName, range: range) != nil {
+            let path = fileURL.path
+            if regex.firstMatch(in: path, range: NSRange(path.startIndex..., in: path)) != nil {
               continue
             }
           }

Tests/SwiftDocCoverageTests/SwiftDocCoverageTests.swift

@@ -239,7 +239,7 @@ final class SourceCodeTests: XCTestCase {
   func test_enum() {
     let code =
     """
-    enum CompassPoint {
+    public enum CompassPoint {
       case north, south
       case east
       case west
@@ -249,12 +249,24 @@ final class SourceCodeTests: XCTestCase {
     """
     let source = SwiftSource(source: code)
     XCTAssert(source.declarations.count == 6)
+    
     XCTAssert(source.declarations[0].name == "enum CompassPoint")
+    XCTAssert(source.declarations[0].accessLevel == .public)
+    
     XCTAssert(source.declarations[1].name == "case CompassPoint.north,south")
+    XCTAssert(source.declarations[1].accessLevel == .public)
+    
     XCTAssert(source.declarations[2].name == "case CompassPoint.east")
+    XCTAssert(source.declarations[2].accessLevel == .public)
+    
     XCTAssert(source.declarations[3].name == "case CompassPoint.west")
+    XCTAssert(source.declarations[3].accessLevel == .public)
+    
     XCTAssert(source.declarations[4].name == "case CompassPoint.upc(Int, Int, Int, Int)")
+    XCTAssert(source.declarations[4].accessLevel == .public)
+    
     XCTAssert(source.declarations[5].name == "enum Planet<Item>")
+    XCTAssert(source.declarations[5].accessLevel == .internal)
   }
 
   func test_macro() {
@@ -496,7 +508,7 @@ final class SwiftDocCoverageTests: XCTestCase {
   }
 
   func test_ignore_filename_regex() throws {
-    let cmd = try SwiftDocCoverage.run(resourcesUrl.path, "--ignore-filename-regex", "Rect.swift")
+    let cmd = try SwiftDocCoverage.run(resourcesUrl.path, "--ignore-regex", "Rect.swift")
     XCTAssert(cmd.sources.count == 2)
 
     XCTAssert(cmd.sources[0].url?.lastPathComponent == "Size.swift")