Skip to content

Improve deprecation warnings for old binding helpers #774

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Sep 7, 2021
Merged

Improve deprecation warnings for old binding helpers #774

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7cf56a3
Improve deprecation warnings for old binding helpers
stephencelis Sep 7, 2021
1f22a42
wip
stephencelis Sep 7, 2021
94e685e
wip
stephencelis Sep 7, 2021
33e6673
wip
stephencelis Sep 7, 2021
db7daf0
esc
stephencelis Sep 7, 2021
0861ed6
wip
stephencelis Sep 7, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 18 additions & 8 deletions Sources/ComposableArchitecture/Internal/Deprecations.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,11 @@ import SwiftUI

#if compiler(>=5.4)
extension BindingAction {
@available(*, deprecated, message: "Values are now wrapped in 'BindableState'")
@available(
*, deprecated,
message:
"For improved safety, bindable properties must now be wrapped explicitly in 'BindableState', and accessed via key paths to that 'BindableState', like '\\.$value'"
)
public static func set<Value>(
_ keyPath: WritableKeyPath<Root, Value>,
_ value: Value
Expand All @@ -20,7 +24,11 @@ import SwiftUI
)
}

@available(*, deprecated, message: "Values are now wrapped in 'BindableState'")
@available(
*, deprecated,
message:
"For improved safety, bindable properties must now be wrapped explicitly in 'BindableState', and accessed via key paths to that 'BindableState', like '\\.$value'"
)
public static func ~= <Value>(
keyPath: WritableKeyPath<Root, Value>,
bindingAction: Self
Expand All @@ -33,7 +41,7 @@ import SwiftUI
@available(
*, deprecated,
message:
"'Reducer.binding()' no longer takes an explicit extract function and instead relies on 'BindableAction'"
"'Reducer.binding()' no longer takes an explicit extract function and instead the reducer's 'Action' type must conform to 'BindableAction'"
)
public func binding(action toBindingAction: @escaping (Action) -> BindingAction<State>?) -> Self
{
Expand All @@ -46,7 +54,9 @@ import SwiftUI

extension ViewStore {
@available(
*, deprecated, message: "Bindings are now derived using 'BindableState' and 'BindableAction'"
*, deprecated,
message:
"For improved safety, bindable properties must now be wrapped explicitly in 'BindableState'. Bindings are now derived via dynamic member lookup to that 'BindableState' (for example, 'viewStore.$value'). For dynamic member lookup to be available, the view store's 'Action' type must also conform to 'BindableAction'."
)
public func binding<LocalState>(
keyPath: WritableKeyPath<State, LocalState>,
Expand All @@ -64,7 +74,7 @@ import SwiftUI
@available(
*, deprecated,
message:
"Values are now wrapped in 'BindableState'. Upgrade to Xcode 12.5 or greater for access to 'BindableState'."
"For improved safety, bindable properties must now be wrapped explicitly in 'BindableState', and accessed via key paths to that 'BindableState', like '\\.$value'. Upgrade to Xcode 12.5 or greater for access to 'BindableState'."
)
public static func set<Value>(
_ keyPath: WritableKeyPath<Root, Value>,
Expand All @@ -82,7 +92,7 @@ import SwiftUI
@available(
*, deprecated,
message:
"Values are now wrapped in 'BindableState'. Upgrade to Xcode 12.5 or greater for access to 'BindableState'."
"For improved safety, bindable properties must now be wrapped explicitly in 'BindableState', and accessed via key paths to that 'BindableState', like '\\.$value'. Upgrade to Xcode 12.5 or greater for access to 'BindableState'."
)
public static func ~= <Value>(
keyPath: WritableKeyPath<Root, Value>,
Expand All @@ -96,7 +106,7 @@ import SwiftUI
@available(
*, deprecated,
message:
"'Reducer.binding()' no longer takes an explicit extract function and instead relies on 'BindableAction'. Upgrade to Xcode 12.5 or greater for access to 'Reducer.binding()' and 'BindableAction'."
"'Reducer.binding()' no longer takes an explicit extract function and instead the reducer's 'Action' type must conform to 'BindableAction'. Upgrade to Xcode 12.5 or greater for access to 'Reducer.binding()' and 'BindableAction'."
)
public func binding(action toBindingAction: @escaping (Action) -> BindingAction<State>?) -> Self
{
Expand All @@ -111,7 +121,7 @@ import SwiftUI
@available(
*, deprecated,
message:
"Bindings are now derived using 'BindableState' and 'BindableAction'. Upgrade to Xcode 12.5 or greater for access to 'BindableState' and 'BindableAction'."
"For improved safety, bindable properties must now be wrapped explicitly in 'BindableState'. Bindings are now derived via dynamic member lookup to that 'BindableState' (for example, 'viewStore.$value'). For dynamic member lookup to be available, the view store's 'Action' type must also conform to 'BindableAction'. Upgrade to Xcode 12.5 or greater for access to 'BindableState' and 'BindableAction'."
)
public func binding<LocalState>(
keyPath: WritableKeyPath<State, LocalState>,
Expand Down