Refactored localization (#164)

* Refactored localization

- Created feature localizations
- Created Delegates
- Refactored folder structure a bit

* Fixed issue caused by dart-lang/build/issues/2835

* Fixed issue by creating typedef

.gitignore

@@ -133,6 +133,7 @@ build/
 # Codegen 
 *.*.dart
 generated_*
+lib/src/core/localization/generated/
 
 pubspec.lock
 .metadata

analysis_options.yaml

@@ -1 +1,5 @@
-include: package:sizzle_lints/sizzle_lints.yaml
+include: package:sizzle_lints/sizzle_lints.yaml
+
+analyzer: 
+  exclude: 
+    - "lib/src/core/localization/generated/**"

l10n.yaml

@@ -1,3 +1,7 @@
-arb-dir: lib/src/core/localization
+arb-dir: lib/src/core/localization/translations
 template-arb-file: app_en.arb
-output-localization-file: app_localizations.dart
+output-localization-file: generated_localizations.dart
+output-class: GeneratedLocalizations
+nullable-getter: false
+# output-dir: lib/src/core/localization/generated
+# synthetic-package: false

lib/runner_io.dart

@@ -1,5 +1,5 @@
 import 'package:sizzle_starter/runner_shared.dart';
-import 'package:sizzle_starter/src/core/model/initialization_hook.dart';
+import 'package:sizzle_starter/src/feature/initialization/model/initialization_hook.dart';
 
 // I\O runner
 Future<void> run() async {

lib/runner_shared.dart

@@ -2,9 +2,9 @@ import 'dart:async';
 
 import 'package:flutter/foundation.dart';
 import 'package:flutter/material.dart';
-import 'package:sizzle_starter/src/core/model/initialization_hook.dart';
 import 'package:sizzle_starter/src/core/utils/logger.dart';
 import 'package:sizzle_starter/src/feature/app/logic/app_runner.dart' as blaze;
+import 'package:sizzle_starter/src/feature/initialization/model/initialization_hook.dart';
 
 /// Run that uses all platforms
 void sharedRun(InitializationHook hook) {

lib/runner_web.dart

@@ -1,5 +1,5 @@
 import 'package:sizzle_starter/runner_shared.dart';
-import 'package:sizzle_starter/src/core/model/initialization_hook.dart';
+import 'package:sizzle_starter/src/feature/initialization/model/initialization_hook.dart';
 
 // Web runner
 Future<void> run() async {

lib/src/core/data/rest_client.dart

@@ -4,7 +4,7 @@ import 'package:http/http.dart' as http;
 import 'package:meta/meta.dart';
 import 'package:path/path.dart' as p;
 import 'package:platform_info/platform_info.dart' as info;
-import 'package:sizzle_starter/src/core/exception/network_exception.dart';
+import 'package:sizzle_starter/src/core/utils/exception/network_exception.dart';
 
 @immutable
 class RestClient {

lib/src/core/localization/app_localization.dart

@@ -1,16 +1,39 @@
 import 'package:flutter/material.dart';
-import 'package:flutter_gen/gen_l10n/app_localizations.dart';
+import 'package:flutter_gen/gen_l10n/generated_localizations.dart';
+import 'package:sizzle_starter/src/core/localization/localization_delegate.dart';
+import 'package:sizzle_starter/src/feature/sample/localization/sample_localization_delegate.dart';
+
+typedef GeneratedLocalization = GeneratedLocalizations;
 
 /// A class which is responsible for providing the localization.
 ///
-/// [AppLocalization] is a wrapper around [AppLocalizations].
-///
+/// [AppLocalization] is a wrapper around [GeneratedLocalizations].
 class AppLocalization {
   AppLocalization._();
 
-  static AppLocalizations of(BuildContext context) => AppLocalizations.of(context)!;
+  /// All the supported locales
+  ///
+  /// SSOT - arb files
+  static const supportedLocales = GeneratedLocalizations.supportedLocales;
+
+  /// All the localizations delegates
+  static final localizationsDelegates = <LocalizationsDelegate<dynamic>>[
+    ...GeneratedLocalizations.localizationsDelegates,
+    ...featureDelegates,
+  ];
+
+  /// Feature localization delegates
+  static final featureDelegates = <LocalizationDelegate<Object>>[
+    SampleLocalizationDelegate(),
+  ];
+
+  /// Returns the localized strings for the given [context].
+  static T stringOf<T>(BuildContext context) => Localizations.of<T>(context, T)!;
 
-  static const supportedLocales = AppLocalizations.supportedLocales;
+  /// Returns the current locale of the [context].
+  static Locale? localeOf(BuildContext context) => Localizations.localeOf(context);
 
-  static const localizationsDelegates = AppLocalizations.localizationsDelegates;
+  /// Loads the [locale].
+  static Future<GeneratedLocalizations> load(Locale locale) =>
+      GeneratedLocalizations.delegate.load(locale);
 }

lib/src/core/localization/localization_delegate.dart

@@ -0,0 +1,20 @@
+import 'package:flutter/material.dart';
+import 'package:sizzle_starter/src/core/localization/app_localization.dart';
+
+abstract class LocalizationDelegate<T> extends LocalizationsDelegate<T> {
+  LocalizationDelegate(this._delegateFactory);
+
+  final T Function(GeneratedLocalization appLocalizations) _delegateFactory;
+
+  @override
+  Future<T> load(Locale locale) async {
+    final appLocalizations = await GeneratedLocalization.delegate.load(locale);
+    return _delegateFactory(appLocalizations);
+  }
+
+  @override
+  bool shouldReload(covariant LocalizationsDelegate<T> old) => false;
+
+  @override
+  bool isSupported(Locale locale) => GeneratedLocalization.delegate.isSupported(locale);
+}

lib/src/core/localization/translations/app_en.arb

@@ -0,0 +1,10 @@
+{
+  "appTitle": "sizzle_starter",
+  "@appTitle": {
+    "description": "The title of the application"
+  },
+  "samplePlaceholder": "Sample placeholder {value}",
+  "@samplePlaceholder": {
+    "description": "Sample placeholder"
+  }
+}

lib/src/core/localization/translations/app_es.arb

@@ -0,0 +1,10 @@
+{
+    "appTitle": "sizzle_starter",
+    "@appTitle": {
+        "description": "El título de la aplicación"
+    },
+    "samplePlaceholder": "Espacio reservado de muestra {value}",
+    "@samplePlaceholder": {
+        "description": "Espacio reservado de muestra"
+    }
+}

lib/src/core/router/router.dart

@@ -1,5 +1,4 @@
 import 'package:auto_route/auto_route.dart';
-import 'package:flutter/material.dart';
 import 'package:sizzle_starter/src/feature/sample/widget/sample_screen.dart';
 
 part 'router.gr.dart';

lib/src/core/utils/extensions/context_extension.dart

@@ -0,0 +1,5 @@
+import 'package:flutter/widgets.dart';
+
+extension LocalizationX on BuildContext {
+  T stringOf<T>() => Localizations.of<T>(this, T)!;
+}

lib/src/feature/app/logic/app_runner.dart

@@ -1,8 +1,8 @@
 import 'package:flutter/material.dart';
-import 'package:sizzle_starter/src/core/model/initialization_hook.dart';
 import 'package:sizzle_starter/src/feature/app/widget/app.dart';
 import 'package:sizzle_starter/src/feature/initialization/logic/initialization_processor.dart';
 import 'package:sizzle_starter/src/feature/initialization/logic/initialization_steps.dart';
+import 'package:sizzle_starter/src/feature/initialization/model/initialization_hook.dart';
 
 /// A class which is responsible for initialization and running the app.
 class AppRunner with InitializationSteps, InitializationProcessor, InitializationFactoryImpl {

lib/src/feature/app/widget/app_context.dart

@@ -16,6 +16,7 @@ class AppContext extends StatelessWidget {
       localizationsDelegates: AppLocalization.localizationsDelegates,
       theme: lightThemeData,
       darkTheme: darkThemeData,
+      locale: const Locale('es'),
     );
   }
 }

lib/src/feature/initialization/logic/initialization_processor.dart

@@ -1,8 +1,8 @@
 import 'package:flutter/foundation.dart';
-import 'package:sizzle_starter/src/core/model/environment_store.dart';
-import 'package:sizzle_starter/src/core/model/initialization_hook.dart';
 import 'package:sizzle_starter/src/feature/app/logic/tracking_manager.dart';
 import 'package:sizzle_starter/src/feature/initialization/logic/initialization_steps.dart';
+import 'package:sizzle_starter/src/feature/initialization/model/environment_store.dart';
+import 'package:sizzle_starter/src/feature/initialization/model/initialization_hook.dart';
 import 'package:sizzle_starter/src/feature/initialization/model/initialization_progress.dart';
 
 part 'initialization_factory.dart';

lib/src/core/model/environment_store.dart → lib/src/feature/initialization/model/environment_store.dart

@@ -1,4 +1,4 @@
-import 'package:sizzle_starter/src/core/model/enum/environment.dart';
+import 'package:sizzle_starter/src/feature/initialization/model/enum/environment.dart';
 
 abstract class IEnvironmentStore {
   abstract final Environment environment;

lib/src/feature/sample/localization/sample_localization_delegate.dart

@@ -0,0 +1,24 @@
+import 'package:sizzle_starter/src/core/localization/app_localization.dart';
+import 'package:sizzle_starter/src/core/localization/localization_delegate.dart';
+
+abstract class SampleStrings {
+  String get appTitle;
+
+  String samplePlaceholder(String value);
+}
+
+class SampleLocalizationDelegate extends LocalizationDelegate<SampleStrings> {
+  SampleLocalizationDelegate() : super(_SampleStringsImpl.new);
+}
+
+class _SampleStringsImpl implements SampleStrings {
+  _SampleStringsImpl(this._appLocalizations);
+
+  final GeneratedLocalization _appLocalizations;
+
+  @override
+  String get appTitle => _appLocalizations.appTitle;
+
+  @override
+  String samplePlaceholder(String value) => _appLocalizations.samplePlaceholder(value);
+}

lib/src/feature/sample/widget/sample_screen.dart

@@ -1,5 +1,7 @@
 import 'package:auto_route/auto_route.dart';
 import 'package:flutter/material.dart';
+import 'package:sizzle_starter/src/core/utils/extensions/context_extension.dart';
+import 'package:sizzle_starter/src/feature/sample/localization/sample_localization_delegate.dart';
 
 /// {@template sample_page}
 /// SamplePage widget
@@ -10,5 +12,16 @@ class SampleScreen extends StatelessWidget {
   const SampleScreen({super.key});
 
   @override
-  Widget build(BuildContext context) => const Placeholder();
-} // SamplePage
+  Widget build(BuildContext context) => Scaffold(
+        appBar: AppBar(
+          title: Text(context.stringOf<SampleStrings>().appTitle),
+        ),
+        body: Column(
+          children: [
+            Text(
+              context.stringOf<SampleStrings>().samplePlaceholder('Misha'),
+            ),
+          ],
+        ),
+      );
+}

test/unit/initialization_test.dart

@@ -1,9 +1,9 @@
 import 'package:flutter_test/flutter_test.dart';
 import 'package:shared_preferences/shared_preferences.dart';
-import 'package:sizzle_starter/src/core/model/initialization_hook.dart';
 import 'package:sizzle_starter/src/core/router/router.dart';
 import 'package:sizzle_starter/src/feature/initialization/logic/initialization_processor.dart';
 import 'package:sizzle_starter/src/feature/initialization/logic/initialization_steps.dart';
+import 'package:sizzle_starter/src/feature/initialization/model/initialization_hook.dart';
 
 void main() {
   group('Initialization Processor >', () {

test/unit/rest_client_test.dart

@@ -4,7 +4,7 @@ import 'package:flutter_test/flutter_test.dart';
 import 'package:http/http.dart' as http;
 import 'package:http/testing.dart';
 import 'package:sizzle_starter/src/core/data/rest_client.dart';
-import 'package:sizzle_starter/src/core/exception/network_exception.dart';
+import 'package:sizzle_starter/src/core/utils/exception/network_exception.dart';
 
 void main() {
   group(