Merge pull request #1224 from mxcl/prerelease-prep

prerelease prep

Author: mxcl

.github/workflows/ci.yml

@@ -5,7 +5,6 @@ on:
       - Sources/**
       - Tests/**
       - .github/workflows/ci.yml
-  workflow_dispatch:
 jobs:
   auto-cancel:
     runs-on: ubuntu-latest
@@ -14,23 +13,22 @@ jobs:
 
   linux:
     name: linux
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-latest
     strategy:
       matrix:
         swift:
         - 5.3
-        - 5.4
+        - 5.4-focal  # Swift 5.4 requires llvm-cov v11
     container:
       image: swift:${{ matrix.swift }}
     steps:
     - uses: actions/checkout@v2
     - run: swift test --enable-code-coverage --parallel --enable-test-discovery
 
     - name: Generate Coverage Report
-      if: ${{ matrix.swift == '5.3' }}  # 5.4 and above needs llvm-cov-12
       run: |
         apt-get -qq update
-        apt-get -qq install curl
+        apt-get -qq install curl  # for codecov action 🙄
         b=$(swift build --show-bin-path)
         llvm-cov export \
           -format lcov \

.github/workflows/publish.yml

@@ -3,56 +3,41 @@ on:
   workflow_dispatch:
     inputs:
       version:
-        description: Version to publish
+        description: Version 🚀
         required: true
 jobs:
-  ci:
+  build:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        swift:
+        - 5.3
+        - 5.4
+    container:
+      image: swift:${{ matrix.swift }}
     steps:
-    - uses: aurelien-baudet/workflow-dispatch@v2
-      with:
-        workflow: CI
-        token: ${{ secrets.JAZZY_PAT }}
-        wait-for-completion: true
+    - uses: actions/checkout@v2
+    - run: swift build
 
   lint:
-    runs-on: macos-10.15
+    runs-on: macos-latest
     strategy:
       matrix:
         xcode:
-          - ^10
-          - ^11
-          - ^12
+          - '12.0'
+          - '12.4'
     steps:
     - uses: maxim-lobanov/setup-xcode@v1
       with:
         xcode-version: ${{ matrix.xcode }}
     - uses: actions/checkout@v2
-      with:
-        submodules: true
     - run: pod lib lint --fail-fast
 
   create-release:
     runs-on: ubuntu-latest
-    needs: [ci, lint]
-    env:
-      v: ${{ github.event.inputs.version }}
+    needs: [lint, build]
     steps:
     - uses: actions/checkout@v2
-      with:
-        fetch-depth: 0  # zero means “all” (or push fails)
-    - name: Update committed versions
-      run: |
-        ruby -i -pe "sub(/CURRENT_PROJECT_VERSION = [0-9.]+/, 'CURRENT_PROJECT_VERSION = $v')" PromiseKit.xcodeproj/project.pbxproj
-        ruby -i -pe "sub(/s.version = '[0-9.]+'/, 's.version = \'$v\'')" PromiseKit.podspec
-    - run: |
-        ! (git diff --quiet)
-    - name: Commit
-      run: |
-        git config user.name github-actions
-        git config user.email github-actions@github.com
-        git commit -am "PromiseKit $v"
-        git push
     - uses: softprops/action-gh-release@v1
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -69,5 +54,4 @@ jobs:
         workflow: CD
         token: ${{ secrets.JAZZY_PAT }}
         inputs: "{\"version\": \"${{ github.event.inputs.version }}\"}"
-        ref: master  # or doesn’t use our new commit above
-        wait-for-completion: true
+        wait-for-completion: false

Documents/Cancel.md

@@ -5,7 +5,9 @@ PromiseKit 7 adds clear and concise cancellation abilities to promises and to th
 ```swift
 UIApplication.shared.isNetworkActivityIndicatorVisible = true
 
-let fetchImage = URLSession.shared.dataTask(.promise, with: url).cancellize().compactMap{ UIImage(data: $0.data) }
+let fetchImage = URLSession.shared.dataTask(.promise, with: url)
+    .cancellize()
+    .compactMap{ UIImage(data: $0.data) }
 let fetchLocation = CLLocationManager.requestLocation().cancellize().lastValue
 
 let finalizer = firstly {
@@ -16,20 +18,23 @@ let finalizer = firstly {
 }.ensure {
     UIApplication.shared.isNetworkActivityIndicatorVisible = false
 }.catch(policy: .allErrors) { error in
-    /* 'catch' will be invoked with 'PMKError.cancelled' when cancel is called on the context.
-       Use the default policy of '.allErrorsExceptCancellation' to ignore cancellation errors. */
+    // `catch` will be invoked with `PMKError.cancelled` when cancel is called
+    // on the context. Use the default policy of `.allErrorsExceptCancellation`
+    // to ignore cancellation errors.
     self.show(UIAlertController(for: error), sender: self)
 }
 
 //…
 
-// Cancel currently active tasks and reject all cancellable promises with 'PMKError.cancelled'.
-// 'cancel()' can be called from any thread at any time.
+// Cancel currently active tasks and reject all cancellable promises
+// with 'PMKError.cancelled'.  `cancel()` can be called from any thread
+// at any time.
 finalizer.cancel()
 
-/* 'finalizer' here refers to the 'CancellableFinalizer' for the chain.  Calling 'cancel' on
-   any promise in the chain or on the finalizer cancels the entire chain.  Therefore
-   calling 'cancel' on the finalizer cancels everything. */
+// `finalizer` here refers to the `CancellableFinalizer` for the chain.
+// Calling 'cancel' on any promise in the chain or on the finalizer
+// cancels the entire chain.  Therefore calling `cancel` on the finalizer
+// cancels everything.
 ```
 
 # Cancel Chains

Tests/Cancel/AfterTests.swift

@@ -15,36 +15,36 @@ class AfterTests: XCTestCase {
         let ex2 = expectation(description: "")
         let cc2 = after(seconds: 0).cancellize().done(fail).catch(policy: .allErrors, ex2.fulfill)
         cc2.cancel()
-        waitForExpectations(timeout: 2, handler: nil)
+        waitForExpectations(timeout: 5, handler: nil)
 
         let ex3 = expectation(description: "")
         let cc3 = after(.seconds(0)).cancellize().done(fail).catch(policy: .allErrors, ex3.fulfill)
         cc3.cancel()
-        waitForExpectations(timeout: 2, handler: nil)
+        waitForExpectations(timeout: 5, handler: nil)
     }
 
     func testNegative() {
         let ex2 = expectation(description: "")
         let cc2 = after(seconds: -1).cancellize().done(fail).catch(policy: .allErrors, ex2.fulfill)
         cc2.cancel()
-        waitForExpectations(timeout: 2, handler: nil)
+        waitForExpectations(timeout: 5, handler: nil)
 
         let ex3 = expectation(description: "")
         let cc3 = after(.seconds(-1)).cancellize().done(fail).catch(policy: .allErrors, ex3.fulfill)
         cc3.cancel()
-        waitForExpectations(timeout: 2, handler: nil)
+        waitForExpectations(timeout: 5, handler: nil)
     }
 
     func testPositive() {
         let ex2 = expectation(description: "")
         let cc2 = after(seconds: 1).cancellize().done(fail).catch(policy: .allErrors, ex2.fulfill)
         cc2.cancel()
-        waitForExpectations(timeout: 2, handler: nil)
+        waitForExpectations(timeout: 5, handler: nil)
 
         let ex3 = expectation(description: "")
         let cc3 = after(.seconds(1)).cancellize().done(fail).catch(policy: .allErrors, ex3.fulfill)
         cc3.cancel()
-        waitForExpectations(timeout: 2, handler: nil)
+        waitForExpectations(timeout: 5, handler: nil)
     }
 
     func testCancellableAfter() {
@@ -87,7 +87,7 @@ class AfterTests: XCTestCase {
             error.isCancelled ? exCancel.fulfill() : XCTFail("unexpected error \(error)")
         }.cancel()
 
-        wait(for: [exComplete, exCancelComplete, exCancel], timeout: 1)
+        wait(for: [exComplete, exCancelComplete, exCancel], timeout: 5)
     }
 
     func testCancelForPromise_Done() {
@@ -104,7 +104,7 @@ class AfterTests: XCTestCase {
 
         promise.cancel()
 
-        wait(for: [exComplete], timeout: 1)
+        wait(for: [exComplete], timeout: 5)
     }
 
     func testCancelForGuarantee_Done() {
@@ -116,6 +116,6 @@ class AfterTests: XCTestCase {
             error.isCancelled ? exComplete.fulfill() : XCTFail("error: \(error)")
         }.cancel()
 
-        wait(for: [exComplete], timeout: 1)
+        wait(for: [exComplete], timeout: 5)
     }
 }

Tests/Cancel/CancelChain.swift

@@ -154,7 +154,7 @@ class CancelChain: XCTestCase {
             self.trace("SETUP COMPLETE")
 
             let expectations = [ex.a, ex.b, ex.c, ex.d, ex.e, ex.cancelled].compactMap { $0 }
-            wait(for: expectations, timeout: 1)
+            wait(for: expectations, timeout: 5)
 
             XCTAssert(c.pA.cancelContext.cancelAttempted)
             XCTAssert(ex.a == nil || isFulfilled(c.pB) || c.pB.cancelContext.cancelAttempted)

Tests/Cancel/CancellableErrorTests.swift

@@ -19,7 +19,7 @@ class CancellationTests: XCTestCase {
 
         p.cancel(with: LocalError.cancel)
 
-        waitForExpectations(timeout: 1)
+        waitForExpectations(timeout: 5)
     }
 
     func testThrowCancellableErrorThatIsNotCancelled() {
@@ -34,7 +34,7 @@ class CancellationTests: XCTestCase {
 
         cc.cancel(with: LocalError.notCancel)
 
-        waitForExpectations(timeout: 1)
+        waitForExpectations(timeout: 5)
     }
 
     func testRecoverWithCancellation() {
@@ -60,7 +60,7 @@ class CancellationTests: XCTestCase {
 
         p.cancel(with: CocoaError.cancelled)
 
-        waitForExpectations(timeout: 1)
+        waitForExpectations(timeout: 5)
     }
 
     func testFoundationBridging1() {
@@ -79,7 +79,7 @@ class CancellationTests: XCTestCase {
 
         p.cancel(with: CocoaError.cancelled)
 
-        waitForExpectations(timeout: 1)
+        waitForExpectations(timeout: 5)
     }
 
     func testFoundationBridging2() {
@@ -98,7 +98,7 @@ class CancellationTests: XCTestCase {
 
         p.cancel(with: URLError.cancelled)
 
-        waitForExpectations(timeout: 1)
+        waitForExpectations(timeout: 5)
     }
 
     func testIsCancelled() {

Tests/Cancel/CancellablePromiseTests.swift

@@ -37,7 +37,7 @@ class CancellablePromiseTests: XCTestCase {
 
         promise.cancel()
 
-        waitForExpectations(timeout: 1)
+        waitForExpectations(timeout: 5)
     }
 
     func testReturnTypeForAMultiLineClosureIsNotExplicitlyStated() {
@@ -56,7 +56,7 @@ class CancellablePromiseTests: XCTestCase {
             XCTFail()
         }
 
-        waitForExpectations(timeout: 1)
+        waitForExpectations(timeout: 5)
     }
 
     func testTryingToCancelAStandardPromiseChain() {
@@ -83,7 +83,7 @@ class CancellablePromiseTests: XCTestCase {
 
         promise.cancel()  /// <-- ERROR: Value of type 'PMKFinalizer' has no member 'cancel'
 
-        waitForExpectations(timeout: 1)
+        waitForExpectations(timeout: 5)
     }
 
     func testCancel() {
@@ -100,7 +100,7 @@ class CancellablePromiseTests: XCTestCase {
         p.resolver.fulfill(3)
         p.promise.cancel()
 
-        wait(for: [ex], timeout: 1)
+        wait(for: [ex], timeout: 5)
     }
 
     func testFirstly() {
@@ -116,7 +116,7 @@ class CancellablePromiseTests: XCTestCase {
             $0.isCancelled ? ex.fulfill() : XCTFail()
         }.cancel()
 
-        wait(for: [ex], timeout: 1)
+        wait(for: [ex], timeout: 5)
     }
 
     func testFirstlyWithPromise() {
@@ -132,7 +132,7 @@ class CancellablePromiseTests: XCTestCase {
             $0.isCancelled ? ex.fulfill() : XCTFail("\($0)")
         }.cancel()
 
-        wait(for: [ex], timeout: 1)
+        wait(for: [ex], timeout: 5)
     }
 
     func testThenMapSuccess() {
@@ -147,7 +147,7 @@ class CancellablePromiseTests: XCTestCase {
         }.catch(policy: .allErrors) { _ in
             XCTFail()
         }
-        waitForExpectations(timeout: 1)
+        waitForExpectations(timeout: 5)
     }
 
     func testThenMapCancel() {
@@ -163,7 +163,7 @@ class CancellablePromiseTests: XCTestCase {
         }.catch(policy: .allErrors) {
             $0.isCancelled ? ex.fulfill() : XCTFail()
         }.cancel()
-        waitForExpectations(timeout: 1)
+        waitForExpectations(timeout: 5)
     }
 
     func testChain() {
@@ -178,7 +178,7 @@ class CancellablePromiseTests: XCTestCase {
         }.catch(policy: .allErrors) {
             $0.isCancelled ? ex.fulfill() : XCTFail()
         }.cancel()
-        waitForExpectations(timeout: 1)
+        waitForExpectations(timeout: 5)
     }
 
     func testBridge() {
@@ -200,6 +200,6 @@ class CancellablePromiseTests: XCTestCase {
             XCTFail()
         }
 
-        waitForExpectations(timeout: 1)
+        waitForExpectations(timeout: 5)
     }
 }