ruby_raider 0.4.7 → 0.4.8
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +6 -0
- data/lib/generators/templates/common/read_me.tt +94 -30
- data/ruby_raider.gemspec +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 904822acb4d07440328f3b619533a79374988766b0882f668f31e32f8636adb3
|
4
|
+
data.tar.gz: e64bfe97f99255eac84ee1f6e850b5ce02293b0bc0314e031d047ee67071e3f3
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c77b13d45b719d5ab8add012d22f9b2c1016d53877441dc7b6b1a9fde39553c1eac5f951d8c9f1e5d7012eb14b9da162fc12c0d08274eb24791cb0fefb462b48
|
7
|
+
data.tar.gz: 610e5101c0f09d3ba1898d03111745e0208705ad36a5337dce2fd44b381afa0116f1a050be4c19896f0a973ae36b26b81a65f0d009568821ea82fdfd162204d5
|
data/README.md
CHANGED
@@ -51,8 +51,12 @@ Ruby Raider is a generator and scaffolding gem to make UI test automation easier
|
|
51
51
|
|
52
52
|
* Generating a framework with Cucumber and Appium cross platform
|
53
53
|
|
54
|
+
* Generating a visual testing framework with Rspec, Applitools and Selenium
|
55
|
+
|
54
56
|
***In order to run the Appium tests, download the example [app](https://github.com/saucelabs/my-demo-app-rn).***
|
55
57
|
|
58
|
+
***In order to run the visual tests with applitools, you need to create an account and get your api key, you can read more [here](https://applitools.com/docs/topics/overview/obtain-api-key.html#:~:text=If%20you%20already%20have%20an,Your%20key%20will%20be%20displayed.).***
|
59
|
+
|
56
60
|
This works in all the platforms (Tested on Mac OS, Linux and Windows).
|
57
61
|
|
58
62
|
## Getting started
|
@@ -106,6 +110,8 @@ Commands:
|
|
106
110
|
raider spec [SPEC_NAME] # Creates a new spec
|
107
111
|
|
108
112
|
raider url [URL] # Sets the default url for a project
|
113
|
+
|
114
|
+
raider version # It shows the version of Ruby Raider you are currently using
|
109
115
|
```
|
110
116
|
|
111
117
|
Ruby raider also supports scaffolding:
|
@@ -1,67 +1,131 @@
|
|
1
1
|
# Ruby Raider
|
2
2
|
|
3
|
-
|
4
|
-
|
3
|
+
<!-- PROJECT LOGO -->
|
4
|
+
<br />
|
5
|
+
<div align="center">
|
6
|
+
<a href="https://github.com/RubyRaider/ruby_raider">
|
7
|
+
<img src="https://rubyraiderdotcom.files.wordpress.com/2022/05/logo_transparent_background-1.png" alt="Logo">
|
8
|
+
</a>
|
9
|
+
<h1 align="center">Ruby Raider</h1>
|
10
|
+
<p align="center">
|
11
|
+
This is a gem to make setup and start of UI automation projects easier.
|
12
|
+
<br />
|
13
|
+
<a href="https://github.com/RubyRaider/ruby_raider#getting-started"><strong>Explore the docs »</strong></a>
|
14
|
+
<br />
|
15
|
+
<br />
|
16
|
+
<a href="https://rubygems.org/gems/ruby_raider">Rubygems</a>
|
17
|
+
·
|
18
|
+
<a href="https://github.com/RubyRaider/ruby_raider/issues">Report Bug</a>
|
19
|
+
·
|
20
|
+
<a href="https://github.com/RubyRaider/ruby_raider/issues">Request Feature</a>
|
21
|
+
</p>
|
22
|
+
<p align="center"> For more information and updates on releases, see <a href="https://ruby-raider.com">https://ruby-raider.com</a></p>
|
23
|
+
</div>
|
5
24
|
|
6
|
-
|
25
|
+
## What is ruby raider?
|
7
26
|
|
8
|
-
|
27
|
+
Ruby Raider is a generator and scaffolding gem to make UI test automation easier
|
9
28
|
|
10
|
-
|
29
|
+
### At the moment Ruby raider supports
|
11
30
|
|
12
|
-
|
31
|
+
* Generating a framework with Cucumber and Selenium
|
13
32
|
|
14
|
-
|
33
|
+
* Generating a framework with Rspec and Selenium
|
15
34
|
|
16
|
-
|
35
|
+
* Generating a framework with Cucumber and Watir
|
17
36
|
|
18
|
-
*
|
19
|
-
* Gerating a Watir with both Cucumber and Rspec framework
|
20
|
-
* Generating an Appium project with Rspec and Cucumber on IOS
|
21
|
-
* Generating an Appium project with Rspec and Cucumber on Android
|
22
|
-
* Generating an Appium project with Rspec and Cucumber cross platform
|
37
|
+
* Generating a framework with Rspec and Watir
|
23
38
|
|
24
|
-
|
39
|
+
* Generating a framework with Rspec and Appium for IOS
|
25
40
|
|
26
|
-
|
41
|
+
* Generating a framework with Cucumber and Appium for IOS
|
27
42
|
|
28
|
-
|
43
|
+
* Generating a framework with Rspec and Appium for Android
|
44
|
+
|
45
|
+
* Generating a framework with Cucumber and Appium for Android
|
46
|
+
|
47
|
+
* Generating a framework with Rspec and Appium cross platform
|
48
|
+
|
49
|
+
* Generating a framework with Cucumber and Appium cross platform
|
50
|
+
|
51
|
+
* Generating a visual testing framework with Rspec, Applitools and Selenium
|
52
|
+
|
53
|
+
***In order to run the Appium tests, download the example [app](https://github.com/saucelabs/my-demo-app-rn).***
|
54
|
+
|
55
|
+
***In order to run the visual tests with applitools, you need to create an account and get your api key, you can read more [here](https://applitools.com/docs/topics/overview/obtain-api-key.html#:~:text=If%20you%20already%20have%20an,Your%20key%20will%20be%20displayed.).***
|
56
|
+
|
57
|
+
This works in all the platforms (Tested on Mac OS, Linux and Windows).
|
58
|
+
|
59
|
+
## Getting started
|
60
|
+
|
61
|
+
To get the project up and running.
|
62
|
+
|
63
|
+
**Just do:**
|
64
|
+
|
65
|
+
```ruby
|
66
|
+
gem install ruby_raider
|
67
|
+
```
|
68
|
+
|
69
|
+
**Then do:**
|
70
|
+
|
71
|
+
```ruby
|
72
|
+
raider new [name_of_project]
|
29
73
|
```
|
74
|
+
|
75
|
+
Then a TUI/CLI will appear where the configuration of which frameworks you want to be generated/scaffolded can be selected.
|
76
|
+
|
77
|
+
Select the ones you will like to work with.
|
78
|
+
|
79
|
+
### Ruby raider provides the following list of commands
|
80
|
+
|
81
|
+
###### Anything between square brackets([...]) is where your imput goes
|
82
|
+
|
83
|
+
```ruby
|
30
84
|
Commands:
|
31
|
-
raider browser [BROWSER]
|
85
|
+
raider browser [BROWSER] # Sets the default browser for a project
|
86
|
+
|
87
|
+
raider browser_options [OPTIONS] # Sets the browser options for the project
|
88
|
+
|
89
|
+
raider feature [FEATURE_NAME] # Creates a new feature
|
32
90
|
|
33
|
-
raider
|
91
|
+
raider help [COMMAND] # Describes available commands or one specific command
|
34
92
|
|
35
|
-
raider
|
93
|
+
raider helper [HELPER_NAME] # Creates a new helper
|
36
94
|
|
37
|
-
raider
|
95
|
+
raider new [PROJECT_NAME] # Creates a new framework based on settings picked
|
38
96
|
|
39
|
-
raider
|
97
|
+
raider page [PAGE_NAME] # Creates a new page object
|
40
98
|
|
41
|
-
raider
|
99
|
+
raider path [PATH] # Sets the default path for scaffolding
|
42
100
|
|
43
|
-
raider
|
101
|
+
raider platform [PLATFORM] # Sets the default platform for a cross-platform project
|
44
102
|
|
45
|
-
raider
|
103
|
+
raider raid # Runs all the tests in a project
|
46
104
|
|
47
|
-
raider
|
105
|
+
raider scaffold [SCAFFOLD_NAME] # Generates everything needed to start automating
|
48
106
|
|
49
|
-
raider
|
107
|
+
raider spec [SPEC_NAME] # Creates a new spec
|
50
108
|
|
51
|
-
raider
|
109
|
+
raider url [URL] # Sets the default url for a project
|
52
110
|
|
53
|
-
raider
|
111
|
+
raider version # It shows the version of Ruby Raider you are currently using
|
54
112
|
```
|
55
113
|
|
114
|
+
Ruby raider also supports scaffolding:
|
115
|
+
|
116
|
+
* To create a new page object you do: ```raider page [PAGE_NAME]```
|
117
|
+
* To create a new spec you do: ```raider spec [SPEC_NAME]```
|
118
|
+
* To create a new feature you do: ```raider feature [FEATURE_NAME]```
|
119
|
+
|
56
120
|
It's possible to add the option --path or -p if you want to specify where to create your features, pages, helpers and
|
57
121
|
specs.
|
58
122
|
|
59
123
|
If you want to set the default path for the creation of your features, helpers and specs:
|
60
124
|
|
61
|
-
```
|
125
|
+
```ruby
|
62
126
|
raider path [PATH_NAME] --feature or -f
|
63
127
|
raider path [PATH_NAME] --spec or -s
|
64
128
|
raider path [PATH_NAME] --helper or -h
|
65
129
|
```
|
66
130
|
|
67
|
-
If you don't specify an option path will assume you want to change the default path for pages
|
131
|
+
If you don't specify an option, path will assume you want to change the default path for pages.
|
data/ruby_raider.gemspec
CHANGED
@@ -2,7 +2,7 @@
|
|
2
2
|
|
3
3
|
Gem::Specification.new do |s|
|
4
4
|
s.name = 'ruby_raider'
|
5
|
-
s.version = '0.4.
|
5
|
+
s.version = '0.4.8'
|
6
6
|
s.summary = 'A gem to make setup and start of UI automation projects easier'
|
7
7
|
s.description = 'This gem has everything you need to start working with test automation'
|
8
8
|
s.authors = ['Agustin Pequeno']
|