Skip to content

Commit

Permalink
Add web url launcher (flutter#2119)
Browse files Browse the repository at this point in the history
* Move url_launcher to url_launcher/url_launcher

Add url_launcher_web package

Test plugins even if they don't have a pubspec in the top-level folder

Bump up the pubspec version for new homepage URL

Add dummy podspec file for iOS

Remove unused import

Format test

Update check_publish.sh script

* UPdate check_publish for federated plugins.

* Follow correct semver when bumping version

* Add some tests for `launch`

* Check if directory exists for CI
  • Loading branch information
Harry Terkelsen authored Oct 2, 2019
1 parent c3f07e7 commit 1d5301d
Show file tree
Hide file tree
Showing 71 changed files with 215 additions and 11 deletions.
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
## 5.1.5

* Update homepage url after moving to federated directory.

## 5.1.4

* Update and migrate iOS example project.
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ name: url_launcher
description: Flutter plugin for launching a URL on Android and iOS. Supports
web, phone, SMS, and email schemes.
author: Flutter Team <flutter-dev@googlegroups.com>
homepage: https://github.com/flutter/plugins/tree/master/packages/url_launcher
version: 5.1.4
homepage: https://github.com/flutter/plugins/tree/master/packages/url_launcher/url_launcher
version: 5.1.5

flutter:
plugin:
Expand Down
3 changes: 3 additions & 0 deletions packages/url_launcher/url_launcher_web/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# 0.0.1

- Initial open-source release.
27 changes: 27 additions & 0 deletions packages/url_launcher/url_launcher_web/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
// Copyright 2019 The Chromium 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.
24 changes: 24 additions & 0 deletions packages/url_launcher/url_launcher_web/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# url_launcher_web

The web implementation of [`url_launcher`][1].

## Usage

To use this plugin in your Flutter Web app, simply add it as a dependency in
your pubspec using a `git` dependency. This is only temporary: in the future
we hope to make this package an "endorsed" implementation of `url_launcher`,
so that it is automatically included in your Flutter Web app when you depend
on `package:url_launcher`.

```yaml
dependencies:
url_launcher: ^5.1.4
url_launcher_web:
git: git@github.com:flutter/plugins.git
path: packages/url_launcher/url_launcher_web
```
Once you have the `url_launcher_web` dependency in your pubspec, you should
be able to use `package:url_launcher` as normal.

[1]: ../url_launcher
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
#
# To learn more about a Podspec see http://guides.cocoapods.org/syntax/podspec.html
#
Pod::Spec.new do |s|
s.name = 'url_launcher_web'
s.version = '0.0.1'
s.summary = 'No-op implementation of url_launcher_web web plugin to avoid build issues on iOS'
s.description = <<-DESC
temp fake url_launcher_web plugin
DESC
s.homepage = 'https://github.com/flutter/plugins/tree/master/packages/url_launcher/url_launcher_web'
s.license = { :file => '../LICENSE' }
s.author = { 'Flutter Team' => 'flutter-dev@googlegroups.com' }
s.source = { :path => '.' }
s.source_files = 'Classes/**/*'
s.public_header_files = 'Classes/**/*.h'
s.dependency 'Flutter'

s.ios.deployment_target = '8.0'
end
49 changes: 49 additions & 0 deletions packages/url_launcher/url_launcher_web/lib/url_launcher_web.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
import 'dart:async';
import 'dart:html' as html;

import 'package:flutter/services.dart';
import 'package:flutter_web_plugins/flutter_web_plugins.dart';
import 'package:meta/meta.dart';

class UrlLauncherPlugin {
static void registerWith(Registrar registrar) {
final MethodChannel channel = MethodChannel(
'plugins.flutter.io/url_launcher',
const StandardMethodCodec(),
registrar.messenger);
final UrlLauncherPlugin instance = UrlLauncherPlugin();
channel.setMethodCallHandler(instance.handleMethodCall);
}

Future<dynamic> handleMethodCall(MethodCall call) async {
switch (call.method) {
case 'canLaunch':
final String url = call.arguments['url'];
return _canLaunch(url);
case 'launch':
final String url = call.arguments['url'];
return _launch(url);
default:
throw PlatformException(
code: 'Unimplemented',
details: "The url_launcher plugin for web doesn't implement "
"the method '${call.method}'");
}
}

bool _canLaunch(String url) {
final Uri parsedUrl = Uri.tryParse(url);
if (parsedUrl == null) return false;

return parsedUrl.isScheme('http') || parsedUrl.isScheme('https');
}

bool _launch(String url) {
return openNewWindow(url) != null;
}

@visibleForTesting
html.WindowBase openNewWindow(String url) {
return html.window.open(url, '');
}
}
29 changes: 29 additions & 0 deletions packages/url_launcher/url_launcher_web/pubspec.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: url_launcher_web
description: Web platform implementation of url_launcher
author: Flutter Team <flutter-dev@googlegroups.com>
homepage: https://github.com/flutter/plugins/tree/master/packages/url_launcher/url_launcher_web
version: 0.0.1

flutter:
plugin:
platforms:
web:
pluginClass: UrlLauncherPlugin
fileName: url_launcher_web.dart

dependencies:
flutter:
sdk: flutter
flutter_web_plugins:
sdk: flutter
meta: ^1.1.7

dev_dependencies:
flutter_test:
sdk: flutter
url_launcher:
path: ../url_launcher

environment:
sdk: ">=2.0.0-dev.28.0 <3.0.0"
flutter: ">=1.5.0 <2.0.0"
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
// Copyright 2019 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

@TestOn('chrome') // Uses web-only Flutter SDK

import 'dart:html' as html;

import 'package:flutter_test/flutter_test.dart';
import 'package:flutter_web_plugins/flutter_web_plugins.dart';
import 'package:url_launcher/url_launcher.dart';
import 'package:url_launcher_web/url_launcher_web.dart';

void main() {
group('URL Launcher for Web', () {
setUp(() {
TestWidgetsFlutterBinding.ensureInitialized();
webPluginRegistry.registerMessageHandler();
final Registrar registrar =
webPluginRegistry.registrarFor(UrlLauncherPlugin);
UrlLauncherPlugin.registerWith(registrar);
});

test('can launch "http" URLs', () {
expect(canLaunch('http://google.com'), completion(isTrue));
});

test('can launch "https" URLs', () {
expect(canLaunch('https://google.com'), completion(isTrue));
});

test('cannot launch "tel" URLs', () {
expect(canLaunch('tel:5551234567'), completion(isFalse));
});

test('launching a URL returns true', () {
expect(launch('https://www.google.com'), completion(isTrue));
});

test('the window that is launched is a new window', () {
final UrlLauncherPlugin urlLauncherPlugin = UrlLauncherPlugin();
final html.WindowBase newWindow =
urlLauncherPlugin.openNewWindow('https://www.google.com');
expect(newWindow, isNotNull);
expect(newWindow, isNot(equals(html.window)));
expect(newWindow.opener, equals(html.window));
});
});
}
10 changes: 5 additions & 5 deletions script/check_publish.sh
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ source "$SCRIPT_DIR/common.sh"

function check_publish() {
local failures=()
for package_name in "$@"; do
local dir="$REPO_DIR/packages/$package_name"
for dir in $(pub global run flutter_plugin_tools list --plugins="$1"); do
local package_name=$(basename "$dir")
echo "Checking that $package_name can be published."
if [[ $(cd "$dir" && cat pubspec.yaml | grep -E "^publish_to: none") ]]; then
echo "Package $package_name is marked as unpublishable. Skipping."
Expand All @@ -33,9 +33,9 @@ function check_publish() {
return "${#failures[@]}"
}

# Sets CHANGED_PACKAGE_LIST
# Sets CHANGED_PACKAGE_LIST and CHANGED_PACKAGES
check_changed_packages

if [[ "${#CHANGED_PACKAGE_LIST[@]}" != 0 ]]; then
check_publish "${CHANGED_PACKAGE_LIST[@]}"
fi
check_publish "${CHANGED_PACKAGES}"
fi
7 changes: 3 additions & 4 deletions script/common.sh
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,12 @@ function check_changed_packages() {
return 1
fi

# Filter out any packages that don't have a pubspec.yaml: they have probably
# been deleted in this PR. Also filter out `location_background` since it
# should be removed soon.
CHANGED_PACKAGES=""
CHANGED_PACKAGE_LIST=()

# Filter out packages that have been deleted.
for package in "${packages[@]}"; do
if [ -f "$REPO_DIR/packages/$package/pubspec.yaml" ] && [ $package != "location_background" ]; then
if [ -d "$REPO_DIR/packages/$package" ]; then
CHANGED_PACKAGES="${CHANGED_PACKAGES},$package"
CHANGED_PACKAGE_LIST=("${CHANGED_PACKAGE_LIST[@]}" "$package")
fi
Expand Down

0 comments on commit 1d5301d

Please sign in to comment.