[ornaments] Refactor visibility options for the logo and attribution button

CHANGELOG.md

@@ -4,6 +4,9 @@ Mapbox welcomes participation and contributions from everyone.
 
 ## main
 
+### Breaking changes ⚠️
+
+  - `OrnamentOptions.logo._isVisible` and `OrnamentOptions.attributionButton._isVisible` have been replaced with `OrnamentOptions.logo.visibility` and `OrnamentOptions.attributionButton.visibility`. ([#326](https://github.com/mapbox/mapbox-maps-ios/pull/326))
 ## 10.0.0-beta.19 - May 6, 2021
 
 ### Breaking changes ⚠️

Sources/MapboxMaps/Foundation/LogoView.swift

@@ -33,6 +33,14 @@ internal class LogoView: UIView {
         }
     }
 
+    public override var isHidden: Bool {
+        didSet {
+            if isHidden {
+                Log.warning(forMessage: "The Mapbox logo wordmark must remain enabled in accordance with our Terms of Service. See https://www.mapbox.com/legal/tos for more details.", category: "Ornaments")
+            }
+        }
+    }
+
     internal override var intrinsicContentSize: CGSize {
         return logoSize.rawValue
     }

Sources/MapboxMaps/MapView/MapView.swift

@@ -12,7 +12,7 @@ open class MapView: BaseMapView {
     public internal(set) var gestures: GestureManager!
 
     /// The `ornaments`object will be responsible for all ornaments on the map.
-    public var ornaments: OrnamentsManager!
+    public internal(set) var ornaments: OrnamentsManager!
 
     /// The `camera` object manages a camera's view lifecycle..
     public internal(set) var camera: CameraAnimationsManager!

Sources/MapboxMaps/Ornaments/MapboxInfoButtonOrnament.swift

@@ -16,6 +16,14 @@ internal class MapboxInfoButtonOrnament: UIView {
         }
     }
 
+    public override var isHidden: Bool {
+        didSet {
+            if isHidden {
+                Log.warning(forMessage: "Attribution must be enabled if you use data from sources that require it. See https://docs.mapbox.com/help/getting-started/attribution/ for more details.", category: "Ornaments")
+            }
+        }
+    }
+
     internal init() {
         super.init(frame: CGRect(origin: .zero, size: CGSize(width: 44, height: 44)))
         NSLayoutConstraint.activate([

Sources/MapboxMaps/Ornaments/OrnamentOptions.swift

@@ -10,12 +10,12 @@ private let defaultOrnamentsMargin = CGPoint(x: 8.0, y: 8.0)
 public struct OrnamentOptions: Equatable {
 
     // MARK: - Scale Bar
-    /// The ornament options for the scale bar.
+    /// The ornament options for the map's scale bar..
     public var scaleBar = ScaleBarViewOptions()
 
     // MARK: - Compass
 
-    /// The ornament options for the compass view.
+    /// The ornament options for the map's compass view.
     public var compass = CompassViewOptions()
 
     // MARK: - Logo View
@@ -25,21 +25,24 @@ public struct OrnamentOptions: Equatable {
      information. See https://docs.mapbox.com/help/how-mapbox-works/attribution/
      for details.
      */
-    /// The ornament options for the logo view.
+
+    /// The ornament options for the map's logo view.
     public var logo = LogoViewOptions()
 
     // MARK: - Attribution Button
-    /// The ornament options for the attribution button.
+
+    /// The ornament options for the map's attribution button.
     public var attributionButton = AttributionButtonOptions()
 }
 
-public protocol BaseOrnamentOptions: Equatable {
+public protocol OrnamentOptionsProtocol {
     var position: OrnamentPosition { get set }
+    /// The default value for this property is `CGPoint(x: 8.0, y: 8.0)`.
     var margins: CGPoint { get set }
 }
 
-/// Used to configure position, margin, and visibility for the map's scale bar.
-public struct ScaleBarViewOptions: BaseOrnamentOptions {
+/// Used to configure position, margin, and visibility for the map's scale bar view.
+public struct ScaleBarViewOptions: OrnamentOptionsProtocol, Equatable {
     /// The default value for this property is `.topLeft`.
     public var position: OrnamentPosition = .topLeft
     /// The default value for this property is `CGPoint(x: 8.0, y: 8.0)`.
@@ -49,7 +52,7 @@ public struct ScaleBarViewOptions: BaseOrnamentOptions {
 }
 
 /// Used to configure position, margin, and visibility for the map's compass view.
-public struct CompassViewOptions: BaseOrnamentOptions {
+public struct CompassViewOptions: OrnamentOptionsProtocol, Equatable {
     /// The default value for this property is `.topRight`.
     public var position: OrnamentPosition = .topRight
     /// The default value for this property is `CGPoint(x: 8.0, y: 8.0)`.
@@ -59,21 +62,25 @@ public struct CompassViewOptions: BaseOrnamentOptions {
 }
 
 /// Used to configure position, margin, and visibility for the map's attribution button.
-public struct AttributionButtonOptions: Equatable {
+public struct AttributionButtonOptions: OrnamentOptionsProtocol, Equatable {
     /// The default value for this property is `.bottomRight`.
     public var position: OrnamentPosition = .bottomRight
     /// The default value for this property is `CGPoint(x: 8.0, y: 8.0)`.
     public var margins: CGPoint = defaultOrnamentsMargin
-    /// The default value for this property is `true`.
-    public var _isVisible: Bool = true
+    /// The default value for this property is `visible`. Setting this property to `.adaptive`
+    /// will lead to the same behavior as `.visible`. The attribution button will be visible
+    /// as long as the map view is visible.
+    public var _visibility: OrnamentVisibility = .visible
 }
 
 /// Used to configure position, margin, and visibility for the map's logo view.
-public struct LogoViewOptions: Equatable {
+public struct LogoViewOptions: OrnamentOptionsProtocol, Equatable {
     /// The default value for this property is `.bottomLeft`.
     public var position: OrnamentPosition = .bottomLeft
     /// The default value for this property is `CGPoint(x: 8.0, y: 8.0)`.
     public var margins: CGPoint = defaultOrnamentsMargin
-    /// The default value for this property is `true`.
-    public var _isVisible: Bool = true
+    /// The default value for this property is `visible`. Setting this property to `.adaptive`
+    /// willl lead to the same behavior as `.visible`. The logo view will be visible as long
+    /// as the map view is visible.
+    public var _visibility: OrnamentVisibility = .visible
 }

Sources/MapboxMaps/Ornaments/OrnamentsManager.swift

@@ -103,10 +103,10 @@ public class OrnamentsManager: NSObject {
         // Activate new constraints
         NSLayoutConstraint.activate(constraints)
 
-        logoView.isHidden = !options.logo._isVisible
+        logoView.isHidden = options.logo._visibility == .hidden
         scalebarView.isHidden = options.scaleBar.visibility == .hidden
         compassView.isHidden = options.compass.visibility == .hidden
-        attributionButton.isHidden = !options.attributionButton._isVisible
+        attributionButton.isHidden = options.attributionButton._visibility == .hidden
     }
 
     private func constraints(with view: UIView, position: OrnamentPosition, margins: CGPoint) -> [NSLayoutConstraint] {