The DevKit is a toolkit that makes it easy to build and use native C/C++ extensions such as RDiscount and RedCloth for Ruby on Windows.
Simply download, double-click, choose an installation directory, run the Ruby install helper script, possibly tweak a
config.yml file for your system specifics, and you’re ready to start using native Ruby extensions.
One of the challenges many Ruby on Windows users have is how to easily use native RubyGems from the community such as the rdiscount orcurb gems. In many cases this isn’t a problem because the extension author has provided a binary gem compatible with the users Ruby environment. In other cases, only the extension source code is available in the gem and the user is expected to have a “sane” environment installed and configured in order to build and use the native gem. A “sane” environment typically means a system with
make, gcc, sh and similar *nix build tools installed.
This expectation of a “sane” build environment is not always true for Windows users and is the primary reason why the DevKit was created. The DevKit, based upon MSYS and MinGW components, is an easy-to-install and easy-to-use solution for quickly setting up a “sane” build environment, enabling you to use most native RubyGems developed by the Ruby community.
We use the DevKit internally for the RubyInstaller project. The DevKit is used to build MRI Ruby and the required dependencies needed to deliver the RubyInstaller for Windows. Many community members also use the DevKit as their “foundation” toolkit for building other native software.
The DevKit is currently available for download as a self-extracting archive and a Windows installer is in development.
- Window XP or greater (32 or 64-bit).
- A Ruby installation from RubyInstaller. This is important as it will not work with any other version of Ruby (e.g. old One-Click)
- [optional] For RubyInstaller’s previous to
1.9.2-p0you may feel more comfortable using the
DevKit-3.4.5-CCYYMMDD-sfx.exeas the earlier RubyInstallers were built using MSys/MinGW v3.4.5. Currently no issues have been reported when either the 4.5.0 or 4.5.1 DevKit’s are used with previous RubyInstaller versions.
While installation is (in general) simple, please ensure you carefully follow each step below.
- If you previously installed the legacy DevKit
devkit-3.4.5r3-20091110.7z, its artifacts were extracted into each Ruby installation and need to be manually removed. Remove the
gcc.bat, make.bat, and sh.batstub batch files in
<RUBY_INSTALL_DIR>\devkitsubdirectory for each Ruby installation using the legacy DevKit.
- If you previously installed one of the legacy self-extracting DevKit’s, follow the SFX DevKit upgrade instructions.
2. DOWNLOAD FILES
- The current DevKit is available at the RubyInstaller download page with older versions available at the archives page. As backup, check ourGitHub downloads page.
3. EXTRACT FILES
- Left double-click the self-extracting executable (SFX) downloaded from Step 2 and choose a directory (without spaces) to install the DevKit artifacts into. For example,
C:\DevKit. NOTE: the SFX is really a 7-Zip archive with a bit of embedded magic. If you already have 7-Zipinstalled, you can simply right-click it and extract it’s contents as you would a normal 7z archive. In the instructions that follow, the directory that you selected is identified as
4. RUN INSTALLATION SCRIPTS
cd <DEVKIT_INSTALL_DIR>from Step 3 above.
ruby dk.rb initto generate the
config.ymlfile to be used later in this Step. Your installed Rubies will be listed there (only those installed by a RubyInstaller package are detected at present).
- edit the generated
config.ymlfile to include installed Rubies not automagically discovered or remove Rubies you do not want to use the DevKit with.
ruby dk.rb reviewto review the list of Rubies to be enhanced to use the DevKit and verify the changes you made to it are correct.
ruby dk.rb installto DevKit enhance your installed Rubies. This step installs (or updates) an
operating_system.rbfile into the relevant directory needed to implement a RubyGems
pre_installhook and a
devkit.rbhelper library file into
<RUBY_INSTALL_DIR>\lib\ruby\site_ruby. NOTE: you may need to use the
--forceoption to update (with backup of the originals) the above mentioned files as discussed at the SFX DevKit upgrade FAQ entry.
5. TEST INSTALLATION
- Confirm your Ruby environment is correctly using the DevKit by running
gem install rdiscount --platform=ruby. RDiscount should install correctly and you should see
Temporarily enhancing PATH to include DevKit...in the screen messages. Next run
ruby -rubygems -e "require 'rdiscount'; puts RDiscount.new('**Hello RubyInstaller**').to_html"to confirm that the rdiscount gem is working.
Example Native RubyGem Installations using the DevKit
Once you’ve installed the DevKit you’ll discover there are but a few different types of native installation scenarios to deal with.
- The Typical Install Scenario – most of the native RubyGems you’re likely to encounter can be installed by running something similar to
gem install bson_ext --platform=ruby. It’s crucial that you include the
--platform=rubyoption to force RubyGems to build the native gem rather than potentially installing an incorrect binary gem.
- The Manual Install Scenario – sometimes a native RubyGem requires additional artifacts to already exist on your system and be usable. One such gem is curb which requires curl’s native header and library files in order be built and installed. In this scenario you need to tell RubyGems where to find those headers and library files by using a command similar to
gem install curb --platform=ruby -- --with-curl-lib="C:/curl/bin" --with-curl-include="C:/curl/include". In addition, the curl library found in the directory specified with
--with-curl-libmust be on your
PATHfor use at runtime by the curb gem.
- The Hacky Developer Scenario – a developer building native gems wants to be able to quickly test that their
extconf.rbfile used to create a
Makefilefor the native library works correctly. To shorten the development cycle, the DevKit enables the developer to run
ruby -rdevkit extconf.rb.
Accessing the Full MSys/MinGW Environment
To access all of the MSYS/MinGW tools from a Command Prompt shell, run the
devkitvars.bat helper script (lives in
<DEVKIT_INSTALL_DIR>) to update the shell’s
PATH environment variable. Similarly, if you’re using PowerShell, run the
devkitvars.ps1 helper script.
Building the DevKit
As the DevKit is a fundamental part of the RubyInstaller build recipes, you can always build your own DevKit by simply:
git clone git://github.com/oneclick/rubyinstaller.git
rake devkit sfx=1
Now that you’ve installed the DevKit, you should be able to use many of the native C RubyGems without problems.
However, some extensions may require additional header and library files to also be installed, and still other extensions may need additional work done by the authors in order to get them to compile with the MSys/MinGW based DevKit. If you have problems, please drop us a line at ourRubyInstaller Google Group