ClassList

When analyzing an unfamiliar project, it can be useful to have a class hierarchy to hand.

Classlist is a command line gem which scans a set of Ruby files and prints out any classes declared along with their hierarchy.

Note. This is a quick and dirty syntactic scan which does NOT take account of any module declarations or nested classes.

It is intended for use in investigating a (possibly non-functioning) code base.

Installation

Or it as:

$ gem install class_list

Usage

$ classlist file1.rb dir1.rb .
Class                Children
-------------------------------------------
Animal
    Bird
        Hawk
        Parrot
    Mammal
        Monkey
        Zebra
Mineral
    Bauxite
    Calcite
Vegetable
    Carrot
    Potato

Development

After checking out the repo, run bin/setup to install dependencies. 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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/m-z-b/class_list.