-
Notifications
You must be signed in to change notification settings - Fork 1.3k
/
PinsStore.swift
174 lines (148 loc) · 5.27 KB
/
PinsStore.swift
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
174
/*
This source file is part of the Swift.org open source project
Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See http://swift.org/LICENSE.txt for license information
See http://swift.org/CONTRIBUTORS.txt for Swift project authors
*/
import TSCBasic
import TSCUtility
import SourceControl
import PackageModel
public final class PinsStore {
public typealias PinsMap = [PackageReference.PackageIdentity: PinsStore.Pin]
public struct Pin {
/// The package reference of the pinned dependency.
public let packageRef: PackageReference
/// The pinned state.
public let state: CheckoutState
/// The product filter applied by the pin.
public let productFilter: ProductFilter
public init(
packageRef: PackageReference,
state: CheckoutState,
productFilter: ProductFilter
) {
self.packageRef = packageRef
self.state = state
self.productFilter = productFilter
}
}
/// The schema version of the resolved file.
///
/// * 1: Initial version.
static let schemaVersion: Int = 1
/// The path to the pins file.
fileprivate let pinsFile: AbsolutePath
/// The filesystem to manage the pin file on.
fileprivate var fileSystem: FileSystem
/// The pins map.
public fileprivate(set) var pinsMap: PinsMap
/// The current pins.
public var pins: AnySequence<Pin> {
return AnySequence<Pin>(pinsMap.values)
}
fileprivate let persistence: SimplePersistence
/// Create a new pins store.
///
/// - Parameters:
/// - pinsFile: Path to the pins file.
/// - fileSystem: The filesystem to manage the pin file on.
public init(pinsFile: AbsolutePath, fileSystem: FileSystem) throws {
self.pinsFile = pinsFile
self.fileSystem = fileSystem
self.persistence = SimplePersistence(
fileSystem: fileSystem,
schemaVersion: PinsStore.schemaVersion,
statePath: pinsFile,
prettyPrint: true)
pinsMap = [:]
do {
_ = try self.persistence.restoreState(self)
} catch SimplePersistence.Error.restoreFailure {
throw StringError("Package.resolved file is corrupted or malformed; fix or delete the file to continue")
}
}
/// Pin a repository at a version.
///
/// This method does not automatically write to state file.
///
/// - Parameters:
/// - packageRef: The package reference to pin.
/// - state: The state to pin at.
public func pin(
packageRef: PackageReference,
state: CheckoutState,
productFilter: ProductFilter
) {
pinsMap[packageRef.identity] = Pin(
packageRef: packageRef,
state: state,
productFilter: productFilter
)
}
/// Add a pin.
///
/// This will replace any previous pin with same package name.
public func add(_ pin: Pin) {
pinsMap[pin.packageRef.identity] = pin
}
/// Unpin all of the currently pinnned dependencies.
///
/// This method does not automatically write to state file.
public func unpinAll() {
// Reset the pins map.
pinsMap = [:]
}
/// Creates constraints based on the pins in the store.
public func createConstraints() -> [RepositoryPackageConstraint] {
return pins.map({ pin in
return RepositoryPackageConstraint(
container: pin.packageRef, requirement: pin.state.requirement(), products: pin.productFilter)
})
}
}
/// Persistence.
extension PinsStore: SimplePersistanceProtocol {
public func saveState() throws {
if pinsMap.isEmpty {
// Remove the pins file if there are zero pins to save.
//
// This can happen if all dependencies are path-based or edited
// dependencies.
return try fileSystem.removeFileTree(pinsFile)
}
try self.persistence.saveState(self)
}
public func restore(from json: JSON) throws {
self.pinsMap = try Dictionary(uniqueKeysWithValues: json.get("pins").map({ ($0.packageRef.identity, $0) }))
}
/// Saves the current state of pins.
public func toJSON() -> JSON {
return JSON([
"pins": pins.sorted(by: { $0.packageRef.identity < $1.packageRef.identity }).toJSON(),
])
}
}
// JSON.
extension PinsStore.Pin: JSONMappable, JSONSerializable, Equatable {
/// Create an instance from JSON data.
public init(json: JSON) throws {
let name: String? = json.get("package")
let url: String = try json.get("repositoryURL")
let identity = PackageReference.computeIdentity(packageURL: url)
let ref = PackageReference(identity: identity, path: url)
self.packageRef = name.flatMap(ref.with(newName:)) ?? ref
self.state = try json.get("state")
self.productFilter = try json.get("products")
}
/// Convert the pin to JSON.
public func toJSON() -> JSON {
return .init([
"package": packageRef.name.toJSON(),
"repositoryURL": packageRef.path,
"state": state,
"products": productFilter,
])
}
}