Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jamesmoriarty/call-graph
Capture execution and create dependency graphs.
https://github.com/jamesmoriarty/call-graph
graph graphviz instrumentation ruby
Last synced: 30 days ago
JSON representation
Capture execution and create dependency graphs.
- Host: GitHub
- URL: https://github.com/jamesmoriarty/call-graph
- Owner: jamesmoriarty
- License: mit
- Created: 2017-01-28T10:29:39.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2020-10-27T11:21:39.000Z (about 4 years ago)
- Last Synced: 2024-08-05T14:16:25.602Z (3 months ago)
- Topics: graph, graphviz, instrumentation, ruby
- Language: Ruby
- Homepage:
- Size: 133 KB
- Stars: 17
- Watchers: 4
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# CallGraph
[](https://travis-ci.org/jamesmoriarty/call-graph)
Capture execution and create dependency graphs.
## Why
> The Law of Demeter (LoD) or principle of least knowledge is a design guideline for developing software, particularly object-oriented programs. In its general form, the LoD is a specific case of loose coupling. The guideline was proposed by Ian Holland at Northeastern University towards the end of 1987, and can be succinctly summarized in each of the following ways:[1]
> - Each unit should have only limited knowledge about other units: only units "closely" related to the current unit.
> - Each unit should only talk to its friends; don't talk to strangers.
> - Only talk to your immediate friends.
## Install
[](https://badge.fury.io/rb/call_graph)
```
gem install call_graph
```
## Usage
Capture the execution you want to graph between `CallGraph.trace { }`.
```ruby
class A
def self.x
B.new.y
end
end
class B
def y
1 + C.z do
1
end
end
end
class C
def self.z
yield
end
end
```
```ruby
require 'call_graph'
CallGraph.config do |config|
config.file_path = "examples/call-graph"
end
CallGraph.trace do
A.x
end
```
Print the captured execution with the provided rake tasks.
```ruby
# Rakefile
load 'call_graph/tasks/printer.rake'
```
```shell
$ rake -T
...
rake call_graph:printer:dot # write dot file
rake call_graph:printer:png # write png file from dot file
```
[](https://github.com/jamesmoriarty/call-graph/blob/master/examples/call-graph.png)
## Configuration
```ruby
CallGraph.config do |config|
config.file_path = "examples/call-graph"
end
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at . This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).