Adds Branch Support + Tests

Author: Emanuel Cunha

Example/Config/RemoteDependencies.json

@@ -14,6 +14,11 @@
             "name": "RemoteDependencyC",
             "url": "https://github.com/DependencyC",
             "revision": "abcde1235kjh"
+        },
+        {
+            "name": "RemoteDependencyD",
+            "url": "https://github.com/DependencyC",
+            "branch": "master"
         }
     ]
 }

Sources/Core/SpecGenerator.swift

@@ -46,7 +46,8 @@ final class SpecGenerator {
             return RemoteDependency(name: dependency.name,
                                     url: remoteDependency.url ?? dependency.url,
                                     version: remoteDependency.version ?? dependency.version,
-                                    revision: remoteDependency.revision ?? dependency.revision)
+                                    revision: remoteDependency.revision ?? dependency.revision,
+                                    branch: remoteDependency.branch ?? dependency.branch)
         }
 
         return Spec(name: partialSpec.name,

Sources/Models/Dependencies.swift

@@ -11,4 +11,17 @@ struct Dependency: Decodable {
     let url: String
     let version: String?
     let revision: String?
+    let branch: String?
+
+    init(name: String, url: String, version: String?, revision: String?, branch: String?) {
+        guard version != nil || revision != nil || branch != nil else {
+            fatalError("You need to provide at least one of the following: version, revision or branch")
+        }
+        
+        self.name = name
+        self.url = url
+        self.version = version
+        self.revision = revision
+        self.branch = branch
+    }
 }

Sources/Models/Spec.swift

@@ -84,12 +84,14 @@ struct RemoteDependency: Decodable {
     let url: String?
     let version: String?
     let revision: String?
+    let branch: String?
 
     enum CodingKeys: CodingKey {
         case name
         case url
         case version
         case revision
+        case branch
     }
 
     init(from decoder: Decoder) throws {
@@ -98,13 +100,19 @@ struct RemoteDependency: Decodable {
         self.url = try container.decodeIfPresent(String.self, forKey: .url)
         self.version = try container.decodeIfPresent(String.self, forKey: .version)
         self.revision = try container.decodeIfPresent(String.self, forKey: .revision)
+        self.branch = try container.decodeIfPresent(String.self, forKey: .branch)
     }
 
-    init(name: String, url: String, version: String?, revision: String?) {
+    init(name: String, url: String, version: String?, revision: String?, branch: String?) {
+        guard version != nil || revision != nil || branch != nil else {
+            fatalError("You need to provide at least one of the following: version, revision or branch")
+        }
+
         self.name = name
         self.url = url
         self.version = version
         self.revision = revision
+        self.branch = branch
     }
 }
 

Templates/Package.stencil

@@ -99,6 +99,8 @@ let package = Package(
             exact: "{{ remote_dependency.version }}"
             {% elif remote_dependency.revision %}
             revision: "{{ remote_dependency.revision }}"
+            {% elif remote_dependency.branch %}
+            branch: "{{ remote_dependency.branch }}"
             {% endif %}
         ),
 {% endfor %}

Tests/PackageGeneratorTests.swift

@@ -7,6 +7,7 @@ final class PackageGeneratorTests: XCTestCase {
 
     enum PackageType: String {
         case revisionProduct = "RevisionProduct"
+        case branchProduct = "BranchProduct"
         case singleProduct = "SingleProduct"
         case multipleProducts = "MultipleProducts"
         case customPlatforms = "CustomPlatforms"
@@ -32,6 +33,10 @@ final class PackageGeneratorTests: XCTestCase {
         try assertPackage(for: .revisionProduct)
     }
 
+    func test_BranchProduct() throws {
+        try assertPackage(for: .branchProduct)
+    }
+
     func test_MultipleProducts() throws {
         try assertPackage(for: .multipleProducts)
     }

Tests/Resources/Package.stencil

@@ -99,6 +99,8 @@ let package = Package(
             exact: "{{ remote_dependency.version }}"
             {% elif remote_dependency.revision %}
             revision: "{{ remote_dependency.revision }}"
+            {% elif remote_dependency.branch %}
+            branch: "{{ remote_dependency.branch }}"
             {% endif %}
         ),
 {% endfor %}

Tests/Resources/Packages/BranchProduct/BranchProduct.json

@@ -0,0 +1,66 @@
+{
+  "name": "BranchProduct",
+  "products": [
+    {
+      "name": "BranchProduct",
+      "productType": "library",
+      "targets": [
+        "TargetA"
+      ]
+    }
+  ],
+  "localDependencies": [
+    {
+      "name": "LocalDependencyA",
+      "path": "../LocalDependencies"
+    }
+  ],
+  "remoteDependencies": [
+    {
+      "name": "RemoteDependencyA"
+    },
+    {
+      "name": "RemoteDependencyB"
+    },
+    {
+      "name": "RemoteDependencyD"
+    }
+  ],
+  "targets": [
+    {
+      "name": "TargetA",
+      "targetType": "target",
+      "dependencies": [
+        {
+          "name": "LocalDependencyA"
+        },
+        {
+          "name": "RemoteDependencyA"
+        },
+        {
+          "name": "RemoteDependencyB"
+        },
+        {
+          "name": "RemoteDependencyD"
+        }
+      ],
+      "sourcesPath": "Framework/Sources",
+      "resourcesPath": "Resources"
+    },
+    {
+      "name": "TargetATests",
+      "targetType": "testTarget",
+      "dependencies": [
+        {
+          "name": "TargetA",
+          "isTarget": true
+        },
+        {
+          "name": "RemoteDependencyB"
+        }
+      ],
+      "sourcesPath": "Tests/Sources",
+      "resourcesPath": "Resources"
+    }
+  ]
+}

Tests/Resources/Packages/BranchProduct/BranchProductPackage.swift

@@ -0,0 +1,65 @@
+// swift-tools-version: 5.7
+
+// This file was automatically generated by PackageGenerator and untracked
+// PLEASE DO NOT EDIT MANUALLY
+
+import PackageDescription
+
+let package = Package(
+    name: "BranchProduct",
+    defaultLocalization: "en",
+    platforms: [.iOS(.v15)],
+    products: [
+        .library(
+            name: "BranchProduct",
+            targets: ["TargetA"]
+        ),
+    ],
+    dependencies: [
+        .package(
+            path: "../LocalDependencies"
+        ),
+        .package(
+            url: "https://github.com/DependencyA",
+            exact: "1.0.0"
+        ),
+        .package(
+            url: "https://github.com/DependencyB",
+            exact: "2.0.0"
+        ),
+        .package(
+            url: "https://github.com/DependencyD",
+            branch: "master"
+        ),
+    ],
+    targets: [
+        .target(
+            name: "TargetA",
+            dependencies: [
+                .product(name: "LocalDependencyA", package: "LocalDependencyA"),
+                .product(name: "RemoteDependencyA", package: "RemoteDependencyA"),
+                .product(name: "RemoteDependencyB", package: "RemoteDependencyB"),
+                .product(name: "RemoteDependencyD", package: "RemoteDependencyD"),
+            ],
+            path: "Framework/Sources",
+            resources: [
+                .process("Resources")
+            ],
+            plugins: [
+            ]
+        ),
+        .testTarget(
+            name: "TargetATests",
+            dependencies: [
+                .byName(name: "TargetA"),
+                .product(name: "RemoteDependencyB", package: "RemoteDependencyB"),
+            ],
+            path: "Tests/Sources",
+            resources: [
+                .process("Resources")
+            ],
+            plugins: [
+            ]
+        ),
+    ]
+)

Tests/Resources/TestRemoteDependencies.json

@@ -14,6 +14,11 @@
             "name": "RemoteDependencyC",
             "url": "https://github.com/DependencyC",
             "revision": "abcde1235kjh"
+        },
+        {
+            "name": "RemoteDependencyD",
+            "url": "https://github.com/DependencyD",
+            "branch": "master"
         }
     ]
 }