Add file_selector_web

Author: tugorez

packages/file_selector/file_selector_web/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.7.0
+
+- Initial open-source release.

packages/file_selector/file_selector_web/LICENSE

@@ -0,0 +1,25 @@
+Copyright 2020 The Flutter Authors. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above
+      copyright notice, this list of conditions and the following
+      disclaimer in the documentation and/or other materials provided
+      with the distribution.
+    * Neither the name of Google Inc. nor the names of its
+      contributors may be used to endorse or promote products derived
+      from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

packages/file_selector/file_selector_web/README.md

@@ -0,0 +1,37 @@
+# file_picker_web
+
+The web implementation of [`file_picker`][1].
+
+**Please set your constraint to `file_picker_web: '>=0.1.y+x <2.0.0'`**
+
+## Backward compatible 1.0.0 version is coming
+The plugin has reached a stable API, we guarantee that version `1.0.0` will be backward compatible with `0.1.y+z`.
+Please use `file_picker_web: '>=0.1.y+x <2.0.0'` as your dependency constraint to allow a smoother ecosystem migration.
+For more details see: https://github.com/flutter/flutter/wiki/Package-migration-to-1.0.0
+
+## Usage
+
+### Import the package
+To use this plugin in your Flutter Web app, simply add it as a dependency in
+your pubspec alongside the base `file_picker` plugin.
+
+_(This is only temporary: in the future we hope to make this package an
+"endorsed" implementation of `file_picker`, so that it is automatically
+included in your Flutter Web app when you depend on `package:file_picker`.)_
+
+This is what the above means to your `pubspec.yaml`:
+
+```yaml
+...
+dependencies:
+  ...
+  file_picker: ^0.1.0
+  file_picker_web: ^0.1.0
+  ...
+```
+
+### Use the plugin
+Once you have the `file_picker_web` dependency in your pubspec, you should
+be able to use `package:file_picker` as normal.
+
+[1]: ../file_picker/file_picker

packages/file_selector/file_selector_web/lib/file_selector_web.dart

