Skip to content

Commit b319d07

Browse files
cnooncnoon
authored
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
1 parent c45ceef commit b319d07

17 files changed

+159
-68
lines changed

‎AlamofireNetworkActivityIndicator.podspec‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Pod::Spec.new do |s|
22
s.name = 'AlamofireNetworkActivityIndicator'
3-
s.version = '2.4.0'
3+
s.version = '3.0.0-beta.1'
44
s.license = 'MIT'
55
s.summary = 'Controls the visibility of the network activity indicator on iOS using Alamofire'
66
s.homepage = 'https://github.com/Alamofire/AlamofireNetworkActivityIndicator'

‎CHANGELOG.md‎

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
All notable changes to this project will be documented in this file.
33
`AlamofireNetworkActivityIndicator` adheres to [Semantic Versioning](http://semver.org/).
44

5+
#### 3.x Releases
6+
- `3.0.0` Betas - [3.0.0-beta.1](#300-beta1)
7+
58
#### 2.x Releases
69
- `2.4.x` Releases - [2.4.0](#240)
710
- `2.3.x` Releases - [2.3.0](#230)
@@ -15,6 +18,24 @@ All notable changes to this project will be documented in this file.
1518

1619
---
1720

21+
## [3.0.0-beta.1](https://github.com/Alamofire/AlamofireNetworkActivityIndicator/releases/tag/3.0.0-beta.1)
22+
Released on 2019-04-10. All issues associated with this milestone can be found using this
23+
[filter](https://github.com/Alamofire/AlamofireNetworkActivityIndicator/milestone/11?closed=1).
24+
25+
#### Added
26+
- New `requestDidStart` and `requestDidStop` APIs based on `requestIDs` to replace the increment and decrement activity count APIs.
27+
- Added by [Christian Noon](https://github.com/cnoon) in Pull Request [#49](https://github.com/Alamofire/AlamofireNetworkActivityIndicator/pull/49).
28+
29+
#### Updated
30+
- Project to use Swift 5 only and require Alamofire 5.0.0-beta.4+ as a dependency.
31+
- Updated by [Christian Noon](https://github.com/cnoon) in Pull Request [#48](https://github.com/Alamofire/AlamofireNetworkActivityIndicator/pull/48).
32+
33+
#### Fixed
34+
- Issue where activity count could become negative causing the network activity indicator to not display correctly.
35+
- 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).
36+
37+
---
38+
1839
## [2.4.0](https://github.com/Alamofire/AlamofireNetworkActivityIndicator/releases/tag/2.4.0)
1940
Released on 2019-04-06. All issues associated with this milestone can be found using this
2041
[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
132153
- Updated by [Christian Noon](https://github.com/cnoon).
133154
- The podspec version to 2.0.0 and bumped deployment target and dependency.
134155
- Updated by [Christian Noon](https://github.com/cnoon).
135-
- Project settings by running Swift 3 conversion tool and setting
156+
- Project settings by running Swift 3 conversion tool and setting
136157
ALWAYS_EMBED_SWIFT_STANDARD_LIBRARIES to YES.
137158
- Updated by [Christian Noon](https://github.com/cnoon).
138159
- The travis-ci yaml file to build against Xcode 8 osx_image.

‎Source/Info.plist‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
<key>CFBundlePackageType</key>
1616
<string>FMWK</string>
1717
<key>CFBundleShortVersionString</key>
18-
<string>2.4.0</string>
18+
<string>3.0.0-beta.1</string>
1919
<key>CFBundleSignature</key>
2020
<string>????</string>
2121
<key>CFBundleVersion</key>

‎docs/Classes.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ <h4>Declaration</h4>
128128
</article>
129129
</div>
130130
<section class="footer">
131-
<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>
131+
<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>
132132
<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>
133133
</section>
134134
</body>

‎docs/Classes/NetworkActivityIndicatorManager.html‎

Lines changed: 55 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -312,74 +312,106 @@ <h4>Declaration</h4>
312312
</div>
313313
<div class="task-group">
314314
<div class="task-name-container">
315-
<a name="/Activity%20Count"></a>
316-
<a name="//apple_ref/swift/Section/Activity Count" class="dashAnchor"></a>
317-
<a href="#/Activity%20Count">
318-
<h3 class="section-name">Activity Count</h3>
315+
<a name="/Request%20Tracking"></a>
316+
<a name="//apple_ref/swift/Section/Request Tracking" class="dashAnchor"></a>
317+
<a href="#/Request%20Tracking">
318+
<h3 class="section-name">Request Tracking</h3>
319319
</a>
320320
</div>
321321
<ul class="item-container">
322322
<li class="item">
323323
<div>
324324
<code>
325-
<a name="/s:33AlamofireNetworkActivityIndicator0bcD7ManagerC09incrementC5CountyyF"></a>
326-
<a name="//apple_ref/swift/Method/incrementActivityCount()" class="dashAnchor"></a>
327-
<a class="token" href="#/s:33AlamofireNetworkActivityIndicator0bcD7ManagerC09incrementC5CountyyF">incrementActivityCount()</a>
325+
<a name="/s:33AlamofireNetworkActivityIndicator0bcD7ManagerC15requestDidStart0F2IDySS_tF"></a>
326+
<a name="//apple_ref/swift/Method/requestDidStart(requestID:)" class="dashAnchor"></a>
327+
<a class="token" href="#/s:33AlamofireNetworkActivityIndicator0bcD7ManagerC15requestDidStart0F2IDySS_tF">requestDidStart(requestID:)</a>
328328
</code>
329329
</div>
330330
<div class="height-container">
331331
<div class="pointer-container"></div>
332332
<section class="section">
333333
<div class="pointer"></div>
334334
<div class="abstract">
335-
<p>Increments the number of active network requests.</p>
335+
<p>Adds the requestID as an active request driving the activity indicator.</p>
336336

337-
<p>If this number was zero before incrementing, the network activity indicator will start spinning after
338-
the <code><a href="../Classes/NetworkActivityIndicatorManager.html#/s:33AlamofireNetworkActivityIndicator0bcD7ManagerC10startDelaySdvp">startDelay</a></code>.</p>
339-
340-
<p>Generally, this method should not need to be used directly.</p>
337+
<p>This method results in a no-op if the request is already being tracked.</p>
341338

342339
</div>
343340
<div class="declaration">
344341
<h4>Declaration</h4>
345342
<div class="language">
346343
<p class="aside-title">Swift</p>
347-
<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>
344+
<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>
348345

349346
</div>
350347
</div>
348+
<div>
349+
<h4>Parameters</h4>
350+
<table class="graybox">
351+
<tbody>
352+
<tr>
353+
<td>
354+
<code>
355+
<em>requestID</em>
356+
</code>
357+
</td>
358+
<td>
359+
<div>
360+
<p>The request identifier.</p>
361+
</div>
362+
</td>
363+
</tr>
364+
</tbody>
365+
</table>
366+
</div>
351367
</section>
352368
</div>
353369
</li>
354370
<li class="item">
355371
<div>
356372
<code>
357-
<a name="/s:33AlamofireNetworkActivityIndicator0bcD7ManagerC09decrementC5CountyyF"></a>
358-
<a name="//apple_ref/swift/Method/decrementActivityCount()" class="dashAnchor"></a>
359-
<a class="token" href="#/s:33AlamofireNetworkActivityIndicator0bcD7ManagerC09decrementC5CountyyF">decrementActivityCount()</a>
373+
<a name="/s:33AlamofireNetworkActivityIndicator0bcD7ManagerC14requestDidStop0F2IDySS_tF"></a>
374+
<a name="//apple_ref/swift/Method/requestDidStop(requestID:)" class="dashAnchor"></a>
375+
<a class="token" href="#/s:33AlamofireNetworkActivityIndicator0bcD7ManagerC14requestDidStop0F2IDySS_tF">requestDidStop(requestID:)</a>
360376
</code>
361377
</div>
362378
<div class="height-container">
363379
<div class="pointer-container"></div>
364380
<section class="section">
365381
<div class="pointer"></div>
366382
<div class="abstract">
367-
<p>Decrements the number of active network requests.</p>
383+
<p>Removes the requestID from the set of active requests driving the activity indicator.</p>
368384

369-
<p>If the number of active requests is zero after calling this method, the network activity indicator will stop
370-
spinning after the <code><a href="../Classes/NetworkActivityIndicatorManager.html#/s:33AlamofireNetworkActivityIndicator0bcD7ManagerC15completionDelaySdvp">completionDelay</a></code>.</p>
371-
372-
<p>Generally, this method should not need to be used directly.</p>
385+
<p>This method results in a no-op if the request is not being tracked.</p>
373386

374387
</div>
375388
<div class="declaration">
376389
<h4>Declaration</h4>
377390
<div class="language">
378391
<p class="aside-title">Swift</p>
379-
<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>
392+
<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>
380393

381394
</div>
382395
</div>
396+
<div>
397+
<h4>Parameters</h4>
398+
<table class="graybox">
399+
<tbody>
400+
<tr>
401+
<td>
402+
<code>
403+
<em>requestID</em>
404+
</code>
405+
</td>
406+
<td>
407+
<div>
408+
<p>The request identifier.</p>
409+
</div>
410+
</td>
411+
</tr>
412+
</tbody>
413+
</table>
414+
</div>
383415
</section>
384416
</div>
385417
</li>
@@ -391,7 +423,7 @@ <h4>Declaration</h4>
391423
</article>
392424
</div>
393425
<section class="footer">
394-
<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>
426+
<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>
395427
<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>
396428
</section>
397429
</body>

‎docs/docsets/AlamofireNetworkActivityIndicator.docset/Contents/Resources/Documents/Classes.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ <h4>Declaration</h4>
128128
</article>
129129
</div>
130130
<section class="footer">
131-
<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>
131+
<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>
132132
<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>
133133
</section>
134134
</body>

0 commit comments

Comments
 (0)