[](#contributors-)
[attractor]: https://github.com/julianrubisch/attractor-ruby
[forks-shield]: https://img.shields.io/github/forks/julianrubisch/attractor-ruby.svg?style=flat-square
[forks-url]: https://github.com/julianrubisch/attractor-ruby/network/members
[stars-shield]: https://img.shields.io/github/stars/julianrubisch/attractor-ruby.svg?style=flat-square
[stars-url]: https://github.com/julianrubisch/attractor-ruby/stargazers
[issues-shield]: https://img.shields.io/github/issues/julianrubisch/attractor-ruby.svg?style=flat-square
[issues-url]: https://github.com/julianrubisch/attractor-ruby/issues
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
Attractor Ruby Plugin
[Attractor][attractor] plugin for the Ruby programming language and its ecosystem
## Table of Contents
- [Table of Contents](#table-of-contents)
- [Getting Started](#getting-started)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
## Getting Started
This is a plugin to help you visualize code complexity metrics for your Ruby code. If you are not familiar with [Attractor][attractor], take a look at the main repo first.
### Installation
Add this to your application's Gemfile:
```ruby
gem 'attractor'
gem 'attractor-ruby'
```
And then execute:
```sh
bundle install
```
## Usage
To create a HTML report in `attractor_output/index.html`, try
```sh
bundle exec attractor report
```
If you'd like to specify a directory, use the file prefix option:
```sh
bundle exec attractor report --file_prefix app/models
```
Or shorter:
```sh
bundle exec attractor report -p app/models
```
Watch for file changes:
```sh
bundle exec attractor report -p app/models --watch
```
Serve at http://localhost:7890:
```sh
bundle exec attractor serve -p app/models
```
Enable rack-livereload:
```sh
bundle exec attractor serve -p app/models --watch
```
## Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
