https://github.com/julianrubisch/attractor-ruby

code complexity metrics visualization and exploration tool for ruby
https://github.com/julianrubisch/attractor-ruby

code-quality complexity ruby

Last synced: 15 days ago
JSON representation

code complexity metrics visualization and exploration tool for ruby

• Host: GitHub
• URL: https://github.com/julianrubisch/attractor-ruby
• Owner: julianrubisch
• Created: 2020-01-19T09:38:27.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-04-15T16:28:26.000Z (over 1 year ago)
• Last Synced: 2024-11-29T14:47:44.330Z (28 days ago)
• Topics: code-quality, complexity, ruby
• Language: Ruby
• Homepage:
• Size: 19.8 MB
• Stars: 2
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


[![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](#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)):

  

    
Andrew Mason
📖 💻

    
Julian Rubisch
💻

    
Manuel Tancoigne
💻

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!