initial implementation of dependencies coming from registry (#3635)

motivation: with SE-0292 accepted, we can start implementing the SwiftPM side of it

the scope of this work only includes basic infrastructure to parse dependencies coming from registry, follow up work is required to complete the feature

changes:
* add manifest support for dependencies coming from registry
* add manifest parsing support for dependencies coming from registry
* separate out registry requirement from source control requirement
* refactor manifest encoding and parsing to more clearly define dependency type and associated metadata
* make .upToNextMajor and .upToNextMinor extensions on Range<Version> to reuse across new requirement types
* non-functional manifest api cleanup, mostly moving serialization to one place
* adjust tests

Author: tomerd

Sources/Commands/Describe.swift

@@ -99,22 +99,54 @@ fileprivate struct DescribedPackage: Encodable {
     }
 
     /// Represents a package dependency for the sole purpose of generating a description.
-    struct DescribedPackageDependency: Encodable {
-        let identity: PackageIdentity
-        let name: String?
-        let url: String?
-        let requirement: PackageDependencyDescription.Requirement?
-
-        init(from dependency: PackageDependencyDescription) {
-            self.identity = dependency.identity
-            self.name = dependency.explicitNameForTargetDependencyResolutionOnly
+    enum DescribedPackageDependency: Encodable {
+        case fileSystem(name: String?, path: AbsolutePath)
+        case sourceControl(name: String?, location: String, requirement: PackageDependency.SourceControl.Requirement)
+        case registry(identity: PackageIdentity, requirement: PackageDependency.Registry.Requirement)
+
+        init(from dependency: PackageDependency) {
             switch dependency {
-            case .local(let data):
-                self.url = data.path.pathString
-                self.requirement = nil
-            case .scm(let data):
-                self.url = data.location
-                self.requirement = data.requirement
+            case .fileSystem(let settings):
+                self = .fileSystem(name: dependency.explicitNameForTargetDependencyResolutionOnly, path: settings.path)
+            case .sourceControl(let settings):
+                self = .sourceControl(name: dependency.explicitNameForTargetDependencyResolutionOnly, location: settings.location, requirement: settings.requirement)
+            case .registry(let settings):
+                self = .registry(identity: settings.identity, requirement: settings.requirement)
+            }
+        }
+
+        private enum CodingKeys: CodingKey {
+            case type
+            case name
+            case path
+            case url
+            case requirement
+            case identity
+        }
+
+        private enum Kind: String, Codable {
+            case fileSystem
+            case sourceControl
+            case registry
+        }
+
+        public func encode(to encoder: Encoder) throws {
+            var container = encoder.container(keyedBy: CodingKeys.self)
+            switch self {
+            case .fileSystem(let name, let path):
+                try container.encode(Kind.fileSystem, forKey: .type)
+                try container.encode(name, forKey: .name)
+                try container.encode(path, forKey: .path)
+            case .sourceControl(let name, let location, let requirement):
+                try container.encode(Kind.sourceControl, forKey: .type)
+                try container.encode(name, forKey: .name)
+                try container.encode(location, forKey: .url)
+                try container.encode(requirement, forKey: .requirement)
+            case .registry(let identity, let requirement):
+                try container.encode(Kind.registry, forKey: .type)
+                try container.encode(identity, forKey: .identity)
+                try container.encode(requirement, forKey: .requirement)
+
             }
         }
     }

Sources/PackageDescription/BuildSettings.swift

@@ -1,24 +1,24 @@
 /*
  This source file is part of the Swift.org open source project
-
+ 
  Copyright (c) 2018 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
-*/
+ */
 
 /// The build configuration such as debug or release.
 public struct BuildConfiguration: Encodable {
     private let config: String
-
+    
     private init(_ config: String) {
         self.config = config
     }
-
+    
     /// The debug build configuration.
     public static let debug: BuildConfiguration = BuildConfiguration("debug")
-
+    
     /// The release build configuration.
     public static let release: BuildConfiguration = BuildConfiguration("release")
 }
@@ -49,15 +49,15 @@ public struct BuildConfiguration: Encodable {
 ///         ]
 ///     ),
 public struct BuildSettingCondition: Encodable {
-
+    
     private let platforms: [Platform]?
     private let config: BuildConfiguration?
-
+    
     private init(platforms: [Platform]?, config: BuildConfiguration?) {
         self.platforms = platforms
         self.config = config
     }
-
+    
     /// Creates a build setting condition.
     ///
     /// At least one parameter is mandatory.
@@ -77,25 +77,25 @@ public struct BuildSettingCondition: Encodable {
 
 /// The underlying build setting data.
 fileprivate struct BuildSettingData: Encodable {
-
+    
     /// The name of the build setting.
     let name: String
-
+    
     /// The value of the build setting.
     let value: [String]
-
+    
     /// A condition that restricts the application of the build setting.
     let condition: BuildSettingCondition?
 }
 
 /// A C-language build setting.
 public struct CSetting: Encodable {
     private let data: BuildSettingData
-
+    
     private init(name: String, value: [String], condition: BuildSettingCondition?) {
         self.data = BuildSettingData(name: name, value: value, condition: condition)
     }
-
+    
     /// Provides a header search path relative to the target's directory.
     ///
     /// Use this setting to add a search path for headers within your target.
@@ -112,7 +112,7 @@ public struct CSetting: Encodable {
     public static func headerSearchPath(_ path: String, _ condition: BuildSettingCondition? = nil) -> CSetting {
         return CSetting(name: "headerSearchPath", value: [path], condition: condition)
     }
-
+    
     /// Defines a value for a macro.
     ///
     /// If you don't specify a value, the macro's default value is 1.
@@ -130,7 +130,7 @@ public struct CSetting: Encodable {
         }
         return CSetting(name: "define", value: [settingValue], condition: condition)
     }
-
+    
     /// Sets unsafe flags to pass arbitrary command-line flags to the corresponding build tool.
     ///
     /// As the usage of the word "unsafe" implies, the Swift Package Manager
@@ -155,11 +155,11 @@ public struct CSetting: Encodable {
 /// A CXX-language build setting.
 public struct CXXSetting: Encodable {
     private let data: BuildSettingData
-
+    
     private init(name: String, value: [String], condition: BuildSettingCondition?) {
         self.data = BuildSettingData(name: name, value: value, condition: condition)
     }
-
+    
     /// Provides a header search path relative to the target's directory.
     ///
     /// Use this setting to add a search path for headers within your target.
@@ -176,7 +176,7 @@ public struct CXXSetting: Encodable {
     public static func headerSearchPath(_ path: String, _ condition: BuildSettingCondition? = nil) -> CXXSetting {
         return CXXSetting(name: "headerSearchPath", value: [path], condition: condition)
     }
-
+    
     /// Defines a value for a macro.
     ///
     /// If you don't specify a value, the macro's default value is 1.
@@ -194,7 +194,7 @@ public struct CXXSetting: Encodable {
         }
         return CXXSetting(name: "define", value: [settingValue], condition: condition)
     }
-
+    
     /// Sets unsafe flags to pass arbitrary command-line flags to the corresponding build tool.
     ///
     /// As the usage of the word "unsafe" implies, the Swift Package Manager
@@ -218,11 +218,11 @@ public struct CXXSetting: Encodable {
 /// A Swift language build setting.
 public struct SwiftSetting: Encodable {
     private let data: BuildSettingData
-
+    
     private init(name: String, value: [String], condition: BuildSettingCondition?) {
         self.data = BuildSettingData(name: name, value: value, condition: condition)
     }
-
+    
     /// Defines a compilation condition.
     ///
     /// Use compilation conditions to only compile statements if a certain condition is true.
@@ -244,7 +244,7 @@ public struct SwiftSetting: Encodable {
     public static func define(_ name: String, _ condition: BuildSettingCondition? = nil) -> SwiftSetting {
         return SwiftSetting(name: "define", value: [name], condition: condition)
     }
-
+    
     /// Sets unsafe flags to pass arbitrary command-line flags to the corresponding build tool.
     ///
     /// As the usage of the word "unsafe" implies, the Swift Package Manager
@@ -268,11 +268,11 @@ public struct SwiftSetting: Encodable {
 /// A linker build setting.
 public struct LinkerSetting: Encodable {
     private let data: BuildSettingData
-
+    
     private init(name: String, value: [String], condition: BuildSettingCondition?) {
         self.data = BuildSettingData(name: name, value: value, condition: condition)
     }
-
+    
     /// Declares linkage to a system library.
     ///
     /// This setting is most useful when the library can't be linked
@@ -287,7 +287,7 @@ public struct LinkerSetting: Encodable {
     public static func linkedLibrary(_ library: String, _ condition: BuildSettingCondition? = nil) -> LinkerSetting {
         return LinkerSetting(name: "linkedLibrary", value: [library], condition: condition)
     }
-
+    
     /// Declares linkage to a system framework.
     ///
     /// This setting is most useful when the framework can't be linked
@@ -302,7 +302,7 @@ public struct LinkerSetting: Encodable {
     public static func linkedFramework(_ framework: String, _ condition: BuildSettingCondition? = nil) -> LinkerSetting {
         return LinkerSetting(name: "linkedFramework", value: [framework], condition: condition)
     }
-
+    
     /// Sets unsafe flags to pass arbitrary command-line flags to the corresponding build tool.
     ///
     /// As the usage of the word "unsafe" implies, the Swift Package Manager

Sources/PackageDescription/CMakeLists.txt

@@ -10,6 +10,7 @@ add_library(PackageDescription
   BuildSettings.swift
   LanguageStandardSettings.swift
   PackageDescription.swift
+  PackageDescriptionSerialization.swift
   PackageDependency.swift
   PackageRequirement.swift
   Product.swift

Sources/PackageDescription/LanguageStandardSettings.swift

@@ -163,26 +163,3 @@ public enum SwiftVersion {
     /// The value is passed as-is to the Swift compiler's `-swift-version` flag.
     case version(String)
 }
-
-extension SwiftVersion: Encodable {
-
-    public func encode(to encoder: Encoder) throws {
-        let value: String
-
-        switch self {
-        case .v3:
-            value = "3"
-        case .v4:
-            value = "4"
-        case .v4_2:
-            value = "4.2"
-        case .v5:
-            value = "5"
-        case .version(let v):
-            value = v
-        }
-
-        var container = encoder.singleValueContainer()
-        try container.encode(value)
-    }
-}