Skip to content
This repository was archived by the owner on Jan 19, 2022. It is now read-only.

Commit 332ea72

Browse files
luispadronluispadron
authored
Merge pull request #170 from luispadron/features/v6.0.0
Version 6.0.0
2 parents e454856 + 3f62ae2 commit 332ea72

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+1223
-1310
lines changed

‎CHANGELOG.md

+10
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
# Version 6.0.0
2+
3+
- Fixed issue with API of `UICircularRingStyle` which made it impossible to have both a gradient and outer ring style, etc.
4+
- Refactor way that `UICircularRingValueFormatter` works. It's now a simple protocol which anyone can conform to. There are two concrete implementations from 5.0.0 which can still be used, however, they're now `struct`s so cannot be mutated.
5+
6+
### Breaking Changes
7+
8+
- Due to the fact that both the `.style` property now doesnt allow setting `.gradient`, this API has been broken. Instead, use the new `.gradientOptions` property to set a gradient, and `.style` if you need extra styling on top of gradient
9+
- Because the value formatter are now structs, they cannot be modified with `.` syntax. Instead create a brand new formatter and assign to the `.valueFormatter` property. This will be over all much better in the future, less state and structs are cool!
10+
111
# Version 5.1.0
212

313
*wow bug fixes already?*

‎UICircularProgressRing.podspec

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Pod::Spec.new do |s|
33

44
s.name = "UICircularProgressRing"
5-
s.version = "5.1.0"
5+
s.version = "6.0.0"
66
s.summary = "A highly customizable circular progress bar for iOS written in Swift"
77

88
s.description = <<-DESC

‎docs/Classes.html

