From fb4b3c4987200403a6bc38e1eb06e36fff5495d9 Mon Sep 17 00:00:00 2001 From: Carlos Gutierrez Date: Fri, 16 Apr 2021 11:06:37 +0100 Subject: [PATCH 1/4] Improved readme and added install instructions --- Readme.md | 41 ++++++++++++++++++++++++++++++++--------- 1 file changed, 32 insertions(+), 9 deletions(-) diff --git a/Readme.md b/Readme.md index dcf2d2d..729c94b 100644 --- a/Readme.md +++ b/Readme.md @@ -2,24 +2,46 @@ A gem that contains generators that create things testers need. -Currently it only generates a cucumber project. You can do this by executing: +Firstly install the gem by running the following in the terminal: + +```bash +gem install testgen +``` + +Currently it only generates a cucumber project. You can do this by executing: testgen project - -This command will create a project in the project_name directory with the files needed to begin -developing cucumber features. There are options that can be provided to have the project configure to use different gems. Here are a few: + +This command will create a project in the project_name directory with the files needed to begin developing +cucumber features. + +``` +my_project_name +├── Gemfile +├── Rakefile +├── cucumber.yml +└── features + ├── step_definitions + └── support + ├── env.rb + ├── hooks.rb + └── pages +``` + +There are options that can be provided to have the project configure to use different gems. Here are a few: ## Web testing -If you are testing a web application, testgen can setup the project to use the PageObject gem. +If you are testing a web application, testgen can setup the project to use the [page-object](https://github.com/cheezy/page-object) gem. testgen project --pageobject-driver=watir - + Valid options for the --pageobject-driver option are 'watir' or 'selenium' ## Android testing -If you are testing an android application in the emulator or on a device, testgen can setup the project to use the Gametel gem. +If you are testing an android application in the emulator or on a device, testgen can setup the project to use +the Gametel gem. testgen project --with-gametel @@ -33,10 +55,11 @@ If you are testing a native windows application, testgen can setup the testgen project --with-mohawk - ## Moving page-objects or screen-objects to the lib directory -There is another option available with will create the page or screen directory in a base directoy named lib. It will also setup the project so these files get loaded the same way they would if the directory was in the support directory. Here's an example of creating a project for web testing using the lib option: +There is another option available with will create the page or screen directory in a base directoy named lib. It will +also setup the project so these files get loaded the same way they would if the directory was in the support directory. +Here's an example of creating a project for web testing using the lib option: testgen project --pageobject-driver=watir --with-lib From 1763b29f414a31486c5e6a9a9e775096088d1043 Mon Sep 17 00:00:00 2001 From: Carlos Gutierrez Date: Fri, 16 Apr 2021 12:06:05 +0100 Subject: [PATCH 2/4] Further updates to the readme --- .ruby-version | 2 +- Readme.md | 49 +++++++++++++++++++++++++++++-------------------- 2 files changed, 30 insertions(+), 21 deletions(-) diff --git a/.ruby-version b/.ruby-version index c1026d2..2eb2fe9 100644 --- a/.ruby-version +++ b/.ruby-version @@ -1 +1 @@ -ruby-2.3.1 +ruby-2.7.2 diff --git a/Readme.md b/Readme.md index 4a1824c..8a0ba88 100644 --- a/Readme.md +++ b/Readme.md @@ -4,16 +4,14 @@ A gem that contains generators that create things testers need. Firstly install the gem by running the following in the terminal: -```bash -gem install testgen -``` + gem install testgen -Currently it only generates a cucumber project. You can do this by executing: +By default it only generates a cucumber project. You can do this by executing: testgen project - -This command will create a project in the project_name directory with the files needed to begin -developing cucumber features. There are options that can be provided to have the project configure to use different gems. Here are a few: + +This command will create a project in the project_name directory with the files and directory structure needed +to begin developing cucumber features. ``` my_project_name @@ -32,32 +30,43 @@ There are options that can be provided to have the project configure to use diff ## Web testing -If you are testing a web application, testgen will by default setup the project to use the PageObject gem -with Watir. +If you are testing a web application, testgen will by default setup the project to use +the [page-object](https://github.com/cheezy/page-object) gem with +[Watir](http://watir.com/). testgen project - + ## Android testing -If you want to setup project to use the Appium library +If you want to setup project to use the [Appium](https://github.com/appium/ruby_lib) library testgen project --with-appium ## Native Windows testing -If you are testing a native windows application, testgen can setup the project to use the Mohawk gem. +If you are testing a native windows application, testgen can setup the project to use +the [Mohawk](https://github.com/leviwilson/mohawk) gem. testgen project --with-mohawk - ## Moving page-objects or screen-objects to the lib directory -There is another option available with will create the page or screen directory in a base directoy named lib. It will -also setup the project so these files get loaded the same way they would if the directory was in the support directory. -Here's an example of creating a project for web testing using the lib option: - - testgen project --pageobject-driver=watir --with-lib - - +There is another option available which will create the page or screen directory in a base directory named lib. +It will also setup the project so that these files get loaded the same way they would if the directory was in the +support directory. Here's an example of creating a project for web testing using the lib option: + testgen project --with-lib +``` +my_project_name +├── Gemfile +├── Rakefile +├── cucumber.yml +├── features +│ ├── step_definitions +│ └── support +│ ├── env.rb +│ └── hooks.rb +└── lib + └── pages +``` From 53bc660e604da876c61b8b1cda9634c156d7524e Mon Sep 17 00:00:00 2001 From: Carlos Gutierrez Date: Fri, 16 Apr 2021 12:23:48 +0100 Subject: [PATCH 3/4] Further edits to the readme --- Readme.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Readme.md b/Readme.md index 8a0ba88..9833730 100644 --- a/Readme.md +++ b/Readme.md @@ -2,7 +2,7 @@ A gem that contains generators that create things testers need. -Firstly install the gem by running the following in the terminal: +First install the gem by running the following in the terminal: gem install testgen @@ -26,7 +26,7 @@ my_project_name └── pages ``` -There are options that can be provided to have the project configure to use different gems. Here are a few: +There are options that can be provided to configure the project to use different gems. Below are the options available: ## Web testing From ef8cac0d88580d24087cda96eafad5639bcbce29 Mon Sep 17 00:00:00 2001 From: Carlos Gutierrez Date: Fri, 16 Apr 2021 12:29:14 +0100 Subject: [PATCH 4/4] Revert ruby-version --- .ruby-version | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.ruby-version b/.ruby-version index 2eb2fe9..c1026d2 100644 --- a/.ruby-version +++ b/.ruby-version @@ -1 +1 @@ -ruby-2.7.2 +ruby-2.3.1