Skip to content

Commit 9d770ca

Browse files
Hide type-specific initializers as per review
1 parent 029bc93 commit 9d770ca

7 files changed

+11
-65
lines changed

src/darwin/Framework/CHIP/MTRManualSetupPayloadParser.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121

2222
NS_ASSUME_NONNULL_BEGIN
2323

24-
MTR_DEPRECATED("Please use -[MTRSetupPayload initWithManualPairingCode:]", ios(16.1, 16.4), macos(13.0, 13.3),
24+
MTR_DEPRECATED("Please use -[MTRSetupPayload initWithPayload:]", ios(16.1, 16.4), macos(13.0, 13.3),
2525
watchos(9.1, 9.4), tvos(16.1, 16.4))
2626
@interface MTRManualSetupPayloadParser : NSObject
2727
- (instancetype)initWithDecimalStringRepresentation:(NSString *)decimalStringRepresentation;

src/darwin/Framework/CHIP/MTRManualSetupPayloadParser.mm

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
#import "MTRManualSetupPayloadParser.h"
1919

2020
#import "MTRError_Internal.h"
21-
#import "MTRSetupPayload.h"
21+
#import "MTRSetupPayload_Internal.h"
2222

2323
@implementation MTRManualSetupPayloadParser {
2424
NSString * _decimalStringRepresentation;

src/darwin/Framework/CHIP/MTRQRCodeSetupPayloadParser.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121

2222
NS_ASSUME_NONNULL_BEGIN
2323

24-
MTR_DEPRECATED("Please use [MTRSetupPayload -initWithQRCode:]", ios(16.1, 16.4), macos(13.0, 13.3),
24+
MTR_DEPRECATED("Please use [MTRSetupPayload -initWithPayload:]", ios(16.1, 16.4), macos(13.0, 13.3),
2525
watchos(9.1, 9.4), tvos(16.1, 16.4))
2626
@interface MTRQRCodeSetupPayloadParser : NSObject
2727
- (instancetype)initWithBase38Representation:(NSString *)base38Representation;

src/darwin/Framework/CHIP/MTRQRCodeSetupPayloadParser.mm

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
#import "MTRQRCodeSetupPayloadParser.h"
1919

2020
#import "MTRError_Internal.h"
21-
#import "MTRSetupPayload.h"
21+
#import "MTRSetupPayload_Internal.h"
2222

2323
@implementation MTRQRCodeSetupPayloadParser {
2424
NSString * _base38Representation;

src/darwin/Framework/CHIP/MTRSetupPayload.h

-12
Original file line numberDiff line numberDiff line change
@@ -120,18 +120,6 @@ MTR_AVAILABLE(ios(16.1), macos(13.0), watchos(9.1), tvos(16.1))
120120
*/
121121
- (nullable instancetype)initWithPayload:(NSString *)payload MTR_NEWLY_AVAILABLE;
122122

123-
/**
124-
* Initializes the payload object from a QR Code string.
125-
* Returns nil if the QR Code string is invalid.
126-
*/
127-
- (nullable instancetype)initWithQRCode:(NSString *)qrCodePayload MTR_NEWLY_AVAILABLE;
128-
129-
/**
130-
* Initializes the payload object from a Manual Pairing Code string.
131-
* Returns nil if the pairing code is not valid.
132-
*/
133-
- (nullable instancetype)initWithManualPairingCode:(NSString *)manualCode MTR_NEWLY_AVAILABLE;
134-
135123
@property (nonatomic, copy) NSNumber * version;
136124
@property (nonatomic, copy) NSNumber * vendorID;
137125
@property (nonatomic, copy) NSNumber * productID;

src/darwin/Framework/CHIP/MTRSetupPayload_Internal.h

+6
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,15 @@
2121

2222
#import <setup_payload/SetupPayload.h>
2323

24+
NS_ASSUME_NONNULL_BEGIN
25+
2426
MTR_DIRECT_MEMBERS
2527
@interface MTRSetupPayload ()
2628

2729
- (instancetype)initWithSetupPayload:(chip::SetupPayload)setupPayload;
30+
- (nullable instancetype)initWithQRCode:(NSString *)qrCodePayload;
31+
- (nullable instancetype)initWithManualPairingCode:(NSString *)manualCode;
2832

2933
@end
34+
35+
NS_ASSUME_NONNULL_END

src/darwin/Framework/CHIPTests/MTRSetupPayloadTests.m

+1-49
Original file line numberDiff line numberDiff line change
@@ -44,30 +44,6 @@ - (void)testOnboardingPayloadParser_Manual_NoError
4444
XCTAssertEqualObjects(payload.manualEntryCode, @"641286075300001000016");
4545
}
4646

47-
- (void)testInitWithManualCode
48-
{
49-
MTRSetupPayload * payload = [[MTRSetupPayload alloc] initWithManualPairingCode:@"641286075300001000016"];
50-
XCTAssertNotNil(payload);
51-
XCTAssertTrue(payload.hasShortDiscriminator);
52-
XCTAssertEqual(payload.discriminator.unsignedIntegerValue, 10);
53-
XCTAssertEqual(payload.setupPasscode.unsignedIntegerValue, 12345670);
54-
XCTAssertEqual(payload.vendorID.unsignedIntegerValue, 1);
55-
XCTAssertEqual(payload.productID.unsignedIntegerValue, 1);
56-
XCTAssertEqual(payload.commissioningFlow, MTRCommissioningFlowCustom);
57-
XCTAssertEqual(payload.version.unsignedIntegerValue, 0);
58-
XCTAssertEqual(payload.discoveryCapabilities, MTRDiscoveryCapabilitiesUnknown);
59-
}
60-
61-
- (void)testInitWithManualCode_Empty
62-
{
63-
XCTAssertNil([[MTRSetupPayload alloc] initWithManualPairingCode:@""]);
64-
}
65-
66-
- (void)testInitWithManualCode_QRCode
67-
{
68-
XCTAssertNil([[MTRSetupPayload alloc] initWithManualPairingCode:@"MT:M5L90MP500K64J00000"]); // a valid QR code
69-
}
70-
7147
- (void)testOnboardingPayloadParser_QRCode_NoError
7248
{
7349
NSError * error;
@@ -86,30 +62,6 @@ - (void)testOnboardingPayloadParser_QRCode_NoError
8662
XCTAssertEqual(payload.discoveryCapabilities, MTRDiscoveryCapabilitiesSoftAP);
8763
}
8864

89-
- (void)testInitWithQRCode
90-
{
91-
MTRSetupPayload * payload = [[MTRSetupPayload alloc] initWithQRCode:@"MT:M5L90MP500K64J00000"];
92-
XCTAssertNotNil(payload);
93-
XCTAssertFalse(payload.hasShortDiscriminator);
94-
XCTAssertEqual(payload.discriminator.unsignedIntegerValue, 128);
95-
XCTAssertEqual(payload.setupPasscode.unsignedIntegerValue, 2048);
96-
XCTAssertEqual(payload.vendorID.unsignedIntegerValue, 12);
97-
XCTAssertEqual(payload.productID.unsignedIntegerValue, 1);
98-
XCTAssertEqual(payload.commissioningFlow, MTRCommissioningFlowStandard);
99-
XCTAssertEqual(payload.version.unsignedIntegerValue, 0);
100-
XCTAssertEqual(payload.discoveryCapabilities, MTRDiscoveryCapabilitiesSoftAP);
101-
}
102-
103-
- (void)testInitWithQRCode_WrongPrefix
104-
{
105-
XCTAssertNil([[MTRSetupPayload alloc] initWithQRCode:@"XX:M5L90MP500K64J00000"]);
106-
}
107-
108-
- (void)testInitWithQRCode_ManualCode
109-
{
110-
XCTAssertNil([[MTRSetupPayload alloc] initWithQRCode:@"641286075300001000016"]); // a valid manual pairing code
111-
}
112-
11365
- (void)testOnboardingPayloadParser_QRCode_WrongVersion
11466
{
11567
// Same as testOnboardingPayloadParser_QRCode_NoError, but with version set to 5.
@@ -441,7 +393,7 @@ - (void)testSecureCodingRoundtrip
441393

442394
- (void)testCopyingAndEquality
443395
{
444-
MTRSetupPayload * payload = [[MTRSetupPayload alloc] initWithQRCode:@"MT:M5L9000000K64J00000"];
396+
MTRSetupPayload * payload = [[MTRSetupPayload alloc] initWithPayload:@"MT:M5L9000000K64J00000"];
445397
XCTAssertFalse(payload.hasShortDiscriminator); // came from a QR code
446398
XCTAssert(payload.discriminator.integerValue > 0xf); // can't "accidentally" round-trip through a short discriminator
447399

0 commit comments

Comments
 (0)