Nomadize

Nomadize is a collection of rake tasks for managing migrations using a PostgreSQL database. It does not import an entire ORM and aims to be a small / simple utility.

Installation

Add this line to your application's Gemfile:

gem 'nomadize'

And then execute:

$ bundle

Or install it yourself as:

$ gem install nomadize

Usage

Nomadize expects a database configuration file in config/database.yml. You can generate this file with the rake task db:generate_template_config or write it yourself. This file should look something like:

development:
  :dbname: lol_dev
test:
  :dbname: lol_test
production:
  :dbname: lol_production

test/development/production keys set environment dependent options (through RACK_ENV) for the postgres connection object. These key/value pairs are handed directly to the PG.connect method, documentation for what options can be passed can be found here.

migrations_path: db/migrations defines where Nomadize should find and create your migration files, this setting is optional and is set to db/migrations by default.

After a config file is in place add require 'nomadize/tasks' to your rake file, and enjoy helpful new rake tasks such as:

  • rake db:create - creates a database and a schema_migrations table
  • rake db:drop - dumps your poor poor database
  • rake db:new_migration[migration_name] - creates a timestamped migration file in db/migrations/ just fill in the details.
  • rake db:migrate - runs migrations found in db/migrations that have not been run yet
  • rake db:status - see which migrations have or have not been run
  • rake db:rollback[count] - rollback migrations (default count: 1)
  • rake db:generate_template_config - generate a config file in config/database.yml

Alternatively you can use the commandline tool nomadize:

  • nomadize create - creates a database and a schema_migrations table
  • nomadize drop - dumps your poor poor database
  • nomadize new_migration $migration_name - creates a timestamped migration file in db/migrations/ just fill in the details.
  • nomadize migrate - runs migrations found in db/migrations that have not been run yet
  • nomadize status - see which migrations have or have not been run
  • nomadize rollback $count - rollback migrations (default count: 1)

Migrations are written in SQL in the generated YAML files:

---
:up:   'CREATE TABLE testing (field TEXT);'
:down: 'DROP TABLE testing;'

You also have access to the underlying PG connection wrapper (using your defined config) by using the Nomadize::Config.db method. This wrapper responds to exec in the same way that the underlying PG connection object does.

Development

todo:

  • [x] an actual config setup / object
  • [x] sql cleaning (getting rid of the interpolation)
  • [x] to display migration status
  • [x] migration rollbacks
  • [ ] transactions / error handling
  • [ ] maybe some kind of logging idk
  • [x] possibly wrap pg
  • [x] template config file generator
  • [x] maybe set a default migrations path (so the key isn't required in the config file)

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/piisalie/nomadize. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Changelog

0.3.0

  • Include a command line interface for Nomadize commands (THANKS @moonglum)

0.2.0

  • migration_path setting now has a default instead of being a required option in config/database.yml
  • Reworded some of the README.md
  • Added a rake task to generate a template config file in config/database.yml

0.1.0 - Initial Release