implement package-collections business logic

motivation: continue the implmentation of package-collections

changes:
* implemented PackageCollectionsProtocol which is the main business logic of the feature
* added basic configuration model for the feature
* added basic validation rules for collection source
* simplfied model names to be shorter
* added relevants tests

Author: tomerd

Sources/PackageCollections/API.swift

@@ -32,23 +32,23 @@ public protocol PackageCollectionsProtocol {
     /// the ordering of `PackageCollection`s should be preserved and respected during conflict resolution.
     ///
     /// - Parameters:
-    ///   - identifers: Optional. If specified, only `PackageCollection`s with matching identifiers will be returned.
+    ///   - identifiers: Optional. If specified, only `PackageCollection`s with matching identifiers will be returned.
     ///   - profile: Optional. The `PackageCollectionProfile` context. By default the `default` profile is used.
     ///   - callback: The closure to invoke when result becomes available
-    func listPackageCollections(
-        identifers: Set<PackageCollectionsModel.PackageCollectionIdentifier>?,
+    func listCollections(
+        identifiers: Set<PackageCollectionsModel.CollectionIdentifier>?,
         in profile: PackageCollectionsModel.Profile?,
-        callback: @escaping (Result<[PackageCollectionsModel.PackageCollection], Error>) -> Void
+        callback: @escaping (Result<[PackageCollectionsModel.Collection], Error>) -> Void
     )
 
     /// Refreshes all configured package collections.
     ///
     /// - Parameters:
     ///   - profile: Optional. The `PackageCollectionProfile` context. By default the `default` profile is used.
     ///   - callback: The closure to invoke after triggering a refresh for the configured package collections.
-    func refreshPackageCollections(
+    func refreshCollections(
         in profile: PackageCollectionsModel.Profile?,
-        callback: @escaping (Result<[PackageCollectionsModel.PackageCollectionSource], Error>) -> Void
+        callback: @escaping (Result<[PackageCollectionsModel.CollectionSource], Error>) -> Void
     )
 
     /// Adds a package collection.
@@ -59,11 +59,11 @@ public protocol PackageCollectionsProtocol {
     ///            By default the new collection is appended to the end (i.e., the least relevant order).
     ///   - profile: Optional. The `PackageCollectionProfile` context. By default the `default` profile is used.
     ///   - callback: The closure to invoke with the updated `PackageCollection`s
-    func addPackageCollection(
-        _ source: PackageCollectionsModel.PackageCollectionSource,
+    func addCollection(
+        _ source: PackageCollectionsModel.CollectionSource,
         order: Int?,
         to profile: PackageCollectionsModel.Profile?,
-        callback: @escaping (Result<PackageCollectionsModel.PackageCollection, Error>) -> Void
+        callback: @escaping (Result<PackageCollectionsModel.Collection, Error>) -> Void
     )
 
     /// Removes a package collection.
@@ -72,8 +72,8 @@ public protocol PackageCollectionsProtocol {
     ///   - source: The package collection's source
     ///   - profile: Optional. The `PackageCollectionProfile` context. By default the `default` profile is used.
     ///   - callback: The closure to invoke with the updated `PackageCollection`s
-    func removePackageCollection(
-        _ source: PackageCollectionsModel.PackageCollectionSource,
+    func removeCollection(
+        _ source: PackageCollectionsModel.CollectionSource,
         from profile: PackageCollectionsModel.Profile?,
         callback: @escaping (Result<Void, Error>) -> Void
     )
@@ -85,8 +85,8 @@ public protocol PackageCollectionsProtocol {
     ///   - order: The new order that the `PackageCollection` should be positioned after the move
     ///   - profile: Optional. The `PackageCollectionProfile` context. By default the `default` profile is used.
     ///   - callback: The closure to invoke with the updated `PackageCollection`s
-    func movePackageCollection(
-        _ source: PackageCollectionsModel.PackageCollectionSource,
+    func moveCollection(
+        _ source: PackageCollectionsModel.CollectionSource,
         to order: Int,
         in profile: PackageCollectionsModel.Profile?,
         callback: @escaping (Result<Void, Error>) -> Void
@@ -98,9 +98,9 @@ public protocol PackageCollectionsProtocol {
     /// - Parameters:
     ///   - source: The package collection's source
     ///   - callback: The closure to invoke with the `PackageCollection`
-    func getPackageCollection(
-        _ source: PackageCollectionsModel.PackageCollectionSource,
-        callback: @escaping (Result<PackageCollectionsModel.PackageCollection, Error>) -> Void
+    func getCollection(
+        _ source: PackageCollectionsModel.CollectionSource,
+        callback: @escaping (Result<PackageCollectionsModel.Collection, Error>) -> Void
     )
 
     // MARK: - Package APIs
@@ -133,7 +133,7 @@ public protocol PackageCollectionsProtocol {
     ///   - profile: Optional. The `PackageCollectionProfile` context. By default the `default` profile is used.
     ///   - callback: The closure to invoke when result becomes available
     func listTargets(
-        collections: Set<PackageCollectionsModel.PackageCollectionIdentifier>?,
+        collections: Set<PackageCollectionsModel.CollectionIdentifier>?,
         in profile: PackageCollectionsModel.Profile?,
         callback: @escaping (Result<PackageCollectionsModel.TargetListResult, Error>) -> Void
     )
@@ -152,7 +152,7 @@ public protocol PackageCollectionsProtocol {
     ///   - callback: The closure to invoke when result becomes available
     func findPackages(
         _ query: String,
-        collections: Set<PackageCollectionsModel.PackageCollectionIdentifier>?,
+        collections: Set<PackageCollectionsModel.CollectionIdentifier>?,
         profile: PackageCollectionsModel.Profile?,
         callback: @escaping (Result<PackageCollectionsModel.PackageSearchResult, Error>) -> Void
     )
@@ -172,7 +172,7 @@ public protocol PackageCollectionsProtocol {
     func findTargets(
         _ query: String,
         searchType: PackageCollectionsModel.TargetSearchType?,
-        collections: Set<PackageCollectionsModel.PackageCollectionIdentifier>?,
+        collections: Set<PackageCollectionsModel.CollectionIdentifier>?,
         profile: PackageCollectionsModel.Profile?,
         callback: @escaping (Result<PackageCollectionsModel.TargetSearchResult, Error>) -> Void
     )

Sources/PackageCollections/Model/PackageSet.swift renamed to Sources/PackageCollections/Model/Collection.swift

@@ -19,9 +19,9 @@ public enum PackageCollectionsModel {}
 
 extension PackageCollectionsModel {
     /// A `PackageCollection` is a collection of packages.
-    public struct PackageCollection: Codable {
-        public typealias Identifier = PackageCollectionIdentifier
-        public typealias Source = PackageCollectionSource
+    public struct Collection: Equatable, Codable {
+        public typealias Identifier = CollectionIdentifier
+        public typealias Source = CollectionSource
 
         /// The identifier of the group
         public let identifier: Identifier
@@ -57,7 +57,7 @@ extension PackageCollectionsModel {
             createdAt: Date,
             lastProcessedAt: Date = Date()
         ) {
-            self.identifier = .init(source: source)
+            self.identifier = .init(from: source)
             self.source = source
             self.name = name
             self.description = description
@@ -71,52 +71,57 @@ extension PackageCollectionsModel {
 
 extension PackageCollectionsModel {
     /// Represents the source of a `PackageCollection`
-    public enum PackageCollectionSource: Equatable {
-        /// Package feed at URL
-        case feed(URL)
+    public struct CollectionSource: Equatable, Hashable, Codable {
+        /// Source type
+        public let type: CollectionSourceType
+
+        /// URL of the source file
+        public let url: URL
+    }
+
+    /// Represents the source type of a `PackageCollection`
+    public enum CollectionSourceType: Equatable, CaseIterable {
+        case feed
     }
 }
 
-extension PackageCollectionsModel.PackageCollectionSource: Codable {
+extension PackageCollectionsModel.CollectionSourceType: Codable {
     public enum DiscriminatorKeys: String, Codable {
         case feed
     }
 
     public enum CodingKeys: CodingKey {
         case _case
-        case url
     }
 
     public init(from decoder: Decoder) throws {
         let container = try decoder.container(keyedBy: CodingKeys.self)
         switch try container.decode(DiscriminatorKeys.self, forKey: ._case) {
         case .feed:
-            let url = try container.decode(URL.self, forKey: .url)
-            self = .feed(url)
+            self = .feed
         }
     }
 
     public func encode(to encoder: Encoder) throws {
         var container = encoder.container(keyedBy: CodingKeys.self)
         switch self {
-        case .feed(let url):
+        case .feed:
             try container.encode(DiscriminatorKeys.feed, forKey: ._case)
-            try container.encode(url, forKey: .url)
         }
     }
 }
 
 extension PackageCollectionsModel {
     /// Represents the identifier of a `PackageCollection`
-    public enum PackageCollectionIdentifier: Hashable, Comparable {
+    public enum CollectionIdentifier: Hashable, Comparable {
         /// Package feed at URL
         case feed(URL)
 
         /// Creates an `Identifier` from `Source`
-        init(source: PackageCollectionSource) {
-            switch source {
-            case .feed(let url):
-                self = .feed(url)
+        init(from source: CollectionSource) {
+            switch source.type {
+            case .feed:
+                self = .feed(source.url)
             }
         }
 
@@ -129,7 +134,7 @@ extension PackageCollectionsModel {
     }
 }
 
-extension PackageCollectionsModel.PackageCollection.Identifier: Codable {
+extension PackageCollectionsModel.CollectionIdentifier: Codable {
     public enum DiscriminatorKeys: String, Codable {
         case feed
     }
@@ -158,9 +163,9 @@ extension PackageCollectionsModel.PackageCollection.Identifier: Codable {
     }
 }
 
-extension PackageCollectionsModel.PackageCollection {
+extension PackageCollectionsModel.Collection {
     /// A representation of package metadata
-    public struct Package: Codable {
+    public struct Package: Equatable, Codable {
         public typealias Version = PackageVersion
 
         /// Package reference
@@ -194,9 +199,9 @@ extension PackageCollectionsModel.PackageCollection {
     }
 }
 
-extension PackageCollectionsModel.PackageCollection {
+extension PackageCollectionsModel.Collection {
     /// A representation of package version
-    public struct PackageVersion: Codable {
+    public struct PackageVersion: Equatable, Codable {
         public typealias Target = PackageCollectionsModel.PackageTarget
         public typealias Product = PackageCollectionsModel.PackageProduct
 

Sources/PackageCollections/Model/License.swift

@@ -12,7 +12,7 @@ import struct Foundation.URL
 
 extension PackageCollectionsModel {
     /// A representation of a package license
-    public struct License: Codable {
+    public struct License: Equatable, Codable {
         /// License type
         public let type: LicenseType
 
@@ -21,7 +21,7 @@ extension PackageCollectionsModel {
     }
 
     /// An enum of license types
-    public enum LicenseType: CaseIterable, CustomStringConvertible {
+    public enum LicenseType: Equatable, CaseIterable, CustomStringConvertible {
         // This list is taken from https://opensource.org/licenses
 
         /// Apache License 2.0

Sources/PackageCollections/Model/Package.swift

@@ -124,7 +124,7 @@ extension PackageCollectionsModel.Package {
 
 extension PackageCollectionsModel {
     /// A representation of package target
-    public struct PackageTarget: Codable {
+    public struct PackageTarget: Equatable, Codable {
         /// The target name
         public let name: String
 
@@ -135,7 +135,7 @@ extension PackageCollectionsModel {
 
 extension PackageCollectionsModel {
     /// A representation of package product
-    public struct PackageProduct: Codable {
+    public struct PackageProduct: Equatable, Codable {
         /// The product name
         public let name: String
 
@@ -168,5 +168,5 @@ extension PackageCollectionsModel.Package {
 }
 
 extension PackageCollectionsModel {
-    public typealias PackageMetadata = (package: PackageCollectionsModel.Package, collections: [PackageCollectionsModel.PackageCollectionIdentifier])
+    public typealias PackageMetadata = (package: PackageCollectionsModel.Package, collections: [PackageCollectionsModel.CollectionIdentifier])
 }

Sources/PackageCollections/Model/Search.swift

@@ -21,7 +21,7 @@ extension PackageCollectionsModel {
             public let package: PackageCollectionsModel.Package
 
             /// Package collections that contain the package
-            public let collections: [PackageCollectionsModel.PackageCollectionIdentifier]
+            public let collections: [PackageCollectionsModel.CollectionIdentifier]
         }
     }
 
@@ -32,5 +32,8 @@ extension PackageCollectionsModel {
     }
 
     /// A representation of target in search result
-    public typealias TargetSearchResult = TargetListResult
+    public struct TargetSearchResult {
+        /// Result items of the search
+        public let items: TargetListResult
+    }
 }

Sources/PackageCollections/Model/TargetListResult.swift

@@ -14,12 +14,14 @@ import SourceControl
 import TSCUtility
 
 extension PackageCollectionsModel {
-    /// Target metadata
     public typealias TargetListResult = [TargetListItem]
 
     public struct TargetListItem {
+        public typealias Target = PackageCollectionsModel.PackageTarget
+        public typealias Package = PackageCollectionsModel.TargetListResult.Package
+
         /// Target
-        public let target: PackageCollectionsModel.PackageTarget
+        public let target: Target
 
         /// Packages where the target is found
         public let packages: [Package]
@@ -28,8 +30,8 @@ extension PackageCollectionsModel {
 
 extension PackageCollectionsModel.TargetListResult {
     /// Metadata of package that contains the target
-    public struct Package {
-        public typealias Version = PackageVersion
+    public struct Package: Hashable {
+        public typealias Version = PackageCollectionsModel.TargetListResult.PackageVersion
 
         /// Package's repository address
         public let repository: RepositorySpecifier
@@ -41,13 +43,13 @@ extension PackageCollectionsModel.TargetListResult {
         public let versions: [Version]
 
         /// Package collections that contain this package and at least one of the `versions`
-        public let collections: [PackageCollectionsModel.PackageCollectionIdentifier]
+        public let collections: [PackageCollectionsModel.CollectionIdentifier]
     }
 }
 
 extension PackageCollectionsModel.TargetListResult {
     /// Represents a package version
-    public struct PackageVersion {
+    public struct PackageVersion: Hashable {
         /// The version
         public let version: TSCUtility.Version
 

Sources/PackageCollections/PackageCollections+Configuration.swift

@@ -0,0 +1,19 @@
+/*
+ This source file is part of the Swift.org open source project
+
+ Copyright (c) 2020 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
+ */
+
+// TODO: how do we read default config values? ENV variables? user settings?
+extension PackageCollections {
+    struct Configuration {
+        let collectionMaximumByteCount: Int = 100_000
+        let maximumPackagesPerCollection: Int = 50
+        let maximumVersionsPerPackage: Int = 6 // 2 majors, 3 minors per major
+        let defaultSources: [PackageCollectionsModel.CollectionSource] = []
+    }
+}