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
94
95
96
97
98
99
100
|
/*
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
*/
import Foundation
/// A section that lists a pre-defined list of possible values for a given symbol.
///
/// For example, a property list key setting a target platform has allowed values of: "ppc", "i386", and "arm".
public struct PossibleValuesRenderSection: RenderSection, Equatable {
/// A named value and optional details content.
///
/// Some values are self-explanatory in their context like "2" or "Info.plist". For values
/// that are not, provide additional details like so:
/// - name: "Default"
/// - content: Use "Default" to load the first-available instance.
public struct NamedValue: Codable, Equatable {
/// The value name.
let name: String
/// Details content, if any.
let content: [RenderBlockContent]?
}
public var kind: RenderSectionKind = .possibleValues
/// The title for the section, `nil` by default.
public let title: String?
/// The list of named values.
public let values: [NamedValue]
/// Creates a new possible values section.
/// - Parameter title: The section title.
/// - Parameter values: The list of values for this section.
public init(title: String, values: [NamedValue]) {
self.title = title
self.values = values
}
// MARK: - Codable
/// The list of keys you use to encode or decode this section.
public enum CodingKeys: String, CodingKey {
case kind, title, values
}
public init(from decoder: Decoder) throws {
let container = try decoder.container(keyedBy: CodingKeys.self)
title = try container.decodeIfPresent(String.self, forKey: .title)
values = try container.decode([NamedValue].self, forKey: .values)
}
public func encode(to encoder: Encoder) throws {
var container = encoder.container(keyedBy: CodingKeys.self)
try container.encode(kind, forKey: .kind)
try container.encode(title, forKey: .title)
try container.encode(values, forKey: .values)
}
}
// Diffable conformance
extension PossibleValuesRenderSection: RenderJSONDiffable {
/// Returns the differences between this PossibleValuesRenderSection and the given one.
func difference(from other: PossibleValuesRenderSection, at path: CodablePath) -> JSONPatchDifferences {
var diffBuilder = DifferenceBuilder(current: self, other: other, basePath: path)
diffBuilder.addDifferences(atKeyPath: \.kind, forKey: CodingKeys.kind)
diffBuilder.addDifferences(atKeyPath: \.title, forKey: CodingKeys.title)
diffBuilder.addDifferences(atKeyPath: \.values, forKey: CodingKeys.values)
return diffBuilder.differences
}
/// Returns if this PossibleValuesRenderSection is similar enough to the given one.
func isSimilar(to other: PossibleValuesRenderSection) -> Bool {
return self.title == other.title || self.values == other.values
}
}
// Diffable conformance
extension PossibleValuesRenderSection.NamedValue: RenderJSONDiffable {
/// Returns the differences between this NamedValue and the given one.
func difference(from other: PossibleValuesRenderSection.NamedValue, at path: CodablePath) -> JSONPatchDifferences {
var diffBuilder = DifferenceBuilder(current: self, other: other, basePath: path)
diffBuilder.addDifferences(atKeyPath: \.name, forKey: CodingKeys.name)
diffBuilder.addDifferences(atKeyPath: \.content, forKey: CodingKeys.content)
return diffBuilder.differences
}
/// Returns if this NamedValue is similar enough to the given one.
func isSimilar(to other: PossibleValuesRenderSection.NamedValue) -> Bool {
return self.name == other.name || self.content == other.content
}
}
|
