Refactor update methods, and expose for testing

Author: stuartmorgan-g

packages/google_maps_flutter/google_maps_flutter_ios/ios/Classes/FGMGroundOverlayController.m

@@ -3,6 +3,7 @@
 // found in the LICENSE file.
 
 #import "FGMGroundOverlayController.h"
+#import "FGMGroundOverlayController_Test.h"
 
 #import "FGMImageUtils.h"
 #import "FLTGoogleMapJSONConversions.h"
@@ -34,67 +35,44 @@ - (void)removeGroundOverlay {
   self.groundOverlay.map = nil;
 }
 
-- (void)setConsumeTapEvents:(BOOL)consumes {
-  self.groundOverlay.tappable = consumes;
-}
-
-- (void)setVisible:(BOOL)visible {
-  self.groundOverlay.map = visible ? self.mapView : nil;
-}
-
-- (void)setZIndex:(int)zIndex {
-  self.groundOverlay.zIndex = zIndex;
-}
-
-- (void)setAnchor:(CGPoint)anchor {
-  self.groundOverlay.anchor = anchor;
-}
-
-- (void)setBearing:(CLLocationDirection)bearing {
-  self.groundOverlay.bearing = bearing;
-}
-
-- (void)setTransparency:(float)transparency {
-  float opacity = 1.0 - transparency;
-  self.groundOverlay.opacity = opacity;
-}
-
-- (void)setPositionFromBounds:(GMSCoordinateBounds *)bounds {
-  self.groundOverlay.bounds = bounds;
-}
-
-- (void)setPositionFromCoordinates:(CLLocationCoordinate2D)coordinates {
-  self.groundOverlay.position = coordinates;
-}
-
-- (void)setIcon:(UIImage *)icon {
-  self.groundOverlay.icon = icon;
-}
-
 - (void)updateFromPlatformGroundOverlay:(FGMPlatformGroundOverlay *)groundOverlay
                               registrar:(NSObject<FlutterPluginRegistrar> *)registrar
                             screenScale:(CGFloat)screenScale {
-  [self setConsumeTapEvents:groundOverlay.clickable];
-  [self setZIndex:(int)groundOverlay.zIndex];
-  [self setAnchor:CGPointMake(groundOverlay.anchor.x, groundOverlay.anchor.y)];
-  UIImage *image = FGMIconFromBitmap(groundOverlay.image, registrar, screenScale);
-  [self setIcon:image];
-  [self setBearing:groundOverlay.bearing];
-  [self setTransparency:groundOverlay.transparency];
-  if ([self isCreatedWithBounds]) {
-    [self setPositionFromBounds:[[GMSCoordinateBounds alloc]
-                                    initWithCoordinate:CLLocationCoordinate2DMake(
-                                                           groundOverlay.bounds.northeast.latitude,
-                                                           groundOverlay.bounds.northeast.longitude)
-                                            coordinate:CLLocationCoordinate2DMake(
-                                                           groundOverlay.bounds.southwest.latitude,
-                                                           groundOverlay.bounds.southwest
-                                                               .longitude)]];
+  [FGMGroundOverlayController updateGroundOverlay:self.groundOverlay
+                        fromPlatformGroundOverlay:groundOverlay
+                                      withMapView:self.mapView
+                                        registrar:registrar
+                                      screenScale:screenScale
+                                      usingBounds:self.createdWithBounds];
+}
+
++ (void)updateGroundOverlay:(GMSGroundOverlay *)groundOverlay
+    fromPlatformGroundOverlay:(FGMPlatformGroundOverlay *)platformGroundOverlay
+                  withMapView:(GMSMapView *)mapView
+                    registrar:(NSObject<FlutterPluginRegistrar> *)registrar
+                  screenScale:(CGFloat)screenScale
+                  usingBounds:(BOOL)useBounds {
+  groundOverlay.tappable = platformGroundOverlay.clickable;
+  groundOverlay.zIndex = (int)platformGroundOverlay.zIndex;
+  groundOverlay.anchor =
+      CGPointMake(platformGroundOverlay.anchor.x, platformGroundOverlay.anchor.y);
+  UIImage *image = FGMIconFromBitmap(platformGroundOverlay.image, registrar, screenScale);
+  groundOverlay.icon = image;
+  groundOverlay.bearing = platformGroundOverlay.bearing;
+  groundOverlay.opacity = 1.0 - platformGroundOverlay.transparency;
+  if (useBounds) {
+    groundOverlay.bounds = [[GMSCoordinateBounds alloc]
+        initWithCoordinate:CLLocationCoordinate2DMake(
+                               platformGroundOverlay.bounds.northeast.latitude,
+                               platformGroundOverlay.bounds.northeast.longitude)
+                coordinate:CLLocationCoordinate2DMake(
+                               platformGroundOverlay.bounds.southwest.latitude,
+                               platformGroundOverlay.bounds.southwest.longitude)];
   } else {
-    [self setPositionFromCoordinates:CLLocationCoordinate2DMake(groundOverlay.position.latitude,
-                                                                groundOverlay.position.longitude)];
+    groundOverlay.position = CLLocationCoordinate2DMake(platformGroundOverlay.position.latitude,
+                                                        platformGroundOverlay.position.longitude);
   }
-  [self setVisible:groundOverlay.visible];
+  groundOverlay.map = platformGroundOverlay.visible ? mapView : nil;
 }
 
 @end

packages/google_maps_flutter/google_maps_flutter_ios/ios/Classes/FGMGroundOverlayController_Test.h

@@ -15,4 +15,15 @@
                               registrar:(NSObject<FlutterPluginRegistrar> *)registrar
                             screenScale:(CGFloat)screenScale;
 
+/// Updates the underlying GMSGroundOverlay with the properties from the given
+/// FGMPlatformGroundOverlay.
+///
+/// Setting the ground overlay to visible will set its map to the given mapView.
++ (void)updateGroundOverlay:(GMSGroundOverlay *)groundOverlay
+    fromPlatformGroundOverlay:(FGMPlatformGroundOverlay *)groundOverlay
+                  withMapView:(GMSMapView *)mapView
+                    registrar:(NSObject<FlutterPluginRegistrar> *)registrar
+                  screenScale:(CGFloat)screenScale
+                  usingBounds:(BOOL)useBounds;
+
 @end

packages/google_maps_flutter/google_maps_flutter_ios/ios/Classes/FLTGoogleMapHeatmapController.m

@@ -3,9 +3,12 @@
 // found in the LICENSE file.
 
 #import "FLTGoogleMapHeatmapController.h"
-#import "FLTGoogleMapJSONConversions.h"
+#import "FLTGoogleMapHeatmapController_Test.h"
+
 @import GoogleMapsUtils;
 
+#import "FLTGoogleMapJSONConversions.h"
+
 @interface FLTGoogleMapHeatmapController ()
 
 /// The heatmap tile layer this controller handles.
@@ -25,9 +28,9 @@ - (instancetype)initWithHeatmapTileLayer:(GMUHeatmapTileLayer *)heatmapTileLayer
     _heatmapTileLayer = heatmapTileLayer;
     _mapView = mapView;
 
-    [FLTGoogleMapHeatmapController interpretHeatmapOptions:_heatmapTileLayer
-                                                   mapView:_mapView
-                                                   options:options];
+    [FLTGoogleMapHeatmapController updateHeatmap:_heatmapTileLayer
+                                     fromOptions:options
+                                     withMapView:_mapView];
   }
   return self;
 }
