Merge pull request #14 from nylo-core/master

Master

Author: agordn52

CHANGELOG.md

@@ -1,3 +1,29 @@
+## [3.0.0] - 2022-04-29
+
+* New arguments for Nylo's `init` method: setup, setupFinished
+* Add init method for NyState class
+* New helpers: nyEvent, nyApi and Backpack
+* assert condition added to DefaultResponse class
+
+## [2.8.0] - 2022-04-21
+
+* Revert new init method in Nylo
+
+## [2.7.0] - 2022-04-21
+
+* Version bump
+
+## [2.6.1] - 2022-04-21
+
+* Fix Nylo init method with router param
+
+## [2.6.0] - 2022-04-21
+
+* Revert init change in NyState.
+* New Metro command to create events in Nylo.
+* bootApplication helper added.
+* Small refactor to folder names
+
 ## [2.5.0] - 2022-04-19
 
 * New Metro command to create Providers in Nylo.

lib/events/events.dart

@@ -0,0 +1,23 @@
+/// Base interface for Events
+abstract class NyEvent {
+  final Map<Type, NyListener> listeners = {};
+}
+
+/// Base class for listeners
+class NyListener {
+  late NyEvent _event;
+
+  /// Set the [event] that the listener was called from
+  setEvent(NyEvent event) {
+    _event = event;
+  }
+
+  /// Get the [NyEvent] that the listener was called from
+  NyEvent getEvent() => _event;
+
+  /// Handle the payload from the event
+  /// The [event] argument provides a Map of the data
+  /// event<ChatCreated>({"chat": Chat()});
+  /// E.g. [event] = {"chat":"Chat instance"}
+  Future<dynamic> handle(Map? event) async {}
+}

lib/helpers/helper.dart

@@ -3,6 +3,7 @@ import 'package:flutter/material.dart';
 import 'package:flutter_dotenv/flutter_dotenv.dart';
 import 'package:flutter_secure_storage/flutter_secure_storage.dart';
 import 'package:logger/logger.dart';
+import 'package:nylo_support/events/events.dart';
 import 'package:nylo_support/localization/app_localization.dart';
 
 /// Returns a value from the .env file
