<commit_before># ManaMana Framework

[![Build Status](https://travis-ci.org/ManaManaFramework/manamana.png)](https://travis-ci.org/ManaManaFramework/manamana)

[![Coverage Status](https://coveralls.io/repos/ManaManaFramework/manamana/badge.png)](https://coveralls.io/r/ManaManaFramework/manamana)


Organize your project's requirements and their associated test cases in a way that makes sense to your organization. Then keep track of the status of each as your project progresses.

## Installation

Install the gem:

    $ gem install manamana

Use the `mana` command to generate a new project:

    $ mana create my_project

This will create a directory named `my_project` containing the following items:

 * `requirements/` - Contains your project's requirements
 * `test_cases/` - Contains your project's test cases
 * `lib/stepdefs/` - Contains definitions for steps that are used by test  cases
 * `lib/helpers/` - Contains helper methods that can be used in test cases and stepdefs

## Usage

**Step 1: Write Requirements**

Writes a requirements file using the Requirements Syntax and save it under the `requirements/` directory. For example:

```<commit_msg>Add Code Climate badge and fix Travis badge<commit_after># ManaMana Framework

[![Code Climate](https://codeclimate.com/github/ManaManaFramework/manamana.png)](https://codeclimate.com/github/ManaManaFramework/manamana) [![Build Status](https://travis-ci.org/ManaManaFramework/manamana.png)](https://travis-ci.org/ManaManaFramework/manamana) [![Coverage Status](https://coveralls.io/repos/ManaManaFramework/manamana/badge.png)](https://coveralls.io/r/ManaManaFramework/manamana)


Organize your project's requirements and their associated test cases in a way that makes sense to your organization. Then keep track of the status of each as your project progresses.

## Installation

Install the gem:

    $ gem install manamana

Use the `mana` command to generate a new project:

    $ mana create my_project

This will create a directory named `my_project` containing the following items:

 * `requirements/` - Contains your project's requirements
 * `test_cases/` - Contains your project's test cases
 * `lib/stepdefs/` - Contains definitions for steps that are used by test  cases
 * `lib/helpers/` - Contains helper methods that can be used in test cases and stepdefs

## Usage

**Step 1: Write Requirements**

Writes a requirements file using the Requirements Syntax and save it under the `requirements/` directory. For example:

```
{'fraction_non_alphanumeric': 0.09428685577307232, 'fraction_numerical': 0.0007990411506192569, 'mean_word_length': 4.796296296296297, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 10, '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': '2156480', 'n_tokens_mistral': 757, 'n_tokens_neox': 720, 'n_words': 257}