exterm / attractor-ruby

code complexity metrics visualization and exploration tool for ruby

Attractor Ruby Plugin

Attractor plugin for the Ruby programming language and its ecosystem

Table of Contents

• Table of Contents
• Getting Started
  • Installation
• Usage
• 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, take a look at the main repo first.

Installation

Add this to your application's Gemfile:

gem 'attractor'
gem 'attractor-ruby'

And then execute:

bundle install

Usage

To create a HTML report in attractor_output/index.html, try

bundle exec attractor report

If you'd like to specify a directory, use the file prefix option:

bundle exec attractor report --file_prefix app/models

Or shorter:

bundle exec attractor report -p app/models

Watch for file changes:

bundle exec attractor report -p app/models --watch

Serve at http://localhost:7890:

bundle exec attractor serve -p app/models

Enable rack-livereload:

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):

Andrew Mason 📖 💻

Julian Rubisch 💻

Manuel Tancoigne 💻

This project follows the all-contributors specification. Contributions of any kind welcome!