override_test.dart 9.96 KB
Newer Older
1 2 3 4 5 6 7 8
// Copyright 2016 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.

import 'package:flutter/foundation.dart';
import 'package:flutter/material.dart';
import 'package:flutter_localizations/flutter_localizations.dart';
import 'package:flutter_test/flutter_test.dart';
9 10 11 12 13 14 15 16
import 'package:intl/intl.dart' as intl;

class FooMaterialLocalizations extends MaterialLocalizationEn {
  FooMaterialLocalizations(
    Locale localeName,
    this.backButtonTooltip,
  ) : super(
    localeName: localeName.toString(),
17 18 19 20 21 22
    fullYearFormat: intl.DateFormat.y(),
    mediumDateFormat: intl.DateFormat('E, MMM\u00a0d'),
    longDateFormat: intl.DateFormat.yMMMMEEEEd(),
    yearMonthFormat: intl.DateFormat.yMMMM(),
    decimalFormat: intl.NumberFormat.decimalPattern(),
    twoDigitZeroPaddedFormat: intl.NumberFormat('00'),
23
  );
24 25

  @override
26
  final String backButtonTooltip;
27 28 29
}

class FooMaterialLocalizationsDelegate extends LocalizationsDelegate<MaterialLocalizations> {
30
  const FooMaterialLocalizationsDelegate({
31
    this.supportedLanguage = 'en',
32
    this.backButtonTooltip = 'foo',
33 34 35 36 37 38 39
  });

  final String supportedLanguage;
  final String backButtonTooltip;

  @override
  bool isSupported(Locale locale) {
40
    return supportedLanguage == 'allLanguages' || locale.languageCode == supportedLanguage;
41
  }
42 43 44

  @override
  Future<FooMaterialLocalizations> load(Locale locale) {
45
    return SynchronousFuture<FooMaterialLocalizations>(FooMaterialLocalizations(locale, backButtonTooltip));
46 47 48 49 50 51 52 53
  }

  @override
  bool shouldReload(FooMaterialLocalizationsDelegate old) => false;
}

Widget buildFrame({
  Locale locale,
54
  Iterable<LocalizationsDelegate<dynamic>> delegates = GlobalMaterialLocalizations.delegates,
55 56
  WidgetBuilder buildContent,
  LocaleResolutionCallback localeResolutionCallback,
57
  Iterable<Locale> supportedLocales = const <Locale>[
58
    Locale('en', 'US'),
59
    Locale('es', 'ES'),
60 61
  ],
}) {
62
  return MaterialApp(
63 64 65 66 67 68
    color: const Color(0xFFFFFFFF),
    locale: locale,
    supportedLocales: supportedLocales,
    localizationsDelegates: delegates,
    localeResolutionCallback: localeResolutionCallback,
    onGenerateRoute: (RouteSettings settings) {
69
      return MaterialPageRoute<void>(
70 71 72 73 74 75 76 77 78 79
        builder: (BuildContext context) {
          return buildContent(context);
        }
      );
    },
  );
}

