<commit_before># Ruby Scaffold for Code Retreat

## Option 1: use Docker wrapper scripts

This scaffold comes with pre-configured Docker environment.

### Run the tests 
May take 1min. to build the image the 1st time.
```bash
./rake
```
Or, using [TCR/BTCR](https://github.com/euranova/code_retreat#tcr):
```
./../../scripts/[tcr|btcr]
```
## Option 2: use a locally installed ruby environment
With this options, TCR/BTCR scripts will not be directly available 
because they use `./gradle.sh` (which calls Docker). 
If you wish to use TCR without Docker, see the comments 
in `./scripts/` sources so that it calls Gradle directly without wrapping 
in a Docker container.

Ruby and Bundler 2+ are required.
### Install the dependencies

```Bash
bundle
```

### Run the tests

```Bash
rake
```

## Hierarchy of directories
<commit_msg>Fix doc: Readme for ruby<commit_after># Ruby Scaffold for Code Retreat

## Option 1: use Docker wrapper scripts

This scaffold comes with pre-configured Docker environment.

### Run the tests 
May take 1min. to build the image the 1st time.
```bash
./rake
```
Or, using [TCR/BTCR](https://github.com/euranova/code_retreat#tcr):
```
./../../scripts/[tcr|btcr]
```
## Option 2: use a locally installed ruby environment
With this options, TCR/BTCR scripts will not be directly available
because they use `./rake` (which calls Docker).
If you wish to use TCR without Docker, see the comment
in `./scripts/test` so that it uses Rake directly without wrapping
in a Docker container.

Ruby and Bundler 2+ are required.
### Install the dependencies

```Bash
bundle
```

### Run the tests

```Bash
rake
```

## Hierarchy of directories

{'fraction_non_alphanumeric': 0.11566265060240964, 'fraction_numerical': 0.006024096385542169, 'mean_word_length': 4.110769230769231, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4858970', 'n_tokens_mistral': 547, 'n_tokens_neox': 484, 'n_words': 219}