Add snappshotter options for logo and attribution

CHANGELOG.md

@@ -17,6 +17,11 @@ Mapbox welcomes participation and contributions from everyone.
 
 * Fixed an issue where `MapView` positioning wasn't correct when used in containers such as UIStackView. ([#533](https://github.com/mapbox/mapbox-maps-ios/pull/533)) 
 
+### Features ✨ and improvements 🏁
+* Added new options to `MapSnapshotOptions`
+    * `showsLogo` is a flag that will decide whether the logo will be shown on a snapshot
+    * `showsAttribution` is a flag that will decide whether the attribution will be shown on a snapshot
+
 ## 10.0.0-rc.4 - July 14, 2021
 
 ### Features ✨ and improvements 🏁

Package.swift

@@ -45,6 +45,10 @@ let package = Package(
                 .copy("Foundation/GeoJSON/Fixtures/multipolygon.geojson"),
                 .copy("Helpers/MapboxAccessToken"),
                 .copy("Resources/empty-style-chicago.json"),
+                .copy("Resources/testShowsLogo().png"),
+                .copy("Resources/testDoNotShowsLogo().png"),
+                .copy("Resources/testShowsAttribution().png"),
+                .copy("Resources/testDoNotShowsAttribution().png"),
                 .process("Snapshot/Snapshot.xcassets"),
                 .process("Resources/MapInitOptionsTests.xib"),
             ]

Sources/MapboxMaps/Foundation/Extensions/Core/MapSnapshotOptions.swift

@@ -1,17 +1,23 @@
 /// Set of options for taking map snapshot with Snapshotter.
 public struct MapSnapshotOptions {
     /// Dimensions of the snapshot in points.
-    public let size: CGSize
+    public var size: CGSize
 
     /// Ratio between the number device-independent and screen pixels.
-    public let pixelRatio: CGFloat
+    public var pixelRatio: CGFloat
 
     /// Glyphs rasterization options to use for client-side text rendering.
     /// By default, `GlyphsRasterizationOptions` will use `.ideographsRasterizedLocally`
-    public let glyphsRasterizationOptions: GlyphsRasterizationOptions
+    public var glyphsRasterizationOptions: GlyphsRasterizationOptions
 
     /// Resource fetching options to be used by the snapshotter.
-    public let resourceOptions: ResourceOptions
+    public var resourceOptions: ResourceOptions
+
+    /// Flag that determines if the logo should be shown on the snapshot
+    public var showsLogo: Bool
+
+    /// Flag that determines if attribution should be shown on the snapshot
+    public var showsAttribution: Bool
 
     /// Initializes a `MapSnapshotOptions`
     /// - Parameters:
@@ -23,10 +29,14 @@ public struct MapSnapshotOptions {
     ///   - resourceOptions: Resource fetching options to be used by the
     ///         snapshotter. Default uses the access token provided by
     ///         `ResourceOptionsManager.default`
+    ///   - showsLogo: Flag that determines if the logo should be shown on the snapshot
+    ///   - showsAttribution: Flag that determines if attribution should be shown on the snapshot
     public init(size: CGSize,
                 pixelRatio: CGFloat,
                 glyphsRasterizationOptions: GlyphsRasterizationOptions = GlyphsRasterizationOptions(),
-                resourceOptions: ResourceOptions = ResourceOptionsManager.default.resourceOptions) {
+                resourceOptions: ResourceOptions = ResourceOptionsManager.default.resourceOptions,
+                showsLogo: Bool = true,
+                showsAttribution: Bool = true) {
         precondition(pixelRatio > 0)
         precondition(size.width * pixelRatio <= 8192, "Width or scale too great.")
         precondition(size.height * pixelRatio <= 8192, "Height or scale too great.")
@@ -35,6 +45,8 @@ public struct MapSnapshotOptions {
         self.pixelRatio = pixelRatio
         self.glyphsRasterizationOptions = glyphsRasterizationOptions
         self.resourceOptions = resourceOptions
+        self.showsLogo = showsLogo
+        self.showsAttribution = showsAttribution
     }
 }
 

Sources/MapboxMaps/Snapshot/Snapshotter.swift

@@ -2,6 +2,8 @@ import UIKit
 import CoreLocation
 import CoreImage.CIFilterBuiltins
 
+@_implementationOnly import MapboxCommon_Private
+
 // MARK: - Snapshotter
 public class Snapshotter {
 
@@ -80,6 +82,8 @@ public class Snapshotter {
         let scale = CGFloat(options.pixelRatio)
 
         let style = self.style
+        let options = self.options
+
         mapSnapshotter.start { (expected) in
             if expected.isError() {
                 completion(.failure(.snapshotFailed(reason: expected.error as? String)))
@@ -180,11 +184,12 @@ public class Snapshotter {
                         context.restoreGState()
                     }
 
-                    if true { // options.showsLogo
+                    if options.showsLogo {
                         Snapshotter.renderLogoView(logoView, context: context)
                     }
 
-                    if let attributionView = attributionView, true { // options.showsAttribution
+                    if let attributionView = attributionView,
+                       options.showsAttribution {
                         Snapshotter.renderAttributionView(attributionView,
                                                           blurredImage: blurredImage,
                                                           context: context)

Tests/MapboxMapsTests/Snapshot/MapboxMapsSnapshotTests.swift

@@ -215,4 +215,63 @@ class MapboxMapsSnapshotTests: XCTestCase {
         }
     }
 
+    func testShowsLogo() throws {
+        var options = try snapshotterOptions()
+        options.showsLogo = true
+
+        showLogoAttributionHelper(options: options, fileName: "\(#function)")
+    }
+
+    func testDoNotShowsLogo() throws {
+        var options = try snapshotterOptions()
+        options.showsLogo = false
+
+        showLogoAttributionHelper(options: options, fileName: "\(#function)")
+    }
+
+    func testShowsAttribution() throws {
+        var options = try snapshotterOptions()
+        options.showsAttribution = true
+
+        showLogoAttributionHelper(options: options, fileName: "\(#function)")
+    }
+
+    func testDoNotShowsAttribution() throws {
+        var options = try snapshotterOptions()
+        options.showsAttribution = false
+
+        showLogoAttributionHelper(options: options, fileName: "\(#function)")
+    }
+
+    private func showLogoAttributionHelper(options: MapSnapshotOptions, fileName: String) {
+        let snapshotter = Snapshotter(options: options)
+
+        // Adding a simple custom style
+        snapshotter.style.JSON = #"{"version":8,"sources":{},"layers":[{"id":"background","type":"background","paint":{"background-color":"white"}}]}"#
+
+        let expectation = self.expectation(description: "snapshot")
+        snapshotter.start(overlayHandler: nil, completion: { result in
+            switch result {
+            case let .success(image) :
+                // This code block is used to generate an image for comparison.
+                let url = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask).first!.appendingPathComponent("\(fileName).png")
+                do {
+                    try image.pngData()?.write(to: url)
+                } catch {
+                    print(error)
+                }
+
+                // Compare snapshot asset data vs snapshot image data
+                let path = Bundle.mapboxMapsTests.path(forResource: "\(fileName)", ofType: "png")!
+                let compareUrl = URL(fileURLWithPath: path)
+                let expectedImageData = try! Data(contentsOf: compareUrl)
+
+                XCTAssertEqual(expectedImageData, image.pngData())
+            case.failure :
+                XCTFail("Failure: snapshot asset and snapshot image do not match")
+            }
+            expectation.fulfill()
+        })
+        wait(for: [expectation], timeout: 10)
+    }
 }