Paywalls: presentPaywallIfNecessary -> presentPaywallIfNeeded (#…

…2953) This is a slightly clearer API.
RevenueCat · Aug 7, 2023 · f54dff2 · f54dff2
1 parent 2dabce5
commit f54dff2
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 18 deletions.
diff --git a/RevenueCatUI/View+PresentPaywall.swift b/RevenueCatUI/View+PresentPaywall.swift
@@ -19,16 +19,16 @@ extension View {
     /// ```swift
     /// var body: some View {
     ///    YourApp()
-    ///      .presentPaywallIfNecessary(requiredEntitlementIdentifier: "pro")
+    ///      .presentPaywallIfNeeded(requiredEntitlementIdentifier: "pro")
     /// }
     /// ```
     /// - Note: If loading the `CustomerInfo` fails (for example, if Internet is offline),
     /// the paywall won't be displayed.
-    public func presentPaywallIfNecessary(
+    public func presentPaywallIfNeeded(
         requiredEntitlementIdentifier: String,
         purchaseCompleted: PurchaseCompletedHandler? = nil
     ) -> some View {
-        return self.presentPaywallIfNecessary(
+        return self.presentPaywallIfNeeded(
             shouldDisplay: { info in
                 !info.entitlements
                     .activeInCurrentEnvironment
@@ -44,7 +44,7 @@ extension View {
     /// ```swift
     /// var body: some View {
     ///    YourApp()
-    ///      .presentPaywallIfNecessary {
+    ///      .presentPaywallIfNeeded {
     ///         !$0.entitlements.active.keys.contains("entitlement_identifier")
     ///     } purchaseCompleted: { customerInfo in
     ///         print("Customer info unlocked entitlement: \(customerInfo.entitlements)")
@@ -53,11 +53,11 @@ extension View {
     /// ```
     /// - Note: If loading the `CustomerInfo` fails (for example, if Internet is offline),
     /// the paywall won't be displayed.
-    public func presentPaywallIfNecessary(
+    public func presentPaywallIfNeeded(
         shouldDisplay: @escaping @Sendable (CustomerInfo) -> Bool,
         purchaseCompleted: PurchaseCompletedHandler? = nil
     ) -> some View {
-        return self.presentPaywallIfNecessary(
+        return self.presentPaywallIfNeeded(
             shouldDisplay: shouldDisplay,
             purchaseCompleted: purchaseCompleted,
             customerInfoFetcher: {
@@ -71,7 +71,7 @@ extension View {
     }
 
     // Visible overload for tests
-    func presentPaywallIfNecessary(
+    func presentPaywallIfNeeded(
         offering: Offering? = nil,
         introEligibility: TrialOrIntroEligibilityChecker? = nil,
         purchaseHandler: PurchaseHandler? = nil,

diff --git a/Tests/APITesters/RevenueCatUIAPITester/SwiftAPITester/PaywallViewAPI.swift b/Tests/APITesters/RevenueCatUIAPITester/SwiftAPITester/PaywallViewAPI.swift
@@ -30,12 +30,12 @@ struct App: View {
     }
 
     @ViewBuilder
-    var checkPresentPaywallIfNecessary: some View {
+    var checkPresentPaywallIfNeeded: some View {
         Text("")
-            .presentPaywallIfNecessary(requiredEntitlementIdentifier: "")
-            .presentPaywallIfNecessary(requiredEntitlementIdentifier: "", purchaseCompleted: completed)
-            .presentPaywallIfNecessary { (_: CustomerInfo) in false }
-            .presentPaywallIfNecessary { (_: CustomerInfo) in false } purchaseCompleted: { completed($0) }
+            .presentPaywallIfNeeded(requiredEntitlementIdentifier: "")
+            .presentPaywallIfNeeded(requiredEntitlementIdentifier: "", purchaseCompleted: completed)
+            .presentPaywallIfNeeded { (_: CustomerInfo) in false }
+            .presentPaywallIfNeeded { (_: CustomerInfo) in false } purchaseCompleted: { completed($0) }
     }
 
     @ViewBuilder

diff --git a/...eCatUITests/PresentIfNecessaryTests.swift → ...enueCatUITests/PresentIfNeededTests.swift b/...eCatUITests/PresentIfNecessaryTests.swift → ...enueCatUITests/PresentIfNeededTests.swift
@@ -1,5 +1,5 @@
 //
-//  PresentIfNecessaryTests.swift
+//  PresentIfNeededTests.swift
 //  
 //
 //  Created by Nacho Soto on 7/31/23.
@@ -15,15 +15,15 @@ import XCTest
 
 @available(iOS 16.0, macOS 13.0, tvOS 16.0, watchOS 9.0, *)
 @MainActor
-class PresentIfNecessaryTests: TestCase {
+class PresentIfNeededTests: TestCase {
 
     func testPresentWithPurchaseHandler() throws {
         var customerInfo: CustomerInfo?
 
         Text("")
-            .presentPaywallIfNecessary(offering: Self.offering,
-                                       introEligibility: .producing(eligibility: .eligible),
-                                       purchaseHandler: Self.purchaseHandler) { _ in
+            .presentPaywallIfNeeded(offering: Self.offering,
+                                    introEligibility: .producing(eligibility: .eligible),
+                                    purchaseHandler: Self.purchaseHandler) { _ in
                 return true
             } purchaseCompleted: {
                 customerInfo = $0

diff --git a/Tests/TestingApps/SimpleApp/SimpleApp/Views/AppContentView.swift b/Tests/TestingApps/SimpleApp/SimpleApp/Views/AppContentView.swift
@@ -53,7 +53,7 @@ struct AppContentView: View {
                     Label("All paywalls", systemImage: "network")
                 }
         }
-        .presentPaywallIfNecessary {
+        .presentPaywallIfNeeded {
             !$0.hasPro
         } purchaseCompleted: { _ in
             self.didPurchase = true