Adding Reference packages (#7)

Author: goergisn

.DS_Store

@@ -20,7 +20,7 @@ jobs:
     - name: Select latest Xcode
       uses: maxim-lobanov/setup-xcode@v1
       with:
-        xcode-version: '15.1'
+        xcode-version: '15.4'
 
     - name: 🛠️ Build with release configuration
       run: |

.github/workflows/build-release.yml

@@ -18,8 +18,8 @@ jobs:
     - name: Select latest Xcode
       uses: maxim-lobanov/setup-xcode@v1
       with:
-        xcode-version: '15.1'
+        xcode-version: '15.4'
 
-    - name: 🛠️ Run Tests
+    - name: 🛠️ Run All Tests
       run: |
-        xcodebuild test -scheme public-api-diff -destination "platform=iOS,name=Any iOS Device" | xcpretty --utf --color && exit
+        xcodebuild test -scheme public-api-diff -destination "platform=iOS,name=Any iOS Device" | xcpretty --utf --color && exit ${PIPESTATUS[0]}

.github/workflows/run-tests.yml

@@ -23,7 +23,7 @@ let package = Package(
             path: "Sources"
         ),
         .testTarget(
-            name: "PublicApiDiffTests",
+            name: "UnitTests",
             dependencies: ["public-api-diff"],
             resources: [
                 // Copy Tests/ExampleTests/Resources directories as-is.
@@ -32,6 +32,16 @@ let package = Package(
                 .copy("Resources/dummy.abi.json"),
                 .copy("Resources/dummi-abi-flat-definition.md")
             ]
+        ),
+        .testTarget(
+            name: "IntegrationTests",
+            dependencies: ["public-api-diff"],
+            resources: [
+                // Copy Tests/ExampleTests/Resources directories as-is.
+                // Use to retain directory structure.
+                // Will be at top level in bundle.
+                .copy("Resources/expected-reference-changes.md")
+            ]
         )
     ]
 )

Package.swift

@@ -0,0 +1,8 @@
+.DS_Store
+/.build
+/Packages
+xcuserdata/
+DerivedData/
+.swiftpm/configuration/registries.json
+.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
+.netrc

ReferencePackages/.DS_Store

@@ -0,0 +1,22 @@
+// swift-tools-version: 5.9
+// The swift-tools-version declares the minimum version of Swift required to build this package.
+
+import PackageDescription
+
+let package = Package(
+    name: "ReferencePackage",
+    platforms: [.iOS(.v17)],
+    products: [
+        // Products define the executables and libraries a package produces, making them visible to other packages.
+        .library(
+            name: "ReferencePackage",
+            targets: ["ReferencePackage"]
+        )
+    ],
+    targets: [
+        // Targets are the basic building blocks of a package, defining a module or a test suite.
+        // Targets can depend on other targets in this package and products from dependencies.
+        .target(
+            name: "ReferencePackage")
+    ]
+)

ReferencePackages/ReferencePackage/.gitignore

