Skip to content

Commit e85c8ea

Browse files
echo-branchecho-branch
committed
CORE-1198 rename variables and methods
1 parent fde14fd commit e85c8ea

File tree

8 files changed

+71
-71
lines changed

8 files changed

+71
-71
lines changed

‎Branch-SDK/BNCPreferenceHelper.h‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,16 +46,16 @@ NSURL* /* _Nonnull */ BNCURLForBranchDirectory(void);
4646
@property (strong, nonatomic) NSString *browserUserAgentString;
4747
@property (strong, atomic) NSString *referringURL;
4848
@property (strong, atomic) NSString *branchAPIURL;
49-
@property (nonatomic, strong, readwrite) NSString *branchBlacklistURL;
5049
@property (assign, atomic) BOOL limitFacebookTracking;
5150
@property (strong, atomic) NSDate *previousAppBuildDate;
5251
@property (assign, nonatomic, readwrite) BOOL disableAdNetworkCallouts;
5352

5453
@property (strong, nonatomic, readwrite) NSURL *faceBookAppLink;
5554

56-
@property (strong, atomic) NSArray<NSString*> *URLBlackList;
57-
@property (assign, atomic) NSInteger URLBlackListVersion;
58-
@property (assign, atomic) BOOL blacklistURLOpen;
55+
@property (nonatomic, strong, readwrite) NSString *patternListURL;
56+
@property (strong, atomic) NSArray<NSString*> *savedURLPatternList;
57+
@property (assign, atomic) NSInteger savedURLPatternListVersion;
58+
@property (assign, atomic) BOOL dropURLOpen;
5959

6060
@property (assign, nonatomic) BOOL sendCloseRequests;
6161

‎Branch-SDK/BNCPreferenceHelper.m‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ - (instancetype)init {
107107
_persistPrefsQueue = [[NSOperationQueue alloc] init];
108108
_persistPrefsQueue.maxConcurrentOperationCount = 1;
109109

110-
self.branchBlacklistURL = @"https://cdn.branch.io";
110+
self.patternListURL = @"https://cdn.branch.io";
111111
self.disableAdNetworkCallouts = NO;
112112
}
113113
return self;
@@ -551,41 +551,41 @@ - (void) setPreviousAppBuildDate:(NSDate*)date {
551551
}
552552
}
553553

