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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
|
/*
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 contains a list of attributes.
public struct AttributesRenderSection: RenderSection, Equatable {
public var kind: RenderSectionKind = .attributes
/// The section title.
public let title: String
/// The list of attributes in this section.
public let attributes: [RenderAttribute]?
/// Creates a new attributes section.
/// - Parameter title: The section title.
/// - Parameter attributes: The list of attributes.
public init(title: String, attributes: [RenderAttribute]) {
self.title = title
self.attributes = attributes
}
// MARK: - Codable
/// The list of keys you use to encode or decode the section data.
public enum CodingKeys: String, CodingKey {
case kind, title, attributes
}
public init(from decoder: Decoder) throws {
let container = try decoder.container(keyedBy: CodingKeys.self)
title = try container.decode(String.self, forKey: .title)
attributes = try container.decodeIfPresent([RenderAttribute].self, forKey: .attributes)
}
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.encodeIfPresent(attributes, forKey: .attributes)
}
}
/// A single renderable attribute.
public enum RenderAttribute: Codable, Equatable {
/// The list of keys to use to encode/decode the attribute.
public enum CodingKeys: CodingKey, Hashable {
case title, value, values, kind
}
/// A list of the plain-text names of supported attributes.
public enum Kind: String, Codable {
case `default`, minimum, minimumExclusive, maximum, maximumExclusive, minimumLength, maximumLength, allowedValues, allowedTypes
}
/// A default value, for example `none`.
case `default`(String)
/// A minimum value, for example `1.0`.
case minimum(String)
/// A minimum value (excluding the given one) for example `1.0`.
case minimumExclusive(String)
/// A maximum value, for example `10.0`.
case maximum(String)
/// A maximum value (excluding the given one), for example `10.0`.
case maximumExclusive(String)
/// A minimum allowed length of a string.
case minimumLength(String)
/// A maximum allowed length of a string.
case maximumLength(String)
/// A list of allowed values, for example `none`, `some`, and `all`.
case allowedValues([String])
/// A list of allowed type declarations for the value being described,
/// for example `String`, `Int`, and `Double`.
case allowedTypes([[DeclarationRenderSection.Token]])
/// A title for this attribute.
var title: String {
switch self {
case .default: return "Default value"
case .minimum: return "Minimum"
case .minimumExclusive: return "Minimum"
case .maximum: return "Maximum"
case .maximumExclusive: return "Maximum"
case .minimumLength: return "Minimum length"
case .maximumLength: return "Maximum length"
case .allowedValues: return "Possible Values"
case .allowedTypes: return "Possible Types"
}
}
public init(from decoder: Decoder) throws {
let container = try decoder.container(keyedBy: CodingKeys.self)
switch try container.decode(Kind.self, forKey: .kind) {
case .default:
self = .default(try container.decode(String.self, forKey: .value))
case .minimum:
self = .minimum(try container.decode(String.self, forKey: .value))
case .minimumExclusive:
self = .minimumExclusive(try container.decode(String.self, forKey: .value))
case .maximum:
self = .maximum(try container.decode(String.self, forKey: .value))
case .maximumExclusive:
self = .maximumExclusive(try container.decode(String.self, forKey: .value))
case .minimumLength:
self = .minimumLength(try container.decode(String.self, forKey: .value))
case .maximumLength:
self = .maximumLength(try container.decode(String.self, forKey: .value))
case .allowedValues:
self = .allowedValues(try container.decode([String].self, forKey: .values))
case .allowedTypes:
self = .allowedTypes(try container.decode([[DeclarationRenderSection.Token]].self, forKey: .values))
}
}
public func encode(to encoder: Encoder) throws {
var container = encoder.container(keyedBy: CodingKeys.self)
switch self {
case .default(let value):
try container.encode(Kind.default, forKey: .kind)
try container.encodeIfPresent(value, forKey: .value)
case .minimum(let value):
try container.encode(Kind.minimum, forKey: .kind)
try container.encodeIfPresent(value, forKey: .value)
case .minimumExclusive(let value):
try container.encode(Kind.minimumExclusive, forKey: .kind)
try container.encodeIfPresent(value, forKey: .value)
case .maximum(let value):
try container.encode(Kind.maximum, forKey: .kind)
try container.encodeIfPresent(value, forKey: .value)
case .maximumExclusive(let value):
try container.encode(Kind.maximumExclusive, forKey: .kind)
try container.encodeIfPresent(value, forKey: .value)
case .minimumLength(let value):
try container.encode(Kind.minimumLength, forKey: .kind)
try container.encodeIfPresent(value, forKey: .value)
case .maximumLength(let value):
try container.encode(Kind.maximumLength, forKey: .kind)
try container.encodeIfPresent(value, forKey: .value)
case .allowedValues(let values):
try container.encode(Kind.allowedValues, forKey: .kind)
try container.encodeIfPresent(values, forKey: .values)
case .allowedTypes(let values):
try container.encode(Kind.allowedTypes, forKey: .kind)
try container.encodeIfPresent(values, forKey: .values)
}
}
}
// Diffable conformance
extension AttributesRenderSection: RenderJSONDiffable {
/// Returns the differences between this AttributesRenderSection and the given one.
func difference(from other: AttributesRenderSection, 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: \.attributes, forKey: CodingKeys.attributes)
return diffBuilder.differences
}
/// Returns if this AttributesRenderSection is similar enough to the given one.
func isSimilar(to other: AttributesRenderSection) -> Bool {
return self.attributes == other.attributes
}
}
|
