rcee_precompiled 0.4.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75e95371c9254f1e4e13c647e6d9bd9a7bf58969568ca3d0423b32dd2509ddb8
-  data.tar.gz: d1d43c4c1ef4cd9b1b823cc46cc760b8b882d944cbc5cbb8d646533d8405a74a
+  metadata.gz: 6c583c2991831575bd4b095940cab064079fd65c438c5e3a165e96a5d8ac7c90
+  data.tar.gz: 1ce001df04c891b01bbf8d16914d2535548b557f10eda7f65409e0aae0550c08
 SHA512:
-  metadata.gz: fd010aa61f60be476bab9b8ad1b0e5bf1f2d13f9fd5a4fee50906451f235e2ca015d08e40160b24d5221bd2bf4052b935a58bb1e8619eb1ba3baa5274821dafb
-  data.tar.gz: bdbb4d096318095eaadaf013e0e00b3f7fd3c7100cdec8a25c7d6e26e2ee3341964de504d2fb47563a5cf63cfb50a3fe708bdf8017c3f1658ad4ee31b5d18cd5
+  metadata.gz: 5c2bce5e9222da79298c9f62a2080b3cdd96fa73dc79dc937385d9ca68531734e946edd9e94c199bef24da4e70dd319d18ab360b4b871f33277aca93347b7d6b
+  data.tar.gz: 7133eb473bd9f35f52335b4429291497ecda8c62e217d58a60d78d3a1dfa34bfd2e7dbdfe7d098aab497243c7ae81abc0695ceb77584c411cc1620fb9fc957e4

data/Gemfile

@@ -8,6 +8,6 @@ gemspec
 gem "rake", "~> 13.0"
 
 gem "rake-compiler"
-gem "rake-compiler-dock", "~> 1.2.1"
+gem "rake-compiler-dock", "1.5.0.rc1"
 
 gem "minitest", "~> 5.0"

data/README.md

@@ -26,15 +26,20 @@ This is really powerful stuff, and once we assume that we can cross-compile reli
 First, we need to add some features to our `Rake::ExtensionTask` in `Rakefile`:
 
 ``` ruby
-cross_rubies = ["3.1.0", "3.0.0", "2.7.0", "2.6.0"]
+cross_rubies = ["3.3.0", "3.2.0", "3.1.0", "3.0.0"]
 cross_platforms = [
-  "x64-mingw32",
+  "aarch64-linux-gnu",
+  "aarch64-linux-musl",
+  "arm-linux-gnu",
+  "arm-linux-musl",
+  "arm64-darwin",
   "x64-mingw-ucrt",
-  "x86-linux",
-  "x86_64-linux",
-  "aarch64-linux",
+  "x64-mingw32",
+  "x86-linux-gnu",
+  "x86-linux-musl",
   "x86_64-darwin",
-  "arm64-darwin",
+  "x86_64-linux-gnu",
+  "x86_64-linux-musl",
 ]
 ENV["RUBY_CC_VERSION"] = cross_rubies.join(":")
 
@@ -92,30 +97,33 @@ The top task (or, really, _set_ of tasks) runs on the host system, and invokes t
 Changes to the `extconf.rb`:
 
 ``` ruby
-ENV["CC"] = RbConfig::CONFIG["CC"]
+def configure_cross_compilers
+  RbConfig::CONFIG["CC"] = RbConfig::MAKEFILE_CONFIG["CC"] = ENV["CC"] if ENV["CC"]
+  ENV["CC"] = RbConfig::CONFIG["CC"]
+end
 ```
 
 This makes sure that the cross-compiler is the compiler used within the guest container (and not the native linux compiler).
 
 ``` ruby
-cross_build_p = enable_config("cross-build")
+def cross_build?
+  enable_config("cross-build")
+end
 ```
 
 The cross-compile rake task signals to `extconf.rb` that it's cross-compiling by using a commandline flag that we can inspect. We'll need this for `libyaml` to make sure that set the appropriate flags during precompilation (flags which shouldn't be set when compiling natively).
 
 ``` ruby
