deprecate unused and outdated code (#246)

motivation: reduce API surface area when not needed

changes:
* deprecate ObjectIdentifierProtocol, since we have Identifiable now in the stdlib
* deprecate PackageLocation which is a SwiftPM diagnostics concern and name-squats a too general of a name
* deprecate AuthorizationProviding which is not in use and redundant
* deprecate TSCUtility.URL which is redundant and name-squats / conflict with Foundation.URL
* adjust call-sites / test

Author: tomerd

Sources/TSCBasic/ObjectIdentifierProtocol.swift

@@ -11,8 +11,10 @@
 /// A protocol which implements Hashable protocol using ObjectIdentifier.
 ///
 /// Classes can conform to this protocol to auto-conform to Hashable and Equatable.
+@available(*, deprecated, message: "user Identifiable instead")
 public protocol ObjectIdentifierProtocol: AnyObject, Hashable {}
 
+@available(*, deprecated)
 extension ObjectIdentifierProtocol {
     public func hash(into hasher: inout Hasher) {
         hasher.combine(ObjectIdentifier(self))

Sources/TSCBasic/Process.swift

@@ -119,8 +119,7 @@ public struct ProcessResult: CustomStringConvertible {
 /// Process allows spawning new subprocesses and working with them.
 ///
 /// Note: This class is thread safe.
-public final class Process: ObjectIdentifierProtocol {
-
+public final class Process {
     /// Errors when attempting to invoke a process
     public enum Error: Swift.Error {
         /// The program requested to be executed cannot be found on the existing search paths, or is not executable.
@@ -837,6 +836,16 @@ extension Process {
     }
 }
 
+extension Process: Hashable {
+    public func hash(into hasher: inout Hasher) {
+        hasher.combine(ObjectIdentifier(self))
+    }
+
+    public static func == (lhs: Process, rhs: Process) -> Bool {
+        ObjectIdentifier(lhs) == ObjectIdentifier(rhs)
+    }
+}
+
 // MARK: - Private helpers
 
 #if !os(Windows)

Sources/TSCUtility/Diagnostics.swift

@@ -186,6 +186,8 @@ extension Optional where Wrapped == DiagnosticsEngine {
 }
 
 /// Namespace for representing diagnostic location of a package.
+// deprecated 9/2021
+@available(*, deprecated)
 public enum PackageLocation {
 
     /// Represents location of a locally available package. This could be root

Sources/TSCUtility/Netrc.swift

@@ -2,11 +2,16 @@ import Foundation
 import TSCBasic
 
 /// Supplies `Authorization` header, typically to be appended to `URLRequest`
+
+// deprecated 9/2021
+@available(*, deprecated)
 public protocol AuthorizationProviding {
     /// Optional `Authorization` header, likely added to `URLRequest`
     func authorization(for url: Foundation.URL) -> String?
 }
 
+// deprecated 9/2021
+@available(*, deprecated)
 extension AuthorizationProviding {
     public func authorization(for url: Foundation.URL) -> String? {
         return nil
@@ -17,9 +22,9 @@ extension AuthorizationProviding {
  Netrc feature depends upon `NSTextCheckingResult.range(withName name: String) -> NSRange`,
  which is only available in macOS 10.13+, iOS 11+, etc at this time.
  */
-@available (macOS 10.13, iOS 11, tvOS 11, watchOS 4, *)
 /// Container of parsed netrc connection settings
-public struct Netrc: AuthorizationProviding {
+@available (macOS 10.13, iOS 11, tvOS 11, watchOS 4, *)
+public struct Netrc {
     /// Representation of `machine` connection settings & `default` connection settings.
     /// If `default` connection settings present, they will be last element.
     public let machines: [Machine]
@@ -62,7 +67,7 @@ public struct Netrc: AuthorizationProviding {
 
         let machines: [Machine] = matches.compactMap {
             return Machine(for: $0, string: content, variant: "lp") ??
-                Machine(for: $0, string: content, variant: "pl")
+            Machine(for: $0, string: content, variant: "pl")
         }
 
         if let defIndex = machines.firstIndex(where: { $0.isDefault }) {
@@ -88,6 +93,11 @@ public struct Netrc: AuthorizationProviding {
     }
 }
 
+// deprecated 9/2021
+@available(*, deprecated)
+@available (macOS 10.13, iOS 11, tvOS 11, watchOS 4, *)
+extension Netrc: AuthorizationProviding {}
+
 @available (macOS 10.13, iOS 11, tvOS 11, watchOS 4, *)
 public extension Netrc {
     enum Error: Swift.Error {
@@ -117,10 +127,10 @@ public extension Netrc {
 
         init?(for match: NSTextCheckingResult, string: String, variant: String = "") {
             guard let name = RegexUtil.Token.machine.capture(in: match, string: string) ?? RegexUtil.Token.default.capture(in: match, string: string),
-                let login = RegexUtil.Token.login.capture(prefix: variant, in: match, string: string),
-                let password = RegexUtil.Token.password.capture(prefix: variant, in: match, string: string) else {
-                    return nil
-            }
+                  let login = RegexUtil.Token.login.capture(prefix: variant, in: match, string: string),
+                  let password = RegexUtil.Token.password.capture(prefix: variant, in: match, string: string) else {
+                      return nil
+                  }
             self = Machine(name: name, login: login, password: password)
         }
     }

Sources/TSCUtility/URL.swift

@@ -8,6 +8,8 @@
  See http://swift.org/CONTRIBUTORS.txt for Swift project authors
 */
 
+// deprecated 9/2021
+@available(*, deprecated, message: "use Foundation APIs instead")
 public struct URL {
 
     /// Parses the URL type of a git repository

Tests/TSCBasicTests/ObjectIdentifierProtocolTests.swift

@@ -12,15 +12,18 @@ import XCTest
 
 import TSCBasic
 
+@available(*, deprecated)
 final class Person {
     let name: String
     init(_ name: String) {
         self.name = name
     }
 }
 
+@available(*, deprecated)
 extension Person: ObjectIdentifierProtocol {}
 
+@available(*, deprecated)
 class ObjectIdentifierProtocolTests: XCTestCase {
 
     func testBasics() {

Tests/TSCUtilityTests/StringTests.swift

@@ -57,6 +57,7 @@ class StringTests: XCTestCase {
 }
 
 class URLTests: XCTestCase {
+    @available(*, deprecated)
     func testSchema() {
         XCTAssertEqual(TSCUtility.URL.scheme("http://github.com/foo/bar"), "http")
         XCTAssertEqual(TSCUtility.URL.scheme("https://github.com/foo/bar"), "https")