diff --git a/.jazzy.yaml b/.jazzy.yaml index 216fd82ae..116ee52c7 100644 --- a/.jazzy.yaml +++ b/.jazzy.yaml @@ -22,6 +22,7 @@ custom_categories: - MGLMapView - MGLMapViewDelegate - MGLStyle + - MGLStyleCurrentVersion - MGLUserTrackingMode - name: Annotations children: diff --git a/include/mbgl/util/default_styles.hpp b/include/mbgl/util/default_styles.hpp index 3f5b6bd31..2043dd3f5 100644 --- a/include/mbgl/util/default_styles.hpp +++ b/include/mbgl/util/default_styles.hpp @@ -14,17 +14,19 @@ struct DefaultStyle { }; extern const DefaultStyle streets; -extern const DefaultStyle emerald; +extern const DefaultStyle outdoors; extern const DefaultStyle light; extern const DefaultStyle dark; extern const DefaultStyle satellite; extern const DefaultStyle hybrid; const DefaultStyle orderedStyles[] = { - streets, emerald, light, dark, satellite, hybrid, + streets, outdoors, light, dark, satellite, hybrid, }; const size_t numOrderedStyles = sizeof(orderedStyles) / sizeof(DefaultStyle); +static const unsigned currentVersion = 9; + } // end namespace default_styles } // end namespace util } // end namespace mbgl diff --git a/platform/darwin/include/MGLStyle.h b/platform/darwin/include/MGLStyle.h index e5b2de877..2a2d61657 100644 --- a/platform/darwin/include/MGLStyle.h +++ b/platform/darwin/include/MGLStyle.h @@ -4,50 +4,115 @@ NS_ASSUME_NONNULL_BEGIN -/** A collection of convenience methods for creating style URLs of default styles provided by Mapbox. These instances of NSURL are cached. */ +/** + A version number identifying the latest released version of the suite of default styles provided by Mapbox. This version number may be passed into one of the “StyleURLWithVersion” class methods of MGLStyle. + + The value of this constant is current as of the date on which this SDK was published. Consult the Mapbox Styles API documentation for the most up-to-date style versioning information. + + @warning The value of this constant may change in a future release of the SDK. If you use any feature that depends on a specific implementation detail in a default style, you may use the current value of this constant or the underlying style URL, but do not use the constant itself. Such implementation details may change significantly from version to version. + */ +static const NSInteger MGLStyleCurrentVersion = 9; + +/** + A collection of convenience methods for creating style URLs of default styles provided by Mapbox. + */ @interface MGLStyle : NSObject /** - Returns the Streets style URL. + Returns the URL to the current version of the Streets style. - Mapbox Streets is a complete base map, perfect for incorporating your own data. + Mapbox Streets is a complete base map that balances nature, commerce, and infrastructure. */ -+ (NSURL *)streetsStyleURL; ++ (NSURL *)streetsStyleURL __attribute__((deprecated("Use -streetsStyleURLWithVersion:."))); /** - Returns the Emerald style URL. + Returns the URL to the given version of the Streets style. - Emerald is a versatile style with emphasis on road networks and public transportation. + Mapbox Streets is a complete base map that balances nature, commerce, and infrastructure. + + @param version The style’s latest released version. The current version is given by `MGLStyleCurrentVersion`. */ -+ (NSURL *)emeraldStyleURL; ++ (NSURL *)streetsStyleURLWithVersion:(NSInteger)version; /** - Returns the Light style URL. + Returns the URL to the current version of the Emerald style. - Light is a subtle, light-colored backdrop for data visualizations. + Mapbox Emerald is a versatile style with emphasis on road networks and public transportation. */ -+ (NSURL *)lightStyleURL; ++ (NSURL *)emeraldStyleURL __attribute__((deprecated("Use ."))); /** - Returns the Dark style URL. + Returns the URL to the given version of the Outdoors style. - Dark is a subtle, dark-colored backdrop for data visualizations. + Mapbox Outdoors is a rugged style that emphasizes physical terrain and outdoor activities. + + @param version The style’s latest released version. The current version is given by `MGLStyleCurrentVersion`. */ -+ (NSURL *)darkStyleURL; ++ (NSURL *)outdoorsStyleURLWithVersion:(NSInteger)version; /** - Returns the Satellite style URL. + Returns the URL to the current version of the Light style. + + Mapbox Light is a subtle, light-colored backdrop for data visualizations. + */ ++ (NSURL *)lightStyleURL __attribute__((deprecated("Use -lightStyleURLWithVersion:."))); + +/** + Returns the URL to the given version of the Light style. + + Mapbox Light is a subtle, light-colored backdrop for data visualizations. + + @param version The style’s latest released version. The current version is given by `MGLStyleCurrentVersion`. + */ ++ (NSURL *)lightStyleURLWithVersion:(NSInteger)version; + +/** + Returns the URL to the current version of the Dark style. + + Mapbox Dark is a subtle, dark-colored backdrop for data visualizations. + */ ++ (NSURL *)darkStyleURL __attribute__((deprecated("Use -darkStyleURLWithVersion:."))); + +/** + Returns the URL to the given version of the Dark style. + + Mapbox Dark is a subtle, dark-colored backdrop for data visualizations. + + @param version The style’s latest released version. The current version is given by `MGLStyleCurrentVersion`. + */ ++ (NSURL *)darkStyleURLWithVersion:(NSInteger)version; + +/** + Returns the URL to the current version of the Satellite style. Mapbox Satellite is a beautiful global satellite and aerial imagery layer. */ -+ (NSURL *)satelliteStyleURL; ++ (NSURL *)satelliteStyleURL __attribute__((deprecated("Use -satelliteStyleURLWithVersion:."))); /** - Returns the Hybrid style URL. + Returns the URL to the given version of the Satellite style. - Hybrid combines the global satellite and aerial imagery of Mapbox Satellite with unobtrusive labels. + Mapbox Satellite is a beautiful global satellite and aerial imagery layer. + + @param version The style’s latest released version. The current version is given by `MGLStyleCurrentVersion`. */ -+ (NSURL *)hybridStyleURL; ++ (NSURL *)satelliteStyleURLWithVersion:(NSInteger)version; + +/** + Returns the URL to the current version of the Hybrid style. + + Mapbox Hybrid combines the global satellite and aerial imagery of Mapbox Satellite with unobtrusive labels. + */ ++ (NSURL *)hybridStyleURL __attribute__((deprecated("Use -hybridStyleURLWithVersion:."))); + +/** + Returns the URL to the given version of the Hybrid style. + + Mapbox Hybrid combines the global satellite and aerial imagery of Mapbox Satellite with unobtrusive labels. + + @param version The style’s latest released version. The current version is given by `MGLStyleCurrentVersion`. + */ ++ (NSURL *)hybridStyleURLWithVersion:(NSInteger)version; - (instancetype)init NS_UNAVAILABLE; diff --git a/platform/darwin/src/MGLStyle.mm b/platform/darwin/src/MGLStyle.mm index 15a25db9e..c906337a5 100644 --- a/platform/darwin/src/MGLStyle.mm +++ b/platform/darwin/src/MGLStyle.mm @@ -4,27 +4,44 @@ @implementation MGLStyle -// name is lowercase -#define MGL_DEFINE_STYLE(name) \ +static_assert(mbgl::util::default_styles::currentVersion == MGLStyleCurrentVersion, "mbgl::util::default_styles::currentVersion and MGLStyleCurrentVersion disagree."); + +/// @param name The style’s marketing name, written in lower camelCase. +/// @param fileName The last path component in the style’s URL, excluding the version suffix. +#define MGL_DEFINE_STYLE(name, fileName) \ static NSURL *MGLStyleURL_##name; \ + (NSURL *)name##StyleURL { \ static dispatch_once_t onceToken; \ dispatch_once(&onceToken, ^{ \ - MGLStyleURL_##name = [NSURL URLWithString:@(mbgl::util::default_styles::name.url)]; \ + MGLStyleURL_##name = [self name##StyleURLWithVersion:MGLStyleCurrentVersion]; \ }); \ return MGLStyleURL_##name; \ + } \ + \ + + (NSURL *)name##StyleURL##WithVersion:(NSInteger)version { \ + return [NSURL URLWithString:[@"mapbox://styles/mapbox/" #fileName "-v" stringByAppendingFormat:@"%li", (long)version]]; \ } -MGL_DEFINE_STYLE(streets) -MGL_DEFINE_STYLE(emerald) -MGL_DEFINE_STYLE(light) -MGL_DEFINE_STYLE(dark) -MGL_DEFINE_STYLE(satellite) -MGL_DEFINE_STYLE(hybrid) +MGL_DEFINE_STYLE(streets, streets) +MGL_DEFINE_STYLE(outdoors, outdoors) +MGL_DEFINE_STYLE(light, light) +MGL_DEFINE_STYLE(dark, dark) +MGL_DEFINE_STYLE(satellite, satellite) +MGL_DEFINE_STYLE(hybrid, satellite-hybrid) // Make sure all the styles listed in mbgl::util::default_styles::orderedStyles // are defined above and also declared in MGLStyle.h. static_assert(6 == mbgl::util::default_styles::numOrderedStyles, "mbgl::util::default_styles::orderedStyles and MGLStyle have different numbers of styles."); +// Emerald is no longer getting new versions as a default style, so the current version is hard-coded here. +static NSURL *MGLStyleURL_emerald; ++ (NSURL *)emeraldStyleURL { + static dispatch_once_t onceToken; + dispatch_once(&onceToken, ^{ + MGLStyleURL_emerald = [NSURL URLWithString:@"mapbox://styles/mapbox/emerald-v8"]; + }); + return MGLStyleURL_emerald; +} + @end diff --git a/platform/darwin/src/MGLTilePyramidOfflineRegion.mm b/platform/darwin/src/MGLTilePyramidOfflineRegion.mm index d1151de09..9b33d267d 100644 --- a/platform/darwin/src/MGLTilePyramidOfflineRegion.mm +++ b/platform/darwin/src/MGLTilePyramidOfflineRegion.mm @@ -33,7 +33,7 @@ - (instancetype)initWithStyleURL:(NSURL *)styleURL bounds:(MGLCoordinateBounds)bounds fromZoomLevel:(double)minimumZoomLevel toZoomLevel:(double)maximumZoomLevel { if (self = [super init]) { if (!styleURL) { - styleURL = [MGLStyle streetsStyleURL]; + styleURL = [MGLStyle streetsStyleURLWithVersion:MGLStyleCurrentVersion]; } if (!styleURL.scheme) { diff --git a/platform/ios/CHANGELOG.md b/platform/ios/CHANGELOG.md index b560535be..c3138058d 100644 --- a/platform/ios/CHANGELOG.md +++ b/platform/ios/CHANGELOG.md @@ -2,6 +2,12 @@ Mapbox welcomes participation and contributions from everyone. If you’d like to do so please see [CONTRIBUTING.md](https://github.com/mapbox/mapbox-gl-native/blob/master/CONTRIBUTING.md) first to get started. +## 3.2.2 + +- Existing MGLStyle class methods that return default style URLs have been deprecated in favor of new methods that require an explicit style version parameter. ([#4759](https://github.com/mapbox/mapbox-gl-native/pull/4759)) +- Deprecated `+[MGLStyle emeraldStyleURL]` with no replacement method. To use the Emerald style going forward, we recommend that you use the underlying URL. ([#4759](https://github.com/mapbox/mapbox-gl-native/pull/4759)) +- Added `+[MGLStyle outdoorsStyleURLWithVersion:]` for the new Outdoors style. ([#4759](https://github.com/mapbox/mapbox-gl-native/pull/4759)) + ## 3.2.1 - Fixed a hang that could occur if the host application attempts to set user defaults on a background queue. ([#4745](https://github.com/mapbox/mapbox-gl-native/pull/4745)) diff --git a/platform/ios/src/MGLMapView.mm b/platform/ios/src/MGLMapView.mm index 17323720a..8d6688e7e 100644 --- a/platform/ios/src/MGLMapView.mm +++ b/platform/ios/src/MGLMapView.mm @@ -276,7 +276,7 @@ mbgl::Duration MGLDurationInSeconds(NSTimeInterval duration) if ( ! styleURL) { - styleURL = [MGLStyle streetsStyleURL]; + styleURL = [MGLStyle streetsStyleURLWithVersion:MGLStyleCurrentVersion]; } if ( ! [styleURL scheme]) diff --git a/platform/osx/app/MainMenu.xib b/platform/osx/app/MainMenu.xib index 646c4ae40..3776d0d16 100644 --- a/platform/osx/app/MainMenu.xib +++ b/platform/osx/app/MainMenu.xib @@ -370,7 +370,7 @@ - + diff --git a/platform/osx/app/MapDocument.m b/platform/osx/app/MapDocument.m index 16d15c4ff..84c1fe4d6 100644 --- a/platform/osx/app/MapDocument.m +++ b/platform/osx/app/MapDocument.m @@ -121,22 +121,22 @@ static const CLLocationCoordinate2D WorldTourDestinations[] = { NSURL *styleURL; switch (tag) { case 1: - styleURL = [MGLStyle streetsStyleURL]; + styleURL = [MGLStyle streetsStyleURLWithVersion:MGLStyleCurrentVersion]; break; case 2: - styleURL = [MGLStyle emeraldStyleURL]; + styleURL = [MGLStyle outdoorsStyleURLWithVersion:MGLStyleCurrentVersion]; break; case 3: - styleURL = [MGLStyle lightStyleURL]; + styleURL = [MGLStyle lightStyleURLWithVersion:MGLStyleCurrentVersion]; break; case 4: - styleURL = [MGLStyle darkStyleURL]; + styleURL = [MGLStyle darkStyleURLWithVersion:MGLStyleCurrentVersion]; break; case 5: - styleURL = [MGLStyle satelliteStyleURL]; + styleURL = [MGLStyle satelliteStyleURLWithVersion:MGLStyleCurrentVersion]; break; case 6: - styleURL = [MGLStyle hybridStyleURL]; + styleURL = [MGLStyle hybridStyleURLWithVersion:MGLStyleCurrentVersion]; break; default: NSAssert(NO, @"Cannot set style from control with tag %li", (long)tag); @@ -440,22 +440,22 @@ static const CLLocationCoordinate2D WorldTourDestinations[] = { NSCellStateValue state; switch (menuItem.tag) { case 1: - state = [styleURL isEqual:[MGLStyle streetsStyleURL]]; + state = [styleURL isEqual:[MGLStyle streetsStyleURLWithVersion:MGLStyleCurrentVersion]]; break; case 2: - state = [styleURL isEqual:[MGLStyle emeraldStyleURL]]; + state = [styleURL isEqual:[MGLStyle outdoorsStyleURLWithVersion:MGLStyleCurrentVersion]]; break; case 3: - state = [styleURL isEqual:[MGLStyle lightStyleURL]]; + state = [styleURL isEqual:[MGLStyle lightStyleURLWithVersion:MGLStyleCurrentVersion]]; break; case 4: - state = [styleURL isEqual:[MGLStyle darkStyleURL]]; + state = [styleURL isEqual:[MGLStyle darkStyleURLWithVersion:MGLStyleCurrentVersion]]; break; case 5: - state = [styleURL isEqual:[MGLStyle satelliteStyleURL]]; + state = [styleURL isEqual:[MGLStyle satelliteStyleURLWithVersion:MGLStyleCurrentVersion]]; break; case 6: - state = [styleURL isEqual:[MGLStyle hybridStyleURL]]; + state = [styleURL isEqual:[MGLStyle hybridStyleURLWithVersion:MGLStyleCurrentVersion]]; break; default: return NO; @@ -550,12 +550,12 @@ static const CLLocationCoordinate2D WorldTourDestinations[] = { } NSArray *styleURLs = @[ - [MGLStyle streetsStyleURL], - [MGLStyle emeraldStyleURL], - [MGLStyle lightStyleURL], - [MGLStyle darkStyleURL], - [MGLStyle satelliteStyleURL], - [MGLStyle hybridStyleURL], + [MGLStyle streetsStyleURLWithVersion:MGLStyleCurrentVersion], + [MGLStyle outdoorsStyleURLWithVersion:MGLStyleCurrentVersion], + [MGLStyle lightStyleURLWithVersion:MGLStyleCurrentVersion], + [MGLStyle darkStyleURLWithVersion:MGLStyleCurrentVersion], + [MGLStyle satelliteStyleURLWithVersion:MGLStyleCurrentVersion], + [MGLStyle hybridStyleURLWithVersion:MGLStyleCurrentVersion], ]; return [styleURLs indexOfObject:self.mapView.styleURL]; } diff --git a/platform/osx/app/MapDocument.xib b/platform/osx/app/MapDocument.xib index 74743ca9e..5b7e37936 100644 --- a/platform/osx/app/MapDocument.xib +++ b/platform/osx/app/MapDocument.xib @@ -1,7 +1,7 @@ - + - + @@ -69,7 +69,7 @@ - + diff --git a/platform/osx/src/MGLMapView.mm b/platform/osx/src/MGLMapView.mm index 1ab98b9f8..899091c9f 100644 --- a/platform/osx/src/MGLMapView.mm +++ b/platform/osx/src/MGLMapView.mm @@ -491,7 +491,7 @@ public: - (nonnull NSURL *)styleURL { NSString *styleURLString = @(_mbglMap->getStyleURL().c_str()).mgl_stringOrNilIfEmpty; - return styleURLString ? [NSURL URLWithString:styleURLString] : [MGLStyle streetsStyleURL]; + return styleURLString ? [NSURL URLWithString:styleURLString] : [MGLStyle streetsStyleURLWithVersion:MGLStyleCurrentVersion]; } - (void)setStyleURL:(nullable NSURL *)styleURL { @@ -506,7 +506,7 @@ public: if (![MGLAccountManager accessToken]) { return; } - styleURL = [MGLStyle streetsStyleURL]; + styleURL = [MGLStyle streetsStyleURLWithVersion:MGLStyleCurrentVersion]; } if (![styleURL scheme]) { diff --git a/platform/osx/test/MGLOfflineRegionTests.m b/platform/osx/test/MGLOfflineRegionTests.m index 63befdf14..5301b264a 100644 --- a/platform/osx/test/MGLOfflineRegionTests.m +++ b/platform/osx/test/MGLOfflineRegionTests.m @@ -14,7 +14,7 @@ - (void)testStyleURLs { MGLCoordinateBounds bounds = MGLCoordinateBoundsMake(kCLLocationCoordinate2DInvalid, kCLLocationCoordinate2DInvalid); MGLTilePyramidOfflineRegion *region = [[MGLTilePyramidOfflineRegion alloc] initWithStyleURL:nil bounds:bounds fromZoomLevel:0 toZoomLevel:DBL_MAX]; - XCTAssertEqualObjects(region.styleURL, [MGLStyle streetsStyleURL], @"Streets isn’t the default style."); + XCTAssertEqualObjects(region.styleURL, [MGLStyle streetsStyleURLWithVersion:MGLStyleCurrentVersion], @"Streets isn’t the default style."); NSURL *localURL = [NSURL URLWithString:@"beautiful.style"]; XCTAssertThrowsSpecificNamed([[MGLTilePyramidOfflineRegion alloc] initWithStyleURL:localURL bounds:bounds fromZoomLevel:0 toZoomLevel:DBL_MAX], NSException, @"Invalid style URL", @"No exception raised when initializing region with a local file URL as the style URL."); @@ -22,7 +22,7 @@ - (void)testEquality { MGLCoordinateBounds bounds = MGLCoordinateBoundsMake(kCLLocationCoordinate2DInvalid, kCLLocationCoordinate2DInvalid); - MGLTilePyramidOfflineRegion *original = [[MGLTilePyramidOfflineRegion alloc] initWithStyleURL:[MGLStyle lightStyleURL] bounds:bounds fromZoomLevel:5 toZoomLevel:10]; + MGLTilePyramidOfflineRegion *original = [[MGLTilePyramidOfflineRegion alloc] initWithStyleURL:[MGLStyle lightStyleURLWithVersion:MGLStyleCurrentVersion] bounds:bounds fromZoomLevel:5 toZoomLevel:10]; MGLTilePyramidOfflineRegion *copy = [original copy]; XCTAssertEqualObjects(original, copy, @"Tile pyramid region should be equal to its copy."); diff --git a/platform/osx/test/MGLOfflineStorageTests.m b/platform/osx/test/MGLOfflineStorageTests.m index 8ffa1207c..53dc7f4a5 100644 --- a/platform/osx/test/MGLOfflineStorageTests.m +++ b/platform/osx/test/MGLOfflineStorageTests.m @@ -30,7 +30,7 @@ - (void)testAddPack { NSUInteger countOfPacks = [MGLOfflineStorage sharedOfflineStorage].packs.count; - NSURL *styleURL = [MGLStyle lightStyleURL]; + NSURL *styleURL = [MGLStyle lightStyleURLWithVersion:8]; /// Somewhere near Grape Grove, Ohio, United States. MGLCoordinateBounds bounds = { { 39.70358155855172, -83.69506472545841 }, diff --git a/platform/osx/test/MGLStyleTests.mm b/platform/osx/test/MGLStyleTests.mm index 69c9ef609..38ee1a511 100644 --- a/platform/osx/test/MGLStyleTests.mm +++ b/platform/osx/test/MGLStyleTests.mm @@ -1,29 +1,84 @@ #import "MGLStyle.h" +#import "NSBundle+MGLAdditions.h" + #import #pragma clang diagnostic ignored "-Wgnu-statement-expression" #pragma clang diagnostic ignored "-Wgnu-zero-variadic-macro-arguments" #import +#import @interface MGLStyleTests : XCTestCase @end @implementation MGLStyleTests -- (void)testStyleURLs { - // Test that all the default styles have publicly-declared MGLStyle class - // methods and that the URLs are all well-formed. +- (void)testUnversionedStyleURLs { +#pragma clang diagnostic push +#pragma clang diagnostic ignored "-Wdeprecated-declarations" XCTAssertEqualObjects([MGLStyle streetsStyleURL].absoluteString, @(mbgl::util::default_styles::streets.url)); - XCTAssertEqualObjects([MGLStyle emeraldStyleURL].absoluteString, @(mbgl::util::default_styles::emerald.url)); + XCTAssertEqualObjects([MGLStyle emeraldStyleURL].absoluteString, @"mapbox://styles/mapbox/emerald-v8"); XCTAssertEqualObjects([MGLStyle lightStyleURL].absoluteString, @(mbgl::util::default_styles::light.url)); XCTAssertEqualObjects([MGLStyle darkStyleURL].absoluteString, @(mbgl::util::default_styles::dark.url)); XCTAssertEqualObjects([MGLStyle satelliteStyleURL].absoluteString, @(mbgl::util::default_styles::satellite.url)); XCTAssertEqualObjects([MGLStyle hybridStyleURL].absoluteString, @(mbgl::util::default_styles::hybrid.url)); +#pragma clang diagnostic pop +} + +- (void)testVersionedStyleURLs { + // Test that all the default styles have publicly-declared MGLStyle class + // methods and that the URLs all have the right values. + XCTAssertEqualObjects([MGLStyle streetsStyleURLWithVersion:MGLStyleCurrentVersion].absoluteString, @(mbgl::util::default_styles::streets.url)); + XCTAssertEqualObjects([MGLStyle outdoorsStyleURLWithVersion:MGLStyleCurrentVersion].absoluteString, @(mbgl::util::default_styles::outdoors.url)); + XCTAssertEqualObjects([MGLStyle lightStyleURLWithVersion:MGLStyleCurrentVersion].absoluteString, @(mbgl::util::default_styles::light.url)); + XCTAssertEqualObjects([MGLStyle darkStyleURLWithVersion:MGLStyleCurrentVersion].absoluteString, @(mbgl::util::default_styles::dark.url)); + XCTAssertEqualObjects([MGLStyle satelliteStyleURLWithVersion:MGLStyleCurrentVersion].absoluteString, @(mbgl::util::default_styles::satellite.url)); + XCTAssertEqualObjects([MGLStyle hybridStyleURLWithVersion:MGLStyleCurrentVersion].absoluteString, @(mbgl::util::default_styles::hybrid.url)); static_assert(6 == mbgl::util::default_styles::numOrderedStyles, "MGLStyleTests isn’t testing all the styles in mbgl::util::default_styles."); } +- (void)testStyleURLComprehensiveness { + // Make sure this test is comprehensive. + const unsigned numImplicitArgs = 2 /* _cmd, self */; + unsigned numMethods = 0; + Method *methods = class_copyMethodList(object_getClass([MGLStyle class]), &numMethods); + unsigned numVersionedMethods = 0; + for (NSUInteger i = 0; i < numMethods; i++) { + Method method = methods[i]; + SEL selector = method_getName(method); + NSString *name = @(sel_getName(selector)); + unsigned numArgs = method_getNumberOfArguments(method); + if ([name hasSuffix:@"StyleURL"]) { + XCTAssertEqual(numArgs, numImplicitArgs, @"Unversioned style URL method should have no parameters, but it has %u.", numArgs - numImplicitArgs); + } else if ([name hasSuffix:@"StyleURLWithVersion:"]) { + XCTAssertEqual(numArgs, numImplicitArgs + 1, @"Versioned style URL method should have one parameter, but it has %u.", numArgs - numImplicitArgs); + numVersionedMethods++; + } else { + XCTAssertEqual([name rangeOfString:@"URL"].location, NSNotFound, @"MGLStyle style URL method %@ is malformed.", name); + } + } + XCTAssertEqual(mbgl::util::default_styles::numOrderedStyles, numVersionedMethods, + @"There are %lu default styles but MGLStyleTests only provides versioned style URL methods for %u of them.", + mbgl::util::default_styles::numOrderedStyles, numVersionedMethods); + + // Test that all the versioned style methods are in the public header. + NSURL *styleHeaderURL = [[[NSBundle mgl_frameworkBundle].bundleURL + URLByAppendingPathComponent:@"Headers" isDirectory:YES] + URLByAppendingPathComponent:@"MGLStyle.h"]; + NSError *styleHeaderError; + NSString *styleHeader = [NSString stringWithContentsOfURL:styleHeaderURL usedEncoding:nil error:&styleHeaderError]; + XCTAssertNil(styleHeaderError, @"Error getting contents of MGLStyle.h."); + + NSError *versionedMethodError; + NSString *versionedMethodExpressionString = @(R"RE(^\+\s*\(NSURL\s*\*\s*\)\s*\w+StyleURLWithVersion\s*:\s*\(\s*NSInteger\s*\)\s*version\s*;)RE"); + NSRegularExpression *versionedMethodExpression = [NSRegularExpression regularExpressionWithPattern:versionedMethodExpressionString options:NSRegularExpressionAnchorsMatchLines error:&versionedMethodError]; + XCTAssertNil(versionedMethodError, @"Error compiling regular expression to search for versioned methods."); + NSUInteger numVersionedMethodDeclarations = [versionedMethodExpression numberOfMatchesInString:styleHeader options:0 range:NSMakeRange(0, styleHeader.length)]; + XCTAssertEqual(numVersionedMethodDeclarations, numVersionedMethods); +} + @end diff --git a/src/mbgl/util/default_styles.cpp b/src/mbgl/util/default_styles.cpp index d051fc60c..247b7320e 100644 --- a/src/mbgl/util/default_styles.cpp +++ b/src/mbgl/util/default_styles.cpp @@ -4,12 +4,12 @@ namespace mbgl { namespace util { namespace default_styles { -const DefaultStyle streets = { "mapbox://styles/mapbox/streets-v8", "Streets" }; -const DefaultStyle emerald = { "mapbox://styles/mapbox/emerald-v8", "Emerald" }; -const DefaultStyle light = { "mapbox://styles/mapbox/light-v8", "Light" }; -const DefaultStyle dark = { "mapbox://styles/mapbox/dark-v8", "Dark" }; -const DefaultStyle satellite = { "mapbox://styles/mapbox/satellite-v8", "Satellite" }; -const DefaultStyle hybrid = { "mapbox://styles/mapbox/satellite-hybrid-v8", "Hybrid" }; +const DefaultStyle streets = { "mapbox://styles/mapbox/streets-v9", "Streets" }; +const DefaultStyle outdoors = { "mapbox://styles/mapbox/outdoors-v9", "Outdoors" }; +const DefaultStyle light = { "mapbox://styles/mapbox/light-v9", "Light" }; +const DefaultStyle dark = { "mapbox://styles/mapbox/dark-v9", "Dark" }; +const DefaultStyle satellite = { "mapbox://styles/mapbox/satellite-v9", "Satellite" }; +const DefaultStyle hybrid = { "mapbox://styles/mapbox/satellite-hybrid-v9", "Hybrid" }; } // namespace default_styles } // end namespace util