Added Comment, Keyword

Author: ikhvorost

…rces/SwiftDocCoverage/DeclComments.swift Sources/SwiftDocCoverage/Comment.swiftSources/SwiftDocCoverage/DeclComments.swift renamed to Sources/SwiftDocCoverage/Comment.swift Sources/SwiftDocCoverage/DeclComments.swift renamed to Sources/SwiftDocCoverage/Comment.swift

@@ -1,4 +1,4 @@
-//  DeclComment.swift
+//  Comment.swift
 //
 //  Created by Iurii Khvorost <iurii.khvorost@gmail.com> on 11.02.2024.
 //  Copyright © 2022 Iurii Khvorost. All rights reserved.
@@ -24,10 +24,10 @@
 import SwiftSyntax
 
 
-struct DeclComment {
-  let piece: TriviaPiece
+public struct Comment {
+  private let piece: TriviaPiece
 
-  var text: String {
+  public var text: String {
     switch piece {
       case .lineComment(let text): return text
       case .blockComment(let text): return text
@@ -37,47 +37,21 @@ struct DeclComment {
     }
   }
 
-  var isDoc: Bool {
+  public var hasDoc: Bool {
     switch piece {
-      case .docLineComment:
-        fallthrough
-      case .docBlockComment:
-        return true
-      default:
-        return true
+      case .docLineComment: fallthrough
+      case .docBlockComment: return true
+      default: return false
     }
   }
 
-  init(piece: TriviaPiece) {
-    self.piece = piece
-  }
-}
-
-struct DeclComments {
-  private let pieces: [DeclComment]
-  
-  var count: Int { pieces.count }
-  
-  var documented: Bool {
-    pieces.first { $0.isDoc } != nil
-  }
-  
-  subscript(index: Int) -> DeclComment { pieces[index] }
-  
-  init(trivia: Trivia) {
-    pieces = trivia.compactMap {
-      switch $0 {
-        case .lineComment:
-          fallthrough
-        case .blockComment:
-          fallthrough
-        case .docLineComment:
-          fallthrough
-        case .docBlockComment:
-          return DeclComment(piece: $0)
-        default:
-          return nil
-      }
+  init?(piece: TriviaPiece) {
+    switch piece {
+      case .lineComment: fallthrough
+      case .blockComment: fallthrough
+      case .docLineComment: fallthrough
+      case .docBlockComment: self.piece = piece
+      default: return nil
     }
   }
 }

Sources/SwiftDocCoverage/Coverage.swift

@@ -28,56 +28,56 @@ extension String : LocalizedError {
   public var errorDescription: String? { self }
 }
 
-fileprivate func findFiles(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."
-  }
+public struct Coverage {
+  let sources: [Source]
+  let minAccessLevel: AccessLevel
+  let output: Output
 
-  if isDirectory.boolValue {
-    var urls = [URL]()
-    
-    let regex: NSRegularExpression? = ignoreFilenameRegex.isEmpty ? nil : try NSRegularExpression(pattern: ignoreFilenameRegex)
+  private 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."
+    }
 
-    let url = URL(fileURLWithPath: path)
-    let resourceKeys = Set<URLResourceKey>([.nameKey, .isDirectoryKey])
-    let options: FileManager.DirectoryEnumerationOptions = skipsHiddenFiles ? [.skipsHiddenFiles] : []
-    if let enumerator = FileManager.default.enumerator(at: url, includingPropertiesForKeys: [.isDirectoryKey, .isHiddenKey], options: options) {
-      for case let fileURL as URL in enumerator {
-        guard let resourceValues = try? fileURL.resourceValues(forKeys: resourceKeys),
-              let isDirectory = resourceValues.isDirectory, !isDirectory,
-              let name = resourceValues.name,
-              name.hasSuffix(ext)
-        else {
-          continue
-        }
-        
-        // Skip by regex
-        if let regex = regex {
-          let fileName = fileURL.lastPathComponent
-          let range = NSRange(location: 0, length: fileName.utf16.count)
-          if regex.firstMatch(in: fileName, range: range) != nil {
+    if isDirectory.boolValue {
+      var urls = [URL]()
+      
+      let regex: NSRegularExpression? = ignoreFilenameRegex.isEmpty ? nil : try NSRegularExpression(pattern: ignoreFilenameRegex)
+      
+      let url = URL(fileURLWithPath: path)
+      let resourceKeys = Set<URLResourceKey>([.nameKey, .isDirectoryKey])
+      let options: FileManager.DirectoryEnumerationOptions = skipsHiddenFiles ? [.skipsHiddenFiles] : []
+      if let enumerator = FileManager.default.enumerator(at: url, includingPropertiesForKeys: [.isDirectoryKey, .isHiddenKey], options: options) {
+        for case let fileURL as URL in enumerator {
+          guard let resourceValues = try? fileURL.resourceValues(forKeys: resourceKeys),
+                let isDirectory = resourceValues.isDirectory, !isDirectory,
+                let name = resourceValues.name,
+                name.hasSuffix(ext)
+          else {
             continue
           }
+          
+          // Skip by regex
+          if let regex = regex {
+            let fileName = fileURL.lastPathComponent
+            let range = NSRange(location: 0, length: fileName.utf16.count)
+            if regex.firstMatch(in: fileName, range: range) != nil {
+              continue
+            }
+          }
+          
+          urls.append(fileURL)
         }
-        
-        urls.append(fileURL)
       }
+      return urls
     }
-    return urls
-  }
-  
-  guard path.hasSuffix(ext) else {
-    throw "Not swift file."
+    
+    guard path.hasSuffix(ext) else {
+      throw "Not swift file."
+    }
+    let url = URL(fileURLWithPath: path)
+    return [url]
   }
-  let url = URL(fileURLWithPath: path)
-  return [url]
-}
-
-public struct Coverage {
-  let urls: [URL]
-  let minAccessLevel: AccessLevel
-  let output: Output
 
   private let dateComponentsFormatter: DateComponentsFormatter = {
     let formatter = DateComponentsFormatter()
@@ -87,12 +87,15 @@ public struct Coverage {
   }()
 
   public init(paths: [String], skipsHiddenFiles: Bool = true, ignoreFilenameRegex: String = "", minAccessLevel: AccessLevel = .public, output: Output = TerminalOutput()) throws {
-    self.urls = try paths.flatMap {
-      try findFiles(path: $0, ext: ".swift", skipsHiddenFiles: skipsHiddenFiles, ignoreFilenameRegex: ignoreFilenameRegex)
+    self.sources = try paths.flatMap {
+      try Self.files(path: $0, ext: ".swift", skipsHiddenFiles: skipsHiddenFiles, ignoreFilenameRegex: ignoreFilenameRegex)
     }
-    guard urls.count > 0 else {
+    .map { try Source(url: $0) }
+    
+    guard sources.count > 0 else {
       throw "Swift files not found."
     }
+    
     self.minAccessLevel = minAccessLevel
     self.output = output
   }
@@ -116,33 +119,37 @@ public struct Coverage {
   }
 
   @discardableResult
-  func report(_ body: ((SourceReport, TimeInterval) -> Void)? = nil) throws -> CoverageReport {
-    precondition(urls.count > 0)
+  public func report(_ body: ((SourceReport, TimeInterval) -> Void)? = nil) throws -> CoverageReport {
+    precondition(sources.count > 0)
 
-    var sources = [SourceReport]()
+    var sourceReports = [SourceReport]()
 
-    try urls.forEach { url in
+    sources.forEach { source in
       let time = Date()
 
-      let source = try Source(fileURL: url, minAccessLevel: minAccessLevel)
       guard source.declarations.count > 0 else {
         return
       }
 
-      let undocumented = source.undocumented.map { DeclarationReport(line: $0.line, column: $0.column, name: $0.name) }
-      let sourceReport = SourceReport(path: url.path,
-                                      totalCount: source.declarations.count,
-                                      undocumented: undocumented)
-      sources.append(sourceReport)
+      let declarations = source.declarations.filter { $0.accessLevel.rawValue <= self.minAccessLevel.rawValue }
+      
+      let undocumented: [DeclarationReport] = declarations
+        .filter {
+          $0.comments.contains { $0.hasDoc == false }
+        }
+        .map { DeclarationReport(line: $0.line, column: $0.column, name: $0.name) }
+      
+      let sourceReport = SourceReport(path: source.url!.absoluteString, totalCount: source.declarations.count, undocumented: undocumented)
+      sourceReports.append(sourceReport)
 
       body?(sourceReport, -time.timeIntervalSinceNow)
     }
 
-    guard sources.count > 0 else {
+    guard sourceReports.count > 0 else {
       throw "Declarations not found."
     }
 
-    return CoverageReport(sources: sources)
+    return CoverageReport(sources: sourceReports)
   }
 
   public func reportStatistics() throws {

Sources/SwiftDocCoverage/DeclProtocol.swift

@@ -28,7 +28,7 @@ protocol DeclProtocol: SyntaxProtocol {
 
   // var attributes: AttributeListSyntax
   var modifiers: DeclModifierListSyntax { get }
-  var keyword: DeclKeyword { get }
+  var keyword: Keyword { get }
   var name: TokenSyntax { get }
 
   var genericParameterClause: GenericParameterClauseSyntax? { get }
@@ -43,48 +43,50 @@ extension DeclProtocol {
   var funcSignature: FunctionSignatureSyntax? { nil }
   var genericWhereClause: GenericWhereClauseSyntax? { nil }
 
-  var comments: DeclComments { DeclComments(trivia: leadingTrivia) }
+  var comments: [Comment] {
+    leadingTrivia.compactMap { Comment(piece: $0) }
+  }
   var accessLevel: AccessLevel { AccessLevel(modifiers: modifiers) }
 }
 
 // MARK: -
 
 extension TypeAliasDeclSyntax: DeclProtocol {
-  var keyword: DeclKeyword { .typealias }
+  var keyword: Keyword { .typealias }
 }
 
 extension AssociatedTypeDeclSyntax: DeclProtocol {
-  var keyword: DeclKeyword { .associatedtype }
+  var keyword: Keyword { .associatedtype }
 }
 
 extension ClassDeclSyntax: DeclProtocol {
-  var keyword: DeclKeyword { .class }
+  var keyword: Keyword { .class }
 }
 
 extension ActorDeclSyntax: DeclProtocol {
-  var keyword: DeclKeyword { .actor }
+  var keyword: Keyword { .actor }
 }
 
 extension StructDeclSyntax: DeclProtocol {
-  var keyword: DeclKeyword { .struct }
+  var keyword: Keyword { .struct }
 }
 
 extension ProtocolDeclSyntax: DeclProtocol {
-  var keyword: DeclKeyword { .protocol }
+  var keyword: Keyword { .protocol }
 }
 
 extension ExtensionDeclSyntax: DeclProtocol {
-  var keyword: DeclKeyword { .extension }
+  var keyword: Keyword { .extension }
   var name: TokenSyntax { TokenSyntax(.identifier(extendedType.trimmedDescription), presence: .present)}
 }
 
 extension FunctionDeclSyntax: DeclProtocol {
-  var keyword: DeclKeyword { .func }
+  var keyword: Keyword { .func }
   var funcSignature: FunctionSignatureSyntax? { signature }
 }
 
 extension InitializerDeclSyntax: DeclProtocol {
-  var keyword: DeclKeyword { .`init` }
+  var keyword: Keyword { .`init` }
 
   var name: TokenSyntax {
     let optionalMark = optionalMark?.trimmedDescription ?? ""
@@ -95,7 +97,7 @@ extension InitializerDeclSyntax: DeclProtocol {
 }
 
 extension SubscriptDeclSyntax: DeclProtocol {
-  var keyword: DeclKeyword { .subscript }
+  var keyword: Keyword { .subscript }
 
   var name: TokenSyntax {
     TokenSyntax(.identifier("subscript"), presence: .present)
@@ -107,7 +109,7 @@ extension SubscriptDeclSyntax: DeclProtocol {
 }
 
 extension VariableDeclSyntax: DeclProtocol {
-  var keyword: DeclKeyword { DeclKeyword(token: bindingSpecifier)! }
+  var keyword: Keyword { Keyword(token: bindingSpecifier)! }
 
   var name: TokenSyntax {
     let name = bindings.map { $0.pattern.trimmedDescription }.joined(separator: ",")
@@ -116,11 +118,11 @@ extension VariableDeclSyntax: DeclProtocol {
 }
 
 extension EnumDeclSyntax: DeclProtocol {
-  var keyword: DeclKeyword { .enum }
+  var keyword: Keyword { .enum }
 }
 
 extension EnumCaseDeclSyntax: DeclProtocol {
-  var keyword: DeclKeyword { .case }
+  var keyword: Keyword { .case }
 
   var name: TokenSyntax {
     let name = elements.map {
@@ -133,10 +135,10 @@ extension EnumCaseDeclSyntax: DeclProtocol {
 }
 
 extension PrecedenceGroupDeclSyntax: DeclProtocol {
-  var keyword: DeclKeyword { .precedencegroup }
+  var keyword: Keyword { .precedencegroup }
 }
 
 extension MacroDeclSyntax: DeclProtocol {
-  var keyword: DeclKeyword { .macro }
+  var keyword: Keyword { .macro }
   var funcSignature: FunctionSignatureSyntax? { signature }
 }

Sources/SwiftDocCoverage/Declaration.swift

@@ -35,17 +35,18 @@ fileprivate struct StringBuilder {
   }
 }
 
-class Declaration {
+public class Declaration {
   private let decl: DeclProtocol
   private let context: [DeclProtocol]
 
-  let line: Int
-  let column: Int
+  public let line: Int
+  public let column: Int
 
-  private(set) lazy var accessLevel: AccessLevel = { decl.accessLevel }()
-  private(set) lazy var comments: DeclComments = { decl.comments }()
+  public var keyword: Keyword { decl.keyword }
 
-  private(set) lazy var name: String = { buildName() }()
+  public private(set) lazy var accessLevel: AccessLevel = { decl.accessLevel }()
+  public private(set) lazy var comments: [Comment] = { decl.comments }()
+  public private(set) lazy var name: String = { buildName() }()
 
   @StringBuilder
   private func buildName() -> String {