@@ -0,0 +1,142 @@
+//
+// Copyright (c) 2024 Adyen N.V.
+//
+// This file is open source and available under the MIT license. See the LICENSE file for more info.
+//
+
+import Foundation
+
+/**
+ An attempt of using all swift language features to make sure that all types of different projects are supported.
+ 
+ Missing information using Swift 5.10
+ - No information about `async`, `@MainActor`
+ - `class func` is missing a unique feature and only shows as `static`
+ */
+
+/**
+ TODOs:
+ - macro
+ - subscriptDeclaration
+ */
+
+// MARK: - Protocol with associatedtype
+
+public protocol CustomProtocol {
+    typealias CustomAssociatedType = Equatable
+    
+    var getSetVar: any CustomAssociatedType { get set }
+    var getVar: any CustomAssociatedType { get }
+    func function() -> any CustomAssociatedType
+}
+
+public struct CustomStruct: CustomProtocol {
+    public var getSetVar: any Equatable
+    public var getVar: any Equatable
+    @discardableResult
+    public func function() -> any Equatable { fatalError() }
+}
+
+// MARK: - Generic public class
+
+public class CustomClass<T: Equatable> {
+    
+    public weak var weakObject: CustomClass?
+    lazy var lazyVar: String = { "I am a lazy" }()
+    @_spi(SomeSpi)
+    @_spi(AnotherSpi)
+    open var computedVar: String { "I am computed" }
+    package let constantLet: String = "I'm a let"
+    public var optionalVar: T?
+    
+    @MainActor
+    public func asyncThrowingFunc() async throws {}
+    public func rethrowingFunc(throwingArg: @escaping () throws -> String) rethrows {}
+    
+    public init(weakObject: CustomClass? = nil, optionalVar: T? = nil) {
+        self.weakObject = weakObject
+        self.optionalVar = optionalVar
+    }
+    
+    public init() {}
+    
+    public convenience init(value: T) {
+        self.init(optionalVar: value)
+    }
+}
+
+// MARK: - Generic open class with Protocol conformance and @_spi constraint
+
+@_spi(SystemProgrammingInterface)
+open class OpenSpiConformingClass: CustomProtocol {
+    public typealias CustomAssociatedType = any Equatable
+    
+    public var getSetVar: CustomAssociatedType
+    public var getVar: CustomAssociatedType
+    @inlinable
+    public func function() -> CustomAssociatedType { fatalError() }
+    
+    public init(getSetVar: CustomAssociatedType, getVar: CustomAssociatedType) {
+        self.getSetVar = getSetVar
+        self.getVar = getVar
+    }
+}
+
+// MARK: - Package only class
+
+package class PackageOnlyClass {
+    public class func classFunc() -> String { "I'm classy" }
+    public static func staticFunc() -> String { "I'm static" }
+    public static var staticVar: String = "I'm static too"
+}
+
+// MARK: - Objc
+
+@_spi(ObjCSpi)
+@objc
+public class ObjcClass: NSObject {
+    public dynamic var dynamicVar: String = "I'm dynamic"
+}
+
+// MARK: - Actor
+
+public actor CustomActor {}
+
+// MARK: - Operators
+
+public enum OperatorNamespace: String {
+    case someValue = "1"
+    
+    public static prefix func ++ (_ counter: OperatorNamespace) -> String {
+        counter.rawValue
+    }
+    
+    public static postfix func ++ (_ counter: OperatorNamespace) -> String {
+        counter.rawValue
+    }
+}
+
+// MARK: Infix operator with custom precedencegroup
+
+postfix operator &&
+prefix operator &&
+
+infix operator &&: CustomPrecedence
+
+precedencegroup CustomPrecedence {
+    higherThan: AdditionPrecedence
+    lowerThan: MultiplicationPrecedence
+    assignment: false
+    associativity: left
+}
+
+// MARK: - Enums
+
+public enum CustomEnum {
+    case normalCase
+    case caseWithString(String)
+    case caseWithTuple(String, Int)
+    case caseWithBlock((Int) throws -> Void)
+    
+    indirect case recursive(CustomEnum)
+}

ReferencePackages/ReferencePackage/Package.swift

@@ -0,0 +1,8 @@
+.DS_Store
+/.build
+/Packages
+xcuserdata/
+DerivedData/
+.swiftpm/configuration/registries.json
+.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
+.netrc

ReferencePackages/ReferencePackage/Sources/ReferencePackage/ReferencePackage.swift

@@ -0,0 +1,22 @@
+// swift-tools-version: 5.9
+// The swift-tools-version declares the minimum version of Swift required to build this package.
+
+import PackageDescription
+
+let package = Package(
+    name: "ReferencePackage",
+    platforms: [.iOS(.v17)],
+    products: [
+        // Products define the executables and libraries a package produces, making them visible to other packages.
+        .library(
+            name: "ReferencePackage",
+            targets: ["ReferencePackage"]
+        )
+    ],
+    targets: [
+        // Targets are the basic building blocks of a package, defining a module or a test suite.
+        // Targets can depend on other targets in this package and products from dependencies.
+        .target(
+            name: "ReferencePackage")
+    ]
+)