rb_sys 0.1.2 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc5893cc69da4a662b63cd5f405880f7e3af228ce263b3d2624285948700290f
-  data.tar.gz: 6b1f7612e79d7a4d52f955809cb9c49f96b19b87e5be6823e4418c6642a39867
+  metadata.gz: b22b7aeab8b1c9d4e6ad7225f110ad9274594ac53bf1b6284421bb9728d6cdb2
+  data.tar.gz: d14f49223946ead201af5b97ab3bf872924da318427762db28939201cca10248
 SHA512:
-  metadata.gz: f094d4cd66b90fa30e396e7b17c91bec78b25cb60ce22a0816577dae88e77f3bc735bec90911d2ba87fb2221d1da782090f2feaee74283a5395c0fc795f746ee
-  data.tar.gz: 2baa7bb926cf8d5208cb1951f42991782e8d5062b43ab0fad5e7140473644930517c56650e37d29a47598d52a62434cd53f41877c9be831c15b00a58dc8f2ada
+  metadata.gz: '049e3e24630545530e01983ab43288e992e73cfcc74e8b2f070735ece4aa3b1e5488a5fc473410c6539f00d162e8366c0b7aebde3bbda2cdf57f579a6d684f18'
+  data.tar.gz: 979ba1c4c4faf11316f576ea1ec103c244bb20dcca42a13e0e23cf7b886e5f249bb8169a14b6bcf2cf22aedf121b53a9e96a6068e6e6432e873924714f6368ae

data/LICENSE-APACHE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2021-2022 Ian Ker-Seymer
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/LICENSE-MIT

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021-2022 Ian Ker-Seymer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/lib/rb_sys/cargo_builder/link_flag_converter.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module RbSys
+  class CargoBuilder
+    # Converts Ruby link flags into something cargo understands
+    class LinkFlagConverter
+      def self.convert(arg)
+        case arg.chomp
+        when /^-L\s*(.+)$/
+          ["-L", "native=#{$1}"]
+        when /^--library=(\w+\S+)$/, /^-l\s*(\w+\S+)$/
+          ["-l", $1]
+        when /^-l\s*:lib(\S+).a$/
+          ["-l", "static=#{$1}"]
+        when /^-l\s*:lib(\S+).(so|dylib|dll)$/
+          ["-l", "dylib=#{$1}"]
+        when /^-F\s*(.*)$/
+          ["-l", "framework=#{$1}"]
+        else
+          ["-C", "link_arg=#{arg}"]
+        end
+      end
+    end
+  end
+end

data/lib/rb_sys/cargo_builder.rb

