# rake-compiler-dev-box

**Repository Path**: mirrors_simi/rake-compiler-dev-box

## Basic Information

- **Project Name**: rake-compiler-dev-box
- **Description**: A virtual machine for using rake-compiler
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-10-27
- **Last Updated**: 2026-02-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# rake-compiler-dev-box

A virtual machine for using rake-compiler.

[rake-compiler](https://github.com/luislavena/rake-compiler) is **totally awesome**, and you should be using it if you maintain a Ruby gem with C or Java extensions to build native binaries for your users.

_However_, getting your local environment set up to build for all the assorted platforms can be a pain.  Thankfully, we have the amazing tool [Vagrant](http://www.vagrantup.com) for "lightweight, reproducible, and portable development environments."

rake-compiler + Vagrant = easy native gems for all.

## Dependencies

* [Vagrant](http://www.vagrantup.com)
* A supported [Vagrant provider](https://docs.vagrantup.com/v2/providers/index.html) — [VirtualBox](https://docs.vagrantup.com/v2/virtualbox/index.html), [Hyper-V](https://docs.vagrantup.com/v2/hyperv/index.html), and [VMware Fusion](https://docs.vagrantup.com/v2/vmware/index.html) should all work.

## How to Build the Virtual Machine

Easy-peasy:

    $ git clone https://github.com/tjschuck/rake-compiler-dev-box.git
    $ cd rake-compiler-dev-box
    $ vagrant up

That's it!  Go grab a cup of coffee, though -- it can take a couple of minutes to build the first time.

## Building Your Native Gems

Once you have your gem ready to package, clone or move your repo into the same directory as the rake-compiler-dev-box:

    $ pwd
    /Users/tjschuck/Code/rake-compiler-dev-box
    $ git clone git@github.com:codahale/bcrypt-ruby.git
    Cloning into 'bcrypt-ruby'...
    [...], done.

Now fire up your virtual machine (if you haven't already):

    $ vagrant up

And SSH in:

    $ vagrant ssh

You'll now be inside the virtual machine.  The directory on your host machine with your gem in it and the scripts to build it will be mounted at `/vagrant`:

    vagrant@precise32:~$ cd /vagrant
    vagrant@precise32:/vagrant$ ls
    bcrypt-ruby  bin  bootstrap.sh  LICENSE.txt  README.md  sample_gem  Vagrantfile

To build all gem binaries (native, Java, and Windows versions), run:

    vagrant@precise32:/vagrant$ package_all YOUR_GEM'S_DIR_NAME

And wait for everything to build.  Replace `YOUR_GEM'S_DIR_NAME` with the correct value -- above, it would be `bcrypt-ruby`. There's a `sample_gem` dir in there as well if you'd like to experiment.

All of your gem binaries will be put into `pkg`:

    vagrant@precise32:/vagrant$ ls bcrypt-ruby/pkg/
    bcrypt-ruby-3.1.0            bcrypt-ruby-3.1.0-x86-linux.gem
    bcrypt-ruby-3.1.0.gem        bcrypt-ruby-3.1.0-x86-mingw32
    bcrypt-ruby-3.1.0-java       bcrypt-ruby-3.1.0-x86-mingw32.gem
    bcrypt-ruby-3.1.0-java.gem   bcrypt-ruby-3.1.0-x86-mswin32-60
    bcrypt-ruby-3.1.0-x86-linux  bcrypt-ruby-3.1.0-x86-mswin32-60.gem

Happy compiling!

## VM Management

Log out of the virtual machine (`exit` or `^D`).

To shut down the virtual machine:

    $ vagrant halt

To start it up again:

    $ vagrant up

To completely remove the VM, clearing it from disk and destroying all contents:

    $ vagrant destroy

To reinstantiate it for future compiling, it can be recreated with:

    $ vagrant up

See the [Vagrant docs](http://docs.vagrantup.com/) for more info.

## :heart: :heart: :heart:

* [Luis Lavena](https://github.com/luislavena) for [rake-compiler](https://github.com/luislavena/rake-compiler)
* [rails-dev-box](https://github.com/rails/rails-dev-box) for the inspiration
* [Harvest](http://www.getharvest.com), my awesome employer.  [We're hiring](http://www.getharvest.com/careers)!