Remove unused code in RenderNodeTranslator (#960)

* Remove unused RenderNodeTranslator source

* Remove no-longer-used source parameters

* Remove other unused (or assign-only) RenderNodeTranslator properties

* Remove unused parameter in private RenderNodeTranslator method

* Update newly added tests to not pass nil for removed (unused) parameter

Author: d-ronnqvist

Sources/SwiftDocC/Converter/DocumentationContextConverter.swift

@@ -83,9 +83,8 @@ public class DocumentationContextConverter {
     /// Convert a documentation node into a render node to get a self-contained, persist-able representation of a given topic's data, so you can write it to disk, send it over a network, or otherwise process it.
     /// - Parameters:
     ///   - node: The documentation node to convert.
-    ///   - source: The source file for the documentation node.
     /// - Returns: The render node representation of the documentation node.
-    public func renderNode(for node: DocumentationNode, at source: URL?) throws -> RenderNode? {
+    public func renderNode(for node: DocumentationNode) throws -> RenderNode? {
         guard !node.isVirtual else {
             return nil
         }
@@ -94,7 +93,6 @@ public class DocumentationContextConverter {
             context: context,
             bundle: bundle,
             identifier: node.reference,
-            source: source,
             renderContext: renderContext,
             emitSymbolSourceFileURIs: shouldEmitSymbolSourceFileURIs,
             emitSymbolAccessLevels: shouldEmitSymbolAccessLevels,
@@ -103,4 +101,9 @@ public class DocumentationContextConverter {
         )
         return translator.visit(node.semantic) as? RenderNode
     }
+    
+    @available(*, deprecated, renamed: "renderNode(for:)", message: "Use 'renderNode(for:)' instead. This deprecated API will be removed after 6.1 is released")
+    public func renderNode(for node: DocumentationNode, at source: URL?) throws -> RenderNode? {
+        return try self.renderNode(for: node)
+    }
 }

Sources/SwiftDocC/Converter/DocumentationNodeConverter.swift

@@ -35,10 +35,14 @@ public struct DocumentationNodeConverter {
     /// Convert a documentation node into a render node to get a self-contained, persistable representation of a given topic's data, so you can write it to disk, send it over a network, or otherwise process it.
     /// - Parameters:
     ///   - node: The documentation node to convert.
-    ///   - source: The source file for the documentation node.
     /// - Returns: The render node representation of the documentation node.
-    public func convert(_ node: DocumentationNode, at source: URL?) throws -> RenderNode {
-        var translator = RenderNodeTranslator(context: context, bundle: bundle, identifier: node.reference, source: source)
+    public func convert(_ node: DocumentationNode) throws -> RenderNode {
+        var translator = RenderNodeTranslator(context: context, bundle: bundle, identifier: node.reference)
         return translator.visit(node.semantic) as! RenderNode
     }
+    
+    @available(*, deprecated, renamed: "convert(_:)", message: "Use 'convert(_:)' instead. This deprecated API will be removed after 6.1 is released")
+    public func convert(_ node: DocumentationNode, at source: URL?) throws -> RenderNode {
+        return try convert(node)
+    }
 }

Sources/SwiftDocC/Infrastructure/DocumentationConverter.swift

@@ -318,8 +318,6 @@ public struct DocumentationConverter: DocumentationConverterProtocol {
         var conversionProblems: [Problem] = references.concurrentPerform { identifier, results in
             // If cancelled skip all concurrent conversion work in this block.
             guard !isConversionCancelled() else { return }
-
-            let source = context.documentURL(for: identifier)
 
             // Wrap JSON encoding in an autorelease pool to avoid retaining the autoreleased ObjC objects returned by `JSONSerialization`
             autoreleasepool {
@@ -330,7 +328,7 @@ public struct DocumentationConverter: DocumentationConverterProtocol {
                         return
                     }
 
-                    guard let renderNode = try converter.renderNode(for: entity, at: source) else {
+                    guard let renderNode = try converter.renderNode(for: entity) else {
                         // No render node was produced for this entity, so just skip it.
                         return
                     }

Sources/SwiftDocC/Model/Rendering/RenderNodeTranslator.swift

@@ -45,9 +45,6 @@ public struct RenderNodeTranslator: SemanticVisitor {
     /// Whether the documentation converter should include access level information for symbols.
     var shouldEmitSymbolAccessLevels: Bool
 
-    /// Whether tutorials that are not curated in a tutorials overview should be translated.
-    var shouldRenderUncuratedTutorials: Bool = false
-    
     /// The source repository where the documentation's sources are hosted.
     var sourceRepository: SourceRepository?
 
@@ -356,7 +353,7 @@ public struct RenderNodeTranslator: SemanticVisitor {
 
     /// Returns a description of the total estimated duration to complete the tutorials of the given technology.
     /// - Returns: The estimated duration, or `nil` if there are no tutorials with time estimates.
-    private func totalEstimatedDuration(for technology: Technology) -> String? {
+    private func totalEstimatedDuration() -> String? {
         var totalDurationMinutes: Int? = nil
 
         for node in context.breadthFirstSearch(from: identifier) {
@@ -381,7 +378,7 @@ public struct RenderNodeTranslator: SemanticVisitor {
         node.metadata.title = technology.intro.title
         node.metadata.category = technology.name
         node.metadata.categoryPathComponent = identifier.url.lastPathComponent
-        node.metadata.estimatedTime = totalEstimatedDuration(for: technology)
+        node.metadata.estimatedTime = totalEstimatedDuration()
         node.metadata.role = DocumentationContentRenderer.role(for: .technology).rawValue
 
         let documentationNode = try! context.entity(with: identifier)
@@ -974,11 +971,6 @@ public struct RenderNodeTranslator: SemanticVisitor {
         return nil
     }
 
-    /// The current module context for symbols.
-    private var currentSymbolModuleName: String? = nil
-    /// The current symbol context.
-    private var currentSymbol: ResolvedTopicReference? = nil
-
     /// Renders automatically generated task groups
     private mutating func renderAutomaticTaskGroupsSection(_ taskGroups: [AutomaticTaskGroupSection], contentCompiler: inout RenderContentCompiler) -> [TaskGroupRenderSection] {
         return taskGroups.map { group in
@@ -1207,8 +1199,6 @@ public struct RenderNodeTranslator: SemanticVisitor {
 
         var node = RenderNode(identifier: identifier, kind: .symbol)
         var contentCompiler = RenderContentCompiler(context: context, bundle: bundle, identifier: identifier)
-
-        currentSymbol = identifier
 
         /*
          FIXME: We shouldn't be doing this kind of crawling here.
@@ -1673,7 +1663,6 @@ public struct RenderNodeTranslator: SemanticVisitor {
         addReferences(contentCompiler.linkReferences, to: &node)
         addReferences(linkReferences, to: &node)
 
-        currentSymbol = nil
         return node
     }
 
@@ -1745,7 +1734,6 @@ public struct RenderNodeTranslator: SemanticVisitor {
     var context: DocumentationContext
     var bundle: DocumentationBundle
     var identifier: ResolvedTopicReference
-    var source: URL?
     var imageReferences: [String: ImageReference] = [:]
     var videoReferences: [String: VideoReference] = [:]
     var fileReferences: [String: FileReference] = [:]
@@ -1952,7 +1940,6 @@ public struct RenderNodeTranslator: SemanticVisitor {
         context: DocumentationContext,
         bundle: DocumentationBundle,
         identifier: ResolvedTopicReference,
-        source: URL?,
         renderContext: RenderContext? = nil,
         emitSymbolSourceFileURIs: Bool = false,
         emitSymbolAccessLevels: Bool = false,
@@ -1962,7 +1949,6 @@ public struct RenderNodeTranslator: SemanticVisitor {
         self.context = context
         self.bundle = bundle
         self.identifier = identifier
-        self.source = source
         self.renderContext = renderContext
         self.contentRenderer = DocumentationContentRenderer(documentationContext: context, bundle: bundle)
         self.shouldEmitSymbolSourceFileURIs = emitSymbolSourceFileURIs

Tests/SwiftDocCTests/Converter/DocumentationContextConverterTests.swift

@@ -27,8 +27,8 @@ class DocumentationContextConverterTests: XCTestCase {
         for identifier in context.knownPages {
             let documentationNode = try XCTUnwrap(try context.entity(with: identifier))
 
-            let renderNode1 = try perNodeConverter.convert(documentationNode, at: nil)
-            let renderNode2 = try bulkNodeConverter.renderNode(for: documentationNode, at: nil)
+            let renderNode1 = try perNodeConverter.convert(documentationNode)
+            let renderNode2 = try bulkNodeConverter.renderNode(for: documentationNode)
 
             // Compare the two nodes are identical
             let data1 = try encoder.encode(renderNode1)
@@ -55,8 +55,7 @@ class DocumentationContextConverterTests: XCTestCase {
                 renderContext: renderContext,
                 emitSymbolSourceFileURIs: true)
 
-            let renderNode = try XCTUnwrap(documentationContextConverter.renderNode(
-                for: fillIntroducedSymbolNode, at: nil))
+            let renderNode = try XCTUnwrap(documentationContextConverter.renderNode(for: fillIntroducedSymbolNode))
             XCTAssertEqual(renderNode.metadata.sourceFileURI, "file:///tmp/FillIntroduced.swift")
         }
 
@@ -66,8 +65,7 @@ class DocumentationContextConverterTests: XCTestCase {
                 context: context,
                 renderContext: renderContext)
 
-            let renderNode = try XCTUnwrap(documentationContextConverter.renderNode(
-                for: fillIntroducedSymbolNode, at: nil))
+            let renderNode = try XCTUnwrap(documentationContextConverter.renderNode(for: fillIntroducedSymbolNode))
             XCTAssertNil(renderNode.metadata.sourceFileURI)
         }
     }
@@ -88,8 +86,7 @@ class DocumentationContextConverterTests: XCTestCase {
                 emitSymbolAccessLevels: true
             )
 
-            let renderNode = try XCTUnwrap(documentationContextConverter.renderNode(
-                for: fillIntroducedSymbolNode, at: nil))
+            let renderNode = try XCTUnwrap(documentationContextConverter.renderNode(for: fillIntroducedSymbolNode))
             XCTAssertEqual(renderNode.metadata.symbolAccessLevel, "public")
         }
 
@@ -99,8 +96,7 @@ class DocumentationContextConverterTests: XCTestCase {
                 context: context,
                 renderContext: renderContext)
 
-            let renderNode = try XCTUnwrap(documentationContextConverter.renderNode(
-                for: fillIntroducedSymbolNode, at: nil))
+            let renderNode = try XCTUnwrap(documentationContextConverter.renderNode(for: fillIntroducedSymbolNode))
             XCTAssertNil(renderNode.metadata.symbolAccessLevel)
         }
     }

Tests/SwiftDocCTests/Converter/RenderNodeCodableTests.swift

@@ -203,12 +203,7 @@ class RenderNodeCodableTests: XCTestCase {
         )
         context.topicGraph.addNode(topicGraphNode)
 
-        var translator = RenderNodeTranslator(
-            context: context,
-            bundle: bundle,
-            identifier: reference,
-            source: nil
-        )
+        var translator = RenderNodeTranslator(context: context, bundle: bundle, identifier: reference)
         let node = try XCTUnwrap(translator.visitArticle(article) as? RenderNode)
         XCTAssertEqual(node.topicSectionsStyle, .compactGrid)
 

Tests/SwiftDocCTests/Converter/TopicRenderReferenceEncoderTests.swift

@@ -170,7 +170,7 @@ class TopicRenderReferenceEncoderTests: XCTestCase {
         // For reach topic encode its render node and verify the references are in alphabetical order.
         for reference in context.knownPages {
             let node = try context.entity(with: reference)
-            let renderNode = try converter.convert(node, at: nil)
+            let renderNode = try converter.convert(node)
 
             // Get the encoded JSON as string
             let encodedData = try renderNode.encodeToJSON(with: encoder, renderReferenceCache: cache)
@@ -228,7 +228,7 @@ class TopicRenderReferenceEncoderTests: XCTestCase {
         // For reach topic encode its render node and verify the references are in alphabetical order.
         for reference in context.knownPages {
             let node = try context.entity(with: reference)
-            let renderNode = try converter.convert(node, at: nil)
+            let renderNode = try converter.convert(node)
 
             // Get the encoded JSON as string
             let encodedData = try renderNode.encodeToJSON(with: encoder)

Tests/SwiftDocCTests/Indexing/IndexingTests.swift

@@ -19,7 +19,7 @@ class IndexingTests: XCTestCase {
         let tutorialReference = ResolvedTopicReference(bundleIdentifier: "org.swift.docc.example", path: "/tutorials/Test-Bundle/TestTutorial", sourceLanguage: .swift)
         let node = try context.entity(with: tutorialReference)
         let tutorial = node.semantic as! Tutorial
-        var converter = RenderNodeTranslator(context: context, bundle: bundle, identifier: tutorialReference, source: context.documentURL(for: tutorialReference))
+        var converter = RenderNodeTranslator(context: context, bundle: bundle, identifier: tutorialReference)
         let renderNode = converter.visit(tutorial) as! RenderNode
         let indexingRecords = try renderNode.indexingRecords(onPage: tutorialReference)
         XCTAssertEqual(4, indexingRecords.count)
@@ -93,7 +93,7 @@ class IndexingTests: XCTestCase {
         let articleReference = ResolvedTopicReference(bundleIdentifier: "org.swift.docc.example", path: "/tutorials/Test-Bundle/TestTutorialArticle", sourceLanguage: .swift)
         let node = try context.entity(with: articleReference)
         let article = node.semantic as! TutorialArticle
-        var converter = RenderNodeTranslator(context: context, bundle: bundle, identifier: articleReference, source: context.documentURL(for: articleReference))
+        var converter = RenderNodeTranslator(context: context, bundle: bundle, identifier: articleReference)
         let renderNode = converter.visit(article) as! RenderNode
         let indexingRecords = try renderNode.indexingRecords(onPage: articleReference)
 
@@ -191,7 +191,7 @@ class IndexingTests: XCTestCase {
         let articleReference = ResolvedTopicReference(bundleIdentifier: "org.swift.docc.example", path: "/documentation/MyKit", sourceLanguage: .swift)
         let node = try context.entity(with: articleReference)
         let article = node.semantic as! Symbol
-        var converter = RenderNodeTranslator(context: context, bundle: bundle, identifier: articleReference, source: context.documentURL(for: articleReference))
+        var converter = RenderNodeTranslator(context: context, bundle: bundle, identifier: articleReference)
         let renderNode = converter.visit(article) as! RenderNode
         let indexingRecords = try renderNode.indexingRecords(onPage: articleReference)
 
@@ -224,7 +224,7 @@ class IndexingTests: XCTestCase {
         let articleReference = ResolvedTopicReference(bundleIdentifier: "org.swift.docc.example", path: "/documentation/MyKit/MyProtocol", sourceLanguage: .swift)
         let node = try context.entity(with: articleReference)
         let article = node.semantic as! Symbol
-        var converter = RenderNodeTranslator(context: context, bundle: bundle, identifier: articleReference, source: context.documentURL(for: articleReference))
+        var converter = RenderNodeTranslator(context: context, bundle: bundle, identifier: articleReference)
         let renderNode = converter.visit(article) as! RenderNode
         let indexingRecords = try renderNode.indexingRecords(onPage: articleReference)