Skip to content

Commit 160899a

Browse files
thomson-tBrandonStalnaker
thomson-t
and
BrandonStalnaker
authored
refactor: Rename 'placements' to 'embeddedViews' in selectPlacements method and update related references (#368)
* refactor: Rename 'placements' to 'embeddedViews' in selectPlacements method and update related references Rename param * refactor the MPKitProtocol --------- Co-authored-by: Brandon Stalnaker <33703490+BrandonStalnaker@users.noreply.github.com>
1 parent ce1a284 commit 160899a

7 files changed

Lines changed: 48 additions & 47 deletions

File tree

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33

44
# Xcode
55
build/
6+
.build/
67
*.pbxuser
78
!default.pbxuser
89
*.mode1v3

‎Example/mParticleExample/ViewController.m‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,7 @@ - (void)selectDarkOverlayPlacement {
204204
roktConfig.colorMode = MPColorModeDark;
205205
[[MParticle sharedInstance].rokt selectPlacements:@"RoktLayout"
206206
attributes:customAttributes
207-
placements:nil
207+
embeddedViews:nil
208208
config:roktConfig
209209
callbacks:nil];
210210
}
@@ -235,9 +235,9 @@ - (void)selectEmbeddedPlacement {
235235
[self setupUI:size];
236236
};
237237

238-
NSDictionary *placements = @{@"Location1": self.roktView};
238+
NSDictionary *embeddedViews = @{@"Location1": self.roktView};
239239

240-
[[MParticle sharedInstance].rokt selectPlacements:@"testiOS" attributes:customAttributes placements:placements config:nil callbacks:callbacks];
240+
[[MParticle sharedInstance].rokt selectPlacements:@"testiOS" attributes:customAttributes embeddedViews:embeddedViews config:nil callbacks:callbacks];
241241
}
242242

243243
- (void)getAudience {

‎UnitTests/MPRoktTests.m‎

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -80,16 +80,16 @@ - (void)testSelectPlacementsSimpleWithValidParameters {
8080
}] identify:[OCMArg any] completion:[OCMArg any]];
8181

8282
// Set up test parameters
83-
NSString *viewName = @"testView";
83+
NSString *identifier = @"testView";
8484
NSDictionary *attributes = @{@"email": @"test@gmail.com", @"sandbox": @"false"};
8585

