Schema to Scaffold
This Gem generates Rails command strings based on a Rails database schema you already have. Unlike traditional migrations, which modify the database as they generate Rails scaffolding code, this Gem reads the schema for your database and generates the Rails code which matches your database's existing columns.
This Gem does not modify anything; it simply prints a string which you can then use to invoke the Rails generators, and optionally copies the string to your clipboard. Generated string commands available are:
rails generate scaffold <model_name> <field[:type]> rails generate factory_girl:model <ModelName> <field[:type]>
Use your schema.rb file from
<rails_app>/db or generated with
rake db:schema:dump. You can optionally rename schema.rb to
schema_your_fav_name.rb and it will still be found. Unique schema file names will prevent schema.rb from being overwritten if you use migrations and run
Schema to Scaffold output looks like this:
rails generate scaffold users fname:string lname:string bdate:date email:string encrypted_password:string
It's possible to generate scripts for all your tables at once. Just enter
* when selecting the table.
Assuming that you have rubygems-bundler installed, just type:
gem install schema_to_scaffold
Usage: scaffold [options] Generate a rails scaffold script for a given schema.rb -h Displays help. -p <path> It specifies a path to a folder or to a file. -c Will copy the script to your clipboard. Requires xclip be installed on Linux. -f Generates a factory_girl:model rather than a full scaffold. -m Add migration (use if your schema comes from a different database) Examples: scaffold scaffold -c -p ~/work/rails/my_app scaffold -c -p ~/work/rails/my_app/db/schema.rb
Since this gem assists you in invoking Rails generators for your scaffolding, make sure you've configured your generators with your preferred settings before you start. There's a good Rails Guide and you can invoke
rails g scaffold -h to see options.
Generator options are configured in
config/application.rb. Here is an example setting:
If you configure factory_girl as your fixture_replacement here, there is no need to invoke factory_girl separately with the
scaffold -f command.
Schema to Scaffold is set up by default to support creating scaffolds for your existing database, presuming that you have generated schema.rb with
rake db:schema:dump. Therefore, no migrations are necessary, because the database already contains the desired table. If instead you are using a schema.rb that was generated from a database other than current development database, you can use the
-m option to build a generator command that includes migrations.
To install xclip on Linux
sudo apt-get install xclip
Want to contribute? Great!
- Fork it.
- Create a branch (
git checkout -b my_schema_to_scaffold)
- Commit your changes (
git commit -am "Added great stuff")
- Push to the branch (
git push origin my_schema_to_scaffold)
- Open a Pull Request
- That's all!!
If you want to collaborate, please send me an email, or just create an issue or pull request.