rcee_precompiled 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 057d5aabd8a8648f1381e6d95d8d7312adc7e325a53e91910debbfd2664d0e20
-  data.tar.gz: 772f3c5ad74b9365076024189e352793f493e101834e8517d5ff60ac4065d32d
+  metadata.gz: 1433303a861ccdca59314c39762f30c11817241057c5deceb1fd90a192119c2f
+  data.tar.gz: aa0690709c7d77f1517714e323d1cbd627febebbb29952b1c9e1ecf3e8e3bfd5
 SHA512:
-  metadata.gz: e490327174f9ad601bf9e150bcdf448a5be74059bee3e728c86524359c3b3efffa876bcb441f089faaae779321559d6ead84451ece12f03f42bdae4e57172cd6
-  data.tar.gz: f53d5117f4b0d9e9b1ab8f577aeb0d35aad7743fbd027ed24e8a75c4e5c47a8b3d05f4dfaecbf859745b8d432960a4fe97771cddcb7a638fdcf8d892df551d6c
+  metadata.gz: 62422e6214c2d6f7c025a7474a46a8fe42d3244125f23b9e1b44c7a4546540860ea0e7a58892dd97627f9854882f87da8e384f540be269966d2676541c170215
+  data.tar.gz: 1ea4fe394233270e1f362b9849189e400726379448472275ce547614d4db5c76e0532ea0e00d807dd50012319623342ce97ae69408237c8690746eae2b3f9301

data/README.md

@@ -93,7 +93,7 @@ This makes sure that the cross-compiler is the compiler used within the guest co
 cross_build_p = enable_config("cross-build")
 ```
 
-We don't need this for `libyaml`, but the technique is useful: the cross-compile rake task signals to `extconf.rb` that it's cross-compiling by using a commandline flag that we can inspect. As an example, `extconf.rb` may need to set specific configuration options on the third-party library when cross-compiling.
+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|
@@ -150,6 +150,24 @@ 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.
 
 
+## Testing
+
+See [.github/workflows/precompiled.yml](../.github/workflows/precompiled.yml)
+
+Key things to note:
+
+- matrix across all supported Rubies and platforms (for compile-from-source installation testing)
+- test native gems for a variety of platforms
+  - use rake-compiler-dock images to build the gems
+  - then install on native platforms and verify that it passes tests
+
+Note that there's additional complexity because of how we test:
+
+- see new script bin/test-gem-build which artificially bumps the VERSION string to double-check we're testing the packaged version of the gem (which the tests output)
+- see new script bin/test-gem-install which installs the gem, deletes the local source code, and runs the tests against the installed gem
+- the gemspec handles a missing version file (because we delete the local source code during testing)
+
+
 ## What Can Go Wrong
 
 This strategy isn't perfect. Remember what I said earlier, that a compiled C extension is specific to
@@ -158,8 +176,8 @@ 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.
+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.
 
-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.
+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.)
 
 So the lesson here is: make sure you have an automated test pipeline that will build a gem and test it on the target platform! This takes time to set up, but it will save you time and effort in the long run.

data/Rakefile

@@ -57,6 +57,29 @@ namespace "gem" do
   multitask "all" => [cross_platforms, "gem"].flatten
 end
 
+desc "Temporarily set VERSION to a unique timestamp"
+task "set-version-to-timestamp" do
+  # this task is used by bin/test-gem-build
+  # to test building, packaging, and installing a precompiled gem
+  version_constant_re = /^\s*VERSION\s*=\s*["'](.*)["']$/
+
+  version_file_path = File.join(__dir__, "lib/rcee/precompiled/version.rb")
+  version_file_contents = File.read(version_file_path)
+
+  current_version_string = version_constant_re.match(version_file_contents)[1]
+  current_version = Gem::Version.new(current_version_string)
+
+  fake_version = Gem::Version.new(format("%s.test.%s", current_version.bump, Time.now.strftime("%Y.%m%d.%H%M")))
+
+  unless version_file_contents.gsub!(version_constant_re, "    VERSION = \"#{fake_version}\"")
+    raise("Could not hack the VERSION constant")
+  end
+
+  File.open(version_file_path, "w") { |f| f.write(version_file_contents) }
+
+  puts "NOTE: wrote version as \"#{fake_version}\""
+end
+
 task default: [:clobber, :compile, :test]
 
 CLEAN.add("{ext,lib}/**/*.{o,so}", "pkg")

data/ext/precompiled/extconf.rb

@@ -6,7 +6,6 @@ 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"]
 
-# not needed for libyaml, but generally useful to know whether we're cross-compiling
 cross_build_p = enable_config("cross-build")
 
 MiniPortile.new("yaml", "0.2.5").tap do |recipe|
@@ -17,12 +16,14 @@ MiniPortile.new("yaml", "0.2.5").tap do |recipe|
   recipe.target = File.join(package_root_dir, "ports")
 
   # 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}" }
+  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
+
+      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))

data/lib/rcee/precompiled/version.rb

@@ -2,6 +2,6 @@
 
 module RCEE
   module Precompiled
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

data/rcee_precompiled.gemspec

@@ -1,10 +1,14 @@
 # frozen_string_literal: true
 
-require_relative "lib/rcee/precompiled/version"
+begin
+  require_relative "lib/rcee/precompiled/version"
+rescue LoadError
+  puts "WARNING: Could not load RCEE::Precompiled::VERSION"
+end
 
 Gem::Specification.new do |spec|
   spec.name          = "rcee_precompiled"
-  spec.version       = RCEE::Precompiled::VERSION
+  spec.version       = defined?(RCEE::Precompiled::VERSION) ? RCEE::Precompiled::VERSION : "0.0.0"
   spec.authors       = ["Mike Dalessio"]
   spec.email         = ["mike.dalessio@gmail.com"]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rcee_precompiled
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Mike Dalessio
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-10 00:00:00.000000000 Z
+date: 2021-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mini_portile2