Skip to content

Remove deprecated path properties #372

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 9, 2022
Merged

Remove deprecated path properties #372

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a8bcf06
Remove deprecated path properties
d-ronnqvist Sep 6, 2022
899b75e
Merge branch 'main' into remove-deperecated-path-property
d-ronnqvist Sep 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 0 additions & 14 deletions Sources/SwiftDocC/LinkTargets/LinkDestinationSummary.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,14 +80,6 @@ public struct LinkDestinationSummary: Codable, Equatable {
/// The language of the summarized element.
public let language: SourceLanguage

/// The relative path to this element.
///
/// > Note: For elements representing on-page elements, this value will include a fragment component.
@available(*, deprecated, message: "Use 'relativePresentationURL' instead.")
public var path: String {
return relativePresentationURL.absoluteString
}

/// The relative presentation URL for this element.
public let relativePresentationURL: URL

Expand Down Expand Up @@ -171,12 +163,6 @@ public struct LinkDestinationSummary: Codable, Equatable {
/// The source language of the variant or `nil` if the kind is the same as the summarized element.
public let language: VariantValue<SourceLanguage>

/// The relative path of the variant or `nil` if the relative is the same as the summarized element.
@available(*, deprecated, message: "Use 'relativePresentationURL' instead.")
public var path: VariantValue<String> {
return relativePresentationURL?.absoluteString
}

/// The relative presentation URL of the variant or `nil` if the relative is the same as the summarized element.
public let relativePresentationURL: VariantValue<URL>

Expand Down
11 changes: 0 additions & 11 deletions Tests/SwiftDocCTests/LinkTargets/LinkDestinationSummaryTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,6 @@ class ExternalLinkableTests: XCTestCase {
let summaries = node.externallyLinkableElementSummaries(context: context, renderNode: renderNode)
let pageSummary = summaries[0]
XCTAssertEqual(pageSummary.title, "Basic Augmented Reality App 💻")
XCTAssertEqual(pageSummary.path, "/tutorials/testbundle/tutorial")
XCTAssertEqual(pageSummary.relativePresentationURL.absoluteString, "/tutorials/testbundle/tutorial")
XCTAssertEqual(pageSummary.referenceURL.absoluteString, "doc://com.test.example/tutorials/TestBundle/Tutorial")
XCTAssertEqual(pageSummary.language, .swift)
Expand All @@ -129,7 +128,6 @@ class ExternalLinkableTests: XCTestCase {

let sectionSummary = summaries[1]
XCTAssertEqual(sectionSummary.title, "Create a New AR Project 💻")
XCTAssertEqual(sectionSummary.path, "/tutorials/testbundle/tutorial#Create-a-New-AR-Project-%F0%9F%92%BB")
XCTAssertEqual(sectionSummary.relativePresentationURL.absoluteString, "/tutorials/testbundle/tutorial#Create-a-New-AR-Project-%F0%9F%92%BB")
XCTAssertEqual(sectionSummary.referenceURL.absoluteString, "doc://com.test.example/tutorials/TestBundle/Tutorial#Create-a-New-AR-Project-%F0%9F%92%BB")
XCTAssertEqual(sectionSummary.language, .swift)
Expand Down Expand Up @@ -164,7 +162,6 @@ class ExternalLinkableTests: XCTestCase {
let summary = node.externallyLinkableElementSummaries(context: context, renderNode: renderNode)[0]

XCTAssertEqual(summary.title, "MyClass")
XCTAssertEqual(summary.path, "/documentation/mykit/myclass")
XCTAssertEqual(summary.relativePresentationURL.absoluteString, "/documentation/mykit/myclass")
XCTAssertEqual(summary.referenceURL.absoluteString, "doc://org.swift.docc.example/documentation/MyKit/MyClass")
XCTAssertEqual(summary.language, .swift)
Expand Down Expand Up @@ -203,7 +200,6 @@ class ExternalLinkableTests: XCTestCase {
let summary = node.externallyLinkableElementSummaries(context: context, renderNode: renderNode)[0]

XCTAssertEqual(summary.title, "MyProtocol")
XCTAssertEqual(summary.path, "/documentation/mykit/myprotocol")
XCTAssertEqual(summary.relativePresentationURL.absoluteString, "/documentation/mykit/myprotocol")
XCTAssertEqual(summary.referenceURL.absoluteString, "doc://org.swift.docc.example/documentation/MyKit/MyProtocol")
XCTAssertEqual(summary.language, .swift)
Expand Down Expand Up @@ -239,7 +235,6 @@ class ExternalLinkableTests: XCTestCase {
let summary = node.externallyLinkableElementSummaries(context: context, renderNode: renderNode)[0]

XCTAssertEqual(summary.title, "myFunction()")
XCTAssertEqual(summary.path, "/documentation/mykit/myclass/myfunction()")
XCTAssertEqual(summary.relativePresentationURL.absoluteString, "/documentation/mykit/myclass/myfunction()")
XCTAssertEqual(summary.referenceURL.absoluteString, "doc://org.swift.docc.example/documentation/MyKit/MyClass/myFunction()")
XCTAssertEqual(summary.language, .swift)
Expand All @@ -259,7 +254,6 @@ class ExternalLinkableTests: XCTestCase {
let summary = node.externallyLinkableElementSummaries(context: context, renderNode: renderNode)[0]

XCTAssertEqual(summary.title, "globalFunction(_:considering:)")
XCTAssertEqual(summary.path, "/documentation/mykit/globalfunction(_:considering:)")
XCTAssertEqual(summary.relativePresentationURL.absoluteString, "/documentation/mykit/globalfunction(_:considering:)")
XCTAssertEqual(summary.referenceURL.absoluteString, "doc://org.swift.docc.example/documentation/MyKit/globalFunction(_:considering:)")
XCTAssertEqual(summary.language, .swift)
Expand Down Expand Up @@ -297,7 +291,6 @@ class ExternalLinkableTests: XCTestCase {
let summary = node.externallyLinkableElementSummaries(context: context, renderNode: renderNode)[0]

XCTAssertEqual(summary.title, "Bar")
XCTAssertEqual(summary.path, "/documentation/mixedlanguageframework/bar")
XCTAssertEqual(summary.relativePresentationURL.absoluteString, "/documentation/mixedlanguageframework/bar")
XCTAssertEqual(summary.referenceURL.absoluteString, "doc://org.swift.MixedLanguageFramework/documentation/MixedLanguageFramework/Bar")
XCTAssertEqual(summary.language, .swift)
Expand Down Expand Up @@ -337,7 +330,6 @@ class ExternalLinkableTests: XCTestCase {
// Check variant content that is the same as the summarized element
XCTAssertEqual(variant.title, nil)
XCTAssertEqual(variant.abstract, nil)
XCTAssertEqual(variant.path, nil)
XCTAssertEqual(variant.usr, nil)
XCTAssertEqual(variant.kind, nil)
XCTAssertEqual(variant.taskGroups, nil)
Expand All @@ -351,7 +343,6 @@ class ExternalLinkableTests: XCTestCase {
let summary = node.externallyLinkableElementSummaries(context: context, renderNode: renderNode)[0]

XCTAssertEqual(summary.title, "myStringFunction(_:)")
XCTAssertEqual(summary.path, "/documentation/mixedlanguageframework/bar/mystringfunction(_:)")
XCTAssertEqual(summary.relativePresentationURL.absoluteString, "/documentation/mixedlanguageframework/bar/mystringfunction(_:)")
XCTAssertEqual(summary.referenceURL.absoluteString, "doc://org.swift.MixedLanguageFramework/documentation/MixedLanguageFramework/Bar/myStringFunction(_:)")
XCTAssertEqual(summary.language, .swift)
Expand Down Expand Up @@ -405,7 +396,6 @@ class ExternalLinkableTests: XCTestCase {

// Check variant content that is the same as the summarized element
XCTAssertEqual(variant.abstract, nil)
XCTAssertEqual(variant.path, nil)
XCTAssertEqual(variant.usr, nil)
XCTAssertEqual(variant.kind, nil)
XCTAssertEqual(
Expand Down Expand Up @@ -474,7 +464,6 @@ class ExternalLinkableTests: XCTestCase {
XCTAssertEqual(decoded.kind, .class)
XCTAssertEqual(decoded.title, "ClassName")
XCTAssertEqual(decoded.abstract?.plainText, "A brief explanation of my class.")
XCTAssertEqual(decoded.path, "documentation/MyKit/ClassName")
XCTAssertEqual(decoded.relativePresentationURL.absoluteString, "documentation/MyKit/ClassName")
XCTAssertEqual(decoded.declarationFragments, [
.init(text: "class", kind: .keyword, identifier: nil),
Expand Down