RidgepoleRake

RidgepoleRake provides basic Rake Task for Ridgepole.

RidgepoleRake supports the version 0.5.0 or later of Ridgepole.

Installation

Add to your Gemfile:

gem 'ridgepole_rake'

Usage

Add to your Rakefile:

require 'ridgepole_rake'
load 'tasks/ridgepole_rake.rake'

If you are using Rails, it has tasks are loaded automatically.

Tasks

$ rake -T
rake ridgepole:apply                # `ridgepole --apply`
rake ridgepole:apply:dry-run        # `ridgepole --apply --dry-run`
rake ridgepole:diff                 # `ridgepole --diff` current db and schema file
rake ridgepole:export               # `ridgepole --export`
rake ridgepole:merge[file]          # `ridgepole --merge`
rake ridgepole:merge:dry-run[file]  # `ridgepole --merge --dry-run`
rake ridgepole:reset                # `rake db:drop`, `rake db:create` and `ridgepole --apply`

Configuration

RidgepoleRake can configure options of Ridgepole.

Configurable options

see also https://github.com/winebarrel/ridgepole#help

Default configuration

# default configuration
RidgepoleRake.config.ridgepole
# => {"config"=>"config/database.yml", "file"=>"db/schemas/Schemafile", "output"=>"db/schemas.dump/Schemafile", "env"=>"development"}

Example

Set by Symbol key.

# Symbol key
RidgepoleRake.config.ridgepole[:env] = 'staging'
# => {"config"=>"config/database.yml", "file"=>"db/schemas/Schemafile", "output"=>"db/schemas.dump/Schemafile", "env"=>"staging"}

RidgepoleRake.config.ridgepole[:env]
# => 'staging'

Set by String key.

# String key
RidgepoleRake.config.ridgepole['env'] = 'production'
# => {"config"=>"config/database.yml", "file"=>"db/schemas/Schemafile", "output"=>"db/schemas.dump/Schemafile", "env"=>"production"}

RidgepoleRake.config.ridgepole['env']
# => 'production'

Convert to ActiveSupport::HashWithIndifferentAccess.

RidgepoleRake.config.ridgepole = { env: 'test' }
RidgepoleRake.config.ridgepole.class
# => ActiveSupport::HashWithIndifferentAccess

Use .configure block

RidgepoleRake.configure do |config|
  config.ridgepole[:config]                = 'database_config.yml'
  config.ridgepole[:file]                  = 'Schemafile'
  config.ridgepole[:env]                   = 'production'
  config.ridgepole[:log_file]              = 'log/ridgepole.log'
  config.ridgepole['enable-mysql-awesome'] = true # It allows all the values, if the key does not have value.
end

Custom configuration with Task

task :my_config do
  RidgepoleRake.configure do |config|
    config.ridgepole[:config]                = 'database_config.yml'
    config.ridgepole[:file]                  = 'Schemafile'
    config.ridgepole[:env]                   = 'production'
    config.ridgepole[:log_file]              = 'log/ridgepole.log'
    config.ridgepole['enable-mysql-awesome'] = true
  end
end

task 'ridgepole:apply:dry-run' => ['my_config']

or

task :my_ridgepole_apply_dryrun do
  RidgepoleRake.configure do |config|
    config.ridgepole[:config]                = 'database_config.yml'
    config.ridgepole[:file]                  = 'Schemafile'
    config.ridgepole[:env]                   = 'production'
    config.ridgepole[:log_file]              = 'log/ridgepole.log'
    config.ridgepole['enable-mysql-awesome'] = true
  end

  Rake::Task['ridgepole:apply:dry-run'].invoke
end

Rails

If you are using Rails, :env's default value is Rails.env.

Rails.env
# => production

RidgepoleRake.config.ridgepole[:env]
# => 'production'

Brancher

RidgepoleRake supports Brancher.

Supported version is 0.3.0 or later.

Add to your Gemfile:

gem 'brancher', '>= 0.3.0'

RidgepoleRake.config.brancher[:use]
# => true

Bundler

RidgepoleRake supports Bundler.

RidgepoleRake.config.bundler
# => {"use"=>true, "clean_system"=>true}

If RidgepoleRake.config.bundler[:use] == true and RidgepoleRake.config.bundler[:clean_system] == true, Ridgepole will be performed using Bundler.clean_system.

RidgepoleRake.config.bundler[:with_clean_env] = proc { ENV.update('FOO' => 'bar') }
# => {"use"=>true, "clean_system"=>true, "with_clean_env"=>#<Proc:0x007f8711095818>}

If an object with a method named call is set in RidgepoleRake.config.bundler[:with_clean_env], Ridgepole will be performed after calling the method named call of that object in Bundler.with_clean_env block.

License

MIT License

see LICENSE.txt