Prepare 0.3.0 release (#146)

This prepares the repo for the 0.3.0 release
plangrid · Sep 20, 2018 · 7811400 · 7811400
1 parent 9112718
commit 7811400
Show file tree

Hide file tree

Showing 69 changed files with 333 additions and 1,038 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,9 +4,14 @@ The changelog for `ReactiveLists`. Also see the [releases](https://github.com/pl
 
 ------
 
-0.3.0 (NEXT)
+0.4.0 (NEXT)
 ------------
 
+This release closes the [0.4.0 milestone](https://github.com/plangrid/ReactiveLists/milestone/10).
+
+0.3.0
+-----
+
 This release closes the [0.3.0 milestone](https://github.com/plangrid/ReactiveLists/milestone/9).
 
 ### New

diff --git a/ReactiveLists.podspec b/ReactiveLists.podspec
@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name = "ReactiveLists"
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.summary = "React-like API for UITableView and UICollectionView"
   s.homepage = "https://github.com/plangrid/ReactiveLists"

diff --git a/Sources/Diffing.swift b/Sources/Diffing.swift
@@ -48,6 +48,8 @@ public extension DiffableViewModel {
 /// These are only created internally from either `TableCellViewModel` or `CollectionCellViewModel`,
 /// so that we can safely force cast the models back to those types.
 public struct AnyDiffableViewModel {
+
+    /// The type-erased `DiffableViewModel`
     public let model: DiffableViewModel
 
     /// Holds implementation of `Differentiable.isContentEqual(to:)`, so that the model's concrete

diff --git a/docs/Classes.html b/docs/Classes.html
@@ -14,7 +14,7 @@
     <a title="Classes  Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="index.html">ReactiveLists Docs</a> (91% documented)</p>
+        <p><a href="index.html">ReactiveLists Docs</a> (100% documented)</p>
         <p class="header-right"><a href="https://github.com/plangrid/ReactiveLists"><img src="img/gh.png"/>View on GitHub</a></p>
       </div>
     </header>
@@ -211,7 +211,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2018 <a class="link" href="https://twitter.com/PlanGrid" target="_blank" rel="external">PlanGrid</a>. All rights reserved. (Last updated: 2018-09-11)</p>
+          <p>&copy; 2018 <a class="link" href="https://twitter.com/PlanGrid" target="_blank" rel="external">PlanGrid</a>. All rights reserved. (Last updated: 2018-09-20)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/Classes/CollectionViewDriver.html b/docs/Classes/CollectionViewDriver.html
@@ -14,7 +14,7 @@
     <a title="CollectionViewDriver Class Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="../index.html">ReactiveLists Docs</a> (91% documented)</p>
+        <p><a href="../index.html">ReactiveLists Docs</a> (100% documented)</p>
         <p class="header-right"><a href="https://github.com/plangrid/ReactiveLists"><img src="../img/gh.png"/>View on GitHub</a></p>
       </div>
     </header>
@@ -237,9 +237,9 @@ <h3 class="section-name">Initialization</h3>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:13ReactiveLists20CollectionViewDriverCACSo012UICollectionD0C010collectionD0_AA0cD5ModelVSg0gdH0Sb27shouldDeselectUponSelectionSb23automaticDiffingEnabledtcfc"></a>
+                    <a name="/s:13ReactiveLists20CollectionViewDriverC010collectionD00fD5Model27shouldDeselectUponSelection23automaticDiffingEnabledACSo012UICollectionD0C_AA0cdG0VSgS2btcfc"></a>
                     <a name="//apple_ref/swift/Method/init(collectionView:collectionViewModel:shouldDeselectUponSelection:automaticDiffingEnabled:)" class="dashAnchor"></a>
-                    <a class="token" href="#/s:13ReactiveLists20CollectionViewDriverCACSo012UICollectionD0C010collectionD0_AA0cD5ModelVSg0gdH0Sb27shouldDeselectUponSelectionSb23automaticDiffingEnabledtcfc">init(collectionView:collectionViewModel:shouldDeselectUponSelection:automaticDiffingEnabled:)</a>
+                    <a class="token" href="#/s:13ReactiveLists20CollectionViewDriverC010collectionD00fD5Model27shouldDeselectUponSelection23automaticDiffingEnabledACSo012UICollectionD0C_AA0cdG0VSgS2btcfc">init(collectionView:collectionViewModel:shouldDeselectUponSelection:automaticDiffingEnabled:)</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -369,7 +369,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2018 <a class="link" href="https://twitter.com/PlanGrid" target="_blank" rel="external">PlanGrid</a>. All rights reserved. (Last updated: 2018-09-11)</p>
+          <p>&copy; 2018 <a class="link" href="https://twitter.com/PlanGrid" target="_blank" rel="external">PlanGrid</a>. All rights reserved. (Last updated: 2018-09-20)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/Classes/TableViewDriver.html b/docs/Classes/TableViewDriver.html
@@ -14,7 +14,7 @@
     <a title="TableViewDriver Class Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="../index.html">ReactiveLists Docs</a> (91% documented)</p>
+        <p><a href="../index.html">ReactiveLists Docs</a> (100% documented)</p>
         <p class="header-right"><a href="https://github.com/plangrid/ReactiveLists"><img src="../img/gh.png"/>View on GitHub</a></p>
       </div>
     </header>
@@ -247,9 +247,9 @@ <h4>Declaration</h4>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:13ReactiveLists15TableViewDriverC18insertionAnimationSC07UITabled3RowG0Ovp"></a>
+                    <a name="/s:13ReactiveLists15TableViewDriverC18insertionAnimationSo07UITabled3RowG0Vvp"></a>
                     <a name="//apple_ref/swift/Property/insertionAnimation" class="dashAnchor"></a>
-                    <a class="token" href="#/s:13ReactiveLists15TableViewDriverC18insertionAnimationSC07UITabled3RowG0Ovp">insertionAnimation</a>
+                    <a class="token" href="#/s:13ReactiveLists15TableViewDriverC18insertionAnimationSo07UITabled3RowG0Vvp">insertionAnimation</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -264,7 +264,7 @@ <h4>Declaration</h4>
                         <h4>Declaration</h4>
                         <div class="language">
                           <p class="aside-title">Swift</p>
-                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">insertionAnimation</span><span class="p">:</span> <span class="kt">UITableViewRowAnimation</span></code></pre>
+                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">insertionAnimation</span><span class="p">:</span> <span class="kt">UITableView</span><span class="o">.</span><span class="kt">RowAnimation</span></code></pre>
 
                         </div>
                       </div>
@@ -274,9 +274,9 @@ <h4>Declaration</h4>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:13ReactiveLists15TableViewDriverC17deletionAnimationSC07UITabled3RowG0Ovp"></a>
+                    <a name="/s:13ReactiveLists15TableViewDriverC17deletionAnimationSo07UITabled3RowG0Vvp"></a>
                     <a name="//apple_ref/swift/Property/deletionAnimation" class="dashAnchor"></a>
-                    <a class="token" href="#/s:13ReactiveLists15TableViewDriverC17deletionAnimationSC07UITabled3RowG0Ovp">deletionAnimation</a>
+                    <a class="token" href="#/s:13ReactiveLists15TableViewDriverC17deletionAnimationSo07UITabled3RowG0Vvp">deletionAnimation</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -291,7 +291,7 @@ <h4>Declaration</h4>
                         <h4>Declaration</h4>
                         <div class="language">
                           <p class="aside-title">Swift</p>
-                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">deletionAnimation</span><span class="p">:</span> <span class="kt">UITableViewRowAnimation</span></code></pre>
+                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">deletionAnimation</span><span class="p">:</span> <span class="kt">UITableView</span><span class="o">.</span><span class="kt">RowAnimation</span></code></pre>
 
                         </div>
                       </div>
@@ -301,9 +301,9 @@ <h4>Declaration</h4>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:13ReactiveLists15TableViewDriverCACSo07UITableD0C05tableD0_AA0cD5ModelVSg0gdH0Sb27shouldDeselectUponSelectionSb23automaticDiffingEnabledtcfc"></a>
+                    <a name="/s:13ReactiveLists15TableViewDriverC05tableD00fD5Model27shouldDeselectUponSelection23automaticDiffingEnabledACSo07UITableD0C_AA0cdG0VSgS2btcfc"></a>
                     <a name="//apple_ref/swift/Method/init(tableView:tableViewModel:shouldDeselectUponSelection:automaticDiffingEnabled:)" class="dashAnchor"></a>
-                    <a class="token" href="#/s:13ReactiveLists15TableViewDriverCACSo07UITableD0C05tableD0_AA0cD5ModelVSg0gdH0Sb27shouldDeselectUponSelectionSb23automaticDiffingEnabledtcfc">init(tableView:tableViewModel:shouldDeselectUponSelection:automaticDiffingEnabled:)</a>
+                    <a class="token" href="#/s:13ReactiveLists15TableViewDriverC05tableD00fD5Model27shouldDeselectUponSelection23automaticDiffingEnabledACSo07UITableD0C_AA0cdG0VSgS2btcfc">init(tableView:tableViewModel:shouldDeselectUponSelection:automaticDiffingEnabled:)</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -401,9 +401,9 @@ <h3 class="section-name">Change and UI Update Handling</h3>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:13ReactiveLists15TableViewDriverC12refreshViewsyAC0C14RefreshContextO0fI0_tF"></a>
+                    <a name="/s:13ReactiveLists15TableViewDriverC12refreshViews0F7ContextyAC0c7RefreshH0O_tF"></a>
                     <a name="//apple_ref/swift/Method/refreshViews(refreshContext:)" class="dashAnchor"></a>
-                    <a class="token" href="#/s:13ReactiveLists15TableViewDriverC12refreshViewsyAC0C14RefreshContextO0fI0_tF">refreshViews(refreshContext:)</a>
+                    <a class="token" href="#/s:13ReactiveLists15TableViewDriverC12refreshViews0F7ContextyAC0c7RefreshH0O_tF">refreshViews(refreshContext:)</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -433,7 +433,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2018 <a class="link" href="https://twitter.com/PlanGrid" target="_blank" rel="external">PlanGrid</a>. All rights reserved. (Last updated: 2018-09-11)</p>
+          <p>&copy; 2018 <a class="link" href="https://twitter.com/PlanGrid" target="_blank" rel="external">PlanGrid</a>. All rights reserved. (Last updated: 2018-09-20)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/Classes/TableViewDriver/TableRefreshContext.html b/docs/Classes/TableViewDriver/TableRefreshContext.html
@@ -14,7 +14,7 @@
     <a title="TableRefreshContext Enumeration Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="../../index.html">ReactiveLists Docs</a> (91% documented)</p>
+        <p><a href="../../index.html">ReactiveLists Docs</a> (100% documented)</p>
         <p class="header-right"><a href="https://github.com/plangrid/ReactiveLists"><img src="../../img/gh.png"/>View on GitHub</a></p>
       </div>
     </header>
@@ -151,9 +151,9 @@ <h1>TableRefreshContext</h1>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:13ReactiveLists15TableViewDriverC0C14RefreshContextO7unknownA2EmF"></a>
+                    <a name="/s:13ReactiveLists15TableViewDriverC0C14RefreshContextO7unknownyA2EmF"></a>
                     <a name="//apple_ref/swift/Element/unknown" class="dashAnchor"></a>
-                    <a class="token" href="#/s:13ReactiveLists15TableViewDriverC0C14RefreshContextO7unknownA2EmF">unknown</a>
+                    <a class="token" href="#/s:13ReactiveLists15TableViewDriverC0C14RefreshContextO7unknownyA2EmF">unknown</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -178,9 +178,9 @@ <h4>Declaration</h4>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:13ReactiveLists15TableViewDriverC0C14RefreshContextO11contentOnlyA2EmF"></a>
+                    <a name="/s:13ReactiveLists15TableViewDriverC0C14RefreshContextO11contentOnlyyA2EmF"></a>
                     <a name="//apple_ref/swift/Element/contentOnly" class="dashAnchor"></a>
-                    <a class="token" href="#/s:13ReactiveLists15TableViewDriverC0C14RefreshContextO11contentOnlyA2EmF">contentOnly</a>
+                    <a class="token" href="#/s:13ReactiveLists15TableViewDriverC0C14RefreshContextO11contentOnlyyA2EmF">contentOnly</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -205,9 +205,9 @@ <h4>Declaration</h4>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:13ReactiveLists15TableViewDriverC0C14RefreshContextO12rowsModifiedA2EmF"></a>
+                    <a name="/s:13ReactiveLists15TableViewDriverC0C14RefreshContextO12rowsModifiedyA2EmF"></a>
                     <a name="//apple_ref/swift/Element/rowsModified" class="dashAnchor"></a>
-                    <a class="token" href="#/s:13ReactiveLists15TableViewDriverC0C14RefreshContextO12rowsModifiedA2EmF">rowsModified</a>
+                    <a class="token" href="#/s:13ReactiveLists15TableViewDriverC0C14RefreshContextO12rowsModifiedyA2EmF">rowsModified</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -234,7 +234,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2018 <a class="link" href="https://twitter.com/PlanGrid" target="_blank" rel="external">PlanGrid</a>. All rights reserved. (Last updated: 2018-09-11)</p>
+          <p>&copy; 2018 <a class="link" href="https://twitter.com/PlanGrid" target="_blank" rel="external">PlanGrid</a>. All rights reserved. (Last updated: 2018-09-20)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/Enums.html b/docs/Enums.html
@@ -14,7 +14,7 @@
     <a title="Enumerations  Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="index.html">ReactiveLists Docs</a> (91% documented)</p>
+        <p><a href="index.html">ReactiveLists Docs</a> (100% documented)</p>
         <p class="header-right"><a href="https://github.com/plangrid/ReactiveLists"><img src="img/gh.png"/>View on GitHub</a></p>
       </div>
     </header>
@@ -212,7 +212,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2018 <a class="link" href="https://twitter.com/PlanGrid" target="_blank" rel="external">PlanGrid</a>. All rights reserved. (Last updated: 2018-09-11)</p>
+          <p>&copy; 2018 <a class="link" href="https://twitter.com/PlanGrid" target="_blank" rel="external">PlanGrid</a>. All rights reserved. (Last updated: 2018-09-20)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/Enums/SupplementaryViewKind.html b/docs/Enums/SupplementaryViewKind.html
@@ -14,7 +14,7 @@
     <a title="SupplementaryViewKind Enumeration Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="../index.html">ReactiveLists Docs</a> (91% documented)</p>
+        <p><a href="../index.html">ReactiveLists Docs</a> (100% documented)</p>
         <p class="header-right"><a href="https://github.com/plangrid/ReactiveLists"><img src="../img/gh.png"/>View on GitHub</a></p>
       </div>
     </header>
@@ -156,9 +156,9 @@ <h1>SupplementaryViewKind</h1>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:13ReactiveLists21SupplementaryViewKindO6headerA2CmF"></a>
+                    <a name="/s:13ReactiveLists21SupplementaryViewKindO6headeryA2CmF"></a>
                     <a name="//apple_ref/swift/Element/header" class="dashAnchor"></a>
-                    <a class="token" href="#/s:13ReactiveLists21SupplementaryViewKindO6headerA2CmF">header</a>
+                    <a class="token" href="#/s:13ReactiveLists21SupplementaryViewKindO6headeryA2CmF">header</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -183,9 +183,9 @@ <h4>Declaration</h4>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:13ReactiveLists21SupplementaryViewKindO6footerA2CmF"></a>
+                    <a name="/s:13ReactiveLists21SupplementaryViewKindO6footeryA2CmF"></a>
                     <a name="//apple_ref/swift/Element/footer" class="dashAnchor"></a>
-                    <a class="token" href="#/s:13ReactiveLists21SupplementaryViewKindO6footerA2CmF">footer</a>
+                    <a class="token" href="#/s:13ReactiveLists21SupplementaryViewKindO6footeryA2CmF">footer</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -212,7 +212,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2018 <a class="link" href="https://twitter.com/PlanGrid" target="_blank" rel="external">PlanGrid</a>. All rights reserved. (Last updated: 2018-09-11)</p>
+          <p>&copy; 2018 <a class="link" href="https://twitter.com/PlanGrid" target="_blank" rel="external">PlanGrid</a>. All rights reserved. (Last updated: 2018-09-20)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
         </section>
       </article>