From 16cb242c43aac4405581ed870c60d3498916cd81 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dennis=20G=C3=BCnnewig?= Date: Sun, 16 Jul 2017 22:12:54 +0200 Subject: [PATCH 01/10] Fix headings in README --- features/README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/features/README.md b/features/README.md index 3c00a6d15..b5349b818 100644 --- a/features/README.md +++ b/features/README.md @@ -28,7 +28,7 @@ Our Vision: Our Focus: * Test the user-interaction with the commands at runtime – this excludes the process of installation/deployment of commands like installing Rubygems with `gem install `. -## Install +# Install Add this line to your application's `Gemfile`: @@ -48,13 +48,13 @@ Or install it yourself as: gem install aruba ~~~ -## Usage +# Usage Please also see this [feature test](https://github.com/cucumber/aruba/tree/master/features/getting_started/supported_testing_frameworks.feature) for the most up to date documentation. -### Initialize your project with "aruba" +## Getting started There's an initializer to make it easier for you to getting started. If you prefer to setup `aruba` yourself, please move on to the next section. @@ -86,7 +86,7 @@ prefer to setup `aruba` yourself, please move on to the next section. bundle install ~~~ -#### Cucumber +### Cucumber 1. Create a file named "features/support/env.rb" with: @@ -116,7 +116,7 @@ prefer to setup `aruba` yourself, please move on to the next section. bundle exec cucumber ~~~ -#### RSpec +### RSpec 1. Create a file named "spec/spec_helper.rb" with the following content. If the file already exists add the line to the file. @@ -151,7 +151,7 @@ prefer to setup `aruba` yourself, please move on to the next section. bundle exec rspec ~~~ -#### Minitest +### Minitest 1. Add a file named "test/test_helper.rb" with: @@ -195,6 +195,6 @@ prefer to setup `aruba` yourself, please move on to the next section. A full documentation of the API can be found [here](http://www.rubydoc.info/github/cucumber/aruba/master/frames). -## Copyright +# Copyright Copyright (c) 2010-2017 Aslak Hellesøy et al. See [MIT License](LICENSE) for details. From e4f5b7ce4c89f2000c3690183df3c05f145ee4c8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dennis=20G=C3=BCnnewig?= Date: Sun, 16 Jul 2017 22:13:35 +0200 Subject: [PATCH 02/10] Draw more attention to feature test explaining support test libraries --- features/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/features/README.md b/features/README.md index b5349b818..2de0f536d 100644 --- a/features/README.md +++ b/features/README.md @@ -50,7 +50,7 @@ gem install aruba # Usage -Please also see this +**Note:** Please also see this [feature test](https://github.com/cucumber/aruba/tree/master/features/getting_started/supported_testing_frameworks.feature) for the most up to date documentation. From 2588dea9614bcfea65715e05d927ba8a9bec149a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dennis=20G=C3=BCnnewig?= Date: Sun, 16 Jul 2017 22:14:10 +0200 Subject: [PATCH 03/10] Fix wording and order of some sections --- features/README.md | 50 +++++++++++++++++++++++++--------------------- 1 file changed, 27 insertions(+), 23 deletions(-) diff --git a/features/README.md b/features/README.md index 2de0f536d..26c6ea42f 100644 --- a/features/README.md +++ b/features/README.md @@ -56,33 +56,16 @@ for the most up to date documentation. ## Getting started -There's an initializer to make it easier for you to getting started. If you -prefer to setup `aruba` yourself, please move on to the next section. - -1. Go to your project's directory - -2. Make sure, it's under version control and all changes are committed to your - version control repository - -3. Run one of the following commands depending on the tools you use to test your project. - - This assumes, that you use either `rspec`, `cucumber-ruby` or `minitest` to - write the tests for your project. Besides that, your tool can be implemented - in any programming language you like. +1. Clone the "Getting Started" application and make the cloned repository your current working directory ~~~bash - aruba init --test-framework rspec - aruba init --test-framework cucumber - aruba init --test-framework minitest + git clone https://github.com/cli-testing/aruba-getting-started.git + cd aruba-getting-started ~~~ -### Your First Tests with "aruba" - -1. Clone the "Getting Started" application and install its dependencies +2. Install the required depencies ~~~bash - git clone https://github.com/cli-testing/aruba-getting-started.git - cd aruba-getting-started bundle install ~~~ @@ -118,8 +101,7 @@ prefer to setup `aruba` yourself, please move on to the next section. ### RSpec -1. Create a file named "spec/spec_helper.rb" with the following content. If the - file already exists add the line to the file. +1. Add the following line to "spec/spec_helper.rb"-file. ~~~ruby require 'aruba/rspec' @@ -195,6 +177,28 @@ prefer to setup `aruba` yourself, please move on to the next section. A full documentation of the API can be found [here](http://www.rubydoc.info/github/cucumber/aruba/master/frames). +# Initialize an existing project + +There's an initializer to make it easier for you to getting started. If you +prefer to setup `aruba` yourself, please move on to the next section. + +1. Go to your project's directory + +2. Make sure, it's under version control and all changes are committed to your + version control repository + +3. Run one of the following commands depending on the tools you use to test your project. + + This assumes, that you use either `rspec`, `cucumber-ruby` or `minitest` to + write the tests for your project. Besides that, your tool can be implemented + in any programming language you like. + + ~~~bash + aruba init --test-framework rspec + aruba init --test-framework cucumber + aruba init --test-framework minitest + ~~~ + # Copyright Copyright (c) 2010-2017 Aslak Hellesøy et al. See [MIT License](LICENSE) for details. From f875fb786175141382ace82ed0cf914c52151384 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dennis=20G=C3=BCnnewig?= Date: Sun, 16 Jul 2017 22:20:26 +0200 Subject: [PATCH 04/10] Fix wording for helper files --- features/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/features/README.md b/features/README.md index 26c6ea42f..5392cdec4 100644 --- a/features/README.md +++ b/features/README.md @@ -101,7 +101,7 @@ for the most up to date documentation. ### RSpec -1. Add the following line to "spec/spec_helper.rb"-file. +1. Add the following line to the "spec/spec_helper.rb"-file. ~~~ruby require 'aruba/rspec' @@ -135,7 +135,7 @@ for the most up to date documentation. ### Minitest -1. Add a file named "test/test_helper.rb" with: +1. Add the following line to the "test/test_helper.rb"-file. ~~~ruby require 'aruba/api' From 6ff9b16b1390766296669cbc8646ef61508084e4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dennis=20G=C3=BCnnewig?= Date: Sun, 16 Jul 2017 22:21:20 +0200 Subject: [PATCH 05/10] Leave $LOAD_PATH unmodified since this is done by -I lib:test --- features/README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/features/README.md b/features/README.md index 5392cdec4..f3d3618cd 100644 --- a/features/README.md +++ b/features/README.md @@ -144,8 +144,6 @@ for the most up to date documentation. 3. Add a file named "test/use_aruba_with_minitest.rb" with: ~~~ruby - $LOAD_PATH.unshift File.expand_path('../test', __FILE__) - require 'test_helper' require 'minitest/autorun' @@ -171,7 +169,7 @@ for the most up to date documentation. 4. Run your tests ~~~bash - bundle exec ruby -Ilib:test test/use_aruba_with_minitest.rb + bundle exec ruby -I lib:test test/use_aruba_with_minitest.rb ~~~ A full documentation of the API can be found From 0f91bc3ff8b62fc4c2b509ea9c8cd908fd076640 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dennis=20G=C3=BCnnewig?= Date: Sun, 16 Jul 2017 22:28:59 +0200 Subject: [PATCH 06/10] Fix link to supported testing frameworks --- features/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/features/README.md b/features/README.md index f3d3618cd..d6b953e77 100644 --- a/features/README.md +++ b/features/README.md @@ -12,7 +12,7 @@ Your benefits: * Test any command line application implemented in any [programming - language](https://github.com/cucumber/aruba/tree/master/features/getting_started/supported_programming_languages.feature) - + language](https://github.com/cucumber/aruba/tree/master/features/01_getting_started_with_aruba/supported_testing_frameworks.feature) - e.g. Bash, Python, Ruby, Java, ... * Manipulate the file system and the process environment with helpers working similar like tools you may know from your shell * No worries about leaking state: The file system and the process environment will be reset between tests From 0cdd812e3aff157a3f63ef4f6b63d5d37aaf0afa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dennis=20G=C3=BCnnewig?= Date: Sun, 16 Jul 2017 22:34:39 +0200 Subject: [PATCH 07/10] Fix typos in text --- features/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/features/README.md b/features/README.md index d6b953e77..7b4250b33 100644 --- a/features/README.md +++ b/features/README.md @@ -63,7 +63,7 @@ for the most up to date documentation. cd aruba-getting-started ~~~ -2. Install the required depencies +2. Install the required dependencies ~~~bash bundle install @@ -101,7 +101,7 @@ for the most up to date documentation. ### RSpec -1. Add the following line to the "spec/spec_helper.rb"-file. +1. Add the following line to the "spec/spec_helper.rb" file. ~~~ruby require 'aruba/rspec' @@ -135,7 +135,7 @@ for the most up to date documentation. ### Minitest -1. Add the following line to the "test/test_helper.rb"-file. +1. Add the following line to the "test/test_helper.rb" file. ~~~ruby require 'aruba/api' @@ -182,7 +182,7 @@ prefer to setup `aruba` yourself, please move on to the next section. 1. Go to your project's directory -2. Make sure, it's under version control and all changes are committed to your +2. Make sure it's under version control and all changes are committed to your version control repository 3. Run one of the following commands depending on the tools you use to test your project. From b35002a32e51c33fe8f7bcd7d7843b9cbfbad8e1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dennis=20G=C3=BCnnewig?= Date: Sun, 16 Jul 2017 23:01:38 +0200 Subject: [PATCH 08/10] Fix another broken link to other documentation --- features/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/features/README.md b/features/README.md index 7b4250b33..eee0268bc 100644 --- a/features/README.md +++ b/features/README.md @@ -51,7 +51,7 @@ gem install aruba # Usage **Note:** Please also see this -[feature test](https://github.com/cucumber/aruba/tree/master/features/getting_started/supported_testing_frameworks.feature) +[feature test](https://github.com/cucumber/aruba/tree/master/features/01_getting_started_with_aruba/supported_testing_frameworks.feature) for the most up to date documentation. ## Getting started From bba9466109793a40812c8a4dff5a18762829dba0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dennis=20G=C3=BCnnewig?= Date: Sun, 16 Jul 2017 23:03:11 +0200 Subject: [PATCH 09/10] Use links to cucumber.pro --- features/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/features/README.md b/features/README.md index eee0268bc..6542733e2 100644 --- a/features/README.md +++ b/features/README.md @@ -12,12 +12,12 @@ Your benefits: * Test any command line application implemented in any [programming - language](https://github.com/cucumber/aruba/tree/master/features/01_getting_started_with_aruba/supported_testing_frameworks.feature) - + language](https://app.cucumber.pro/projects/Aruba/documents/master/features/01_getting_started_with_aruba/supported_testing_frameworks.feature) - e.g. Bash, Python, Ruby, Java, ... * Manipulate the file system and the process environment with helpers working similar like tools you may know from your shell * No worries about leaking state: The file system and the process environment will be reset between tests * Support by a helpful and welcoming community – see our [Code of Conduct](https://github.com/cucumber/cucumber/blob/master/CODE_OF_CONDUCT.md) -* The [documentation](https://github.com/cucumber/aruba/tree/master/features/) is our contract with you. You can expect `aruba` to work as documented +* The [documentation](https://app.cucumber.pro/projects/aruba) is our contract with you. You can expect `aruba` to work as documented Our Vision: @@ -51,7 +51,7 @@ gem install aruba # Usage **Note:** Please also see this -[feature test](https://github.com/cucumber/aruba/tree/master/features/01_getting_started_with_aruba/supported_testing_frameworks.feature) +[feature test](https://app.cucumber.pro/projects/Aruba/documents/master/features/01_getting_started_with_aruba/supported_testing_frameworks.feature) for the most up to date documentation. ## Getting started From 8ec78b84453c35ad176d37b130b223ec91d5f42a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dennis=20G=C3=BCnnewig?= Date: Sun, 16 Jul 2017 23:08:14 +0200 Subject: [PATCH 10/10] Take move of section into account --- features/README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/features/README.md b/features/README.md index 6542733e2..187368583 100644 --- a/features/README.md +++ b/features/README.md @@ -177,8 +177,7 @@ A full documentation of the API can be found # Initialize an existing project -There's an initializer to make it easier for you to getting started. If you -prefer to setup `aruba` yourself, please move on to the next section. +There's an initializer to make it easier for you to get started. 1. Go to your project's directory