Add Data Tables

Author: olexale

CHANGELOG.md

@@ -1,3 +1,7 @@
+## [1.2.1] - Data Tables
+
+* Add data tables support
+
 ## [1.2.0] - Scenario Outline
 
 * Add scenario outline support

README.md

@@ -51,7 +51,7 @@ flutter test
 
 Feature file sample:
 ```ruby
-// comment here
+# comment here
 
 Feature: Counter
 

example/pubspec.lock

@@ -42,7 +42,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "1.2.0"
+    version: "1.2.1"
   boolean_selector:
     dependency: transitive
     description:

lib/src/bdd_line.dart

@@ -19,6 +19,7 @@ enum LineType {
   step,
   after,
   examples,
+  exampleTitle,
   unknown,
 }
 
@@ -44,6 +45,9 @@ LineType _lineTypeFromString(String line) {
   if (examplesMarkers.any((marker) => line.startsWith(marker))) {
     return LineType.examples;
   }
+  if (examplesTitleMarkers.any((marker) => line.startsWith(marker))) {
+    return LineType.exampleTitle;
+  }
   if (tagMarkers.any((marker) => line.startsWith(marker))) {
     return LineType.tag;
   }
@@ -57,7 +61,8 @@ const tagMarkers = ['@'];
 const scenarioMarkers = ['Scenario:', 'Example:'];
 const scenarioOutlineMarkers = ['Scenario Outline:'];
 const stepMarkers = ['Given', 'When', 'Then', 'And', 'But'];
-const examplesMarkers = ['Examples:', 'Scenarios', '|'];
+const examplesMarkers = ['|'];
+const examplesTitleMarkers = ['Examples:', 'Scenarios'];
 
 String _removeLinePrefix(String rawLine) {
   final lines = rawLine.split(' ');

lib/src/data_table_parser.dart

@@ -0,0 +1,37 @@
+import 'package:bdd_widget_test/src/bdd_line.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;
+    }
+    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];
+      }
+      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;

lib/src/feature_generator.dart

@@ -1,4 +1,5 @@
 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/scenario_generator.dart';
 import 'package:bdd_widget_test/src/step_file.dart';
 import 'package:bdd_widget_test/src/step_generator.dart';
@@ -103,27 +104,21 @@ void _parseFeature(
   for (final scenario in scenarios) {
     final scenarioTestMethodName =
         _parseScenaioTags(feature, scenario.first, testMethodName);
-    if (scenario.first.type == LineType.scenario) {
+
+    final flattenDataTables = replaceDataTables(scenario).toList();
+    final scenariosToParse = flattenDataTables.first.type == LineType.scenario
+        ? [flattenDataTables]
+        : generateScenariosFromScenaioOutline(flattenDataTables);
+
+    for (final s in scenariosToParse) {
       parseScenario(
         sb,
-        scenario.first.value,
-        scenario.where((e) => e.type == LineType.step).toList(),
+        s.first.value,
+        s.where((e) => e.type == LineType.step).toList(),
         hasSetUp,
         hasTearDown,
         scenarioTestMethodName,
       );
-    } else {
-      final generatedScenarios = generateScenariosFromScenaioOutline(scenario);
-      for (final g in generatedScenarios) {
-        parseScenario(
-          sb,
-          g.first.value,
-          g.where((e) => e.type == LineType.step).toList(),
-          hasSetUp,
-          hasTearDown,
-          scenarioTestMethodName,
-        );
-      }
     }
   }
   sb.writeln('  });');

lib/src/scenario_generator.dart

@@ -40,12 +40,12 @@ List<Map<String, String>> _getExamples(
   List<BddLine> scenario,
 ) {
   final exampleLines = scenario
+      .skipWhile((l) => l.type != LineType.exampleTitle)
       .where((l) => l.type == LineType.examples)
-      .skip(1) // Skip 'Examples:` line
       .map((e) => e.rawLine.substring(
             // Remove the first and the last '|' separator
             1,
-            e.rawLine.length - 2,
+            e.rawLine.length - 1,
           ))
       .map(_parseExampleLine);
   final names = exampleLines.first;
@@ -61,7 +61,7 @@ Iterable<BddLine> _processScenarioLines(
   yield BddLine.fromValue(
       name.type, '${name.value} (${examples.values.join(', ')})');
 
-  for (final line in lines.skip(1).where((l) => l.type == LineType.step)) {
+  for (final line in lines.skip(1)) {
     yield BddLine.fromValue(
         line.type, _replacePlaceholders(line.value, examples));
   }
@@ -70,7 +70,7 @@ Iterable<BddLine> _processScenarioLines(
 String _replacePlaceholders(String line, Map<String, String> example) {
   var replaced = line;
   for (final e in example.keys) {
-    replaced = replaced.replaceAll(' <$e> ', ' {${example[e]}} ');
+    replaced = replaced.replaceAll('<$e>', '{${example[e]}}');
   }
   return replaced;
 }

lib/src/step/generic_step.dart

@@ -17,7 +17,7 @@ ${getStepSignature(rawLine)} {
 ''';
 
   String getStepSignature(String stepLine) {
-    final params = parametersValueRegExp.allMatches(stepLine);
+    final params = parametersRegExp.allMatches(stepLine);
     if (params.isEmpty) {
       final examples = examplesRegExp.allMatches(stepLine);
       if (examples.isEmpty) {

lib/src/step_generator.dart

@@ -38,15 +38,16 @@ String getStepMethodName(String stepText) {
   return camelize(text);
 }
 
-String getStepMethodCall(String stepLine) {
+String getStepMethodCall(String stepLine, {List<String>? forceParams}) {
   final name = getStepMethodName(stepLine);
 
   final params = parametersValueRegExp.allMatches(stepLine);
-  if (params.isEmpty) {
+  if (params.isEmpty && forceParams == null) {
     return '$name(tester)';
   }
 
-  final methodParameters = params.map((p) => p.group(0)).join(', ');
+  final methodParameters =
+      forceParams ?? params.map((p) => p.group(0)).join(', ');
   return '$name(tester, $methodParameters)';
 }
 

pubspec.yaml

@@ -1,6 +1,6 @@
 name: bdd_widget_test
 description: A BDD-style widget testing library. Generates Flutter widget tests from *.feature files.
-version: 1.2.0
+version: 1.2.1
 author: Oleksandr Leushchenko <olexa.le@gmail.com>
 homepage: https://github.com/olexale/bdd_widget_test