Skip to content

Commit

Permalink
[4.0.0] release prep + rebuild docs
Browse files Browse the repository at this point in the history
closes #63
  • Loading branch information
jessesquires committed Dec 23, 2022
1 parent fe0831f commit 6feb585
Show file tree
Hide file tree
Showing 11 changed files with 36 additions and 30 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ NEXT
4.0.0
-----

This release closes the [4.0.0 milestone](https://github.com/jessesquires/Foil/milestone/5?closed=1).

### New

- The publisher projected by the property wrapper now sends values when user defaults changes from anywhere. Previously, only when using the property wrapper's setter would the projected publisher send a new value. ([#61](https://github.com/jessesquires/Foil/pull/61), [@nolanw](https://github.com/nolanw))
Expand All @@ -22,6 +24,10 @@ NEXT
- Key names containing a `.` character _anywhere_ in the name **do not** notify observers on updates. (This is a side-effect of `KeyPaths` which include periods.)
- Example: `com.myApp.my-key-name`

### Changed

- Upgrade to Xcode 14
- Upgrade to Swift 5.7

3.0.0
-----
Expand Down
4 changes: 2 additions & 2 deletions Foil.podspec
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Pod::Spec.new do |s|
s.name = 'Foil'
s.version = '3.0.0'
s.version = '4.0.0'
s.license = 'MIT'

s.summary = 'A lightweight property wrapper for UserDefaults'
Expand All @@ -12,7 +12,7 @@ Pod::Spec.new do |s|
s.source = { :git => 'https://github.com/jessesquires/Foil.git', :tag => s.version }
s.source_files = 'Sources/*.swift'

s.swift_version = '5.5'
s.swift_version = '5.7'

s.ios.deployment_target = '13.0'
s.tvos.deployment_target = '13.0'
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,14 +163,14 @@ Adding support for custom types is possible by conforming to `UserDefaultsSerial
### [CocoaPods](http://cocoapods.org)

````ruby
pod 'Foil', '~> 3.0.0'
pod 'Foil', '~> 4.0.0'
````

### [Swift Package Manager](https://swift.org/package-manager/)

```swift
dependencies: [
.package(url: "https://github.com/jessesquires/Foil.git", from: "3.0.0")
.package(url: "https://github.com/jessesquires/Foil.git", from: "4.0.0")
]
```

Expand Down
6 changes: 3 additions & 3 deletions docs/Protocols.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="Protocols Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">Foil 3.0.0 Docs</a> (100% documented)</p>
<p><a href="index.html">Foil 4.0.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/jessesquires/Foil"><img src="img/gh.png" alt="GitHub"/>View on GitHub</a></p>
<div class="header-right">
<form role="search" action="search.json">
Expand Down Expand Up @@ -118,8 +118,8 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2022 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2022-04-16)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
<p>&copy; 2022 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2022-12-23)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
6 changes: 3 additions & 3 deletions docs/Protocols/UserDefaultsSerializable.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="UserDefaultsSerializable Protocol Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Foil 3.0.0 Docs</a> (100% documented)</p>
<p><a href="../index.html">Foil 4.0.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/jessesquires/Foil"><img src="../img/gh.png" alt="GitHub"/>View on GitHub</a></p>
<div class="header-right">
<form role="search" action="../search.json">
Expand Down Expand Up @@ -197,8 +197,8 @@ <h4>Parameters</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2022 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2022-04-16)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
<p>&copy; 2022 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2022-12-23)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
6 changes: 3 additions & 3 deletions docs/Structs.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="Structures Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">Foil 3.0.0 Docs</a> (100% documented)</p>
<p><a href="index.html">Foil 4.0.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/jessesquires/Foil"><img src="img/gh.png" alt="GitHub"/>View on GitHub</a></p>
<div class="header-right">
<form role="search" action="search.json">
Expand Down Expand Up @@ -132,8 +132,8 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2022 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2022-04-16)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
<p>&copy; 2022 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2022-12-23)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
6 changes: 3 additions & 3 deletions docs/Structs/WrappedDefault.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="WrappedDefault Structure Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Foil 3.0.0 Docs</a> (100% documented)</p>
<p><a href="../index.html">Foil 4.0.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/jessesquires/Foil"><img src="../img/gh.png" alt="GitHub"/>View on GitHub</a></p>
<div class="header-right">
<form role="search" action="../search.json">
Expand Down Expand Up @@ -232,8 +232,8 @@ <h4>Parameters</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2022 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2022-04-16)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
<p>&copy; 2022 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2022-12-23)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
8 changes: 4 additions & 4 deletions docs/Structs/WrappedDefaultOptional.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="WrappedDefaultOptional Structure Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Foil 3.0.0 Docs</a> (100% documented)</p>
<p><a href="../index.html">Foil 4.0.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/jessesquires/Foil"><img src="../img/gh.png" alt="GitHub"/>View on GitHub</a></p>
<div class="header-right">
<form role="search" action="../search.json">
Expand Down Expand Up @@ -116,7 +116,7 @@ <h4>Declaration</h4>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The value retreived from <code>UserDefaults</code>, if any exists.</p>
<p>The value retrieved from <code>UserDefaults</code>, if any exists.</p>

</div>
<div class="declaration">
Expand Down Expand Up @@ -220,8 +220,8 @@ <h4>Parameters</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2022 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2022-04-16)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
<p>&copy; 2022 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2022-12-23)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
14 changes: 7 additions & 7 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<a title="Foil Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">Foil 3.0.0 Docs</a> (100% documented)</p>
<p><a href="index.html">Foil 4.0.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/jessesquires/Foil"><img src="img/gh.png" alt="GitHub"/>View on GitHub</a></p>
<div class="header-right">
<form role="search" action="search.json">
Expand Down Expand Up @@ -201,17 +201,17 @@ <h2 id='supported-platforms' class='heading'>Supported Platforms</h2>
<h2 id='requirements' class='heading'>Requirements</h2>

<ul>
<li>Swift 5.5+</li>
<li>Xcode 13.0+</li>
<li>Swift 5.7+</li>
<li>Xcode 14.0+</li>
<li><a href="https://github.com/realm/SwiftLint">SwiftLint</a></li>
</ul>
<h2 id='installation' class='heading'>Installation</h2>
<h3 id='a-href-http-cocoapods-org-cocoapods-a' class='heading'><a href="http://cocoapods.org">CocoaPods</a></h3>
<pre class="highlight ruby"><code><span class="n">pod</span> <span class="s1">'Foil'</span><span class="p">,</span> <span class="s1">'~&gt; 3.0.0'</span>
<pre class="highlight ruby"><code><span class="n">pod</span> <span class="s1">'Foil'</span><span class="p">,</span> <span class="s1">'~&gt; 4.0.0'</span>
</code></pre>
<h3 id='a-href-https-swift-org-package-manager-swift-package-manager-a' class='heading'><a href="https://swift.org/package-manager/">Swift Package Manager</a></h3>
<pre class="highlight swift"><code><span class="nv">dependencies</span><span class="p">:</span> <span class="p">[</span>
<span class="o">.</span><span class="nf">package</span><span class="p">(</span><span class="nv">url</span><span class="p">:</span> <span class="s">"https://github.com/jessesquires/Foil.git"</span><span class="p">,</span> <span class="nv">from</span><span class="p">:</span> <span class="s">"3.0.0"</span><span class="p">)</span>
<span class="o">.</span><span class="nf">package</span><span class="p">(</span><span class="nv">url</span><span class="p">:</span> <span class="s">"https://github.com/jessesquires/Foil.git"</span><span class="p">,</span> <span class="nv">from</span><span class="p">:</span> <span class="s">"4.0.0"</span><span class="p">)</span>
<span class="p">]</span>
</code></pre>

Expand Down Expand Up @@ -245,8 +245,8 @@ <h2 id='license' class='heading'>License</h2>
</section>
</section>
<section id="footer">
<p>&copy; 2022 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2022-04-16)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
<p>&copy; 2022 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2022-12-23)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/js/jquery.min.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/search.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"Structs/WrappedDefaultOptional.html#/s:4Foil22WrappedDefaultOptionalV3keySSvp":{"name":"key","abstract":"<p>The key for the value in <code>UserDefaults</code>.</p>","parent_name":"WrappedDefaultOptional"},"Structs/WrappedDefaultOptional.html#/s:4Foil22WrappedDefaultOptionalV12wrappedValuexSgvp":{"name":"wrappedValue","abstract":"<p>The value retreived from <code>UserDefaults</code>, if any exists.</p>","parent_name":"WrappedDefaultOptional"},"Structs/WrappedDefaultOptional.html#/s:4Foil22WrappedDefaultOptionalV14projectedValue7Combine12AnyPublisherVyxSgs5NeverOGvp":{"name":"projectedValue","abstract":"<p>A publisher that delivers updates to subscribers.</p>","parent_name":"WrappedDefaultOptional"},"Structs/WrappedDefaultOptional.html#/s:4Foil22WrappedDefaultOptionalV3key12userDefaultsACyxGSS_So06NSUserG0Ctcfc":{"name":"init(key:userDefaults:)","abstract":"<p>Initializes the property wrapper.</p>","parent_name":"WrappedDefaultOptional"},"Structs/WrappedDefault.html#/s:4Foil14WrappedDefaultV3keySSvp":{"name":"key","abstract":"<p>The key for the value in <code>UserDefaults</code>.</p>","parent_name":"WrappedDefault"},"Structs/WrappedDefault.html#/s:4Foil14WrappedDefaultV12wrappedValuexvp":{"name":"wrappedValue","abstract":"<p>The value retrieved from <code>UserDefaults</code>.</p>","parent_name":"WrappedDefault"},"Structs/WrappedDefault.html#/s:4Foil14WrappedDefaultV14projectedValue7Combine12AnyPublisherVyxs5NeverOGvp":{"name":"projectedValue","abstract":"<p>A publisher that delivers updates to subscribers.</p>","parent_name":"WrappedDefault"},"Structs/WrappedDefault.html#/s:4Foil14WrappedDefaultV12wrappedValue3key12userDefaultsACyxGx_SSSo06NSUserH0Ctcfc":{"name":"init(wrappedValue:key:userDefaults:)","abstract":"<p>Initializes the property wrapper.</p>","parent_name":"WrappedDefault"},"Structs/WrappedDefault.html":{"name":"WrappedDefault","abstract":"<p>A property wrapper that uses <code>UserDefaults</code> as a backing store,"},"Structs/WrappedDefaultOptional.html":{"name":"WrappedDefaultOptional","abstract":"<p>A property wrapper that uses <code>UserDefaults</code> as a backing store,"},"Protocols/UserDefaultsSerializable.html#/s:4Foil24UserDefaultsSerializableP11StoredValueQa":{"name":"StoredValue","abstract":"<p>The type of the value that is stored in <code>UserDefaults</code>.</p>","parent_name":"UserDefaultsSerializable"},"Protocols/UserDefaultsSerializable.html#/s:4Foil24UserDefaultsSerializableP11storedValue06StoredF0Qzvp":{"name":"storedValue","abstract":"<p>The value to store in <code>UserDefaults</code>.</p>","parent_name":"UserDefaultsSerializable"},"Protocols/UserDefaultsSerializable.html#/s:4Foil24UserDefaultsSerializableP11storedValuex06StoredF0Qz_tcfc":{"name":"init(storedValue:)","abstract":"<p>Initializes the object using the provided value.</p>","parent_name":"UserDefaultsSerializable"},"Protocols/UserDefaultsSerializable.html":{"name":"UserDefaultsSerializable","abstract":"<p>Describes a value that can be saved to and fetched from <code>UserDefaults</code>.</p>"},"Protocols.html":{"name":"Protocols","abstract":"<p>The following protocols are available globally.</p>"},"Structs.html":{"name":"Structures","abstract":"<p>The following structures are available globally.</p>"}}
{"Structs/WrappedDefaultOptional.html#/s:4Foil22WrappedDefaultOptionalV3keySSvp":{"name":"key","abstract":"<p>The key for the value in <code>UserDefaults</code>.</p>","parent_name":"WrappedDefaultOptional"},"Structs/WrappedDefaultOptional.html#/s:4Foil22WrappedDefaultOptionalV12wrappedValuexSgvp":{"name":"wrappedValue","abstract":"<p>The value retrieved from <code>UserDefaults</code>, if any exists.</p>","parent_name":"WrappedDefaultOptional"},"Structs/WrappedDefaultOptional.html#/s:4Foil22WrappedDefaultOptionalV14projectedValue7Combine12AnyPublisherVyxSgs5NeverOGvp":{"name":"projectedValue","abstract":"<p>A publisher that delivers updates to subscribers.</p>","parent_name":"WrappedDefaultOptional"},"Structs/WrappedDefaultOptional.html#/s:4Foil22WrappedDefaultOptionalV3key12userDefaultsACyxGSS_So06NSUserG0Ctcfc":{"name":"init(key:userDefaults:)","abstract":"<p>Initializes the property wrapper.</p>","parent_name":"WrappedDefaultOptional"},"Structs/WrappedDefault.html#/s:4Foil14WrappedDefaultV3keySSvp":{"name":"key","abstract":"<p>The key for the value in <code>UserDefaults</code>.</p>","parent_name":"WrappedDefault"},"Structs/WrappedDefault.html#/s:4Foil14WrappedDefaultV12wrappedValuexvp":{"name":"wrappedValue","abstract":"<p>The value retrieved from <code>UserDefaults</code>.</p>","parent_name":"WrappedDefault"},"Structs/WrappedDefault.html#/s:4Foil14WrappedDefaultV14projectedValue7Combine12AnyPublisherVyxs5NeverOGvp":{"name":"projectedValue","abstract":"<p>A publisher that delivers updates to subscribers.</p>","parent_name":"WrappedDefault"},"Structs/WrappedDefault.html#/s:4Foil14WrappedDefaultV12wrappedValue3key12userDefaultsACyxGx_SSSo06NSUserH0Ctcfc":{"name":"init(wrappedValue:key:userDefaults:)","abstract":"<p>Initializes the property wrapper.</p>","parent_name":"WrappedDefault"},"Structs/WrappedDefault.html":{"name":"WrappedDefault","abstract":"<p>A property wrapper that uses <code>UserDefaults</code> as a backing store,"},"Structs/WrappedDefaultOptional.html":{"name":"WrappedDefaultOptional","abstract":"<p>A property wrapper that uses <code>UserDefaults</code> as a backing store,"},"Protocols/UserDefaultsSerializable.html#/s:4Foil24UserDefaultsSerializableP11StoredValueQa":{"name":"StoredValue","abstract":"<p>The type of the value that is stored in <code>UserDefaults</code>.</p>","parent_name":"UserDefaultsSerializable"},"Protocols/UserDefaultsSerializable.html#/s:4Foil24UserDefaultsSerializableP11storedValue06StoredF0Qzvp":{"name":"storedValue","abstract":"<p>The value to store in <code>UserDefaults</code>.</p>","parent_name":"UserDefaultsSerializable"},"Protocols/UserDefaultsSerializable.html#/s:4Foil24UserDefaultsSerializableP11storedValuex06StoredF0Qz_tcfc":{"name":"init(storedValue:)","abstract":"<p>Initializes the object using the provided value.</p>","parent_name":"UserDefaultsSerializable"},"Protocols/UserDefaultsSerializable.html":{"name":"UserDefaultsSerializable","abstract":"<p>Describes a value that can be saved to and fetched from <code>UserDefaults</code>.</p>"},"Protocols.html":{"name":"Protocols","abstract":"<p>The following protocols are available globally.</p>"},"Structs.html":{"name":"Structures","abstract":"<p>The following structures are available globally.</p>"}}

0 comments on commit 6feb585

Please sign in to comment.