Paywalls: updated template names (#2878)

These now match our initial 2 templates. I've updated everything for consistency: - `PaywallTemplate` - `View`s - Snapshot tests - Test fixtures
RevenueCat · Aug 17, 2023 · 2596938 · 2596938
1 parent a5c3bcc
commit 2596938
Show file tree

Hide file tree

Showing 20 changed files with 28 additions and 28 deletions.
diff --git a/Package.swift b/Package.swift
@@ -77,7 +77,7 @@ let package = Package(
                         "Nimble",
                         .product(name: "SnapshotTesting", package: "swift-snapshot-testing")
                     ],
-                    exclude: ["__Snapshots__"],
+                    exclude: ["Templates/__Snapshots__"],
                     resources: [.copy("Resources/header.jpg"), .copy("Resources/background.jpg")])
     ]
 )
diff --git a/RevenueCatUI/Data/TestData.swift b/RevenueCatUI/Data/TestData.swift
@@ -117,7 +117,7 @@ internal enum TestData {
     ]
 
     static let paywallWithIntroOffer = PaywallData(
-        template: .singlePackage,
+        template: .onePackageStandard,
         config: .init(
             packages: [.monthly],
             images: Self.images,
@@ -129,7 +129,7 @@ internal enum TestData {
         assetBaseURL: Self.paywallAssetBaseURL
     )
     static let paywallWithNoIntroOffer = PaywallData(
-        template: .singlePackage,
+        template: .onePackageStandard,
         config: .init(
             packages: [.annual],
             images: Self.images,
@@ -160,7 +160,7 @@ internal enum TestData {
         serverDescription: "Offering",
         metadata: [:],
         paywall: .init(
-            template: .multiPackage,
+            template: .multiPackageBold,
             config: .init(
                 packages: [.annual, .monthly],
                 images: Self.images,

diff --git a/RevenueCatUI/Helpers/PaywallData+Default.swift b/RevenueCatUI/Helpers/PaywallData+Default.swift
@@ -15,7 +15,7 @@ extension PaywallData {
     /// Default `PaywallData` to display when attempting to present a ``PaywallView`` with an offering
     /// that has no paywall configuration, or when that configuration is invalid.
     public static let `default`: Self = .init(
-        template: .multiPackage,
+        template: .multiPackageBold,
         config: .init(
             packages: [.weekly, .monthly, .annual],
             images: .init(background: Self.backgroundImage),

diff --git a/RevenueCatUI/PaywallView.swift b/RevenueCatUI/PaywallView.swift
@@ -262,8 +262,8 @@ private extension PaywallTemplate {
 
     var name: String {
         switch self {
-        case .singlePackage: return "single"
-        case .multiPackage: return "multi"
+        case .onePackageStandard: return "single"
+        case .multiPackageBold: return "multi"
         }
     }
 

diff --git a/...atUI/Templates/MultiPackageTemplate.swift → .../Templates/MultiPackageBoldTemplate.swift b/...atUI/Templates/MultiPackageTemplate.swift → .../Templates/MultiPackageBoldTemplate.swift
@@ -2,7 +2,7 @@ import RevenueCat
 import SwiftUI
 
 @available(iOS 16.0, macOS 13.0, tvOS 16.0, *)
-struct MultiPackageTemplate: TemplateViewType {
+struct MultiPackageBoldTemplate: TemplateViewType {
 
     private let configuration: TemplateViewConfiguration
 

diff --git a/...tUI/Templates/SinglePackageTemplate.swift → ...lates/SinglePackageStandardTemplate.swift b/...tUI/Templates/SinglePackageTemplate.swift → ...lates/SinglePackageStandardTemplate.swift
@@ -2,7 +2,7 @@ import RevenueCat
 import SwiftUI
 
 @available(iOS 16.0, macOS 13.0, tvOS 16.0, *)
-struct SinglePackageTemplate: TemplateViewType {
+struct SinglePackageStandardTemplate: TemplateViewType {
 
     private let configuration: TemplateViewConfiguration
 

diff --git a/RevenueCatUI/Templates/TemplateViewType.swift b/RevenueCatUI/Templates/TemplateViewType.swift
@@ -14,8 +14,8 @@ private extension PaywallTemplate {
 
     var packageSetting: TemplateViewConfiguration.PackageSetting {
         switch self {
-        case .singlePackage: return .single
-        case .multiPackage: return .multiple
+        case .onePackageStandard: return .single
+        case .multiPackageBold: return .multiple
         }
     }
 
@@ -69,10 +69,10 @@ extension PaywallData {
     private static func createView(template: PaywallTemplate,
                                    configuration: TemplateViewConfiguration) -> some View {
         switch template {
-        case .singlePackage:
-            SinglePackageTemplate(configuration)
-        case .multiPackage:
-            MultiPackageTemplate(configuration)
+        case .onePackageStandard:
+            SinglePackageStandardTemplate(configuration)
+        case .multiPackageBold:
+            MultiPackageBoldTemplate(configuration)
         }
     }
 

diff --git a/Sources/Paywalls/PaywallTemplate.swift b/Sources/Paywalls/PaywallTemplate.swift
@@ -17,8 +17,8 @@ import Foundation
 public enum PaywallTemplate: String {
 
     // swiftlint:disable missing_docs
-    case singlePackage = "sample_1"
-    case multiPackage = "sample_2"
+    case onePackageStandard = "one_package_standard"
+    case multiPackageBold = "multi_package_bold"
 
     // swiftlint:enable missing_docs
 

diff --git a/Tests/APITesters/SwiftAPITester/SwiftAPITester/PaywallAPI.swift b/Tests/APITesters/SwiftAPITester/SwiftAPITester/PaywallAPI.swift
@@ -131,9 +131,9 @@ func checkPaywallColor(_ color: PaywallColor) throws {
 
 func checkPaywallTemplate(_ template: PaywallTemplate) {
     switch template {
-    case .singlePackage:
+    case .onePackageStandard:
         break
-    case .multiPackage:
+    case .multiPackageBold:
         break
     @unknown default:
         break

diff --git a/...ITests/MultiPackagePaywallViewTests.swift → ...es/MultiPackageBoldPaywallViewTests.swift b/...ITests/MultiPackagePaywallViewTests.swift → ...es/MultiPackageBoldPaywallViewTests.swift
@@ -6,7 +6,7 @@ import SnapshotTesting
 #if !os(macOS)
 
 @available(iOS 16.0, macOS 13.0, tvOS 16.0, watchOS 9.0, *)
-class MultiPackagePaywallViewTests: BaseSnapshotTest {
+class MultiPackageBoldPaywallViewTests: BaseSnapshotTest {
 
     func testSamplePaywall() {
         let view = PaywallView(offering: Self.offering.withLocalImages,

diff --git a/...Tests/SinglePackagePaywallViewTests.swift → .../OnePackageStandardPaywallViewTests.swift b/...Tests/SinglePackagePaywallViewTests.swift → .../OnePackageStandardPaywallViewTests.swift
@@ -7,7 +7,7 @@ import SwiftUI
 #if !os(macOS)
 
 @available(iOS 16.0, macOS 13.0, tvOS 16.0, watchOS 9.0, *)
-class SinglePackagePaywallViewTests: BaseSnapshotTest {
+class OnePackageStandardPaywallViewTests: BaseSnapshotTest {
 
     func testSamplePaywall() {
         let view = PaywallView(offering: Self.offeringWithNoIntroOffer,

diff --git a/...nueCatUITests/OtherPaywallViewTests.swift → ...sts/Templates/OtherPaywallViewTests.swift b/...nueCatUITests/OtherPaywallViewTests.swift → ...sts/Templates/OtherPaywallViewTests.swift
diff --git a/...UITests/PaywallViewDynamicTypeTests.swift → ...mplates/PaywallViewDynamicTypeTests.swift b/...UITests/PaywallViewDynamicTypeTests.swift → ...mplates/PaywallViewDynamicTypeTests.swift
diff --git a/...ITests/PaywallViewLocalizationTests.swift → ...plates/PaywallViewLocalizationTests.swift b/...ITests/PaywallViewLocalizationTests.swift → ...plates/PaywallViewLocalizationTests.swift
@@ -53,7 +53,7 @@ import SwiftUI
         serverDescription: "Offering",
         metadata: [:],
         paywall: .init(
-            template: .multiPackage,
+            template: .multiPackageBold,
             config: .init(
                 packages: [.weekly, .annual, .monthly],
                 images: TestData.images,

diff --git a/Tests/UnitTests/Networking/Responses/Fixtures/Offerings.json b/Tests/UnitTests/Networking/Responses/Fixtures/Offerings.json
@@ -39,7 +39,7 @@
                 }
             ],
             "paywall": {
-                "template_name": "sample_1",
+                "template_name": "one_package_standard",
                 "localized_strings": {
                     "en_US": {
                         "title": "Paywall",

diff --git a/Tests/UnitTests/Networking/Responses/Fixtures/PaywallData-Sample1.json b/Tests/UnitTests/Networking/Responses/Fixtures/PaywallData-Sample1.json
@@ -1,5 +1,5 @@
 {
-    "template_name": "sample_1",
+    "template_name": "one_package_standard",
     "localized_strings": {
         "en_US": {
             "title": "Paywall",

diff --git a/...itTests/Networking/Responses/Fixtures/PaywallData-missing_current_and_default_locale.json b/...itTests/Networking/Responses/Fixtures/PaywallData-missing_current_and_default_locale.json
@@ -1,5 +1,5 @@
 {
-    "template_name": "sample_1",
+    "template_name": "one_package_standard",
     "localized_strings": {
         "it_IT": {
             "title": "Paywall",

diff --git a/Tests/UnitTests/Networking/Responses/Fixtures/PaywallData-missing_current_locale.json b/Tests/UnitTests/Networking/Responses/Fixtures/PaywallData-missing_current_locale.json
@@ -1,5 +1,5 @@
 {
-    "template_name": "sample_1",
+    "template_name": "one_package_standard",
     "localized_strings": {
         "es_ES": {
             "title": "Tienda",

diff --git a/Tests/UnitTests/Networking/Responses/OfferingsDecodingTests.swift b/Tests/UnitTests/Networking/Responses/OfferingsDecodingTests.swift
@@ -108,7 +108,7 @@ class OfferingsDecodingTests: BaseHTTPResponseTest {
         expect(offering.packages).to(haveCount(2))
 
         let paywall = try XCTUnwrap(offering.paywall)
-        expect(paywall.template) == .singlePackage
+        expect(paywall.template) == .onePackageStandard
         expect(paywall.defaultLocale) == Locale(identifier: "en_US")
         try expect(paywall.assetBaseURL) == XCTUnwrap(URL(string: "https://rc-paywalls.s3.amazonaws.com"))
 

diff --git a/Tests/UnitTests/Paywalls/PaywallDataTests.swift b/Tests/UnitTests/Paywalls/PaywallDataTests.swift
@@ -29,7 +29,7 @@ class PaywallDataTests: BaseHTTPResponseTest {
     func testSample1() throws {
         let paywall: PaywallData = try self.decodeFixture("PaywallData-Sample1")
 
-        expect(paywall.template) == .singlePackage
+        expect(paywall.template) == .onePackageStandard
         expect(paywall.defaultLocale) == Locale(identifier: Self.defaultLocale)
         expect(paywall.assetBaseURL) == URL(string: "https://rc-paywalls.s3.amazonaws.com")!
         expect(paywall.config.packages) == [.monthly, .annual]