Episode 221

0221-pflive-dependencies-stacks/standups/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Point-Free
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

0221-pflive-dependencies-stacks/standups/README.md

@@ -0,0 +1,106 @@
+# Standups
+
+This project demonstrates how to build a complex, real world application that deals with many forms
+of navigation (_e.g._, sheets, drill-downs, alerts), many side effects (timers, speech recognizer,
+data persistence), and do so in a way that is testable and modular.
+
+This application was built over the course of [many episodes][modern-swiftui-collection] on
+Point-Free, a video series exploring functional programming and the Swift language, hosted by
+[Brandon Williams](https://twitter.com/mbrandonw) and [Stephen
+Celis](https://twitter.com/stephencelis).
+
+<a href="https://www.pointfree.co/collections/swiftui/modern-swiftui">
+  <img alt="video poster image" src="https://d3rccdn33rt8ze.cloudfront.net/episodes/0209.jpeg" width="600">
+</a>
+
+## Call to action!
+
+While we have built the Standups application in the style that makes the most sense to us, we know 
+that some of our choices aren’t for everyone. We would love if others fork this repo and rebuild 
+it in the style of their choice.
+
+Don’t like to use an `ObservableObject` for each screen? Prefer to use `@StateObject` instead of 
+`@ObservedObject`? Want to use an architectural pattern such as VIPER? Have a different way of 
+handling dependencies? 
+
+Please show us! Just complete the following steps:
+
+1. [Fork](https://github.com/pointfreeco/standups/fork) our repo and rebuild the app any way you 
+see fit. If you want to start with Apple’s code rather than ours, you can [download it 
+here][scrumdinger-dl].
+2. Update the Readme.md to describe your choices in rebuilding the app (see [below](#modern-swiftui)
+for ours).
+3. Open a PR to this repo where you add a link to your port in this readme.
+
+We will collect links to the other ports so that there can be a single place to reference many 
+different approaches for building the same application.
+
+## Overview
+
+The inspiration for this application comes Apple's [Scrumdinger][scrumdinger] tutorial:
+
+> This module guides you through the development of Scrumdinger, an iOS app that helps users manage
+> their daily scrums. To help keep scrums short and focused, Scrumdinger uses visual and audio cues
+> to indicate when and how long each attendee should speak. The app also displays a progress screen
+> that shows the time remaining in the meeting and creates a transcript that users can refer to
+> later.
+
+The Scrumdinger app is one of Apple's most interesting code samples as it deals with many real world
+world problems that one faces in application development. It shows off many types of navigation,
+it deals with complex effects such as timers and speech recognition, and it persists application
+data to disk.
+
+However, it is not necessarily built in the most ideal way. It uses mostly fire-and-forget style
+navigation, which means you can't easily deep link into any screen of the app, which is handy for
+push notifications and opening URLs. It also uses uncontrolled dependencies, including file system
+access, timers and a speech recognizer, which makes it nearly impossible to write automated tests
+and even hinders the ability to preview the app in Xcode previews.
+
+But, the simplicity of Apple's Scrumdinger codebase is not a defect. In fact, it's a feature!
+Apple's sample code is viewed by hundreds of thousands of developers across the world, and so its
+goal is to be as approachable as possible in order to teach the basics of SwiftUI. But, that doesn't
+mean there isn't room for improvement.
+
+## Modern SwiftUI
+
+Our Standups application is a rebuild of Apple's Scrumdinger application, but with a focus on
+modern, best practices for SwiftUI development. We faithfully recreate the Scrumdinger, but with
+some key additions:
+
+ 1. Identifiers are made type safe using our [Tagged library][tagged-gh]. This prevents us from
+    writing non-sensical code, such as comparing a `Standup.ID` to a `Attendee.ID`.
+ 2. Instead of using bare arrays in feature logic we use an "identified" array from our
+    [IdentifiedCollections][identified-collections-gh] library. This allows you to read and modify
+    elements of the collection via their ID rather than positional index, which can be error prone
+    and lead to bugs or crashes.
+ 3. _All_ navigation is driven off of state, including sheets, drill-downs and alerts. This makes
+    it possible to deep link into any screen of the app by just constructing a piece of state and
+    handing it off to SwiftUI.
+ 4. Further, each view represents its navigation destinations as a single enum, which gives us
+    compile time proof that two destinations cannot be active at the same time. This cannot be
+    accomplished with default SwiftUI tools, but can be done with our [SwiftUINavigation
+    library][swiftui-nav-gh].
+ 5. All side effects are controlled. This includes access to the file system for persistence, access
+    to time-based asynchrony for timers, access to speech recognition APIs, and even the creation
+    of dates and UUIDs. This allows us to run our application in specific execution contexts, which
+    is very useful in tests and Xcode previews. We accomplish this using our
+    [Dependencies][dependencies-gh] library.
+ 6. The project includes a full test suite. Since all of navigation is driven off of state, and
+    because we controlled all dependencies, we can write very comprehensive and nuanced tests. For
+    example, we can write a unit test that proves that when a standup meeting's timer runs out the
+    screen pops off the stack and a new transcript is added to the standup. Such a test would be
+    very difficult, if not impossible, without controlling dependencies.
+
+## Ports
+
+Here is a list of ports of the app:
+
+* [https://github.com/nashysolutions/standups](https://github.com/nashysolutions/standups)
+
+[modern-swiftui-collection]: https://www.pointfree.co/collections/swiftui/modern-swiftui
+[scrumdinger]: https://developer.apple.com/tutorials/app-dev-training/getting-started-with-scrumdinger
+[scrumdinger-dl]: https://docs-assets.developer.apple.com/published/1ea2eec121b90031e354288912a76357/TranscribingSpeechToText.zip
+[tagged-gh]: http://github.com/pointfreeco/swift-tagged
+[identified-collections-gh]: http://github.com/pointfreeco/swift-identified-collections 
+[swiftui-nav-gh]: http://github.com/pointfreeco/swiftui-navigation
+[dependencies-gh]: http://github.com/pointfreeco/swift-dependencies