gem-ext-zig_builder 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55b4bf2fe202be13789c3afbc3fc71d515d49f56b08b92720cd882ebed52d13d
-  data.tar.gz: 7fee2a3b6f222b25ce72b95275cdb8be2b2c61ca0948a44ae12f4d5098649e77
+  metadata.gz: 352295a2ed859fecfef121e9b8748b10efaa83eb2cc14842307cd43779c21724
+  data.tar.gz: 6222bdbd160014d6cf7c0e060a49d9ce9da9e8f37b4e774937ea3f7da0b912a9
 SHA512:
-  metadata.gz: 38802825ac0b746613ef0fba7447db7cda21879eaef100307689a083e3f05640ccea6adce95f2805b0d5ce2af2150fc1a21a06b1b769a0f2875c060a62cba970
-  data.tar.gz: 570fd46fc68606563c097b858e763ea92564d3189e6bba9f43971ea591403bd4561033fbe073afafd5318d16b2c5d095abf672a0e45119b0d30f7f949e6aaf54
+  metadata.gz: f38796b73f8c45131a5b0b6281304f2b8e5b76d2aab3a50bac322843794f24af60adea60c0a4ff295a24d9ebde9d8eba90a1f4966a999c0379abb125164c915d
+  data.tar.gz: 727f9954335613743bbd4dceaf35e7d359c4fa0bb5759c109323a1f6ad679e11a7d68446c13d5ae3771b2e5fb9fb40278f035163010b10660423883b38af0b80

data/lib/gem/ext/zig_builder/version.rb

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+
 module Gem
   module Ext
     class Builder; end
+
     class ZigBuilder < Builder
-      VERSION = '0.2.1'
+      VERSION = '0.3.0'
     end
   end
 end

data/lib/gem/ext/zig_builder.rb

@@ -1,54 +1,141 @@
 # frozen_string_literal: true
-require 'gem/ext/zig_builder/version'
+
+require_relative 'zig_builder/version'
 require 'rubygems/ext/builder'
-require 'rubygems/command'
-require 'shellwords'
 require 'rbconfig'
 require 'tmpdir'
 
+# This class is used by rubygems to build Zig extensions. It is a thin-wrapper
+# over the zig build command. To trigger this builder, specify a build.zig
+# file in the gem spec.
+#
+# A minimal zig.build example:
+#
+#   const std = @import("std");
+#   pub fn build(b: *std.Build) void {
+#       const optimize = b.standardOptimizeOption(.{});
+#       const target = b.standardTargetOptions(.{});
+#       const lib = b.addSharedLibrary(.{
+#           .name = "zigrb_example",
+#           .root_source_file = .{ .path = "src/zigrb.zig" },
+#           .target = target,
+#           .optimize = optimize,
+#       });
+#       lib.linkSystemLibrary(std.os.getenv("RUBY_PC") orelse "ruby");
+#       lib.linkSystemLibrary("c");
+#       b.installArtifact(lib);
+#   }
+#
+# A minimal zigrb.zig example:
+#
+#   const std = @import("std");
+#   const ruby = @cImport(@cInclude("ruby/ruby.h"));
+#   export fn Init_libzigrb_example() void {
+#       ruby.ruby_init();
+#   }
+#
+# An example of defining a ruby class and adding a zig method:
+#
+#   var zig_rb_class: ruby.VALUE = ruby.rb_define_class("ZigExample", ruby.rb_cObject);
+#   _ = ruby.rb_define_method(zig_rb_class, "method_name", rb_example_method, 2);
+#
+# An example of a zig ruby method:
+#
+#   fn rb_example_method(...) callconv(.C) ruby.VALUE {
+#       var ap = @cVaStart();
+#       defer @cVaEnd(&ap);
+#       // first argument is `self` in ruby; discard it
+#       var self = @cVaArg(&ap, ruby.VALUE); _ = self;
+#       // additional arguments
+#       var _ = @cVaArg(&ap, ruby.VALUE);
+#       var _ = @cVaArg(&ap, ruby.VALUE);
+#       return ruby.QNil
+#   }
+#
+# An example of ruby zig type conversions:
+#
+#   var m = ruby.NUM2INT(@cVaArg(&ap, ruby.VALUE));
+#   var n = ruby.NUM2INT(@cVaArg(&ap, ruby.VALUE));
+#   return ruby.INT2NUM(f(m, n));
+#
 class Gem::Ext::ZigBuilder < Gem::Ext::Builder
+  #
+  # This module patches the Builder builder_for method to ensure that
+  # this builder class is used for build.zig extensions.
+  #
   module PatchBuilderLookup
     def builder_for(extension)
       /build.zig/ === extension ? Gem::Ext::ZigBuilder : super
     end
   end
 