8686
// Set up expectations for kit container
8787
XCTestExpectation *expectation = [self expectationWithDescription:@"Wait for async operation"];
88-
SEL roktSelector = @selector(executeWithViewName:attributes:placements:config:callbacks:filteredUser:);
88+
SEL roktSelector = @selector(executeWithIdentifier:attributes:embeddedViews:config:callbacks:filteredUser:);
8989
OCMExpect([self.mockContainer forwardSDKCall:roktSelector
9090
event:nil
9191
parameters:[OCMArg checkWithBlock:^BOOL(MPForwardQueueParameters *params) {
92-
XCTAssertEqualObjects(params[0], viewName);
92+
XCTAssertEqualObjects(params[0], identifier);
9393
XCTAssertEqualObjects(params[1], attributes);
9494
XCTAssertNil(params[2]);
9595
XCTAssertNil(params[3]);
@@ -101,7 +101,7 @@ - (void)testSelectPlacementsSimpleWithValidParameters {
101101
});
102102

103103
// Execute method
104-
[self.rokt selectPlacements:viewName
104+
[self.rokt selectPlacements:identifier
105105
attributes:attributes];
106106

107107
// Wait for async operation
@@ -120,11 +120,11 @@ - (void)testSelectPlacementsExpandedWithValidParameters {
120120
[[[self.mockInstance stub] andReturn:self.mockInstance] sharedInstance];
121121

122122
// Set up test parameters
123-
NSString *viewName = @"testView";
123+
NSString *identifier = @"testView";
124124
NSDictionary *attributes = @{@"key": @"value"};
125125
NSDictionary *finalAttributes = @{@"key": @"value", @"sandbox": @"true"};
126126
MPRoktEmbeddedView *exampleView = [[MPRoktEmbeddedView alloc] initWithFrame:CGRectZero];
127-
NSDictionary *placements = @{@"placement": exampleView};
127+
NSDictionary *embeddedViews = @{@"placement": exampleView};
128128
MPRoktEventCallback *exampleCallbacks = [[MPRoktEventCallback alloc] init];
129129
exampleCallbacks.onLoad = ^{};
130130
exampleCallbacks.onUnLoad = ^{};
@@ -139,13 +139,13 @@ - (void)testSelectPlacementsExpandedWithValidParameters {
139139

140140
// Set up expectations for kit container
141141
XCTestExpectation *expectation = [self expectationWithDescription:@"Wait for async operation"];
142-
SEL roktSelector = @selector(executeWithViewName:attributes:placements:config:callbacks:filteredUser:);
142+
SEL roktSelector = @selector(executeWithIdentifier:attributes:embeddedViews:config:callbacks:filteredUser:);
143143
OCMExpect([self.mockContainer forwardSDKCall:roktSelector
144144
event:nil
145145
parameters:[OCMArg checkWithBlock:^BOOL(MPForwardQueueParameters *params) {
146-
XCTAssertEqualObjects(params[0], viewName);
146+
XCTAssertEqualObjects(params[0], identifier);
147147
XCTAssertEqualObjects(params[1], finalAttributes);
148-
XCTAssertEqualObjects(params[2], placements);
148+
XCTAssertEqualObjects(params[2], embeddedViews);
149149
XCTAssertEqualObjects(params[3], roktConfig);
150150
MPRoktEventCallback *resultCallbacks = params[4];
151151
XCTAssertEqualObjects(resultCallbacks.onLoad, exampleCallbacks.onLoad);
@@ -161,9 +161,9 @@ - (void)testSelectPlacementsExpandedWithValidParameters {
161161
});
162162

163163
// Execute method
164-
[self.rokt selectPlacements:viewName
164+
[self.rokt selectPlacements:identifier
165165
attributes:attributes
166-
placements:placements
166+
embeddedViews:embeddedViews
167167
config:roktConfig
168168
callbacks:exampleCallbacks];
169169

@@ -183,25 +183,25 @@ - (void)testSelectPlacementsExpandedWithNilParameters {
183183
[[[self.mockInstance stub] andReturn:self.mockInstance] sharedInstance];
184184

185185
// Set up test parameters
186-
NSString *viewName = @"testView";
186+
NSString *identifier = @"testView";
187187

188188
// Execute method with nil parameters
189-
[self.rokt selectPlacements:viewName
189+
[self.rokt selectPlacements:identifier
190190
attributes:nil
191-
placements:nil
191+
embeddedViews:nil
192192
config:nil
193193
callbacks:nil];
194194

195195
// Wait for async operation
196196
XCTestExpectation *expectation = [self expectationWithDescription:@"Wait for async operation"];
197197

198-
SEL roktSelector = @selector(executeWithViewName:attributes:placements:config:callbacks:filteredUser:);
198+
SEL roktSelector = @selector(executeWithIdentifier:attributes:embeddedViews:config:callbacks:filteredUser:);
199199
NSDictionary *finalAttributes = @{@"sandbox": @"true"};
200200

201201
OCMExpect([self.mockContainer forwardSDKCall:roktSelector
202202
event:nil
203203
parameters:[OCMArg checkWithBlock:^BOOL(MPForwardQueueParameters *params) {
204-
XCTAssertEqualObjects(params[0], viewName);
204+
XCTAssertEqualObjects(params[0], identifier);
205205
XCTAssertEqualObjects(params[1], finalAttributes);
206206
XCTAssertNil(params[2]);
207207
XCTAssertNil(params[3]);
@@ -228,17 +228,17 @@ - (void)testSelectPlacementsSimpleWithMapping {
228228
[[[self.mockInstance stub] andReturn:self.mockInstance] sharedInstance];
229229

230230
// Set up test parameters
231-
NSString *viewName = @"testView";
231+
NSString *identifier = @"testView";
232232
NSDictionary *attributes = @{@"f.name": @"Brandon"};
233233
NSDictionary *mappedAttributes = @{@"firstname": @"Brandon", @"sandbox": @"true"};
234234

235235
// Set up expectations for kit container
236236
XCTestExpectation *expectation = [self expectationWithDescription:@"Wait for async operation"];
237-
SEL roktSelector = @selector(executeWithViewName:attributes:placements:config:callbacks:filteredUser:);
237+
SEL roktSelector = @selector(executeWithIdentifier:attributes:embeddedViews:config:callbacks:filteredUser:);
238238
OCMExpect([self.mockContainer forwardSDKCall:roktSelector
239239
event:nil
240240
parameters:[OCMArg checkWithBlock:^BOOL(MPForwardQueueParameters *params) {
241-
XCTAssertEqualObjects(params[0], viewName);
241+
XCTAssertEqualObjects(params[0], identifier);
242242
XCTAssertEqualObjects(params[1], mappedAttributes);
243243
XCTAssertNil(params[2]);
244244
XCTAssertNil(params[3]);
@@ -250,7 +250,7 @@ - (void)testSelectPlacementsSimpleWithMapping {
250250
});
251251

252252
// Execute method
253-
[self.rokt selectPlacements:viewName
253+
[self.rokt selectPlacements:identifier
254254
attributes:attributes];
255255

256256
// Wait for async operation
@@ -268,19 +268,19 @@ - (void)testSelectPlacementsSimpleWithNilMapping {
268268
[[[self.mockInstance stub] andReturn:self.mockContainer] kitContainer_PRIVATE];
269269
[[[self.mockInstance stub] andReturn:self.mockInstance] sharedInstance];
270270

271-
SEL roktSelector = @selector(executeWithViewName:attributes:placements:config:callbacks:filteredUser:);
271+
SEL roktSelector = @selector(executeWithIdentifier:attributes:embeddedViews:config:callbacks:filteredUser:);
272272
OCMReject([self.mockContainer forwardSDKCall:roktSelector
273273
event:[OCMArg any]
274274
parameters:[OCMArg any]
275275
messageType:MPMessageTypeEvent
276276
userInfo:[OCMArg any]]);
277277

278278
// Set up test parameters
279-
NSString *viewName = @"testView";
279+
NSString *identifier = @"testView";
280280
NSDictionary *attributes = @{@"f.name": @"Brandon"};
281281

282282
// Execute method
283-
[self.rokt selectPlacements:viewName
283+
[self.rokt selectPlacements:identifier
284284
attributes:attributes];
285285

286286
// Verify
@@ -323,7 +323,7 @@ - (void)testSelectPlacementsIdentifyUser {
323323
[[[self.mockInstance stub] andReturn:self.mockInstance] sharedInstance];
324324

325325
// Set up test parameters
326-
NSString *viewName = @"testView";
326+
NSString *identifier = @"testView";
327327
NSDictionary *attributes = @{@"email": @"test@gmail.com", @"sandbox": @"false"};
328328

329329
// Set up expectations for kit container
@@ -333,7 +333,7 @@ - (void)testSelectPlacementsIdentifyUser {
333333
});
334334

335335
// Execute method
336-
[self.rokt selectPlacements:viewName attributes:attributes];
336+
[self.rokt selectPlacements:identifier attributes:attributes];
337337

338338
// Wait for async operation
339339
[self waitForExpectationsWithTimeout:0.2 handler:nil];
@@ -358,10 +358,10 @@ - (void)testTriggeredIdentifyWithNoIdentities {
358358
return true;
359359
}] completion:OCMOCK_ANY];
360360

361-
NSString *viewName = @"testView";
361+
NSString *identifier = @"testView";
362362
NSDictionary *attributes = @{@"email": @"test@gmail.com", @"sandbox": @"false"};
363363

364-
[self.rokt selectPlacements:viewName attributes:attributes];
364+
[self.rokt selectPlacements:identifier attributes:attributes];
365365

366366
[self.identityMock verifyWithDelay:0.2];
367367
}
@@ -389,10 +389,10 @@ - (void)testTriggeredIdentifyWithMismatchedEmailIdentity {
389389
return true;
390390
}] completion:OCMOCK_ANY];
391391

392-
NSString *viewName = @"testView";
392+
NSString *identifier = @"testView";
393393
NSDictionary *attributes = @{@"email": @"test@gmail.com", @"sandbox": @"false"};
394394

395-
[self.rokt selectPlacements:viewName attributes:attributes];
395+
[self.rokt selectPlacements:identifier attributes:attributes];
396396

397397
[self.identityMock verifyWithDelay:0.2];
398398
}

‎mParticle-Apple-SDK/Include/MPKitProtocol.h‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -137,9 +137,9 @@
137137
- (nonnull NSArray<MPForwardRecord *> *)logBatch:(nonnull NSDictionary *)batch;
138138

139139
#pragma mark First Party Kits
140-
- (nonnull MPKitExecStatus *)executeWithViewName:(NSString * _Nullable)viewName
140+
- (nonnull MPKitExecStatus *)executeWithIdentifier:(NSString * _Nullable)identifier
141141
attributes:(NSDictionary<NSString *, NSString *> * _Nonnull)attributes
142-
placements:(NSDictionary<NSString *, MPRoktEmbeddedView *> * _Nullable)placements
142+
embeddedViews:(NSDictionary<NSString *, MPRoktEmbeddedView *> * _Nullable)embeddedViews
143143
config:(MPRoktConfig * _Nullable)config
144144
callbacks:(MPRoktEventCallback * _Nullable)callbacks
145145
filteredUser:(FilteredMParticleUser * _Nonnull)filteredUser;

‎mParticle-Apple-SDK/Include/MPRokt.h‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,12 +76,12 @@ typedef NS_ENUM(NSInteger, MPColorMode) {
7676
*
7777
* @param identifier Unique identifier for the placement
7878
* @param attributes Optional dictionary of attributes to customize the placement
79-
* @param placements Optional dictionary mapping placement names to their embedded views
79+
* @param embeddedViews Optional dictionary mapping placement names to their embedded views
8080
* @param roktEventCallback Optional callback object to handle widget events
8181
*/
8282
- (void)selectPlacements:(NSString *_Nonnull)identifier
8383
attributes:(NSDictionary<NSString *, NSString *> * _Nullable)attributes
84-
placements:(NSDictionary<NSString *, MPRoktEmbeddedView *> * _Nullable)placements
84+
embeddedViews:(NSDictionary<NSString *, MPRoktEmbeddedView *> * _Nullable)embeddedViews
8585
config:(MPRoktConfig * _Nullable)config
8686
callbacks:(MPRoktEventCallback * _Nullable)roktEventCallback;
8787

‎mParticle-Apple-SDK/Kits/MPKitContainer.mm‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2299,18 +2299,18 @@ - (void)attemptToLogEventToKit:(id<MPExtensionKitProtocol>)kitRegister kitFilter
22992299
return;
23002300
}
23012301
execStatus = [kitRegister.wrapperInstance logEvent:((MPEvent *)kitFilter.forwardEvent)];
2302-
} else if (selector == @selector(executeWithViewName:attributes:placements:config:callbacks:filteredUser:)) {
2302+
} else if (selector == @selector(executeWithIdentifier:attributes:embeddedViews:config:callbacks:filteredUser:)) {
23032303
if (kitFilter.shouldFilter) {
23042304
return;
23052305
}
23062306
MParticleUser *currentUser = [[[MParticle sharedInstance] identity] currentUser];
23072307
FilteredMParticleUser *filteredUser = [[FilteredMParticleUser alloc] initWithMParticleUser:currentUser kitConfiguration:self.kitConfigurations[kitRegister.code]];
2308-
execStatus = [kitRegister.wrapperInstance executeWithViewName:parameters[0]
2309-
attributes:parameters[1]
2310-
placements:parameters[2]
2311-
config:parameters[3]
2312-
callbacks:parameters[4]
2313-
filteredUser:filteredUser];
2308+
execStatus = [kitRegister.wrapperInstance executeWithIdentifier:parameters[0]
2309+
attributes:parameters[1]
2310+
embeddedViews:parameters[2]
2311+
config:parameters[3]
2312+
callbacks:parameters[4]
2313+
filteredUser:filteredUser];
23142314
} else if (selector == @selector(logScreen:)) {
23152315
if (!kitFilter.forwardEvent || ![kitFilter.forwardEvent isKindOfClass:[MPEvent class]]) {
23162316
return;

‎mParticle-Apple-SDK/MPRokt.m‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,12 @@ @implementation MPRokt
3030

3131
- (void)selectPlacements:(NSString *)identifier
3232
attributes:(NSDictionary<NSString *, NSString *> * _Nullable)attributes {
33-
[self selectPlacements:identifier attributes:attributes placements:nil config:nil callbacks:nil];
33+
[self selectPlacements:identifier attributes:attributes embeddedViews:nil config:nil callbacks:nil];
3434
}
3535

3636
- (void)selectPlacements:(NSString *)identifier
3737
attributes:(NSDictionary<NSString *, NSString *> * _Nullable)attributes
38-
placements:(NSDictionary<NSString *, MPRoktEmbeddedView *> * _Nullable)placements
38+
embeddedViews:(NSDictionary<NSString *, MPRoktEmbeddedView *> * _Nullable)embeddedViews
3939
config:(MPRoktConfig * _Nullable)config
4040
callbacks:(MPRoktEventCallback * _Nullable)callbacks {
4141
MParticleUser *currentUser = [MParticle sharedInstance].identity.currentUser;
@@ -68,11 +68,11 @@ - (void)selectPlacements:(NSString *)identifier
6868
MPForwardQueueParameters *queueParameters = [[MPForwardQueueParameters alloc] init];
6969
[queueParameters addParameter:identifier];
7070
[queueParameters addParameter:[self confirmSandboxAttribute:mappedAttributes]];
71-
[queueParameters addParameter:placements];
71+
[queueParameters addParameter:embeddedViews];
7272
[queueParameters addParameter:config];
7373
[queueParameters addParameter:callbacks];
7474

75-
SEL roktSelector = @selector(executeWithViewName:attributes:placements:config:callbacks:filteredUser:);
75+
SEL roktSelector = @selector(executeWithIdentifier:attributes:embeddedViews:config:callbacks:filteredUser:);
7676
[[MParticle sharedInstance].kitContainer_PRIVATE forwardSDKCall:roktSelector
7777
event:nil
7878
parameters:queueParameters

0 commit comments

Comments
 (0)