CRuby

2.0.0

Swift system module for libruby
johnfairh/CRuby

What's New

v2.0.0

2021-06-29T09:12:59Z

Modernize, prep for Ruby 3.

Breaking
  • Require Swift 5.4.
Bug Fixes
  • Fix --mode xcode option on macOS 11.

Platforms License

CRuby

Wrap libruby for SwiftPM or Xcode. Easily reconfigure for your Ruby installation.

See RubyGateway for a high-level Swift-Ruby integration framework.

Tested with:

  • macOS 10.13 system Ruby
  • macOS Homebrew, RBEnv, RVM
  • macOS bespoke installation
  • Ubuntu 14.04 x86_64 Brightbox ruby2.4-dev
  • Ubuntu 16.04 x86_64 Brightbox ruby2.5-dev
  • Ubuntu 14.04, 16.04 x86_64 RBEnv, RVM

Usage

CRuby comes set up to use the macOS system Ruby, and Xcode to provide C headers.

If you want to use a different Ruby then use the cfg-cruby script to rewrite the build config files.

For options other than macOS system Ruby, cfg-cruby generates a custom pkg-config file called CRuby.pc that can be passed directly to swift build or manually copied into your Xcode project settings.

Swift Package Manager

Include this repo as a dependency in your project:

.package(url: "https://github.com/johnfairh/CRuby/", majorVersion: 1)

To use a Ruby other than macOS system default you need to reconfigure. For example to set up Ruby 2.4.1 managed by rbenv:

swift package edit CRuby
./Packages/CRuby/cfg-cruby --mode rbenv --name 2.4.1
export PKG_CONFIG_PATH=$(pwd)/Packages/CRuby/CRuby.pc:$PKG_CONFIG_PATH
swift build

Either leave the CRuby package in edit mode or fork the repo, use that fork as your remote, and push your customizations back there.

Xcode

Include this repo in your project. A git submodule works well. So either way you have a directory called CRuby. Then go to Build Settings for the Target where you want to do import CRuby and find Import Paths under Swift Compiler - Search Paths. Add the path to your CRuby directory - you can use ${SRCROOT} to substitute for the directory containing the project file.

Check Xcode is happy with an import CRuby line.

If you want to use a different Ruby, run cfg-cruby. Now transfer the settings from the CRuby.pc to the Xcode build settings for the target:

  1. Find Header Search Paths under Search Paths and add the directories mentioned in the Cflags: line of CRuby.pc. Don't copy over the -I part, just the paths.
  2. Find Library Search Paths under Search Paths and add the directories mentioned in the Libs: line of CRuby.pc. Don't copy over the -L part, just the paths. Ignore any -l flags [please tell me if you find a case where this breaks].

That's it: Xcode should now resolve CRuby against your chosen version.

Supported Ruby Configs

macOS system

Use the xcode-selected Xcode:

cfg-cruby --mode xcode

This configuration does not require a pkg-config file.

macOS Homebrew or Linux -dev package

cfg-cruby --mode pkgconfig --name <pkg-name>

Use pkg-config --list-all to see what you have installed.

The pkg-config setup is not directly consumable by SwiftPM. cfg-cruby uses it to create the CRuby.pc that is compatible with SwiftPM.

RBEnv or RVM

cfg-cruby --mode rbenv --name <version>

or

cfg-cruby --mode rvm --name <ruby name>

Something else

If you've built Ruby yourself or are using a different version manager that preserves the regular layout then:

cfg-cruby --path <full path to Ruby directory>

The path required is one to a directory that is called ruby-*something* and contains subdirectories including lib, include, and bin.

Contributions

Welcome - github / johnfairh@gmail.com

License

Distributed under the MIT license.

Description

  • Swift Tools 5.4.0
View More Packages from this Author

Dependencies

  • None
Last updated: Tue Jan 31 2023 13:24:24 GMT-0500 (GMT-05:00)