Contents

# FamilyTree

Print classes family tree

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'family_tree'
```

And then execute:

    $ bundle install

Or install it yourself as:

    $ gem install family_tree

## Usage

Pass classes array to `FamilyTree.graph`

```ruby
class A; end
class B; end
class C < B;end

puts FamilyTree.graph([A, B, C])
# BasicObject
# └─Object
#   ├─A
#   └─B
#     └─C
```

You can output to html

```ruby
File.open('abc-hierarchy.html', 'w') do |f|
  f.puts FamilyTree.html([A, B, C])
end
```

For private constant, pass full name in string

```ruby
module M
  class K; end
  private_constant :K
end

FamilyTree.graph(['M::K'])
```

## 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 https://github.com/[USERNAME]/family_tree. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/family_tree/blob/master/CODE_OF_CONDUCT.md).


## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## Code of Conduct

Everyone interacting in the FamilyTree project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/family_tree/blob/master/CODE_OF_CONDUCT.md).

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
family_tree-0.1.2	README.md