Merge pull request #36 from Iconica-Development/feature/error_handling

feat: error handling
This commit is contained in:
mike doornenbal 2024-09-05 11:25:03 +02:00 committed by GitHub
commit d8e824191a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
9 changed files with 89 additions and 43 deletions

View file

@ -40,3 +40,11 @@
# 3.0.0 - February 22nd 2024 # 3.0.0 - February 22nd 2024
- Removed customButton from ImagePicker. - Removed customButton from ImagePicker.
# 4.0.0
* Added title options to theme.
* updated iconica_analysis dependency.
* Updated default theme.
# 4.1.0
* Added support for handling errors when calling `pickImage`.

View file

@ -11,7 +11,9 @@ void main() {
} }
class ImagePickerExample extends StatelessWidget { class ImagePickerExample extends StatelessWidget {
const ImagePickerExample({Key? key}) : super(key: key); const ImagePickerExample({
super.key,
});
@override @override
Widget build(BuildContext context) { Widget build(BuildContext context) {
@ -27,8 +29,10 @@ class ImagePickerExample extends StatelessWidget {
} }
class ImagePickerExampleHomePage extends StatefulWidget { class ImagePickerExampleHomePage extends StatefulWidget {
const ImagePickerExampleHomePage({Key? key, required this.title}) const ImagePickerExampleHomePage({
: super(key: key); required this.title,
super.key,
});
final String title; final String title;
@ -112,7 +116,13 @@ class ImagePickerExampleHomePageState
Uint8List? imageInBytes = await showModalBottomSheet<Uint8List?>( Uint8List? imageInBytes = await showModalBottomSheet<Uint8List?>(
context: context, context: context,
backgroundColor: Colors.white, backgroundColor: Colors.white,
builder: (BuildContext context) => const ImagePicker()); builder: (BuildContext context) => ImagePicker(
onError: (error) {
ScaffoldMessenger.of(context).showSnackBar(
SnackBar(content: Text(error.message ?? "An error occurred")),
);
},
));
if (imageInBytes != null) { if (imageInBytes != null) {
if (!listEquals(uploadedImage, imageInBytes)) { if (!listEquals(uploadedImage, imageInBytes)) {
setState(() { setState(() {

View file

@ -4,7 +4,7 @@
/// ///
library flutter_image_picker; library flutter_image_picker;
export 'src/models/image_picker_config.dart'; export "src/models/image_picker_config.dart";
export 'src/models/image_picker_theme.dart'; export "src/models/image_picker_theme.dart";
export 'src/services/image_picker_service.dart'; export "src/services/image_picker_service.dart";
export 'src/ui/image_picker.dart'; export "src/ui/image_picker.dart";

View file

@ -2,7 +2,7 @@
// //
// SPDX-License-Identifier: BSD-3-Clause // SPDX-License-Identifier: BSD-3-Clause
import 'package:flutter/material.dart'; import "package:flutter/material.dart";
class ImagePickerTheme { class ImagePickerTheme {
/// The [ImagePickerTheme] is used to style the [ImagePicker]. /// The [ImagePickerTheme] is used to style the [ImagePicker].
@ -12,11 +12,14 @@ class ImagePickerTheme {
this.iconSize = 125, this.iconSize = 125,
this.spaceBetweenIcons = 30, this.spaceBetweenIcons = 30,
this.makePhotoIcon, this.makePhotoIcon,
this.makePhotoText = 'Take a Picture', this.makePhotoText = "TAKE PICTURE",
this.selectImageIcon, this.selectImageIcon,
this.selectImageText = 'Select File', this.selectImageText = "UPLOAD FILE",
this.iconTextStyle, this.iconTextStyle,
this.closeButtonBuilder, this.closeButtonBuilder,
this.title = "Do you want to upload a file or take a picture?",
this.titleStyle,
this.titleAlignment = TextAlign.center,
}); });
/// The color of the icons /// The color of the icons
@ -45,5 +48,11 @@ class ImagePickerTheme {
final TextStyle? iconTextStyle; final TextStyle? iconTextStyle;
final Widget Function(Function onTap)? closeButtonBuilder; final Widget Function(Function() onTap)? closeButtonBuilder;
final String title;
final TextStyle? titleStyle;
final TextAlign titleAlignment;
} }

View file

@ -2,9 +2,9 @@
// //
// SPDX-License-Identifier: BSD-3-Clause // SPDX-License-Identifier: BSD-3-Clause
import 'dart:typed_data'; import "dart:typed_data";
import 'package:flutter_image_picker/src/models/image_picker_config.dart'; import "package:flutter_image_picker/src/models/image_picker_config.dart";
import 'package:image_picker/image_picker.dart'; import "package:image_picker/image_picker.dart";
/// The Image Picker Service class is the functionality of the Image Picker /// The Image Picker Service class is the functionality of the Image Picker
/// package which uses the Image Picker package to choose an image. /// package which uses the Image Picker package to choose an image.

View file

@ -2,9 +2,10 @@
// //
// SPDX-License-Identifier: BSD-3-Clause // SPDX-License-Identifier: BSD-3-Clause
import 'package:flutter/material.dart'; import "package:flutter/material.dart";
import 'package:flutter_image_picker/flutter_image_picker.dart'; import "package:flutter/services.dart";
import 'package:image_picker/image_picker.dart'; import "package:flutter_image_picker/flutter_image_picker.dart";
import "package:image_picker/image_picker.dart";
/// The Image Picker class generates the Image Picker Widget which can be /// The Image Picker class generates the Image Picker Widget which can be
/// displayed in your application. If you call the class you can give it 4 /// displayed in your application. If you call the class you can give it 4
@ -21,6 +22,7 @@ class ImagePicker extends StatelessWidget {
this.theme = const ImagePickerTheme(), this.theme = const ImagePickerTheme(),
this.config = const ImagePickerConfig(), this.config = const ImagePickerConfig(),
this.service, this.service,
this.onError,
super.key, super.key,
}); });
@ -36,10 +38,20 @@ class ImagePicker extends StatelessWidget {
/// add more features. If null the current implementation will be used. /// add more features. If null the current implementation will be used.
final ImagePickerService? service; final ImagePickerService? service;
final Function(PlatformException error)? onError;
@override @override
Widget build(BuildContext context) => SingleChildScrollView( Widget build(BuildContext context) => SingleChildScrollView(
child: Column( child: Column(
children: <Widget>[ children: <Widget>[
ListTile(
title: Text(
theme.title,
style:
theme.titleStyle ?? Theme.of(context).textTheme.titleMedium,
textAlign: theme.titleAlignment,
),
),
Row( Row(
mainAxisAlignment: MainAxisAlignment.center, mainAxisAlignment: MainAxisAlignment.center,
children: [ children: [
@ -50,6 +62,7 @@ class ImagePicker extends StatelessWidget {
Icons.image, Icons.image,
ImageSource.gallery, ImageSource.gallery,
theme.selectImageText, theme.selectImageText,
onError,
), ),
if (config.cameraOption ?? true) ...[ if (config.cameraOption ?? true) ...[
SizedBox( SizedBox(
@ -62,6 +75,7 @@ class ImagePicker extends StatelessWidget {
Icons.camera_alt_rounded, Icons.camera_alt_rounded,
ImageSource.camera, ImageSource.camera,
theme.makePhotoText, theme.makePhotoText,
onError,
), ),
], ],
], ],
@ -82,7 +96,7 @@ class ImagePicker extends StatelessWidget {
), ),
onPressed: () => Navigator.of(context).pop(), onPressed: () => Navigator.of(context).pop(),
child: const Text( child: const Text(
'Close', "Close",
style: TextStyle( style: TextStyle(
fontSize: 15, fontSize: 15,
color: Colors.white, color: Colors.white,
@ -117,6 +131,7 @@ class ImagePicker extends StatelessWidget {
IconData icon, IconData icon,
ImageSource imageSource, ImageSource imageSource,
String bottomText, String bottomText,
Function(PlatformException error)? onError,
) => ) =>
Column( Column(
mainAxisSize: MainAxisSize.min, mainAxisSize: MainAxisSize.min,
@ -125,8 +140,14 @@ class ImagePicker extends StatelessWidget {
key: Key(bottomText), key: Key(bottomText),
onTap: () async { onTap: () async {
var navigator = Navigator.of(context); var navigator = Navigator.of(context);
var image = await (service ?? ImagePickerServiceDefault()) Uint8List? image;
try {
image = await (service ?? ImagePickerServiceDefault())
.pickImage(imageSource, config: config); .pickImage(imageSource, config: config);
} on PlatformException catch (e) {
debugPrint("image_picker_error: $e");
onError?.call(e);
}
navigator.pop(image); navigator.pop(image);
}, },
child: customIcon ?? child: customIcon ??

View file

@ -1,6 +1,6 @@
name: flutter_image_picker name: flutter_image_picker
description: A Flutter Image Picking package. description: A Flutter Image Picking package.
version: 3.0.0 version: 4.1.0
repository: https://github.com/Iconica-Development/flutter_image_picker repository: https://github.com/Iconica-Development/flutter_image_picker
publish_to: https://forgejo.internal.iconica.nl/api/packages/internal/pub publish_to: https://forgejo.internal.iconica.nl/api/packages/internal/pub
@ -12,7 +12,7 @@ environment:
dependencies: dependencies:
flutter: flutter:
sdk: flutter sdk: flutter
image_picker: ^1.0.7 image_picker: ^1.1.2
dev_dependencies: dev_dependencies:
flutter_test: flutter_test:
@ -21,6 +21,4 @@ dev_dependencies:
flutter_iconica_analysis: flutter_iconica_analysis:
git: git:
url: https://github.com/Iconica-Development/flutter_iconica_analysis url: https://github.com/Iconica-Development/flutter_iconica_analysis
ref: 6.0.0 ref: 7.0.0
flutter:

View file

@ -2,22 +2,22 @@
// //
// SPDX-License-Identifier: BSD-3-Clause // SPDX-License-Identifier: BSD-3-Clause
import 'dart:typed_data'; import "dart:typed_data";
import 'package:flutter/material.dart'; import "package:flutter/material.dart";
import 'package:flutter_image_picker/flutter_image_picker.dart' import "package:flutter_image_picker/flutter_image_picker.dart"
as iconica_image_picker; as iconica_image_picker;
import 'package:flutter_test/flutter_test.dart'; import "package:flutter_test/flutter_test.dart";
import 'package:image_picker/image_picker.dart' as image_picker; import "package:image_picker/image_picker.dart" as image_picker;
import 'package:mocktail/mocktail.dart'; import "package:mocktail/mocktail.dart";
import 'mocks/image_picker_service_mock.dart'; import "mocks/image_picker_service_mock.dart";
void main() { void main() {
var cameraImage = Uint8List(10); var cameraImage = Uint8List(10);
var galleryImage = Uint8List(44); var galleryImage = Uint8List(44);
testWidgets('Image Picker Shows With Normal Theme', (tester) async { testWidgets("Image Picker Shows With Normal Theme", (tester) async {
await tester.pumpWidget( await tester.pumpWidget(
const MaterialApp( const MaterialApp(
home: Material( home: Material(
@ -32,7 +32,7 @@ void main() {
var selectImageIconFinder = find.byIcon(Icons.image); var selectImageIconFinder = find.byIcon(Icons.image);
var selectImageTextFinder = find var selectImageTextFinder = find
.text(const iconica_image_picker.ImagePickerTheme().selectImageText); .text(const iconica_image_picker.ImagePickerTheme().selectImageText);
var closebuttonTextFinder = find.text('Close'); var closebuttonTextFinder = find.text("Close");
expect(makePhotoIconFinder, findsOneWidget); expect(makePhotoIconFinder, findsOneWidget);
expect(makePhotoTextFinder, findsOneWidget); expect(makePhotoTextFinder, findsOneWidget);
@ -42,7 +42,7 @@ void main() {
}); });
testWidgets( testWidgets(
'Image Picker Calls Function Correctly When ImageSource Is Gallery', "Image Picker Calls Function Correctly When ImageSource Is Gallery",
(tester) async { (tester) async {
var serviceMock = ImagePickerServiceMock(); var serviceMock = ImagePickerServiceMock();
@ -70,7 +70,7 @@ void main() {
}); });
testWidgets( testWidgets(
'Image Picker Calls Function Correctly When ImageSource Is Camera', "Image Picker Calls Function Correctly When ImageSource Is Camera",
(tester) async { (tester) async {
var serviceMock = ImagePickerServiceMock(); var serviceMock = ImagePickerServiceMock();
@ -97,20 +97,20 @@ void main() {
.called(1); .called(1);
}); });
testWidgets('Image Picker Shows With Custom Theme', (tester) async { testWidgets("Image Picker Shows With Custom Theme", (tester) async {
Widget makePhotoIcon = Container( Widget makePhotoIcon = Container(
height: 125, height: 125,
width: 125, width: 125,
color: Colors.red, color: Colors.red,
); );
var makePhotoText = 'taaaake image'; var makePhotoText = "taaaake image";
Widget selectImageIcon = Container( Widget selectImageIcon = Container(
height: 125, height: 125,
width: 125, width: 125,
color: Colors.blue, color: Colors.blue,
); );
var selectImageText = 'seleeeeect image'; var selectImageText = "seleeeeect image";
var closeButtonText = 'Close'; var closeButtonText = "Close";
await tester.pumpWidget( await tester.pumpWidget(
MaterialApp( MaterialApp(

View file

@ -2,7 +2,7 @@
// //
// SPDX-License-Identifier: BSD-3-Clause // SPDX-License-Identifier: BSD-3-Clause
import 'package:flutter_image_picker/src/services/image_picker_service.dart'; import "package:flutter_image_picker/src/services/image_picker_service.dart";
import 'package:mocktail/mocktail.dart'; import "package:mocktail/mocktail.dart";
class ImagePickerServiceMock extends Mock implements ImagePickerService {} class ImagePickerServiceMock extends Mock implements ImagePickerService {}