<commit_before># Reciper

Suppose you're writing a book containing some programming recipes. It would be great to have a test suite that ensures that your snippets really are really working. But why we should write a test suite if RSpec already does an awesome job doing it ?

Reciper is a collection of helpers that helps you write tests for your book recipes. It should be included on your described class and used whenever you need to copy files, copy line ranges, run tests, overwrite files, among other things.

## Install

On your `Gemfile`, just do this:

```ruby
gem "reciper"
```
     
Run `bundle install` and on your described class just include `Reciper::Helpers`

```ruby
describe "My awesome recipe" do
  include Reciper::Helpers
  # (...)
end
```

        
<commit_msg>Readme improvement<commit_after># Reciper

Suppose you're writing a book containing some programming recipes. It would be great to have a test suite that ensures that your snippets really are really working. But why we should write a test suite if RSpec already does an awesome job doing it ?

Reciper is a collection of helpers that helps you write tests for your book recipes. It should be included on your described class and used whenever you need to copy files, copy line ranges, run tests, overwrite files, among other things.

## Installation

On your `Gemfile`, just do this:

```ruby
gem "reciper"
```
     
Run `bundle install` and you're ready to go!

## Usage

Usage is really simple:

```ruby
Recipe.new("My recipe name", "recipe_path/code", "ruby_app_template").execute do
  copy_file("file.rb", :as => "user.rb", :to => "app/models")
end
```
{'fraction_non_alphanumeric': 0.075, 'fraction_numerical': 0.0, 'mean_word_length': 4.242811501597444, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 5, 'https://': 0, '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': '6027991', 'n_tokens_mistral': 454, 'n_tokens_neox': 430, 'n_words': 241}