Merge pull request #28 from NickEntin/entin/switch-default-snapshot-engine

Switch default subspec to SnapshotTesting

Author: NickEntin

AccessibilitySnapshot.podspec

@@ -12,7 +12,7 @@ Pod::Spec.new do |s|
 
   s.ios.deployment_target = '12.0'
 
-  s.default_subspecs = 'Core', 'iOSSnapshotTestCase'
+  s.default_subspecs = 'Core', 'SnapshotTesting'
 
   s.subspec 'Core' do |ss|
     ss.source_files = 'AccessibilitySnapshot/Core/Classes/**/*.{swift,h,m}'

Example/Podfile

@@ -10,7 +10,7 @@ target 'AccessibilitySnapshotDemo' do
 	target 'SnapshotTests' do
 		inherit! :search_paths
 
-		pod 'AccessibilitySnapshot', :path => '../AccessibilitySnapshot.podspec'
+		pod 'AccessibilitySnapshot/iOSSnapshotTestCase', :path => '../AccessibilitySnapshot.podspec'
 		pod 'AccessibilitySnapshot/SnapshotTesting', :path => '../AccessibilitySnapshot.podspec'
 	end
 

Example/Podfile.lock

@@ -1,7 +1,4 @@
 PODS:
-  - AccessibilitySnapshot (0.3.3):
-    - AccessibilitySnapshot/Core (= 0.3.3)
-    - AccessibilitySnapshot/iOSSnapshotTestCase (= 0.3.3)
   - AccessibilitySnapshot/Core (0.3.3):
     - fishhook (~> 0.2)
   - AccessibilitySnapshot/iOSSnapshotTestCase (0.3.3):
@@ -17,11 +14,11 @@ PODS:
   - iOSSnapshotTestCase/SwiftSupport (6.2.0):
     - iOSSnapshotTestCase/Core
   - Paralayout (0.9.1)
-  - SnapshotTesting (1.7.2)
+  - SnapshotTesting (1.8.2)
 
 DEPENDENCIES:
-  - AccessibilitySnapshot (from `../AccessibilitySnapshot.podspec`)
   - AccessibilitySnapshot/Core (from `../AccessibilitySnapshot.podspec`)
+  - AccessibilitySnapshot/iOSSnapshotTestCase (from `../AccessibilitySnapshot.podspec`)
   - AccessibilitySnapshot/SnapshotTesting (from `../AccessibilitySnapshot.podspec`)
   - Paralayout (from `https://github.com/square/Paralayout`)
 
@@ -43,12 +40,12 @@ CHECKOUT OPTIONS:
     :git: https://github.com/square/Paralayout
 
 SPEC CHECKSUMS:
-  AccessibilitySnapshot: 9f5bb086d87f4d797f4e047c46dcb06b0c7878f8
+  AccessibilitySnapshot: 16a6591e103a619a370283d735bc7b89b07811b9
   fishhook: ea19933abfe8f2f52c55fd8b6e2718467d3ebc89
   iOSSnapshotTestCase: 9ab44cb5aa62b84d31847f40680112e15ec579a6
   Paralayout: f4d6727fca5b592eb93a7cc408e45404599a4b0a
-  SnapshotTesting: 8caa6661fea7c8019d5b46de77c16bab99c36c5c
+  SnapshotTesting: 38947050d13960d57a4a9c166fcf51bca7d56970
 
-PODFILE CHECKSUM: 909a664616eb8ce5c087424039327435f7f366b7
+PODFILE CHECKSUM: 732bb9b88eb5ba688736aeb334770899a1d472c2
 
 COCOAPODS: 1.9.1

README.md

@@ -9,7 +9,7 @@ AccessibilitySnapshots makes it simple to add regression tests for accessibility
 
 ## Getting Started
 
-By default, AccessibilitySnapshot uses [iOSSnapshotTestCase](https://github.com/uber/ios-snapshot-test-case) to record snapshots and perform comparisons. Before setting up accessibility snapshot tests, make sure your project is set up for standard snapshot testing. Accessibility snapshot tests require that the test target has a host application. See the [Extensions](#extensions) section below for a list of other available snapshotting options.
+By default, AccessibilitySnapshot uses [SnapshotTesting](https://github.com/pointfreeco/swift-snapshot-testing) to record snapshots and perform comparisons. The framework also includes support for using [iOSSnapshotTestCase](https://github.com/uber/ios-snapshot-test-case) as the snapshotting engine instead. Before setting up accessibility snapshot tests, make sure your project is set up for standard snapshot testing. Accessibility snapshot tests require that the test target has a host application. See the [Extensions](#extensions) section below for a list of other available snapshotting options.
 
 ### CocoaPods
 
@@ -19,20 +19,52 @@ Install with [CocoaPods](https://cocoapods.org) by adding the following to your
 pod 'AccessibilitySnapshot'
 ```
 
-To use only the core accessibility parser, add a dependency on the Core subspec alone.
+To use only the core accessibility parser, add a dependency on the Core subspec alone:
 
 ```ruby
 pod 'AccessibilitySnapshot/Core'
 ```
 
-Alternatively, if you wish to use Pointfree's SnapshotTesting library to perform image comparisons, then you should use the following subspec instead.
+Alternatively, if you wish to use [iOSSnapshotTestCase](https://github.com/uber/ios-snapshot-test-case) to perform image comparisons, you can add a dependency on the `iOSSnapshotTestCase` subspec instead (or in addition - you can use both in the same project):
 
 ```ruby
-pod 'AccessibilitySnapshot/SnapshotTesting'
+pod 'AccessibilitySnapshot/iOSSnapshotTestCase'
 ```
 
 ## 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.
+
+### Getting Started with SnapshotTesting
+
+AccessibilitySnapshot provides an `.accessibilityImage` snapshotting strategy that can be used with SnapshotTesting's snapshot assertions.
+
+```swift
+func testAccessibility() {
+    let view = MyView()
+    // Configure the view...
+
+    assertSnapshot(matching: view, as: .accessibilityImage)
+}
+```
+
+Snapshots can also be customized in a few ways, for example controlling when to include indicators for the accessibility activation point of each element. By default, these indicators are shown when the activation point is different than the default activation point for that view. You can override this behavior for each snapshot:
+
+```swift
+func testAccessibility() {
+    let view = MyView()
+    // Configure the view...
+
+    // Show indicators for every element.
+    assertSnapshot(matching: view, as: .accessibilityImage(showActivationPoints: .always))
+
+    // Don't show any indicators.
+    assertSnapshot(matching: view, as: .accessibilityImage(showActivationPoints: .never))
+}
+```
+
+### Getting Started with iOSSnapshotTestCase
+
 To run a snapshot test, simply call the `SnapshotVerifyAccessibility` method:
 
 ```swift