Merge pull request #83 from swift-developer-tools/feature/remote-advanced

Add Remote (Advanced) bindings

Author: swift-developer-tools-archive

Sources/SwiftLibgit2/Remote-Advanced/Remote-Advanced-Enums.swift

@@ -0,0 +1,69 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the swift-libgit2 open source project.
+//
+// Copyright (c) Margins Technologies LLC.
+// Licensed under the Apache License, Version 2.0.
+//
+//===----------------------------------------------------------------------===//
+
+import CLibgit2
+
+
+
+/// The flags indicating a remote's capabilities.
+///
+/// ## C Equivalent
+///
+/// [`git_remote_capability_t`](https://libgit2.org/docs/reference/main/sys/remote/git_remote_capability_t.html)
+public struct GitRemoteCapabilityT: COptionSet
+{
+    /// The raw value to use.
+    public let rawValue: UInt32
+    
+    
+    
+    /// Initializes a ``GitRemoteCapabilityT`` instance from the given raw
+    /// value.
+    /// - Parameter rawValue: The raw value to use.
+    public init(
+        rawValue: UInt32
+    )
+    {
+        self.rawValue = rawValue
+    }
+    
+    
+    
+    /// Initializes a ``GitRemoteCapabilityT`` instance from the given
+    /// `git_remote_capability_t` instance.
+    /// - Parameter remoteCapability: The `git_remote_capability_t` instance
+    /// to use.
+    internal init(
+        cValue remoteCapability: git_remote_capability_t
+    )
+    {
+        self.rawValue = remoteCapability.rawValue
+    }
+    
+    
+    
+    /// The remote supports fetching an advertised object by its ID.
+    public static let gitRemoteCapabilityTipOID         = GitRemoteCapabilityT(rawValue: GIT_REMOTE_CAPABILITY_TIP_OID.rawValue)
+    
+    /// The remote supports fetching an individual reachable object.
+    public static let gitRemoteCapabilityReachableOID   = GitRemoteCapabilityT(rawValue: GIT_REMOTE_CAPABILITY_REACHABLE_OID.rawValue)
+    
+    /// The remote supports push options.
+    public static let gitRemoteCapabilityPushOptions    = GitRemoteCapabilityT(rawValue: GIT_REMOTE_CAPABILITY_PUSH_OPTIONS.rawValue)
+    
+    
+    
+    /// Converts the ``GitRemoteCapabilityT`` instance into a
+    /// `git_remote_capability_t` instance.
+    /// - Returns: The `git_remote_capability_t` instance.
+    internal func cValue() -> git_remote_capability_t
+    {
+        return git_remote_capability_t(rawValue)
+    }
+}

Sources/SwiftLibgit2/Remote-Advanced/Remote-Advanced-Functions.swift

@@ -0,0 +1,42 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the swift-libgit2 open source project.
+//
+// Copyright (c) Margins Technologies LLC.
+// Licensed under the Apache License, Version 2.0.
+//
+//===----------------------------------------------------------------------===//
+
+import CLibgit2
+
+
+
+// TODO: Replace `git_transport_remote_connect_options()` in documentation.
+/// Frees the memory allocated for the given `git_remote_connect_options`
+/// instance.
+/// - Parameter opts: The remote connect options to free.
+///
+/// ## Discussion
+///
+/// This function does not free the `git_remote_connect_options` instance
+/// itself. It disposes the libgit2-initialized fields of the given options.
+///
+/// - Important: This function must be called only with a
+/// `git_remote_connect_options` instance that was returned by
+/// `git_transport_remote_connect_options()`.
+///
+/// ## C Equivalent
+///
+/// [`git_remote_connect_options_dispose()`](https://libgit2.org/docs/reference/main/sys/remote/git_remote_connect_options_dispose.html)
+public func gitRemoteConnectOptionsDispose(
+    opts: UnsafeMutablePointer<git_remote_connect_options>?
+)
+{
+    guard let opts: UnsafeMutablePointer<git_remote_connect_options> = opts
+    else
+    {
+        return
+    }
+    
+    git_remote_connect_options_dispose(opts)
+}

Sources/SwiftLibgit2/SwiftLibgit2.docc/Remote-Advanced.md

@@ -0,0 +1,13 @@
+# Remote (Advanced)
+
+Low-level remote custom transports.
+
+## Topics
+
+### Enums
+
+- ``GitRemoteCapabilityT``
+
+### Functions
+
+- ``gitRemoteConnectOptionsDispose(opts:)``

Tests/swift-libgit2Tests/Remote-Advanced-Tests.swift

@@ -0,0 +1,53 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the swift-libgit2 open source project.
+//
+// Copyright (c) Margins Technologies LLC.
+// Licensed under the Apache License, Version 2.0.
+//
+//===----------------------------------------------------------------------===//
+
+import CLibgit2
+import XCTest
+@testable import SwiftLibgit2
+
+
+
+final class RemoteAdvancedTests: XCTestCaseStopOnFail
+{
+    func testGitRemoteCapabilityT() throws
+    {
+        XCTAssertEqual(GitRemoteCapabilityT.gitRemoteCapabilityTipOID.rawValue, GIT_REMOTE_CAPABILITY_TIP_OID.rawValue)
+        XCTAssertEqual(GitRemoteCapabilityT.gitRemoteCapabilityReachableOID.rawValue, GIT_REMOTE_CAPABILITY_REACHABLE_OID.rawValue)
+        XCTAssertEqual(GitRemoteCapabilityT.gitRemoteCapabilityPushOptions.rawValue, GIT_REMOTE_CAPABILITY_PUSH_OPTIONS.rawValue)
+        
+        XCTAssertEqual(GitRemoteCapabilityT(rawValue: 123).cValue().rawValue, 123)
+        
+        XCTAssertEqual(GitRemoteCapabilityT.gitRemoteCapabilityTipOID.cValue(), GIT_REMOTE_CAPABILITY_TIP_OID)
+        XCTAssertEqual(GitRemoteCapabilityT.gitRemoteCapabilityReachableOID.cValue(), GIT_REMOTE_CAPABILITY_REACHABLE_OID)
+        XCTAssertEqual(GitRemoteCapabilityT.gitRemoteCapabilityPushOptions.cValue(), GIT_REMOTE_CAPABILITY_PUSH_OPTIONS)
+        
+        XCTAssertEqual(GitRemoteCapabilityT(cValue: GIT_REMOTE_CAPABILITY_TIP_OID), .gitRemoteCapabilityTipOID)
+        XCTAssertEqual(GitRemoteCapabilityT(cValue: GIT_REMOTE_CAPABILITY_REACHABLE_OID), .gitRemoteCapabilityReachableOID)
+        XCTAssertEqual(GitRemoteCapabilityT(cValue: GIT_REMOTE_CAPABILITY_PUSH_OPTIONS), .gitRemoteCapabilityPushOptions)
+        
+        
+        
+        let flags: GitRemoteCapabilityT =
+        [
+            .gitRemoteCapabilityTipOID,
+            .gitRemoteCapabilityReachableOID
+        ]
+        
+        XCTAssertTrue(flags.contains(.gitRemoteCapabilityTipOID))
+        XCTAssertTrue(flags.contains(.gitRemoteCapabilityReachableOID))
+        XCTAssertFalse(flags.contains(.gitRemoteCapabilityPushOptions))
+    }
+    
+    
+    
+    func testGitRemoteConnectOptionsDispose() throws
+    {
+        gitRemoteConnectOptionsDispose(opts: nil)
+    }
+}