Merge pull request #33 from hartbit/update

Import for SwiftPM #2523

Author: hartbit

Sources/TSCBasic/CollectionAlgorithms.swift

@@ -8,15 +8,16 @@
  See http://swift.org/CONTRIBUTORS.txt for Swift project authors
 */
 
-extension Sequence where Iterator.Element: Hashable {
+extension Sequence where Element: Hashable {
 
     /// Finds duplicates in given sequence of Hashables.
     /// - Returns: duplicated elements in the invoking sequence.
-    public func spm_findDuplicates() -> [Iterator.Element] {
-        var unique: Set<Iterator.Element> = []
-        return filter {
-            !unique.insert($0).inserted
+    public func spm_findDuplicates() -> [Element] {
+        var counts: [Element: Int] = [:]
+        for element in self {
+            counts[element, default: 0] += 1
         }
+        return Array(counts.lazy.filter({ $0.value > 1 }).map({ $0.key }))
     }
 }
 

Sources/TSCBasic/DiagnosticsEngine.swift

@@ -101,23 +101,27 @@ public final class DiagnosticsEngine: CustomStringConvertible {
     /// The handler will be called on an unknown queue.
     private let handlers: [DiagnosticsHandler]
 
+    /// The default location to apply to location-less diagnostics.
+    public let defaultLocation: DiagnosticLocation
+
     /// Returns true if there is an error diagnostics in the engine.
     public var hasErrors: Bool {
         return diagnostics.contains(where: { $0.message.behavior == .error })
     }
 
-    public init(handlers: [DiagnosticsHandler] = []) {
+    public init(handlers: [DiagnosticsHandler] = [], defaultLocation: DiagnosticLocation = UnknownLocation.location) {
         self.handlers = handlers
+        self.defaultLocation = defaultLocation
     }
 
     public func emit(
         _ message: Diagnostic.Message,
-        location: DiagnosticLocation = UnknownLocation.location
+        location: DiagnosticLocation? = nil
     ) {
-        emit(Diagnostic(message: message, location: location))
+        emit(Diagnostic(message: message, location: location ?? defaultLocation))
     }
 
-    private func emit(_ diagnostic: Diagnostic) {
+    public func emit(_ diagnostic: Diagnostic) {
         queue.sync {
             _diagnostics.append(diagnostic)
         }

Sources/TSCBasic/FileSystem.swift

@@ -148,6 +148,11 @@ public protocol FileSystem: class {
     /// This follows the POSIX `getcwd(3)` semantics.
     var currentWorkingDirectory: AbsolutePath? { get }
 
+    /// Change the current working directory.
+    /// - Parameters:
+    ///   - path: The path to the directory to change the current working directory to.
+    func changeCurrentWorkingDirectory(to path: AbsolutePath) throws
+
     /// Get the home directory of current user
     var homeDirectory: AbsolutePath { get }
 
@@ -279,6 +284,16 @@ private class LocalFileSystem: FileSystem {
         return try? AbsolutePath(validating: cwdStr)
     }
 
+    func changeCurrentWorkingDirectory(to path: AbsolutePath) throws {
+        guard isDirectory(path) else {
+            throw FileSystemError.notDirectory
+        }
+
+        guard FileManager.default.changeCurrentDirectoryPath(path.pathString) else {
+            throw FileSystemError.unknownOSError
+        }
+    }
+
     var homeDirectory: AbsolutePath {
         return AbsolutePath(NSHomeDirectory())
     }
@@ -570,6 +585,10 @@ public class InMemoryFileSystem: FileSystem {
         return AbsolutePath("/")
     }
 
+    public func changeCurrentWorkingDirectory(to path: AbsolutePath) throws {
+        fatalError("Unsupported")
+    }
+
     public var homeDirectory: AbsolutePath {
         // FIXME: Maybe we should allow setting this when creating the fs.
         return AbsolutePath("/home/user")
@@ -800,6 +819,10 @@ public class RerootedFileSystemView: FileSystem {
         return AbsolutePath("/")
     }
 
+    public func changeCurrentWorkingDirectory(to path: AbsolutePath) throws {
+        fatalError("Unsupported")
+    }
+
     public var homeDirectory: AbsolutePath {
         fatalError("homeDirectory on RerootedFileSystemView is not supported.")
     }

Sources/TSCTestSupport/DiagnosticsEngine.swift

@@ -13,36 +13,6 @@ import TSCUtility
 
 import XCTest
 
-public enum StringCheck: ExpressibleByStringLiteral {
-    case equal(String)
-    case contains(String)
-
-    func check(
-        input: String,
-        file: StaticString = #file,
-        line: UInt = #line
-    ) {
-        switch self {
-        case .equal(let str):
-            XCTAssertEqual(str, input, file: file, line: line)
-        case .contains(let str):
-            XCTAssert(input.contains(str), "\(input) does not contain \(str)", file: file, line: line)
-        }
-    }
-
-    public init(stringLiteral value: String) {
-        self = .equal(value)
-    }
-
-    public init(extendedGraphemeClusterLiteral value: String) {
-        self.init(stringLiteral: value)
-    }
-
-    public init(unicodeScalarLiteral value: String) {
-        self.init(stringLiteral: value)
-    }
-}
-
 public func DiagnosticsEngineTester(
     _ engine: DiagnosticsEngine,
     ignoreNotes: Bool = false,
@@ -73,7 +43,7 @@ final public class DiagnosticsEngineResult {
     }
 
     public func check(
-        diagnostic: StringCheck,
+        diagnostic: StringPattern,
         checkContains: Bool = false,
         behavior: Diagnostic.Behavior,
         location: String? = nil,
@@ -87,7 +57,7 @@ final public class DiagnosticsEngineResult {
         let location = location ?? UnknownLocation.location.description
         let theDiagnostic = uncheckedDiagnostics.removeFirst()
 
-        diagnostic.check(input: theDiagnostic.description, file: file, line: line)
+        XCTAssertMatch(theDiagnostic.description, diagnostic, file: file, line: line)
         XCTAssertEqual(theDiagnostic.message.behavior, behavior, file: file, line: line)
         XCTAssertEqual(theDiagnostic.location.description, location, file: file, line: line)
     }

Sources/TSCUtility/Diagnostics.swift

@@ -35,28 +35,28 @@ extension DiagnosticsEngine {
 
     public func emit(
         error: String,
-        location: DiagnosticLocation = UnknownLocation.location
+        location: DiagnosticLocation? = nil
     ) {
         emit(.error(error), location: location)
     }
 
     public func emit(
         warning: String,
-        location: DiagnosticLocation = UnknownLocation.location
+        location: DiagnosticLocation? = nil
     ) {
         emit(.warning(warning), location: location)
     }
 
     public func emit(
         note: String,
-        location: DiagnosticLocation = UnknownLocation.location
+        location: DiagnosticLocation? = nil
     ) {
         emit(.note(note), location: location)
     }
 
   public func emit(
       remark: String,
-      location: DiagnosticLocation = UnknownLocation.location
+      location: DiagnosticLocation? = nil
   ) {
       emit(.remark(remark), location: location)
   }
@@ -67,7 +67,7 @@ extension DiagnosticsEngine {
     /// Otherwise, they will be emitted as AnyDiagnostic.
     public func emit(
         _ error: Swift.Error,
-        location: DiagnosticLocation = UnknownLocation.location
+        location: DiagnosticLocation? = nil
     ) {
         if let diagnosticData = error as? DiagnosticData {
             emit(.error(diagnosticData), location: location)
@@ -81,26 +81,31 @@ extension DiagnosticsEngine {
     /// Emit a diagnostic data convertible instance.
     public func emit(
         _ convertible: DiagnosticDataConvertible,
-        location: DiagnosticLocation = UnknownLocation.location
+        location: DiagnosticLocation? = nil
      ) {
         emit(.error(convertible.diagnosticData), location: location)
     }
 
+    @discardableResult
+    public func with<T>(location: DiagnosticLocation, _ closure: (DiagnosticsEngine) -> T) -> T {
+        let innerDiagnostics = DiagnosticsEngine(handlers: [self.emit], defaultLocation: location)
+        return closure(innerDiagnostics)
+    }
+
     /// Wrap a throwing closure, returning an optional value and
     /// emitting any thrown errors.
     ///
     /// - Parameters:
     ///     - closure: Closure to wrap.
     /// - Returns: Returns the return value of the closure wrapped
     ///   into an optional. If the closure throws, nil is returned.
-    public func wrap<T>(
-        with constuctLocation: @autoclosure () -> (DiagnosticLocation) = UnknownLocation.location,
-        _ closure: () throws -> T
-    ) -> T? {
+    public func wrap<T>(_ closure: () throws -> T) -> T? {
         do {
             return try closure()
+        } catch Diagnostics.fatalError {
+            return nil
         } catch {
-            emit(error, location: constuctLocation())
+            emit(error)
             return nil
         }
     }
@@ -113,20 +118,65 @@ extension DiagnosticsEngine {
     /// - Returns: Returns true if the wrapped closure did not throw
     ///   and false otherwise.
     @discardableResult
-    public func wrap(
-        with constuctLocation: @autoclosure () -> (DiagnosticLocation) = UnknownLocation.location,
-        _ closure: () throws -> Void
-    ) -> Bool {
+    public func wrap(_ closure: () throws -> Void) -> Bool {
         do {
             try closure()
             return true
+        } catch Diagnostics.fatalError {
+            return false
         } catch {
-            emit(error, location: constuctLocation())
+            emit(error)
             return false
         }
     }
 }
 
+extension Optional where Wrapped == DiagnosticsEngine {
+    public func emit(
+        error: String,
+        location: DiagnosticLocation? = nil
+    ) throws {
+        if case let diagnostics? = self {
+            diagnostics.emit(.error(error), location: location)
+        } else {
+            throw Diagnostics.fatalError
+        }
+    }
+
+    public func emit(
+        _ error: Swift.Error,
+        location: DiagnosticLocation? = nil
+    ) throws {
+        if case let diagnostics? = self {
+            diagnostics.emit(error, location: location)
+        } else {
+            throw Diagnostics.fatalError
+        }
+    }
+
+    public func emit(
+        _ convertible: DiagnosticDataConvertible,
+        location: DiagnosticLocation? = nil
+    ) throws {
+        if case let diagnostics? = self {
+            diagnostics.emit(.error(convertible.diagnosticData), location: location)
+        } else {
+            throw Diagnostics.fatalError
+        }
+    }
+
+    public func emit(
+        _ message: Diagnostic.Message,
+        location: DiagnosticLocation? = nil
+    ) throws {
+        if case let diagnostics? = self {
+            diagnostics.emit(message, location: location)
+        } else if message.behavior == .error {
+            throw Diagnostics.fatalError
+        }
+    }
+}
+
 /// Namespace for representing diagnostic location of a package.
 public enum PackageLocation {
 

Tests/TSCBasicTests/CollectionAlgorithmsTests.swift

@@ -14,7 +14,8 @@ import TSCBasic
 
 class CollectionAlgorithmsTests: XCTestCase {
     func testFindDuplicates() {
-        XCTAssertEqual([1, 2, 3, 2, 1].spm_findDuplicates(), [2, 1])
+        XCTAssertEqual(Set([1, 2, 3, 2, 1].spm_findDuplicates()), [1, 2])
+        XCTAssertEqual(Set([1, 2, 3, 2, 1, 2].spm_findDuplicates()), [1, 2])
         XCTAssertEqual(["foo", "bar"].spm_findDuplicates(), [])
         XCTAssertEqual(["foo", "Foo"].spm_findDuplicates(), [])
     }

Tests/TSCUtilityTests/DownloaderTests.swift

@@ -320,6 +320,10 @@ class FailingFileSystem: FileSystem {
         fatalError("unexpected call")
     }
 
+    func changeCurrentWorkingDirectory(to path: AbsolutePath) throws {
+        fatalError("unexpected call")
+    }
+
     func exists(_ path: AbsolutePath, followSymlink: Bool) -> Bool {
         fatalError("unexpected call")
     }