Converted Declaration to struct

Author: ikhvorost

Sources/SwiftDocCoverage/Coverage.swift

@@ -29,7 +29,7 @@ extension String : LocalizedError {
 }
 
 public struct Coverage {
-  let sources: [Source]
+  let urls: [URL]
   let minAccessLevel: AccessLevel
   let output: Output
 
@@ -87,12 +87,11 @@ public struct Coverage {
   }()
 
   public init(paths: [String], skipsHiddenFiles: Bool = true, ignoreFilenameRegex: String = "", minAccessLevel: AccessLevel = .public, output: Output = TerminalOutput()) throws {
-    self.sources = try paths.flatMap {
+    self.urls = try paths.flatMap {
       try Self.files(path: $0, ext: ".swift", skipsHiddenFiles: skipsHiddenFiles, ignoreFilenameRegex: ignoreFilenameRegex)
     }
-    .map { try Source(url: $0) }
 
-    guard sources.count > 0 else {
+    guard urls.count > 0 else {
       throw "Swift files not found."
     }
 
@@ -120,26 +119,30 @@ public struct Coverage {
 
   @discardableResult
   public func report(_ body: ((SourceReport, TimeInterval) -> Void)? = nil) throws -> CoverageReport {
-    precondition(sources.count > 0)
+    precondition(urls.count > 0)
 
     var sourceReports = [SourceReport]()
 
-    sources.forEach { source in
+    try urls.forEach { url in
       let time = Date()
 
+      let source = try Source(url: url)
+      
       guard source.declarations.count > 0 else {
         return
       }
 
-      let declarations = source.declarations.filter { $0.accessLevel.rawValue <= self.minAccessLevel.rawValue }
+      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)
+      let sourceReport = SourceReport(path: url.absoluteString, totalCount: source.declarations.count, undocumented: undocumented)
       sourceReports.append(sourceReport)
 
       body?(sourceReport, -time.timeIntervalSinceNow)

Sources/SwiftDocCoverage/DeclProtocol.swift

@@ -24,7 +24,7 @@
 import SwiftSyntax
 
 
-protocol DeclProtocol: SyntaxProtocol {
+protocol DeclProtocol: DeclSyntaxProtocol {
 
   // var attributes: AttributeListSyntax
   var modifiers: DeclModifierListSyntax { get }

Sources/SwiftDocCoverage/Declaration.swift

@@ -35,28 +35,23 @@ fileprivate struct StringBuilder {
   }
 }
 
-public class Declaration {
-  private let decl: DeclProtocol
-  private let context: [DeclProtocol]
-  
+public struct Declaration {
+  public let comments: [Comment]
+  public let accessLevel: AccessLevel
+  public var keyword: Keyword
+  public let name: String
   public let line: Int
   public let column: Int
-  
-  public var keyword: Keyword { decl.keyword }
-  
-  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 {
+  private static func buildName(decl: DeclProtocol, path: String?) -> String {
     if decl.keyword != .`init`, decl.keyword != .subscript {
       decl.keyword.rawValue
       " "
     }
 
-    if context.count > 0 {
-      context.map { $0.name.trimmedDescription }.joined(separator: ".")
+    if let path = path {
+      path
       "."
     }
 
@@ -71,9 +66,11 @@ public class Declaration {
     }
   }
 
-  init(decl: DeclProtocol, context: [DeclProtocol], location: SourceLocation) {
-    self.decl = decl
-    self.context = context
+  init(decl: DeclProtocol, path: String?, location: SourceLocation) {
+    self.comments = decl.comments
+    self.accessLevel = decl.accessLevel
+    self.keyword = decl.keyword
+    self.name = Self.buildName(decl: decl, path: path)
     self.line = location.line
     self.column = location.column
   }

Sources/SwiftDocCoverage/Lazy.swift

@@ -23,30 +23,24 @@
 
 import Foundation
 import SwiftSyntax
-import SwiftParser
 
 
 public struct Source {
   public let url: URL?
-  public let source: String
+  public let declarations: [Declaration]
 
-  // https://oleb.net/blog/2015/12/lazy-properties-in-structs-swift/
-  public var declarations: [Declaration] {
-    Lazy.var {
-      let sourceFile = Parser.parse(source: source)
-      let converter = SourceLocationConverter(fileName: "", tree: sourceFile)
-      let visitor = Visitor(sourceFile: sourceFile, converter: converter)
-      return visitor.declarations
-    }
+  private init(url: URL?, source: String) {
+    self.url = url
+    let visitor = Visitor(source: source)
+    self.declarations = visitor.declarations
   }
-  
+    
   public init(source: String) {
-    self.url = nil
-    self.source = source
+    self.init(url: nil, source: source)
   }
 
   public init(url: URL) throws {
-    self.url = url
-    self.source = try String(contentsOf: url)
+    let source = try String(contentsOf: url)
+    self.init(url: url, source: source)
   }
 }

Sources/SwiftDocCoverage/Source.swift

@@ -22,22 +22,30 @@
 //  THE SOFTWARE.
 
 import SwiftSyntax
+import SwiftParser
 
 
 class Visitor: SyntaxVisitor {
-  var declarations = [Declaration]()
-  var context = [DeclProtocol]()
-  let converter: SourceLocationConverter
+  private var context = [DeclProtocol]()
+  private let converter: SourceLocationConverter
 
-  init(sourceFile: SourceFileSyntax, converter: SourceLocationConverter) {
-    self.converter = converter
+  private(set) var declarations = [Declaration]()
+  
+  init(source: String) {
+    let sourceFile = Parser.parse(source: source)
+    self.converter = SourceLocationConverter(fileName: "", tree: sourceFile)
     super.init(viewMode: .sourceAccurate)
     walk(sourceFile)
   }
 
   func append(decl: DeclProtocol) {
     let startLocation = decl.startLocation(converter: converter, afterLeadingTrivia: true)
-    let declaration = Declaration(decl: decl, context: context, location: startLocation)
+    
+    let path: String? = context.count > 0
+      ? context.map { $0.name.trimmedDescription }.joined(separator: ".")
+      : nil
+    
+    let declaration = Declaration(decl: decl, path: path, location: startLocation)
     declarations.append(declaration)
   }
 
@@ -59,30 +67,55 @@ class Visitor: SyntaxVisitor {
     return .visitChildren
   }
 
+  override func visitPost(_ node: ClassDeclSyntax) {
+    let decl = context.popLast()
+    assert(decl is ClassDeclSyntax)
+  }
+  
   override func visit(_ node: ActorDeclSyntax) -> SyntaxVisitorContinueKind {
     append(decl: node)
     context.append(node)
     return .visitChildren
   }
 
+  override func visitPost(_ node: ActorDeclSyntax) {
+    let decl = context.popLast()
+    assert(decl is ActorDeclSyntax)
+  }
+  
   override func visit(_ node: StructDeclSyntax) -> SyntaxVisitorContinueKind {
     append(decl: node)
     context.append(node)
     return .visitChildren
   }
 
+  override func visitPost(_ node: StructDeclSyntax) {
+    let decl = context.popLast()
+    assert(decl is StructDeclSyntax)
+  }
+  
   override func visit(_ node: ProtocolDeclSyntax) -> SyntaxVisitorContinueKind {
     append(decl: node)
     context.append(node)
     return .visitChildren
   }
 
+  override func visitPost(_ node: ProtocolDeclSyntax) {
+    let decl = context.popLast()
+    assert(decl is ProtocolDeclSyntax)
+  }
+  
   override func visit(_ node: ExtensionDeclSyntax) -> SyntaxVisitorContinueKind {
     append(decl: node)
     context.append(node)
     return .visitChildren
   }
 
+  override func visitPost(_ node: ExtensionDeclSyntax) {
+    let decl = context.popLast()
+    assert(decl is ExtensionDeclSyntax)
+  }
+  
   override func visit(_ node: FunctionDeclSyntax) -> SyntaxVisitorContinueKind {
     append(decl: node)
     return .skipChildren
@@ -109,6 +142,11 @@ class Visitor: SyntaxVisitor {
     return .visitChildren
   }
 
+  override func visitPost(_ node: EnumDeclSyntax) {
+    let decl = context.popLast()
+    assert(decl is EnumDeclSyntax)
+  }
+  
   override func visit(_ node: EnumCaseDeclSyntax) -> SyntaxVisitorContinueKind {
     append(decl: node)
     return .skipChildren
@@ -123,36 +161,4 @@ class Visitor: SyntaxVisitor {
     append(decl: node)
     return .skipChildren
   }
-  
-  // MARK: -
-  
-  override func visitPost(_ node: ClassDeclSyntax) {
-    let decl = context.popLast()
-    assert(decl is ClassDeclSyntax)
-  }
-  
-  override func visitPost(_ node: ActorDeclSyntax) {
-    let decl = context.popLast()
-    assert(decl is ActorDeclSyntax)
-  }
-  
-  override func visitPost(_ node: EnumDeclSyntax) {
-    let decl = context.popLast()
-    assert(decl is EnumDeclSyntax)
-  }
-  
-  override func visitPost(_ node: ExtensionDeclSyntax) {
-    let decl = context.popLast()
-    assert(decl is ExtensionDeclSyntax)
-  }
-  
-  override func visitPost(_ node: ProtocolDeclSyntax) {
-    let decl = context.popLast()
-    assert(decl is ProtocolDeclSyntax)
-  }
-  
-  override func visitPost(_ node: StructDeclSyntax) {
-    let decl = context.popLast()
-    assert(decl is StructDeclSyntax)
-  }
 }