Improving on HttpAssetLoader

.github/workflows/pr_check.yml

@@ -0,0 +1,11 @@
+name: PR Check
+
+on:
+  workflow_dispatch:
+  pull_request:
+
+jobs:
+  test:
+    name: Test
+    uses: ./.github/workflows/test.yml
+    secrets: inherit

.github/workflows/release.yml

@@ -0,0 +1,39 @@
+name: Release to pub.dev
+
+on:
+  workflow_dispatch:
+  push:
+    tags:
+      - 'v[0-9]+.[0-9]+.[0-9]+*'
+
+jobs:
+  test:
+    name: Test
+    uses: ./.github/workflows/test.yml
+    secrets: inherit
+
+  publish:
+    needs: [test]
+    name: Publish
+    permissions:
+      id-token: write # This is required for authentication using OIDC
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: dart-lang/setup-dart@v1
+
+      - uses: subosito/flutter-action@v2
+        with:
+          channel: "stable"
+
+      - name: Install dependencies
+        run: dart pub get
+
+      - name: code format
+        run: dart format lib/*/*.dart lib/*.dart
+
+      - name: Publish
+        run: dart pub publish --force

.github/workflows/test.yml

@@ -0,0 +1,29 @@
+name: Test
+
+on:
+  workflow_call:
+
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-java@v1
+      with:
+        java-version: '12.x'
+    - uses: subosito/flutter-action@v1
+      with:
+        channel: 'stable'
+
+    - name: Install packages dependencies
+      run: flutter pub get
+
+    - name: Analyze the project's Dart code
+      run: flutter analyze
+
+    - name: Run tests
+      run: flutter test
+
+    - name: Run tests coverage
+      run: flutter test --coverage

.gitignore

@@ -14,6 +14,7 @@
 *.ipr
 *.iws
 .idea/
+.vscode/
 
 # 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

CHANGELOG.md

@@ -1,3 +1,18 @@
-## [0.0.1]
+## 2.0.0
 
-- initial release
+- **BREAKING**: The local `AssetLoader` class deleted, now using the one from
+  [easy_localization](https://pub.dev/documentation/easy_localization/latest/easy_localization/AssetLoader-class.html) itself.
+- **BREAKING**: Depends on [connectivity_plus](https://pub.dev/packages/connectivity_plus) ^4.0.0
+  and [http](https://pub.dev/packages/http) ^1.0.0.
+- Const constructors in:
+  - `FileAssetLoader`
+  - `HttpAssetLoader`
+  - `JsonAssetLoader`
+  - `TestsAssetLoader`
+  - `XmlAssetLoader`
+  - `YamlAssetLoader`
+- Fixed deprecations
+
+## 0.0.1
+
+- Initial release.

CONTRIBUTING.md

@@ -0,0 +1,11 @@
+# Contributing
+
+## Release process
+
+    1. Make sure that the changelog is updated
+
+    2. Make sure that the version in pubspec.yaml is correct
+
+    3. Create a release in the github UI. Name the release like the version, but with a v (3.7.5 -> v3.7.5). Name the tag like the release
+
+    4. A pipeline will run and deploy the new version to pub.dev

README.md

@@ -39,7 +39,7 @@ dependencies:
 
 ```
 
-2. Change assetLoader and patch
+2. Change assetLoader and path
 
 ```dart
 ...
@@ -54,4 +54,20 @@ void main(){
 ...
 ```
 
-3. All done!.
+3. All done!.
+
+
+### Loaders Specification
+
+#### HttpAssetLoader
+
+In order to use HttpAssetLoader you must provide a path to a folder (i.e. base path) where all your translations are placed like `https://example.com/translations`
+
+Your translations should be created as separate files with `.json` extension. Placing translations as individual files reduces the size of the file to load on application init.
+Example:
+
+```
+translations/
+├── en-US.json
+└── uk-UA.json
+```

lib/easy_localization_loader.dart

@@ -1,10 +1,8 @@
-library easy_localization_loader;
-
+export 'package:easy_localization_loader/src/csv_asset_loader.dart';
 export 'package:easy_localization_loader/src/file_asset_loader.dart';
-export 'package:easy_localization_loader/src/json_asset_loader.dart';
 export 'package:easy_localization_loader/src/http_asset_loader.dart';
-export 'package:easy_localization_loader/src/csv_asset_loader.dart';
-export 'package:easy_localization_loader/src/yaml_asset_loader.dart';
-export 'package:easy_localization_loader/src/xml_asset_loader.dart';
-export 'package:easy_localization_loader/src/tests_asset_loader.dart';
+export 'package:easy_localization_loader/src/json_asset_loader.dart';
 export 'package:easy_localization_loader/src/smart_network_asset_loader.dart';
+export 'package:easy_localization_loader/src/tests_asset_loader.dart';
+export 'package:easy_localization_loader/src/xml_asset_loader.dart';
+export 'package:easy_localization_loader/src/yaml_asset_loader.dart';

lib/src/csv_asset_loader.dart

@@ -3,10 +3,9 @@ import 'dart:ui';
 
 import 'package:csv/csv.dart';
 import 'package:csv/csv_settings_autodetection.dart';
+import 'package:easy_localization/easy_localization.dart';
 import 'package:flutter/services.dart';
 
-import 'asset_loader.dart';
-
 //
 // load example/resources/langs/langs.csv
 //

lib/src/file_asset_loader.dart

@@ -3,13 +3,11 @@ import 'dart:developer';
 import 'dart:io';
 import 'dart:ui';
 
-import 'asset_loader.dart';
+import 'package:easy_localization/easy_localization.dart';
 
-//
-//
-//
-//
 class FileAssetLoader extends AssetLoader {
+  const FileAssetLoader();
+
   @override
   Future<Map<String, dynamic>> load(String path, Locale locale) async {
     final file = File(path);

lib/src/http_asset_loader.dart

@@ -1,27 +1,24 @@
-//
-//
-//
-//
 import 'dart:convert';
 import 'dart:developer';
 import 'dart:ui';
 
+import 'package:easy_localization/easy_localization.dart';
 import 'package:http/http.dart' as http;
 
-import 'asset_loader.dart';
-
 class HttpAssetLoader extends AssetLoader {
+  const HttpAssetLoader();
+
   @override
   Future<Map<String, dynamic>> load(String path, Locale locale) async {
     log('easy localization loader: load http $path');
     try {
-      var url = Uri.parse(path);
+      var url = Uri.parse('$path/${locale.toLanguageTag()}.json');
       return http
           .get(url)
-          .then((response) => json.decode(response.body.toString()));
+          .then((response) => json.decode(utf8.decode(response.bodyBytes)));
     } catch (e) {
       //Catch network exceptions
-      return Future.value();
+      return {};
     }
   }
 }

lib/src/json_asset_loader.dart

@@ -2,13 +2,14 @@ import 'dart:convert';
 import 'dart:developer';
 import 'dart:ui';
 
+import 'package:easy_localization/easy_localization.dart';
 import 'package:flutter/services.dart';
 
-import 'asset_loader.dart';
-
 class JsonAssetLoader extends AssetLoader {
+  const JsonAssetLoader();
+
   String getLocalePath(String basePath, Locale locale) {
-    return '$basePath/${localeToString(locale, separator: "-")}.json';
+    return '$basePath/${locale.toStringWithSeparator(separator: "-")}.json';
   }
 
   @override

lib/src/smart_network_asset_loader.dart

@@ -2,13 +2,12 @@ import 'dart:convert';
 import 'dart:io';
 import 'dart:ui';
 import 'package:connectivity_plus/connectivity_plus.dart';
+import 'package:easy_localization/easy_localization.dart';
 import 'package:http/http.dart' as http;
 import 'package:path_provider/path_provider.dart' as paths;
 
 import 'package:flutter/services.dart';
 
-import 'asset_loader.dart';
-
 /// ```dart
 /// SmartNetworkAssetLoader(
 ///           assetsPath: 'assets/translations',

lib/src/tests_asset_loader.dart

@@ -2,14 +2,15 @@ import 'dart:convert';
 
 import 'dart:ui';
 
+import 'package:easy_localization/easy_localization.dart';
 import 'package:flutter/services.dart';
 
-import 'asset_loader.dart';
-
 // asset loader to be used when doing integration tests
 // default AssetLoader suffers from this issue
 // https://github.com/flutter/flutter/issues/44182
 class TestsAssetLoader extends AssetLoader {
+  const TestsAssetLoader();
+
   @override
   Future<Map<String, dynamic>> load(String path, Locale locale) async {
     final byteData = await rootBundle.load(path);

lib/src/xml_asset_loader.dart

@@ -1,15 +1,16 @@
 import 'dart:developer';
 import 'dart:ui';
 
+import 'package:easy_localization/easy_localization.dart';
 import 'package:flutter/services.dart';
 import 'package:xml/xml.dart';
 
-import 'asset_loader.dart';
-
 //Loader for multiple xml files
 class XmlAssetLoader extends AssetLoader {
+  const XmlAssetLoader();
+
   String getLocalePath(String basePath, Locale locale) {
-    return '$basePath/${localeToString(locale, separator: "-")}.xml';
+    return '$basePath/${locale.toStringWithSeparator(separator: "-")}.xml';
   }
 
   @override
@@ -50,7 +51,7 @@ Map<String, dynamic> convertXmlNodeToMap(XmlNode xmlNode) {
     if (entry is XmlElement) {
       switch (entry.children.length) {
         case 1:
-          map[entry.name.toString()] = entry.text;
+          map[entry.name.toString()] = entry.value;
           break;
         case 0:
           print(entry.name.toString());

lib/src/yaml_asset_loader.dart

@@ -1,15 +1,16 @@
 import 'dart:developer';
 import 'dart:ui';
 
+import 'package:easy_localization/easy_localization.dart';
 import 'package:flutter/services.dart';
 import 'package:yaml/yaml.dart';
 
-import 'asset_loader.dart';
-
 //Loader for multiple yaml files
 class YamlAssetLoader extends AssetLoader {
+  const YamlAssetLoader();
+
   String getLocalePath(String basePath, Locale locale) {
-    return '$basePath/${localeToString(locale, separator: "-")}.yaml';
+    return '$basePath/${locale.toStringWithSeparator(separator: "-")}.yaml';
   }
 
   @override

pubspec.yaml

@@ -4,22 +4,21 @@ description: Easy Localization Loader custom assets loaders for easy_localizatio
 homepage: https://github.com/aissat/easy_localization_loader
 issue_tracker: https://github.com/aissat/easy_localization_loader/issues
 
-version: 1.0.1+1
+version: 2.0.0
 
 environment:
-  sdk: '>=2.12.0-0 <3.0.0'
+  sdk: '>=2.12.0 <4.0.0'
 
 dependencies:
-  http: ^0.13.5
+  connectivity_plus: ^5.0.1
   csv: ^5.0.1
-  yaml: ^3.1.1
+  easy_localization: ^3.0.3
+  flutter: { sdk: flutter }
+  http: ^1.1.0
+  path_provider: ^2.1.1
   xml: ^6.1.0
-  flutter:
-    sdk: flutter
-  connectivity_plus: ^2.3.7
-  path_provider: ^2.0.11
+  yaml: ^3.1.1
 
 dev_dependencies:
   pedantic: ^1.11.1
   test: ^1.21.6
-