Skip to content
This repository has been archived by the owner on May 29, 2018. It is now read-only.

bwillis/rockit

Repository files navigation

Rockit Build Status Gem Status

Rockit is a dsl to help setup, detect changes and keep your environment up-to-date so you can start working as fast as possible.

Install

gem install rockit-now
touch Rockitfile

How to use

Rockit is run at the command line and can be followed by other commands to execute after.

Command line :

rockit <any command>

Include in a ruby file :

require 'rockit'
Rockit::Application.new.run

RockitFile Configuration

Rockit requires a Rockitfile for configuration. This is where you use ruby code and some helpful methods to define your environment. It is highly recommended that you commit your configuration to ensure quick and easy setup.

Commands and Services

All applications require certain commands and services are available before you can get going. If you want to just require these print a message and exit you can use these shortcuts :

command "convert"
service "mysql"

For more control when the services or commands are missing you can use the following syntax :

if_command_missing "convert" do
  puts "required command 'convert' is not available."
  exit
end

if_service_not_running "mysql" do
  puts "required service 'mysql' is not running."
  exit
end

Changes

Applications environments are always changing and your local environment needs to react to them. For instance, when working in a rails team, migrations and gems are often changed and need to be updated. Add the following to your configurtion to detect changes and automatically keep stay up-to-date :

if_file_changed "Gemfile" do
  run "bundle"
end

if_directory_changed "db/migrate" do
  run "rake db:migrate"
end

Documentation and Examples

License

Rockit is released under the MIT license: www.opensource.org/licenses/MIT

About

Rockit is a way to manage your external dependencies and keep your environment up to date.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages