Refactor ManagedDependency to remove unnecessary helpers

Author: mattt

Sources/SPMTestSupport/MockWorkspace.swift

@@ -464,13 +464,17 @@ public final class MockWorkspace {
             }
             switch state {
             case .checkout(let checkoutState):
+                guard case .checkout(let dependencyCheckoutState) = dependency.state else {
+                    return XCTFail("Expected checked out dependency; found '\(dependency.state)' instead", file: file, line: line)
+                }
+
                 switch checkoutState {
                 case .version(let version):
-                    XCTAssertEqual(dependency.checkoutState?.version, version, file: file, line: line)
+                    XCTAssertEqual(dependencyCheckoutState.version, version, file: file, line: line)
                 case .revision(let revision):
-                    XCTAssertEqual(dependency.checkoutState?.revision.identifier, revision, file: file, line: line)
+                    XCTAssertEqual(dependencyCheckoutState.revision.identifier, revision, file: file, line: line)
                 case .branch(let branch):
-                    XCTAssertEqual(dependency.checkoutState?.branch, branch, file: file, line: line)
+                    XCTAssertEqual(dependencyCheckoutState.branch, branch, file: file, line: line)
                 }
             case .edited(let path):
                 if dependency.state != .edited(path) {

Sources/Workspace/ManagedDependency.swift

@@ -21,6 +21,8 @@ import TSCUtility
 public class ManagedDependency {
     /// Represents the state of the managed dependency.
     public enum State: Equatable {
+        // The dependency is a local package.
+        case local
 
         /// The dependency is a managed checkout.
         case checkout(CheckoutState)
@@ -31,15 +33,6 @@ public class ManagedDependency {
         /// located at the path. In other words, this dependency is being used
         /// for top of the tree style development.
         case edited(AbsolutePath?)
-
-        // The dependency is a local package.
-        case local
-
-        /// Returns true if state is checkout.
-        var isCheckout: Bool {
-            if case .checkout = self { return true }
-            return false
-        }
     }
 
     /// The package reference.
@@ -48,6 +41,12 @@ public class ManagedDependency {
     /// The state of the managed dependency.
     public let state: State
 
+    /// Returns true if state is checkout.
+    public var isCheckout: Bool {
+        if case .checkout = state { return true }
+        return false
+    }
+
     /// Returns true if the dependency is edited.
     public var isEdited: Bool {
         switch state {
@@ -58,13 +57,6 @@ public class ManagedDependency {
         }
     }
 
-    public var checkoutState: CheckoutState? {
-        if case .checkout(let checkoutState) = state {
-            return checkoutState
-        }
-        return nil
-    }
-
     /// The checked out path of the dependency on disk, relative to the workspace checkouts path.
     public let subpath: RelativePath
 
@@ -75,10 +67,6 @@ public class ManagedDependency {
     /// unedit a package.
     public internal(set) var basedOn: ManagedDependency?
 
-    public var packageIdentity: PackageIdentity {
-        self.package.identity
-    }
-
     public init(
         packageRef: PackageReference,
         subpath: RelativePath,
@@ -120,7 +108,7 @@ public class ManagedDependency {
         subpath: RelativePath,
         unmanagedPath: AbsolutePath?
     ) {
-        assert(dependency.state.isCheckout)
+        assert(dependency.isCheckout)
         self.basedOn = dependency
         self.package = dependency.package
         self.subpath = subpath

Sources/Workspace/ResolverPrecomputationProvider.swift

@@ -122,30 +122,38 @@ private struct LocalPackageContainer: PackageContainer {
 
     func getDependencies(at version: Version, productFilter: ProductFilter) throws -> [PackageContainerConstraint] {
         // Because of the implementation of `reversedVersions`, we should only get the exact same version.
-        guard case .version(version, revision: _) = dependency?.checkoutState else {
-            throw InternalError("expected version, but checkout state was \(String(describing: dependency?.checkoutState))")
+        guard case .checkout(let checkoutState) = dependency?.state else {
+            throw InternalError("expected dependency to be checked out")
         }
+
+        guard case .version = checkoutState else {
+            throw InternalError("expected version, but checkout state was \(String(describing: checkoutState))")
+        }
+
         return try manifest.dependencyConstraints(productFilter: productFilter)
     }
 
     func getDependencies(at revisionString: String, productFilter: ProductFilter) throws -> [PackageContainerConstraint] {
         // Return the dependencies if the checkout state matches the revision.
         let revision = Revision(identifier: revisionString)
-        switch dependency?.checkoutState {
-        case .branch(_, revision: revision), .revision(revision):
-            return try manifest.dependencyConstraints(productFilter: productFilter)
-        default:
+
+        guard case .checkout(let checkoutState) = dependency?.state,
+              checkoutState.isBranchOrRevisionBased,
+              checkoutState.revision == revision
+        else {
             throw ResolverPrecomputationError.differentRequirement(
                 package: self.package,
                 state: self.dependency?.state,
                 requirement: .revision(revisionString)
             )
         }
+
+        return try manifest.dependencyConstraints(productFilter: productFilter)
     }
 
     func getUnversionedDependencies(productFilter: ProductFilter) throws -> [PackageContainerConstraint] {
         // Throw an error when the dependency is not unversioned to fail resolution.
-        guard dependency?.state.isCheckout != true else {
+        guard dependency?.isCheckout != true else {
             throw ResolverPrecomputationError.differentRequirement(
                 package: package,
                 state: dependency?.state,

Sources/Workspace/Workspace.swift

@@ -1147,7 +1147,7 @@ extension Workspace {
             try fileSystem.removeFileTree(self.location.editsDirectory)
         }
 
-        if let checkoutState = dependency.basedOn?.checkoutState {
+        if case .checkout(let checkoutState) = dependency.basedOn?.state {
                 // Restore the original checkout.
                 //
                 // The clone method will automatically update the managed dependency state.
@@ -1343,7 +1343,7 @@ extension Workspace {
         func computePackageURLs() -> (required: Set<PackageReference>, missing: Set<PackageReference>) {
             let manifestsMap: [PackageIdentity: Manifest] = Dictionary(uniqueKeysWithValues:
                 self.root.packages.map { ($0.key, $0.value.manifest) } +
-                self.dependencies.map { ($0.dependency.packageIdentity, $0.manifest) }
+                self.dependencies.map { ($0.dependency.package.identity, $0.manifest) }
             )
 
             var inputIdentities: Set<PackageReference> = []