+12-142
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<a title="Classes Reference"></a>
1515
<header>
1616
<div class="content-wrapper">
17-
<p><a href="index.html">UICircularProgressRing Docs</a> (97% documented)</p>
17+
<p><a href="index.html">UICircularProgressRing Docs</a> (96% documented)</p>
1818
<p class="header-right"><a href="https://github.com/luispadron/UICircularProgressRing"><img src="img/gh.png"/>View on GitHub</a></p>
1919
</div>
2020
</header>
@@ -34,24 +34,15 @@
3434
<li class="nav-group-task">
3535
<a href="Classes/UICircularProgressRing.html">UICircularProgressRing</a>
3636
</li>
37-
<li class="nav-group-task">
38-
<a href="Classes/UICircularProgressRingFormatter.html">UICircularProgressRingFormatter</a>
39-
</li>
4037
<li class="nav-group-task">
4138
<a href="Classes/UICircularRing.html">UICircularRing</a>
4239
</li>
43-
<li class="nav-group-task">
44-
<a href="Classes/UICircularRingValueFormatter.html">UICircularRingValueFormatter</a>
45-
</li>
4640
<li class="nav-group-task">
4741
<a href="Classes/UICircularTimerRing.html">UICircularTimerRing</a>
4842
</li>
4943
<li class="nav-group-task">
5044
<a href="Classes/UICircularTimerRing/State.html">– State</a>
5145
</li>
52-
<li class="nav-group-task">
53-
<a href="Classes/UICircularTimerRingFormatter.html">UICircularTimerRingFormatter</a>
54-
</li>
5546
</ul>
5647
</li>
5748
<li class="nav-group-name">
@@ -71,17 +62,26 @@
7162
<li class="nav-group-task">
7263
<a href="Protocols/UICircularProgressRingDelegate.html">UICircularProgressRingDelegate</a>
7364
</li>
65+
<li class="nav-group-task">
66+
<a href="Protocols/UICircularRingValueFormatter.html">UICircularRingValueFormatter</a>
67+
</li>
7468
</ul>
7569
</li>
7670
<li class="nav-group-name">
7771
<a href="Structs.html">Structures</a>
7872
<ul class="nav-group-tasks">
7973
<li class="nav-group-task">
80-
<a href="Structs/UICircularGradientOptions.html">UICircularGradientOptions</a>
74+
<a href="Structs/UICircularProgressRingFormatter.html">UICircularProgressRingFormatter</a>
75+
</li>
76+
<li class="nav-group-task">
77+
<a href="Structs/UICircularRingGradientOptions.html">UICircularRingGradientOptions</a>
8178
</li>
8279
<li class="nav-group-task">
8380
<a href="Structs/UICircularRingValueKnobStyle.html">UICircularRingValueKnobStyle</a>
8481
</li>
82+
<li class="nav-group-task">
83+
<a href="Structs/UICircularTimerRingFormatter.html">UICircularTimerRingFormatter</a>
84+
</li>
8585
</ul>
8686
</li>
8787
</ul>
@@ -172,136 +172,6 @@ <h4>Declaration</h4>
172172
</li>
173173
</ul>
174174
</div>
175-
<div class="task-group">
176-
<div class="task-name-container">
177-
<a name="/UICircularRingValueFormatter"></a>
178-
<a name="//apple_ref/swift/Section/UICircularRingValueFormatter" class="dashAnchor"></a>
179-
<a href="#/UICircularRingValueFormatter">
180-
<h3 class="section-name">UICircularRingValueFormatter</h3>
181-
</a>
182-
</div>
183-
<ul>
184-
<li class="item">
185-
<div>
186-
<code>
187-
<a name="/c:@M@UICircularProgressRing@objc(cs)UICircularRingValueFormatter"></a>
188-
<a name="//apple_ref/swift/Class/UICircularRingValueFormatter" class="dashAnchor"></a>
189-
<a class="token" href="#/c:@M@UICircularProgressRing@objc(cs)UICircularRingValueFormatter">UICircularRingValueFormatter</a>
190-
</code>
191-
</div>
192-
<div class="height-container">
193-
<div class="pointer-container"></div>
194-
<section class="section">
195-
<div class="pointer"></div>
196-
<div class="abstract">
197-
<p>UICricularRingValueFormatter</p>
198-
199-
<p>The base class for all the UICircularRing formatters.
200-
Subclasses should implement <code>string(forValue:)</code> as this is used
201-
to format the value into a string in the base class</p>
202-
203-
<p>Two concrete implementations are provided, refer to <code><a href="Classes/UICircularTimerRingFormatter.html">UICircularTimerRingFormatter</a></code>
204-
and <code><a href="Classes/UICircularProgressRingFormatter.html">UICircularProgressRingFormatter</a></code></p>
205-
206-
<a href="Classes/UICircularRingValueFormatter.html" class="slightly-smaller">See more</a>
207-
</div>
208-
<div class="declaration">
209-
<h4>Declaration</h4>
210-
<div class="language">
211-
<p class="aside-title">Swift</p>
212-
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">UICircularRingValueFormatter</span> <span class="p">:</span> <span class="kt">Formatter</span></code></pre>
213-
214-
</div>
215-
</div>
216-
</section>
217-
</div>
218-
</li>
219-
</ul>
220-
</div>
221-
<div class="task-group">
222-
<div class="task-name-container">
223-
<a name="/UICircularTimerRingFormatter"></a>
224-
<a name="//apple_ref/swift/Section/UICircularTimerRingFormatter" class="dashAnchor"></a>
225-
<a href="#/UICircularTimerRingFormatter">
226-
<h3 class="section-name">UICircularTimerRingFormatter</h3>
227-
</a>
228-
</div>
229-
<ul>
230-
<li class="item">
231-
<div>
232-
<code>
233-
<a name="/c:@M@UICircularProgressRing@objc(cs)UICircularTimerRingFormatter"></a>
234-
<a name="//apple_ref/swift/Class/UICircularTimerRingFormatter" class="dashAnchor"></a>
235-
<a class="token" href="#/c:@M@UICircularProgressRing@objc(cs)UICircularTimerRingFormatter">UICircularTimerRingFormatter</a>
236-
</code>
237-
</div>
238-
<div class="height-container">
239-
<div class="pointer-container"></div>
240-
<section class="section">
241-
<div class="pointer"></div>
242-
<div class="abstract">
243-
<p>UICircularTimerRingFormatter</p>
244-
245-
<p>The formatter used in UICircularTimerRing class, formats
246-
the ring value into a time string.</p>
247-
248-
<a href="Classes/UICircularTimerRingFormatter.html" class="slightly-smaller">See more</a>
249-
</div>
250-
<div class="declaration">
251-
<h4>Declaration</h4>
252-
<div class="language">
253-
<p class="aside-title">Swift</p>
254-
<pre class="highlight swift"><code><span class="kd">final</span> <span class="kd">public</span> <span class="kd">class</span> <span class="kt">UICircularTimerRingFormatter</span> <span class="p">:</span> <span class="kt"><a href="Classes/UICircularRingValueFormatter.html">UICircularRingValueFormatter</a></span></code></pre>
255-
256-
</div>
257-
</div>
258-
</section>
259-
</div>
260-
</li>
261-
</ul>
262-
</div>
263-
<div class="task-group">
264-
<div class="task-name-container">
265-
<a name="/UICircularProgressRingFormatter"></a>
266-
<a name="//apple_ref/swift/Section/UICircularProgressRingFormatter" class="dashAnchor"></a>
267-
<a href="#/UICircularProgressRingFormatter">
268-
<h3 class="section-name">UICircularProgressRingFormatter</h3>
269-
</a>
270-
</div>
271-
<ul>
272-
<li class="item">
273-
<div>
274-
<code>
275-
<a name="/c:@M@UICircularProgressRing@objc(cs)UICircularProgressRingFormatter"></a>
276-
<a name="//apple_ref/swift/Class/UICircularProgressRingFormatter" class="dashAnchor"></a>
277-
<a class="token" href="#/c:@M@UICircularProgressRing@objc(cs)UICircularProgressRingFormatter">UICircularProgressRingFormatter</a>
278-
</code>
279-
</div>
280-
<div class="height-container">
281-
<div class="pointer-container"></div>
282-
<section class="section">
283-
<div class="pointer"></div>
284-
<div class="abstract">
285-
<p>UICircularProgressRingFormatter</p>
286-
287-
<p>The formatter used in UICircularProgressRing class,
288-
responsible for formatting the value of the ring into a readable string</p>
289-
290-
<a href="Classes/UICircularProgressRingFormatter.html" class="slightly-smaller">See more</a>
291-
</div>
292-
<div class="declaration">
293-
<h4>Declaration</h4>
294-
<div class="language">
295-
<p class="aside-title">Swift</p>
296-
<pre class="highlight swift"><code><span class="kd">final</span> <span class="kd">public</span> <span class="kd">class</span> <span class="kt">UICircularProgressRingFormatter</span> <span class="p">:</span> <span class="kt"><a href="Classes/UICircularRingValueFormatter.html">UICircularRingValueFormatter</a></span></code></pre>
297-
298-
</div>
299-
</div>
300-
</section>
301-
</div>
302-
</li>
303-
</ul>
304-
</div>
305175
<div class="task-group">
306176
<ul>
307177
<li class="item">
@@ -337,7 +207,7 @@ <h4>Declaration</h4>
337207
</section>
338208
</section>
339209
<section id="footer">
340-
<p>&copy; 2019 <a class="link" href="https://luispadron.com" target="_blank" rel="external">Luis</a>. All rights reserved. (Last updated: 2019-02-08)</p>
210+
<p>&copy; 2019 <a class="link" href="https://luispadron.com" target="_blank" rel="external">Luis</a>. All rights reserved. (Last updated: 2019-02-22)</p>
341211
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
342212
</section>
343213
</article>