-MiniPortile.new("yaml", "0.2.5").tap do |recipe|
-  # ...
-  # configure the environment that MiniPortile will use for subshells
-  ENV.to_h.dup.tap do |env|
-    # -fPIC is necessary for linking into a shared library
-    env["CFLAGS"] = [env["CFLAGS"], "-fPIC"].join(" ")
-    env["SUBDIRS"] = "include src" # libyaml: skip tests
-
-    recipe.configure_options += env.map { |key, value| "#{key}=#{value.strip}" }
+  # pass some environment variables to the libyaml configuration for cross-compilation
+  if cross_build?
+    ENV.to_h.tap do |env|
+      # -fPIC is necessary for linking into a shared library
+      env["CFLAGS"] = [env["CFLAGS"], "-fPIC"].join(" ")
+      env["SUBDIRS"] = "include src" # libyaml: skip tests
+
+      recipe.configure_options += env.map { |key, value| "#{key}=#{value.strip}" }
+    end
   end
-  # ...
-end
 ```
 
 The rest of the extconf changes are related to configuring libyaml at build time. We need to set the -fPIC option so we can mix static and shared libraries together. (This should probably always be set.)
@@ -128,14 +136,14 @@ We have one more small change we'll need to make to how the extension is require
 lib
 └── rcee
     ├── precompiled
-    │   ├── 2.6
-    │   │   └── precompiled.so
-    │   ├── 2.7
-    │   │   └── precompiled.so
     │   ├── 3.0
     │   │   └── precompiled.so
     │   ├── 3.1
     │   │   └── precompiled.so
+    │   ├── 3.2
+    │   │   └── precompiled.so
+    │   ├── 3.3
+    │   │   └── precompiled.so
     │   └── version.rb
     └── precompiled.rb
 ```
@@ -158,6 +166,22 @@ end
 Go ahead and try it! `gem install rcee_precompiled`. If you're on windows, linux, or macos you should get a precompiled version that installs in under a second. Everyone else (hello FreeBSD people!) it'll take a few more seconds to build the vanilla gem's packaged tarball.
 
 
