Rename viewEnvironment to environment

square · Mar 30, 2023 · 11998ee · 11998ee
1 parent 3391f7a
commit 11998ee
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 12 deletions.
diff --git a/ViewEnvironmentUI/Sources/ViewEnvironmentPropagating.swift b/ViewEnvironmentUI/Sources/ViewEnvironmentPropagating.swift
@@ -81,7 +81,7 @@ public protocol ViewEnvironmentPropagating {
     /// `layoutSubviews()` respectively.
     ///
     @_spi(ViewEnvironmentWiring)
-    var viewEnvironment: ViewEnvironment { get }
+    var environment: ViewEnvironment { get }
 }
 
 extension ViewEnvironmentPropagating {
@@ -110,20 +110,20 @@ extension ViewEnvironmentPropagating {
     /// ``ViewEnvironmentObserving/applyEnvironmentIfNeeded()-8gr5k`` in `viewWillLayoutSubviews()` and
     /// `layoutSubviews()` respectively.
     ///
-    public var viewEnvironment: ViewEnvironment {
+    public var environment: ViewEnvironment {
         _defaultViewEnvironment
     }
 
-    /// The default `ViewEnvironment` returned by ``viewEnvironment-1p2gj``.
+    /// The default `ViewEnvironment` returned by ``environment``.
     ///
     /// The environment is constructed by recursively walking to the root of the propagation path
     /// and then applying all customizations on the way back down.
     ///
-    ///  You should only need to access this value if you are overriding ``viewEnvironment-1p2gj``
+    ///  You should only need to access this value if you are overriding ``environment``
     /// and want to conditionally return the default.
     @_spi(ViewEnvironmentWiring)
     public var _defaultViewEnvironment: ViewEnvironment {
-        var environment = environmentAncestor?.viewEnvironment
+        var environment = environmentAncestor?.environment
             ?? .empty
 
         (self as? ViewEnvironmentCustomizing)?.customize(environment: &environment)

diff --git a/ViewEnvironmentUI/Sources/ViewEnvironmentPropagatingObject.swift b/ViewEnvironmentUI/Sources/ViewEnvironmentPropagatingObject.swift
@@ -51,7 +51,7 @@ extension ViewEnvironmentObserving where Self: ViewEnvironmentPropagatingObject
 
         needsEnvironmentUpdate = false
 
-        apply(environment: viewEnvironment)
+        apply(environment: environment)
     }
 }
 
@@ -215,7 +215,7 @@ extension ViewEnvironmentPropagatingObject {
         needsEnvironmentUpdate = true
 
         if !needsUpdateObservers.isEmpty {
-            let environment = viewEnvironment
+            let environment = self.environment
 
             for observer in needsUpdateObservers.values {
                 observer(environment)

diff --git a/ViewEnvironmentUI/Tests/ViewEnvironmentObservingTests.swift b/ViewEnvironmentUI/Tests/ViewEnvironmentObservingTests.swift
@@ -15,7 +15,7 @@ final class ViewEnvironmentObservingTests: XCTestCase {
         container.addChild(child)
         child.didMove(toParent: container)
 
-        XCTAssertEqual(child.viewEnvironment.testContext.number, 1)
+        XCTAssertEqual(child.environment.testContext.number, 1)
     }
 
     func test_environment_propagation_to_presented() {
@@ -30,7 +30,7 @@ final class ViewEnvironmentObservingTests: XCTestCase {
 
         container.present(child, animated: false, completion: {})
 
-        XCTAssertEqual(child.viewEnvironment.testContext.number, 1)
+        XCTAssertEqual(child.environment.testContext.number, 1)
     }
 
     func test_environment_multiple_overrides_with_root() {
@@ -67,7 +67,7 @@ final class ViewEnvironmentObservingTests: XCTestCase {
         // Mutation by child
         expectedContext.number = 2
 
-        XCTAssertEqual(child.viewEnvironment.testContext, expectedContext)
+        XCTAssertEqual(child.environment.testContext, expectedContext)
     }
 
     // MARK: - apply(environment:)
@@ -176,7 +176,7 @@ final class ViewEnvironmentObservingTests: XCTestCase {
         let viewController = UIViewController()
         viewController.environmentAncestorOverride = { ancestor }
 
-        XCTAssertEqual(viewController.viewEnvironment.testContext, expectedTestContext)
+        XCTAssertEqual(viewController.environment.testContext, expectedTestContext)
     }
 
     func test_descendant_customFlow() {
@@ -229,7 +229,7 @@ final class ViewEnvironmentObservingTests: XCTestCase {
         XCTAssertTrue(child.needsEnvironmentUpdate)
         XCTAssertTrue(descendant.needsEnvironmentUpdate)
 
-        XCTAssertEqual(descendant.viewEnvironment.testContext, expectedContext)
+        XCTAssertEqual(descendant.environment.testContext, expectedContext)
     }
 
     // MARK: - Observations