update companion ad slot to use companionadslotsize

Author: bparrishMines

packages/interactive_media_ads/example/lib/main.dart

@@ -61,9 +61,8 @@ class _AdExampleWidgetState extends State<AdExampleWidget>
   final ContentProgressProvider _contentProgressProvider =
       ContentProgressProvider();
 
-  late final CompanionAdSlot companionAd = CompanionAdSlot.size(
-    width: 300,
-    height: 250,
+  late final CompanionAdSlot companionAd = CompanionAdSlot(
+    size: CompanionAdSlotSize.fixed(width: 300, height: 250),
     onClicked: () => debugPrint('Companion Ad Clicked'),
   );
 

packages/interactive_media_ads/lib/interactive_media_ads.dart

@@ -21,4 +21,7 @@ export 'src/platform_interface/platform_interface.dart'
         AdEvent,
         AdEventType,
         AdUIElement,
-        AdsLoadErrorData;
+        AdsLoadErrorData,
+        CompanionAdSlotSize,
+        CompanionAdSlotSizeFixed,
+        CompanionAdSlotSizeFluid;

packages/interactive_media_ads/lib/src/android/android_companion_ad_slot.dart

@@ -6,6 +6,7 @@ import 'package:flutter/cupertino.dart';
 import 'package:meta/meta.dart';
 
 import '../platform_interface/build_widget_creation_params.dart';
+import '../platform_interface/companion_ad_slot_size.dart';
 import '../platform_interface/platform_companion_ad_slot.dart';
 import 'android_view_widget.dart';
 import 'interactive_media_ads.g.dart' as ima;
@@ -15,52 +16,26 @@ import 'platform_views_service_proxy.dart';
 /// Android implementation of [PlatformCompanionAdSlotCreationParams].
 final class AndroidCompanionAdSlotCreationParams
     extends PlatformCompanionAdSlotCreationParams {
-  /// Constructs a [AndroidCompanionAdSlotCreationParams].
-  const AndroidCompanionAdSlotCreationParams.size({
-    required super.width,
-    required super.height,
+  /// Constructs an [AndroidCompanionAdSlotCreationParams].
+  const AndroidCompanionAdSlotCreationParams({
+    required super.size,
     super.onClicked,
     @visibleForTesting InteractiveMediaAdsProxy? proxy,
     @visibleForTesting PlatformViewsServiceProxy? platformViewsProxy,
   })  : _proxy = proxy ?? const InteractiveMediaAdsProxy(),
         _platformViewsProxy =
             platformViewsProxy ?? const PlatformViewsServiceProxy(),
-        super.size();
+        super();
 
-  /// Constructs a [AndroidCompanionAdSlotCreationParams].
-  const AndroidCompanionAdSlotCreationParams.fluid({
-    super.onClicked,
-    @visibleForTesting InteractiveMediaAdsProxy? proxy,
-    @visibleForTesting PlatformViewsServiceProxy? platformViewsProxy,
-  })  : _proxy = proxy ?? const InteractiveMediaAdsProxy(),
-        _platformViewsProxy =
-            platformViewsProxy ?? const PlatformViewsServiceProxy(),
-        super.fluid();
-
-  /// Creates a [AndroidCompanionAdSlotCreationParams] from an instance of
+  /// Creates a  [AndroidCompanionAdSlotCreationParams] from an instance of
   /// [PlatformCompanionAdSlotCreationParams].
   factory AndroidCompanionAdSlotCreationParams.fromPlatformCompanionAdSlotCreationParamsSize(
     PlatformCompanionAdSlotCreationParams params, {
     @visibleForTesting InteractiveMediaAdsProxy? proxy,
     @visibleForTesting PlatformViewsServiceProxy? platformViewsProxy,
   }) {
-    return AndroidCompanionAdSlotCreationParams.size(
-      width: params.width!,
-      height: params.height!,
-      onClicked: params.onClicked,
-      proxy: proxy,
-      platformViewsProxy: platformViewsProxy,
-    );
-  }
-
-  /// Creates a [AndroidCompanionAdSlotCreationParams] from an instance of
-  /// [PlatformCompanionAdSlotCreationParams].
-  factory AndroidCompanionAdSlotCreationParams.fromPlatformCompanionAdSlotCreationParamsFluid(
-    PlatformCompanionAdSlotCreationParams params, {
-    @visibleForTesting InteractiveMediaAdsProxy? proxy,
-    @visibleForTesting PlatformViewsServiceProxy? platformViewsProxy,
-  }) {
-    return AndroidCompanionAdSlotCreationParams.fluid(
+    return AndroidCompanionAdSlotCreationParams(
+      size: params.size,
       onClicked: params.onClicked,
       proxy: proxy,
       platformViewsProxy: platformViewsProxy,
@@ -106,13 +81,8 @@ base class AndroidCompanionAdSlot extends PlatformCompanionAdSlot {
       return params;
     }
 
-    if (params.isFluid) {
-      return AndroidCompanionAdSlotCreationParams
-          .fromPlatformCompanionAdSlotCreationParamsFluid(params);
-    } else {
-      return AndroidCompanionAdSlotCreationParams
-          .fromPlatformCompanionAdSlotCreationParamsSize(params);
-    }
+    return AndroidCompanionAdSlotCreationParams
+        .fromPlatformCompanionAdSlotCreationParamsSize(params);
   }
 
   Future<ima.CompanionAdSlot> _initCompanionAdSlot() async {
@@ -122,10 +92,11 @@ base class AndroidCompanionAdSlot extends PlatformCompanionAdSlot {
 
     await Future.wait(<Future<void>>[
       adSlot.setContainer(_frameLayout),
-      if (params.isFluid)
-        adSlot.setFluidSize()
-      else
-        adSlot.setSize(params.width!, params.height!),
+      switch (params.size) {
+        final CompanionAdSlotSizeFixed size =>
+          adSlot.setSize(size.width, size.height),
+        CompanionAdSlotSizeFluid() => adSlot.setFluidSize(),
+      },
       if (params.onClicked != null)
         adSlot.addClickListener(
           _createAdSlotClickListener(

packages/interactive_media_ads/lib/src/companion_ad_slot.dart

@@ -29,35 +29,22 @@ import 'platform_interface/platform_interface.dart';
 /// }
 /// ```
 class CompanionAdSlot {
-  /// Constructs an instance of a [CompanionAdSlot] with design ad width and
-  /// height.
+  /// Constructs an instance of a [CompanionAdSlot].
   ///
   /// See [CompanionAdSlot.fromPlatformCreationParams] for setting parameters
   /// for a specific platform.
-  CompanionAdSlot.size({
-    required int width,
-    required int height,
+  CompanionAdSlot({
+    required CompanionAdSlotSize size,
     void Function()? onClicked,
   }) : this.fromPlatformCreationParams(
-          params: PlatformCompanionAdSlotCreationParams.size(
-            width: width,
-            height: height,
+          params: PlatformCompanionAdSlotCreationParams(
+            size: size,
             onClicked: onClicked,
           ),
         );
 
-  /// Constructs an instance of a [CompanionAdSlot] with fluid size.
-  ///
-  /// See [CompanionAdSlot.fromPlatformCreationParams] for setting parameters
-  /// for a specific platform.
-  CompanionAdSlot.fluid({void Function()? onClicked})
-      : this.fromPlatformCreationParams(
-          params: PlatformCompanionAdSlotCreationParams.fluid(
-            onClicked: onClicked,
-          ),
-        );
-
-  /// Constructs an [CompanionAdSlot] from creation params for a specific platform.
+  /// Constructs an [CompanionAdSlot] from creation params for a specific
+  /// platform.
   ///
   /// {@template interactive_media_ads.CompanionAdSlot.fromPlatformCreationParams}
   /// Below is an example of setting platform-specific creation parameters for

packages/interactive_media_ads/lib/src/ios/ios_companion_ad_slot.dart

@@ -7,50 +7,30 @@ import 'package:flutter/services.dart';
 import 'package:meta/meta.dart';
 
 import '../platform_interface/build_widget_creation_params.dart';
+import '../platform_interface/companion_ad_slot_size.dart';
 import '../platform_interface/platform_companion_ad_slot.dart';
 import 'interactive_media_ads.g.dart';
 import 'interactive_media_ads_proxy.dart';
 
 /// Implementation of [PlatformCompanionAdSlotCreationParams] for iOS.
 final class IOSCompanionAdSlotCreationParams
     extends PlatformCompanionAdSlotCreationParams {
-  /// Constructs a [IOSCompanionAdSlotCreationParams].
-  const IOSCompanionAdSlotCreationParams.size({
-    required super.width,
-    required super.height,
+  /// Constructs an [IOSCompanionAdSlotCreationParams].
+  const IOSCompanionAdSlotCreationParams({
+    required super.size,
     super.onClicked,
     @visibleForTesting InteractiveMediaAdsProxy? proxy,
   })  : _proxy = proxy ?? const InteractiveMediaAdsProxy(),
-        super.size();
+        super();
 
-  /// Constructs a [IOSCompanionAdSlotCreationParams].
-  const IOSCompanionAdSlotCreationParams.fluid({
-    super.onClicked,
-    @visibleForTesting InteractiveMediaAdsProxy? proxy,
-  })  : _proxy = proxy ?? const InteractiveMediaAdsProxy(),
-        super.fluid();
-
-  /// Creates a [IOSCompanionAdSlotCreationParams] from an instance of
+  /// Creates an [IOSCompanionAdSlotCreationParams] from an instance of
   /// [PlatformCompanionAdSlotCreationParams].
   factory IOSCompanionAdSlotCreationParams.fromPlatformCompanionAdSlotCreationParamsSize(
     PlatformCompanionAdSlotCreationParams params, {
     @visibleForTesting InteractiveMediaAdsProxy? proxy,
   }) {
-    return IOSCompanionAdSlotCreationParams.size(
-      width: params.width!,
-      height: params.height!,
-      onClicked: params.onClicked,
-      proxy: proxy,
-    );
-  }
-
-  /// Creates a [IOSCompanionAdSlotCreationParams] from an instance of
-  /// [PlatformCompanionAdSlotCreationParams].
-  factory IOSCompanionAdSlotCreationParams.fromPlatformCompanionAdSlotCreationParamsFluid(
-    PlatformCompanionAdSlotCreationParams params, {
-    @visibleForTesting InteractiveMediaAdsProxy? proxy,
-  }) {
-    return IOSCompanionAdSlotCreationParams.fluid(
+    return IOSCompanionAdSlotCreationParams(
+      size: params.size,
       onClicked: params.onClicked,
       proxy: proxy,
     );
@@ -96,23 +76,21 @@ base class IOSCompanionAdSlot extends PlatformCompanionAdSlot {
       return params;
     }
 
-    if (params.isFluid) {
-      return IOSCompanionAdSlotCreationParams
-          .fromPlatformCompanionAdSlotCreationParamsFluid(params);
-    } else {
-      return IOSCompanionAdSlotCreationParams
-          .fromPlatformCompanionAdSlotCreationParamsSize(params);
-    }
+    return IOSCompanionAdSlotCreationParams
+        .fromPlatformCompanionAdSlotCreationParamsSize(params);
   }
 
   IMACompanionAdSlot _initCompanionAdSlot() {
-    final IMACompanionAdSlot adSlot = params.isFluid
-        ? _iosParams._proxy.newIMACompanionAdSlot(view: _view)
-        : _iosParams._proxy.sizeIMACompanionAdSlot(
-            view: _view,
-            width: _iosParams.width!,
-            height: _iosParams.height!,
-          );
+    final IMACompanionAdSlot adSlot = switch (params.size) {
+      final CompanionAdSlotSizeFixed size =>
+        _iosParams._proxy.sizeIMACompanionAdSlot(
+          view: _view,
+          width: size.width,
+          height: size.height,
+        ),
+      CompanionAdSlotSizeFluid() =>
+        _iosParams._proxy.newIMACompanionAdSlot(view: _view),
+    };
 
     if (params.onClicked != null) {
       adSlot.setDelegate(_delegate);

packages/interactive_media_ads/lib/src/platform_interface/companion_ad_slot_size.dart

@@ -20,7 +20,7 @@ sealed class CompanionAdSlotSize {
   /// A slot for a companion had with no fixed size, but rather adapts to fit the
   /// creative content they display.
   factory CompanionAdSlotSize.fluid() {
-    return const CompanionAdSizeSlotFluid._();
+    return const CompanionAdSlotSizeFluid._();
   }
 }
 
@@ -42,6 +42,6 @@ class CompanionAdSlotSizeFixed extends CompanionAdSlotSize {
 /// A slot for a companion had with no fixed size, but rather adapts to fit the
 /// creative content they display.
 @immutable
-class CompanionAdSizeSlotFluid extends CompanionAdSlotSize {
-  const CompanionAdSizeSlotFluid._() : super._();
+class CompanionAdSlotSizeFluid extends CompanionAdSlotSize {
+  const CompanionAdSlotSizeFluid._() : super._();
 }

packages/interactive_media_ads/lib/src/platform_interface/platform_companion_ad_slot.dart

@@ -5,6 +5,7 @@
 import 'package:flutter/widgets.dart';
 
 import 'build_widget_creation_params.dart';
+import 'companion_ad_slot_size.dart';
 import 'interactive_media_ads_platform.dart';
 
 /// Object specifying creation parameters for creating a
@@ -45,37 +46,18 @@ import 'interactive_media_ads_platform.dart';
 @immutable
 base class PlatformCompanionAdSlotCreationParams {
   /// Used by the platform implementation to create a new
-  /// [PlatformCompanionAdSlot] with ad width and height.
-  const PlatformCompanionAdSlotCreationParams.size({
-    required int this.width,
-    required int this.height,
+  /// [PlatformCompanionAdSlot].
+  const PlatformCompanionAdSlotCreationParams({
+    required this.size,
     this.onClicked,
-  }) : isFluid = false;
-
-  /// Used by the platform implementation to create a new
-  /// [PlatformCompanionAdSlot] with fluid size.
-  const PlatformCompanionAdSlotCreationParams.fluid({this.onClicked})
-      : width = null,
-        height = null,
-        isFluid = true;
+  });
 
-  /// The width of the companion slot.
-  ///
-  /// Returns `null` when [isFluid] returns true;
-  final int? width;
-
-  /// The height of the companion slot.
-  ///
-  /// Returns `null` when [isFluid] returns true;
-  final int? height;
+  /// The size of the slot.
+  final CompanionAdSlotSize size;
 
   /// Called when the slot is clicked on by the user and will successfully
   /// navigate away.
   final void Function()? onClicked;
-
-  /// Whether the companion ad has no fixed size, but rather adapts to fit the
-  /// creative content they display.
-  final bool isFluid;
 }
 
 /// Ad slot for companion ads.

packages/interactive_media_ads/lib/src/platform_interface/platform_interface.dart

@@ -6,6 +6,7 @@ export 'ad_error.dart';
 export 'ad_event.dart';
 export 'ad_ui_element.dart';
 export 'build_widget_creation_params.dart';
+export 'companion_ad_slot_size.dart';
 export 'interactive_media_ads_platform.dart';
 export 'platform_ad_display_container.dart';
 export 'platform_ads_loader.dart';

packages/interactive_media_ads/test/android/ad_display_container_test.dart

@@ -754,9 +754,8 @@ void main() {
           platformViewsProxy: mockPlatformViewsProxy,
           companionSlots: <PlatformCompanionAdSlot>[
             AndroidCompanionAdSlot(
-              AndroidCompanionAdSlotCreationParams.size(
-                width: 300,
-                height: 444,
+              AndroidCompanionAdSlotCreationParams(
+                size: CompanionAdSlotSize.fixed(width: 300, height: 444),
                 proxy: imaProxy,
               ),
             )

packages/interactive_media_ads/test/android/companion_ad_slot_test.dart

@@ -7,6 +7,7 @@ import 'package:interactive_media_ads/src/android/android_companion_ad_slot.dart
 import 'package:interactive_media_ads/src/android/interactive_media_ads.g.dart'
     as ima;
 import 'package:interactive_media_ads/src/android/interactive_media_ads_proxy.dart';
+import 'package:interactive_media_ads/src/platform_interface/companion_ad_slot_size.dart';
 import 'package:mockito/annotations.dart';
 import 'package:mockito/mockito.dart';
 
@@ -25,9 +26,8 @@ void main() {
       );
       final MockCompanionAdSlot mockCompanionAdSlot = MockCompanionAdSlot();
       final AndroidCompanionAdSlotCreationParams params =
-          AndroidCompanionAdSlotCreationParams.size(
-        width: 300,
-        height: 400,
+          AndroidCompanionAdSlotCreationParams(
+        size: CompanionAdSlotSize.fixed(width: 300, height: 400),
         proxy: InteractiveMediaAdsProxy(
           newFrameLayout: () {
             return frameLayout;
@@ -52,9 +52,8 @@ void main() {
     test('AndroidCompanionAdSlot receives onClick', () async {
       final MockCompanionAdSlot mockCompanionAdSlot = MockCompanionAdSlot();
       final AndroidCompanionAdSlotCreationParams params =
-          AndroidCompanionAdSlotCreationParams.size(
-        width: 300,
-        height: 400,
+          AndroidCompanionAdSlotCreationParams(
+        size: CompanionAdSlotSize.fixed(width: 300, height: 400),
         onClicked: expectAsync0(() {}),
         proxy: InteractiveMediaAdsProxy(
           newFrameLayout: () {