1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
|
/*
This source file is part of the Swift.org open source project
Copyright (c) 2021 Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See https://swift.org/LICENSE.txt for license information
See https://swift.org/CONTRIBUTORS.txt for Swift project authors
*/
/// A generic high impact section that may be rendered differently depending on the page type.
public struct IntroRenderSection: RenderSection, Equatable {
public let kind: RenderSectionKind = .hero
/// The title of the intro.
public var title: String
/// If defined for a Tutorial page, the parent chapter of the tutorial.
public var chapter: String?
/// An estimation, in minutes, of how much time is needed to read a documentation page.
public var estimatedTimeInMinutes: Int?
/// An Xcode requirement.
///
/// This is the minimum version of Xcode that is required in order to follow this tutorial.
public var xcodeRequirement: RenderReferenceIdentifier?
/// An image to display behind the section.
public var backgroundImage: RenderReferenceIdentifier?
/// An action to perform.
public var action: RenderInlineContent?
/// A key image to display.
public var image: RenderReferenceIdentifier?
/// A video to display modally.
public var video: RenderReferenceIdentifier?
/// A project download reference, if available.
public var projectFiles: RenderReferenceIdentifier?
/// Arbitrary content to display under the subheading.
public var content: [RenderBlockContent] = []
/// Creates a new generic introductory section.
///
/// - Parameter title: The title of the section.
public init(title: String) {
self.title = title
}
public init(from decoder: Decoder) throws {
let container = try decoder.container(keyedBy: CodingKeys.self)
title = try container.decode(String.self, forKey: .title)
chapter = try container.decodeIfPresent(String.self, forKey: .chapter)
estimatedTimeInMinutes = try container.decodeIfPresent(Int.self, forKey: .estimatedTimeInMinutes)
xcodeRequirement = try container.decodeIfPresent(RenderReferenceIdentifier.self, forKey: .xcodeRequirement)
backgroundImage = try container.decodeIfPresent(RenderReferenceIdentifier.self, forKey: .backgroundImage)
action = try container.decodeIfPresent(RenderInlineContent.self, forKey: .action)
image = try container.decodeIfPresent(RenderReferenceIdentifier.self, forKey: .image)
video = try container.decodeIfPresent(RenderReferenceIdentifier.self, forKey: .video)
projectFiles = try container.decodeIfPresent(RenderReferenceIdentifier.self, forKey: .projectFiles)
content = try container.decodeIfPresent([RenderBlockContent].self, forKey: .content) ?? []
}
}
// Diffable conformance
extension IntroRenderSection: RenderJSONDiffable {
/// Returns the differences between this IntroRenderSection and the given one.
func difference(from other: IntroRenderSection, at path: CodablePath) -> JSONPatchDifferences {
var diffBuilder = DifferenceBuilder(current: self, other: other, basePath: path)
diffBuilder.addDifferences(atKeyPath: \.title, forKey: CodingKeys.title)
diffBuilder.addDifferences(atKeyPath: \.chapter, forKey: CodingKeys.chapter)
diffBuilder.addDifferences(atKeyPath: \.estimatedTimeInMinutes, forKey: CodingKeys.estimatedTimeInMinutes)
diffBuilder.addDifferences(atKeyPath: \.xcodeRequirement, forKey: CodingKeys.xcodeRequirement)
diffBuilder.addDifferences(atKeyPath: \.backgroundImage, forKey: CodingKeys.backgroundImage)
diffBuilder.addDifferences(atKeyPath: \.action, forKey: CodingKeys.action)
diffBuilder.addDifferences(atKeyPath: \.image, forKey: CodingKeys.image)
diffBuilder.addDifferences(atKeyPath: \.video, forKey: CodingKeys.video)
diffBuilder.addDifferences(atKeyPath: \.projectFiles, forKey: CodingKeys.projectFiles)
diffBuilder.addDifferences(atKeyPath: \.content, forKey: CodingKeys.content)
return diffBuilder.differences
}
/// Returns if this IntroRenderSection is similar enough to the given one.
func isSimilar(to other: IntroRenderSection) -> Bool {
return self.title == other.title || self.content == other.content
}
}
|