void main() {
  testWidgets('Locale fallbacks', (WidgetTester tester) async {
80
    final Key textKey = UniqueKey();
81 82 83 84

    await tester.pumpWidget(
      buildFrame(
        buildContent: (BuildContext context) {
85
          return Text(
86 87 88 89 90 91 92 93 94 95
            MaterialLocalizations.of(context).backButtonTooltip,
            key: textKey,
          );
        }
      )
    );

    expect(tester.widget<Text>(find.byKey(textKey)).data, 'Back');

    // Unrecognized locale falls back to 'en'
96
    await tester.binding.setLocale('foo', 'BAR');
97 98 99 100
    await tester.pump();
    expect(tester.widget<Text>(find.byKey(textKey)).data, 'Back');

    // Spanish Bolivia locale, falls back to just 'es'
101
    await tester.binding.setLocale('es', 'BO');
102
    await tester.pump();
103
    expect(tester.widget<Text>(find.byKey(textKey)).data, 'Atrás');
104 105 106 107 108 109
  });

  testWidgets('Localizations.override widget tracks parent\'s locale', (WidgetTester tester) async {
    Widget buildLocaleFrame(Locale locale) {
      return buildFrame(
        locale: locale,
110
        supportedLocales: <Locale>[locale],
111
        buildContent: (BuildContext context) {
112
          return Localizations.override(
113
            context: context,
114
            child: Builder(
115 116 117 118 119
              builder: (BuildContext context) {
                // No MaterialLocalizations are defined for the first Localizations
                // ancestor, so we should get the values from the default one, i.e.
                // the one created by WidgetsApp via the LocalizationsDelegate
                // provided by MaterialApp.
120
                return Text(MaterialLocalizations.of(context).backButtonTooltip);
121 122 123
              },
            ),
          );
124
        },
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142
      );
    }

    await tester.pumpWidget(buildLocaleFrame(const Locale('en', 'US')));
    expect(find.text('Back'), findsOneWidget);

    await tester.pumpWidget(buildLocaleFrame(const Locale('de', 'DE')));
    expect(find.text('Zurück'), findsOneWidget);

    await tester.pumpWidget(buildLocaleFrame(const Locale('zh', 'CN')));
    expect(find.text('返回'), findsOneWidget);
  });

  testWidgets('Localizations.override widget with hardwired locale', (WidgetTester tester) async {
    Widget buildLocaleFrame(Locale locale) {
      return buildFrame(
        locale: locale,
        buildContent: (BuildContext context) {
143
          return Localizations.override(
144 145
            context: context,
            locale: const Locale('en', 'US'),
146
            child: Builder(
147 148 149 150 151
              builder: (BuildContext context) {
                // No MaterialLocalizations are defined for the Localizations.override
                // ancestor, so we should get all values from the default one, i.e.
                // the one created by WidgetsApp via the LocalizationsDelegate
                // provided by MaterialApp.
152
                return Text(MaterialLocalizations.of(context).backButtonTooltip);
153 154 155
              },
            ),
          );
156
        },
157 158 159 160 161 162 163 164 165 166 167 168 169
      );
    }

    await tester.pumpWidget(buildLocaleFrame(const Locale('en', 'US')));
    expect(find.text('Back'), findsOneWidget);

    await tester.pumpWidget(buildLocaleFrame(const Locale('de', 'DE')));
    expect(find.text('Back'), findsOneWidget);

    await tester.pumpWidget(buildLocaleFrame(const Locale('zh', 'CN')));
    expect(find.text('Back'), findsOneWidget);
  });

170
  testWidgets('MaterialApp adds MaterialLocalizations for additional languages', (WidgetTester tester) async {
171
    final Key textKey = UniqueKey();
172 173 174 175 176 177 178 179

    await tester.pumpWidget(
      buildFrame(
        delegates: <FooMaterialLocalizationsDelegate>[
          const FooMaterialLocalizationsDelegate(supportedLanguage: 'fr', backButtonTooltip: 'FR'),
          const FooMaterialLocalizationsDelegate(supportedLanguage: 'de', backButtonTooltip: 'DE'),
        ],
        supportedLocales: const <Locale>[
180 181 182
          Locale('en'),
          Locale('fr'),
          Locale('de'),
183 184
        ],
        buildContent: (BuildContext context) {
185
          return Text(
186 187 188
            MaterialLocalizations.of(context).backButtonTooltip,
            key: textKey,
          );
189
        },
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
      )
    );

    expect(tester.widget<Text>(find.byKey(textKey)).data, 'Back');

    await tester.binding.setLocale('fr', 'CA');
    await tester.pump();
    expect(find.text('FR'), findsOneWidget);

    await tester.binding.setLocale('de', 'DE');
    await tester.pump();
    expect(find.text('DE'), findsOneWidget);
  });

  testWidgets('MaterialApp overrides MaterialLocalizations for all locales', (WidgetTester tester) async {
205
    final Key textKey = UniqueKey();
206 207 208 209 210 211

    await tester.pumpWidget(
      buildFrame(
        // Accept whatever locale we're given
        localeResolutionCallback: (Locale locale, Iterable<Locale> supportedLocales) => locale,
        delegates: <FooMaterialLocalizationsDelegate>[
212
          const FooMaterialLocalizationsDelegate(supportedLanguage: 'allLanguages'),
213 214 215
        ],
        buildContent: (BuildContext context) {
          // Should always be 'foo', no matter what the locale is
216
          return Text(
217 218 219
            MaterialLocalizations.of(context).backButtonTooltip,
            key: textKey,
          );
220
        },
221 222 223 224 225 226 227 228 229 230 231 232 233 234
      )
    );

    expect(tester.widget<Text>(find.byKey(textKey)).data, 'foo');

    await tester.binding.setLocale('zh', 'CN');
    await tester.pump();
    expect(find.text('foo'), findsOneWidget);

    await tester.binding.setLocale('de', 'DE');
    await tester.pump();
    expect(find.text('foo'), findsOneWidget);
  });

235
  testWidgets('MaterialApp overrides MaterialLocalizations for default locale', (WidgetTester tester) async {
236
    final Key textKey = UniqueKey();
237 238 239 240 241 242 243 244

    await tester.pumpWidget(
      buildFrame(
        delegates: <FooMaterialLocalizationsDelegate>[
          const FooMaterialLocalizationsDelegate(supportedLanguage: 'en'),
        ],
        // supportedLocales not specified, so all locales resolve to 'en'
        buildContent: (BuildContext context) {
245
          return Text(
246 247 248
            MaterialLocalizations.of(context).backButtonTooltip,
            key: textKey,
          );
249
        },
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
      )
    );

    // Unsupported locale '_' (the widget tester's default) resolves to 'en'.
    expect(tester.widget<Text>(find.byKey(textKey)).data, 'foo');

    // Unsupported locale 'zh' resolves to 'en'.
    await tester.binding.setLocale('zh', 'CN');
    await tester.pump();
    expect(find.text('foo'), findsOneWidget);

    // Unsupported locale 'de' resolves to 'en'.
    await tester.binding.setLocale('de', 'DE');
    await tester.pump();
    expect(find.text('foo'), findsOneWidget);
  });

267
  testWidgets('deprecated Android/Java locales are modernized', (WidgetTester tester) async {
268
    final Key textKey = UniqueKey();
269 270 271 272 273 274 275 276 277 278

    await tester.pumpWidget(
      buildFrame(
        supportedLocales: <Locale>[
          const Locale('en', 'US'),
          const Locale('he', 'IL'),
          const Locale('yi', 'IL'),
          const Locale('id', 'JV'),
        ],
        buildContent: (BuildContext context) {
279
          return Text(
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
            '${Localizations.localeOf(context)}',
            key: textKey,
          );
        },
      )
    );

    expect(tester.widget<Text>(find.byKey(textKey)).data, 'en_US');

    // Hebrew was iw (ISO-639) is he (ISO-639-1)
    await tester.binding.setLocale('iw', 'IL');
    await tester.pump();
    expect(tester.widget<Text>(find.byKey(textKey)).data, 'he_IL');

    // Yiddish was ji (ISO-639) is yi (ISO-639-1)
    await tester.binding.setLocale('ji', 'IL');
    await tester.pump();
    expect(tester.widget<Text>(find.byKey(textKey)).data, 'yi_IL');

    // Indonesian was in (ISO-639) is id (ISO-639-1)
    await tester.binding.setLocale('in', 'JV');
    await tester.pump();
    expect(tester.widget<Text>(find.byKey(textKey)).data, 'id_JV');
  });
}