-  def self.build(extension, dest_path, results, args=[], lib_dir=nil, extension_dir=nil)
-    tmp_dir         = Dir.mktmpdir
-    dlext           = RbConfig::CONFIG['DLEXT']
-    target_vendor   = RbConfig::CONFIG['target_vendor']
-    pkg_config_path = "#{RbConfig::CONFIG['libdir']}/pkgconfig"
-    ruby_pc         = "#{File.basename(RbConfig::CONFIG['ruby_pc'], '.pc')}"
-
-    cmd = [].tap {|c|
-      c << 'zig' << 'build' << '-Doptimize=ReleaseSafe'
-      c << '--prefix-lib-dir' << tmp_dir
-      c << 'test' << 'install'
-    }
-
-    # older versions of ruby do not support the 5th `env` argument to run,
-    # so pollute the global ENV as a cheap workaround
-    ENV['PKG_CONFIG_PATH'] = pkg_config_path
-    ENV['RUBY_PC'        ] = ruby_pc
-
-    # even older versions of ruby do not support the 4th extension_dir arg
-    Dir.chdir(extension_dir ? extension_dir : '.') do
-      run(cmd, results, 'zig')
+  class << self
+    def build(_extension, dest_path, results, _args = [], _lib_dir = nil, extension_dir = nil)
+      dlext   = RbConfig::CONFIG['DLEXT']
+      tmp_dir = Dir.mktmpdir
+      command = _build_command(tmp_dir)
+      envvars = _build_envvars
+
+      _run(command, results, 'zig', extension_dir, envvars)
+      _install_artifacts(tmp_dir, dlext, dest_path)
+
+      results
+    ensure
+      FileUtils.remove_entry tmp_dir if tmp_dir
     end
 
-    Dir.chdir tmp_dir do
-      if target_vendor == 'apple' && dlext == 'bundle'
-        Dir.glob('*.dylib').each do |dylib|
-          FileUtils.mv dylib, "#{File.basename(dylib, '.dylib')}.bundle"
-        end
+    private
+
+    def _build_command(tmp_dir)
+      [].tap { |c|
+        c << 'zig' << 'build' << '-Doptimize=ReleaseSafe'
+        c << '--prefix-lib-dir' << tmp_dir
+        c << 'test' << 'install'
+      }
+    end
+
+    def _build_envvars
+      {
+        'PKG_CONFIG_PATH' => "#{RbConfig::CONFIG['libdir']}/pkgconfig",
+        'RUBY_PC'         => File.basename(RbConfig::CONFIG['ruby_pc'], '.pc'),
+      }
+    end
+
+    def _run(command, results, command_name, dir, env)
+      # old versions do not support the 4th `dir` arg
+      # old versions do not support the 5th `env` arg
+      case method(:run).parameters.count
+      when 3
+        _pollute_env(env)
+        run(command, results, command_name)
+      when 4
+        _pollute_env(env)
+        run(command, results, command_name, dir)
+      when 5
+        run(command, results, command_name, dir, env)
+      else
+        raise ArgumentError, 'wrong number of arguments'
       end
+    end
 
-      FileUtils.mv Dir.glob("*.#{dlext}"), dest_path
+    def _pollute_env(env)
+      env.each do |k, v| ENV[k] = v end
     end
 
-    results
-  ensure
-    FileUtils.remove_entry tmp_dir if tmp_dir
+    def _install_artifacts(tmp_dir, dlext, dest_path)
+      target_vendor   = RbConfig::CONFIG['target_vendor']
+
+      Dir.chdir tmp_dir do
+        if target_vendor == 'apple' && dlext == 'bundle'
+          # zig builds a .dylib but ruby wants to load a .bundle
+          Dir.glob('*.dylib').each do |dylib|
+            FileUtils.mv dylib, "#{File.basename(dylib, '.dylib')}.bundle"
+          end
+        end
+
+        FileUtils.mv Dir.glob("*.#{dlext}"), dest_path
+      end
+    end
   end
 end
 

data/lib/rubygems_plugin.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# RubyGems will load plugins in the latest version of each installed gem
+# or $LOAD_PATH. Plugins must be named ‘rubygems_plugin’ (.rb, .so,
+# etc) and placed at the root of your gem’s #require_path. Plugins are
+# installed at a special location and loaded on boot.
+# https://guides.rubygems.org/plugins/
+
+require_relative 'gem/ext/zig_builder'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gem-ext-zig_builder
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Frank J. Cameron
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-11 00:00:00.000000000 Z
+date: 2023-05-20 00:00:00.000000000 Z
 dependencies: []
 description: ''
 email:
@@ -19,6 +19,7 @@ extra_rdoc_files: []
 files:
 - lib/gem/ext/zig_builder.rb
 - lib/gem/ext/zig_builder/version.rb
+- lib/rubygems_plugin.rb
 homepage: https://gitlab.com/fjc/gem-ext-zig_builder
 licenses:
 - MIT
@@ -26,6 +27,7 @@ metadata:
   homepage_uri: https://gitlab.com/fjc/gem-ext-zig_builder
   source_code_uri: https://gitlab.com/fjc/gem-ext-zig_builder
   changelog_uri: https://gitlab.com/fjc/gem-ext-zig_builder
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -34,7 +36,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="