🔀 Merge pull request #21 from Cynnexis/dev

Ready to release first version

Author: Cynnexis

.github/workflows/main.yml

@@ -26,3 +26,21 @@ jobs:
         id: zephyr_test
         with:
           args: "test"
+
+  release:
+    runs-on: ubuntu-18.04
+    name: Create a release
+    needs: [lint, test]
+    if: github.event_name == 'push' && github.ref == 'master' || contains(github.ref, 'cicd/')
+    steps:
+      - name: Create a release for Zéphyr
+        id: create_release
+        uses: actions/create-release@latest
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ github.sha }}
+          release_name: ${{ github.sha }}
+          body: "Ref: ${{ github.ref }} SHA: ${{ github.sha }}"
+          draft: true
+          prerelease: false

README.md

@@ -44,6 +44,7 @@ The app should be running now.
 * [flutter_typeahead][flutter_typeahead]
 * [diacritic][diacritic]
 * [flutter_launcher_icons][flutter_launcher_icons]
+* [notifiable_iterables][notifiable_iterables]
 
 ## Contributing
 
@@ -68,5 +69,6 @@ for more detail (it's a really fascinating story written in there!)
 [flutter_typeahead]: https://pub.dev/packages/flutter_typeahead
 [diacritic]: https://pub.dev/packages/diacritic
 [flutter_launcher_icons]: https://pub.dev/packages/flutter_launcher_icons
+[notifiable_iterables]: https://pub.dev/packages/notifiable_iterables
 [cynnexis]: https://github.com/Cynnexis
 [license]: https://github.com/Cynnexis/zephyr/blob/master/LICENSE.txt

docker-entrypoint.sh

@@ -6,7 +6,7 @@ function print_help() {
 	echo "The commands are:"
 	echo "  lint     - Check if the Dart syntax of the code is correct."
 	echo "  fix-lint - Fix the Dart syntax of the code."
-	echo "  test     - Run the test."
+	echo "  test     - Run the tests."
 }
 
 if [[ $# == 0 ]]; then

lib/model/abstract_notifier_set.dart

@@ -1,21 +1,21 @@
 import 'package:flutter/widgets.dart';
-import 'package:zephyr/model/abstract_notifier_set.dart';
+import 'package:notifiable_iterables/notifiable_iterables.dart';
 import 'package:zephyr/model/sign.dart';
 import 'package:zephyr/service/preferences.dart';
 
 /// List of favorites signs. It is also a [ChangeNotifier] that notifies all its listeners every time the list is
 /// modified.
-class Favorites extends AbstractNotifierSet<Sign> {
+class Favorites extends NotifiableSet<Sign> {
   /// Default constructors for [Favorites].
   ///
   /// Construct a list of favorites signs from [signs]. The listeners will be notify at the end.
   Favorites([dynamic signs]) {
-    if (signs != null) this.values = signs;
+    if (signs != null) addAll(signs);
   }
 
   /// Construct a copy of [favorites].
   Favorites.from(Favorites favorites) {
-    this.values = favorites.values;
+    addAll(favorites);
   }
 
   /// Create a [Favorites] instance by loading the value from the internal storage. Note that this operations is
@@ -27,7 +27,8 @@ class Favorites extends AbstractNotifierSet<Sign> {
   /// instead). Finally, [onComplete] will be called at the end of the operation.
   Favorites.load([void Function(Favorites) onSuccess, void Function(Error) onError, void Function() onComplete]) {
     loadFavorites().then((fav) {
-      this.values = fav.values;
+      clear();
+      addAll(fav);
       if (onSuccess != null) onSuccess(this);
     }).catchError((e) {
       if (onError != null)

lib/model/favorites.dart

@@ -1,22 +1,22 @@
 import 'package:flutter/widgets.dart';
-import 'package:zephyr/model/abstract_notifier_set.dart';
+import 'package:notifiable_iterables/notifiable_iterables.dart';
 import 'package:zephyr/service/preferences.dart';
 
 import 'keywords.dart';
 
 /// List of keywords. It is also a [ChangeNotifier] that notifies all its listeners every time the list is
 /// modified.
-class History extends AbstractNotifierSet<Keywords> {
+class History extends NotifiableSet<Keywords> {
   /// Default constructors for [History].
   ///
   /// Construct a list of keywords from [keywords]. The listeners will be notify at the end.
   History([dynamic keywords]) {
-    if (keywords != null) this.values = keywords;
+    if (keywords != null) addAll(keywords);
   }
 
   /// Construct a copy of [History].
   History.from(History history) {
-    this.values = history.values;
+    addAll(history);
   }
 
   /// Create a [History] instance by loading the value from the internal storage. Note that this operations is
@@ -28,7 +28,8 @@ class History extends AbstractNotifierSet<Keywords> {
   /// instead). Finally, [onComplete] will be called at the end of the operation.
   History.load([void Function(History) onSuccess, void Function(Error) onError, void Function() onComplete]) {
     loadHistory().then((history) {
-      this.values = history.values;
+      clear();
+      addAll(history);
       if (onSuccess != null) onSuccess(this);
     }).catchError((e) {
       if (onError != null)

lib/model/history.dart

@@ -40,6 +40,7 @@ dependencies:
   provider: 4.3.1
   flutter_typeahead: 1.8.6
   json_serializable: 3.3.0
+  notifiable_iterables: 1.0.0
 
 dev_dependencies:
   flutter_driver:

pubspec.yaml

@@ -60,13 +60,13 @@ void main() {
     test("Saving & Loading Favorites", () async {
       await saveFavorites(signs);
       final Favorites loadedSigns = await loadFavorites();
-      expect(signs, equals(loadedSigns.values));
+      expect(signs, equals(loadedSigns.toSet()));
     });
 
     test("Saving & Loading History", () async {
       await saveHistory(keywordsSet);
       final History loadedHistory = await loadHistory();
-      expect(keywordsSet, equals(loadedHistory.values));
+      expect(keywordsSet, equals(loadedHistory.toSet()));
     });
 
     test("Append Favorites", () async {
@@ -88,7 +88,7 @@ void main() {
 
       await saveFavorites(newSigns, append: true);
 
-      final Set<Sign> loadedSigns = Set<Sign>.of((await loadFavorites()).values);
+      final Set<Sign> loadedSigns = (await loadFavorites()).toSet();
       expect(allSigns, equals(loadedSigns));
     });
 
@@ -114,7 +114,7 @@ void main() {
 
       await saveFavorites(newSigns, append: true);
 
-      final Set<Sign> loadedSigns = Set<Sign>.of((await loadFavorites()).values);
+      final Set<Sign> loadedSigns = (await loadFavorites()).toSet();
       expect(allSigns, equals(loadedSigns));
     });
   });