auxolotl/docs
26
0
Fork 1
mirror of https://git.gay/pyrox/aux-docs synced 2024-12-29 18:47:57 +00:00
Code Issues Packages Projects Releases Wiki Activity
docs/Nixpkgs/Languages-And-Frameworks/ruby.section/index.html

3163 lines
76 KiB
HTML
Raw Permalink Blame History

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="description" content="Aux Documentation">
<meta name="author" content="Nixpkgs Aux, and Lix Contributors">
<link rel="canonical" href="https://docs.auxolotl.org/Nixpkgs/Languages-And-Frameworks/ruby.section/">
<link rel="prev" href="../r.section/">
<link rel="next" href="../rust.section/">
<link rel="icon" href="../../../assets/aux-logo.svg">
<meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.29">
<title>Ruby - Aux Docs</title>
<link rel="stylesheet" href="../../../assets/stylesheets/main.76a95c52.min.css">
<link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.bunny.net/css?family=IBM+Plex+Sans:300,300i,400,400i,700,700i%7CIBM+Plex+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"IBM Plex Sans";--md-code-font:"IBM Plex Mono"}</style>
<script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<meta property="og:type" content="website" >
<meta property="og:title" content="Ruby {#sec-language-ruby} - Aux Docs" >
<meta property="og:description" content="Aux Documentation" >
<meta property="og:image" content="https://docs.auxolotl.org/assets/images/social/Nixpkgs/Languages-And-Frameworks/ruby.section.png" >
<meta property="og:image:type" content="image/png" >
<meta property="og:image:width" content="1200" >
<meta property="og:image:height" content="630" >
<meta property="og:url" content="https://docs.auxolotl.org/Nixpkgs/Languages-And-Frameworks/ruby.section/" >
<meta name="twitter:card" content="summary_large_image" >
<meta name="twitter:title" content="Ruby {#sec-language-ruby} - Aux Docs" >
<meta name="twitter:description" content="Aux Documentation" >
<meta name="twitter:image" content="https://docs.auxolotl.org/assets/images/social/Nixpkgs/Languages-And-Frameworks/ruby.section.png" >
</head>
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="blue">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#sec-language-ruby" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../../.." title="Aux Docs" class="md-header__button md-logo" aria-label="Aux Docs" data-md-component="logo">
<img src="../../../assets/aux-logo.svg" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
Aux Docs
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Ruby
</span>
</div>
</div>
</div>
<form class="md-header__option" data-md-component="palette">
<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="blue" aria-label="Dark Mode" type="radio" name="__palette" id="__palette_0">
<label class="md-header__button md-icon" title="Dark Mode" for="__palette_1" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m17.75 4.09-2.53 1.94.91 3.06-2.63-1.81-2.63 1.81.91-3.06-2.53-1.94L12.44 4l1.06-3 1.06 3 3.19.09m3.5 6.91-1.64 1.25.59 1.98-1.7-1.17-1.7 1.17.59-1.98L15.75 11l2.06-.05L18.5 9l.69 1.95 2.06.05m-2.28 4.95c.83-.08 1.72 1.1 1.19 1.85-.32.45-.66.87-1.08 1.27C15.17 23 8.84 23 4.94 19.07c-3.91-3.9-3.91-10.24 0-14.14.4-.4.82-.76 1.27-1.08.75-.53 1.93.36 1.85 1.19-.27 2.86.69 5.83 2.89 8.02a9.96 9.96 0 0 0 8.02 2.89m-1.64 2.02a12.08 12.08 0 0 1-7.8-3.47c-2.17-2.19-3.33-5-3.49-7.82-2.81 3.14-2.7 7.96.31 10.98 3.02 3.01 7.84 3.12 10.98.31Z"/></svg>
</label>
<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="indigo" data-md-color-accent="blue" aria-label="Light Mode" type="radio" name="__palette" id="__palette_1">
<label class="md-header__button md-icon" title="Light Mode" for="__palette_0" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 7a5 5 0 0 1 5 5 5 5 0 0 1-5 5 5 5 0 0 1-5-5 5 5 0 0 1 5-5m0 2a3 3 0 0 0-3 3 3 3 0 0 0 3 3 3 3 0 0 0 3-3 3 3 0 0 0-3-3m0-7 2.39 3.42C13.65 5.15 12.84 5 12 5c-.84 0-1.65.15-2.39.42L12 2M3.34 7l4.16-.35A7.2 7.2 0 0 0 5.94 8.5c-.44.74-.69 1.5-.83 2.29L3.34 7m.02 10 1.76-3.77a7.131 7.131 0 0 0 2.38 4.14L3.36 17M20.65 7l-1.77 3.79a7.023 7.023 0 0 0-2.38-4.15l4.15.36m-.01 10-4.14.36c.59-.51 1.12-1.14 1.54-1.86.42-.73.69-1.5.83-2.29L20.64 17M12 22l-2.41-3.44c.74.27 1.55.44 2.41.44.82 0 1.63-.17 2.37-.44L12 22Z"/></svg>
</label>
</form>
<script>var media,input,key,value,palette=__md_get("__palette");if(palette&&palette.color){"(prefers-color-scheme)"===palette.color.media&&(media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']"),palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent"));for([key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://git.auxolotl.org/auxolotl/docs" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M16.777 0a2.9 2.9 0 1 1-2.529 4.322H12.91a4.266 4.266 0 0 0-4.265 4.195v2.118a7.076 7.076 0 0 1 4.147-1.42l.118-.002h1.338a2.9 2.9 0 0 1 5.43 1.422 2.9 2.9 0 0 1-5.43 1.422H12.91a4.266 4.266 0 0 0-4.265 4.195v2.319A2.9 2.9 0 0 1 7.222 24 2.9 2.9 0 0 1 5.8 18.57V8.589a7.109 7.109 0 0 1 6.991-7.108l.118-.001h1.338A2.9 2.9 0 0 1 16.778 0ZM7.223 19.905a1.194 1.194 0 1 0 0 2.389 1.194 1.194 0 0 0 0-2.389Zm9.554-10.464a1.194 1.194 0 1 0 0 2.389 1.194 1.194 0 0 0 0-2.39Zm0-7.735a1.194 1.194 0 1 0 0 2.389 1.194 1.194 0 0 0 0-2.389Z"/></svg>
</div>
<div class="md-source__repository">
auxolotl/docs
</div>
</a>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
<div class="md-grid">
<ul class="md-tabs__list">
<li class="md-tabs__item">
<a href="../../.." class="md-tabs__link">
Aux Documentation Hub
</a>
</li>
<li class="md-tabs__item">
<a href="../../../TODO/" class="md-tabs__link">
TODO
</a>
</li>
<li class="md-tabs__item">
<a href="../../../Aux/" class="md-tabs__link">
Aux
</a>
</li>
<li class="md-tabs__item">
<a href="../../../Lix/" class="md-tabs__link">
Lix
</a>
</li>
<li class="md-tabs__item">
<a href="../../../NixOS/appstream/" class="md-tabs__link">
NixOS
</a>
</li>
<li class="md-tabs__item md-tabs__item--active">
<a href="../../" class="md-tabs__link">
Nixpkgs
</a>
</li>
</ul>
</div>
</nav>
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../../.." title="Aux Docs" class="md-nav__button md-logo" aria-label="Aux Docs" data-md-component="logo">
<img src="../../../assets/aux-logo.svg" alt="logo">
</a>
Aux Docs
</label>
<div class="md-nav__source">
<a href="https://git.auxolotl.org/auxolotl/docs" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M16.777 0a2.9 2.9 0 1 1-2.529 4.322H12.91a4.266 4.266 0 0 0-4.265 4.195v2.118a7.076 7.076 0 0 1 4.147-1.42l.118-.002h1.338a2.9 2.9 0 0 1 5.43 1.422 2.9 2.9 0 0 1-5.43 1.422H12.91a4.266 4.266 0 0 0-4.265 4.195v2.319A2.9 2.9 0 0 1 7.222 24 2.9 2.9 0 0 1 5.8 18.57V8.589a7.109 7.109 0 0 1 6.991-7.108l.118-.001h1.338A2.9 2.9 0 0 1 16.778 0ZM7.223 19.905a1.194 1.194 0 1 0 0 2.389 1.194 1.194 0 0 0 0-2.389Zm9.554-10.464a1.194 1.194 0 1 0 0 2.389 1.194 1.194 0 0 0 0-2.39Zm0-7.735a1.194 1.194 0 1 0 0 2.389 1.194 1.194 0 0 0 0-2.389Z"/></svg>
</div>
<div class="md-source__repository">
auxolotl/docs
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../.." class="md-nav__link">
<span class="md-ellipsis">
Aux Documentation Hub
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../TODO/" class="md-nav__link">
<span class="md-ellipsis">
TODO
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../../Aux/" class="md-nav__link">
<span class="md-ellipsis">
Aux
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../../Lix/" class="md-nav__link">
<span class="md-ellipsis">
Lix
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../../NixOS/appstream/" class="md-nav__link">
<span class="md-ellipsis">
NixOS
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" checked>
<div class="md-nav__link md-nav__container">
<a href="../../" class="md-nav__link ">
<span class="md-ellipsis">
Nixpkgs
</span>
</a>
<label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Nixpkgs
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../options/" class="md-nav__link">
<span class="md-ellipsis">
Options
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../Build-Helpers/" class="md-nav__link">
<span class="md-ellipsis">
Build Helpers
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../Development/" class="md-nav__link">
<span class="md-ellipsis">
Development
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../Functions/" class="md-nav__link">
<span class="md-ellipsis">
Functions
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../Hooks/" class="md-nav__link">
<span class="md-ellipsis">
Hooks
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_7" checked>
<div class="md-nav__link md-nav__container">
<a href="../" class="md-nav__link ">
<span class="md-ellipsis">
Languages And Frameworks
</span>
</a>
<label class="md-nav__link " for="__nav_6_7" id="__nav_6_7_label" tabindex="0">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_7_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_6_7">
<span class="md-nav__icon md-icon"></span>
Languages And Frameworks
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../agda.section/" class="md-nav__link">
<span class="md-ellipsis">
Agda
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../android.section/" class="md-nav__link">
<span class="md-ellipsis">
Android
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../beam.section/" class="md-nav__link">
<span class="md-ellipsis">
BEAM Languages (Erlang, Elixir &amp; LFE)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../bower.section/" class="md-nav__link">
<span class="md-ellipsis">
Bower
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../chicken.section/" class="md-nav__link">
<span class="md-ellipsis">
CHICKEN
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../coq.section/" class="md-nav__link">
<span class="md-ellipsis">
Coq and coq packages
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../crystal.section/" class="md-nav__link">
<span class="md-ellipsis">
Crystal
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../cuda.section/" class="md-nav__link">
<span class="md-ellipsis">
CUDA
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../cuelang.section/" class="md-nav__link">
<span class="md-ellipsis">
Cue (Cuelang)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../dart.section/" class="md-nav__link">
<span class="md-ellipsis">
Dart
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../dhall.section/" class="md-nav__link">
<span class="md-ellipsis">
Dhall
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../dlang.section/" class="md-nav__link">
<span class="md-ellipsis">
D (Dlang)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../dotnet.section/" class="md-nav__link">
<span class="md-ellipsis">
Dotnet
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../emscripten.section/" class="md-nav__link">
<span class="md-ellipsis">
Emscripten
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../gnome.section/" class="md-nav__link">
<span class="md-ellipsis">
GNOME
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../go.section/" class="md-nav__link">
<span class="md-ellipsis">
Go
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../gradle.section/" class="md-nav__link">
<span class="md-ellipsis">
Gradle
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../hare.section/" class="md-nav__link">
<span class="md-ellipsis">
Hare
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../haskell.section/" class="md-nav__link">
<span class="md-ellipsis">
Haskell
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../hy.section/" class="md-nav__link">
<span class="md-ellipsis">
Hy
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../idris.section/" class="md-nav__link">
<span class="md-ellipsis">
Idris
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../idris2.section/" class="md-nav__link">
<span class="md-ellipsis">
Idris2
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../ios.section/" class="md-nav__link">
<span class="md-ellipsis">
iOS
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../java.section/" class="md-nav__link">
<span class="md-ellipsis">
Java
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../javascript.section/" class="md-nav__link">
<span class="md-ellipsis">
Javascript
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../julia.section/" class="md-nav__link">
<span class="md-ellipsis">
Julia
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../lisp.section/" class="md-nav__link">
<span class="md-ellipsis">
lisp-modules
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../lua.section/" class="md-nav__link">
<span class="md-ellipsis">
Lua
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../maven.section/" class="md-nav__link">
<span class="md-ellipsis">
Maven
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nim.section/" class="md-nav__link">
<span class="md-ellipsis">
Nim
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../ocaml.section/" class="md-nav__link">
<span class="md-ellipsis">
OCaml
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../octave.section/" class="md-nav__link">
<span class="md-ellipsis">
Octave
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../perl.section/" class="md-nav__link">
<span class="md-ellipsis">
Perl
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../php.section/" class="md-nav__link">
<span class="md-ellipsis">
PHP
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../pkg-config.section/" class="md-nav__link">
<span class="md-ellipsis">
pkg-config
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../python.section/" class="md-nav__link">
<span class="md-ellipsis">
Python
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../qt.section/" class="md-nav__link">
<span class="md-ellipsis">
Qt
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../r.section/" class="md-nav__link">
<span class="md-ellipsis">
R
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Ruby
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Ruby
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#using-ruby" class="md-nav__link">
<span class="md-ellipsis">
Using Ruby
</span>
</a>
<nav class="md-nav" aria-label="Using Ruby">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#temporary-ruby-environment-with-nix-shell" class="md-nav__link">
<span class="md-ellipsis">
Temporary Ruby environment with nix-shell
</span>
</a>
<nav class="md-nav" aria-label="Temporary Ruby environment with nix-shell">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#load-ruby-environment-from-.nix-expression" class="md-nav__link">
<span class="md-ellipsis">
Load Ruby environment from .nix expression
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#execute-command-with---run" class="md-nav__link">
<span class="md-ellipsis">
Execute command with --run
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#using-nix-shell-as-shebang" class="md-nav__link">
<span class="md-ellipsis">
Using nix-shell as shebang
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#developing-with-ruby" class="md-nav__link">
<span class="md-ellipsis">
Developing with Ruby
</span>
</a>
<nav class="md-nav" aria-label="Developing with Ruby">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#using-an-existing-gemfile" class="md-nav__link">
<span class="md-ellipsis">
Using an existing Gemfile
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#gem-specific-configurations-and-workarounds" class="md-nav__link">
<span class="md-ellipsis">
Gem-specific configurations and workarounds
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#ruby-platform-specif-gems" class="md-nav__link">
<span class="md-ellipsis">
Platform-specific gems
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#adding-a-gem-to-the-default-gemset" class="md-nav__link">
<span class="md-ellipsis">
Adding a gem to the default gemset
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#packaging-applications" class="md-nav__link">
<span class="md-ellipsis">
Packaging applications
</span>
</a>
<nav class="md-nav" aria-label="Packaging applications">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#packaging-executables-that-require-wrapping" class="md-nav__link">
<span class="md-ellipsis">
Packaging executables that require wrapping
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../rust.section/" class="md-nav__link">
<span class="md-ellipsis">
Rust
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../scheme.section/" class="md-nav__link">
<span class="md-ellipsis">
Scheme
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../swift.section/" class="md-nav__link">
<span class="md-ellipsis">
Swift
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../texlive.section/" class="md-nav__link">
<span class="md-ellipsis">
TeX Live
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../titanium.section/" class="md-nav__link">
<span class="md-ellipsis">
Titanium
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../vim.section/" class="md-nav__link">
<span class="md-ellipsis">
Vim
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../Library-Reference/asserts/" class="md-nav__link">
<span class="md-ellipsis">
Library Reference
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../Module-System/module-system.chapter/" class="md-nav__link">
<span class="md-ellipsis">
Module System
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../Packages/" class="md-nav__link">
<span class="md-ellipsis">
Packages
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../Standard-Environment/" class="md-nav__link">
<span class="md-ellipsis">
Standard Environment
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../Using-Nixpkgs/" class="md-nav__link">
<span class="md-ellipsis">
Using Nixpkgs
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#using-ruby" class="md-nav__link">
<span class="md-ellipsis">
Using Ruby
</span>
</a>
<nav class="md-nav" aria-label="Using Ruby">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#temporary-ruby-environment-with-nix-shell" class="md-nav__link">
<span class="md-ellipsis">
Temporary Ruby environment with nix-shell
</span>
</a>
<nav class="md-nav" aria-label="Temporary Ruby environment with nix-shell">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#load-ruby-environment-from-.nix-expression" class="md-nav__link">
<span class="md-ellipsis">
Load Ruby environment from .nix expression
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#execute-command-with---run" class="md-nav__link">
<span class="md-ellipsis">
Execute command with --run
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#using-nix-shell-as-shebang" class="md-nav__link">
<span class="md-ellipsis">
Using nix-shell as shebang
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#developing-with-ruby" class="md-nav__link">
<span class="md-ellipsis">
Developing with Ruby
</span>
</a>
<nav class="md-nav" aria-label="Developing with Ruby">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#using-an-existing-gemfile" class="md-nav__link">
<span class="md-ellipsis">
Using an existing Gemfile
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#gem-specific-configurations-and-workarounds" class="md-nav__link">
<span class="md-ellipsis">
Gem-specific configurations and workarounds
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#ruby-platform-specif-gems" class="md-nav__link">
<span class="md-ellipsis">
Platform-specific gems
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#adding-a-gem-to-the-default-gemset" class="md-nav__link">
<span class="md-ellipsis">
Adding a gem to the default gemset
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#packaging-applications" class="md-nav__link">
<span class="md-ellipsis">
Packaging applications
</span>
</a>
<nav class="md-nav" aria-label="Packaging applications">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#packaging-executables-that-require-wrapping" class="md-nav__link">
<span class="md-ellipsis">
Packaging executables that require wrapping
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="sec-language-ruby">Ruby</h1>
<h2 id="using-ruby">Using Ruby</h2>
<p>Several versions of Ruby interpreters are available on Nix, as well as over 250 gems and many applications written in Ruby. The attribute <code>ruby</code> refers to the default Ruby interpreter, which is currently MRI 3.1. It's also possible to refer to specific versions, e.g. <code>ruby_3_y</code>, <code>jruby</code>, or <code>mruby</code>.</p>
<p>In the Nixpkgs tree, Ruby packages can be found throughout, depending on what they do, and are called from the main package set. Ruby gems, however are separate sets, and there's one default set for each interpreter (currently MRI only).</p>
<p>There are two main approaches for using Ruby with gems. One is to use a specifically locked <code>Gemfile</code> for an application that has very strict dependencies. The other is to depend on the common gems, which we'll explain further down, and rely on them being updated regularly.</p>
<p>The interpreters have common attributes, namely <code>gems</code>, and <code>withPackages</code>. So you can refer to <code>ruby.gems.nokogiri</code>, or <code>ruby_3_2.gems.nokogiri</code> to get the Nokogiri gem already compiled and ready to use.</p>
<p>Since not all gems have executables like <code>nokogiri</code>, it's usually more convenient to use the <code>withPackages</code> function like this: <code>ruby.withPackages (p: with p; [ nokogiri ])</code>. This will also make sure that the Ruby in your environment will be able to find the gem and it can be used in your Ruby code (for example via <code>ruby</code> or <code>irb</code> executables) via <code>require "nokogiri"</code> as usual.</p>
<h3 id="temporary-ruby-environment-with-nix-shell">Temporary Ruby environment with <code>nix-shell</code></h3>
<p>Rather than having a single Ruby environment shared by all Ruby development projects on a system, Nix allows you to create separate environments per project. <code>nix-shell</code> gives you the possibility to temporarily load another environment akin to a combined <code>chruby</code> or <code>rvm</code> and <code>bundle exec</code>.</p>
<p>There are two methods for loading a shell with Ruby packages. The first and recommended method is to create an environment with <code>ruby.withPackages</code> and load that.</p>
<div class="highlight"><pre><span></span><code>$ nix-shell -p &quot;ruby.withPackages (ps: with ps; [ nokogiri pry ])&quot;
</code></pre></div>
<p>The other method, which is not recommended, is to create an environment and list all the packages directly.</p>
<div class="highlight"><pre><span></span><code>$ nix-shell -p ruby.gems.nokogiri ruby.gems.pry
</code></pre></div>
<p>Again, it's possible to launch the interpreter from the shell. The Ruby interpreter has the attribute <code>gems</code> which contains all Ruby gems for that specific interpreter.</p>
<h4 id="load-ruby-environment-from-.nix-expression">Load Ruby environment from <code>.nix</code> expression</h4>
<p>As explained <a href="https://nixos.org/manual/nix/stable/command-ref/nix-shell">in the <code>nix-shell</code> section</a> of the Nix manual, <code>nix-shell</code> can also load an expression from a <code>.nix</code> file.
Say we want to have Ruby, <code>nokogori</code>, and <code>pry</code>. Consider a <code>shell.nix</code> file with:</p>
<div class="highlight"><pre><span></span><code><span class="k">with</span> <span class="nb">import</span> <span class="l">&lt;nixpkgs&gt;</span> <span class="p">{};</span>
ruby<span class="o">.</span>withPackages <span class="p">(</span>ps<span class="p">:</span> <span class="k">with</span> ps<span class="p">;</span> <span class="p">[</span> nokogiri pry <span class="p">])</span>
</code></pre></div>
<p>What's happening here?</p>
<ol>
<li>We begin with importing the Nix Packages collections. <code>import &lt;nixpkgs&gt;</code> imports the <code>&lt;nixpkgs&gt;</code> function, <code>{}</code> calls it and the <code>with</code> statement brings all attributes of <code>nixpkgs</code> in the local scope. These attributes form the main package set.</li>
<li>Then we create a Ruby environment with the <code>withPackages</code> function.</li>
<li>The <code>withPackages</code> function expects us to provide a function as an argument that takes the set of all ruby gems and returns a list of packages to include in the environment. Here, we select the packages <code>nokogiri</code> and <code>pry</code> from the package set.</li>
</ol>
<h4 id="execute-command-with---run">Execute command with <code>--run</code></h4>
<p>A convenient flag for <code>nix-shell</code> is <code>--run</code>. It executes a command in the <code>nix-shell</code>. We can e.g. directly open a <code>pry</code> REPL:</p>
<div class="highlight"><pre><span></span><code>$ nix-shell -p &quot;ruby.withPackages (ps: with ps; [ nokogiri pry ])&quot; --run &quot;pry&quot;
</code></pre></div>
<p>Or immediately require <code>nokogiri</code> in pry:</p>
<div class="highlight"><pre><span></span><code>$ nix-shell -p &quot;ruby.withPackages (ps: with ps; [ nokogiri pry ])&quot; --run &quot;pry -rnokogiri&quot;
</code></pre></div>
<p>Or run a script using this environment:</p>
<div class="highlight"><pre><span></span><code>$ nix-shell -p &quot;ruby.withPackages (ps: with ps; [ nokogiri pry ])&quot; --run &quot;ruby example.rb&quot;
</code></pre></div>
<h4 id="using-nix-shell-as-shebang">Using <code>nix-shell</code> as shebang</h4>
<p>In fact, for the last case, there is a more convenient method. You can add a <a href="https://en.wikipedia.org/wiki/Shebang_(Unix)">shebang</a> to your script specifying which dependencies <code>nix-shell</code> needs. With the following shebang, you can just execute <code>./example.rb</code>, and it will run with all dependencies.</p>
<div class="highlight"><pre><span></span><code><span class="ch">#! /usr/bin/env nix-shell</span>
<span class="c1">#! nix-shell -i ruby -p &quot;ruby.withPackages (ps: with ps; [ nokogiri rest-client ])&quot;</span>
<span class="nb">require</span><span class="w"> </span><span class="s1">&#39;nokogiri&#39;</span>
<span class="nb">require</span><span class="w"> </span><span class="s1">&#39;rest-client&#39;</span>
<span class="n">body</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">RestClient</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;http://example.com&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">body</span>
<span class="nb">puts</span><span class="w"> </span><span class="no">Nokogiri</span><span class="o">::</span><span class="no">HTML</span><span class="p">(</span><span class="n">body</span><span class="p">)</span><span class="o">.</span><span class="n">at</span><span class="p">(</span><span class="s1">&#39;h1&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">text</span>
</code></pre></div>
<h2 id="developing-with-ruby">Developing with Ruby</h2>
<h3 id="using-an-existing-gemfile">Using an existing Gemfile</h3>
<p>In most cases, you'll already have a <code>Gemfile.lock</code> listing all your dependencies. This can be used to generate a <code>gemset.nix</code> which is used to fetch the gems and combine them into a single environment. The reason why you need to have a separate file for this, is that Nix requires you to have a checksum for each input to your build. Since the <code>Gemfile.lock</code> that <code>bundler</code> generates doesn't provide us with checksums, we have to first download each gem, calculate its SHA256, and store it in this separate file.</p>
<p>So the steps from having just a <code>Gemfile</code> to a <code>gemset.nix</code> are:</p>
<div class="highlight"><pre><span></span><code>$ bundle lock
$ bundix
</code></pre></div>
<p>If you already have a <code>Gemfile.lock</code>, you can run <code>bundix</code> and it will work the same.</p>
<p>To update the gems in your <code>Gemfile.lock</code>, you may use the <code>bundix -l</code> flag, which will create a new <code>Gemfile.lock</code> in case the <code>Gemfile</code> has a more recent time of modification.</p>
<p>Once the <code>gemset.nix</code> is generated, it can be used in a <code>bundlerEnv</code> derivation. Here is an example you could use for your <code>shell.nix</code>:</p>
<div class="highlight"><pre><span></span><code><span class="c1"># ...</span>
<span class="k">let</span>
<span class="ss">gems</span> <span class="o">=</span> bundlerEnv <span class="p">{</span>
<span class="ss">name</span> <span class="o">=</span> <span class="s2">&quot;gems-for-some-project&quot;</span><span class="p">;</span>
<span class="ss">gemdir</span> <span class="o">=</span> <span class="l">./.</span><span class="p">;</span>
<span class="p">};</span>
<span class="k">in</span> mkShell <span class="p">{</span> <span class="ss">packages</span> <span class="o">=</span> <span class="p">[</span> gems gems<span class="o">.</span>wrappedRuby <span class="p">];</span> <span class="p">}</span>
</code></pre></div>
<p>With this file in your directory, you can run <code>nix-shell</code> to build and use the gems. The important parts here are <code>bundlerEnv</code> and <code>wrappedRuby</code>.</p>
<p>The <code>bundlerEnv</code> is a wrapper over all the gems in your gemset. This means that all the <code>/lib</code> and <code>/bin</code> directories will be available, and the executables of all gems (even of indirect dependencies) will end up in your <code>$PATH</code>. The <code>wrappedRuby</code> provides you with all executables that come with Ruby itself, but wrapped so they can easily find the gems in your gemset.</p>
<p>One common issue that you might have is that you have Ruby, but also <code>bundler</code> in your gemset. That leads to a conflict for <code>/bin/bundle</code> and <code>/bin/bundler</code>. You can resolve this by wrapping either your Ruby or your gems in a <code>lowPrio</code> call. So in order to give the <code>bundler</code> from your gemset priority, it would be used like this:</p>
<div class="highlight"><pre><span></span><code><span class="c1"># ...</span>
mkShell <span class="p">{</span> <span class="ss">buildInputs</span> <span class="o">=</span> <span class="p">[</span> gems <span class="p">(</span>lowPrio gems<span class="o">.</span>wrappedRuby<span class="p">)</span> <span class="p">];</span> <span class="p">}</span>
</code></pre></div>
<p>Sometimes a Gemfile references other files. Such as <code>.ruby-version</code> or vendored gems. When copying the Gemfile to the nix store we need to copy those files alongside. This can be done using <code>extraConfigPaths</code>. For example:</p>
<div class="highlight"><pre><span></span><code><span class="p">{</span>
<span class="ss">gems</span> <span class="o">=</span> bundlerEnv <span class="p">{</span>
<span class="ss">name</span> <span class="o">=</span> <span class="s2">&quot;gems-for-some-project&quot;</span><span class="p">;</span>
<span class="ss">gemdir</span> <span class="o">=</span> <span class="l">./.</span><span class="p">;</span>
<span class="ss">extraConfigPaths</span> <span class="o">=</span> <span class="p">[</span> <span class="s2">&quot;</span><span class="si">${</span><span class="l">./.</span><span class="si">}</span><span class="s2">/.ruby-version&quot;</span> <span class="p">];</span>
<span class="p">};</span>
<span class="p">}</span>
</code></pre></div>
<h3 id="gem-specific-configurations-and-workarounds">Gem-specific configurations and workarounds</h3>
<p>In some cases, especially if the gem has native extensions, you might need to modify the way the gem is built.</p>
<p>This is done via a common configuration file that includes all of the workarounds for each gem.</p>
<p>This file lives at <code>/pkgs/development/ruby-modules/gem-config/default.nix</code>, since it already contains a lot of entries, it should be pretty easy to add the modifications you need for your needs.</p>
<p>In the meanwhile, or if the modification is for a private gem, you can also add the configuration to only your own environment.</p>
<p>Two places that allow this modification are the <code>ruby</code> derivation, or <code>bundlerEnv</code>.</p>
<p>Here's the <code>ruby</code> one:</p>
<div class="highlight"><pre><span></span><code><span class="p">{</span> pg_version <span class="o">?</span> <span class="s2">&quot;10&quot;</span><span class="p">,</span> pkgs <span class="o">?</span> <span class="nb">import</span> <span class="l">&lt;nixpkgs&gt;</span> <span class="p">{</span> <span class="p">}</span> <span class="p">}:</span>
<span class="k">let</span>
<span class="ss">myRuby</span> <span class="o">=</span> pkgs<span class="o">.</span>ruby<span class="o">.</span>override <span class="p">{</span>
<span class="ss">defaultGemConfig</span> <span class="o">=</span> pkgs<span class="o">.</span>defaultGemConfig <span class="o">//</span> <span class="p">{</span>
<span class="ss">pg</span> <span class="o">=</span> attrs<span class="p">:</span> <span class="p">{</span>
<span class="ss">buildFlags</span> <span class="o">=</span>
<span class="p">[</span> <span class="s2">&quot;--with-pg-config=</span><span class="si">${</span>pkgs<span class="o">.</span><span class="s2">&quot;postgresql_</span><span class="si">${</span>pg_version<span class="si">}</span><span class="s2">&quot;</span><span class="si">}</span><span class="s2">/bin/pg_config&quot;</span> <span class="p">];</span>
<span class="p">};</span>
<span class="p">};</span>
<span class="p">};</span>
<span class="k">in</span> myRuby<span class="o">.</span>withPackages <span class="p">(</span>ps<span class="p">:</span> <span class="k">with</span> ps<span class="p">;</span> <span class="p">[</span> pg <span class="p">])</span>
</code></pre></div>
<p>And an example with <code>bundlerEnv</code>:</p>
<div class="highlight"><pre><span></span><code><span class="p">{</span> pg_version <span class="o">?</span> <span class="s2">&quot;10&quot;</span><span class="p">,</span> pkgs <span class="o">?</span> <span class="nb">import</span> <span class="l">&lt;nixpkgs&gt;</span> <span class="p">{</span> <span class="p">}</span> <span class="p">}:</span>
<span class="k">let</span>
<span class="ss">gems</span> <span class="o">=</span> pkgs<span class="o">.</span>bundlerEnv <span class="p">{</span>
<span class="ss">name</span> <span class="o">=</span> <span class="s2">&quot;gems-for-some-project&quot;</span><span class="p">;</span>
<span class="ss">gemdir</span> <span class="o">=</span> <span class="l">./.</span><span class="p">;</span>
<span class="ss">gemConfig</span> <span class="o">=</span> pkgs<span class="o">.</span>defaultGemConfig <span class="o">//</span> <span class="p">{</span>
<span class="ss">pg</span> <span class="o">=</span> attrs<span class="p">:</span> <span class="p">{</span>
<span class="ss">buildFlags</span> <span class="o">=</span>
<span class="p">[</span> <span class="s2">&quot;--with-pg-config=</span><span class="si">${</span>pkgs<span class="o">.</span><span class="s2">&quot;postgresql_</span><span class="si">${</span>pg_version<span class="si">}</span><span class="s2">&quot;</span><span class="si">}</span><span class="s2">/bin/pg_config&quot;</span> <span class="p">];</span>
<span class="p">};</span>
<span class="p">};</span>
<span class="p">};</span>
<span class="k">in</span> mkShell <span class="p">{</span> <span class="ss">buildInputs</span> <span class="o">=</span> <span class="p">[</span> gems gems<span class="o">.</span>wrappedRuby <span class="p">];</span> <span class="p">}</span>
</code></pre></div>
<p>And finally via overlays:</p>
<div class="highlight"><pre><span></span><code><span class="p">{</span> pg_version <span class="o">?</span> <span class="s2">&quot;10&quot;</span> <span class="p">}:</span>
<span class="k">let</span>
<span class="ss">pkgs</span> <span class="o">=</span> <span class="nb">import</span> <span class="l">&lt;nixpkgs&gt;</span> <span class="p">{</span>
<span class="ss">overlays</span> <span class="o">=</span> <span class="p">[</span>
<span class="p">(</span>self<span class="p">:</span> super<span class="p">:</span> <span class="p">{</span>
<span class="ss">defaultGemConfig</span> <span class="o">=</span> super<span class="o">.</span>defaultGemConfig <span class="o">//</span> <span class="p">{</span>
<span class="ss">pg</span> <span class="o">=</span> attrs<span class="p">:</span> <span class="p">{</span>
<span class="ss">buildFlags</span> <span class="o">=</span> <span class="p">[</span>
<span class="s2">&quot;--with-pg-config=</span><span class="si">${</span>
pkgs<span class="o">.</span><span class="s2">&quot;postgresql_</span><span class="si">${</span>pg_version<span class="si">}</span><span class="s2">&quot;</span>
<span class="si">}</span><span class="s2">/bin/pg_config&quot;</span>
<span class="p">];</span>
<span class="p">};</span>
<span class="p">};</span>
<span class="p">})</span>
<span class="p">];</span>
<span class="p">};</span>
<span class="k">in</span> pkgs<span class="o">.</span>ruby<span class="o">.</span>withPackages <span class="p">(</span>ps<span class="p">:</span> <span class="k">with</span> ps<span class="p">;</span> <span class="p">[</span> pg <span class="p">])</span>
</code></pre></div>
<p>Then we can get whichever postgresql version we desire and the <code>pg</code> gem will always reference it correctly:</p>
<div class="highlight"><pre><span></span><code>$ nix-shell --argstr pg_version 9_4 --run &#39;ruby -rpg -e &quot;puts PG.library_version&quot;&#39;
90421
$ nix-shell --run &#39;ruby -rpg -e &quot;puts PG.library_version&quot;&#39;
100007
</code></pre></div>
<p>Of course for this use-case one could also use overlays since the configuration for <code>pg</code> depends on the <code>postgresql</code> alias, but for demonstration purposes this has to suffice.</p>
<h3 id="ruby-platform-specif-gems">Platform-specific gems</h3>
<p>Right now, bundix has some issues with pre-built, platform-specific gems: <a href="https://github.com/nix-community/bundix/pull/68">bundix PR #68</a>.
Until this is solved, you can tell bundler to not use platform-specific gems and instead build them from source each time:
- globally (will be set in <code>~/.config/.bundle/config</code>):
<div class="highlight"><pre><span></span><code>$<span class="w"> </span>bundle<span class="w"> </span>config<span class="w"> </span><span class="nb">set</span><span class="w"> </span>force_ruby_platform<span class="w"> </span><span class="nb">true</span>
</code></pre></div>
- locally (will be set in <code>&lt;project-root&gt;/.bundle/config</code>):
<div class="highlight"><pre><span></span><code>$<span class="w"> </span>bundle<span class="w"> </span>config<span class="w"> </span><span class="nb">set</span><span class="w"> </span>--local<span class="w"> </span>force_ruby_platform<span class="w"> </span><span class="nb">true</span>
</code></pre></div></p>
<h3 id="adding-a-gem-to-the-default-gemset">Adding a gem to the default gemset</h3>
<p>Now that you know how to get a working Ruby environment with Nix, it's time to go forward and start actually developing with Ruby. We will first have a look at how Ruby gems are packaged on Nix. Then, we will look at how you can use development mode with your code.</p>
<p>All gems in the standard set are automatically generated from a single <code>Gemfile</code>. The dependency resolution is done with <code>bundler</code> and makes it more likely that all gems are compatible to each other.</p>
<p>In order to add a new gem to nixpkgs, you can put it into the <code>/pkgs/development/ruby-modules/with-packages/Gemfile</code> and run <code>./maintainers/scripts/update-ruby-packages</code>.</p>
<p>To test that it works, you can then try using the gem with:</p>
<div class="highlight"><pre><span></span><code><span class="nv">NIX_PATH</span><span class="o">=</span><span class="nv">nixpkgs</span><span class="o">=</span><span class="nv">$PWD</span><span class="w"> </span>nix-shell<span class="w"> </span>-p<span class="w"> </span><span class="s2">&quot;ruby.withPackages (ps: with ps; [ name-of-your-gem ])&quot;</span>
</code></pre></div>
<h3 id="packaging-applications">Packaging applications</h3>
<p>A common task is to add a ruby executable to nixpkgs, popular examples would be <code>chef</code>, <code>jekyll</code>, or <code>sass</code>. A good way to do that is to use the <code>bundlerApp</code> function, that allows you to make a package that only exposes the listed executables, otherwise the package may cause conflicts through common paths like <code>bin/rake</code> or <code>bin/bundler</code> that aren't meant to be used.</p>
<p>The absolute easiest way to do that is to write a <code>Gemfile</code> along these lines:</p>
<div class="highlight"><pre><span></span><code><span class="n">source</span><span class="w"> </span><span class="s1">&#39;https://rubygems.org&#39;</span><span class="w"> </span><span class="k">do</span>
<span class="w"> </span><span class="n">gem</span><span class="w"> </span><span class="s1">&#39;mdl&#39;</span>
<span class="k">end</span>
</code></pre></div>
<p>If you want to package a specific version, you can use the standard Gemfile syntax for that, e.g. <code>gem 'mdl', '0.5.0'</code>, but if you want the latest stable version anyway, it's easier to update by running the <code>bundle lock</code> and <code>bundix</code> steps again.</p>
<p>Now you can also make a <code>default.nix</code> that looks like this:</p>
<div class="highlight"><pre><span></span><code><span class="p">{</span> bundlerApp <span class="p">}:</span>
bundlerApp <span class="p">{</span>
<span class="ss">pname</span> <span class="o">=</span> <span class="s2">&quot;mdl&quot;</span><span class="p">;</span>
<span class="ss">gemdir</span> <span class="o">=</span> <span class="l">./.</span><span class="p">;</span>
<span class="ss">exes</span> <span class="o">=</span> <span class="p">[</span> <span class="s2">&quot;mdl&quot;</span> <span class="p">];</span>
<span class="p">}</span>
</code></pre></div>
<p>All that's left to do is to generate the corresponding <code>Gemfile.lock</code> and <code>gemset.nix</code> as described above in the <code>Using an existing Gemfile</code> section.</p>
<h4 id="packaging-executables-that-require-wrapping">Packaging executables that require wrapping</h4>
<p>Sometimes your app will depend on other executables at runtime, and tries to find it through the <code>PATH</code> environment variable.</p>
<p>In this case, you can provide a <code>postBuild</code> hook to <code>bundlerApp</code> that wraps the gem in another script that prefixes the <code>PATH</code>.</p>
<p>Of course you could also make a custom <code>gemConfig</code> if you know exactly how to patch it, but it's usually much easier to maintain with a simple wrapper so the patch doesn't have to be adjusted for each version.</p>
<p>Here's another example:</p>
<div class="highlight"><pre><span></span><code><span class="p">{</span> lib<span class="p">,</span> bundlerApp<span class="p">,</span> makeWrapper<span class="p">,</span> git<span class="p">,</span> gnutar<span class="p">,</span> gzip <span class="p">}:</span>
bundlerApp <span class="p">{</span>
<span class="ss">pname</span> <span class="o">=</span> <span class="s2">&quot;r10k&quot;</span><span class="p">;</span>
<span class="ss">gemdir</span> <span class="o">=</span> <span class="l">./.</span><span class="p">;</span>
<span class="ss">exes</span> <span class="o">=</span> <span class="p">[</span> <span class="s2">&quot;r10k&quot;</span> <span class="p">];</span>
<span class="ss">nativeBuildInputs</span> <span class="o">=</span> <span class="p">[</span> makeWrapper <span class="p">];</span>
<span class="ss">postBuild</span> <span class="o">=</span> <span class="s s-Multiline">&#39;&#39;</span>
<span class="s s-Multiline"> wrapProgram $out/bin/r10k --prefix PATH : </span><span class="si">${</span>lib<span class="o">.</span>makeBinPath <span class="p">[</span> git gnutar gzip <span class="p">]</span><span class="si">}</span>
<span class="s s-Multiline"> &#39;&#39;</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
<div class="md-copyright__highlight">
Licenced MIT
</div>
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
<div class="md-social">
<a href="https://git.auxolotl.org/auxolotl/docs" target="_blank" rel="noopener" title="Aux Docs Repo" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M16.777 0a2.9 2.9 0 1 1-2.529 4.322H12.91a4.266 4.266 0 0 0-4.265 4.195v2.118a7.076 7.076 0 0 1 4.147-1.42l.118-.002h1.338a2.9 2.9 0 0 1 5.43 1.422 2.9 2.9 0 0 1-5.43 1.422H12.91a4.266 4.266 0 0 0-4.265 4.195v2.319A2.9 2.9 0 0 1 7.222 24 2.9 2.9 0 0 1 5.8 18.57V8.589a7.109 7.109 0 0 1 6.991-7.108l.118-.001h1.338A2.9 2.9 0 0 1 16.778 0ZM7.223 19.905a1.194 1.194 0 1 0 0 2.389 1.194 1.194 0 0 0 0-2.389Zm9.554-10.464a1.194 1.194 0 1 0 0 2.389 1.194 1.194 0 0 0 0-2.39Zm0-7.735a1.194 1.194 0 1 0 0 2.389 1.194 1.194 0 0 0 0-2.389Z"/></svg>
</a>
<a href="https://forum.aux.computer/" target="_blank" rel="noopener" title="Aux Forum" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12.103 0C18.666 0 24 5.485 24 11.997c0 6.51-5.33 11.99-11.9 11.99L0 24V11.79C0 5.28 5.532 0 12.103 0zm.116 4.563a7.395 7.395 0 0 0-6.337 3.57 7.247 7.247 0 0 0-.148 7.22L4.4 19.61l4.794-1.074a7.424 7.424 0 0 0 8.136-1.39 7.256 7.256 0 0 0 1.737-7.997 7.375 7.375 0 0 0-6.84-4.585h-.008z"/></svg>
</a>
<a href="https://wiki.auxolotl.org/" target="_blank" rel="noopener" title="Aux Wiki" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M17.801 13.557c.148.098.288.202.417.313 1.854 1.6 3.127 4.656 2.582 7.311-1.091-.255-5.747-1.055-7.638-3.383-.91-1.12-1.366-2.081-1.569-2.885a5.65 5.65 0 0 0 .034-.219c.089.198.197.35.313.466.24.24.521.335.766.372.304.046.594-.006.806-.068l.001.001c.05-.015.433-.116.86-.342.325-.173 2.008-.931 3.428-1.566Zm-7.384 1.435C9.156 16.597 6.6 18.939.614 18.417c.219-1.492 1.31-3.019 2.51-4.11.379-.345.906-.692 1.506-1.009.286.168.598.332.939.486 2.689 1.221 3.903 1.001 4.89.573a1.3 1.3 0 0 0 .054-.025 6.156 6.156 0 0 0-.096.66Zm4.152-.462c.38-.341.877-.916 1.383-1.559-.389-.15-.866-.371-1.319-.591-.598-.29-1.305-.283-2.073-.315a4.685 4.685 0 0 1-.804-.103c.014-.123.027-.246.038-.369.062.104.673.057.871.057.354 0 1.621.034 3.074-.574 1.452-.608 2.55-1.706 3.022-3.225.474-1.52.22-3.091-.168-3.952-.169.709-1.453 2.381-1.926 2.871-.473.489-2.381 2.296-2.972 2.921-.7.74-.688.793-1.332 1.302-.202.19-.499.402-.563.53.027-.338.039-.675.027-.997a7.653 7.653 0 0 0-.032-.523c.322-.059.567-.522.567-.861 0-.224-.106-.247-.271-.229.075-.894.382-3.923 1.254-4.281.218.109.831.068.649-.295-.182-.364-.825-.074-1.081.266-.28.374-.956 2.046-.92 4.324-.113.014-.174.033-.322.033-.171 0-.321-.04-.433-.05.034-2.275-.714-3.772-.84-4.169-.12-.375-.491-.596-.781-.596-.146 0-.272.056-.333.179-.182.363.459.417.677.308.706.321 1.156 3.519 1.254 4.277-.125-.006-.199.035-.199.233 0 .311.17.756.452.843a.442.442 0 0 0-.007.03s-.287.99-.413 2.189a4.665 4.665 0 0 1-.718-.225c-.714-.286-1.355-.583-2.019-.566-.664.018-1.366.023-1.804-.036-.438-.058-.649-.15-.649-.15s-.234.365.257 1.075c.42.607 1.055 1.047 1.644 1.18.589.134 1.972.18 2.785-.377.16-.109.317-.228.459-.34a8.717 8.717 0 0 0-.013.626c-.289.753-.571 1.993-.268 3.338 0-.001.701-.842.787-2.958.006-.144.009-.271.01-.383.052-.248.103-.518.148-.799.072.135.151.277.234.413.511.842 1.791 1.37 2.383 1.49.091.019.187.032.285.038Zm-1.12.745c-.188.055-.445.1-.713.059-.21-.031-.45-.11-.655-.316-.169-.168-.312-.419-.401-.789a9.837 9.837 0 0 0 .039-.82l.049-.243c.563.855 1.865 1.398 2.476 1.522.036.008.072.014.109.02l-.013.009c-.579.415-.76.503-.891.558Zm6.333-2.818c-.257.114-4.111 1.822-5.246 2.363.98-.775 3.017-3.59 3.699-4.774 1.062.661 1.468 1.109 1.623 1.441.101.217.09.38.096.515a.57.57 0 0 1-.172.455Zm-9.213 1.62a1.606 1.606 0 0 1-.19.096c-.954.414-2.126.61-4.728-.571-2.023-.918-3.024-2.157-3.371-2.666.476.161 1.471.473 2.157.524.282.021.703.068 1.167.125.021.209.109.486.345.829l.001.001c.451.651 1.134 1.119 1.765 1.262.622.141 2.083.182 2.942-.407a3.12 3.12 0 0 0 .132-.093l.001.179a6.052 6.052 0 0 0-.221.721Zm5.512-1.271a17.49 17.49 0 0 1-1.326-.589c.437.042 1.054.083 1.692.108-.121.162-.244.323-.366.481Zm.932-1.26c-.12.17-.245.343-.373.517-.241.018-.478.03-.709.038a29.05 29.05 0 0 1-.741-.048c.608-.065 1.228-.252 1.823-.507Zm.22-.315c-.809.382-1.679.648-2.507.648-.472 0-.833.018-1.139.039v.001c-.324-.031-.665-.039-1.019-.054a3.555 3.555 0 0 1-.152-.009c.102-.002.192-.006.249-.006.363 0 1.662.034 3.151-.589 1.508-.632 2.645-1.773 3.136-3.351.37-1.186.31-2.402.086-3.312.458-.336.86-.651 1.147-.91.501-.451.743-.733.848-.869.199.206.714.864.685 2.138-.036 1.611-.606 3.187-1.501 4.154a9.099 9.099 0 0 1-1.321 1.132 11.978 11.978 0 0 0-.644-.422l-.089-.055-.051.091c-.184.332-.5.825-.879 1.374ZM4.763 5.817c-.157 1.144.113 2.323.652 3.099.539.776 2.088 2.29 3.614 2.505.991.14 2.055.134 2.055.134s-.593-.576-1.114-1.66c-.521-1.085-.948-2.104-1.734-2.786-.785-.681-1.601-1.416-2.045-1.945-.444-.53-.59-.86-.59-.86s-.656.175-.838 1.513Zm14.301 4.549a9.162 9.162 0 0 0 1.3-1.12c.326-.352.611-.782.845-1.265 1.315.145 2.399.371 2.791.434 0 0-.679 1.971-3.945 3.022l-.016-.035c-.121-.26-.385-.594-.975-1.036Zm-11.634.859a8.537 8.537 0 0 1-.598-.224c-1.657-.693-2.91-1.944-3.449-3.678-.498-1.601-.292-3.251.091-4.269.225.544.758 1.34 1.262 2.01a3.58 3.58 0 0 0-.172.726c-.163 1.197.123 2.428.687 3.24.416.599 1.417 1.62 2.555 2.193-.128.002-.253.003-.376.002Zm-1.758-.077c-.958-.341-1.901-.787-2.697-1.368C-.07 7.559 0 6.827 0 6.827s1.558-.005 3.088.179c.03.126.065.251.104.377.557 1.791 1.851 3.086 3.562 3.803l.047.019a4.254 4.254 0 0 1-.267-.026h-.001c-.401-.053-.595-.135-.595-.135l-.157-.069-.092.144-.017.029Zm6.807-1.59c.086.017.136.058.136.145 0 .197-.242.5-.597.597l-.01-.161a.887.887 0 0 0 .283-.243c.078-.099.142-.217.188-.338Zm-1.591.006c.033.1.076.197.129.282.061.097.134.18.217.24l-.021.083c-.276-.093-.424-.293-.424-.466 0-.078.035-.119.099-.139Zm-.025-.664c-.275-.816-.795-2.022-1.505-2.179-.296.072-.938.096-.691-.145.246-.24 1.085-.048 1.283.217.145.194.744.806 1.011 1.737l.032.227a.324.324 0 0 0-.13.143Zm1.454-.266c.251-.99.889-1.639 1.039-1.841.197-.265 1.036-.457 1.283-.217.247.241-.395.217-.691.145-.69.152-1.2 1.296-1.481 2.109a.364.364 0 0 0-.067-.059.37.37 0 0 0-.092-.043l.009-.094Zm4.802-2.708a9.875 9.875 0 0 1-.596.705c-.304.315-1.203 1.176-1.963 1.916.647-.955 1.303-1.806 2.184-2.376.123-.08.249-.161.375-.245Z"/></svg>
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "../../..", "features": ["content.tooltips", "search.highlight", "navigation.tabs", "navigation.indexes", "navigation.prune"], "search": "../../../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
<script src="../../../assets/javascripts/bundle.fe8b6f2b.min.js"></script>
</body>
</html>
Reference in a new issue View git blame Copy permalink