feat: Adds supportedExtensions for decoders (#47)

* ✨ Adds `supportedExtensions` for decoders

* feat: update BaseDecoder

- Add` BaseDecoder.isSupportExtension` method
- Update `BaseDecoder.supportedExtensions`, use `@mustBeOverridden` replace abstract
- Add test for the extensions

Signed-off-by: Caijinglong <[email protected]>

* feat: Update version to 2.4.0

- Update version for pubspec
- Add changelog
- Add example for README

Signed-off-by: Caijinglong <[email protected]>

---------

Signed-off-by: Caijinglong <[email protected]>
Co-authored-by: Caijinglong <[email protected]>

Author: AlexV525

example/test/issue_027_test.dart

@@ -20,6 +20,9 @@ class MyJpegDecoder extends JpegDecoder {
   bool _checkHeader(List<int> bytes) {
     return bytes[0] == 0xFF && bytes[1] == 0xD8;
   }
+
+  @override
+  List<String> get supportedExtensions => JpegDecoder().supportedExtensions;
 }
 
 void main() {

packages/image_size_getter/CHANGELOG.md

@@ -1,6 +1,7 @@
 # CHANGELOG
 
 - [CHANGELOG](#changelog)
+  - [2.4.0](#240)
   - [2.3.0+1](#2301)
   - [2.3.0](#230)
   - [2.2.0](#220)
@@ -17,6 +18,10 @@
   - [0.1.1](#011)
   - [0.1.0](#010)
 
+## 2.4.0
+
+- Add `isSupportExtension` to `BaseDecoder`
+
 ## 2.3.0+1
 
 - Docs: Add docs for dartdoc.

packages/image_size_getter/README.md

@@ -103,6 +103,17 @@ If your data source is read asynchronously, consider using `AsyncImageInput`.
 
 A typical use case is [http_input][HttpInput].
 
+## Check the extension for decoder
+
+> Since 2.4.0
+
+```dart
+void checkExtension(String ext, BaseDecoder decoder) {
+  final isSupport = decoder.isSupportExtension(ext);
+  print('The decoder ${decoder.decoderName} support $ext: $isSupport');
+}
+```
+
 ## Custom
 
 We can implement our own input or decoder.

packages/image_size_getter/lib/src/decoder/decoder.dart

@@ -1,12 +1,11 @@
+import 'package:meta/meta.dart';
 import 'package:collection/collection.dart';
 import 'package:image_size_getter/image_size_getter.dart';
 
 /// {@template image_size_getter.BaseDecoder}
-///
 /// Base of the decoder.
 ///
 /// Implement this class to create a new decoder.
-///
 /// {@endtemplate}
 abstract class BaseDecoder {
   /// {@macro image_size_getter.BaseDecoder}
@@ -15,6 +14,31 @@ abstract class BaseDecoder {
   /// The name of the decoder.
   String get decoderName;
 
+  /// How many file extensions are supported with the decoder.
+  ///
+  /// The method must be overridden for each implementation.
+  ///
+  /// - See also: https://developer.mozilla.org/docs/Web/Media/Formats/Image_types
+  /// - See also: [isSupportExtension]
+  @mustBeOverridden
+  List<String> get supportedExtensions => [];
+
+  /// {@template image_size_getter.BaseDecoder.isSupportExtension}
+  ///
+  /// Returns the [extension] is support or not.
+  /// Ignore the case of letters.
+  ///
+  /// {@endtemplate}
+  bool isSupportExtension(String extension) {
+    for (final ext in supportedExtensions) {
+      // ignore the case.
+      if (ext.toLowerCase() == extension.toLowerCase()) {
+        return true;
+      }
+    }
+    return false;
+  }
+
   /// {@template image_size_getter.BaseDecoder.isValid}
   ///
   /// Returns the [input] is support or not.

packages/image_size_getter/lib/src/decoder/impl/bmp_decoder.dart

@@ -12,6 +12,9 @@ class BmpDecoder extends BaseDecoder {
   @override
   String get decoderName => 'bmp';
 
+  @override
+  List<String> get supportedExtensions => List.unmodifiable(['bmp']);
+
   @override
   Size getSize(ImageInput input) {
     final widthList = input.getRange(0x12, 0x16);

packages/image_size_getter/lib/src/decoder/impl/gif_decoder.dart

@@ -11,6 +11,9 @@ class GifDecoder extends BaseDecoder with MutilFileHeaderAndFooterValidator {
 
   String get decoderName => 'gif';
 
+  @override
+  List<String> get supportedExtensions => List.unmodifiable(['gif']);
+
   Size _getSize(List<int> widthList, List<int> heightList) {
     final width = convertRadix16ToInt(widthList, reverse: true);
     final height = convertRadix16ToInt(heightList, reverse: true);

packages/image_size_getter/lib/src/decoder/impl/jpeg_decoder.dart

@@ -14,9 +14,14 @@ class JpegDecoder extends BaseDecoder with SimpleTypeValidator {
   });
 
   final bool isStandardJpeg;
+
   @override
   String get decoderName => isStandardJpeg ? 'jpeg' : 'non-standard-jpeg';
 
+  @override
+  List<String> get supportedExtensions =>
+      List.unmodifiable(['jpg', 'jpeg', 'jfif', 'pjpeg', 'pjp']);
+
   @override
   Size getSize(ImageInput input) {
     int start = 2;

packages/image_size_getter/lib/src/decoder/impl/png_decoder.dart

@@ -12,6 +12,9 @@ class PngDecoder extends BaseDecoder with SimpleTypeValidator {
   @override
   String get decoderName => 'png';
 
+  @override
+  List<String> get supportedExtensions => List.unmodifiable(['png']);
+
   @override
   Size getSize(ImageInput input) {
     final widthList = input.getRange(0x10, 0x14);

packages/image_size_getter/lib/src/decoder/impl/webp_decoder.dart

@@ -13,6 +13,9 @@ class WebpDecoder extends BaseDecoder {
   @override
   String get decoderName => 'webp';
 
+  @override
+  List<String> get supportedExtensions => List.unmodifiable(['webp']);
+
   @override
   Size getSize(ImageInput input) {
     final chunkHeader = input.getRange(12, 16);

packages/image_size_getter/pubspec.yaml

@@ -1,6 +1,6 @@
 name: image_size_getter
 description: Get image width and height, the library does not completely decode the image file, just read the metadata to get the image width and height.
-version: 2.3.0+1
+version: 2.4.0
 homepage: https://github.com/CaiJingLong/dart_image_size_getter
 
 topics:

packages/image_size_getter/test/decoder_extension_test.dart

@@ -0,0 +1,53 @@
+import 'package:image_size_getter/image_size_getter.dart';
+import 'package:test/test.dart';
+
+void main() {
+  group('Test decoder extension', () {
+    test('Test gif decoder', () {
+      final GifDecoder decoder = GifDecoder();
+      expect(decoder.isSupportExtension('gif'), true);
+      expect(decoder.isSupportExtension('GIF'), true);
+
+      expect(decoder.isSupportExtension('jpg'), false);
+      expect(decoder.isSupportExtension('JPG'), false);
+    });
+
+    test('Test jpeg decoder', () {
+      final JpegDecoder decoder = JpegDecoder();
+      expect(decoder.isSupportExtension('jpg'), true);
+      expect(decoder.isSupportExtension('JPG'), true);
+      expect(decoder.isSupportExtension('jpeg'), true);
+      expect(decoder.isSupportExtension('JPEG'), true);
+
+      expect(decoder.isSupportExtension('gif'), false);
+      expect(decoder.isSupportExtension('GIF'), false);
+    });
+
+    test('Test png decoder', () {
+      final PngDecoder decoder = PngDecoder();
+      expect(decoder.isSupportExtension('png'), true);
+      expect(decoder.isSupportExtension('PNG'), true);
+
+      expect(decoder.isSupportExtension('jpg'), false);
+      expect(decoder.isSupportExtension('JPG'), false);
+    });
+
+    test('Test webp decoder', () {
+      final WebpDecoder decoder = WebpDecoder();
+      expect(decoder.isSupportExtension('webp'), true);
+      expect(decoder.isSupportExtension('WEBP'), true);
+
+      expect(decoder.isSupportExtension('jpg'), false);
+      expect(decoder.isSupportExtension('JPG'), false);
+    });
+
+    test('Test bmp decoder', () {
+      final BmpDecoder decoder = BmpDecoder();
+      expect(decoder.isSupportExtension('bmp'), true);
+      expect(decoder.isSupportExtension('BMP'), true);
+
+      expect(decoder.isSupportExtension('jpg'), false);
+      expect(decoder.isSupportExtension('JPG'), false);
+    });
+  });
+}

packages/image_size_getter_heic/lib/src/image_size_getter_heic_base.dart

@@ -35,6 +35,10 @@ class HeicDecoder extends BaseDecoder {
   @override
   String get decoderName => 'heic';
 
+  @override
+  List<String> get supportedExtensions =>
+      List.unmodifiable(['heic', 'heics', 'heif', 'heifs']);
+
   /// Extracts the size information from a HEIC image synchronously.
   ///
   /// This method parses the BMFF structure of the HEIC file to find the 'ispe' box

packages/image_size_getter_heic/test/image_size_getter_heic_test.dart

@@ -16,6 +16,16 @@ void main() {
       final asyncInput = AsyncImageInput.input(input);
       expect(decoder.isValidAsync(asyncInput), completion(equals(true)));
     });
+
+    test('extension', () {
+      expect(decoder.isSupportExtension('heic'), equals(true));
+      expect(decoder.isSupportExtension('HEIC'), equals(true));
+      expect(decoder.isSupportExtension('heif'), equals(true));
+      expect(decoder.isSupportExtension('HEIF'), equals(true));
+
+      expect(decoder.isSupportExtension('jpg'), equals(false));
+      expect(decoder.isSupportExtension('JPG'), equals(false));
+    });
   });
 
   group('Test get heic size', () {

packages/image_size_getter_http_input/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 2.1.0
+
+- Support library `2.4.0`.
+
 ## 2.0.1+1
 
 - Docs: Add docs for dartdoc.

packages/image_size_getter_http_input/pubspec.yaml

@@ -1,6 +1,6 @@
 name: image_size_getter_http_input
 description: A http input for image_size_getter.
-version: 2.0.1+1
+version: 2.1.0
 homepage: https://github.com/CaiJingLong/dart_image_size_getter/tree/master/image_size_getter_http_input
 # publish_to: https://pub.dev/
 
@@ -11,7 +11,7 @@ dependencies:
   http: ^1.0.0
   # image_size_getter:
   #   path: ../library
-  image_size_getter: ^2.0.0
+  image_size_getter: ^2.4.0
 #   path: ^1.8.0
 
 dev_dependencies: