rcee_precompiled 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1433303a861ccdca59314c39762f30c11817241057c5deceb1fd90a192119c2f
-  data.tar.gz: aa0690709c7d77f1517714e323d1cbd627febebbb29952b1c9e1ecf3e8e3bfd5
+  metadata.gz: 80a6876c836d53fcde0cdcc9b6b948419be41fcc942f8add855984fdcabe99aa
+  data.tar.gz: 52b74c8bb35c6dfd33fa1f7fbb30aa1f7e43b7b8fda8ebcd4c885837413ba5bc
 SHA512:
-  metadata.gz: 62422e6214c2d6f7c025a7474a46a8fe42d3244125f23b9e1b44c7a4546540860ea0e7a58892dd97627f9854882f87da8e384f540be269966d2676541c170215
-  data.tar.gz: 1ea4fe394233270e1f362b9849189e400726379448472275ce547614d4db5c76e0532ea0e00d807dd50012319623342ce97ae69408237c8690746eae2b3f9301
+  metadata.gz: c8864cdae0e60f649af23b3cd5b31ca7675ee8b3ab5c73edb783351d2ba09bc33d61145c86fae21b98da8ebdaad0b4e4327d717ef6665b6c87952cab4ec77d31
+  data.tar.gz: 47f13c358c3b04d3b47d86424e5f21b945feedbce55c9063f5521b1b10c8fc166b2763d071156391a5eae56657e5519d92b320e53d3d5cb29d9add1d15989806

data/Gemfile

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

data/README.md

@@ -26,8 +26,16 @@ 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.0.0", "2.7.0", "2.6.0", "2.5.0"]
-cross_platforms = ["x64-mingw32", "x86_64-linux", "x86_64-darwin", "arm64-darwin"]
+cross_rubies = ["3.3.0", "3.2.0", "3.1.0", "3.0.0"]
+cross_platforms = [
+  "x64-mingw32",
+  "x64-mingw-ucrt",
+  "x86-linux",
+  "x86_64-linux",
+  "aarch64-linux",
+  "x86_64-darwin",
+  "arm64-darwin",
+]
 ENV["RUBY_CC_VERSION"] = cross_rubies.join(":")
 
 Rake::ExtensionTask.new("precompiled", rcee_precompiled_spec) do |ext|
@@ -84,30 +92,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.)
@@ -120,13 +131,13 @@ We have one more small change we'll need to make to how the extension is require
 lib
 └── rcee
     ├── precompiled
-    │   ├── 2.5
+    │   ├── 3.0
     │   │   └── precompiled.so
-    │   ├── 2.6
+    │   ├── 3.1
     │   │   └── precompiled.so
-    │   ├── 2.7
+    │   ├── 3.2
     │   │   └── precompiled.so
-    │   ├── 3.0
+    │   ├── 3.3
     │   │   └── precompiled.so
     │   └── version.rb
     └── precompiled.rb
@@ -176,7 +187,7 @@ This strategy isn't perfect. Remember what I said earlier, that a compiled C ext
 - the machine architecture (e.g., x86_64)
 - the system libraries
 
-The precompiled strategy mostly takes care of the first two, but there are still edge cases for system libraries. The big gotcha is that linux libc is not the same as linux musl, and we've had to work around this a few times in Nokogiri. Note also that we're unable to easily test `musl` systems on Github Actions because of limitations in the `download-artifact` action.
+The precompiled strategy mostly takes care of the first two, but there are still edge cases for system libraries. The big gotcha is that linux libc is not the same as linux musl, and we've had to work around this a few times in Nokogiri.
 
 I'm positive that there are more edge cases that will be found as users add more platforms and as more gems start precompiling. I'm willing to bet money that you can break this by setting some Ruby compile-time flags on your system. I'm honestly surprised it works as well as it has. (Worth noting: the `sassc` gem stopped shipping native gems for linux because of the musl incompatibilities.)
 

data/Rakefile

@@ -6,13 +6,26 @@ require "rake/testtask"
 require "rake/extensiontask"
 require "rake_compiler_dock"
 
-cross_rubies = ["3.0.0", "2.7.0", "2.6.0", "2.5.0"]
-cross_platforms = ["x64-mingw32", "x86_64-linux", "x86_64-darwin", "arm64-darwin"]
+cross_rubies = ["3.3.0", "3.2.0", "3.1.0", "3.0.0"]
+cross_platforms = [
+  "aarch64-linux",
+  "aarch64-linux-musl",
+  "arm-linux",
+  "arm-linux-musl",
+  "arm64-darwin",
+  "x64-mingw-ucrt",
+  "x64-mingw32",
+  "x86-linux",
+  "x86-linux-musl",
+  "x86_64-darwin",
+  "x86_64-linux",
+  "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"

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.3.0"
+    VERSION = "0.5.0"
   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.5.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.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Mike Dalessio
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-08 00:00:00.000000000 Z
+date: 2024-01-27 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.5.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: Example gem demonstrating a basic C extension.