Cucumber data table

.gitignore

@@ -75,3 +75,4 @@ pubspec.lock
 !**/ios/**/default.perspectivev3
 !/packages/flutter_tools/test/data/dart_dependencies_test/**/.packages
 coverage/lcov.info
+/coverage/

example/test/songs.feature

@@ -0,0 +1,7 @@
+Feature: Songs
+
+  Scenario: Available songs
+    Given the following songs
+      | 'artist'      | 'title'              |
+      | 'The Beatles' | 'Let It Be'          |
+      | 'Camel'       | 'Slow yourself down' |

example/test/step/the_following_songs.dart

@@ -0,0 +1,7 @@
+import 'package:bdd_widget_test/src/data_table.dart' as bdd;
+import 'package:flutter_test/flutter_test.dart';
+
+/// Usage: the following songs
+Future<void> theFollowingSongs(WidgetTester tester, bdd.DataTable dataTable) async {
+  throw UnimplementedError();
+}

lib/src/bdd_line.dart

@@ -10,6 +10,10 @@ class BddLine {
   final LineType type;
 }
 
+class DataTableBddLine extends BddLine {
+  DataTableBddLine(super.rawLine);
+}
+
 enum LineType {
   feature,
   background,

lib/src/data_table.dart

@@ -0,0 +1,23 @@
+import 'package:collection/collection.dart';
+
+class DataTable {
+  const DataTable(this._data);
+
+  final List<List<dynamic>> _data;
+
+  List<List<dynamic>> asLists({bool ignoreFirstRow = false}) =>
+      _data.sublist(ignoreFirstRow ? 1 : 0, _data.length);
+
+  List<Map<dynamic, dynamic>> asMaps() {
+    final result = <Map<dynamic, dynamic>>[];
+    final headers = _data.first;
+    _data.skip(1).forEach((row) {
+      final map = <dynamic, dynamic>{};
+      headers.forEachIndexed((index, header) {
+        map[header] = row[index];
+      });
+      result.add(map);
+    });
+    return result;
+  }
+}

lib/src/data_table_parser.dart

@@ -1,37 +1,79 @@
 import 'package:bdd_widget_test/src/bdd_line.dart';
+import 'package:bdd_widget_test/src/regex.dart';
 import 'package:bdd_widget_test/src/scenario_generator.dart';
 
-Iterable<BddLine> replaceDataTables(List<BddLine> lines) sync* {
-  var reachedExamples = false;
-  var i = 0;
-  while (i < lines.length) {
-    if (lines[i].type == LineType.exampleTitle) {
-      reachedExamples = true;
-    }
-    if (reachedExamples) {
-      yield lines[i++];
-      continue;
+abstract class DataTableParser {
+  static bool hasBddDataTable(List<BddLine> lines) {
+    for (var index = 0; index < lines.length; index++) {
+      final isStep = lines[index].type == LineType.step;
+      final isNextLineTable = isNextTable(lines: lines, index: index + 1);
+      final isExamplesFormatted = hasExamplesFormat(bddLine: lines[index]);
+      if (isStep && isNextLineTable && !isExamplesFormatted) {
+        return true;
+      }
     }
-    if (i + 1 < lines.length && _foundDataTable(lines, i)) {
-      final dataTable = [
-        lines[i],
-        ...lines.skip(i + 1).takeWhile((l) => l.type == LineType.examples),
-      ];
-      final data = generateScenariosFromScenaioOutline([
-        // pretend to be an Example section to re-use some logic
-        BddLine.fromValue(LineType.exampleTitle, ''),
-        ...dataTable,
-      ]);
-      for (final item in data) {
-        yield item[1];
+    return false;
+  }
+
+  static Iterable<BddLine> replaceDataTables(List<BddLine> lines) sync* {
+    for (var index = 0; index < lines.length; index++) {
+      final isStep = lines[index].type == LineType.step;
+      final isNextLineTable = isNextTable(lines: lines, index: index + 1);
+      if (isStep && isNextLineTable) {
+        if (!hasExamplesFormat(bddLine: lines[index])) {
+          // Cucumber data table
+          final text = lines[index].value;
+          final table = List<List<String>>.empty(growable: true);
+          do {
+            table.add(_createRow(bddLine: lines[++index]));
+          } while (isNextTable(lines: lines, index: index + 1));
+          yield BddLine.fromValue(
+            LineType.step,
+            '$text {const bdd.DataTable($table)}',
+          );
+        } else {
+          // Data table formatted as examples
+          final dataTable = [lines[index]];
+          do {
+            dataTable.add(lines[++index]);
+          } while (index + 1 < lines.length &&
+              lines[index + 1].type == LineType.examples);
+          final data = generateScenariosFromScenaioOutline([
+            // pretend to be an Example section to re-use some logic
+            BddLine.fromValue(LineType.exampleTitle, ''),
+            ...dataTable,
+          ]);
+
+          for (final item in data) {
+            yield item[1];
+          }
+        }
+      } else {
+        yield lines[index];
       }
-      i += dataTable.length;
-      continue;
     }
-    yield lines[i++];
   }
-}
 
-bool _foundDataTable(List<BddLine> lines, int index) =>
-    lines[index].type == LineType.step &&
-    lines[index + 1].type == LineType.examples;
+  static bool isNextTable({
+    required List<BddLine> lines,
+    required int index,
+  }) =>
+      index < lines.length && _isTable(bddLine: lines[index]);
+
+  static bool _isTable({required BddLine bddLine}) =>
+      bddLine.type == LineType.examples;
+
+  static bool hasExamplesFormat({required BddLine bddLine}) =>
+      examplesRegExp.allMatches(bddLine.rawLine).isNotEmpty;
+
+  static List<String> _createRow({
+    required BddLine bddLine,
+  }) =>
+      List<String>.unmodifiable(
+        bddLine.value
+            .split('|')
+            .map((example) => example.trim())
+            .takeWhile((value) => value.isNotEmpty)
+            .toList(),
+      );
+}

lib/src/feature_file.dart

@@ -1,9 +1,11 @@
 import 'package:bdd_widget_test/src/bdd_line.dart';
+import 'package:bdd_widget_test/src/data_table_parser.dart';
 import 'package:bdd_widget_test/src/feature_generator.dart';
 import 'package:bdd_widget_test/src/generator_options.dart';
 import 'package:bdd_widget_test/src/step_file.dart';
 import 'package:bdd_widget_test/src/util/common.dart';
 import 'package:bdd_widget_test/src/util/constants.dart';
+import 'package:collection/collection.dart';
 
 class FeatureFile {
   FeatureFile({
@@ -39,6 +41,7 @@ class FeatureFile {
             generatorOptions,
             _testerType,
             _testerName,
+            e is DataTableBddLine,
           ),
         )
         .toList();
@@ -67,10 +70,28 @@ class FeatureFile {
   List<StepFile> getStepFiles() => _stepFiles;
 
   static List<BddLine> _prepareLines(Iterable<BddLine> input) {
-    final headers = input.takeWhile((value) => value.type == LineType.unknown);
-    final lines = input
+    final lines = input.mapIndexed(
+      (index, bddLine) {
+        final isStep = bddLine.type == LineType.step;
+        final hasExamplesFormat = DataTableParser.hasExamplesFormat(
+          bddLine: bddLine,
+        );
+        final isNextTable = DataTableParser.isNextTable(
+          lines: input.toList(),
+          index: index + 1,
+        );
+        if (isStep && !hasExamplesFormat && isNextTable) {
+          return DataTableBddLine(bddLine.rawLine);
+        } else {
+          return bddLine;
+        }
+      },
+    );
+
+    final headers = lines.takeWhile((value) => value.type == LineType.unknown);
+    final steps = lines
         .skip(headers.length)
         .where((value) => value.type != LineType.unknown);
-    return [...headers, ...lines];
+    return [...headers, ...steps];
   }
 }

lib/src/feature_generator.dart

@@ -48,6 +48,9 @@ String generateFeatureDart(
   if (tags.isNotEmpty) {
     sb.writeln("@Tags(['${tags.join("', '")}'])");
   }
+  if (DataTableParser.hasBddDataTable(lines)) {
+    sb.writeln("import 'package:bdd_widget_test/src/data_table.dart' as bdd;");
+  }
   sb.writeln("import 'package:flutter/material.dart';");
   sb.writeln("import 'package:flutter_test/flutter_test.dart';");
   if (isIntegrationTest) {
@@ -175,7 +178,7 @@ void _parseFeature(
       scenarioParamsTag,
     );
 
-    final flattenDataTables = replaceDataTables(
+    final flattenDataTables = DataTableParser.replaceDataTables(
       scenario.skipWhile((line) => line.type == LineType.tag).toList(),
     ).toList();
     final scenariosToParse = flattenDataTables.first.type == LineType.scenario

lib/src/step/generic_step.dart

@@ -9,24 +9,37 @@ class GenericStep implements BddStep {
     this.rawLine,
     this.testerType,
     this.customTesterName,
+    this.hadDataTable,
   );
 
   final String rawLine;
   final String methodName;
   final String testerType;
   final String customTesterName;
+  final bool hadDataTable;
 
   @override
-  String get content => '''
+  String get content {
+    var result = '';
+    if (hadDataTable) {
+      result +=
+          "import 'package:bdd_widget_test/src/data_table.dart' as bdd;\n";
+    }
+    return result += '''
 import 'package:flutter_test/flutter_test.dart';
 
 /// Usage: $rawLine
-Future<void> $methodName($testerType $customTesterName${_getMethodParameters(rawLine)}) async {
+Future<void> $methodName($testerType $customTesterName${_getMethodParameters(rawLine, hadDataTable)}) async {
   throw UnimplementedError();
 }
 ''';
+  }
+
+  String _getMethodParameters(String stepLine, bool hadDataTable) {
+    if (hadDataTable) {
+      return ', bdd.DataTable dataTable';
+    }
 
-  String _getMethodParameters(String stepLine) {
     final params = parseRawStepLine(stepLine).skip(1);
     if (params.isNotEmpty) {
       return params

lib/src/step_file.dart

@@ -15,6 +15,7 @@ abstract class StepFile {
     GeneratorOptions generatorOptions,
     String testerTypeTagValue,
     String testerNameTagValue,
+    bool hadDataTable,
   ) {
     final file = '${getStepFilename(line)}.dart';
 
@@ -42,6 +43,7 @@ abstract class StepFile {
         line,
         testerTypeTagValue,
         testerNameTagValue,
+        hadDataTable,
       );
     }
 
@@ -57,6 +59,7 @@ abstract class StepFile {
       line,
       testerTypeTagValue,
       testerNameTagValue,
+      hadDataTable,
     );
   }
 }
@@ -69,16 +72,22 @@ class NewStepFile extends StepFile {
     this.line,
     this.testerType,
     this.testerName,
+    this.isDataTable,
   ) : super._();
 
   final String package;
   final String line;
   final String filename;
   final String testerType;
   final String testerName;
-
-  String get dartContent =>
-      generateStepDart(package, line, testerType, testerName);
+  final bool isDataTable;
+  String get dartContent => generateStepDart(
+        package,
+        line,
+        testerType,
+        testerName,
+        isDataTable,
+      );
 }
 
 class ExistingStepFile extends StepFile {

lib/src/step_generator.dart

@@ -51,11 +51,18 @@ String generateStepDart(
   String line,
   String testerType,
   String customTesterName,
+  bool hadDataTable,
 ) {
   final methodName = getStepMethodName(line);
 
-  final bddStep =
-      _getStep(methodName, package, line, testerType, customTesterName);
+  final bddStep = _getStep(
+    methodName,
+    package,
+    line,
+    testerType,
+    customTesterName,
+    hadDataTable,
+  );
   return bddStep.content;
 }
 
@@ -65,10 +72,17 @@ BddStep _getStep(
   String line,
   String testerType,
   String testerName,
+  bool hadDataTable,
 ) {
   //for now, predefined steps don't support testerType
   final factory = predefinedSteps[methodName] ??
-      (_, __) => GenericStep(methodName, line, testerType, testerName);
+      (_, __) => GenericStep(
+            methodName,
+            line,
+            testerType,
+            testerName,
+            hadDataTable,
+          );
   return factory(package, line);
 }