Metasploit::ERD

Traces the belongs_to associations on ActiveRecord::Base.descendants to find the minimum cluster in which all foreign keys are fulfilled in the Entity-Relationship Diagram.'

Versioning

Metasploit::ERD is versioned using semantic versioning 2.0. Each branch should set Metasploit::ERD::Version::PRERELEASE to the branch name, while master should have no PRERELEASE and the PRERELEASE section of Metasploit::ERD::VERSION does not exist.

Installation

Gem

Add this line to your application's Gemfile:

gem 'metasploit-erd'

And then execute:

$ bundle

Or install it yourself as:

$ gem install metasploit-erd

System tools

In order to generate the diagrams as PNGs, graphviz is used, which may have issues when use on OSX Mavericks. If you get 'CoreTest performance note' messages when running 'rake yard', you should reinstall graphviz as follows: brew reinstall graphviz --with-bindings --with-freetype --with-librsvg --with-pangocairo.

Usage

TODO: Write usage instructions here

Contributing

1. Fork it ( http://github.com//metasploit-erd/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request