<commit_before>| Project         | Ataru
|:----------------|:--------------------------------------------------
| CI              | [![Build Status](https://travis-ci.org/CodePadawans/ataru.svg?branch=master)](https://travis-ci.org/CodePadawans/ataru)
| Gem Version     | [![Gem Version](https://badge.fury.io/rb/ataru.svg)](http://badge.fury.io/rb/ataru)

# Ataru

Ataru is a gem that provides a command line tool for testing code samples in the documentation files.
You can also integrate ataru in your continuous integration process on Travis CI.

Ataru will check if your documentation is still in sync with the application it was written for.
The output of the results has the MiniTest style.

## What can ataru check

- Ataru can read files written in Github Flavoured Markdown, as it uses Kramdown with Github Flavoured Markdown Parser.

- Ataru is currently able to test the Ruby code only.
It checks the Ruby syntax and implements assertions (`assert_equal`) in place of `#=>` and `# =>`.

## Requirements

- The dependencies of your gem have to be in the range of the latest major versions of:

    - minitest (~> 5.0)
    - kramdown (~> 1.0)
    - thor (~> 0.1)

- In most cases, you need to create the setup file (for more info read Setup section).

## Usage as command line tool

1. Add ataru to your project Gemfile.<commit_msg>changed dependencies<commit_after>| Project         | Ataru
|:----------------|:--------------------------------------------------
| CI              | [![Build Status](https://travis-ci.org/CodePadawans/ataru.svg?branch=master)](https://travis-ci.org/CodePadawans/ataru)
| Gem Version     | [![Gem Version](https://badge.fury.io/rb/ataru.svg)](http://badge.fury.io/rb/ataru)

# Ataru

Ataru is a gem that provides a command line tool for testing code samples in the documentation files.
You can also integrate ataru in your continuous integration process on Travis CI.

Ataru will check if your documentation is still in sync with the application it was written for.
The output of the results has the MiniTest style.

## What can ataru check

- Ataru can read files written in Github Flavoured Markdown, as it uses Kramdown with Github Flavoured Markdown Parser.

- Ataru is currently able to test the Ruby code only.
It checks the Ruby syntax and implements assertions (`assert_equal`) in place of `#=>` and `# =>`.

## Requirements

- The dependencies of your gem have to be in the range of the latest major versions of:

    - minitest (~> 5.0)
    - kramdown (~> 1.3)
    - thor (~> 0.19.0)

- In most cases, you need to create the setup file (for more info read Setup section).

## Usage as command line tool

1. Add ataru to your project Gemfile.
{'fraction_non_alphanumeric': 0.13919821826280623, 'fraction_numerical': 0.005939123979213066, 'mean_word_length': 2.855507868383405, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 13, 'https://': 6, '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': '36252', 'n_tokens_mistral': 790, 'n_tokens_neox': 764, 'n_words': 330}