@@ -280,3 +281,71 @@ class NyLogger {
 /// lang translation will be returned for the app locale.
 String trans(String key, {Map<String, String>? arguments}) =>
     NyLocalization.instance.translate(key, arguments);
+
+/// Event helper
+nyEvent<T>({
+  Map? params,
+  Map<Type, NyEvent> events = const {},
+}) async {
+  assert(T.toString() != 'dynamic',
+      'You must provide an Event type for this method.\nE.g. event<LoginEvent>({"User": "#1 User"});');
+
+  Map<Type, NyEvent> appEvents = events;
+
+  if (events.isEmpty) {
+    appEvents = Backpack.instance.read('nylo').getEvents();
+  }
+
+  NyEvent nyEvent = appEvents[T]!;
+  assert(appEvents.containsKey(T),
+      'Your config/events.dart is missing this class ${T.toString()}');
+  Map<dynamic, NyListener> listeners = nyEvent.listeners;
+
+  if (listeners.isEmpty) {
+    return;
+  }
+  for (NyListener listener in listeners.values.toList()) {
+    listener.setEvent(nyEvent);
+    dynamic result = await listener.handle(params);
+    if (result != null && result == false) {
+      break;
+    }
+  }
+}
+
+/// API helper
+Future<void> nyApi<T>(
+    {required dynamic Function(T) request,
+    required Map<Type, dynamic> apiDecoders,
+    BuildContext? context}) async {
+  assert(apiDecoders.containsKey(T),
+      'Your config/decoders.dart is missing this class ${T.toString()} in apiDecoders');
+
+  dynamic apiService = apiDecoders[T];
+  if (context != null) {
+    apiService.setContext(context);
+  }
+
+  await request(apiService);
+}
+
+/// Backpack class for storing data
+/// This class is not designed to store huge amounts of data.
+class Backpack {
+  Map<String, dynamic> _values = {};
+
+  Backpack._privateConstructor();
+
+  static final Backpack instance = Backpack._privateConstructor();
+
+  T? read<T>(String key) {
+    if (!_values.containsKey(key)) {
+      return null;
+    }
+    return _values[key];
+  }
+
+  set(String key, dynamic value) async {
+    _values[key] = value;
+  }
+}

lib/metro/constants/strings.dart

@@ -7,14 +7,16 @@ const String themeDarkFlag = 'dark';
 const String controllerFlag = 'controller';
 const String isResourceFlag = 'resource';
 const String modelFlag = 'model';
+const String urlFlag = 'url';
 
 // folders
 const String yamlPath = 'pubspec.yaml';
-const String controllerFolder = 'lib/app/controllers';
-const String widgetFolder = 'lib/resources/widgets';
-const String pageFolder = 'lib/resources/pages';
-const String modelFolder = 'lib/app/models';
-const String themeFolder = 'lib/resources/themes';
+const String controllersFolder = 'lib/app/controllers';
+const String widgetsFolder = 'lib/resources/widgets';
+const String pagesFolder = 'lib/resources/pages';
+const String modelsFolder = 'lib/app/models';
+const String themesFolder = 'lib/resources/themes';
 const String providerFolder = 'lib/app/providers';
+const String eventsFolder = 'lib/app/events';
 const String networkingFolder = 'lib/app/networking';
 const String themeColorsFolder = 'lib/resources/themes/styles';

lib/metro/metro_service.dart

@@ -5,7 +5,7 @@ import 'package:nylo_support/metro/metro_console.dart';
 class MetroService {
   /// Creates a new Controller.
   static Future makeController(String className, String value,
-      {String folderPath = controllerFolder, bool forceCreate = false}) async {
+      {String folderPath = controllersFolder, bool forceCreate = false}) async {
     String filePath = '$folderPath/${className.toLowerCase()}_controller.dart';
 
     await _makeDirectory(folderPath);
@@ -15,7 +15,7 @@ class MetroService {
 
   /// Creates a new Page.
   static makePage(String className, String value,
-      {String folderPath = pageFolder, bool forceCreate = false}) async {
+      {String folderPath = pagesFolder, bool forceCreate = false}) async {
     String filePath = '$folderPath/${className.toLowerCase()}_page.dart';
 
     await _makeDirectory(folderPath);
@@ -25,7 +25,7 @@ class MetroService {
 
   /// Creates a new Model.
   static makeModel(String className, String value,
-      {String folderPath = modelFolder,
+      {String folderPath = modelsFolder,
       bool storable = false,
       bool forceCreate = false}) async {
     String filePath = '$folderPath/${className.toLowerCase()}.dart';
@@ -37,7 +37,7 @@ class MetroService {
 
   /// Creates a new Stateless Widget.
   static makeStatelessWidget(String className, String value,
-      {String folderPath = widgetFolder, bool forceCreate = false}) async {
+      {String folderPath = widgetsFolder, bool forceCreate = false}) async {
     String filePath = '$folderPath/${className.toLowerCase()}_widget.dart';
 
     await _makeDirectory(folderPath);
@@ -47,7 +47,7 @@ class MetroService {
 
   /// Creates a new Stateful Widget.
   static makeStatefulWidget(String className, String value,
-      {String folderPath = widgetFolder, bool forceCreate = false}) async {
+      {String folderPath = widgetsFolder, bool forceCreate = false}) async {
     String filePath = '$folderPath/${className.toLowerCase()}_widget.dart';
 
     await _makeDirectory(folderPath);
@@ -57,7 +57,7 @@ class MetroService {
 
   /// Creates a new Stateful Widget.
   static makeTheme(String className, String value,
-      {String folderPath = themeFolder, bool forceCreate = false}) async {
+      {String folderPath = themesFolder, bool forceCreate = false}) async {
     String filePath = '$folderPath/${className.toLowerCase()}_theme.dart';
 
     await _makeDirectory(folderPath);
@@ -75,6 +75,16 @@ class MetroService {
     await _createNewFile(filePath, value);
   }
 
+  /// Creates a new Event.
+  static makeEvent(String className, String value,
+      {String folderPath = eventsFolder, bool forceCreate = false}) async {
+    String filePath = '$folderPath/${className.toLowerCase()}_event.dart';
+
+    await _makeDirectory(folderPath);
+    await _checkIfFileExists(filePath, shouldForceCreate: forceCreate);
+    await _createNewFile(filePath, value);
+  }
+
   /// Creates a new API service.
   static makeApiService(String className, String value,
       {String folderPath = networkingFolder, bool forceCreate = false}) async {

lib/networking/default_response.dart

@@ -6,7 +6,10 @@ class DefaultResponse<T> {
 
   late final T data;
 
-  DefaultResponse.fromJson(json, decoders, {required Type type}) {
+  DefaultResponse.fromJson(json, Map<Type, dynamic> decoders,
+      {required Type type}) {
+    assert(decoders.containsKey(type),
+        'Your config/decoders.dart file does not contain a decoder for the following class: ${type.toString()} in modelDecoders');
     data = decoders[type]!(json) as T;
   }
 }

lib/nylo.dart

@@ -1,11 +1,13 @@
 import 'package:flutter_dotenv/flutter_dotenv.dart';
+import 'package:nylo_support/events/events.dart';
 import 'package:nylo_support/plugin/nylo_plugin.dart';
 import 'package:nylo_support/router/router.dart';
 export 'package:nylo_support/exceptions/validation_exception.dart';
 export 'package:nylo_support/alerts/toast_enums.dart';
 
 class Nylo {
   late NyRouter? router;
+  late Map<Type, NyEvent> _events = {};
 
   Nylo({this.router});
 
@@ -18,6 +20,8 @@ class Nylo {
       router = NyRouter();
     }
     router!.setNyRoutes(plugin.routes());
+    _events.addAll(plugin.events());
+    NyNavigator.instance.router = this.router!;
   }
 
   /// Allows you to add additional Router's to your project.
@@ -35,15 +39,29 @@ class Nylo {
       this.router = NyRouter();
     }
     this.router!.setRegisteredRoutes(router.getRegisteredRoutes());
+    NyNavigator.instance.router = this.router!;
   }
 
-  /// Run to init Nylo
-  static Future<Nylo> init({required router, Function? setup}) async {
+  /// Add [events] to Nylo
+  addEvents(Map<Type, NyEvent> events) async {
+    _events.addAll(events);
+  }
+
+  /// Return all the registered events
+  Map<Type, NyEvent> getEvents() => _events;
+
+  /// Initialize Nylo
+  static Future<Nylo> init({Function? setup, Function? setupFinished}) async {
     await dotenv.load(fileName: ".env");
 
-    if (setup != null) {
-      await setup();
+    if (setup == null) {
+      return Nylo();
+    }
+
+    Nylo nylo = await setup();
+    if (setupFinished != null) {
+      await setupFinished(nylo);
     }
-    return Nylo(router: router);
+    return nylo;
   }
 }

lib/plugin/nylo_plugin.dart

@@ -1,3 +1,4 @@
+import 'package:nylo_support/events/events.dart';
 import 'package:nylo_support/nylo.dart';
 import 'package:nylo_support/router/router.dart';
 
@@ -6,6 +7,7 @@ abstract class NyAppPlugin {
   initPackage(Nylo nylo) async {}
   construct() async {}
   routes() {}
+  events() {}
 }
 
 /// [BasePlugin] class for NyPlugin.
@@ -24,6 +26,9 @@ class BasePlugin implements NyAppPlugin {
 
   /// Add additional routes to a Nylo project via the [router].
   NyRouter routes() => nyRoutes((router) {});
+
+  /// Add events to a Nylo project.
+  Map<Type, NyEvent> events() => {};
 }
 
 class NyPlugin extends BasePlugin {
@@ -35,4 +40,7 @@ class NyPlugin extends BasePlugin {
         // Add your routes here
         // router.route("/new-page", (context) => NewPage());
       });
+
+  /// Add events to a Nylo project.
+  Map<Type, NyEvent> events() => {};
 }

lib/providers/providers.dart

@@ -1,5 +1,28 @@
+import 'package:nylo_support/helpers/helper.dart';
+import 'package:nylo_support/nylo.dart';
+
 /// Base class for Providers.
-class NyProvider {
+abstract class NyProvider {
   /// Boot method is used for initializing code in your application.
-  boot() async {}
+  Future<Nylo?> boot(Nylo nylo) async => null;
+}
+
+/// Boots application providers.
+///
+/// See "config/providers" to add/modify providers
+Future<Nylo> bootApplication(Map<Type, NyProvider> providers) async {
+  Nylo nylo = Nylo();
+  for (var provider in providers.values) {
+    Nylo? nyloObject = await provider.boot(nylo);
+    if (nyloObject != null) {
+      nylo = nyloObject;
+    }
+  }
+  return nylo;
+}
+
+/// Called with init Nylo finishes.
+Future<Nylo> bootFinished(Nylo nylo) async {
+  Backpack.instance.set('nylo', nylo);
+  return nylo;
 }

lib/router/router.dart

@@ -29,7 +29,6 @@ NyRouter nyRoutes(Function(NyRouter router) build) {
   NyRouter nyRouter = NyRouter();
   build(nyRouter);
 
-  NyNavigator.instance.router = nyRouter;
   return nyRouter;
 }
 
@@ -144,13 +143,15 @@ class NyRouter {
           "'${route.name}' has already been registered before. Overriding it!");
     }
     _routeNameMappings[route.name] = route;
+    NyNavigator.instance.router = this;
   }
 
   /// Add a list of routes at once.
   void addRoutes(List<NyRouterRoute> routes) {
     if (routes.isNotEmpty) {
       routes.forEach((route) => this._addRoute(route));
     }
+    NyNavigator.instance.router = this;
   }
 
   /// Makes this a callable class. Delegates to [navigate].