https://github.com/getgauge/gauge-ruby
Ruby runner for Gauge.
https://github.com/getgauge/gauge-ruby
gauge gauge-plugin
Last synced: 9 months ago
JSON representation
Ruby runner for Gauge.
- Host: GitHub
- URL: https://github.com/getgauge/gauge-ruby
- Owner: getgauge
- License: apache-2.0
- Created: 2014-10-20T10:10:50.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2025-03-24T10:47:09.000Z (10 months ago)
- Last Synced: 2025-03-29T08:08:41.032Z (10 months ago)
- Topics: gauge, gauge-plugin
- Language: Ruby
- Homepage: https://gauge.org/
- Size: 577 KB
- Stars: 24
- Watchers: 19
- Forks: 11
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Gauge-ruby
[](https://github.com/getgauge/gauge-ruby/actions)
[](https://rubygems.org/gems/gauge-ruby)
[](CODE_OF_CONDUCT.md)
This project adds ruby [language plugin](https://docs.gauge.org/plugins.html#language-reporting-plugins) for [gauge](https://gauge.org/).
The plugin is authored in [Ruby](https://en.wikipedia.org/wiki/Ruby_(programming_language)). It contains a launcher component (gauge-ruby.go) written in golang which is used to start the plugin from [gauge](https://github.com/getgauge/gauge).
## Getting started
### Pre-requisite
- [Install Gauge](https://docs.gauge.org/installing.html#installation)
### Installation
```
gauge install ruby
```
### Create a gauge-ruby project
```
gauge init ruby
```
### Run tests
```
gauge run specs
```
### Alternate Installation options
#### Install specific version
* Installing specific version
```
gauge install ruby --version 0.7.0
```
#### Offline installation
* Download the plugin from [Releases](https://github.com/getgauge/gauge-ruby/releases)
```
gauge install ruby --file gauge-ruby-0.7.0-linux.x86_64.zip
```
#### Build from Source
##### Requirements
* [Golang](http://golang.org/)
* [Ruby](https://www.ruby-lang.org/en/)
* [Bundler](http://bundler.io/)
* [Gauge](https://gauge.org/)
Run `bundle install` to install all required gems.
Running `bundle exec rake -T` should give the list of all tasks available. Below sections detail some commonly used tasks.
##### Compiling
To build gauge-ruby.xxx.gem and the gauge-ruby executable for current platform use:
````
bundle exec rake compile
````
To build gauge-ruby.xxx.gem and the gauge-ruby for all supported platforms use:
````
bundle exec rake xcompile
````
##### Installing
After compiling
TO install the gauge-ruby.xxx.gem use:
````
bundle exec rake install
````
To install gauge-ruby plugin use (Note, this will uninstall gauge-ruby before installing the compiled version):
```
bundle exec rake force_install
```
Installing to a CUSTOM_LOCATION
````
bundle exec rake force_install[CUSTOM_LOCATION]
````
##### Creating distributable
Note: Run after compiling
````
bundle exec rake package
````
For distributable across platforms os, windows and linux for both x86_64 and arm64
````
bundle exec rake package_all
````
New distribution details need to be updated in the ruby-install.json file in [gauge plugin repository](https://github.com/getgauge/gauge-repository) for a new version update.
## License
[Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)
## Copyright
Copyright ThoughtWorks, Inc.