https://github.com/victor-am/ruby_detective

🔎 Investigating your ruby code dependencies
https://github.com/victor-am/ruby_detective

dependencies network-graph ruby

Last synced: 8 days ago
JSON representation

🔎 Investigating your ruby code dependencies

• Host: GitHub
• URL: https://github.com/victor-am/ruby_detective
• Owner: victor-am
• License: mit
• Created: 2019-12-03T22:27:50.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-24T01:12:52.000Z (about 2 years ago)
• Last Synced: 2025-01-03T10:42:33.452Z (about 1 month ago)
• Topics: dependencies, network-graph, ruby
• Language: Ruby
• Homepage:
• Size: 2.36 MB
• Stars: 110
• Watchers: 3
• Forks: 3
• Open Issues: 25
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Ruby Detective

### Investigating your code dependencies

Ruby Detective is a gem that parses your code, finds it's dependencies and outputs an interactive .html file that you can use to explore the dependency network of the code.

This is the UI for the Ruby Detective project by the way:

### [Click here to access the live preview](https://victor-am.github.io/ruby_detective/preview.html)

[![Preview](docs/preview.png?raw=true)](https://victor-am.github.io/ruby_detective/preview.html)

***:** Due to Ruby metaprogramming super-powers (and by extension Rails heavy use of those) it's unfeasible to find every single dependency, so we can only guarantee that explicit constants will be pointed as dependencies.

## Main features

- Explorable and interactive network graph of the project dependencies

- Graph nodes colored by namespace, making it easier to spot contexts

- Useful information like lines of code, number of dependencies and dependents, etc

- Outputs a fully self-contained .html file that can be easily shared

## Installation

**Make sure you have Ruby 2.5 or higher installed (lower versions are not supported)**

```

gem install ruby_detective

```

## Usage

```

cd my-project-folder

ruby_detective .

```

This should output an html file at the end that is completely self-contained, and can be shared around with your peers :D

### Some tips

- Click on a node to bring it's card to the top of the list on the left

- Click twice on a node to add it to the graph, allowing to navigate through dependencies

- Use the filters on the right to customize the graph, toggling off the "Show second-level dependency edges" option can be specially useful

*This gem was inspired by @emad-elsaid library [rubrowser](https://github.com/emad-elsaid/rubrowser).*