ModelProbe

ActiveRecord schema visualization and model organization made easy 🙌

Colorized table info for columns, types, nullables, indexes... and the actual DDL used by the database to create the table. All this and more with ModelProbe!

1. Get a clear picture of your model's underlying schema with beautiful and informative schema introspection.
2. Generate model class definitions with a well organized, logical structure.
3. Create sensible text fixture stubs.

Table of Contents

• Quick Start
• Supported Databases
• Videos
• Screenshots

Quick Start

1. Add the GEM to your project

   bundle add model_probe

   ModelProbe auto initializes in the Rails development environment.

2. Use in a Rails console

   # examples for a User model
   User.probe
   User.print_model
   User.print_fixture

3. Use with Rails (Rake) tasks

   # examples for a User model
   bin/rails model_probe:probe[User]
   bin/rails model_probe:print_model[User]
   bin/rails model_probe:print_fixture[User]

Supported Databases

• MySQL
• PostgreSQL
• SQLite
• ...more? contributions welcome ;)

Videos

Screenshots

Introspect your ActiveRecord models to build a deep understanding of the underlying database structure.

Generate a well organized template for your ActiveRecord model's class definition.

Create fixture stubs to use in the test suite.

Contributing

Tests

Test can be ran using the default rake task or individually.

ruby -Ilib test/model_probe_test.rb

Combine with a simple watch program for a simple test runner.

fd --extension rb | entr -c rake