refactor: Rename parameters for clarity in MPKitRokt methods

Updated method signatures and documentation to replace 'viewName' with 'identifier' and 'placements' with 'embeddedViews'

Author: thomson-t

mParticle-Rokt/MPKitRokt.m

@@ -76,19 +76,19 @@ - (void)start {
     });
 }
 
-/// \param viewName The name that should be displayed in the widget
+/// \param identifier The name that should be displayed in the widget
 ///
 /// \param attributes A string dictionary containing the parameters that should be displayed in the widget
 ///
-/// \param placements A dictionary of RoktEmbeddedViews with their names
+/// \param embeddedViews A dictionary of RoktEmbeddedViews with their names
 ///
 /// \param callbacks Object that contains all possible callbacks for selectPlacements
 ///
 /// \param filteredUser The current user when this placement was requested. Filtered for the kit as per settings in the mParticle UI
 ///
-- (MPKitExecStatus *)executeWithViewName:(NSString * _Nullable)viewName
+- (MPKitExecStatus *)executeWithIdentifier:(NSString * _Nullable)identifier
                               attributes:(NSDictionary<NSString *, NSString *> * _Nonnull)attributes
-                              placements:(NSDictionary<NSString *, MPRoktEmbeddedView *> * _Nullable)placements
+                           embeddedViews:(NSDictionary<NSString *, MPRoktEmbeddedView *> * _Nullable)embeddedViews
                                   config:(MPRoktConfig * _Nullable)mpRoktConfig
                                callbacks:(MPRoktEventCallback * _Nullable)callbacks
                             filteredUser:(FilteredMParticleUser * _Nonnull)filteredUser {
@@ -113,9 +113,9 @@ - (MPKitExecStatus *)executeWithViewName:(NSString * _Nullable)viewName
     //Convert MPRoktConfig to RoktConfig
     RoktConfig *roktConfig = [MPKitRokt convertMPRoktConfig:mpRoktConfig];
 
-    [Rokt executeWithViewName:viewName
+    [Rokt executeWithViewName:identifier
                    attributes:finalAtt
-                   placements:[self confirmPlacements:placements]
+                   placements:[self confirmEmbeddedViews:embeddedViews]
                        config:roktConfig
                        onLoad:callbacks.onLoad
                      onUnLoad:callbacks.onUnLoad
@@ -151,11 +151,11 @@ - (RoktFrameworkType)mapMPWrapperSdkToRoktFrameworkType:(MPWrapperSdk)wrapperSdk
     }
 }
 
-- (NSDictionary<NSString *, RoktEmbeddedView *> * _Nullable) confirmPlacements:(NSDictionary<NSString *, MPRoktEmbeddedView *> * _Nullable)placements {
+- (NSDictionary<NSString *, RoktEmbeddedView *> * _Nullable) confirmEmbeddedViews:(NSDictionary<NSString *, MPRoktEmbeddedView *> * _Nullable)embeddedViews {
     NSMutableDictionary <NSString *, RoktEmbeddedView *> *safePlacements = [NSMutableDictionary dictionary];
 
-    for (NSString* key in placements) {
-        MPRoktEmbeddedView *mpView = [placements objectForKey:key];
+    for (NSString* key in embeddedViews) {
+        MPRoktEmbeddedView *mpView = [embeddedViews objectForKey:key];
 
         if ([mpView isKindOfClass:MPRoktEmbeddedView.class]) {
             // Create a new RoktEmbeddedView instance

mParticle_RoktTests/mParticle_RoktTests.m

@@ -5,9 +5,9 @@
 
 @interface MPKitRokt ()
 
-- (MPKitExecStatus *)executeWithViewName:(NSString * _Nullable)viewName
+- (MPKitExecStatus *)executeWithIdentifier:(NSString * _Nullable)identifier
                               attributes:(NSDictionary<NSString *, NSString *> * _Nonnull)attributes
-                              placements:(NSDictionary<NSString *, MPRoktEmbeddedView *> * _Nullable)placements
+                           embeddedViews:(NSDictionary<NSString *, MPRoktEmbeddedView *> * _Nullable)embeddedViews
                                   config:(MPRoktConfig * _Nullable)mpRoktConfig
                                callbacks:(MPRoktEventCallback * _Nullable)callbacks
                             filteredUser:(FilteredMParticleUser * _Nonnull)filteredUser;
@@ -17,7 +17,7 @@ - (MPKitExecStatus *)purchaseFinalized:(NSString *)placementId
                          catalogItemId:(NSString *)catalogItemId
                                success:(NSNumber *)success;
 
-- (NSDictionary<NSString *, RoktEmbeddedView *> * _Nullable) confirmPlacements:(NSDictionary<NSString *, RoktEmbeddedView *> * _Nullable)placements;
+- (NSDictionary<NSString *, RoktEmbeddedView *> * _Nullable) confirmEmbeddedViews:(NSDictionary<NSString *, RoktEmbeddedView *> * _Nullable)embeddedViews;
 
 - (NSDictionary<NSString *, NSString *> *) filteredUserAttributes:(NSDictionary<NSString *, NSString *> * _Nonnull)attributes kitConfiguration:(MPKitConfiguration *)kitConfiguration;
 
@@ -76,20 +76,20 @@ - (void)testDidFinishLaunchingWithConfiguration_MissingAccountId {
     XCTAssertEqual(status.returnCode, MPKitReturnCodeRequirementsNotMet);
 }
 
-- (void)testConfirmPlacements_ValidPlacements {
+- (void)testConfirmEmbeddedViews_ValidEmbeddedViews {
     MPRoktEmbeddedView *view = [[MPRoktEmbeddedView alloc] init];
-    NSDictionary *placements = @{@"placement1": view};
+    NSDictionary *embeddedViews = @{@"placement1": view};
 
-    NSDictionary *result = [self.kitInstance confirmPlacements:placements];
+    NSDictionary *result = [self.kitInstance confirmEmbeddedViews:embeddedViews];
 
     XCTAssertEqual(result.count, 1);
     XCTAssertTrue([result[@"placement1"] isKindOfClass:[RoktEmbeddedView class]]);
 }
 
-- (void)testConfirmPlacements_InvalidPlacements {
-    NSDictionary *placements = @{@"placement1": @"invalid"};
+- (void)testConfirmEmbeddedViews_InvalidEmbeddedViews {
+    NSDictionary *embeddedViews = @{@"placement1": @"invalid"};
 
-    NSDictionary *result = [self.kitInstance confirmPlacements:placements];
+    NSDictionary *result = [self.kitInstance confirmEmbeddedViews:embeddedViews];
 
     XCTAssertEqual(result.count, 0);
 }
@@ -124,12 +124,12 @@ - (void)testLogBaseEvent {
     XCTAssertEqual(status.returnCode, MPKitReturnCodeSuccess);
 }
 
-- (void)testExecuteWithViewName {
+- (void)testExecuteWithIdentifier {
     id mockRoktSDK = OCMClassMock([Rokt class]);
 
     MPRoktEmbeddedView *view = [[MPRoktEmbeddedView alloc] init];
-    NSString *viewName = @"TestView";
-    NSDictionary *placements = @{@"placement1": view};
+    NSString *identifier = @"TestView";
+    NSDictionary *embeddedViews = @{@"placement1": view};
     NSDictionary *attributes = @{@"attr1": @"value1", @"sandbox": @"true"};
     FilteredMParticleUser *user = [[FilteredMParticleUser alloc] init];
 
@@ -139,19 +139,19 @@ - (void)testExecuteWithViewName {
     };
 
     // Expect Rokt execute call with correct parameters
-    OCMExpect([mockRoktSDK executeWithViewName:viewName
+    OCMExpect([mockRoktSDK executeWithViewName:identifier
                                     attributes:expectedAttributes
-                                    placements:OCMOCK_ANY
+                                 embeddedViews:OCMOCK_ANY
                                         config:nil
                                         onLoad:nil
                                       onUnLoad:nil
                   onShouldShowLoadingIndicator:nil
                   onShouldHideLoadingIndicator:nil
                           onEmbeddedSizeChange:nil]);
 
-    MPKitExecStatus *status = [self.kitInstance executeWithViewName:viewName
+    MPKitExecStatus *status = [self.kitInstance executeWithIdentifier:identifier
                                                          attributes:attributes
-                                                         placements:placements
+                                                      embeddedViews:embeddedViews
                                                              config:nil
                                                           callbacks:nil
                                                        filteredUser:user];