[federated_plugin] adds platform interface implementation and plugin implementation for Android (#503)

2025-11-10 14:58:34 +00:00 · 2020-07-29 09:17:36 +05:30
parent 3bc860f5df
commit 6d909874db
19 changed files with 622 additions and 101 deletions
--- a/experimental/federated_plugin/federated_plugin_platform_interface/.gitignore
+++ b/experimental/federated_plugin/federated_plugin_platform_interface/.gitignore
@@ -0,0 +1,75 @@
+# Miscellaneous
+*.class
+*.log
+*.pyc
+*.swp
+.DS_Store
+.atom/
+.buildlog/
+.history
+.svn/
+
+# IntelliJ related
+*.iml
+*.ipr
+*.iws
+.idea/
+
+# The .vscode folder contains launch configuration and tasks you configure in
+# VS Code which you may wish to be included in version control, so this line
+# is commented out by default.
+#.vscode/
+
+# Flutter/Dart/Pub related
+**/doc/api/
+.dart_tool/
+.flutter-plugins
+.flutter-plugins-dependencies
+.packages
+.pub-cache/
+.pub/
+build/
+
+# Android related
+**/android/**/gradle-wrapper.jar
+**/android/.gradle
+**/android/captures/
+**/android/gradlew
+**/android/gradlew.bat
+**/android/local.properties
+**/android/**/GeneratedPluginRegistrant.java
+
+# iOS/XCode related
+**/ios/**/*.mode1v3
+**/ios/**/*.mode2v3
+**/ios/**/*.moved-aside
+**/ios/**/*.pbxuser
+**/ios/**/*.perspectivev3
+**/ios/**/*sync/
+**/ios/**/.sconsign.dblite
+**/ios/**/.tags*
+**/ios/**/.vagrant/
+**/ios/**/DerivedData/
+**/ios/**/Icon?
+**/ios/**/Pods/
+**/ios/**/.symlinks/
+**/ios/**/profile
+**/ios/**/xcuserdata
+**/ios/.generated/
+**/ios/Flutter/App.framework
+**/ios/Flutter/Flutter.framework
+**/ios/Flutter/Flutter.podspec
+**/ios/Flutter/Generated.xcconfig
+**/ios/Flutter/app.flx
+**/ios/Flutter/app.zip
+**/ios/Flutter/flutter_assets/
+**/ios/Flutter/flutter_export_environment.sh
+**/ios/ServiceDefinitions.json
+**/ios/Runner/GeneratedPluginRegistrant.*
+
+# Exceptions to above rules.
+!**/ios/**/default.mode1v3
+!**/ios/**/default.mode2v3
+!**/ios/**/default.pbxuser
+!**/ios/**/default.perspectivev3
+!/packages/flutter_tools/test/data/dart_dependencies_test/**/.packages
--- a/experimental/federated_plugin/federated_plugin_platform_interface/.metadata
+++ b/experimental/federated_plugin/federated_plugin_platform_interface/.metadata
@@ -0,0 +1,10 @@
+# This file tracks properties of this Flutter project.
+# Used by Flutter tool to assess capabilities and perform upgrades etc.
+#
+# This file should be version controlled and should not be manually edited.
+
+version:
+  revision: 8bd2e6585b0eda5ccdc10c1e1d35105e11f84424
+  channel: master
+
+project_type: package
--- a/experimental/federated_plugin/federated_plugin_platform_interface/analysis_options.yaml
+++ b/experimental/federated_plugin/federated_plugin_platform_interface/analysis_options.yaml
@@ -0,0 +1,31 @@
+include: package:pedantic/analysis_options.yaml
+
+analyzer:
+  strong-mode:
+    implicit-casts: false
+    implicit-dynamic: false
+
+linter:
+  rules:
+    - avoid_types_on_closure_parameters
+    - avoid_void_async
+    - await_only_futures
+    - camel_case_types
+    - cancel_subscriptions
+    - close_sinks
+    - constant_identifier_names
+    - control_flow_in_finally
+    - directives_ordering
+    - empty_statements
+    - hash_and_equals
+    - implementation_imports
+    - non_constant_identifier_names
+    - package_api_docs
+    - package_names
+    - package_prefixed_library_names
+    - test_types_in_equals
+    - throw_in_finally
+    - unnecessary_brace_in_string_interps
+    - unnecessary_getters_setters
+    - unnecessary_new
+    - unnecessary_statements
--- a/experimental/federated_plugin/federated_plugin_platform_interface/lib/federated_plugin_platform_interface.dart
+++ b/experimental/federated_plugin/federated_plugin_platform_interface/lib/federated_plugin_platform_interface.dart
@@ -0,0 +1,31 @@
+// Copyright 2020 The Flutter team. 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:federated_plugin_platform_interface/location_method_channel.dart';
+import 'package:federated_plugin_platform_interface/location_model.dart';
+import 'package:plugin_platform_interface/plugin_platform_interface.dart';
+
+/// Interface which allows all the platform plugins to implement the same
+/// functionality.
+abstract class FederatedPluginInterface extends PlatformInterface {
+  FederatedPluginInterface() : super(token: _object);
+
+  static FederatedPluginInterface _federatedPluginInterface =
+      LocationMethodChannel();
+
+  static final Object _object = Object();
+
+  /// Provides instance of [LocationMethodChannel] to invoke platform calls.
+  static FederatedPluginInterface get instance => _federatedPluginInterface;
+
+  static set instance(FederatedPluginInterface instance) {
+    PlatformInterface.verifyToken(instance, _object);
+    _federatedPluginInterface = instance;
+  }
+
+  /// Returns [Location] to provide latitude and longitude.
+  Future<Location> getLocation() async {
+    throw UnimplementedError('getLocation() has not been implemented.');
+  }
+}
--- a/experimental/federated_plugin/federated_plugin_platform_interface/lib/location_method_channel.dart
+++ b/experimental/federated_plugin/federated_plugin_platform_interface/lib/location_method_channel.dart
@@ -0,0 +1,24 @@
+// Copyright 2020 The Flutter team. 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:federated_plugin_platform_interface/federated_plugin_platform_interface.dart';
+import 'package:federated_plugin_platform_interface/location_model.dart';
+import 'package:flutter/services.dart';
+
+/// Implements [FederatedPluginInterface] using [MethodChannel] to fetch
+/// location from platform.
+class LocationMethodChannel extends FederatedPluginInterface {
+  static const MethodChannel _methodChannel = MethodChannel('location');
+
+  @override
+  Future<Location> getLocation() async {
+    final result =
+        await _methodChannel.invokeMethod<List<dynamic>>('getLocation');
+
+    return Location(
+      longitude: result.first as double,
+      latitude: result.last as double,
+    );
+  }
+}
--- a/experimental/federated_plugin/federated_plugin_platform_interface/lib/location_model.dart
+++ b/experimental/federated_plugin/federated_plugin_platform_interface/lib/location_model.dart
@@ -0,0 +1,11 @@
+// Copyright 2020 The Flutter team. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+/// Model to hold the incoming latitude and longitude values from platform.
+class Location {
+  final double latitude;
+  final double longitude;
+
+  Location({this.latitude, this.longitude});
+}
--- a/experimental/federated_plugin/federated_plugin_platform_interface/pubspec.lock
+++ b/experimental/federated_plugin/federated_plugin_platform_interface/pubspec.lock
@@ -0,0 +1,161 @@
+# Generated by pub
+# See https://dart.dev/tools/pub/glossary#lockfile
+packages:
+  async:
+    dependency: transitive
+    description:
+      name: async
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "2.4.2"
+  boolean_selector:
+    dependency: transitive
+    description:
+      name: boolean_selector
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "2.0.0"
+  characters:
+    dependency: transitive
+    description:
+      name: characters
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "1.1.0-nullsafety"
+  charcode:
+    dependency: transitive
+    description:
+      name: charcode
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "1.1.3"
+  clock:
+    dependency: transitive
+    description:
+      name: clock
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "1.0.1"
+  collection:
+    dependency: transitive
+    description:
+      name: collection
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "1.15.0-nullsafety"
+  fake_async:
+    dependency: transitive
+    description:
+      name: fake_async
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "1.1.0"
+  flutter:
+    dependency: "direct main"
+    description: flutter
+    source: sdk
+    version: "0.0.0"
+  flutter_test:
+    dependency: "direct dev"
+    description: flutter
+    source: sdk
+    version: "0.0.0"
+  matcher:
+    dependency: transitive
+    description:
+      name: matcher
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "0.12.8"
+  meta:
+    dependency: transitive
+    description:
+      name: meta
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "1.3.0-nullsafety"
+  path:
+    dependency: transitive
+    description:
+      name: path
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "1.7.0"
+  pedantic:
+    dependency: "direct dev"
+    description:
+      name: pedantic
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "1.9.2"
+  plugin_platform_interface:
+    dependency: "direct main"
+    description:
+      name: plugin_platform_interface
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "1.0.2"
+  sky_engine:
+    dependency: transitive
+    description: flutter
+    source: sdk
+    version: "0.0.99"
+  source_span:
+    dependency: transitive
+    description:
+      name: source_span
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "1.7.0"
+  stack_trace:
+    dependency: transitive
+    description:
+      name: stack_trace
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "1.9.5"
+  stream_channel:
+    dependency: transitive
+    description:
+      name: stream_channel
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "2.0.0"
+  string_scanner:
+    dependency: transitive
+    description:
+      name: string_scanner
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "1.0.5"
+  term_glyph:
+    dependency: transitive
+    description:
+      name: term_glyph
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "1.1.0"
+  test_api:
+    dependency: transitive
+    description:
+      name: test_api
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "0.2.17"
+  typed_data:
+    dependency: transitive
+    description:
+      name: typed_data
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "1.3.0-nullsafety"
+  vector_math:
+    dependency: transitive
+    description:
+      name: vector_math
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "2.1.0-nullsafety"
+sdks:
+  dart: ">=2.9.0-18.0 <2.9.0"
+  flutter: ">=1.17.0 <2.0.0"
--- a/experimental/federated_plugin/federated_plugin_platform_interface/pubspec.yaml
+++ b/experimental/federated_plugin/federated_plugin_platform_interface/pubspec.yaml
@@ -0,0 +1,20 @@
+name: federated_plugin_platform_interface
+description: A new Flutter package project.
+version: 0.0.1
+author:
+homepage:
+publish_to: none
+
+environment:
+  sdk: ">=2.7.0 <3.0.0"
+  flutter: ">=1.17.0 <2.0.0"
+
+dependencies:
+  flutter:
+    sdk: flutter
+  plugin_platform_interface: ^1.0.2
+
+dev_dependencies:
+  flutter_test:
+    sdk: flutter
+  pedantic: ^1.9.0
--- a/experimental/federated_plugin/federated_plugin_platform_interface/test/federated_plugin_platform_interface_test.dart
+++ b/experimental/federated_plugin/federated_plugin_platform_interface/test/federated_plugin_platform_interface_test.dart
@@ -0,0 +1,28 @@
+// Copyright 2020 The Flutter team. 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:federated_plugin_platform_interface/location_method_channel.dart';
+import 'package:federated_plugin_platform_interface/location_model.dart';
+import 'package:flutter/services.dart';
+import 'package:flutter_test/flutter_test.dart';
+
+void main() {
+  TestWidgetsFlutterBinding.ensureInitialized();
+
+  group('MethodChannel test', () {
+    final location = Location(latitude: 1.0, longitude: 2.0);
+    MethodChannel('location').setMockMethodCallHandler((call) async {
+      if (call.method == 'getLocation') {
+        return [location.longitude, location.latitude];
+      }
+    });
+
+    test('getLocation method test', () async {
+      final locationMethodChannel = LocationMethodChannel();
+      final result = await locationMethodChannel.getLocation();
+      expect(result.longitude, location.longitude);
+      expect(result.latitude, result.latitude);
+    });
+  });
+}