Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yegor256/judges
Executor of Ruby scripts that update a Factbase both adding new and modifying facts inside it
https://github.com/yegor256/judges
ruby ruby-gem zerocracy
Last synced: 17 days ago
JSON representation
Executor of Ruby scripts that update a Factbase both adding new and modifying facts inside it
- Host: GitHub
- URL: https://github.com/yegor256/judges
- Owner: yegor256
- License: mit
- Created: 2024-05-11T08:10:36.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2024-05-19T11:55:32.000Z (8 months ago)
- Last Synced: 2024-05-19T14:07:23.606Z (8 months ago)
- Topics: ruby, ruby-gem, zerocracy
- Language: Ruby
- Homepage:
- Size: 229 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Judges over a Factbase Executor
[](http://www.rultor.com/p/yegor256/judges)
[](https://www.jetbrains.com/ruby/)
[](https://github.com/yegor256/judges/actions/workflows/rake.yml)
[](http://www.0pdd.com/p?name=yegor256/judges)
[](http://badge.fury.io/rb/judges)
[](https://codecov.io/github/yegor256/judges?branch=master)
[](http://rubydoc.info/github/yegor256/judges/master/frames)
[](https://hitsofcode.com/view/github/yegor256/judges)
[](https://github.com/yegor256/judges/blob/master/LICENSE.txt)
A command line tool and a Ruby gem for running so called judges against a
[factbase](https://github.com/yegor256/factbase).
Every "judge" is a directory with a single `.rb` file and a number
of `.yml` files. A script in the Ruby file is executed with the following
global variables available to it:
* `$fb` — an instance
of [`Factbase`](https://www.rubydoc.info/gems/factbase/0.0.22/Factbase),
where facts may be added/updated;
* `$loog` — an instance
of [`Loog`](https://www.rubydoc.info/gems/loog/0.5.1/Loog),
where `.info` and `.debug` logs are welcome;
* `$options` — a holder of options coming from either the `--option` command
line flag or the `.yml` file during testing;
* `$local` — a hash map that is cleaned up when the execution of
a judge is finished;
* `$global` — a hash map that is never cleaned up;
* `$judge` — the basename of the directory, where the `.rb` script is located.
Every `.yml` file must be formatted as such:
```yaml
before:
- abc
category: slow
runs: 1
skip: false
input:
-
foo: 42
bar: Hello, world!
many: [1, 2, -10]
options:
max: 100
expected:
- /fb[count(f)=1]
expected_failure:
- 'file not found'
after:
- first.rb
- second.rb
```
Here, the `input` is an array of facts to be placed into the Factbase before
the test starts; the `options` is a hash map of options as if they are passed
via the command line `--option` flag of the `update` command; and `expected` is
an array of XPath expressions that must be present in the XML of the Factbase
when the test is finished.
The `category` (default: `[]`) may have one or an array of categories,
which then may be turned on via the `--category` command line flag.
The `runs` (default: `1`) is the number of times the `.rb` script should
be executed. After each execution, all expected XPath expressions are validated.
The `before` (default: `[]`) is a list of judges that must be executed before
the current one.
The `after` (default: `[]`) is a list of relative file names
of Ruby scripts that are executed after the judge
(`$fb` and `$loog` are passed into them).
The `expected_failure` (default: `[]`) is a list of strings that must
be present in the message of the exception being raised.
## How to contribute
Read
[these guidelines](https://www.yegor256.com/2014/04/15/github-guidelines.html).
Make sure you build is green before you contribute
your pull request. You will need to have
[Ruby](https://www.ruby-lang.org/en/) 3.0+ and
[Bundler](https://bundler.io/) installed. Then:
```bash
bundle update
bundle exec rake
```
If it's clean and you don't see any error messages, submit your pull request.