We currently have a single case of `AnyCasePath(unsafe:)` in the code
base, which uses reflection for extraction, and is something we would
like to remove in a future major version of Case Paths.
This explores a refactoring of `BindingReducer` that takes an explicit
case key path toe the binding action case, instead:
```swift
BindingReducer(action: \.binding)
```
`BindableAction` as a protocol is still necessary for bindable stores to
know how to embed binding actions in a short syntax, _e.g._
`$store.text`.
It's a slight bummer that the reducer gets slightly more verbose,
especially when there _is_ something abstractable here, I'm just not
sure Swift provides the tools yet to truly abstract over a case path in
an ergonomic fashion.
The alternative would be to introduce a special protocol
(`BindableCasePath`?) that the `@Reducer` macro would need to apply
correctly when detecting a `BindableAction`, but this is one-off logic
that seems to take things in the wrong direction.
* Allow an alert to present another alert
When we added support for vanilla SwiftUI modifiers, we lost the ability
to present one alert after another because `nil` writes to the alert
bindings unconditionally dismissed the feature, even if the feature was
freshly presented.
This fixes things by suppressing dismissal when the identity of a
presented item has changed.
Fix#3272.
* wip
* Support swift-syntax from 600.0.0-latest
The Xcode 16 beta generates macro projects using these swift-syntax
snapshots. Luckily things seem to be backwards compatible, so we can
expand our supported range.
* wip
* Precondition: persistence keys must match value
We currently soft-fail if a persistence key is reused across different
types. At runtime a persistence key will write over the other's value,
and vice versa, and data is lost.
Reusing the same file storage URL or app storage key with conflicting
types is a programmer error and ideally should crash over data
corruption.
* wip
* wip
* Cancel `TestStore` effects when root feature is dismissed
Right now, if a leaf feature is tested and it dismisses itself while
effects are in-flight, the only way to get tests passing is to
explicitly tell the store or any tasks returned by `store.send` to
cancel. Further, you must use an expectation in such tests to assert
that `dismiss` was called in the first place.
This PR changes this behavior to automatically cancel a test store's
effects if it is dismissed, and it prohibits sending more actions to it
after dismiss has been called.
* wip
* wip
* Shared State
* fix compiler errors in 5.7
* fixes and tests
* fix
* fix
* wip
* longer sleeps
* fix test
* fix tests
* Clean up some typos in SharingState.md (#2860)
* public inits
* wip
* wip
* add test for shared state and onChange
* Case study for sandboxing shared state
* tweaks to case study
* wip
* add tests to sandboxing case study
* rename files
* wip
* simplify sync up tests
* wip
* fix
* wip
* fix $shared.publisher non-determinism and write test that currently fails but ideally would not.
* more docs and a test for autoclosure
* more docs
* wip
* update todo with persistence
* wip
* wip
* support default `nil` optionals in `@Shared`
* Introduce unavailable overload for better diagnostics
* Fix autocomplete from `@Shared(.`
* Revert "Fix autocomplete from `@Shared(.`"
This reverts commit fd1798f9f5.
* Fix defaults
* wip
* Give persistence keys a synchronous update interface (#2880)
* Don't use async sequence for persistence
* wip
* wip
* wip
* Update Sources/ComposableArchitecture/SharedState/PersistenceKey.swift
Co-authored-by: Hal Lee <hal@lee.me>
---------
Co-authored-by: Hal Lee <hal@lee.me>
* Revert sharing in Todos for now
* wip
* wip
* Pass initial shared value to strategy / register app storage (#2904)
* Pass initial shared value to strategy / register app storage
This PR modifies the `PersistenceKey` protocol so that its `load` and
`subscribe` endpoints are handed the initial value and must return a
non-optional value. By feeding this value in, we can ensure that
`.appStorage` declared in a feature is registered outside the feature.
* wip
* wip
* wip
* wip
* wip
* wip
* swift-format
* Update Sources/ComposableArchitecture/Documentation.docc/Articles/SharingState.md
Co-authored-by: Pyry Jahkola <pyry.jahkola@iki.fi>
* non-exhaustive fix
* wip
* remove decodable for now
* Fix app storage registration with `nil` values
* fix
* wip
* tutorial
* fixes
* lots of tutorial fixes
* more tutorial fixes
* more tutorial fixes
* more tutorial fixes
* tutorial fixes
* wip
* re-arrange test
* Remove store shared preview quarantine
* Add support for \.defaultInMemoryStorage (#2965)
* fix
* Added Privacy Manifest file (#2930)
* Added Privacy Manifest file
* Update Package@swift-5.9.swift
---------
Co-authored-by: Stephen Celis <stephen.celis@gmail.com>
* remove warning overloads
* write default instead of register
this is more consistent with SwiftUI's property wrapper, and causes less
strangeness when multiple repeat properties have different defaults
* move privacy manifest
* wip
* wip
* EphemeralFileStorage -> InMemoryFileStorage
* documented gotcha
* add test
* Shared state beta task snaps (#2976)
* wip
* wip
* wip
* wip
* wip
* wip
* wip
---------
Co-authored-by: Brandon Williams <mbrandonw@hey.com>
* wip
* Use notification center instead of KVO for user defaults observation. (#2978)
* Use notification center instead of KVO for user defaults observation.
* wip
* wip
* Introduce @SharedReader (#2979)
* wip
* wip
* wip
* wip
* wip
* wip
* Introduce @SharedReader.
* wip
* wip
* sendable
* wip
* wip
---------
Co-authored-by: Stephen Celis <stephen@stephencelis.com>
* Make Shared.Subscription.cancel public (#2983)
* added failing test
* Add convenience initializers
* Save to file storage when app is about to be terminated (#2992)
* Save file storage on termination too.
* wip
* Shared change tracking enhancements (#2989)
* wip
* wip
* wip
* wip
* Add unavailable conformance
* wip
* wip
* wip
* Don't need to check for previews.
* Add default providing persistence key (#2980)
* wip - default providing key
* warn on default access
* Revert "warn on default access"
This reverts commit 38706450bef44a50f94afeaddbc4628e383b52b3.
* wip
* wip
* wip - tests
* wip - reader key
* fix docs
* A few changes.
* A few more changes.
* docs
---------
Co-authored-by: Brandon Williams <mbrandonw@hey.com>
* Fix optional shared defaults.
* undo last commit but keep test
* wip
* Better shared state change tracking and `TestStore` interactions (#2995)
* A fix for shared assertion.
* fixes
* wip
---------
Co-authored-by: Brandon Williams <mbrandonw@hey.com>
* docs
* docs
* wip
* Throttle for 1 second.
* fix typo in examples: `let` -> `var` (#2999)
Co-authored-by: Andreas Tielmann <atielmann@deloitte.de>
* wip
* wip
* fix observing projection
* Ping `Shared.publisher` in `willSet` so prev/next values observable
* wip
* wip
* remove sandbox demo
* wip
* wip
* recover inlining
* wip
* wip
* fix docc
* wip
* wip
* re-entrant test
* wip
* Don’t assume CastableLookup (#3011)
* Don’t assume CastableLookup
If the observed value in `UserDefaults` is a `RawRepresentable` type, simply casting to `Value` might fail because the raw representing type could be different from `Value`. Instead of querying `UserDefaults` directly here, we should call `loadValue()` which will do the right thing for raw representable types (esp. try to call `Value.init(rawValue:)` with the value obtained from `UserDefaults`).
* Add test
---------
Co-authored-by: Stephen Celis <stephen@stephencelis.com>
* Make `FileStorage` more opaque (#3010)
* Make `FileStorage` more opaque
Previously, we had a public protocol and conformances, but we don't
expect anyone to conform outside the library, so instead let's hide
things in a more opaque struct.
The downside of this PR is that it's a breaking API change pretty late
in the game:
```diff
-$0.defaultFileStorage = InMemoryFileStorage()
+$0.defaultFileStorage = .inMemory
```
We could add public deprecated functions that emulate the old
initializers if we think it's worth it...
* wip
* wip
* wip
* wip
* wip
* wip
* fix for 5.7.1
* sync ups clean up
* more docs
* more tests
* shared testing tiups
* wip
* wip
* Fix typo. (#3014)
* more shared state docs
* relax version of swift-dependencies.
* dep change
* fix == and hash on Shared and more tests
* revert == changes
* add test
* Remove hashable conformance from shared
* remove conditional encodability from shared
* wip
* remove syncups tutorial
* wip
* fix
* fix file storage deletion resubscription
* wip
* wip
* wip
* wip
* wip
* fix
* eager throttle
---------
Co-authored-by: Brandon Williams <mbrandonw@hey.com>
Co-authored-by: NF <4764329+NFulkerson@users.noreply.github.com>
Co-authored-by: Hal Lee <hal@lee.me>
Co-authored-by: Brandon Williams <135203+mbrandonw@users.noreply.github.com>
Co-authored-by: Pyry Jahkola <pyry.jahkola@iki.fi>
Co-authored-by: Daniel Lyons <72824209+DandyLyons@users.noreply.github.com>
Co-authored-by: Hilton Campbell <github@crosswaterbridge.com>
Co-authored-by: Luke Redpath <lredpath@community.com>
Co-authored-by: andtie <andreas.tielmann@gmail.com>
Co-authored-by: Andreas Tielmann <atielmann@deloitte.de>
Co-authored-by: Alex Kovács <alex@kobachi.jp>
Co-authored-by: Zev Eisenberg <zev@zeveisenberg.com>
* Some cleanup
- `if/guard let x = x` -> `if/guard let x`
- Remove unneeded `self` from a few demos
- Fix up some presentation logic in TicTacToe
* Update Examples/TicTacToe/tic-tac-toe/Sources/LoginUIKit/LoginViewController.swift
* wip
* wip
* wip
It was pointed out in the Slack that the `Codable` conformance was
confusing and seems like a requirement, but neither `Codable` nor
`Hashable` is necessary, so I think these conformances are vestigial and
should be removed.
* bring back view store performance
* wip
* Allow chaining of store bindings
* wip
* Localize ignoring bindings to text field resignation/dismissal
* wip
* fix DiagnosticsError message (#2597)
* store collection
* wip
* wip
* update migration guide
* Add `@Presents` macro for observable presentation
While it would be nice for the `@PresentationState` property wrapper to
"just work" with TCA's upcoming observable tools, sadly that does not
seem to be the case. Adding observation directly to
`@PresentationState`, as we have done with the beta so far, can break
existing projects due to the additional observation. This primarily
manifests itself in projects that present navigation stacks, where the
`@PresentationState` observation can cause the navigation hierarchy to
recompute and trigger SwiftUI bugs.
The best we've come up with so far is introducing a brand new macro that
automatically wraps a property with `@PresentationState` _and_
instruments it with observation.
We're open to other ideas, and we do have future plans to eliminate the
need for a property wrapper or macro at all, but till then this offers a
non-breaking upgrade path!
* fixes
* Observe child store changes
* wip
* wip
* wip
* Fix typo in MigratingTo1.6.md (#2608)
* Rename bindingViewStore argument to store in MigratingTo1.6.md (#2611)
* wip
* Revert "wip"
This reverts commit f221ed0e1a.
* Add `@Presents` macro for observable presentation (#2604)
* Add `@Presents` macro for observable presentation
While it would be nice for the `@PresentationState` property wrapper to
"just work" with TCA's upcoming observable tools, sadly that does not
seem to be the case. Adding observation directly to
`@PresentationState`, as we have done with the beta so far, can break
existing projects due to the additional observation. This primarily
manifests itself in projects that present navigation stacks, where the
`@PresentationState` observation can cause the navigation hierarchy to
recompute and trigger SwiftUI bugs.
The best we've come up with so far is introducing a brand new macro that
automatically wraps a property with `@PresentationState` _and_
instruments it with observation.
We're open to other ideas, and we do have future plans to eliminate the
need for a property wrapper or macro at all, but till then this offers a
non-breaking upgrade path!
* wip
* Fix perception bindings (#2609)
* Fix runtime warning when binding accesses perceptible state.
* Fix runtime warning in SwiftUI bindings.
* wip
* wip
* wip
* wip
* wip
* wip
* wip
* wip
---------
Co-authored-by: Stephen Celis <stephen@stephencelis.com>
* wip
* wip
* fix
* wip
* wip
* wip
* Check observable state identity for presentation state.
* Add willSset/didSet to registrar types.
* clean up @Presents
* clean up
* fix
* Emit observation warnings in escaping contexts like `ForEach` and `sheet` (#2613)
* Fix perception warning in ForEach.
* fix
---------
Co-authored-by: Brandon Williams <mbrandonw@hey.com>
* Introduce @ViewAction(for:) macro. (#2612)
* Add back @ViewAction macro.
* wip
* wip
* wip
* wip
* wip
* clean up
* wip
* wip
* fix migration guide'
* ViewActionable
* wip
* rename
* wip
* wip
---------
Co-authored-by: Stephen Celis <stephen@stephencelis.com>
* Introduce @BindableStore for bindings in pre-iOS 17 (#2610)
* Introduce @BindableStore.
* docs
* wip
* wip
* fixc
* wip
* wip
* wip
* wip
---------
Co-authored-by: Stephen Celis <stephen@stephencelis.com>
* re-record intergration logs
* wip
* wip
* localize invalid stores to store collection
* Deprecate closure-based `store.scope` operations (#2618)
These uncached operations can be problematic, especially when working
with observation, which often depends on the stable identity of stores.
* document
* Update warning message
* Performance Improvement: Skip perception checks when calling reducers. (#2622)
* Skip perception checks when calling reducers.
* inline withoutPerceptionChecking() for RELEASE
Co-authored-by: Brandon Williams <135203+mbrandonw@users.noreply.github.com>
---------
Co-authored-by: Brandon Williams <135203+mbrandonw@users.noreply.github.com>
* Don't show perception warnings in action closures. (#2614)
* Don't show perception warnings in action closures.
* wip
* wip
* wip
* clean up
* wip
---------
Co-authored-by: Stephen Celis <stephen@stephencelis.com>
* fix BindableStore + release
* Add docs
* Change associated type names of ViewActionSending (#2629)
* Fix some @ViewAction annoyances.
* wip
* wip
* wip
* wip
* wip
* wip
* fix
* wip
* fixed merge
* Add new view modifiers for observing alerts/dialogs (#2628)
* Add new view modifiers for observing alerts/dialogs
Instead of:
```swift
.alert(store: store.scope(state: \.$alert, action: \.alert))
```
You can now do:
```swift
.alert($store.scope(state: \.alert, action: \.alert))
```
This new modifier is powered by the same store binding scope operation
that can power `sheet(item:)`, etc., and is much lighter weight than the
previous view modifier, which spun up view stores and `WithViewStore`
views.
* wip
* wip
* wip
---------
Co-authored-by: Brandon Williams <mbrandonw@hey.com>
* Fix uncached warning when using Store.ifLet (#2625)
* Fix uncached warning when using Store.ifLet
* wip
* wip
* wip
* wip
* wip
* wip
---------
Co-authored-by: Stephen Celis <stephen@stephencelis.com>
* Resolve packages
* Updated scopes
* wip
* wip
* updated binding docs
* adding docs
* clean up
* wip
* wip
* wip
* clean up
* clean up
* clean up
* wip;
* lots of fixes
* update more docs
* fix
* wip
* wip
* Remove ObservationRegistrarWrapper. (#2634)
* Remove ObservationRegistrarWrapper.
* Delete Sources/ComposableArchitecture/Internal/ObservationRegistrarWrapper.swift
---------
Co-authored-by: Stephen Celis <stephen@stephencelis.com>
* more docs
* update docs
* a few more tests
* fix
* wip
* wip
* wip
* Cache data in store collections (#2635)
* fix tutorial highlighting
* wip
* wip
* wip
* wip
* tests for observation of special domain types
* another test
* fix
* wip
* Implement memoization for perception checks (#2630)
* Implement memoization for isInSwiftUIBody
* tidy up
* Perception caching updates (#2649)
* Small updates to perception caching.
* wip
* debug
* some more macro tests
* syncups tutorial beginnings
* wip
* wip
* wip
* wip
* wip
* merge fixes
* wip
* update tests
* fix
* fix
* fix perception checking in store
* rename task local
* delete old test
* deprecate test using old apis
* fix test
* perception tests for store
* wip
* wip
* wip
* wip
* wip
* wip
* wip
* Opt out of key path for Store.ifLet
* sync ups
* lots more sync up tutorial
* more sync ups tutorial
* wip
* wip
* wio
* wip
* wip
* wip
* updated references of 1.6 to 1.7
* wip
* no need to force unwrap here
* fixed crash in ForEach with bindings
* more sync ups tutorial
* more sync ups tutorial
* wip
* more sync ups
* wip
* wip
* Better support for observing copies of values (#2650)
* Explore using _modify
* wip
* wip
* wip
* wip
* wip
* wip
* more tests
* wip
* get another failing test for an edge case
* wip
* tests all passing
* flag for determining when new state was created
* wip
* clean up
* wip
* wip
* wip;
* wip
* wip
* wip
* wip
* wip
* wip
* wip
* wip
* wip
* wip
* wip
* wip
* wip
* wip
* wip
* wip
* wip
* wip
* wip
* New test that currently fails.
* wip
* wip
* Update Sources/ComposableArchitectureMacros/PresentsMacro.swift
* wip
* remove redundant attached member attribute
* storage
* cleanup
* more benchmarks and tests
* wip
* wip
* wip
* wip
* update tests
* wip
* wip
---------
Co-authored-by: Brandon Williams <mbrandonw@hey.com>
* wip
* wip
* wip
* swift-format
* fix
* wip
* wip
* wip
* wip
* Perception
* wip
* wip
* clean up shared state
* fix shared state tests
* wip
* add alert test
* wip
* wip
* wip
* wip
* Use transaction in binding
* wip
* wip
* wip
* wip
* wip
* wip
* uikit
* keep references to controllers when presenting so that we can properly dismiss
* change order of features in shared state demo
* wip
* cleanup
* cleanup
* wip
* wip
* wip
* Fix perception checking for effect actions.
* wip
* wip
* wip
* Fix perception checking for effect actions.
* wip
* wip
* remove sync ups tutorial
* wip
* wip
* wip
* wip
* wip
* docs for observe function for uikit
* Add cancellation to observation'
* re-record integration test snapshots
* fixed some todos
* update test
* remove 5.9.2 checks
* wip
* improve docs
* update docs
* updates
* lots of fixes
* more docs
* remove unneeded file;
* wip
* wip
* wip
* update readme and getting started
* wip
* simplify
* migration stuff
* wip
* Update Models.swift
* wip
* wip
* wip
* Update Bindings.md
* wip
* wip
* wip
* wip
* fix
* wip
* wip
* wip
* wip
* wip
Co-authored-by: Kabir Oberai <oberai.kabir@gmail.com>
---------
Co-authored-by: Brandon Williams <mbrandonw@hey.com>
Co-authored-by: hmhv <admin@hmhv.info>
Co-authored-by: Jimmy Prime <jimmylevelup@gmail.com>
Co-authored-by: Michael Pohl <15653162+Mika5652@users.noreply.github.com>
Co-authored-by: Brandon Williams <135203+mbrandonw@users.noreply.github.com>
Co-authored-by: George Scott <gscott@gekkoto.com>
Co-authored-by: Kabir Oberai <oberai.kabir@gmail.com>
* Clean up shared state case study.
* wip
* wip
* Update Examples/CaseStudies/SwiftUICaseStudies/01-GettingStarted-SharedState.swift
---------
Co-authored-by: Stephen Celis <stephen@stephencelis.com>
* Migration guide: `@CasePathable` tweaks
Tweaks the 1.4 migration guide a bit to note that `@CasePathable` is
explicitly needed in some cases.
* wip
* Update Sources/ComposableArchitecture/Documentation.docc/Articles/MigratingTo1.4.md
* Update Sources/ComposableArchitecture/Documentation.docc/Articles/MigratingTo1.4.md
---------
Co-authored-by: Brandon Williams <135203+mbrandonw@users.noreply.github.com>