554-
- (NSArray<NSString*>*) URLBlackList {
554+
- (NSArray<NSString*>*) savedURLPatternList {
555555
@synchronized(self) {
556-
id a = [self readObjectFromDefaults:@"URLBlackList"];
556+
id a = [self readObjectFromDefaults:@"URLPatternList"];
557557
if ([a isKindOfClass:NSArray.class]) return a;
558558
return nil;
559559
}
560560
}
561561

562-
- (void) setURLBlackList:(NSArray<NSString *> *)URLBlackList {
562+
- (void) setSavedURLPatternList:(NSArray<NSString *> *)URLPatternList {
563563
@synchronized(self) {
564-
[self writeObjectToDefaults:@"URLBlackList" value:URLBlackList];
564+
[self writeObjectToDefaults:@"URLPatternList" value:URLPatternList];
565565
}
566566
}
567567

568-
- (NSInteger) URLBlackListVersion {
568+
- (NSInteger) savedURLPatternListVersion {
569569
@synchronized(self) {
570-
return [self readIntegerFromDefaults:@"URLBlackListVersion"];
570+
return [self readIntegerFromDefaults:@"URLPatternListVersion"];
571571
}
572572
}
573573

574-
- (void) setURLBlackListVersion:(NSInteger)URLBlackListVersion {
574+
- (void) setSavedURLPatternListVersion:(NSInteger)URLPatternListVersion {
575575
@synchronized(self) {
576-
[self writeIntegerToDefaults:@"URLBlackListVersion" value:URLBlackListVersion];
576+
[self writeIntegerToDefaults:@"URLPatternListVersion" value:URLPatternListVersion];
577577
}
578578
}
579579

580-
- (BOOL) blacklistURLOpen {
580+
- (BOOL) dropURLOpen {
581581
@synchronized(self) {
582-
return [self readBoolFromDefaults:@"blacklistURLOpen"];
582+
return [self readBoolFromDefaults:@"dropURLOpen"];
583583
}
584584
}
585585

586-
- (void) setBlacklistURLOpen:(BOOL)value {
586+
- (void) setDropURLOpen:(BOOL)value {
587587
@synchronized(self) {
588-
[self writeBoolToDefaults:@"blacklistURLOpen" value:value];
588+
[self writeBoolToDefaults:@"dropURLOpen" value:value];
589589
}
590590
}
591591

‎Branch-SDK/BNCURLFilter.m‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,14 @@
1212
#import "Branch.h"
1313

1414
@interface BNCURLFilter () {
15-
NSArray<NSString*>*_blackList;
15+
NSArray<NSString*>*_patternList;
1616
}
1717
@property (strong) NSArray<NSRegularExpression*> *ignoredURLRegex;
18-
@property (assign) NSInteger blackListVersion;
18+
@property (assign) NSInteger listVersion;
1919
@property (strong) id<BNCNetworkServiceProtocol> networkService;
2020
@property (assign) BOOL hasUpdatedPatternList;
2121
@property (strong) NSError *error;
22-
@property (strong) NSURL *blackListJSONURL;
22+
@property (strong) NSURL *jsonURL;
2323
@end
2424

2525
@implementation BNCURLFilter
@@ -37,12 +37,12 @@ - (instancetype) init {
3737
@"^(?i)(?!(http|https):).*(:|:.*\\b)(password|o?auth|o?auth.?token|access|access.?token)\\b",
3838
@"^(?i)((http|https):\\/\\/).*[\\/|?|#].*\\b(password|o?auth|o?auth.?token|access|access.?token)\\b",
3939
];
40-
self.blackListVersion = -1; // First time always refresh the list version, version 0.
40+
self.listVersion = -1; // First time always refresh the list version, version 0.
4141

42-
NSArray *storedList = [BNCPreferenceHelper preferenceHelper].URLBlackList;
42+
NSArray *storedList = [BNCPreferenceHelper preferenceHelper].savedURLPatternList;
4343
if (storedList.count > 0) {
4444
self.patternList = storedList;
45-
self.blackListVersion = [BNCPreferenceHelper preferenceHelper].URLBlackListVersion;
45+
self.listVersion = [BNCPreferenceHelper preferenceHelper].savedURLPatternListVersion;
4646
}
4747

4848
NSError *error = nil;
@@ -57,24 +57,24 @@ - (void) dealloc {
5757
self.networkService = nil;
5858
}
5959

60-
- (void) setPatternList:(NSArray<NSString *> *)blackList {
60+
- (void) setPatternList:(NSArray<NSString *> *)patternList {
6161
@synchronized (self) {
62-
_blackList = blackList;
63-
_ignoredURLRegex = [self.class compileRegexArray:_blackList error:nil];
62+
_patternList = patternList;
63+
_ignoredURLRegex = [self.class compileRegexArray:_patternList error:nil];
6464
}
6565
}
6666

6767
- (NSArray<NSString*>*) patternList {
6868
@synchronized (self) {
69-
return _blackList;
69+
return _patternList;
7070
}
7171
}
7272

73-
+ (NSArray<NSRegularExpression*>*) compileRegexArray:(NSArray<NSString*>*)blacklist
73+
+ (NSArray<NSRegularExpression*>*) compileRegexArray:(NSArray<NSString*>*)patternList
7474
error:(NSError*_Nullable __autoreleasing *_Nullable)error_ {
7575
if (error_) *error_ = nil;
7676
NSMutableArray *array = [NSMutableArray new];
77-
for (NSString *pattern in blacklist) {
77+
for (NSString *pattern in patternList) {
7878
NSError *error = nil;
7979
NSRegularExpression *regex =
8080
[NSRegularExpression regularExpressionWithPattern:pattern
@@ -107,7 +107,7 @@ - (BOOL) shouldIgnoreURL:(NSURL *)url {
107107
return ([self patternMatchingURL:url]) ? YES : NO;
108108
}
109109

110-
- (void) refreshBlackListFromServer {
110+
- (void) updatePatternList {
111111
[self updatePatternListWithCompletion:nil];
112112
}
113113

@@ -121,9 +121,9 @@ - (void) updatePatternListWithCompletion:(void (^) (NSError*error, NSArray*list)
121121
}
122122

123123
self.error = nil;
124-
NSString *urlString = [self.blackListJSONURL absoluteString];
124+
NSString *urlString = [self.jsonURL absoluteString];
125125
if (!urlString) {
126-
urlString = [NSString stringWithFormat:@"%@/sdk/uriskiplist_v%ld.json", [BNCPreferenceHelper preferenceHelper].branchBlacklistURL, (long) self.blackListVersion+1];
126+
urlString = [NSString stringWithFormat:@"%@/sdk/uriskiplist_v%ld.json", [BNCPreferenceHelper preferenceHelper].patternListURL, (long) self.listVersion+1];
127127
}
128128
NSMutableURLRequest *request =
129129
[NSMutableURLRequest requestWithURL:[NSURL URLWithString:urlString]
@@ -149,9 +149,9 @@ - (void) processServerOperation:(id<BNCNetworkOperationProtocol>)operation {
149149
if (operation.responseData)
150150
responseString = [[NSString alloc] initWithData:operation.responseData encoding:NSUTF8StringEncoding];
151151
if (operation.response.statusCode == 404) {
152-
BNCLogDebugSDK(@"No new BlackList refresh found.");
152+
BNCLogDebugSDK(@"No new URL ignore list found.");
153153
} else {
154-
BNCLogDebugSDK([NSString stringWithFormat:@"BlackList refresh result. Error: %@ status: %ld body:\n%@.",
154+
BNCLogDebugSDK([NSString stringWithFormat:@"URL ignore list update result. Error: %@ status: %ld body:\n%@.",
155155
operation.error, (long)operation.response.statusCode, responseString]);
156156
}
157157
if (operation.error || operation.responseData == nil || operation.response.statusCode != 200) {
@@ -166,16 +166,16 @@ - (void) processServerOperation:(id<BNCNetworkOperationProtocol>)operation {
166166
return;
167167
}
168168

169-
NSArray *blackListURLs = dictionary[@"uri_skip_list"];
170-
if (![blackListURLs isKindOfClass:NSArray.class]) return;
169+
NSArray *urls = dictionary[@"uri_skip_list"];
170+
if (![urls isKindOfClass:NSArray.class]) return;
171171

172-
NSNumber *blackListVersion = dictionary[@"version"];
173-
if (![blackListVersion isKindOfClass:NSNumber.class]) return;
172+
NSNumber *version = dictionary[@"version"];
173+
if (![version isKindOfClass:NSNumber.class]) return;
174174

175-
self.patternList = blackListURLs;
176-
self.blackListVersion = [blackListVersion longValue];
177-
[BNCPreferenceHelper preferenceHelper].URLBlackList = self.patternList;
178-
[BNCPreferenceHelper preferenceHelper].URLBlackListVersion = self.blackListVersion;
175+
self.patternList = urls;
176+
self.listVersion = [version longValue];
177+
[BNCPreferenceHelper preferenceHelper].savedURLPatternList = self.patternList;
178+
[BNCPreferenceHelper preferenceHelper].savedURLPatternListVersion = self.listVersion;
179179
}
180180

181181
@end

‎Branch-SDK/Branch.h‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -645,7 +645,7 @@ typedef NS_ENUM(NSUInteger, BranchCreditHistoryOrder) {
645645
646646
These are ICU standard regular expressions.
647647
*/
648-
@property (copy, nullable) NSArray<NSString*>/*_Nullable*/* blackListURLRegex;
648+
@property (copy, nullable) NSArray<NSString*>/*_Nullable*/* urlsToIgnore;
649649

650650
/**
651651
Register your Facebook SDK's FBSDKAppLinkUtility class to be used by Branch for deferred deep linking from their platform

‎Branch-SDK/Branch.m‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ typedef NS_ENUM(NSInteger, BNCInitStatus) {
123123

124124
@interface Branch() <BranchDeepLinkingControllerCompletionDelegate> {
125125
NSInteger _networkCount;
126-
BNCURLFilter *_userURLBlackList;
126+
BNCURLFilter *_userURLFilter;
127127
}
128128

129129
// This isolation queue protects branch initialization and ensures things are processed in order.
@@ -141,7 +141,7 @@ @interface Branch() <BranchDeepLinkingControllerCompletionDelegate> {
141141
@property (weak, nonatomic) UIViewController *deepLinkPresentingController;
142142
@property (strong, nonatomic) NSDictionary *deepLinkDebugParams;
143143
@property (strong, nonatomic) NSMutableArray *whiteListedSchemeList;
144-
@property (strong, nonatomic) BNCURLFilter *URLBlackList;
144+
@property (strong, nonatomic) BNCURLFilter *urlFilter;
145145

146146
#if !TARGET_OS_TV
147147
@property (strong, nonatomic) BNCContentDiscoveryManager *contentDiscoveryManager;
@@ -200,7 +200,7 @@ - (id)initWithInterface:(BNCServerInterface *)interface
200200
#endif
201201

202202
self.class.branchKey = key;
203-
self.URLBlackList = [BNCURLFilter new];
203+
self.urlFilter = [BNCURLFilter new];
204204

205205
[BranchOpenRequest setWaitNeededForOpenResponseLock];
206206

@@ -673,16 +673,16 @@ - (void)addWhiteListedScheme:(NSString *)scheme {
673673
[self.whiteListedSchemeList addObject:scheme];
674674
}
675675

676-
- (void)setBlackListURLRegex:(NSArray<NSString*>*)blackListURLs {
676+
- (void)setUrlsToIgnore:(NSArray<NSString*>*)urlsToIgnore {
677677
@synchronized (self) {
678-
_userURLBlackList = [[BNCURLFilter alloc] init];
679-
_userURLBlackList.patternList = blackListURLs;
678+
_userURLFilter = [[BNCURLFilter alloc] init];
679+
_userURLFilter.patternList = urlsToIgnore;
680680
}
681681
}
682682

683-
- (NSArray<NSString *> *)blackListURLRegex {
683+
- (NSArray<NSString *> *)urlsToIgnore {
684684
@synchronized (self) {
685-
return _userURLBlackList.patternList;
685+
return _userURLFilter.patternList;
686686
}
687687
}
688688

@@ -701,15 +701,15 @@ - (BOOL)handleDeepLink:(NSURL *)url sceneIdentifier:(NSString *)sceneIdentifier
701701
// this allows foreground links to callback
702702
self.initializationStatus = BNCInitStatusUninitialized;
703703

704-
NSString *blackListPattern = nil;
705-
blackListPattern = [self.URLBlackList patternMatchingURL:url];
706-
if (!blackListPattern) {
707-
blackListPattern = [_userURLBlackList patternMatchingURL:url];
704+
NSString *pattern = nil;
705+
pattern = [self.urlFilter patternMatchingURL:url];
706+
if (!pattern) {
707+
pattern = [_userURLFilter patternMatchingURL:url];
708708
}
709-
if (blackListPattern) {
710-
self.preferenceHelper.blacklistURLOpen = YES;
711-
self.preferenceHelper.externalIntentURI = blackListPattern;
712-
self.preferenceHelper.referringURL = blackListPattern;
709+
if (pattern) {
710+
self.preferenceHelper.dropURLOpen = YES;
711+
self.preferenceHelper.externalIntentURI = pattern;
712+
self.preferenceHelper.referringURL = pattern;
713713

714714
[self initUserSessionAndCallCallback:YES sceneIdentifier:sceneIdentifier];
715715
return NO;
@@ -2212,8 +2212,8 @@ - (void)handleInitSuccessAndCallCallback:(BOOL)callCallback sceneIdentifier:(NSS
22122212
}
22132213
[self sendOpenNotificationWithLinkParameters:latestReferringParams error:nil];
22142214

2215-
if (!self.URLBlackList.hasUpdatedPatternList) {
2216-
[self.URLBlackList updatePatternListWithCompletion:nil];
2215+
if (!self.urlFilter.hasUpdatedPatternList) {
2216+
[self.urlFilter updatePatternListWithCompletion:nil];
22172217
}
22182218

22192219
if (self.shouldAutomaticallyDeepLink) {

‎Branch-SDK/BranchOpenRequest.m‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ + (NSNumber *)appUpdateState {
128128

129129
- (void)processResponse:(BNCServerResponse *)response error:(NSError *)error {
130130
BNCPreferenceHelper *preferenceHelper = [BNCPreferenceHelper preferenceHelper];
131-
if (error && preferenceHelper.blacklistURLOpen) {
131+
if (error && preferenceHelper.dropURLOpen) {
132132
// Ignore this response from the server. Dummy up a response:
133133
error = nil;
134134
response.data = @{
@@ -248,7 +248,7 @@ - (void)processResponse:(BNCServerResponse *)response error:(NSError *)error {
248248
preferenceHelper.externalIntentURI = nil;
249249
preferenceHelper.appleSearchAdNeedsSend = NO;
250250
preferenceHelper.referringURL = referringURL;
251-
preferenceHelper.blacklistURLOpen = NO;
251+
preferenceHelper.dropURLOpen = NO;
252252

253253
NSString *string = BNCStringFromWireFormat(data[BRANCH_RESPONSE_KEY_BRANCH_IDENTITY]);
254254
if (string) preferenceHelper.identityID = string;

‎Branch-TestBed/Branch-SDK-Tests/BNCPreferenceHelperTests.m‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,11 +43,11 @@ - (void)testPreferenceSets {
4343
}
4444

4545
- (void)testBlacklistURL {
46-
XCTAssertTrue([@"https://cdn.branch.io" isEqualToString:self.prefHelper.branchBlacklistURL]);
46+
XCTAssertTrue([@"https://cdn.branch.io" isEqualToString:self.prefHelper.patternListURL]);
4747

4848
NSString *customBlacklistURL = @"https://blacklist.branch.io";
49-
self.prefHelper.branchBlacklistURL = customBlacklistURL;
50-
XCTAssertTrue([customBlacklistURL isEqualToString:self.prefHelper.branchBlacklistURL]);
49+
self.prefHelper.patternListURL = customBlacklistURL;
50+
XCTAssertTrue([customBlacklistURL isEqualToString:self.prefHelper.patternListURL]);
5151
}
5252

5353
// only verifies that the flag is stored correctly

‎Branch-TestBed/Branch-SDK-Tests/BNCURLBlackList.Test.m‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,13 @@ @interface BNCURLBlackListTest : BNCTestCase
2222
@implementation BNCURLBlackListTest
2323

2424
- (void) setUp {
25-
[BNCPreferenceHelper preferenceHelper].URLBlackList = nil;
26-
[BNCPreferenceHelper preferenceHelper].URLBlackListVersion = 0;
27-
[BNCPreferenceHelper preferenceHelper].blacklistURLOpen = NO;
25+
[BNCPreferenceHelper preferenceHelper].URLPatternList = nil;
26+
[BNCPreferenceHelper preferenceHelper].URLListVersion = 0;
27+
[BNCPreferenceHelper preferenceHelper].dropURLOpen = NO;
2828
}
2929

3030
- (void) tearDown {
31-
[BNCPreferenceHelper preferenceHelper].blacklistURLOpen = NO;
31+
[BNCPreferenceHelper preferenceHelper].dropURLOpen = NO;
3232
}
3333

3434
- (void)testListDownLoad {
@@ -172,7 +172,7 @@ - (void) testUserBlackList {
172172
BNCLogSetDisplayLevel(BNCLogLevelAll);
173173
Branch *branch = (Branch.branchKey.length) ? Branch.getInstance : [Branch getInstance:@"key_live_foo"];
174174
[branch clearNetworkQueue];
175-
branch.blackListURLRegex = @[
175+
branch.urlsToIgnore = @[
176176
@"\\/bob\\/"
177177
];
178178
id serverInterfaceMock = OCMPartialMock(branch.serverInterface);

0 commit comments

Comments
 (0)