Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/shreyasbharath/cpp-dependency-graph

A Ruby gem that generates useful visualisations (dot, d3.js) to study the architecture of C/C++ projects
https://github.com/shreyasbharath/cpp-dependency-graph

architecture c cplusplus d3-visualization d3js dependency-graph dependency-tree dotfiles rubygem visualization

Last synced: about 2 months ago
JSON representation

A Ruby gem that generates useful visualisations (dot, d3.js) to study the architecture of C/C++ projects

Awesome Lists containing this project

README 

        
# Cpp Dependency Graph



[![Join the chat at https://gitter.im/cpp_dependency_graph/Lobby](https://badges.gitter.im/cpp_dependency_graph/Lobby.svg)](https://gitter.im/cpp_dependency_graph/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)



[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

[![Build Status](https://travis-ci.org/shreyasbharath/cpp_dependency_graph.svg?branch=master)](https://travis-ci.org/shreyasbharath/cpp_dependency_graph)

[![Maintainability](https://api.codeclimate.com/v1/badges/2a07b587ca6fc8b1b3db/maintainability)](https://codeclimate.com/github/shreyasbharath/cpp_dependency_graph/maintainability)

[![Codacy](https://api.codacy.com/project/badge/Grade/9439dbb7fde44b5380401acba5325e62)](https://www.codacy.com/app/shreyasbharath/cpp_dependency_graph?utm_source=github.com&utm_medium=referral&utm_content=shreyasbharath/cpp_dependency_graph&utm_campaign=Badge_Grade)

[![Test Coverage](https://api.codeclimate.com/v1/badges/2a07b587ca6fc8b1b3db/test_coverage)](https://codeclimate.com/github/shreyasbharath/cpp_dependency_graph/test_coverage)

[![Gem Version](https://badge.fury.io/rb/cpp_dependency_graph.svg)](https://badge.fury.io/rb/cpp_dependency_graph)



Generates useful component dependency visualisations (`dot` or `d3.js`) to study the architecture of C/C++ projects.



Why do all the other languages have awesome tools to analyse codebases but C/C++ does not?



It's time to change that.



This tool aims to -



- provide multiple views into the architecture of a codebase

- generate views at multiple levels of the architecture

- make the resulting views genuinely useful, rich, dynamic and interactive (static views are boring)



## Inspiration



This tool is inspired by a number of projects [rubrowser](http://www.emadelsaid.com/rubrowser/), [cpp-dependencies](https://github.com/tomtom-international/cpp-dependencies) and [objc-dependency-visualizer](https://github.com/PaulTaykalo/objc-dependency-visualizer).



The pretty `d3` visualisations are directly copied from `objc-dependency-visualiser`.



A huge shout out to the people behind these projects.



## Comparison With Other Tools



### cpp-dependencies



### cinclude2dot



### dep-matrix



## Usage



### Installation



`gem install cpp_dependency_graph`



### Help



`cpp_dependency_graph -h`



### Overall component dependency graph



To generate the overall component dependency graph for a project, use it like so -



`cpp_dependency_graph visualise_project -r spec\test\example_project\ -o deps.svg -f svg`



Below is the overall `dot` and `d3` component dependency visualisations for [leveldb](https://github.com/google/leveldb)



![Dot](docs/examples/leveldb_overall.svg)



![d3.js visualisation of leveldb](docs/examples/leveldb_overall_d3.svg)



![d3.js visualisation of rocksdb](docs/examples/rocksdb_overall_d3.svg)



**NOTE** - If your project has a large number of components (> 100 and lots of connections between them), then generation (and subsequent rendering) may take some time.



### Individual component dependency graph



This will highlight the dependencies coming in and going out of a specific component. This allows you to filter out extraneous detail and study individual components in more detail.



`cpp_dependency_graph visualise_component -r spec\test\example_project\ --component Engine -o deps.dot -f dot`



Here's a component dependency visualisation generated for the `queue` component in [rethinkdb](https://github.com/rethinkdb/rethinkdb)



![Queue component dot visualisation](docs/examples/rethinkdb_queue_component.svg)



![Queue component d3 visualisation](docs/examples/rethinkdb_queue_component_d3.svg)



### Component include dependency graph



This will highlight dependencies of includes within a specific component



`cpp_dependency_graph visualise_component_includes -r spec\test\example_project\ --component Engine`



Here's a component include dependency visualisation generated for the `queue` component in [rethinkdb](https://github.com/rethinkdb/rethinkdb)



![Queue include graph dot](docs/examples/rethinkdb_queue_include.svg)



![Queue include graph d3](docs/examples/rethinkdb_queue_include_d3.svg)



### Header file include dependency graph



This will highlight include dependencies of header files globally within the project



`cpp_dependency_graph visualise_header_includes -r spec\test\example_project\ --header Engine.h`



Here's a component include dependency visualisation generated for the `errors.hpp` header file in [rethinkdb](https://github.com/rethinkdb/rethinkdb)



![Errors.hpp include graph dot](docs/examples/rethinkdb_errors_header_include.svg)



### Cyclic dependencies only graph



This will highlight cyclic dependencies between components within a project. This is especially useful for targeted refactoring activities to reduce coupling between components.



`cpp_dependency_graph visualise_cyclic_deps -r spec\test\example_project\`



Here's the cyclic dependencies only visualisation generated for [rethinkdb](https://github.com/rethinkdb/rethinkdb) and [leveldb](https://github.com/google/leveldb)



![rethinkdb](docs/examples/rethinkdb_cyclic_deps.svg)



![leveldb](docs/examples/leveldb_cyclic_deps.svg)



## Development



`bundle exec cpp_dependency_graph  -r  ...`



### Running all unit tests



`rake spec`



### Running a single test



`rake spec SPEC=`



## License



cpp_dependency_graph is available under the MIT license.



## Warranty



This software is provided "as is" and without any express or implied

warranties, including, without limitation, the implied warranties of

merchantability and fitness for a particular purpose.