Add Swift Package Manager (#47)

* Adds support for Swift Package Manager.
* Moves source files to new structure.
* Minor source changes to work with new structure.
* Adds CI job to build via SPM.

Author: Sherlouk

.github/workflows/ci.yml

@@ -43,3 +43,17 @@ jobs:
         run: bundle exec --gemfile=Example/Gemfile pod install --project-directory=Example
       - name: Lint Podspec
         run: bundle exec --gemfile=Example/Gemfile pod lib lint --verbose --fail-fast
+  spm:
+    name: SPM Build
+    runs-on: macOS-latest
+    strategy:
+      matrix:
+        platform: ['iOS_14']
+      fail-fast: false
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v2
+      - name: Select Xcode Version
+        run: sudo xcode-select --switch /Applications/Xcode_12.2.app/Contents/Developer
+      - name: Build
+        run: Scripts/build.swift spm ${{ matrix.platform }}

.gitignore

@@ -27,3 +27,8 @@ Carthage/Build
 
 # CocoaPods
 Pods/
+
+# Swift Package Manager
+generated/
+.build/
+.swiftpm/

AccessibilitySnapshot.podspec

@@ -15,28 +15,25 @@ Pod::Spec.new do |s|
   s.default_subspecs = 'Core', 'SnapshotTesting'
 
   s.subspec 'Core' do |ss|
-    ss.source_files = 'AccessibilitySnapshot/Core/Classes/**/*.{swift,h,m}'
-    ss.public_header_files = [
-      'AccessibilitySnapshot/Core/Classes/UIAccessibilityStatusUtility.h',
-      'AccessibilitySnapshot/Core/Classes/UIView+DynamicTypeSnapshotting.h',
-    ]
+    ss.source_files = 'Sources/AccessibilitySnapshot/Core/Swift/Classes/**/*.swift', 'Sources/AccessibilitySnapshot/Core/ObjC/**/*.{h,m}'
+    ss.public_header_files = 'Sources/AccessibilitySnapshot/Core/ObjC/include/*.h'
     ss.resource_bundles = {
-     'AccessibilitySnapshot' => ['AccessibilitySnapshot/Core/Assets/**/*.{strings,xcassets}']
+     'AccessibilitySnapshot' => ['Sources/AccessibilitySnapshot/Core/Swift/Assets/**/*.{strings,xcassets}']
     }
   end
 
   s.subspec 'iOSSnapshotTestCase' do |ss|
-    ss.source_files = 'AccessibilitySnapshot/iOSSnapshotTestCase/Classes/**/*.{swift,h,m}'
+    ss.source_files = 'Sources/AccessibilitySnapshot/iOSSnapshotTestCase/**/*.{swift,h,m}'
     ss.public_header_files = [
-      'AccessibilitySnapshot/iOSSnapshotTestCase/Classes/FBSnapshotTestCase_Accessibility.h',
+      'Sources/AccessibilitySnapshot/iOSSnapshotTestCase/FBSnapshotTestCase_Accessibility.h',
     ]
 
     ss.dependency 'AccessibilitySnapshot/Core'
     ss.dependency 'iOSSnapshotTestCase', '~> 6.0'
   end
 
   s.subspec 'SnapshotTesting' do |ss|
-    ss.source_files = 'AccessibilitySnapshot/SnapshotTesting/Classes/**/*.{swift,h,m}'
+    ss.source_files = 'Sources/AccessibilitySnapshot/SnapshotTesting/**/*.{swift,h,m}'
 
     ss.dependency 'AccessibilitySnapshot/Core'
     ss.dependency 'SnapshotTesting', '~> 1.0'

Example/Podfile.lock

@@ -37,7 +37,7 @@ CHECKOUT OPTIONS:
     :git: https://github.com/square/Paralayout
 
 SPEC CHECKSUMS:
-  AccessibilitySnapshot: cb80a36813f8897825eada35ca5b09b210e472c3
+  AccessibilitySnapshot: 4e1a6b6a16d945a4aca3a7459490fc6e1ccc867e
   iOSSnapshotTestCase: 9ab44cb5aa62b84d31847f40680112e15ec579a6
   Paralayout: f4d6727fca5b592eb93a7cc408e45404599a4b0a
   SnapshotTesting: 38947050d13960d57a4a9c166fcf51bca7d56970

Package.resolved

@@ -0,0 +1,16 @@
+{
+  "object": {
+    "pins": [
+      {
+        "package": "SnapshotTesting",
+        "repositoryURL": "https://github.com/pointfreeco/swift-snapshot-testing.git",
+        "state": {
+          "branch": null,
+          "revision": "c466812aa2e22898f27557e2e780d3aad7a27203",
+          "version": "1.8.2"
+        }
+      }
+    ]
+  },
+  "version": 1
+}

Package.swift

@@ -0,0 +1,47 @@
+// swift-tools-version:5.3
+// The swift-tools-version declares the minimum version of Swift required to build this package.
+
+import PackageDescription
+
+let package = Package(
+    name: "AccessibilitySnapshot",
+    defaultLocalization: "en",
+    platforms: [
+        .iOS(.v12),
+    ],
+    products: [
+        // Core + SnapshotTesting for image comparison
+        .library(
+            name: "AccessibilitySnapshot",
+            targets: ["AccessibilitySnapshot"]
+        ),
+        
+        .library(
+            name: "AccessibilitySnapshotCore",
+            targets: ["AccessibilitySnapshotCore"]
+        ),
+    ],
+    dependencies: [
+        .package(
+            name: "SnapshotTesting",
+            url: "https://github.com/pointfreeco/swift-snapshot-testing.git",
+            .upToNextMajor(from: "1.8.0")
+        )
+    ],
+    targets: [
+        .target(
+            name: "AccessibilitySnapshotCore-ObjC",
+            path: "Sources/AccessibilitySnapshot/Core/ObjC"
+        ),
+        .target(
+            name: "AccessibilitySnapshotCore",
+            dependencies: ["AccessibilitySnapshotCore-ObjC"],
+            path: "Sources/AccessibilitySnapshot/Core/Swift"
+        ),
+        .target(
+            name: "AccessibilitySnapshot",
+            dependencies: ["AccessibilitySnapshotCore", "SnapshotTesting"],
+            path: "Sources/AccessibilitySnapshot/SnapshotTesting"
+        )
+    ]
+)

README.md

@@ -31,6 +31,36 @@ Alternatively, if you wish to use [iOSSnapshotTestCase](https://github.com/uber/
 pod 'AccessibilitySnapshot/iOSSnapshotTestCase'
 ```
 
+### Swift Package Manager
+
+Install with [Swift Package Manager](https://swift.org/package-manager/) by adding the following to your `Package.swift`:
+
+```swift
+dependencies: [
+    .package(name: "AccessibilitySnapshot", url: "https://github.com/cashapp/AccessibilitySnapshot.git", from: "0.4.1"),
+]
+```
+
+Next, add AccessibilitySnapshot as a dependency to your test target:
+
+```swift
+targets: [
+    .target(name: "MyApp"),
+    .testTarget(name: "MyAppTests", dependencies: ["MyApp", "AccessibilitySnapshot"])
+]
+```
+
+To use only the core accessibility parser, add a dependency on the Core library alone:
+
+```swift
+targets: [
+    .target(name: "MyApp"),
+    .testTarget(name: "MyAppTests", dependencies: ["MyApp", "AccessibilitySnapshotCore"])
+]
+```
+
+We do not currently support AccessibilitySnapshot and [iOSSnapshotTestCase](https://github.com/uber/ios-snapshot-test-case) through Swift Package Manager.
+
 ## Usage
 
 AccessibilitySnapshot builds on top of existing snapshot frameworks to add support for snapshotting your app's accessibility. By default it uses the [SnapshotTesting](https://github.com/pointfreeco/swift-snapshot-testing) framework for snapshotting, but can be switched over to [iOSSnapshotTestCase](https://github.com/uber/ios-snapshot-test-case) as well.

Scripts/build.swift

@@ -46,11 +46,14 @@ enum TaskError: Error {
 }
 
 enum Platform: String, CustomStringConvertible {
+	case iOS_14
 	case iOS_13
 	case iOS_12
 
 	var destination: String {
 		switch self {
+		case .iOS_14:
+			return "platform=iOS Simulator,OS=14.2,name=iPhone 12 Pro"
 		case .iOS_13:
 			return "platform=iOS Simulator,OS=13.3,name=iPhone 11 Pro"
 		case .iOS_12:
@@ -68,31 +71,40 @@ enum Platform: String, CustomStringConvertible {
 }
 
 enum Task: String, CustomStringConvertible {
+	case spm
 	case xcode
 
 	var workspace: String? {
 		switch self {
+		case .spm:
+			return nil
 		case .xcode:
 			return "Example/AccessibilitySnapshot.xcworkspace"
 		}
 	}
 
 	var project: String? {
 		switch self {
+		case .spm:
+			return nil
 		case .xcode:
 			return nil
 		}
 	}
 
 	var scheme: String {
 		switch self {
+		case .spm:
+			return "AccessibilitySnapshot"
 		case .xcode:
 			return "AccessibilitySnapshotDemo"
 		}
 	}
 
 	var shouldRunTests: Bool {
 		switch self {
+		case .spm:
+			return false
 		case .xcode:
 			return true
 		}

AccessibilitySnapshot/Core/Classes/ASAccessibilityEnabler.m renamed to Sources/AccessibilitySnapshot/Core/ObjC/ASAccessibilityEnabler.m

@@ -39,7 +39,7 @@
 // OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-#import "UIAccessibilityStatusUtility.h"
+#import "include/UIAccessibilityStatusUtility.h"
 
 #import <dlfcn.h>
 

AccessibilitySnapshot/Core/Classes/UIAccessibilityStatusUtility.m renamed to Sources/AccessibilitySnapshot/Core/ObjC/UIAccessibilityStatusUtility.m

@@ -14,7 +14,7 @@
 //  limitations under the License.
 //
 
-#import "UIView+DynamicTypeSnapshotting.h"
+#import "include/UIView+DynamicTypeSnapshotting.h"
 
 #import <objc/runtime.h>
 

AccessibilitySnapshot/Core/Classes/UIApplication+DynamicTypeSnapshotting.h renamed to Sources/AccessibilitySnapshot/Core/ObjC/UIApplication+DynamicTypeSnapshotting.h

@@ -14,7 +14,7 @@
 //  limitations under the License.
 //
 
-@import Foundation;
+#import <UIKit/UIKit.h>
 
 NS_ASSUME_NONNULL_BEGIN
 

AccessibilitySnapshot/Core/Classes/UIApplication+DynamicTypeSnapshotting.m renamed to Sources/AccessibilitySnapshot/Core/ObjC/UIApplication+DynamicTypeSnapshotting.m

@@ -771,9 +771,13 @@ private extension Bundle {
     private final class Sentinel {}
 
     static var accessibilitySnapshotResources: Bundle = {
+        #if SWIFT_PACKAGE
+        return Bundle.module
+        #else
         let container = Bundle(for: Sentinel.self)
         let resources = container.url(forResource: "AccessibilitySnapshot", withExtension: "bundle")!
         return Bundle(url: resources)!
+        #endif
     }()
 
 }

AccessibilitySnapshot/Core/Classes/UIView+DynamicTypeSnapshotting.m renamed to Sources/AccessibilitySnapshot/Core/ObjC/UIView+DynamicTypeSnapshotting.m

@@ -35,6 +35,9 @@ private enum StringLocalization {
     private static var localeToBundleMap: [String: Bundle] = [:]
 
     private static let resourceBundle: Bundle = {
+        #if SWIFT_PACKAGE
+        return Bundle.module
+        #else
         let frameworkBundle = Bundle(for: AccessibilityHierarchyParser.self)
 
         guard let resourceBundlePath = frameworkBundle.path(forResource: "AccessibilitySnapshot", ofType: "bundle") else {
@@ -46,6 +49,7 @@ private enum StringLocalization {
         }
 
         return resourceBundle
+        #endif
     }()
 
     // MARK: - Public Static Methods

AccessibilitySnapshot/Core/Classes/UIAccessibilityStatusUtility.h renamed to Sources/AccessibilitySnapshot/Core/ObjC/include/UIAccessibilityStatusUtility.h

@@ -15,6 +15,12 @@
 //
 
 import SnapshotTesting
+import UIKit
+
+#if SWIFT_PACKAGE
+import AccessibilitySnapshotCore
+import AccessibilitySnapshotCore_ObjC
+#endif
 
 extension Snapshotting where Value == UIView, Format == UIImage {