RubyGems.org API Demo

Gem: gudev

Info: GUdev, GLib bindings for libudev device enumeration, for Ruby. Defined from its GObject Introspection typelib at require time rather than wrapped by hand, so the binding is the whole library and does not drift as it gains API.

Authors: Nathan Kidd

Downloads: 105

Version: 1.0.0

Project Homepage Content:

gudev | RubyGems.org | your community gem host

GUdev, GLib bindings for libudev device enumeration, for Ruby. Defined from its GObject Introspection typelib at require time rather than wrapped by hand, so the binding is the whole library and does not drift as it gains API.

Required Ruby Version

>= 3.3

Authors

Nathan Kidd

Versions

  1. 1.0.0
    1. source

      1. 1.0.0 source November 03, 2026 (13.5 KB)

Pushed by

SHA 256 checksum

Homepage URI Content:

GitHub - n-at-han-k/gudev-rb: Ruby bindings for the gudev crate - GLib support for libudev. · GitHub
Skip to content
n-at-han-kPublic

About

Ruby bindings for the gudev crate - GLib support for libudev.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

gudev

Ruby bindings for libgudev, GNOME's GObject wrapper over libudev: what devices does this machine have, read out of the kernel's sysfs tree.

require "gudev"

client = GUdev::Client.new

client.query_by_subsystem("block").each do |device|
  puts "#{device.name}\t#{device.device_file}\t#{device.get_property("ID_MODEL")}"
end

# Or build a filtered search and run it.
disks = GUdev::Enumerator.new(client)
  .add_match_subsystem("block")
  .add_match_property("DEVTYPE", "disk")
  .execute

No display, no session bus and no GLib main loop — this works from a plain script. The one exception is libgudev's uevent signal, devices appearing and disappearing, which only emits while a GLib main context is running.

How this works, and what it costs to install

libgudev ships a GObject Introspection typelib — GUdev-1.0.typelib — describing every class, method, property and signal it has. GUdev::Loader, about twenty lines, hands that to ruby-gnome's GObjectIntrospection::Loader, which defines the Ruby classes from it at require time.

So there is no extension of its own here, no Cargo workspace and no per-platform binary. You get the whole library rather than the subset somebody got round to wrapping by hand, and it does not drift when libgudev gains API.

Be precise about install, though. gem install gudev still compiles C, because gobject-introspection and glib2 both declare spec.extensions and build against glib — so a compiler and glib's development headers are needed. What this gem adds on top of that is nothing: those two are the extensions every ruby-gnome application already has, since gtk4 depends on them. If you are writing a Ruby GNOME app, gudev costs you no build step you were not already paying.

This is how ruby-gnome itself ships gtksourceview5, libsecret and the rest.

The one thing you must install

The typelib is a C-library artefact, so it belongs to your distribution and this gem cannot install it:

Debian / Ubuntu gir1.2-gudev-1.0 (the library is libgudev-1.0-0)
Fedora libgudev
Arch libgudev
nix pkgs.libgudev

If it is not in the default search path, point GI_TYPELIB_PATH at the directory holding GUdev-1.0.typelib. The dev shell in flake.nix does this.

One trap worth knowing. The typelib must come from the same glib build as the gobject-introspection gem. GUdev-1.0.typelib names GObject-2.0 as its one dependency, and two glib builds in one process fail with cannot register existing type. Under nix, take both from one nixpkgs — and note that glib's typelibs live in its out output, not the default bin one.

What the namespace gives you

GUdev::Client the handle on udev; direct lookups by subsystem, name, device file, sysfs path or device number
GUdev::Enumerator a filtered search built up by chaining add_match_* / add_nomatch_* and then execute
GUdev::Device one device: its identity, its place in the tree, its udev properties and its sysfs attributes
GUdev::DeviceType BLOCK, CHAR, NONE — the space a device number lives in

udev has no error return for something that is not set: a missing property or sysfs attribute reads back as nil, and the numeric coercions (get_property_as_int and friends) give their own type's zero. The suite pins that, because it is what a caller branches on.

Using it from a flake

The gem needs GUdev-1.0.typelib and everything that typelib declares, resolved transitively by the loader at require time. A missing one surfaces as Typelib file for namespace 'X' not found, one at a time, so the whole chain is listed here rather than discovered by repeated failure:

  • pkgs.libgudev — its typelib, which is where GUdev-1.0.typelib lives
  • pkgs.glib — GLib-2.0, GObject-2.0 and Gio-2.0, which nearly every GNOME typelib declares

Note the .out: a package's default output is often bin, which carries no typelibs. makeSearchPath takes the first output, so it has to be asked for out explicitly — this is the single most common way to get a search path that looks right and finds nothing.

{
  inputs.nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";

  outputs = { nixpkgs, ... }:
    let
      system = "x86_64-linux";
      pkgs = nixpkgs.legacyPackages.${system};

      typelibPath = pkgs.lib.makeSearchPath "lib/girepository-1.0"
        (map (drv: drv.out or drv) [ pkgs.libgudev pkgs.glib ]);
    in
    {
      devShells.${system}.default = pkgs.mkShell {
        packages = [ pkgs.ruby_3_4 pkgs.bundler ] ++ [ pkgs.libgudev pkgs.glib ];

        shellHook = ''
          export GI_TYPELIB_PATH="${typelibPath}''${GI_TYPELIB_PATH:+:$GI_TYPELIB_PATH}"
        '';
      };
    };
}

Everything must come from one nixpkgs. A typelib built against a different glib than the gobject-introspection gem registers GIO twice in the process and fails with cannot register existing type 'GTlsCertificate'.

If you are packaging an application rather than entering a shell, the same typelibPath goes on the wrapper:

makeWrapper ${ruby}/bin/ruby $out/bin/my-app \
  --set GI_TYPELIB_PATH "${typelibPath}"

Development

nix develop
bin/test

Releasing

gem kit release

That is the whole thing. It gates on the changelog having an entry for this version, on no deprecation deadline coming due, and on a clean working tree; then builds, pushes and tags.

There is nothing to wait for in CI. This gem is pure Ruby, so gem build produces one gudev-X.Y.Z.gem that is the same artefact wherever it is built — no extension, no per-platform gems, nothing for a workflow to hand back.

Licence

Apache-2.0. libgudev itself is LGPL-2.1-or-later; this gem links nothing and copies no libgudev code — it reads a description of it at runtime.

About

Ruby bindings for the gudev crate - GLib support for libudev.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

Versions:

Owners: