Prepped the AFNAI 3.0.0-beta.1 release (#50)

* Added release notes to the CHANGELOG and bumped version to 3.0.0-beta.1 * Updated the jazzy docs for the 3.0.0-beta.1 release
Alamofire · Apr 10, 2019 · b319d07 · b319d07
1 parent c45ceef
commit b319d07
Show file tree

Hide file tree

Showing 17 changed files with 159 additions and 68 deletions.
diff --git a/AlamofireNetworkActivityIndicator.podspec b/AlamofireNetworkActivityIndicator.podspec
@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name = 'AlamofireNetworkActivityIndicator'
-  s.version = '2.4.0'
+  s.version = '3.0.0-beta.1'
   s.license = 'MIT'
   s.summary = 'Controls the visibility of the network activity indicator on iOS using Alamofire'
   s.homepage = 'https://github.com/Alamofire/AlamofireNetworkActivityIndicator'

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,9 @@
 All notable changes to this project will be documented in this file.
 `AlamofireNetworkActivityIndicator` adheres to [Semantic Versioning](http://semver.org/).
 
+#### 3.x Releases
+- `3.0.0` Betas - [3.0.0-beta.1](#300-beta1)
+
 #### 2.x Releases
 - `2.4.x` Releases - [2.4.0](#240)
 - `2.3.x` Releases - [2.3.0](#230)
@@ -15,6 +18,24 @@ All notable changes to this project will be documented in this file.
 
 ---
 
+## [3.0.0-beta.1](https://github.com/Alamofire/AlamofireNetworkActivityIndicator/releases/tag/3.0.0-beta.1)
+Released on 2019-04-10. All issues associated with this milestone can be found using this
+[filter](https://github.com/Alamofire/AlamofireNetworkActivityIndicator/milestone/11?closed=1).
+
+#### Added
+- New `requestDidStart` and `requestDidStop` APIs based on `requestIDs` to replace the increment and decrement activity count APIs.
+  - Added by [Christian Noon](https://github.com/cnoon) in Pull Request [#49](https://github.com/Alamofire/AlamofireNetworkActivityIndicator/pull/49).
+
+#### Updated
+- Project to use Swift 5 only and require Alamofire 5.0.0-beta.4+ as a dependency.
+  - Updated by [Christian Noon](https://github.com/cnoon) in Pull Request [#48](https://github.com/Alamofire/AlamofireNetworkActivityIndicator/pull/48).
+
+#### Fixed
+- Issue where activity count could become negative causing the network activity indicator to not display correctly.
+  - Fixed by [Christian Noon](https://github.com/cnoon) in regards to Issue [#38](https://github.com/Alamofire/AlamofireNetworkActivityIndicator/issues/38) in Pull Request [#49](https://github.com/Alamofire/AlamofireNetworkActivityIndicator/pull/49).
+
+---
+
 ## [2.4.0](https://github.com/Alamofire/AlamofireNetworkActivityIndicator/releases/tag/2.4.0)
 Released on 2019-04-06. All issues associated with this milestone can be found using this
 [filter](https://github.com/Alamofire/AlamofireNetworkActivityIndicator/milestone/10?closed=1).
@@ -132,7 +153,7 @@ Released on 2016-09-11. All issues associated with this milestone can be found u
   - Updated by [Christian Noon](https://github.com/cnoon).
 - The podspec version to 2.0.0 and bumped deployment target and dependency.
   - Updated by [Christian Noon](https://github.com/cnoon).
-- Project settings by running Swift 3 conversion tool and setting 
+- Project settings by running Swift 3 conversion tool and setting
   ALWAYS_EMBED_SWIFT_STANDARD_LIBRARIES to YES.
   - Updated by [Christian Noon](https://github.com/cnoon).
 - The travis-ci yaml file to build against Xcode 8 osx_image.

diff --git a/Source/Info.plist b/Source/Info.plist
@@ -15,7 +15,7 @@
 	<key>CFBundlePackageType</key>
 	<string>FMWK</string>
 	<key>CFBundleShortVersionString</key>
-	<string>2.4.0</string>
+	<string>3.0.0-beta.1</string>
 	<key>CFBundleSignature</key>
 	<string>????</string>
 	<key>CFBundleVersion</key>

diff --git a/docs/Classes.html b/docs/Classes.html
@@ -128,7 +128,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2019 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2019-04-06)</p>
+      <p>&copy; 2019 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2019-04-10)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/Classes/NetworkActivityIndicatorManager.html b/docs/Classes/NetworkActivityIndicatorManager.html
@@ -312,74 +312,106 @@ <h4>Declaration</h4>
             </div>
             <div class="task-group">
               <div class="task-name-container">
-                <a name="/Activity%20Count"></a>
-                <a name="//apple_ref/swift/Section/Activity Count" class="dashAnchor"></a>
-                <a href="#/Activity%20Count">
-                  <h3 class="section-name">Activity Count</h3>
+                <a name="/Request%20Tracking"></a>
+                <a name="//apple_ref/swift/Section/Request Tracking" class="dashAnchor"></a>
+                <a href="#/Request%20Tracking">
+                  <h3 class="section-name">Request Tracking</h3>
                 </a>
               </div>
               <ul class="item-container">
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:33AlamofireNetworkActivityIndicator0bcD7ManagerC09incrementC5CountyyF"></a>
-                    <a name="//apple_ref/swift/Method/incrementActivityCount()" class="dashAnchor"></a>
-                    <a class="token" href="#/s:33AlamofireNetworkActivityIndicator0bcD7ManagerC09incrementC5CountyyF">incrementActivityCount()</a>
+                    <a name="/s:33AlamofireNetworkActivityIndicator0bcD7ManagerC15requestDidStart0F2IDySS_tF"></a>
+                    <a name="//apple_ref/swift/Method/requestDidStart(requestID:)" class="dashAnchor"></a>
+                    <a class="token" href="#/s:33AlamofireNetworkActivityIndicator0bcD7ManagerC15requestDidStart0F2IDySS_tF">requestDidStart(requestID:)</a>
                     </code>
                   </div>
                   <div class="height-container">
                     <div class="pointer-container"></div>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-                        <p>Increments the number of active network requests.</p>
+                        <p>Adds the requestID as an active request driving the activity indicator.</p>
 
-<p>If this number was zero before incrementing, the network activity indicator will start spinning after
-the <code><a href="../Classes/NetworkActivityIndicatorManager.html#/s:33AlamofireNetworkActivityIndicator0bcD7ManagerC10startDelaySdvp">startDelay</a></code>.</p>
-
-<p>Generally, this method should not need to be used directly.</p>
+<p>This method results in a no-op if the request is already being tracked.</p>
 
                       </div>
                       <div class="declaration">
                         <h4>Declaration</h4>
                         <div class="language">
                           <p class="aside-title">Swift</p>
-                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">incrementActivityCount</span><span class="p">()</span></code></pre>
+                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">requestDidStart</span><span class="p">(</span><span class="nv">requestID</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre>
 
                         </div>
                       </div>
+                      <div>
+                        <h4>Parameters</h4>
+                        <table class="graybox">
+                          <tbody>
+                            <tr>
+                              <td>
+                                <code>
+                                <em>requestID</em>
+                                </code>
+                              </td>
+                              <td>
+                                <div>
+                                  <p>The request identifier.</p>
+                                </div>
+                              </td>
+                            </tr>
+                          </tbody>
+                        </table>
+                      </div>
                     </section>
                   </div>
                 </li>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:33AlamofireNetworkActivityIndicator0bcD7ManagerC09decrementC5CountyyF"></a>
-                    <a name="//apple_ref/swift/Method/decrementActivityCount()" class="dashAnchor"></a>
-                    <a class="token" href="#/s:33AlamofireNetworkActivityIndicator0bcD7ManagerC09decrementC5CountyyF">decrementActivityCount()</a>
+                    <a name="/s:33AlamofireNetworkActivityIndicator0bcD7ManagerC14requestDidStop0F2IDySS_tF"></a>
+                    <a name="//apple_ref/swift/Method/requestDidStop(requestID:)" class="dashAnchor"></a>
+                    <a class="token" href="#/s:33AlamofireNetworkActivityIndicator0bcD7ManagerC14requestDidStop0F2IDySS_tF">requestDidStop(requestID:)</a>
                     </code>
                   </div>
                   <div class="height-container">
                     <div class="pointer-container"></div>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-                        <p>Decrements the number of active network requests.</p>
+                        <p>Removes the requestID from the set of active requests driving the activity indicator.</p>
 
-<p>If the number of active requests is zero after calling this method, the network activity indicator will stop
-spinning after the <code><a href="../Classes/NetworkActivityIndicatorManager.html#/s:33AlamofireNetworkActivityIndicator0bcD7ManagerC15completionDelaySdvp">completionDelay</a></code>.</p>
-
-<p>Generally, this method should not need to be used directly.</p>
+<p>This method results in a no-op if the request is not being tracked.</p>
 
                       </div>
                       <div class="declaration">
                         <h4>Declaration</h4>
                         <div class="language">
                           <p class="aside-title">Swift</p>
-                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">decrementActivityCount</span><span class="p">()</span></code></pre>
+                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">requestDidStop</span><span class="p">(</span><span class="nv">requestID</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre>
 
                         </div>
                       </div>
+                      <div>
+                        <h4>Parameters</h4>
+                        <table class="graybox">
+                          <tbody>
+                            <tr>
+                              <td>
+                                <code>
+                                <em>requestID</em>
+                                </code>
+                              </td>
+                              <td>
+                                <div>
+                                  <p>The request identifier.</p>
+                                </div>
+                              </td>
+                            </tr>
+                          </tbody>
+                        </table>
+                      </div>
                     </section>
                   </div>
                 </li>
@@ -391,7 +423,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2019 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2019-04-06)</p>
+      <p>&copy; 2019 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2019-04-10)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
     </section>
   </body>

diff --git a/...ocsets/AlamofireNetworkActivityIndicator.docset/Contents/Resources/Documents/Classes.html b/...ocsets/AlamofireNetworkActivityIndicator.docset/Contents/Resources/Documents/Classes.html
@@ -128,7 +128,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2019 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2019-04-06)</p>
+      <p>&copy; 2019 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2019-04-10)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
     </section>
   </body>