[camera] Switch platform interface to new analysis options (#4613)

Switches camera_platform_interface from the legacy analysis options to the new ones, fixing all violations they flag.

Part of flutter/flutter#76229

Author: stuartmorgan-g

packages/camera/camera_platform_interface/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 2.1.2
+
+* Adopts new analysis options and fixes all violations.
+
 ## 2.1.1
 
 * Add web-relevant docs to platform interface code.

packages/camera/camera_platform_interface/analysis_options.yaml

@@ -2,10 +2,10 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
+/// Expose XFile
+export 'package:cross_file/cross_file.dart';
+
 export 'src/events/camera_event.dart';
 export 'src/events/device_event.dart';
 export 'src/platform_interface/camera_platform.dart';
 export 'src/types/types.dart';
-
-/// Expose XFile
-export 'package:cross_file/cross_file.dart';

packages/camera/camera_platform_interface/lib/camera_platform_interface.dart

@@ -3,6 +3,7 @@
 // found in the LICENSE file.
 
 import 'package:camera_platform_interface/src/types/focus_mode.dart';
+import 'package:meta/meta.dart';
 
 import '../../camera_platform_interface.dart';
 
@@ -22,14 +23,15 @@ import '../../camera_platform_interface.dart';
 /// See below for examples: `CameraClosingEvent`, `CameraErrorEvent`...
 /// These events are more semantic and more pleasant to use than raw generics.
 /// They can be (and in fact, are) filtered by the `instanceof`-operator.
+@immutable
 abstract class CameraEvent {
-  /// The ID of the Camera this event is associated to.
-  final int cameraId;
-
   /// Build a Camera Event, that relates a `cameraId`.
   ///
   /// The `cameraId` is the ID of the camera that triggered the event.
-  CameraEvent(this.cameraId) : assert(cameraId != null);
+  const CameraEvent(this.cameraId) : assert(cameraId != null);
+
+  /// The ID of the Camera this event is associated to.
+  final int cameraId;
 
   @override
   bool operator ==(Object other) =>
@@ -44,30 +46,12 @@ abstract class CameraEvent {
 
 /// An event fired when the camera has finished initializing.
 class CameraInitializedEvent extends CameraEvent {
-  /// The width of the preview in pixels.
-  final double previewWidth;
-
-  /// The height of the preview in pixels.
-  final double previewHeight;
-
-  /// The default exposure mode
-  final ExposureMode exposureMode;
-
-  /// The default focus mode
-  final FocusMode focusMode;
-
-  /// Whether setting exposure points is supported.
-  final bool exposurePointSupported;
-
-  /// Whether setting focus points is supported.
-  final bool focusPointSupported;
-
   /// Build a CameraInitialized event triggered from the camera represented by
   /// `cameraId`.
   ///
   /// The `previewWidth` represents the width of the generated preview in pixels.
   /// The `previewHeight` represents the height of the generated preview in pixels.
-  CameraInitializedEvent(
+  const CameraInitializedEvent(
     int cameraId,
     this.previewWidth,
     this.previewHeight,
@@ -80,17 +64,36 @@ class CameraInitializedEvent extends CameraEvent {
   /// Converts the supplied [Map] to an instance of the [CameraInitializedEvent]
   /// class.
   CameraInitializedEvent.fromJson(Map<String, dynamic> json)
-      : previewWidth = json['previewWidth'],
-        previewHeight = json['previewHeight'],
-        exposureMode = deserializeExposureMode(json['exposureMode']),
-        exposurePointSupported = json['exposurePointSupported'] ?? false,
-        focusMode = deserializeFocusMode(json['focusMode']),
-        focusPointSupported = json['focusPointSupported'] ?? false,
-        super(json['cameraId']);
+      : previewWidth = json['previewWidth']! as double,
+        previewHeight = json['previewHeight']! as double,
+        exposureMode = deserializeExposureMode(json['exposureMode']! as String),
+        exposurePointSupported =
+            (json['exposurePointSupported'] as bool?) ?? false,
+        focusMode = deserializeFocusMode(json['focusMode']! as String),
+        focusPointSupported = (json['focusPointSupported'] as bool?) ?? false,
+        super(json['cameraId']! as int);
+
+  /// The width of the preview in pixels.
+  final double previewWidth;
+
+  /// The height of the preview in pixels.
+  final double previewHeight;
+
+  /// The default exposure mode
+  final ExposureMode exposureMode;
+
+  /// The default focus mode
+  final FocusMode focusMode;
+
+  /// Whether setting exposure points is supported.
+  final bool exposurePointSupported;
+
+  /// Whether setting focus points is supported.
+  final bool focusPointSupported;
 
   /// Converts the [CameraInitializedEvent] instance into a [Map] instance that
   /// can be serialized to JSON.
-  Map<String, dynamic> toJson() => {
+  Map<String, dynamic> toJson() => <String, Object>{
         'cameraId': cameraId,
         'previewWidth': previewWidth,
         'previewHeight': previewHeight,
@@ -126,18 +129,12 @@ class CameraInitializedEvent extends CameraEvent {
 
 /// An event fired when the resolution preset of the camera has changed.
 class CameraResolutionChangedEvent extends CameraEvent {
-  /// The capture width in pixels.
-  final double captureWidth;
-
-  /// The capture height in pixels.
-  final double captureHeight;
-
   /// Build a CameraResolutionChanged event triggered from the camera
   /// represented by `cameraId`.
   ///
   /// The `captureWidth` represents the width of the resulting image in pixels.
   /// The `captureHeight` represents the height of the resulting image in pixels.
-  CameraResolutionChangedEvent(
+  const CameraResolutionChangedEvent(
     int cameraId,
     this.captureWidth,
     this.captureHeight,
@@ -146,13 +143,19 @@ class CameraResolutionChangedEvent extends CameraEvent {
   /// Converts the supplied [Map] to an instance of the
   /// [CameraResolutionChangedEvent] class.
   CameraResolutionChangedEvent.fromJson(Map<String, dynamic> json)
-      : captureWidth = json['captureWidth'],
-        captureHeight = json['captureHeight'],
-        super(json['cameraId']);
+      : captureWidth = json['captureWidth']! as double,
+        captureHeight = json['captureHeight']! as double,
+        super(json['cameraId']! as int);
+
+  /// The capture width in pixels.
+  final double captureWidth;
+
+  /// The capture height in pixels.
+  final double captureHeight;
 
   /// Converts the [CameraResolutionChangedEvent] instance into a [Map] instance
   /// that can be serialized to JSON.
-  Map<String, dynamic> toJson() => {
+  Map<String, dynamic> toJson() => <String, Object>{
         'cameraId': cameraId,
         'captureWidth': captureWidth,
         'captureHeight': captureHeight,
@@ -162,7 +165,7 @@ class CameraResolutionChangedEvent extends CameraEvent {
   bool operator ==(Object other) =>
       identical(this, other) ||
       other is CameraResolutionChangedEvent &&
-          super == (other) &&
+          super == other &&
           runtimeType == other.runtimeType &&
           captureWidth == other.captureWidth &&
           captureHeight == other.captureHeight;
@@ -176,58 +179,61 @@ class CameraResolutionChangedEvent extends CameraEvent {
 class CameraClosingEvent extends CameraEvent {
   /// Build a CameraClosing event triggered from the camera represented by
   /// `cameraId`.
-  CameraClosingEvent(int cameraId) : super(cameraId);
+  const CameraClosingEvent(int cameraId) : super(cameraId);
 
   /// Converts the supplied [Map] to an instance of the [CameraClosingEvent]
   /// class.
   CameraClosingEvent.fromJson(Map<String, dynamic> json)
-      : super(json['cameraId']);
+      : super(json['cameraId']! as int);
 
   /// Converts the [CameraClosingEvent] instance into a [Map] instance that can
   /// be serialized to JSON.
-  Map<String, dynamic> toJson() => {
+  Map<String, dynamic> toJson() => <String, Object>{
         'cameraId': cameraId,
       };
 
   @override
   bool operator ==(Object other) =>
       identical(this, other) ||
-      super == (other) &&
+      super == other &&
           other is CameraClosingEvent &&
           runtimeType == other.runtimeType;
 
   @override
+  // This is here even though it just calls super to make it less likely that
+  // operator== would be changed without changing `hashCode`.
+  // ignore: unnecessary_overrides
   int get hashCode => super.hashCode;
 }
 
 /// An event fired when an error occured while operating the camera.
 class CameraErrorEvent extends CameraEvent {
-  /// Description of the error.
-  final String description;
-
   /// Build a CameraError event triggered from the camera represented by
   /// `cameraId`.
   ///
   /// The `description` represents the error occured on the camera.
-  CameraErrorEvent(int cameraId, this.description) : super(cameraId);
+  const CameraErrorEvent(int cameraId, this.description) : super(cameraId);
 
   /// Converts the supplied [Map] to an instance of the [CameraErrorEvent]
   /// class.
   CameraErrorEvent.fromJson(Map<String, dynamic> json)
-      : description = json['description'],
-        super(json['cameraId']);
+      : description = json['description']! as String,
+        super(json['cameraId']! as int);
+
+  /// Description of the error.
+  final String description;
 
   /// Converts the [CameraErrorEvent] instance into a [Map] instance that can be
   /// serialized to JSON.
-  Map<String, dynamic> toJson() => {
+  Map<String, dynamic> toJson() => <String, Object>{
         'cameraId': cameraId,
         'description': description,
       };
 
   @override
   bool operator ==(Object other) =>
       identical(this, other) ||
-      super == (other) &&
+      super == other &&
           other is CameraErrorEvent &&
           runtimeType == other.runtimeType &&
           description == other.description;
@@ -238,32 +244,32 @@ class CameraErrorEvent extends CameraEvent {
 
 /// An event fired when a video has finished recording.
 class VideoRecordedEvent extends CameraEvent {
-  /// XFile of the recorded video.
-  final XFile file;
-
-  /// Maximum duration of the recorded video.
-  final Duration? maxVideoDuration;
-
   /// Build a VideoRecordedEvent triggered from the camera with the `cameraId`.
   ///
   /// The `file` represents the file of the video.
   /// The `maxVideoDuration` shows if a maxVideoDuration shows if a maximum
   /// video duration was set.
-  VideoRecordedEvent(int cameraId, this.file, this.maxVideoDuration)
+  const VideoRecordedEvent(int cameraId, this.file, this.maxVideoDuration)
       : super(cameraId);
 
   /// Converts the supplied [Map] to an instance of the [VideoRecordedEvent]
   /// class.
   VideoRecordedEvent.fromJson(Map<String, dynamic> json)
-      : file = XFile(json['path']),
+      : file = XFile(json['path']! as String),
         maxVideoDuration = json['maxVideoDuration'] != null
             ? Duration(milliseconds: json['maxVideoDuration'] as int)
             : null,
-        super(json['cameraId']);
+        super(json['cameraId']! as int);
+
+  /// XFile of the recorded video.
+  final XFile file;
+
+  /// Maximum duration of the recorded video.
+  final Duration? maxVideoDuration;
 
   /// Converts the [VideoRecordedEvent] instance into a [Map] instance that can be
   /// serialized to JSON.
-  Map<String, dynamic> toJson() => {
+  Map<String, dynamic> toJson() => <String, Object?>{
         'cameraId': cameraId,
         'path': file.path,
         'maxVideoDuration': maxVideoDuration?.inMilliseconds

packages/camera/camera_platform_interface/lib/src/events/camera_event.dart

@@ -4,6 +4,7 @@
 
 import 'package:camera_platform_interface/src/utils/utils.dart';
 import 'package:flutter/services.dart';
+import 'package:meta/meta.dart';
 
 /// Generic Event coming from the native side of Camera,
 /// not related to a specific camera module.
@@ -18,24 +19,29 @@ import 'package:flutter/services.dart';
 /// See below for examples: `DeviceOrientationChangedEvent`...
 /// These events are more semantic and more pleasant to use than raw generics.
 /// They can be (and in fact, are) filtered by the `instanceof`-operator.
-abstract class DeviceEvent {}
+@immutable
+abstract class DeviceEvent {
+  /// Creates a new device event.
+  const DeviceEvent();
+}
 
 /// The [DeviceOrientationChangedEvent] is fired every time the orientation of the device UI changes.
 class DeviceOrientationChangedEvent extends DeviceEvent {
-  /// The new orientation of the device
-  final DeviceOrientation orientation;
-
   /// Build a new orientation changed event.
-  DeviceOrientationChangedEvent(this.orientation);
+  const DeviceOrientationChangedEvent(this.orientation);
 
   /// Converts the supplied [Map] to an instance of the [DeviceOrientationChangedEvent]
   /// class.
   DeviceOrientationChangedEvent.fromJson(Map<String, dynamic> json)
-      : orientation = deserializeDeviceOrientation(json['orientation']);
+      : orientation =
+            deserializeDeviceOrientation(json['orientation']! as String);
+
+  /// The new orientation of the device
+  final DeviceOrientation orientation;
 
   /// Converts the [DeviceOrientationChangedEvent] instance into a [Map] instance that
   /// can be serialized to JSON.
-  Map<String, dynamic> toJson() => {
+  Map<String, dynamic> toJson() => <String, Object>{
         'orientation': serializeDeviceOrientation(orientation),
       };