From 669e1791e6ec3c32323a701680ba03d7c2ab2416 Mon Sep 17 00:00:00 2001
From: hedhyw <hedhyw@yahoo.com>
Date: Sat, 16 Sep 2023 05:47:52 +0300
Subject: [PATCH] docs: use scenario outline for scenarios with examples [#95]

---
 README.md                                        |  2 +-
 internal/app/app.feature                         | 16 ++++++++--------
 internal/docplugin/goplugin/goplugin.go          | 10 +++++++++-
 internal/generator/examples/bool.feature         |  2 +-
 .../generator/examples/default/bool.feature.json |  2 +-
 .../examples/default/issue_26.feature.json       |  2 +-
 .../examples/default/readme.feature.json         |  2 +-
 internal/generator/examples/issue_26.feature     |  2 +-
 .../examples/parallel/bool.feature.json          |  2 +-
 .../examples/parallel/issue_26.feature.json      |  2 +-
 .../examples/parallel/readme.feature.json        |  2 +-
 internal/generator/examples/readme.feature       |  2 +-
 internal/generator/generator_test.feature        |  2 +-
 13 files changed, 28 insertions(+), 20 deletions(-)

diff --git a/README.md b/README.md
index 1768015..a9178a7 100644
--- a/README.md
+++ b/README.md
@@ -20,7 +20,7 @@ The generator is very customizable, it is possible to customize an output for an
 **Given** [feature](internal/generator/examples/readme.feature) [[reference](https://cucumber.io/docs/gherkin/reference/)]:
 ```feature
 Feature: Application command line tool
-  Scenario: User wants to see usage information
+  Scenario Outline: User wants to see usage information
     When the application is started with <flag>
     Then usage should be printed <printed>
     And exit status should be <exit_status>
diff --git a/internal/app/app.feature b/internal/app/app.feature
index 5dabd88..cf2a17d 100644
--- a/internal/app/app.feature
+++ b/internal/app/app.feature
@@ -1,5 +1,5 @@
 Feature: Application command line tool
-  Scenario: User wants to generate the output in given format
+  Scenario Outline: User wants to generate the output in given format
     When <format> is given
     And  <feature> is provided
     Then the output should be generated
@@ -11,21 +11,21 @@ Feature: Application command line tool
     | app.feature      | invalid  | does not    |
     | notfound.feature | raw      | does not    |
 
-  Scenario: User wants to see usage information
+  Scenario Outline: User wants to see usage information
     When <flag> is provided
     Then usage should be printed
     Examples:
     | <flag> |
     | --help |
 
-  Scenario: User wants to list built-in templates
+  Scenario Outline: User wants to list built-in templates
     When <flag> is provided
     Then templates should be printed
     Examples:
     | <flag> |
     | --list |
 
-  Scenario: User wants to use custom template
+  Scenario Outline: User wants to use custom template
     When <template> is provided
     And  <feature> is provided
     Then the output should be generated
@@ -35,7 +35,7 @@ Feature: Application command line tool
     | app.feature | @/std.struct.v1.go.tmpl         |
     | app.feature | @/std.simple.v1.go.tmpl         |
   
-  Scenario: User wants to set custom package
+  Scenario Outline: User wants to set custom package
     When <package> is provided
     Then the output should contain <package>
     Examples:
@@ -43,7 +43,7 @@ Feature: Application command line tool
     | app_test      |
     | example_test  |
   
-  Scenario: User wants to generate a permanent json output
+  Scenario Outline: User wants to generate a permanent json output
     When -format is json
     And -permanent-ids is <TheSameIDs>
     Then calling generation twice will produce the same output <TheSameIDs>
@@ -56,7 +56,7 @@ Feature: Application command line tool
     When flag -invalid is provided
     Then an error is returned
 
-  Scenario: User asks for a version
+  Scenario Outline: User asks for a version
     When <flag> is provided
     Then version is printed
     Examples:
@@ -64,7 +64,7 @@ Feature: Application command line tool
     | --version |
     | -version  |
 
-  Scenario: User specifies a file, but the file is not found
+  Scenario Outline: User specifies a file, but the file is not found
     When inexistent <template> is provided
     And  <feature> is provided
     Then the user receives an error
diff --git a/internal/docplugin/goplugin/goplugin.go b/internal/docplugin/goplugin/goplugin.go
index 9f0d79c..81a5353 100644
--- a/internal/docplugin/goplugin/goplugin.go
+++ b/internal/docplugin/goplugin/goplugin.go
@@ -169,7 +169,7 @@ func (p GoPlugin) handleStruct(
 		val.PluginData[dataFieldGoparallel] = p.args.Parallel
 		p.processRuleBackground(val)
 	case model.Scenario:
-		val.PluginData[dataFieldGoName] = p.aliaser.NameAlias(val.Keyword)
+		val.PluginData[dataFieldGoName] = p.aliaser.NameAlias(formatScenarioKeyword(val.Keyword))
 		val.PluginData[dataFieldGoValue] = p.aliaser.StringValue(val.Name)
 		val.PluginData[dataFieldGoType] = string(goTypeString)
 		val.PluginData[dataFieldGoparallel] = p.args.Parallel
@@ -191,6 +191,14 @@ func (p GoPlugin) handleStruct(
 	return nil
 }
 
+func formatScenarioKeyword(keyword string) string {
+	if strings.ToLower(keyword) == "scenario outline" {
+		keyword = "Scenario"
+	}
+
+	return keyword
+}
+
 func (p GoPlugin) processFeatureBackground(f model.Feature) {
 	var hasBackground bool
 
diff --git a/internal/generator/examples/bool.feature b/internal/generator/examples/bool.feature
index 5734648..5e74f8d 100644
--- a/internal/generator/examples/bool.feature
+++ b/internal/generator/examples/bool.feature
@@ -1,5 +1,5 @@
 Feature: Type determinatiopn
-  Scenario: All type are determinated
+  Scenario Outline: All type are determinated
     When generator completed
     Then correct types are shown
     Examples:
diff --git a/internal/generator/examples/default/bool.feature.json b/internal/generator/examples/default/bool.feature.json
index 07542c7..afd0187 100644
--- a/internal/generator/examples/default/bool.feature.json
+++ b/internal/generator/examples/default/bool.feature.json
@@ -19,7 +19,7 @@
                         "PluginData": {}
                     },
                     "Tags": [],
-                    "Keyword": "Scenario",
+                    "Keyword": "Scenario Outline",
                     "Name": "All type are determinated",
                     "Description": "",
                     "Steps": [
diff --git a/internal/generator/examples/default/issue_26.feature.json b/internal/generator/examples/default/issue_26.feature.json
index 2bf9915..10766f1 100644
--- a/internal/generator/examples/default/issue_26.feature.json
+++ b/internal/generator/examples/default/issue_26.feature.json
@@ -19,7 +19,7 @@
                         "PluginData": {}
                     },
                     "Tags": [],
-                    "Keyword": "Scenario",
+                    "Keyword": "Scenario Outline",
                     "Name": "Just a hello world",
                     "Description": "",
                     "Steps": [],
diff --git a/internal/generator/examples/default/readme.feature.json b/internal/generator/examples/default/readme.feature.json
index 94cbf5d..525be6b 100644
--- a/internal/generator/examples/default/readme.feature.json
+++ b/internal/generator/examples/default/readme.feature.json
@@ -19,7 +19,7 @@
                         "PluginData": {}
                     },
                     "Tags": [],
-                    "Keyword": "Scenario",
+                    "Keyword": "Scenario Outline",
                     "Name": "User wants to see usage information",
                     "Description": "",
                     "Steps": [
diff --git a/internal/generator/examples/issue_26.feature b/internal/generator/examples/issue_26.feature
index 9a08194..d97e837 100644
--- a/internal/generator/examples/issue_26.feature
+++ b/internal/generator/examples/issue_26.feature
@@ -1,5 +1,5 @@
 Feature: Issue example
-    Scenario: Just a hello world
+    Scenario Outline: Just a hello world
         Examples:
         | <name>      |
         | hello world  |
\ No newline at end of file
diff --git a/internal/generator/examples/parallel/bool.feature.json b/internal/generator/examples/parallel/bool.feature.json
index 07542c7..afd0187 100644
--- a/internal/generator/examples/parallel/bool.feature.json
+++ b/internal/generator/examples/parallel/bool.feature.json
@@ -19,7 +19,7 @@
                         "PluginData": {}
                     },
                     "Tags": [],
-                    "Keyword": "Scenario",
+                    "Keyword": "Scenario Outline",
                     "Name": "All type are determinated",
                     "Description": "",
                     "Steps": [
diff --git a/internal/generator/examples/parallel/issue_26.feature.json b/internal/generator/examples/parallel/issue_26.feature.json
index 2bf9915..10766f1 100644
--- a/internal/generator/examples/parallel/issue_26.feature.json
+++ b/internal/generator/examples/parallel/issue_26.feature.json
@@ -19,7 +19,7 @@
                         "PluginData": {}
                     },
                     "Tags": [],
-                    "Keyword": "Scenario",
+                    "Keyword": "Scenario Outline",
                     "Name": "Just a hello world",
                     "Description": "",
                     "Steps": [],
diff --git a/internal/generator/examples/parallel/readme.feature.json b/internal/generator/examples/parallel/readme.feature.json
index 94cbf5d..525be6b 100644
--- a/internal/generator/examples/parallel/readme.feature.json
+++ b/internal/generator/examples/parallel/readme.feature.json
@@ -19,7 +19,7 @@
                         "PluginData": {}
                     },
                     "Tags": [],
-                    "Keyword": "Scenario",
+                    "Keyword": "Scenario Outline",
                     "Name": "User wants to see usage information",
                     "Description": "",
                     "Steps": [
diff --git a/internal/generator/examples/readme.feature b/internal/generator/examples/readme.feature
index 6503509..c744263 100644
--- a/internal/generator/examples/readme.feature
+++ b/internal/generator/examples/readme.feature
@@ -1,5 +1,5 @@
 Feature: Application command line tool
-  Scenario: User wants to see usage information
+  Scenario Outline: User wants to see usage information
     When the application is started with <flag>
     Then usage should be printed <printed>
     And exit status should be <exit_status>
diff --git a/internal/generator/generator_test.feature b/internal/generator/generator_test.feature
index ac8d50e..de77b07 100644
--- a/internal/generator/generator_test.feature
+++ b/internal/generator/generator_test.feature
@@ -1,5 +1,5 @@
 Feature: Guess the word
-  Scenario: <main_player> starts a game
+  Scenario Outline: <main_player> starts a game
     When the <main_player> starts a game at start_date
     Then the <main_player> waits for a <oponent_player> to join
     Examples: