v3.0.0 updates

Author: agordn52

CHANGELOG.md

@@ -1,3 +1,12 @@
+## [3.0.0] - 2022-04-29
+
+* New command to create: Events, Providers and API Services
+* Remove command: project:init
+* Docs link updated in Model stub
+* Update README info
+* Remove nylo_support ref from stubs
+* Pubspec.yaml dependency updates
+
 ## [2.2.0] - 2022-03-29
 
 * Remove appended 'Widget' from Metro:make command for stateless and stateful widgets

README.md

@@ -1,14 +1,14 @@
 ![Nylo Banner](https://nylo.dev/images/nylo_logo_header.png)
 
 <p align="center">
-  <a href="https://github.com/nylo-core/framework/releases/tag/v2.2.0"><img src="https://img.shields.io/github/v/release/nylo-core/framework?style=plastic" alt="Latest Release Version"></a>
-  <a href="https://github.com/nylo-core/framework/releases/tag/v2.2.0"><img src="https://img.shields.io/github/license/nylo-core/framework?style=plastic" alt="Latest Stable Version"></a>
+  <a href="https://github.com/nylo-core/framework/releases/latest"><img src="https://img.shields.io/github/v/release/nylo-core/framework?style=plastic" alt="Latest Release Version"></a>
+  <a href="https://github.com/nylo-core/framework/releases/latest"><img src="https://img.shields.io/github/license/nylo-core/framework?style=plastic" alt="Latest Stable Version"></a>
   <a href="https://github.com/nylo-core/framework"><img alt="GitHub stars" src="https://img.shields.io/github/stars/nylo-core/framework?style=plastic"></a>
 </p>
 
-## Nylo Framework (v2.2.0)
+## Nylo Framework (v3.0.0)
 
-Nylo is a micro-framework for Flutter which is designed to help simplify app development. Every project provides a simple boilerplate and MVC pattern to help you build apps easier. 
+Nylo is a micro-framework for Flutter which is designed to help simplify app development. Every project provides a simple boilerplate and MVC pattern to help you build apps easier.
 
 This project is open source and MIT-licenced, we welcome any contributions. You can join as a backer/sponsor to fund future development for this project [here](https://nylo.dev/contributions)
 
@@ -18,10 +18,12 @@ This project is open source and MIT-licenced, we welcome any contributions. You
 
 ## Features
 Some core features available
-* Cli for generating new files 
+* CLI for generating new files
 * Router file to manage routes
 * Light and dark themes preset for customization
 * Localization ready
+* Elegant API Services for Networking
+* Dispatch Events
 * Project structure for widgets, assets, controllers + more
 
 ## Documentation

example/pubspec.lock

@@ -202,14 +202,14 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "2.2.0"
+    version: "3.0.0"
   nylo_support:
     dependency: transitive
     description:
       name: nylo_support
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "2.4.0"
+    version: "3.0.0"
   page_transition:
     dependency: transitive
     description:

lib/metro/menu.dart

@@ -8,14 +8,15 @@ Options
     -h
     
 All commands:
- project
-  project:init
  
  make
   make:controller
   make:model
   make:page
   make:stateful_widget
   make:stateless_widget
+  make:provider
+  make:event
+  make:api_service
   make:theme
 """;

lib/metro/metro.dart

@@ -3,6 +3,9 @@ library metro;
 import 'package:collection/collection.dart' show IterableExtension;
 import 'package:args/args.dart';
 import 'package:nylo_framework/metro/menu.dart';
+import 'package:nylo_framework/metro/stubs/api_service_stub.dart';
+import 'package:nylo_framework/metro/stubs/event_stub.dart';
+import 'package:nylo_framework/metro/stubs/provider_stub.dart';
 import 'package:nylo_framework/metro/stubs/theme_colors_stub.dart';
 import 'package:nylo_framework/metro/stubs/theme_stub.dart';
 import 'package:nylo_support/metro/constants/strings.dart';
@@ -21,12 +24,6 @@ import 'package:recase/recase.dart';
 
 final ArgParser parser = ArgParser(allowTrailingOptions: true);
 List<NyCommand> _allCommands = [
-  NyCommand(
-      name: "init",
-      options: 1,
-      arguments: ["-h"],
-      category: "project",
-      action: _projectInit),
   NyCommand(
       name: "controller",
       options: 1,
@@ -57,6 +54,24 @@ List<NyCommand> _allCommands = [
       arguments: ["-h", "-f"],
       category: "make",
       action: _makeStatelessWidget),
+  NyCommand(
+      name: "provider",
+      options: 1,
+      arguments: ["-h", "-f"],
+      category: "make",
+      action: _makeProvider),
+  NyCommand(
+      name: "event",
+      options: 1,
+      arguments: ["-h", "-f"],
+      category: "make",
+      action: _makeEvent),
+  NyCommand(
+      name: "api_service",
+      options: 1,
+      arguments: ["-h", "-f", "-model", "-resource"],
+      category: "make",
+      action: _makeApiService),
   NyCommand(
       name: "theme",
       options: 1,
@@ -93,32 +108,14 @@ Future<void> commands(List<String> arguments) async {
   await nyCommand.action!(arguments);
 }
 
-_projectInit(List<String> arguments) async {
-  parser.addFlag(helpFlag,
-      abbr: 'h', help: 'Initializes the Nylo project', negatable: false);
-
-  final ArgResults argResults = parser.parse(arguments);
-
-  _checkHelpFlag(argResults[helpFlag], parser.usage);
-
-  if (await MetroService.hasFile(".env") == false) {
-    final File envExample = File('.env-example');
-    final File env = File('.env');
-    await env.writeAsString(await envExample.readAsString());
-    MetroConsole.writeInGreen('.env file add from .env-example 🎉');
-  }
-
-  MetroConsole.writeInGreen('Project initialized, create something great 🎉');
-}
-
 _makeStatefulWidget(List<String> arguments) async {
   parser.addFlag(helpFlag,
       abbr: 'h',
-      help: 'e.g. make:widget video_player_widget',
+      help: 'e.g. make:stateful_widget video_player_widget',
       negatable: false);
   parser.addFlag(forceFlag,
       abbr: 'f',
-      help: 'Creates a new widget even if it already exists.',
+      help: 'Creates a new stateful widget even if it already exists.',
       negatable: false);
 
   final ArgResults argResults = parser.parse(arguments);
@@ -127,6 +124,9 @@ _makeStatefulWidget(List<String> arguments) async {
 
   _checkHelpFlag(argResults[helpFlag], parser.usage);
 
+  _checkArguments(arguments,
+      'You are missing the \'name\' of the stateful widget that you want to create.\ne.g. make:stateful_widget my_new_widget');
+
   String widgetName =
       argResults.arguments.first.replaceAll(RegExp(r'(_?widget)'), "");
 
@@ -140,11 +140,11 @@ _makeStatefulWidget(List<String> arguments) async {
 _makeStatelessWidget(List<String> arguments) async {
   parser.addFlag(helpFlag,
       abbr: 'h',
-      help: 'e.g. make:widget video_player_widget',
+      help: 'e.g. make:stateless_widget video_player_widget',
       negatable: false);
   parser.addFlag(forceFlag,
       abbr: 'f',
-      help: 'Creates a new widget even if it already exists.',
+      help: 'Creates a new stateless widget even if it already exists.',
       negatable: false);
 
   final ArgResults argResults = parser.parse(arguments);
@@ -166,6 +166,114 @@ _makeStatelessWidget(List<String> arguments) async {
   MetroConsole.writeInGreen(widgetName + ' created 🎉');
 }
 
+_makeProvider(List<String> arguments) async {
+  parser.addFlag(helpFlag,
+      abbr: 'h', help: 'e.g. make:provider storage_provider', negatable: false);
+  parser.addFlag(forceFlag,
+      abbr: 'f',
+      help: 'Creates a new provider even if it already exists.',
+      negatable: false);
+
+  final ArgResults argResults = parser.parse(arguments);
+
+  bool? hasForceFlag = argResults[forceFlag];
+
+  _checkHelpFlag(argResults[helpFlag], parser.usage);
+
+  _checkArguments(arguments,
+      'You are missing the \'name\' of the provider that you want to create.\ne.g. make:provider cache_provider');
+
+  String providerName =
+      argResults.arguments.first.replaceAll(RegExp(r'(_?provider)'), "");
+
+  String stubProvider = providerStub(ReCase(providerName));
+  await MetroService.makeProvider(providerName, stubProvider,
+      forceCreate: hasForceFlag ?? false);
+
+  MetroConsole.writeInGreen(providerName + '_provider created 🎉');
+}
+
+_makeEvent(List<String> arguments) async {
+  parser.addFlag(helpFlag,
+      abbr: 'h', help: 'e.g. make:event login_event', negatable: false);
+  parser.addFlag(forceFlag,
+      abbr: 'f',
+      help: 'Creates a new event even if it already exists.',
+      negatable: false);
+
+  final ArgResults argResults = parser.parse(arguments);
+
+  bool? hasForceFlag = argResults[forceFlag];
+
+  _checkHelpFlag(argResults[helpFlag], parser.usage);
+
+  _checkArguments(arguments,
+      'You are missing the \'name\' of the event that you want to create.\ne.g. make:event login_event');
+
+  String eventName =
+      argResults.arguments.first.replaceAll(RegExp(r'(_?event)'), "");
+
+  String stubEvent = eventStub(eventName: ReCase(eventName));
+  await MetroService.makeEvent(eventName, stubEvent,
+      forceCreate: hasForceFlag ?? false);
+
+  MetroConsole.writeInGreen(eventName + '_event created 🎉');
+}
+
+_makeApiService(List<String> arguments) async {
+  parser.addFlag(helpFlag,
+      abbr: 'h',
+      help: 'e.g. make:api_service user_api_service',
+      negatable: false);
+  parser.addFlag(forceFlag,
+      abbr: 'f',
+      help: 'Creates a new API service even if it already exists.',
+      negatable: false);
+  parser.addOption(
+    modelFlag,
+    abbr: 'm',
+    help: 'Provide the Model that should be used in the API service.',
+  );
+  parser.addOption(
+    urlFlag,
+    abbr: 'u',
+    help: 'Provide the Base Url that should be used in the API service.',
+  );
+  parser.addFlag(isResourceFlag,
+      abbr: 'r',
+      help: 'Creates a API service with crud methods',
+      negatable: false);
+
+  final ArgResults argResults = parser.parse(arguments);
+
+  bool? hasForceFlag = argResults[forceFlag];
+  bool hasResourceFlag = argResults[isResourceFlag] ?? false;
+  String modelFlagValue = argResults[modelFlag] ?? "Model";
+  String? baseUrlFlagValue = argResults[urlFlag];
+  if (baseUrlFlagValue == null) {
+    baseUrlFlagValue = "getEnv('API_BASE_URL')";
+  } else {
+    baseUrlFlagValue = "\"$baseUrlFlagValue\"";
+  }
+
+  _checkHelpFlag(argResults[helpFlag], parser.usage);
+
+  _checkArguments(arguments,
+      'You are missing the \'name\' of the API service that you want to create.\ne.g. make:api_service user_api_service');
+
+  String apiServiceName =
+      argResults.arguments.first.replaceAll(RegExp(r'(_?api_service)'), "");
+
+  String stubApiService = apiServiceStub(ReCase(apiServiceName),
+      model: ReCase(modelFlagValue),
+      isResource: hasResourceFlag,
+      baseUrl: baseUrlFlagValue);
+  await MetroService.makeApiService(apiServiceName, stubApiService,
+      forceCreate: hasForceFlag ?? false);
+
+  MetroConsole.writeInGreen(apiServiceName + '_api_service created 🎉');
+}
+
 _makeTheme(List<String> arguments) async {
   parser.addFlag(helpFlag,
       abbr: 'h', help: 'e.g. make:theme bright_theme', negatable: false);
@@ -231,7 +339,8 @@ _makeController(List<String> arguments) async {
 _makeModel(List<String> arguments) async {
   parser.addFlag(helpFlag,
       abbr: 'h',
-      help: 'Creates a new model in your project.',
+      help:
+          'To create a new model, use e.g. "flutter pub run nylo_framework:main make:model user"',
       negatable: false);
   parser.addFlag(forceFlag,
       abbr: 'f',

lib/metro/stubs/api_service_stub.dart

@@ -0,0 +1,61 @@
+import 'package:recase/recase.dart';
+
+String apiServiceStub(ReCase rc,
+        {required ReCase model,
+        bool isResource = false,
+        required String baseUrl}) =>
+    '''
+import 'package:flutter/material.dart';
+import 'package:flutter_app/app/networking/dio/base_api_service.dart';
+${baseUrl == "getEnv('API_BASE_URL')" ? "import 'package:nylo_framework/nylo_framework.dart';" : ""}
+${model.originalText != 'Model' ? "import 'package:flutter_app/app/models/${model.snakeCase}.dart';" : ""}
+
+class ${rc.pascalCase}ApiService extends BaseApiService {
+  ${rc.pascalCase}ApiService({BuildContext? buildContext}) : super(buildContext);
+
+  @override
+  String get baseUrl => $baseUrl;
+
+${isResource ? ''' 
+  /// Return a list of users
+  Future<List<${model.pascalCase}>?> fetchAll({dynamic query}) async {
+    return await network<List<${model.pascalCase}>>(
+        request: (request) => request.get("/endpoint-path", queryParameters: query),
+    );
+  }
+
+  /// Find a ${model.pascalCase}
+  Future<${model.pascalCase}?> find({required int id}) async {
+    return await network<${model.pascalCase}>(
+      request: (request) => request.get("/endpoint-path/\$id"),
+    );
+  }
+
+  /// Create a ${model.pascalCase}
+  Future<${model.pascalCase}?> create({required dynamic data}) async {
+    return await network<${model.pascalCase}>(
+      request: (request) => request.post("/endpoint-path", data: data),
+    );
+  }
+
+  /// Update a ${model.pascalCase}
+  Future<${model.pascalCase}?> update({dynamic query}) async {
+    return await network<${model.pascalCase}>(
+      request: (request) => request.put("/endpoint-path", queryParameters: query),
+    );
+  }
+
+  /// Delete a ${model.pascalCase}
+  Future<bool?> delete({required int id}) async {
+    return await network<bool>(
+      request: (request) => request.delete("/endpoint-path/\$id"),
+    );
+  }''' : '''
+  /// Example API Request
+  Future<dynamic> fetchData() async {
+    return await network<dynamic>(
+        request: (request) => request.get("/endpoint-path"),
+    );
+  }'''}
+}
+''';

lib/metro/stubs/event_stub.dart

@@ -0,0 +1,19 @@
+import 'package:recase/recase.dart';
+
+String eventStub({required ReCase eventName}) => '''
+import 'package:nylo_framework/nylo_framework.dart';
+
+class ${eventName.pascalCase}Event implements NyEvent {
+
+  final listeners = {
+    DefaultListener: DefaultListener(),
+  };
+}
+
+class DefaultListener extends NyListener {
+  handle(dynamic event) async {
+   // Handle the event
+   
+  }
+}
+''';