@@ -0,0 +1,333 @@
+module RbSys
+  class CargoBuilder < Gem::Ext::Builder
+    attr_accessor :spec, :runner, :profile, :env, :features, :target, :extra_rustc_args
+
+    def initialize(spec)
+      require "rubygems/command"
+      require_relative "cargo_builder/link_flag_converter"
+
+      @spec = spec
+      @runner = self.class.method(:run)
+      @profile = ENV.fetch("CARGO_BUILD_PROFILE", :release).to_sym
+      @env = {}
+      @features = []
+      @target = ENV["CARGO_BUILD_TARGET"]
+      @extra_rustc_args = []
+    end
+
+    def build(_extension, dest_path, results, args = [], lib_dir = nil, cargo_dir = Dir.pwd)
+      require "fileutils"
+      require "shellwords"
+
+      build_crate(dest_path, results, args, cargo_dir)
+      validate_cargo_build!(dest_path)
+      rename_cdylib_for_ruby_compatibility(dest_path)
+      finalize_directory(dest_path, lib_dir, cargo_dir)
+      results
+    end
+
+    def build_crate(dest_path, results, args, cargo_dir)
+      env = build_env
+      cmd = cargo_command(cargo_dir, dest_path, args)
+      runner.call cmd, results, "cargo", cargo_dir, env
+
+      results
+    end
+
+    def build_env
+      build_env = rb_config_env
+      build_env["RUBY_STATIC"] = "true" if ruby_static? && ENV.key?("RUBY_STATIC")
+      build_env.merge(env)
+    end
+
+    def cargo_command(cargo_dir, dest_path, args = [])
+      manifest = File.join(cargo_dir, "Cargo.toml")
+      cargo = ENV.fetch("CARGO", "cargo")
+
+      cmd = []
+      cmd += [cargo, "rustc"]
+      cmd += ["--target", target] if target
+      cmd += ["--target-dir", dest_path]
+      cmd += ["--features", features.join(",")] unless features.empty?
+      cmd += ["--manifest-path", manifest]
+      cmd += ["--lib"]
+      cmd += ["--profile", profile.to_s]
+      cmd += ["--locked"] if profile.to_s == "release"
+      cmd += Gem::Command.build_args
+      cmd += args
+      cmd += ["--"]
+      cmd += [*cargo_rustc_args(dest_path)]
+      cmd += extra_rustc_args
+      cmd
+    end
+
+    def cargo_dylib_path(dest_path)
+      prefix = so_ext == "dll" ? "" : "lib"
+      path_parts = [dest_path]
+      path_parts << target if target
+      path_parts += [profile_target_directory, "#{prefix}#{cargo_crate_name}.#{so_ext}"]
+      File.join(*path_parts)
+    end
+
+    private
+
+    def rb_config_env
+      result = {}
+      RbConfig::CONFIG.each { |k, v| result["RBCONFIG_#{k}"] = v }
+      result
+    end
+
+    def cargo_rustc_args(dest_dir)
+      [
+        *linker_args,
+        *mkmf_libpath,
+        *rustc_dynamic_linker_flags(dest_dir),
+        *rustc_lib_flags(dest_dir),
+        *platform_specific_rustc_args(dest_dir),
+        *debug_flags
+      ]
+    end
+
+    def platform_specific_rustc_args(dest_dir, flags = [])
+      if mingw_target?
+        # On mingw platforms, mkmf adds libruby to the linker flags
+        flags += libruby_args(dest_dir)
+
+        # Make sure ALSR is used on mingw
+        # see https://github.com/rust-lang/rust/pull/75406/files
+        flags += ["-C", "link-arg=-Wl,--dynamicbase"]
+        flags += ["-C", "link-arg=-Wl,--disable-auto-image-base"]
+
+        # If the gem is installed on a host with build tools installed, but is
+        # run on one that isn't the missing libraries will cause the extension
+        # to fail on start.
+        flags += ["-C", "link-arg=-static-libgcc"]
+      end
+
+      flags
+    end
+
+    # We want to use the same linker that Ruby uses, so that the linker flags from
+    # mkmf work properly.
+    def linker_args
+      # Have to handle CC="cl /nologo" on mswin
+      cc_flag = Shellwords.split(makefile_config("CC"))
+      linker = cc_flag.shift
+      link_args = cc_flag.flat_map { |a| ["-C", "link-arg=#{a}"] }
+
+      ["-C", "linker=#{linker}", *link_args]
+    end
+
+    def libruby_args(dest_dir)
+      libs = makefile_config(ruby_static? ? "LIBRUBYARG_STATIC" : "LIBRUBYARG_SHARED")
+      raw_libs = Shellwords.split(libs)
+      raw_libs.flat_map { |l| ldflag_to_link_modifier(l) }
+    end
+
+    def ruby_static?
+      return true if %w[1 true].include?(ENV["RUBY_STATIC"])
+
+      makefile_config("ENABLE_SHARED") == "no"
+    end
+
+    # Ruby expects the dylib to follow a file name convention for loading
+    def rename_cdylib_for_ruby_compatibility(dest_path)
+      new_path = final_extension_path(dest_path)
+      FileUtils.cp(cargo_dylib_path(dest_path), new_path)
+      new_path
+    end
+
+    def validate_cargo_build!(dir)
+      dylib_path = cargo_dylib_path(dir)
+
+      raise DylibNotFoundError, dir unless File.exist?(dylib_path)
+
+      dylib_path
+    end
+
+    def final_extension_path(dest_path)
+      dylib_path = cargo_dylib_path(dest_path)
+      dlext_name = "#{spec.name}.#{makefile_config("DLEXT")}"
+      dylib_path.gsub(File.basename(dylib_path), dlext_name)
+    end
+
+    def cargo_crate_name
+      spec.metadata.fetch("cargo_crate_name", spec.name).tr("-", "_")
+    end
+
+    def rustc_dynamic_linker_flags(dest_dir)
+      split_flags("DLDFLAGS")
+        .map { |arg| maybe_resolve_ldflag_variable(arg, dest_dir) }
+        .compact
+        .flat_map { |arg| ldflag_to_link_modifier(arg) }
+    end
+
+    def rustc_lib_flags(dest_dir)
+      split_flags("LIBS").flat_map { |arg| ldflag_to_link_modifier(arg) }
+    end
+
+    def split_flags(var)
+      Shellwords.split(RbConfig::CONFIG.fetch(var, ""))
+    end
+
+    def ldflag_to_link_modifier(arg)
+      LinkFlagConverter.convert(arg)
+    end
+
+    def msvc_target?
+      makefile_config("target_os").include?("msvc")
+    end
+
+    def darwin_target?
+      makefile_config("target_os").include?("darwin")
+    end
+
+    def mingw_target?
+      makefile_config("target_os").include?("mingw")
+    end
+
+    def win_target?
+      target_platform = RbConfig::CONFIG["target_os"]
+      !!Gem::WIN_PATTERNS.find { |r| target_platform =~ r }
+    end
+
+    # Interpolate substition vars in the arg (i.e. $(DEFFILE))
+    def maybe_resolve_ldflag_variable(input_arg, dest_dir)
+      var_matches = input_arg.match(/\$\((\w+)\)/)
+
+      return input_arg unless var_matches
+
+      var_name = var_matches[1]
+
+      return input_arg if var_name.nil? || var_name.chomp.empty?
+
+      case var_name
+      # On windows, it is assumed that mkmf has setup an exports file for the
+      # extension, so we have to to create one ourselves.
+      when "DEFFILE"
+        write_deffile(dest_dir)
+      else
+        RbConfig::CONFIG[var_name]
+      end
+    end
+
+    def write_deffile(dest_path)
+      dest_dir = File.dirname(final_extension_path(dest_path))
+      FileUtils.mkdir_p(dest_dir)
+      deffile_path = File.join(dest_dir, "#{spec.name}-#{RbConfig::CONFIG["arch"]}.def")
+      export_prefix = makefile_config("EXPORT_PREFIX") || ""
+
+      File.open(deffile_path, "w") do |f|
+        f.puts "EXPORTS"
+        f.puts "#{export_prefix.strip}Init_#{spec.name}"
+      end
+
+      deffile_path
+    end
+
+    # We have to basically reimplement RbConfig::CONFIG['SOEXT'] here to support
+    # Ruby < 2.5
+    #
+    # @see https://github.com/ruby/ruby/blob/c87c027f18c005460746a74c07cd80ee355b16e4/configure.ac#L3185
+    def so_ext
+      return RbConfig::CONFIG["SOEXT"] if RbConfig::CONFIG.key?("SOEXT")
+
+      if win_target?
+        "dll"
+      elsif darwin_target?
+        "dylib"
+      else
+        "so"
+      end
+    end
+
+    # Corresponds to $(LIBPATH) in mkmf
+    def mkmf_libpath
+      ["-L", "native=#{makefile_config("libdir")}"]
+    end
+
+    def makefile_config(var_name)
+      val = RbConfig::MAKEFILE_CONFIG[var_name]
+
+      return unless val
+
+      RbConfig.expand(val.dup)
+    end
+
+    # Good balance between binary size and debugability
+    def debug_flags
+      return [] if profile == :dev
+
+      ["-C", "debuginfo=1"]
+    end
+
+    # Copied from ExtConfBuilder
+    def finalize_directory(dest_path, lib_dir, extension_dir)
+      require "fileutils"
+      require "tempfile"
+
+      ext_path = final_extension_path(dest_path)
+
+      begin
+        tmp_dest = Dir.mktmpdir(".gem.", extension_dir)
+
+        # Some versions of `mktmpdir` return absolute paths, which will break make
+        # if the paths contain spaces. However, on Ruby 1.9.x on Windows, relative
+        # paths cause all C extension builds to fail.
+        #
+        # As such, we convert to a relative path unless we are using Ruby 1.9.x on
+        # Windows. This means that when using Ruby 1.9.x on Windows, paths with
+        # spaces do not work.
+        #
+        # Details: https://github.com/rubygems/rubygems/issues/977#issuecomment-171544940
+        tmp_dest_relative = get_relative_path(tmp_dest.clone, extension_dir)
+
+        if tmp_dest_relative
+          full_tmp_dest = File.join(extension_dir, tmp_dest_relative)
+
+          # TODO: remove in RubyGems 3
+          if Gem.install_extension_in_lib && lib_dir
+            FileUtils.mkdir_p lib_dir
+            FileUtils.cp_r ext_path, lib_dir, remove_destination: true
+          end
+
+          FileUtils::Entry_.new(full_tmp_dest).traverse do |ent|
+            destent = ent.class.new(dest_path, ent.rel)
+            destent.exist? || FileUtils.mv(ent.path, destent.path)
+          end
+        end
+      ensure
+        FileUtils.rm_rf tmp_dest if tmp_dest
+      end
+    end
+
+    def get_relative_path(path, base)
+      path[0..base.length - 1] = "." if path.start_with?(base)
+      path
+    end
+
+    def profile_target_directory
+      case profile
+      when :release then "release"
+      when :dev then "debug"
+      else raise "unknown target directory for profile: #{profile}"
+      end
+    end
+
+    # Error raised when no cdylib artifact was created
+    class DylibNotFoundError < StandardError
+      def initialize(dir)
+        files = Dir.glob(File.join(dir, "**", "*")).map { |f| "- #{f}" }.join "\n"
+
+        super <<~MSG
+          Dynamic library not found for Rust extension (in #{dir})
+
+          Make sure you set "crate-type" in Cargo.toml to "cdylib"
+
+          Found files:
+          #{files}
+        MSG
+      end
+    end
+  end
+end

data/lib/rb_sys/mkmf.rb

@@ -2,13 +2,33 @@
 
 require "rubygems/ext"
 require "shellwords"
-require_relative "./../../vendor/rubygems/ext/cargo_builder"
+require_relative "cargo_builder"
 
 # Root module
 module RbSys
-  # Helpers for creating a Ruby compatible makefile for Rust
+  # Helper class for creating Rust Makefiles
   module Mkmf
-    def create_rust_makefile(target, srcprefix = nil)
+    # Helper for building Rust extensions by creating a Ruby compatible makefile
+    # for Rust. By using this class, your rust extension will be 100% compatible
+    # with the rake-compiler gem, which allows for easy cross compilation.
+    #
+    # @example Basic
+    #   require 'mkmf'
+    # . require 'rb_sys/mkmf'
+    #
+    # . create_rust_makefile("my_extension") #=> Generate a Makefile in the current directory
+    #
+    # @example Configure a custom build profile
+    #   require 'mkmf'
+    # . require 'rb_sys/mkmf'
+    #
+    # . create_rust_makefile("my_extension") do |r|
+    # .   # All of these are optional
+    # .   r.env = { 'FOO' => 'bar' }
+    # .   r.profile = ENV.fetch('CARGO_BUILD_PROFILE', :dev).to_sym
+    # .   r.features = %w[some_cargo_feature]
+    # . end
+    def create_rust_makefile(target, srcprefix = nil, &blk)
       if target.include?("/")
         target_prefix, target = File.split(target)
         target_prefix[0, 0] = "/"
@@ -17,14 +37,21 @@ module RbSys
       end
 
       spec = Struct.new(:name, :metadata).new(target, {})
-      builder = Gem::Ext::CargoBuilder.new(spec)
+      builder = CargoBuilder.new(spec)
+
+      yield builder if blk
+
       srcprefix ||= "$(srcdir)/#{srcprefix}".chomp("/")
       RbConfig.expand(srcdir = srcprefix.dup)
 
+      full_cargo_command = cargo_command(srcdir, builder)
+      gsub_cargo_command!(full_cargo_command, builder: builder)
+
       # rubocop:disable Style/GlobalVars
       make_install = <<~MAKE
+        RB_SYS_CARGO_PROFILE ?= #{builder.profile}
+        RB_SYS_CARGO_FEATURES ?= #{builder.features.join(",")}
         target_prefix = #{target_prefix}
-        CARGO_PROFILE = release
         CLEANLIBS = $(RUSTLIB) $(DLLIB)
         DISTCLEANDIRS = target/
         RUBYARCHDIR   = $(sitearchdir)$(target_prefix)
@@ -39,10 +66,10 @@ module RbSys
         FORCE: ;
 
         $(DLLIB): FORCE
-        \t#{cargo_command(srcdir, builder)}
+        \t#{full_cargo_command}
         \t$(COPY) "$(RUSTLIB)" $@
 
-        install: $(DLLIB)
+        install: $(DLLIB) Makefile
         \t$(INSTALL_PROG) $(DLLIB) $(RUBYARCHDIR)
 
         all: #{$extout ? "install" : "$(DLLIB)"}
@@ -70,12 +97,30 @@ module RbSys
     end
 
     def env_vars(builder)
-      builder.build_env.map { |k, v| %($(DLLIB): export #{k} = #{v.gsub("\n", '\n')}) }.join("\n")
+      lines = builder.build_env.map { |k, v| env_line(k, v) }
+      lines << env_line("CC", env_or_makefile_config("CC"))
+      lines << env_line("AR", env_or_makefile_config("AR")) unless env_or_makefile_config("AR") == "libtool -static"
+      lines.compact.join("\n")
+    end
+
+    def env_line(k, v)
+      return unless v
+      %($(DLLIB): export #{k} = #{v.gsub("\n", '\n')})
+    end
+
+    def env_or_makefile_config(key)
+      ENV[key] || RbConfig::MAKEFILE_CONFIG[key]
     end
 
     def dllib_path(builder)
       builder.cargo_dylib_path(File.join(Dir.pwd, "target"))
     end
+
+    def gsub_cargo_command!(cargo_command, builder:)
+      cargo_command.gsub!("--profile #{builder.profile}", "--profile $(RB_SYS_CARGO_PROFILE)")
+      cargo_command.gsub!(%r{--features \S+}, "--features $(RB_SYS_CARGO_FEATURES)")
+      cargo_command
+    end
   end
 end
 

data/lib/rb_sys/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RbSys
-  VERSION = "0.1.2"
+  VERSION = "0.9.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rb_sys
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.9.1
 platform: ruby
 authors:
 - Ian Ker-Seymer
@@ -30,7 +30,7 @@ cert_chain:
   Rl+ASkq2/1i07TkBpCf+2hq66+h/hx+/Y/KrUzXfe0jtvil0WESkJT2kqRqHWNhD
   9GKBxaQlXokNDtWCm1/gl6cD8WRZ0N5S4ZGJT1FLLsA=
   -----END CERTIFICATE-----
-date: 2022-04-26 00:00:00.000000000 Z
+date: 2022-06-01 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -43,11 +43,11 @@ files:
 - LICENSE-MIT
 - certs/ianks.pem
 - lib/rb_sys.rb
+- lib/rb_sys/cargo_builder.rb
+- lib/rb_sys/cargo_builder/link_flag_converter.rb
 - lib/rb_sys/mkmf.rb
 - lib/rb_sys/version.rb
 - sig/rb_sys.rbs
-- vendor/rubygems/ext/cargo_builder.rb
-- vendor/rubygems/ext/cargo_builder/link_flag_converter.rb
 homepage: https://github.com/oxidize-rb/rb-sys
 licenses:
 - MIT

data/LICENSE-APACHE

@@ -1 +0,0 @@
-/Users/ianks/Code/open-source/rb-sys/LICENSE-APACHE

data/LICENSE-MIT

@@ -1 +0,0 @@
-/Users/ianks/Code/open-source/rb-sys/LICENSE-MIT

data/vendor/rubygems/ext/cargo_builder/link_flag_converter.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-class Gem::Ext::CargoBuilder < Gem::Ext::Builder
-  # Converts Ruby link flags into something cargo understands
-  class LinkFlagConverter
-    def self.convert(arg)
-      case arg.chomp
-      when /^-L\s*(.+)$/
-        ["-L", "native=#{$1}"]
-      when /^--library=(\w+\S+)$/, /^-l\s*(\w+\S+)$/
-        ["-l", $1]
-      when /^-l\s*:lib(\S+).a$/
-        ["-l", "static=#{$1}"]
-      when /^-l\s*:lib(\S+).(so|dylib|dll)$/
-        ["-l", "dylib=#{$1}"]
-      when /^-F\s*(.*)$/
-        ["-l", "framework=#{$1}"]
-      else
-        ["-C", "link_arg=#{arg}"]
-      end
-    end
-  end
-end

data/vendor/rubygems/ext/cargo_builder.rb

@@ -1,330 +0,0 @@
-# frozen_string_literal: true
-
-# This class is used by rubygems to build Rust extensions. It is a thin-wrapper
-# over the `cargo rustc` command which takes care of building Rust code in a way
-# that Ruby can use.
-class Gem::Ext::CargoBuilder < Gem::Ext::Builder
-  attr_accessor :spec, :runner, :profile
-
-  def initialize(spec)
-    require "rubygems/command"
-    require_relative "cargo_builder/link_flag_converter"
-
-    @spec = spec
-    @runner = self.class.method(:run)
-    @profile = :release
-  end
-
-  def build(_extension, dest_path, results, args = [], lib_dir = nil, cargo_dir = Dir.pwd)
-    require "fileutils"
-    require "shellwords"
-
-    build_crate(dest_path, results, args, cargo_dir)
-    validate_cargo_build!(dest_path)
-    rename_cdylib_for_ruby_compatibility(dest_path)
-    finalize_directory(dest_path, lib_dir, cargo_dir)
-    results
-  end
-
-  def build_crate(dest_path, results, args, cargo_dir)
-    env = build_env
-    cmd = cargo_command(cargo_dir, dest_path, args)
-    runner.call cmd, results, "cargo", cargo_dir, env
-
-    results
-  end
-
-  def build_env
-    build_env = rb_config_env
-    build_env["RUBY_STATIC"] = "true" if ruby_static? && ENV.key?("RUBY_STATIC")
-    build_env
-  end
-
-  def cargo_command(cargo_dir, dest_path, args = [])
-    manifest = File.join(cargo_dir, "Cargo.toml")
-    cargo = ENV.fetch("CARGO", "cargo")
-
-    cmd = []
-    cmd += [cargo, "rustc"]
-    cmd += ["--target", ENV["CARGO_BUILD_TARGET"]] if ENV["CARGO_BUILD_TARGET"]
-    cmd += ["--target-dir", dest_path]
-    cmd += ["--manifest-path", manifest]
-    cmd += ["--lib"]
-    cmd += ["--profile", profile.to_s]
-    cmd += ["--locked"] if profile == :release
-    cmd += Gem::Command.build_args
-    cmd += args
-    cmd += ["--"]
-    cmd += [*cargo_rustc_args(dest_path)]
-    cmd
-  end
-
-  def cargo_dylib_path(dest_path)
-    prefix = so_ext == "dll" ? "" : "lib"
-    path_parts = [dest_path]
-    path_parts << ENV["CARGO_BUILD_TARGET"] if ENV["CARGO_BUILD_TARGET"]
-    path_parts += [profile_target_directory, "#{prefix}#{cargo_crate_name}.#{so_ext}"]
-    File.join(*path_parts)
-  end
-
-  private
-
-  def rb_config_env
-    result = {}
-    RbConfig::CONFIG.each { |k, v| result["RBCONFIG_#{k}"] = v }
-    result
-  end
-
-  def cargo_rustc_args(dest_dir)
-    [
-      *linker_args,
-      *mkmf_libpath,
-      *rustc_dynamic_linker_flags(dest_dir),
-      *rustc_lib_flags(dest_dir),
-      *platform_specific_rustc_args(dest_dir),
-      *debug_flags
-    ]
-  end
-
-  def platform_specific_rustc_args(dest_dir, flags = [])
-    if mingw_target?
-      # On mingw platforms, mkmf adds libruby to the linker flags
-      flags += libruby_args(dest_dir)
-
-      # Make sure ALSR is used on mingw
-      # see https://github.com/rust-lang/rust/pull/75406/files
-      flags += ["-C", "link-arg=-Wl,--dynamicbase"]
-      flags += ["-C", "link-arg=-Wl,--disable-auto-image-base"]
-
-      # If the gem is installed on a host with build tools installed, but is
-      # run on one that isn't the missing libraries will cause the extension
-      # to fail on start.
-      flags += ["-C", "link-arg=-static-libgcc"]
-    end
-
-    flags
-  end
-
-  # We want to use the same linker that Ruby uses, so that the linker flags from
-  # mkmf work properly.
-  def linker_args
-    # Have to handle CC="cl /nologo" on mswin
-    cc_flag = Shellwords.split(makefile_config("CC"))
-    linker = cc_flag.shift
-    link_args = cc_flag.flat_map { |a| ["-C", "link-arg=#{a}"] }
-
-    ["-C", "linker=#{linker}", *link_args]
-  end
-
-  def libruby_args(dest_dir)
-    libs = makefile_config(ruby_static? ? "LIBRUBYARG_STATIC" : "LIBRUBYARG_SHARED")
-    raw_libs = Shellwords.split(libs)
-    raw_libs.flat_map { |l| ldflag_to_link_modifier(l) }
-  end
-
-  def ruby_static?
-    return true if %w[1 true].include?(ENV["RUBY_STATIC"])
-
-    makefile_config("ENABLE_SHARED") == "no"
-  end
-
-  # Ruby expects the dylib to follow a file name convention for loading
-  def rename_cdylib_for_ruby_compatibility(dest_path)
-    new_path = final_extension_path(dest_path)
-    FileUtils.cp(cargo_dylib_path(dest_path), new_path)
-    new_path
-  end
-
-  def validate_cargo_build!(dir)
-    dylib_path = cargo_dylib_path(dir)
-
-    raise DylibNotFoundError, dir unless File.exist?(dylib_path)
-
-    dylib_path
-  end
-
-  def final_extension_path(dest_path)
-    dylib_path = cargo_dylib_path(dest_path)
-    dlext_name = "#{spec.name}.#{makefile_config("DLEXT")}"
-    dylib_path.gsub(File.basename(dylib_path), dlext_name)
-  end
-
-  def cargo_crate_name
-    spec.metadata.fetch("cargo_crate_name", spec.name).tr("-", "_")
-  end
-
-  def rustc_dynamic_linker_flags(dest_dir)
-    split_flags("DLDFLAGS")
-      .map { |arg| maybe_resolve_ldflag_variable(arg, dest_dir) }
-      .compact
-      .flat_map { |arg| ldflag_to_link_modifier(arg) }
-  end
-
-  def rustc_lib_flags(dest_dir)
-    split_flags("LIBS").flat_map { |arg| ldflag_to_link_modifier(arg) }
-  end
-
-  def split_flags(var)
-    Shellwords.split(RbConfig::CONFIG.fetch(var, ""))
-  end
-
-  def ldflag_to_link_modifier(arg)
-    LinkFlagConverter.convert(arg)
-  end
-
-  def msvc_target?
-    makefile_config("target_os").include?("msvc")
-  end
-
-  def darwin_target?
-    makefile_config("target_os").include?("darwin")
-  end
-
-  def mingw_target?
-    makefile_config("target_os").include?("mingw")
-  end
-
-  def win_target?
-    target_platform = RbConfig::CONFIG["target_os"]
-    !!Gem::WIN_PATTERNS.find { |r| target_platform =~ r }
-  end
-
-  # Interpolate substition vars in the arg (i.e. $(DEFFILE))
-  def maybe_resolve_ldflag_variable(input_arg, dest_dir)
-    var_matches = input_arg.match(/\$\((\w+)\)/)
-
-    return input_arg unless var_matches
-
-    var_name = var_matches[1]
-
-    return input_arg if var_name.nil? || var_name.chomp.empty?
-
-    case var_name
-    # On windows, it is assumed that mkmf has setup an exports file for the
-    # extension, so we have to to create one ourselves.
-    when "DEFFILE"
-      write_deffile(dest_dir)
-    else
-      RbConfig::CONFIG[var_name]
-    end
-  end
-
-  def write_deffile(dest_path)
-    dest_dir = File.dirname(final_extension_path(dest_path))
-    FileUtils.mkdir_p(dest_dir)
-    deffile_path = File.join(dest_dir, "#{spec.name}-#{RbConfig::CONFIG["arch"]}.def")
-    export_prefix = makefile_config("EXPORT_PREFIX") || ""
-
-    File.open(deffile_path, "w") do |f|
-      f.puts "EXPORTS"
-      f.puts "#{export_prefix.strip}Init_#{spec.name}"
-    end
-
-    deffile_path
-  end
-
-  # We have to basically reimplement RbConfig::CONFIG['SOEXT'] here to support
-  # Ruby < 2.5
-  #
-  # @see https://github.com/ruby/ruby/blob/c87c027f18c005460746a74c07cd80ee355b16e4/configure.ac#L3185
-  def so_ext
-    return RbConfig::CONFIG["SOEXT"] if RbConfig::CONFIG.key?("SOEXT")
-
-    if win_target?
-      "dll"
-    elsif darwin_target?
-      "dylib"
-    else
-      "so"
-    end
-  end
-
-  # Corresponds to $(LIBPATH) in mkmf
-  def mkmf_libpath
-    ["-L", "native=#{makefile_config("libdir")}"]
-  end
-
-  def makefile_config(var_name)
-    val = RbConfig::MAKEFILE_CONFIG[var_name]
-
-    return unless val
-
-    RbConfig.expand(val.dup)
-  end
-
-  # Good balance between binary size and debugability
-  def debug_flags
-    return [] if profile == :dev
-
-    ["-C", "debuginfo=1"]
-  end
-
-  # Copied from ExtConfBuilder
-  def finalize_directory(dest_path, lib_dir, extension_dir)
-    require "fileutils"
-    require "tempfile"
-
-    ext_path = final_extension_path(dest_path)
-
-    begin
-      tmp_dest = Dir.mktmpdir(".gem.", extension_dir)
-
-      # Some versions of `mktmpdir` return absolute paths, which will break make
-      # if the paths contain spaces. However, on Ruby 1.9.x on Windows, relative
-      # paths cause all C extension builds to fail.
-      #
-      # As such, we convert to a relative path unless we are using Ruby 1.9.x on
-      # Windows. This means that when using Ruby 1.9.x on Windows, paths with
-      # spaces do not work.
-      #
-      # Details: https://github.com/rubygems/rubygems/issues/977#issuecomment-171544940
-      tmp_dest_relative = get_relative_path(tmp_dest.clone, extension_dir)
-
-      if tmp_dest_relative
-        full_tmp_dest = File.join(extension_dir, tmp_dest_relative)
-
-        # TODO: remove in RubyGems 3
-        if Gem.install_extension_in_lib && lib_dir
-          FileUtils.mkdir_p lib_dir
-          FileUtils.cp_r ext_path, lib_dir, remove_destination: true
-        end
-
-        FileUtils::Entry_.new(full_tmp_dest).traverse do |ent|
-          destent = ent.class.new(dest_path, ent.rel)
-          destent.exist? || FileUtils.mv(ent.path, destent.path)
-        end
-      end
-    ensure
-      FileUtils.rm_rf tmp_dest if tmp_dest
-    end
-  end
-
-  def get_relative_path(path, base)
-    path[0..base.length - 1] = "." if path.start_with?(base)
-    path
-  end
-
-  def profile_target_directory
-    case profile
-    when :release then "release"
-    when :dev then "debug"
-    else raise "unknown target directory for profile: #{profile}"
-    end
-  end
-
-  # Error raised when no cdylib artifact was created
-  class DylibNotFoundError < StandardError
-    def initialize(dir)
-      files = Dir.glob(File.join(dir, "**", "*")).map { |f| "- #{f}" }.join "\n"
-
-      super <<~MSG
-        Dynamic library not found for Rust extension (in #{dir})
-
-        Make sure you set "crate-type" in Cargo.toml to "cdylib"
-
-        Found files:
-        #{files}
-      MSG
-    end
-  end
-end