@@ -41,14 +44,16 @@ - (void)clearTileCache {
 }
 
 - (void)interpretHeatmapOptions:(NSDictionary<NSString *, id> *)data {
-  [FLTGoogleMapHeatmapController interpretHeatmapOptions:_heatmapTileLayer
-                                                 mapView:_mapView
-                                                 options:data];
+  [FLTGoogleMapHeatmapController updateHeatmap:_heatmapTileLayer
+                                   fromOptions:data
+                                   withMapView:_mapView];
 }
 
-+ (void)interpretHeatmapOptions:(GMUHeatmapTileLayer *)heatmapTileLayer
-                        mapView:(GMSMapView *)mapView
-                        options:(NSDictionary<NSString *, id> *)options {
++ (void)updateHeatmap:(GMUHeatmapTileLayer *)heatmapTileLayer
+          fromOptions:(NSDictionary<NSString *, id> *)options
+          withMapView:(GMSMapView *)mapView {
+  // TODO(stuartmorgan): Migrate this to Pigeon. See
+  // https://github.com/flutter/flutter/issues/117907
   id weightedData = options[kHeatmapDataKey];
   if ([weightedData isKindOfClass:[NSArray class]]) {
     heatmapTileLayer.weightedData =

packages/google_maps_flutter/google_maps_flutter_ios/ios/Classes/FLTGoogleMapHeatmapController_Test.h

@@ -0,0 +1,17 @@
+// Copyright 2013 The Flutter Authors
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#import "FLTGoogleMapHeatmapController.h"
+
+/// Internal APIs exposed for unit testing
+@interface FLTGoogleMapHeatmapController (Test)
+
+/// Updates the underlying GMUHeatmapTileLayer with the properties from the given options.
+///
+/// Setting the heatmap to visible will set its map to the given mapView.
++ (void)updateHeatmap:(GMUHeatmapTileLayer *)heatmapTileLayer
+          fromOptions:(NSDictionary<NSString *, id> *)options
+          withMapView:(GMSMapView *)mapView;
+
+@end

packages/google_maps_flutter/google_maps_flutter_ios/ios/Classes/FLTGoogleMapTileOverlayController.m

@@ -3,6 +3,8 @@
 // found in the LICENSE file.
 
 #import "FLTGoogleMapTileOverlayController.h"
+#import "FLTGoogleMapTileOverlayController_Test.h"
+
 #import "FLTGoogleMapJSONConversions.h"
 
 @interface FLTGoogleMapTileOverlayController ()
@@ -21,8 +23,9 @@ - (instancetype)initWithTileOverlay:(FGMPlatformTileOverlay *)tileOverlay
   if (self) {
     _layer = tileLayer;
     _mapView = mapView;
-    // TODO(stuartmorgan: Refactor to avoid this call to an instance method in init.
-    [self updateFromPlatformTileOverlay:tileOverlay];
+    [FLTGoogleMapTileOverlayController updateTileLayer:tileLayer
+                               fromPlatformTileOverlay:tileOverlay
+                                           withMapView:mapView];
   }
   return self;
 }
@@ -35,33 +38,20 @@ - (void)clearTileCache {
   [self.layer clearTileCache];
 }
 
-- (void)setFadeIn:(BOOL)fadeIn {
-  self.layer.fadeIn = fadeIn;
-}
-
-- (void)setTransparency:(float)transparency {
-  float opacity = 1.0 - transparency;
-  self.layer.opacity = opacity;
-}
-
-- (void)setVisible:(BOOL)visible {
-  self.layer.map = visible ? self.mapView : nil;
-}
-
-- (void)setZIndex:(int)zIndex {
-  self.layer.zIndex = zIndex;
-}
-
-- (void)setTileSize:(NSInteger)tileSize {
-  self.layer.tileSize = tileSize;
-}
-
 - (void)updateFromPlatformTileOverlay:(FGMPlatformTileOverlay *)overlay {
-  [self setVisible:overlay.visible];
-  [self setTransparency:overlay.transparency];
-  [self setZIndex:(int)overlay.zIndex];
-  [self setFadeIn:overlay.fadeIn];
-  [self setTileSize:overlay.tileSize];
+  [FLTGoogleMapTileOverlayController updateTileLayer:self.layer
+                             fromPlatformTileOverlay:overlay
+                                         withMapView:self.mapView];
+}
+
++ (void)updateTileLayer:(GMSTileLayer *)tileLayer
+    fromPlatformTileOverlay:(FGMPlatformTileOverlay *)platformOverlay
+                withMapView:(GMSMapView *)mapView {
+  tileLayer.map = platformOverlay.visible ? mapView : nil;
+  tileLayer.opacity = 1.0 - platformOverlay.transparency;
+  tileLayer.zIndex = (int)platformOverlay.zIndex;
+  tileLayer.fadeIn = platformOverlay.fadeIn;
+  tileLayer.tileSize = platformOverlay.tileSize;
 }
 
 @end

packages/google_maps_flutter/google_maps_flutter_ios/ios/Classes/FLTGoogleMapTileOverlayController_Test.h

@@ -0,0 +1,17 @@
+// Copyright 2013 The Flutter Authors
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#import "FLTGoogleMapTileOverlayController.h"
+
+/// Internal APIs exposed for unit testing
+@interface FLTGoogleMapTileOverlayController (Test)
+
+/// Updates the underlying GMSTileLayer with the properties from the given FGMPlatformTileOverlay.
+///
+/// Setting the tile overlay to visible will set its map to the given mapView.
++ (void)updateTileLayer:(GMSTileLayer *)tileLayer
+    fromPlatformTileOverlay:(FGMPlatformTileOverlay *)platformOverlay
+                withMapView:(GMSMapView *)mapView;
+
+@end

packages/google_maps_flutter/google_maps_flutter_ios/ios/Classes/GoogleMapCircleController.h

@@ -7,6 +7,8 @@
 
 #import "messages.g.h"
 
+NS_ASSUME_NONNULL_BEGIN
+
 // Defines circle controllable by Flutter.
 @interface FLTGoogleMapCircleController : NSObject
 - (instancetype)initCircleWithPlatformCircle:(FGMPlatformCircle *)circle
@@ -24,3 +26,5 @@
 - (void)didTapCircleWithIdentifier:(NSString *)identifier;
 - (bool)hasCircleWithIdentifier:(NSString *)identifier;
 @end
+
+NS_ASSUME_NONNULL_END

packages/google_maps_flutter/google_maps_flutter_ios/ios/Classes/GoogleMapCircleController.m

@@ -3,6 +3,8 @@
 // found in the LICENSE file.
 
 #import "GoogleMapCircleController.h"
+#import "GoogleMapCircleController_Test.h"
+
 #import "FLTGoogleMapJSONConversions.h"
 
 @interface FLTGoogleMapCircleController ()
@@ -22,8 +24,9 @@ - (instancetype)initCircleWithPlatformCircle:(FGMPlatformCircle *)circle
                                      radius:circle.radius];
     _mapView = mapView;
     _circle.userData = @[ circle.circleId ];
-    // TODO(stuartmorgan: Refactor to avoid this call to an instance method in init.
-    [self updateFromPlatformCircle:circle];
+    [FLTGoogleMapCircleController updateCircle:_circle
+                            fromPlatformCircle:circle
+                                   withMapView:mapView];
   }
   return self;
 }