‎docs/Classes/UICircularProgressRing.html

+16-16
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<a title="UICircularProgressRing Class Reference"></a>
1515
<header>
1616
<div class="content-wrapper">
17-
<p><a href="../index.html">UICircularProgressRing Docs</a> (97% documented)</p>
17+
<p><a href="../index.html">UICircularProgressRing Docs</a> (96% documented)</p>
1818
<p class="header-right"><a href="https://github.com/luispadron/UICircularProgressRing"><img src="../img/gh.png"/>View on GitHub</a></p>
1919
</div>
2020
</header>
@@ -34,24 +34,15 @@
3434
<li class="nav-group-task">
3535
<a href="../Classes/UICircularProgressRing.html">UICircularProgressRing</a>
3636
</li>
37-
<li class="nav-group-task">
38-
<a href="../Classes/UICircularProgressRingFormatter.html">UICircularProgressRingFormatter</a>
39-
</li>
4037
<li class="nav-group-task">
4138
<a href="../Classes/UICircularRing.html">UICircularRing</a>
4239
</li>
43-
<li class="nav-group-task">
44-
<a href="../Classes/UICircularRingValueFormatter.html">UICircularRingValueFormatter</a>
45-
</li>
4640
<li class="nav-group-task">
4741
<a href="../Classes/UICircularTimerRing.html">UICircularTimerRing</a>
4842
</li>
4943
<li class="nav-group-task">
5044
<a href="../Classes/UICircularTimerRing/State.html">– State</a>
5145
</li>
52-
<li class="nav-group-task">
53-
<a href="../Classes/UICircularTimerRingFormatter.html">UICircularTimerRingFormatter</a>
54-
</li>
5546
</ul>
5647
</li>
5748
<li class="nav-group-name">
@@ -71,17 +62,26 @@
7162
<li class="nav-group-task">
7263
<a href="../Protocols/UICircularProgressRingDelegate.html">UICircularProgressRingDelegate</a>
7364
</li>
65+
<li class="nav-group-task">
66+
<a href="../Protocols/UICircularRingValueFormatter.html">UICircularRingValueFormatter</a>
67+
</li>
7468
</ul>
7569
</li>
7670
<li class="nav-group-name">
7771
<a href="../Structs.html">Structures</a>
7872
<ul class="nav-group-tasks">
7973
<li class="nav-group-task">
80-
<a href="../Structs/UICircularGradientOptions.html">UICircularGradientOptions</a>
74+
<a href="../Structs/UICircularProgressRingFormatter.html">UICircularProgressRingFormatter</a>
75+
</li>
76+
<li class="nav-group-task">
77+
<a href="../Structs/UICircularRingGradientOptions.html">UICircularRingGradientOptions</a>
8178
</li>
8279
<li class="nav-group-task">
8380
<a href="../Structs/UICircularRingValueKnobStyle.html">UICircularRingValueKnobStyle</a>
8481
</li>
82+
<li class="nav-group-task">
83+
<a href="../Structs/UICircularTimerRingFormatter.html">UICircularTimerRingFormatter</a>
84+
</li>
8585
</ul>
8686
</li>
8787
</ul>
@@ -340,9 +340,9 @@ <h4>Declaration</h4>
340340
<li class="item">
341341
<div>
342342
<code>
343-
<a name="/s:22UICircularProgressRingAAC14valueFormatterAA0abcE0Cvp"></a>
343+
<a name="/s:22UICircularProgressRingAAC14valueFormatterAA0ac5ValueE0_pvp"></a>
344344
<a name="//apple_ref/swift/Property/valueFormatter" class="dashAnchor"></a>
345-
<a class="token" href="#/s:22UICircularProgressRingAAC14valueFormatterAA0abcE0Cvp">valueFormatter</a>
345+
<a class="token" href="#/s:22UICircularProgressRingAAC14valueFormatterAA0ac5ValueE0_pvp">valueFormatter</a>
346346
</code>
347347
</div>
348348
<div class="height-container">
@@ -354,7 +354,7 @@ <h4>Declaration</h4>
354354
value of the progress ring into a readable text string
355355
which is then displayed in the label of the ring.</p>
356356