@@ -0,0 +1,139 @@
+import 'dart:async';
+import 'package:flutter/services.dart';
+import 'package:flutter_web_plugins/flutter_web_plugins.dart';
+import 'package:file_selector_platform_interface/file_selector_platform_interface.dart';
+import 'dart:html';
+
+/// The web implementation of [FileSelectorPlatform].
+///
+/// This class implements the `package:file_selector` functionality for the web.
+class FileSelectorWeb extends FileSelectorPlatform {
+  final _input = FileUploadInputElement();
+
+  /// Registers this class as the default instance of [FileSelectorPlatform].
+  static void registerWith(Registrar registrar) {
+    FileSelectorPlatform.instance = FileSelectorWeb();
+  }
+
+  /// Default constructor, initializes _container to a DOM element that we can use
+  /// to host HTML elements.
+  /// overrides parameter allows for testing to override functions
+  FileSelectorWeb() {
+    final body = querySelector('body');
+    final container =
+        querySelector('file-selector') ?? Element.tag('file-selector');
+    body.children.add(container);
+    container.children.add(_input);
+  }
+
+  /// Open file dialog for loading files and return a XFile
+  @override
+  Future<XFile> openFile({
+    List<XTypeGroup> acceptedTypeGroups,
+    String initialDirectory,
+    String confirmButtonText,
+  }) async {
+    final files = await _openFiles(acceptedTypeGroups: acceptedTypeGroups);
+    return files.first;
+  }
+
+  /// Open file dialog for loading files and return a XFile
+  @override
+  Future<List<XFile>> openFiles({
+    List<XTypeGroup> acceptedTypeGroups,
+    String initialDirectory,
+    String confirmButtonText,
+  }) async {
+    return _openFiles(acceptedTypeGroups: acceptedTypeGroups, multiple: true);
+  }
+
+  @override
+  Future<String> getSavePath({
+    List<XTypeGroup> acceptedTypeGroups,
+    String initialDirectory,
+    String suggestedName,
+    String confirmButtonText,
+  }) async =>
+      null;
+
+  @override
+  Future<String> getDirectoryPath({
+    String initialDirectory,
+    String confirmButtonText,
+  }) async =>
+      null;
+
+  Future<List<XFile>> _openFiles({
+    List<XTypeGroup> acceptedTypeGroups,
+    bool multiple = false,
+  }) async {
+    final accept = _acceptedTypesToString(acceptedTypeGroups);
+    _input.accept = accept;
+    _input.multiple = multiple;
+    return _getFiles(_input);
+  }
+
+  /// For a given input, returns the files selected by an user.
+  static Future<List<XFile>> _getFiles(FileUploadInputElement input) {
+    final Completer<List<XFile>> _completer = Completer();
+
+    input.onChange.first.then((_) {
+      final List<XFile> files = input.files.map(_convertFileToXFile).toList();
+      _completer.complete(files);
+    });
+
+    input.onError.first.then((event) {
+      final ErrorEvent error = event;
+      final platformException = PlatformException(
+        code: error.type,
+        message: error.message,
+      );
+      _completer.completeError(platformException);
+    });
+
+    input.click();
+
+    return _completer.future;
+  }
+
+  /// Helper to convert an html.File to an XFile
+  static XFile _convertFileToXFile(File file) => XFile(
+        Url.createObjectUrl(file),
+        name: file.name,
+        length: file.size,
+        lastModified: DateTime.fromMillisecondsSinceEpoch(file.lastModified),
+      );
+
+  /// Convert list of XTypeGroups to a comma-separated string
+  static String _acceptedTypesToString(List<XTypeGroup> acceptedTypes) {
+    if (acceptedTypes == null) return '';
+    final List<String> allTypes = [];
+    for (final group in acceptedTypes) {
+      _assertTypeGroupIsValid(group);
+      if (group.extensions != null) {
+        allTypes.addAll(group.extensions.map(_normalizeExtension));
+      }
+      if (group.mimeTypes != null) {
+        allTypes.addAll(group.mimeTypes);
+      }
+      if (group.webWildCards != null) {
+        allTypes.addAll(group.webWildCards);
+      }
+    }
+    return allTypes.join(',');
+  }
+
+  /// Make sure that at least one of its fields is populated.
+  static void _assertTypeGroupIsValid(XTypeGroup group) {
+    assert(
+        !((group.extensions == null || group.extensions.isEmpty) &&
+            (group.mimeTypes == null || group.mimeTypes.isEmpty) &&
+            (group.webWildCards == null || group.webWildCards.isEmpty)),
+        'At least one of extensions / mimeTypes / webWildCards is required for web.');
+  }
+
+  /// Append a dot at the beggining if it is not there png -> .png
+  static String _normalizeExtension(String ext) {
+    return ext.isNotEmpty && ext[0] != '.' ? '.' + ext : ext;
+  }
+}

packages/file_selector/file_selector_web/pubspec.yaml

@@ -0,0 +1,31 @@
+name: file_selector_web
+description: Web platform implementation of file_selector
+homepage: https://github.com/flutter/plugins/tree/master/packages/file_selector/file_selector_web
+version: 0.7.0
+
+flutter:
+  plugin:
+    platforms:
+      web:
+        pluginClass: FileSelectorWeb
+        fileName: file_selector_web.dart
+
+dependencies:
+  file_selector_platform_interface: ^1.0.0
+  platform_detect: ^1.4.0
+  flutter:
+    sdk: flutter
+  flutter_web_plugins:
+    sdk: flutter
+  meta: ^1.1.7
+
+dev_dependencies:
+  flutter_test:
+    sdk: flutter
+  pedantic: ^1.8.0
+  integration_test:
+    path: ../../integration_test
+
+environment:
+  sdk: ">=2.2.0 <3.0.0"
+  flutter: ">=1.10.0 <2.0.0"

packages/file_selector/file_selector_web/test/lib/main.dart

@@ -0,0 +1,22 @@
+// Copyright 2013 The Flutter Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+import 'package:flutter/material.dart';
+
+void main() {
+  runApp(MyApp());
+}
+
+/// App for testing
+class MyApp extends StatefulWidget {
+  @override
+  _MyAppState createState() => _MyAppState();
+}
+
+class _MyAppState extends State<MyApp> {
+  @override
+  Widget build(BuildContext context) {
+    return Text('Testing... Look at the console output for results!');
+  }
+}

packages/file_selector/file_selector_web/test/pubspec.yaml