@@ -32,41 +35,23 @@ - (void)removeCircle {
   self.circle.map = nil;
 }
 
-- (void)setConsumeTapEvents:(BOOL)consumes {
-  self.circle.tappable = consumes;
-}
-- (void)setVisible:(BOOL)visible {
-  self.circle.map = visible ? self.mapView : nil;
-}
-- (void)setZIndex:(int)zIndex {
-  self.circle.zIndex = zIndex;
-}
-- (void)setCenter:(CLLocationCoordinate2D)center {
-  self.circle.position = center;
-}
-- (void)setRadius:(CLLocationDistance)radius {
-  self.circle.radius = radius;
-}
-
-- (void)setStrokeColor:(UIColor *)color {
-  self.circle.strokeColor = color;
-}
-- (void)setStrokeWidth:(CGFloat)width {
-  self.circle.strokeWidth = width;
-}
-- (void)setFillColor:(UIColor *)color {
-  self.circle.fillColor = color;
-}
-
 - (void)updateFromPlatformCircle:(FGMPlatformCircle *)platformCircle {
-  [self setConsumeTapEvents:platformCircle.consumeTapEvents];
-  [self setVisible:platformCircle.visible];
-  [self setZIndex:platformCircle.zIndex];
-  [self setCenter:FGMGetCoordinateForPigeonLatLng(platformCircle.center)];
-  [self setRadius:platformCircle.radius];
-  [self setStrokeColor:FGMGetColorForRGBA(platformCircle.strokeColor)];
-  [self setStrokeWidth:platformCircle.strokeWidth];
-  [self setFillColor:FGMGetColorForRGBA(platformCircle.fillColor)];
+  [FLTGoogleMapCircleController updateCircle:self.circle
+                          fromPlatformCircle:platformCircle
+                                 withMapView:self.mapView];
+}
+
++ (void)updateCircle:(GMSCircle *)circle
+    fromPlatformCircle:(FGMPlatformCircle *)platformCircle
+           withMapView:(GMSMapView *)mapView {
+  circle.tappable = platformCircle.consumeTapEvents;
+  circle.map = platformCircle.visible ? mapView : nil;
+  circle.zIndex = platformCircle.zIndex;
+  circle.position = FGMGetCoordinateForPigeonLatLng(platformCircle.center);
+  circle.radius = platformCircle.radius;
+  circle.strokeColor = FGMGetColorForRGBA(platformCircle.strokeColor);
+  circle.strokeWidth = platformCircle.strokeWidth;
+  circle.fillColor = FGMGetColorForRGBA(platformCircle.fillColor);
 }
 
 @end

packages/google_maps_flutter/google_maps_flutter_ios/ios/Classes/GoogleMapCircleController_Test.h

@@ -0,0 +1,21 @@
+// Copyright 2013 The Flutter Authors
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#import "GoogleMapCircleController.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+/// Private methods exposed for testing.
+@interface FLTGoogleMapCircleController (Test)
+
+/// Updates the underlying GMSCircle with the properties from the given FGMPlatformCircle.
+///
+/// Setting the circle to visible will set its map to the given mapView.
++ (void)updateCircle:(GMSCircle *)circle
+    fromPlatformCircle:(FGMPlatformCircle *)platformCircle
+           withMapView:(GMSMapView *)mapView;
+
+@end
+
+NS_ASSUME_NONNULL_END