+breaking: Make improvements to generated output

Author: robmllze

.gitignore

@@ -17,4 +17,9 @@
 **/.github/.git
 **/.metadata
 **/.flutter-plugins
-**/.flutter-plugins-dependencies
+**/.flutter-plugins-dependencies
+**/pubspec_overrides.yaml
+
+# Don't support IntelliJ.
+**/*.iml
+**/*.idea/

lib/src/_generator_converger.dart

@@ -26,14 +26,14 @@ final generatorConverger = _GeneratorConverger(
     final [
       controllerTemplate,
       screenTemplate,
-      viewTemplate,
+      stateTemplate,
     ] = templates;
 
     for (final replacement in replacements) {
       final templates = {
         replacement.insight.controllerFileName: controllerTemplate,
         replacement.insight.screenFileName: screenTemplate,
-        replacement.insight.viewFileName: viewTemplate,
+        replacement.insight.stateFileName: stateTemplate,
       };
       for (final entry in templates.entries) {
         final fileName = entry.key;

lib/src/generate_screen/_generator_converger.dart

@@ -33,7 +33,7 @@ final generatorConverger = _GeneratorConverger(
       final templates = {
         replacement.insight.controllerFileName: controllerTemplate,
         replacement.insight.screenFileName: screenTemplate,
-        replacement.insight.viewFileName: viewTemplate,
+        replacement.insight.stateFileName: viewTemplate,
       };
       for (final entry in templates.entries) {
         final fileName = entry.key;

lib/src/generate_screen/_insight.dart

@@ -15,7 +15,7 @@ class Insight {
   final String bindingsFileName;
   final String controllerFileName;
   final String screenFileName;
-  final String viewFileName;
+  final String stateFileName;
   final bool isAccessibleOnlyIfLoggedIn;
   final bool isAccessibleOnlyIfLoggedInAndVerified;
   final bool isAccessibleOnlyIfLoggedOut;
@@ -31,7 +31,7 @@ class Insight {
     required this.bindingsFileName,
     required this.controllerFileName,
     required this.screenFileName,
-    required this.viewFileName,
+    required this.stateFileName,
     required this.isAccessibleOnlyIfLoggedIn,
     required this.isAccessibleOnlyIfLoggedInAndVerified,
     required this.isAccessibleOnlyIfLoggedOut,

lib/src/generate_screen/_insight_mappers.dart

@@ -47,9 +47,9 @@ final insightMappers = [
     },
   ),
   _InsightMapper(
-    placeholder: Placeholders.VIEW_FILE,
+    placeholder: Placeholders.STATE_FILE,
     mapInsights: (insight) async {
-      return insight.viewFileName;
+      return insight.stateFileName;
     },
   ),
   _InsightMapper(
@@ -66,9 +66,7 @@ final insightMappers = [
   _InsightMapper(
     placeholder: Placeholders.I1,
     mapInsights: (insight) async {
-      final q1 = insight.queryParameters
-          .map((e) => 'late final $e = configuration.$e;')
-          .join('\n');
+      final q1 = insight.queryParameters.map((e) => 'late final $e = configuration.$e;').join('\n');
       return q1;
     },
   ),
@@ -92,17 +90,13 @@ final insightMappers = [
       final generateScreenBindingsArgs = [
         if (insight.path != null) "path: '${insight.path}'",
         if (insight.title != null) "title: '${insight.title}'",
-        if (insight.isAccessibleOnlyIfLoggedIn)
-          'isAccessibleOnlyIfLoggedIn: true',
+        if (insight.isAccessibleOnlyIfLoggedIn) 'isAccessibleOnlyIfLoggedIn: true',
         if (insight.isAccessibleOnlyIfLoggedInAndVerified)
           'isAccessibleOnlyIfLoggedInAndVerified: true',
-        if (insight.isAccessibleOnlyIfLoggedOut)
-          'isAccessibleOnlyIfLoggedOut: true',
+        if (insight.isAccessibleOnlyIfLoggedOut) 'isAccessibleOnlyIfLoggedOut: true',
         if (insight.isRedirectable) 'isRedirectable: true',
-        if (insight.internalParameters.isNotEmpty && a.isNotEmpty)
-          'internalParameters: {$a,}',
-        if (insight.queryParameters.isNotEmpty && b.isNotEmpty)
-          'queryParameters: {$b,}',
+        if (insight.internalParameters.isNotEmpty && a.isNotEmpty) 'internalParameters: {$a,}',
+        if (insight.queryParameters.isNotEmpty && b.isNotEmpty) 'queryParameters: {$b,}',
       ].join(',');
       return generateScreenBindingsArgs;
     },
@@ -125,7 +119,7 @@ enum Placeholders {
   BINDINGS_FILE,
   CONTROLLER_FILE,
   SCREEN_FILE,
-  VIEW_FILE,
+  STATE_FILE,
   Q1,
   I1,
   GENERATE_SCREEN_BINDINGS_ARGS,

lib/src/generate_screen/generate.dart

@@ -50,20 +50,19 @@ Future<void> generateScreen({
     ))!,
   );
 
-  final viewTemplate = extractCodeFromMarkdown(
+  final stateTemplate = extractCodeFromMarkdown(
     (await FileSystemUtility.i
-        .readFileFromPathOrUrl([templatePathOrUrl, 'view.dart.md'].join('/')))!,
+        .readFileFromPathOrUrl([templatePathOrUrl, 'state.dart.md'].join('/')))!,
   );
 
   final insight = Insight(
     screenClassName: screenName.toPascalCase(),
     bindingsFileName: '_bindings.g.dart',
     controllerFileName: '_controller.dart',
     screenFileName: '${screenName.toSnakeCase()}.dart',
-    viewFileName: '_view.dart',
+    stateFileName: '_state.dart',
     isAccessibleOnlyIfLoggedIn: isAccessibleOnlyIfLoggedIn,
-    isAccessibleOnlyIfLoggedInAndVerified:
-        isAccessibleOnlyIfLoggedInAndVerified,
+    isAccessibleOnlyIfLoggedInAndVerified: isAccessibleOnlyIfLoggedInAndVerified,
     isAccessibleOnlyIfLoggedOut: isAccessibleOnlyIfLoggedOut,
     isRedirectable: isRedirectable,
     internalParameters: internalParameters,
@@ -79,7 +78,7 @@ Future<void> generateScreen({
     [
       controllerTemplate,
       screenTemplate,
-      viewTemplate,
+      stateTemplate,
     ],
     insightMappers,
   );

pubspec.yaml

@@ -12,7 +12,7 @@
 
 name: df_generate_screen
 description: A tool to generate ready-made screen templates for your Flutter app (uses df_sceen)
-version: 0.4.1
+version: 0.5.0
 repository: https://github.com/devcetra/df_generate_screen
 funding:
   - https://www.buymeacoffee.com/robmllze
@@ -35,7 +35,7 @@ dependencies:
   df_config: ^0.5.3
   df_gen_core: ^0.4.5
   df_generate_dart_indexes: ^0.4.1
-  df_generate_dart_models_core: ^0.6.10
+  df_generate_dart_models_core: ^0.8.0
   df_log: ^0.2.4
   df_screen_core: ^0.3.0
   df_string: ^0.2.3
@@ -54,6 +54,6 @@ dev_dependencies:
 ## -----------------------------------------------------------------------------
 
 executables:
-  dfscr: dfscr-v5
-  dfscr-access: dfscr-access-v5
-  dfscr-bindings: dfscr-bindings-v5
+  gen-screen: dfscr-v5
+  gen-screen-access: dfscr-access-v5
+  gen-screen-bindings: dfscr-bindings-v5

templates/v6/access.dart.md

@@ -0,0 +1,129 @@
+```dart
+//.title
+// ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓
+//
+// GENERATED - DO NOT MODIFY BY HAND
+// See: https://github.com/DevCetra/df_generate_screen
+//
+// ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓
+//.title~
+
+// ignore: depend_on_referenced_packages
+import 'package:df_screen/df_screen.dart';
+
+import '_index.g.dart';
+
+// ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
+
+/// A list of all screen routes in the app.
+final generatedScreenRoutes = [
+  ___GENERATED_SCREEN_ROUTES___,
+];
+
+/// A list of function references. Each function returns a corresponding [Screen]
+/// for a given [ModelScreenConfiguration] or `null` if the given configuration
+/// does not match or access is denied to the screen.
+const SCREEN_MAKERS = [
+  ___SCREEN_MAKERS___,
+];
+
+/// Finds the screen that corresponds to [configuration]. It iterates through
+/// the list of screen makers and calls each one with the provided [configuration]
+/// and authentication states ([isLoggedInAndVerified], [isLoggedIn], [isLoggedOut]).
+/// If a screen is found that matches the configuration and is accessible, it is
+/// returned. Otherwise, `null` is returned.
+Screen? findScreenFromConfiguration({
+  required ModelScreenConfiguration configuration,
+  required bool? isLoggedInAndVerified,
+  required bool? isLoggedIn,
+  required bool? isLoggedOut,
+}) {
+  for (final screenMaker in SCREEN_MAKERS) {
+    final screen = screenMaker.call(
+      configuration,
+      isLoggedInAndVerified ?? false,
+      isLoggedIn ?? false,
+      isLoggedOut ?? true,
+    );
+    if (screen != null) {
+      return screen;
+    }
+  }
+  return null;
+}
+
+/// Finds the screen that corresponds to [configuration], considering
+/// the user's authentication state ([loggedIn], [verified]). It determines
+/// whether the user is logged in, verified, or logged out, and then calls
+/// `findScreenFromConfiguration` with these states. If a matching screen is
+/// found and accessible, it is returned; otherwise, `null` is returned.
+Screen? findScreenFromConfigurationAndAuthService({
+  required ModelScreenConfiguration configuration,
+  required bool loggedIn,
+  required bool verified,
+}) {
+  final loggedOut = !loggedIn;
+  final loggedInAndVerified = loggedIn && verified;
+  return findScreenFromConfiguration(
+    configuration: configuration,
+    isLoggedInAndVerified: loggedInAndVerified,
+    isLoggedIn: loggedIn,
+    isLoggedOut: loggedOut,
+  );
+}
+
+/// Translates the current URL into a [ModelScreenConfiguration], considering
+/// the user's authentication state ([loggedIn], [verified]). It calls
+/// `findScreenFromConfigurationAndAuthService` with the current URL's query
+/// parameters and path, along with the user's authentication states. If a
+/// matching screen configuration is found and accessible, it is returned;
+/// otherwise, `null` is returned.
+ModelScreenConfiguration? currentUrlToConfiguration({
+  required bool loggedIn,
+  required bool verified,
+}) {
+  return findScreenFromConfigurationAndAuthService(
+    configuration: ModelScreenConfiguration(
+      args: Uri.base.queryParameters,
+      path: Uri.base.path,
+    ),
+    loggedIn: loggedIn,
+    verified: verified,
+  )?.configuration;
+}
+
+/// Translates the current URL into a [ModelScreenConfiguration] under the
+/// assumption that the user is logged in and verified. It calls
+/// `findScreenFromConfiguration` with the current URL's query parameters and
+/// path, assuming the user is logged in and verified. If a corresponding
+/// screen is accessible, its configuration is returned; otherwise, `null` is
+/// returned.
+ModelScreenConfiguration? currentUrlToLoginConfiguration() {
+  return findScreenFromConfiguration(
+    configuration: ModelScreenConfiguration(
+      args: Uri.base.queryParameters,
+      path: Uri.base.path,
+    ),
+    isLoggedInAndVerified: true,
+    isLoggedIn: true,
+    isLoggedOut: false,
+  )?.configuration;
+}
+
+/// Translates the current URL into a [ModelScreenConfiguration] under the
+/// assumption that the user is logged out. It calls `findScreenFromConfiguration`
+/// with the current URL's query parameters and path, assuming the user is
+/// logged out. If a corresponding screen is accessible, its configuration is
+/// returned; otherwise, `null` is returned.
+ModelScreenConfiguration? currentUrlToLogoutConfiguration() {
+  return findScreenFromConfiguration(
+    configuration: ModelScreenConfiguration(
+      args: Uri.base.queryParameters,
+      path: Uri.base.path,
+    ),
+    isLoggedInAndVerified: false,
+    isLoggedIn: false,
+    isLoggedOut: true,
+  )?.configuration;
+}
+```