<commit_before>Avocado
=======

Avocado hooks into your Rails specs and generates a JSON file containing useful information. It sends
that JSON file to a configurable URL where you can do whatever you want with it, such as display API
documentation for your mobile team.

By default, Avocado comes with an Angular API viewer within `Avocado::Engine`.

### Installation

```
gem "avocado-docs"
bundle
```

### RSpec

Add this line to the top of `spec/spec_helper.rb`:

```ruby
require 'avocado/rspec'
```

Avocado will not document specs that are tagged with `document: false` in the metadata.

### Minitest

Add this line to your `test/test_helper.rb`:

```ruby
require 'avocado/minitest'
```

### Cucumber

Add this line to your `env.rb`:

```ruby
require 'avocado/cucumber'
```

Avocado will not document scenarios that are tagged with `@nodoc`.

### Configuration

You can configure Avocado using the `Avocado.configure` block, here are the options with defaults (further explanation below):

```ruby
Avocado.configure do |config|
  config.url = nil
  config.headers = []
  config.upload_id = proc { SecureRandom.uuid }
  config.document_if = proc { |_request, _response| true }
  config.ignored_params = %w(controller action format)
  config.uploader = Avocado::Uploader.instance
  config.storage = Avocado::Storage::File.new ::Rails.root
end
```

`url` must be set to a valid URL. Avocado will POST the JSON file to this endpoint. If using the default `Avocado::Engine`, set it to the mounted engine URL at `/specs`, for example: "my-server.com/avocado/specs" if you mounted the engine at "/avocado".
<commit_msg>Update README for URL change<commit_after>Avocado
=======

Avocado hooks into your Rails specs and generates a JSON file containing useful information. It sends
that JSON file to a configurable URL where you can do whatever you want with it, such as display API
documentation for your mobile team.

By default, Avocado comes with an Angular API viewer within `Avocado::Engine`.

### Installation

```
gem "avocado-docs"
bundle
```

### RSpec

Add this line to the top of `spec/spec_helper.rb`:

```ruby
require 'avocado/rspec'
```

Avocado will not document specs that are tagged with `document: false` in the metadata.

### Minitest

Add this line to your `test/test_helper.rb`:

```ruby
require 'avocado/minitest'
```

### Cucumber

Add this line to your `env.rb`:

```ruby
require 'avocado/cucumber'
```

Avocado will not document scenarios that are tagged with `@nodoc`.

### Configuration

You can configure Avocado using the `Avocado.configure` block, here are the options with defaults (further explanation below):

```ruby
Avocado.configure do |config|
  config.url = nil
  config.headers = []
  config.upload_id = proc { SecureRandom.uuid }
  config.document_if = proc { |_request, _response| true }
  config.ignored_params = %w(controller action format)
  config.uploader = Avocado::Uploader.instance
  config.storage = Avocado::Storage::File.new ::Rails.root
end
```

`url` must be set to a valid URL. Avocado will POST the JSON file to this endpoint. If using the default `Avocado::Engine`, set it to the mounted engine URL, for example: "my-server.com/avocado" if you mounted the engine at "/avocado".

{'fraction_non_alphanumeric': 0.10392824002474482, 'fraction_numerical': 0.0, 'mean_word_length': 4.566265060240964, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, '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': '1807385', 'n_tokens_mistral': 1034, 'n_tokens_neox': 937, 'n_words': 396}