Rename ManagedDependency property packageRef to package

mattt · mattt · commit 36764e906255 · 2021-09-10T03:00:15.000-07:00
diff --git a/Sources/Workspace/ManagedDependency.swift b/Sources/Workspace/ManagedDependency.swift
@@ -43,7 +43,7 @@ public class ManagedDependency {
     }
 
     /// The package reference.
-    public let packageRef: PackageReference
+    public let package: PackageReference
 
     /// The state of the managed dependency.
     public let state: State
@@ -76,40 +76,40 @@ public class ManagedDependency {
     public internal(set) var basedOn: ManagedDependency?
 
     public var packageIdentity: PackageIdentity {
-        self.packageRef.identity
+        self.package.identity
     }
 
     public init(
         packageRef: PackageReference,
         subpath: RelativePath,
         checkoutState: CheckoutState
     ) {
-        self.packageRef = packageRef
+        self.package = packageRef
         self.state = .checkout(checkoutState)
         self.basedOn = nil
         self.subpath = subpath
     }
 
     /// Create a dependency present locally on the filesystem.
     public static func local(
-        packageRef: PackageReference
+        package: PackageReference
     ) -> ManagedDependency {
         return ManagedDependency(
-            packageRef: packageRef,
+            package: package,
             state: .local,
             // FIXME: This is just a fake entry, we should fix it.
-            subpath: RelativePath(packageRef.identity.description),
+            subpath: RelativePath(package.identity.description),
             basedOn: nil
         )
     }
 
     internal init(
-        packageRef: PackageReference,
+        package: PackageReference,
         state: State,
         subpath: RelativePath,
         basedOn: ManagedDependency?
     ) {
-        self.packageRef = packageRef
+        self.package = package
         self.subpath = subpath
         self.basedOn = basedOn
         self.state = state
@@ -122,7 +122,7 @@ public class ManagedDependency {
     ) {
         assert(dependency.state.isCheckout)
         self.basedOn = dependency
-        self.packageRef = dependency.packageRef
+        self.package = dependency.package
         self.subpath = subpath
         self.state = .edited(unmanagedPath)
     }
@@ -140,7 +140,7 @@ public class ManagedDependency {
 
 extension ManagedDependency: CustomStringConvertible {
     public var description: String {
-        return "<ManagedDependency: \(self.packageRef.name) \(self.state)>"
+        return "<ManagedDependency: \(self.package.name) \(self.state)>"
     }
 }
 
@@ -161,18 +161,18 @@ public final class ManagedDependencies {
     }
 
     public subscript(forIdentity identity: PackageIdentity) -> ManagedDependency? {
-        dependencyMap.values.first(where: { $0.packageRef.identity == identity })
+        dependencyMap.values.first(where: { $0.package.identity == identity })
     }
 
     public subscript(forNameOrIdentity nameOrIdentity: String) -> ManagedDependency? {
         let lowercasedNameOrIdentity = nameOrIdentity.lowercased()
         return dependencyMap.values.first(where: {
-            $0.packageRef.name == nameOrIdentity || $0.packageRef.identity.description == lowercasedNameOrIdentity
+            $0.package.name == nameOrIdentity || $0.package.identity.description == lowercasedNameOrIdentity
         })
     }
 
     public func add(_ dependency: ManagedDependency) {
-        self.dependencyMap[dependency.packageRef.location] = dependency
+        self.dependencyMap[dependency.package.location] = dependency
     }
 
     public func remove(forURL url: String) {
diff --git a/Sources/Workspace/ResolverPrecomputationProvider.swift b/Sources/Workspace/ResolverPrecomputationProvider.swift
@@ -60,7 +60,7 @@ struct ResolverPrecomputationProvider: PackageContainerProvider {
     ) {
         queue.async {
             // Start by searching manifests from the Workspace's resolved dependencies.
-            if let manifest = self.dependencyManifests.dependencies.first(where: { _, managed, _ in managed.packageRef == package }) {
+            if let manifest = self.dependencyManifests.dependencies.first(where: { _, managed, _ in managed.package == package }) {
                 let container = LocalPackageContainer(
                     package: package,
                     manifest: manifest.manifest,
@@ -158,8 +158,8 @@ private struct LocalPackageContainer: PackageContainer {
 
     // Gets the package reference from the managed dependency or computes it for root packages.
     func getUpdatedIdentifier(at boundVersion: BoundVersion) throws -> PackageReference {
-        if let packageRef = dependency?.packageRef {
-            return packageRef
+        if let package = dependency?.package {
+            return package
         } else {
             return .root(identity: self.package.identity, path: self.manifest.path)
         }
diff --git a/Sources/Workspace/Workspace.swift b/Sources/Workspace/Workspace.swift
@@ -594,7 +594,7 @@ extension Workspace {
         }
 
         // If any products are required, the rest of the package graph will supply those constraints.
-        let constraint = PackageContainerConstraint(package: dependency.packageRef, requirement: requirement, products: .nothing)
+        let constraint = PackageContainerConstraint(package: dependency.package, requirement: requirement, products: .nothing)
 
         // Run the resolution.
         try self.resolve(
@@ -986,9 +986,9 @@ extension Workspace {
         case .checkout(let checkoutState):
             return checkoutState
         case .edited:
-            diagnostics.emit(error: "dependency '\(dependency.packageRef.name)' already in edit mode")
+            diagnostics.emit(error: "dependency '\(dependency.package.name)' already in edit mode")
         case .local:
-            diagnostics.emit(error: "local dependency '\(dependency.packageRef.name)' can't be edited")
+            diagnostics.emit(error: "local dependency '\(dependency.package.name)' can't be edited")
         }
         return nil
     }
@@ -1020,10 +1020,10 @@ extension Workspace {
         if fileSystem.exists(destination) {
             // FIXME: this should not block
             let manifest = try temp_await {
-                self.loadManifest(packageIdentity: dependency.packageRef.identity,
+                self.loadManifest(packageIdentity: dependency.package.identity,
                                   packageKind: .local,
                                   packagePath: destination,
-                                  packageLocation: dependency.packageRef.repository.url,
+                                  packageLocation: dependency.package.repository.url,
                                   diagnostics: diagnostics,
                                   completion: $0)
             }
@@ -1049,7 +1049,7 @@ extension Workspace {
             // Get handle to the repository.
             // TODO: replace with async/await when available
             let handle = try temp_await {
-                repositoryManager.lookup(repository: dependency.packageRef.repository, skipUpdate: true, on: .sharedConcurrent, completion: $0)
+                repositoryManager.lookup(repository: dependency.package.repository, skipUpdate: true, on: .sharedConcurrent, completion: $0)
             }
             let repo = try handle.open()
 
@@ -1115,7 +1115,7 @@ extension Workspace {
         switch dependency.state {
         // If the dependency isn't in edit mode, we can't unedit it.
         case .checkout, .local:
-            throw WorkspaceDiagnostics.DependencyNotInEditMode(dependencyName: dependency.packageRef.name)
+            throw WorkspaceDiagnostics.DependencyNotInEditMode(dependencyName: dependency.package.name)
 
         case .edited(let path):
             if path != nil {
@@ -1151,10 +1151,10 @@ extension Workspace {
                 // Restore the original checkout.
                 //
                 // The clone method will automatically update the managed dependency state.
-                _ = try clone(package: dependency.packageRef, at: checkoutState)
+                _ = try clone(package: dependency.package, at: checkoutState)
         } else {
             // The original dependency was removed, update the managed dependency state.
-            state.dependencies.remove(forURL: dependency.packageRef.location)
+            state.dependencies.remove(forURL: dependency.package.location)
             try state.saveState()
         }
 
@@ -1183,7 +1183,7 @@ extension Workspace {
         let requiredURLs = dependencyManifests.computePackageURLs().required
 
         for dependency in state.dependencies  {
-            if requiredURLs.contains(where: { $0.location == dependency.packageRef.location }) {
+            if requiredURLs.contains(where: { $0.location == dependency.package.location }) {
                 pinsStore.pin(dependency)
             }
         }
@@ -1213,7 +1213,7 @@ fileprivate extension PinsStore {
         }
 
         self.pin(
-            packageRef: dependency.packageRef,
+            packageRef: dependency.package,
             state: checkoutState
         )
     }
@@ -1325,12 +1325,12 @@ extension Workspace {
                 switch dependency.state {
                 case .checkout(let checkout):
                     if checkout.isBranchOrRevisionBased {
-                        result.insert(dependency.packageRef)
+                        result.insert(dependency.package)
                     }
                 case .edited:
                     continue
                 case .local:
-                    result.insert(dependency.packageRef)
+                    result.insert(dependency.package)
                 }
             }
 
@@ -1397,7 +1397,7 @@ extension Workspace {
                     // FIXME: We shouldn't need to construct a new package reference object here.
                     // We should get the correct one from managed dependency object.
                     let ref = PackageReference.local(
-                        identity: managedDependency.packageRef.identity,
+                        identity: managedDependency.package.identity,
                         path: workspace.path(to: managedDependency)
                     )
                     let constraint = PackageContainerConstraint(
@@ -1426,7 +1426,7 @@ extension Workspace {
                 // FIXME: We shouldn't need to construct a new package reference object here.
                 // We should get the correct one from managed dependency object.
                 let ref = PackageReference.local(
-                    identity: managedDependency.packageRef.identity,
+                    identity: managedDependency.package.identity,
                     path: workspace.path(to: managedDependency)
                 )
                 let constraint = PackageContainerConstraint(
@@ -1475,7 +1475,7 @@ extension Workspace {
         case .edited(let path):
             return path ?? self.location.editsDirectory.appending(dependency.subpath)
         case .local:
-            return AbsolutePath(dependency.packageRef.location)
+            return AbsolutePath(dependency.package.location)
         }
     }
 
@@ -1513,9 +1513,9 @@ extension Workspace {
         let dependenciesToCheck = Array(state.dependencies)
         // Remove any managed dependency which has become a root.
         for dependency in dependenciesToCheck {
-            if root.packages.keys.contains(dependency.packageRef.identity) {
+            if root.packages.keys.contains(dependency.package.identity) {
                 diagnostics.wrap {
-                    try self.remove(package: dependency.packageRef)
+                    try self.remove(package: dependency.package)
                 }
             }
         }
@@ -1554,7 +1554,7 @@ extension Workspace {
             // prepopulate managed dependencies if we are asked to do so
             if automaticallyAddManagedDependencies {
                 dependenciesRequired.filter { $0.isLocal }.forEach { dependency in
-                    state.dependencies.add(ManagedDependency.local(packageRef: dependency.createPackageRef()))
+                    state.dependencies.add(ManagedDependency.local(package: dependency.createPackageRef()))
                 }
                 diagnostics.wrap { try state.saveState() }
             }
@@ -1628,10 +1628,10 @@ extension Workspace {
         let packagePath = path(to: managedDependency)
 
         // Load and return the manifest.
-        self.loadManifest(packageIdentity: managedDependency.packageRef.identity,
+        self.loadManifest(packageIdentity: managedDependency.package.identity,
                           packageKind: packageKind,
                           packagePath: packagePath,
-                          packageLocation: managedDependency.packageRef.location,
+                          packageLocation: managedDependency.package.location,
                           version: version,
                           diagnostics: diagnostics) { result in
             // error is added to diagnostics in the function above
@@ -1815,7 +1815,7 @@ extension Workspace {
     private func parseArtifacts(from manifests: DependencyManifests) throws -> (local: [ManagedArtifact], remote: [RemoteArtifact]) {
         let packageAndManifests: [(reference: PackageReference, manifest: Manifest)] =
             manifests.root.packages.values + // Root package and manifests.
-            manifests.dependencies.map({ manifest, managed, _ in (managed.packageRef, manifest) }) // Dependency package and manifests.
+            manifests.dependencies.map({ manifest, managed, _ in (managed.package, manifest) }) // Dependency package and manifests.
 
         var localArtifacts: [ManagedArtifact] = []
         var remoteArtifacts: [RemoteArtifact] = []
@@ -2338,11 +2338,11 @@ extension Workspace {
             case .edited, .local: continue
             }
 
-            let identity = dependency.packageRef.identity
+            let identity = dependency.package.identity
 
-            if requiredURLs.contains(where: { $0.location == dependency.packageRef.location }) {
+            if requiredURLs.contains(where: { $0.location == dependency.package.location }) {
                 // If required identity contains this dependency, it should be in the pins store.
-                if let pin = pinsStore.pinsMap[identity], pin.packageRef.location == dependency.packageRef.location {
+                if let pin = pinsStore.pinsMap[identity], pin.packageRef.location == dependency.package.location {
                     continue
                 }
             } else if !pins.contains(identity) {
@@ -2463,7 +2463,7 @@ extension Workspace {
                     return self.path(to: $0).pathString == packageRef.location
                 }) {
                     currentDependency = editedDependency
-                    let originalReference = editedDependency.basedOn!.packageRef // forced unwrap safe
+                    let originalReference = editedDependency.basedOn!.package // forced unwrap safe
                     packageStateChanges[originalReference.location] = (originalReference, .unchanged)
                 } else {
                     currentDependency = nil
@@ -2549,7 +2549,7 @@ extension Workspace {
             }
         }
         // Set the state of any old package that might have been removed.
-        for packageRef in state.dependencies.lazy.map({ $0.packageRef }) where packageStateChanges[packageRef.location] == nil {
+        for packageRef in state.dependencies.lazy.map({ $0.package }) where packageStateChanges[packageRef.location] == nil {
             packageStateChanges[packageRef.location] = (packageRef, .removed)
         }
 
@@ -2620,8 +2620,8 @@ extension Workspace {
                 switch dependency.state {
                 case .checkout(let checkoutState):
                     // If some checkout dependency has been removed, clone it again.
-                    _ = try clone(package: dependency.packageRef, at: checkoutState)
-                    diagnostics.emit(.checkedOutDependencyMissing(packageName: dependency.packageRef.name))
+                    _ = try clone(package: dependency.package, at: checkoutState)
+                    diagnostics.emit(.checkedOutDependencyMissing(packageName: dependency.package.name))
 
                 case .edited:
                     // If some edited dependency has been removed, mark it as unedited.
@@ -2631,10 +2631,10 @@ extension Workspace {
                     // of some other resolve operation (i.e. resolve, update, etc).
                     try unedit(dependency: dependency, forceRemove: true, diagnostics: diagnostics)
 
-                    diagnostics.emit(.editedDependencyMissing(packageName: dependency.packageRef.name))
+                    diagnostics.emit(.editedDependencyMissing(packageName: dependency.package.name))
 
                 case .local:
-                    state.dependencies.remove(forURL: dependency.packageRef.location)
+                    state.dependencies.remove(forURL: dependency.package.location)
                     try state.saveState()
                 }
             }
@@ -2827,7 +2827,7 @@ extension Workspace {
             checkoutState = .branch(name: branch, revision: revision)
 
         case .unversioned:
-            state.dependencies.add(ManagedDependency.local(packageRef: package))
+            state.dependencies.add(ManagedDependency.local(package: package))
             try state.saveState()
             return AbsolutePath(package.location)
         }
@@ -2856,7 +2856,7 @@ extension Workspace {
         }
 
         // Inform the delegate.
-        delegate?.removing(repository: dependency.packageRef.repository.url)
+        delegate?.removing(repository: dependency.package.repository.url)
 
         // Compute the dependency which we need to remove.
         let dependencyToRemove: ManagedDependency
@@ -2868,7 +2868,7 @@ extension Workspace {
             state.dependencies.add(dependency)
         } else {
             dependencyToRemove = dependency
-            state.dependencies.remove(forURL: dependencyToRemove.packageRef.location)
+            state.dependencies.remove(forURL: dependencyToRemove.package.location)
         }
 
         // Remove the checkout.
@@ -2882,7 +2882,7 @@ extension Workspace {
         try fileSystem.removeFileTree(dependencyPath)
 
         // Remove the clone.
-        try repositoryManager.remove(repository: dependencyToRemove.packageRef.repository)
+        try repositoryManager.remove(repository: dependencyToRemove.package.repository)
 
         // Save the state.
         try state.saveState()
diff --git a/Sources/Workspace/WorkspaceState.swift b/Sources/Workspace/WorkspaceState.swift
@@ -163,7 +163,7 @@ fileprivate struct WorkspaceStateStorage {
             let basedOn: Dependency?
 
             init(_ dependency: ManagedDependency) {
-                self.packageRef = .init(dependency.packageRef)
+                self.packageRef = .init(dependency.package)
                 self.state = .init(underlying: dependency.state)
                 self.subpath = dependency.subpath.pathString
                 self.basedOn = dependency.basedOn.map{ .init($0) }
@@ -313,7 +313,7 @@ fileprivate struct WorkspaceStateStorage {
 extension ManagedDependency {
     fileprivate convenience init(_ dependency: WorkspaceStateStorage.V4.Dependency) {
         self.init(
-            packageRef: .init(dependency.packageRef),
+            package: .init(dependency.packageRef),
             state: dependency.state.underlying,
             subpath: RelativePath(dependency.subpath),
             basedOn: dependency.basedOn.map { .init($0) }
diff --git a/Tests/PackageGraphTests/RepositoryPackageContainerProviderTests.swift b/Tests/PackageGraphTests/RepositoryPackageContainerProviderTests.swift
diff --git a/Tests/WorkspaceTests/WorkspaceTests.swift b/Tests/WorkspaceTests/WorkspaceTests.swift