357-
<p>Default formatter is of type <code><a href="../Classes/UICircularProgressRingFormatter.html">UICircularProgressRingFormatter</a></code>.</p>
357+
<p>Default formatter is of type <code><a href="../Structs/UICircularProgressRingFormatter.html">UICircularProgressRingFormatter</a></code>.</p>
358358
<h2 id='author' class='heading'>Author</h2>
359359

360360
<p>Luis Padron</p>
@@ -364,7 +364,7 @@ <h2 id='author' class='heading'>Author</h2>
364364
<h4>Declaration</h4>
365365
<div class="language">
366366
<p class="aside-title">Swift</p>
367-
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">valueFormatter</span><span class="p">:</span> <span class="kt"><a href="../Classes/UICircularProgressRingFormatter.html">UICircularProgressRingFormatter</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
367+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">valueFormatter</span><span class="p">:</span> <span class="kt"><a href="../Protocols/UICircularRingValueFormatter.html">UICircularRingValueFormatter</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
368368

369369
</div>
370370
</div>
@@ -591,7 +591,7 @@ <h4>Declaration</h4>
591591
</section>
592592
</section>
593593
<section id="footer">
594-
<p>&copy; 2019 <a class="link" href="https://luispadron.com" target="_blank" rel="external">Luis</a>. All rights reserved. (Last updated: 2019-02-08)</p>
594+
<p>&copy; 2019 <a class="link" href="https://luispadron.com" target="_blank" rel="external">Luis</a>. All rights reserved. (Last updated: 2019-02-22)</p>
595595
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
596596
</section>
597597
</article>

0 commit comments

Comments
 (0)