+### Windows notes
+
+You may have noticed that the gem for `x64-mingw32` only contains `.../3.0/precompiled.so` and not a shared library for 3.1, 3.2, or 3.3. Conversely, the gem for `x64-mingw-ucrt` does *not* contain 3.0 (but contains 3.1..3.3 inclusive).
+
+This is because the Windows installer for Ruby switched from `msvcrt` to `ucrt` for the C standard library. Rubies 3.0 and earlier use `msvcrt` but later Rubies use `ucrt`. So if you're on Ruby 3.0 on Windows, bundler will resolve your platform as `x64-mingw32`; but if you're on Ruby 3.1 or later, bundler will resolve your platform as `x64-mingw-ucrt`. See [the rubyinstaller release notes](https://rubyinstaller.org/2021/12/31/rubyinstaller-3.1.0-1-released.html) for more information.
+
+This is all taken care of for you by `rake-compiler-dock` and there's no additional work necessary to create those specialized native gems. However, you'll see this libc transition in the CI testing matrix in `.github/workflows/precompiled.yml`.
+
+
+### Linux notes
+
+On Linux, the default C library for a long time was GNU libc, and so when you see native gem platforms like `x86_64-linux` the _implied_ libc is `gnu`. However, in recent years the `musl` libc project has gotten off the ground in distributions like Alpine. Often, `musl` systems are able to run code compiled on (and for) `gnu` systems; but not always. And in those incompatible cases, users had to work around it or avoid Alpine.
+
+As of Rubygems 3.3.22, the `gem` and `bundle` tools are able to distinguish platforms by their libc type (e.g., `x86_64-linux-gnu` versus `x86_64-linux-musl`); and `rake-compiler-dock` started to be able to build `musl` native gems as of v1.5.0.
+
+
 ## Testing
 
 See [.github/workflows/precompiled.yml](../.github/workflows/precompiled.yml)

data/Rakefile

@@ -6,22 +6,26 @@ require "rake/testtask"
 require "rake/extensiontask"
 require "rake_compiler_dock"
 
-cross_rubies = ["3.1.0", "3.0.0", "2.7.0", "2.6.0"]
+cross_rubies = ["3.3.0", "3.2.0", "3.1.0", "3.0.0"]
 cross_platforms = [
-  "aarch64-linux",
-  "arm-linux",
+  "aarch64-linux-gnu",
+  "aarch64-linux-musl",
+  "arm-linux-gnu",
+  "arm-linux-musl",
   "arm64-darwin",
   "x64-mingw-ucrt",
   "x64-mingw32",
-  "x86-linux",
+  "x86-linux-gnu",
+  "x86-linux-musl",
   "x86_64-darwin",
-  "x86_64-linux",
+  "x86_64-linux-gnu",
+  "x86_64-linux-musl",
 ]
 ENV["RUBY_CC_VERSION"] = cross_rubies.join(":")
 
 rcee_precompiled_spec = Bundler.load_gemspec("rcee_precompiled.gemspec")
 Gem::PackageTask.new(rcee_precompiled_spec).define #packaged_tarball version of the gem for platform=ruby
-task "package" => cross_platforms.map { |p| "gem:#{p}" } # "package" task for all the native platforms
+task "package" => "gem:all"
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
@@ -38,6 +42,11 @@ Rake::ExtensionTask.new("precompiled", rcee_precompiled_spec) do |ext|
     # remove things not needed for precompiled gems
     spec.dependencies.reject! { |dep| dep.name == "mini_portile2" }
     spec.files.reject! { |file| File.fnmatch?("*.tar.gz", file) }
+
+    if spec.platform.os == "linux"
+      # the `-gnu` suffix is not recognized in earlier versions of rubygems
+      spec.required_rubygems_version.concat([">= 3.3.22"])
+    end
   end
 end
 

data/ext/precompiled/extconf.rb

@@ -1,41 +1,78 @@
 require "mkmf"
 require "mini_portile2"
 
-package_root_dir = File.expand_path(File.join(File.dirname(__FILE__), "..", ".."))
+module RCEE
+  module Precompiled
+    module ExtConf
+      PACKAGE_ROOT_DIR = File.expand_path(File.join(File.dirname(__FILE__), "..", ".."))
 
-RbConfig::CONFIG["CC"] = RbConfig::MAKEFILE_CONFIG["CC"] = ENV["CC"] if ENV["CC"]
-ENV["CC"] = RbConfig::CONFIG["CC"]
+      class << self
+        def configure
+          configure_cross_compilers
+          configure_packaged_libraries
+          create_makefile("rcee/precompiled/precompiled")
+        end
 
-cross_build_p = enable_config("cross-build")
+        def configure_cross_compilers
+          RbConfig::CONFIG["CC"] = RbConfig::MAKEFILE_CONFIG["CC"] = ENV["CC"] if ENV["CC"]
+          ENV["CC"] = RbConfig::CONFIG["CC"]
+        end
 
-MiniPortile.new("yaml", "0.2.5").tap do |recipe|
-  recipe.files = [{
-    url: "https://github.com/yaml/libyaml/releases/download/0.2.5/yaml-0.2.5.tar.gz",
-    sha256: "c642ae9b75fee120b2d96c712538bd2cf283228d2337df2cf2988e3c02678ef4",
-  }]
-  recipe.target = File.join(package_root_dir, "ports")
+        def configure_packaged_libraries
+          recipe = libyaml_recipe
 
-  # configure the environment that MiniPortile will use for subshells
-  if cross_build_p
-    ENV.to_h.tap do |env|
-      # -fPIC is necessary for linking into a shared library
-      env["CFLAGS"] = [env["CFLAGS"], "-fPIC"].join(" ")
-      env["SUBDIRS"] = "include src" # libyaml: skip tests
+          # pass some environment variables to the libyaml configuration for cross-compilation
+          if cross_build?
+            ENV.to_h.tap do |env|
+              # -fPIC is necessary for linking into a shared library
+              env["CFLAGS"] = [env["CFLAGS"], "-fPIC"].join(" ")
+              env["SUBDIRS"] = "include src" # libyaml: skip tests
 
-      recipe.configure_options += env.map { |key, value| "#{key}=#{value.strip}" }
-    end
-  end
+              recipe.configure_options += env.map { |key, value| "#{key}=#{value.strip}" }
+            end
+          end
 
-  unless File.exist?(File.join(recipe.target, recipe.host, recipe.name, recipe.version))
-    recipe.cook
-  end
+          # ensure libyaml has already been unpacked, configured, and compiled
+          unless File.exist?(File.join(recipe.target, recipe.host, recipe.name, recipe.version))
+            recipe.cook
+          end
+
+          # use the packaged libyaml
+          recipe.activate
+          pkg_config(File.join(recipe.path, "lib", "pkgconfig", "yaml-0.1.pc"))
+
+          # assert that we can build against the packaged libyaml
+          unless have_library("yaml", "yaml_get_version", "yaml.h")
+            abort("\nERROR: *** could not find libyaml development environment ***\n\n")
+          end
+        end
 
-  recipe.activate
-  pkg_config(File.join(recipe.path, "lib", "pkgconfig", "yaml-0.1.pc"))
+        def cross_build?
+          enable_config("cross-build")
+        end
+
+        def download
+          libyaml_recipe.download
+        end
+
+        def libyaml_recipe
+          MiniPortile.new("yaml", "0.2.5").tap do |recipe|
+            recipe.files = [{
+              url: "https://github.com/yaml/libyaml/releases/download/0.2.5/yaml-0.2.5.tar.gz",
+              sha256: "c642ae9b75fee120b2d96c712538bd2cf283228d2337df2cf2988e3c02678ef4"
+            }]
+            recipe.target = File.join(PACKAGE_ROOT_DIR, "ports")
+          end
+        end
+      end
+    end
+  end
 end
 
-unless have_library("yaml", "yaml_get_version", "yaml.h")
-  abort("\nERROR: *** could not find libyaml development environment ***\n\n")
+# run "ruby ./ext/precompiled/extconf.rb -- --download-dependencies" to download the tarball
+if arg_config("--download-dependencies")
+  RCEE::Precompiled::ExtConf.download
+  exit!(0)
 end
 
-create_makefile("rcee/precompiled/precompiled")
+RCEE::Precompiled::ExtConf.configure

data/lib/rcee/precompiled/version.rb

@@ -2,6 +2,6 @@
 
 module RCEE
   module Precompiled
-    VERSION = "0.4.0"
+    VERSION = "0.5.1"
   end
 end

data/rcee_precompiled.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
   spec.summary       = "Example gem demonstrating a basic C extension."
   spec.description   = "Part of a project to explain how Ruby C extensions work."
   spec.homepage      = "https://github.com/flavorjones/ruby-c-extensions-explained"
-  spec.required_ruby_version = ">= 2.6.0"
+  spec.required_ruby_version = ">= 3.0.0"
   spec.license = "MIT"
 
   # Specify which files should be added to the gem when it is released.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rcee_precompiled
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Mike Dalessio
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-05-19 00:00:00.000000000 Z
+date: 2024-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mini_portile2
@@ -24,6 +24,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+  force_ruby_platform: false
 description: Part of a project to explain how Ruby C extensions work.
 email:
 - mike.dalessio@gmail.com
@@ -55,14 +56,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.5
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: Example gem demonstrating a basic C extension.