Skip to content

Latest commit

 

History

History
54 lines (40 loc) · 2.43 KB

README.markdown

File metadata and controls

54 lines (40 loc) · 2.43 KB
Raw

activerecord-grapher

activerecord-grapher is a library gem to facilitate working with your ActiveRecord models as graphs.

Examples

Build an RGL graph of all of your models

Using rails console in test/reference/rails5 as follows:

irb> model_graph = ActiveRecord::Grapher.build_graph()
# Visualize the model graph
irb> require 'rgl/dot'
irb> model_graph.write_to_graphic_file('png')
"graph.png"

Produces the following graph:

Rails 5 model graph

All nodes in the returned graph are either subclasses of ActiveRecord::Base or Sets of ActiveRecord::Base subclasses. A Set node represents two more classes that correspond to the same underlying database table. Currently this is only used to represent implicit models created via has_and_belongs_to_many associations.

Topologically sort all models

To iterate over your models in topological order, use topsort_iterator:

irb> require 'rgl/topsort'
irb> model_graph = ActiveRecord::Grapher.build_graph()
irb> model_graph.topsort_iterator.map {|v| v.respond_to?(:name) ? v.name : v.map {|w| w.name} }
=> ["Book", "Author", ["HABTM_Parts", "HABTM_Assemblies"], "Part", "Assembly", "Appointment", "Patient", "Physician", "AccountHistory", "Account", "Supplier"]

Contributing to activerecord-grapher

  • Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
  • Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
  • Fork the project.
  • Start a feature/bugfix branch.
  • Commit and push until you are happy with your contribution.
  • Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
  • Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

Copyright

Copyright (c) 2017 Ryan Oblak. See LICENSE.txt for further details.