@@ -0,0 +1,18 @@
+name: file_selector_web_tests
+publish_to: none
+
+environment:
+  sdk: ">=2.2.2 <3.0.0"
+
+dependencies:
+  flutter:
+    sdk: flutter
+  flutter_driver:
+    sdk: flutter
+  flutter_test:
+    sdk: flutter
+  mockito: ^4.1.1
+  integration_test:
+    path: ../../../integration_test
+  file_selector_web:
+    path: ../

packages/file_selector/file_selector_web/test/run_test

@@ -0,0 +1,17 @@
+#!/usr/bin/bash
+if pgrep -lf chromedriver > /dev/null; then
+  echo "chromedriver is running."
+
+  if [ $# -eq 0 ]; then
+    echo "No target specified, running all tests..."
+    find test_driver/ -iname *_integration.dart | xargs -n1 -i -t flutter drive -d web-server --web-port=7357 --browser-name=chrome --target='{}'
+  else
+    echo "Running test target: $1..."
+    set -x
+    flutter drive -d web-server --web-port=7357 --browser-name=chrome --target=$1
+  fi
+
+  else
+    echo "chromedriver is not running."
+fi
+

packages/file_selector/file_selector_web/test/test_driver/file_selector_web_integration.dart

@@ -0,0 +1,97 @@
+// Copyright 2020 The Flutter Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+// @dart = 2.9
+
+import 'dart:html';
+import 'package:flutter_test/flutter_test.dart';
+import 'package:integration_test/integration_test.dart';
+import 'package:file_selector_platform_interface/file_selector_platform_interface.dart';
+import 'package:file_selector_web/file_selector_web.dart';
+
+FileList FileListItems(List<File> files) {
+  final dt = DataTransfer();
+  files.forEach((file) => dt.items.add(file));
+  return dt.files;
+}
+
+void main() {
+  group('FileSelectorWeb', () {
+    IntegrationTestWidgetsFlutterBinding.ensureInitialized();
+    FileSelectorWeb plugin;
+    FileUploadInputElement input;
+
+    setUp(() {
+      plugin = FileSelectorWeb();
+      input = querySelector('file-selector') as FileUploadInputElement;
+      assert(input != null);
+    });
+
+    group('openFile', () {
+      final mockFile = File(['random content'], 'image.png');
+
+      setUp(() {
+        input.files = FileListItems([mockFile]);
+      });
+
+      testWidgets('works', (WidgetTester _) async {
+        final typeGroup = XTypeGroup(
+          label: 'images',
+          extensions: ['jpg', 'jpeg'],
+          mimeTypes: ['image/png'],
+          webWildCards: ['image/*'],
+        );
+
+        final futureFile = plugin.openFile(acceptedTypeGroups: [typeGroup]);
+
+        //simulate a user has chosen a file
+        input.dispatchEvent(Event('change'));
+
+        final file = await futureFile;
+
+        expect(input.accept, '.jpg,.jpeg,image/png,image/*');
+        expect(input.multiple, false);
+        expect(file.name, mockFile.name);
+        expect(await file.length(), 14);
+        expect(await file.readAsString(), 'random content');
+        expect(await file.lastModified(), isNotNull);
+      });
+    });
+
+    group('openFiles', () {
+      final mockFile = File(['123456'], 'log.txt');
+
+      setUp(() {
+        input.files = FileListItems([mockFile]);
+      });
+
+      testWidgets('works', (WidgetTester _) async {
+        final txts = XTypeGroup(
+          label: 'txt',
+          mimeTypes: ['file/txt'],
+        );
+
+        final jsons = XTypeGroup(
+          label: 'JSON',
+          extensions: ['json'],
+        );
+
+        final futureFiles = plugin.openFiles(acceptedTypeGroups: [txts, jsons]);
+
+        //simulate a user has chosen a file
+        input.dispatchEvent(Event('change'));
+
+        final files = await futureFiles;
+
+        expect(input.accept, 'file/txt,.json');
+        expect(input.multiple, true);
+        expect(files.length, 1);
+        expect(files[0].name, 'log.txt');
+        expect(await files[0].length(), 6);
+        expect(await files[0].readAsString(), '123456');
+        expect(await files[0].lastModified(), isNotNull);
+      });
+    });
+  });
+}