rake-compiler-dock 1.8.0 → 1.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8defac75bbfdcb50e87c34ae26c04eeac94d56144481a01ea096cffe70f33ac
-  data.tar.gz: 5fe13b2f51bea09bb8ed3f02c170ccf2984aa6fcd74bed05b74643d658a0d615
+  metadata.gz: 17f3ab24c0e7f48cc7eba4fbfce3af5d2e178643a6d0d5663b92a635ec9c48ae
+  data.tar.gz: 25c51dc1ebf4872403b8e9a2233dea9d4e47edb44506a7a65b2088657625de47
 SHA512:
-  metadata.gz: 94bb24cf349bc6099fc6dd07ffe860588a782ef0408af57c59001a4100a5be568489e7d8610a840949590086289a474c123be34da1193633c7ba6aaff733c2fb
-  data.tar.gz: 2123aa6ccb22c06ee123e58eb34e306a0f8e5b69e57fd6124b1bfe7cdd42a5f2a83a0b7c6ce63015e7c02f706f011bd46a1b0e56b823d86997a702fa7ab57525
+  metadata.gz: f2a8bc6953b45749a195aa0e742f3d84c18705d286b364acc2b0c9533f30f762e34b5ed09ffed3261749d3ff90654d858592f405bb68c17babc001246b65ef0b
+  data.tar.gz: 0c4e8fe5ba886f41b824637f018bac313d0fe4d8f4440a7789e90d706b4a9f96c54b0b06e2486a75bd94d54bd1172c43882b1e1060e09b5d1f086952e32ddd92

data/Dockerfile.mri.erb

@@ -74,30 +74,30 @@ ENV BASH_ENV=/etc/rubybashrc
 ##
 USER rubyuser
 
-ENV RBENV_RUBIES="2.5.9 3.1.6"
+ENV RBENV_RUBIES="2.5.9 3.1.6 3.4.1"
 
 # Install the bootstrap rubies
 RUN bash -c " \
-      echo 'gem: --no-ri --no-rdoc --no-document' >> ~/.gemrc && \
-      export CFLAGS='-s -O3 -fno-fast-math -fPIC' && \
-      for v in ${RBENV_RUBIES} ; do \
-        rbenv install \$v -- --disable-install-doc ; \
-      done && \
-      find ${RBENV_ROOT} -type d -print0 | sudo xargs -0 chmod g+w \
-    "
+  echo 'gem: --no-ri --no-rdoc --no-document' >> ~/.gemrc && \
+  export CFLAGS='-s -O3 -fno-fast-math -fPIC' && \
+  for v in ${RBENV_RUBIES} ; do \
+    rbenv install \$v -- --disable-install-doc ; \
+  done && \
+  find ${RBENV_ROOT} -type d -print0 | sudo xargs -0 chmod g+w \
+"
 
 # Install rake-compiler and patch it to build and install static libraries for Linux rubies
 COPY build/patches /home/rubyuser/patches
 RUN bash -c " \
-      for v in ${RBENV_RUBIES} ; do \
-        rbenv shell \$v && \
-        gem install rake-compiler -v1.2.9 && \
-        cd ${RBENV_ROOT}/versions/\$v/lib/ruby/gems/*/gems/rake-compiler-1.2.9 && \
-        for patch in /home/rubyuser/patches/rake-compiler-1.2.9/*.patch ; do \
-          patch -p1 < \$patch ; \
-        done \
-      done \
-    "
+  for v in ${RBENV_RUBIES} ; do \
+    rbenv shell \$v && \
+    gem install rake-compiler -v1.2.9 && \
+    cd ${RBENV_ROOT}/versions/\$v/lib/ruby/gems/*/gems/rake-compiler-1.2.9 && \
+    for patch in /home/rubyuser/patches/rake-compiler-1.2.9/*.patch ; do \
+      patch -p1 < \$patch ; \
+    done \
+  done \
+"
 
 # Install rake-compiler's cross rubies in global dir instead of /root
 RUN sudo mkdir -p /usr/local/rake-compiler && \
@@ -115,7 +115,7 @@ RUN sudo mkdir -p /usr/local/rake-compiler && \
 xrubies_build_plan = if platform =~ /x64-mingw-ucrt/
   [
     # Rubyinstaller-3.1+ is platform x64-mingw-ucrt
-    ["3.4.1:3.3.5:3.2.6:3.1.6", "3.1.6"],
+    ["3.4.1:3.3.7:3.2.6:3.1.6", "3.4.1"],
   ]
 elsif platform =~ /x64-mingw32/
   [
@@ -126,7 +126,8 @@ elsif platform =~ /x64-mingw32/
 else
   [
     ["2.6.10:2.5.9:2.4.10", "2.5.9"],
-    ["3.4.1:3.3.5:3.2.6:3.1.6:3.0.7:2.7.8", "3.1.6"],
+    ["2.7.8", "3.1.6"],
+    ["3.4.1:3.3.7:3.2.6:3.1.6:3.0.7", "3.4.1"],
   ]
 end
 
@@ -134,16 +135,16 @@ strip = '-s' if platform !~ /darwin/
 
 xrubies_build_plan.each do |xrubies, bootstrap_ruby_version| %>
 RUN bash -c " \
-      rbenv shell <%= bootstrap_ruby_version %> && \
-      export CPPFLAGS='<%= "-D__USE_MINGW_ANSI_STDIO=1" if platform =~ /x64-mingw-ucrt/ %>' && \
-      export CFLAGS='-O1 -fno-omit-frame-pointer -fno-fast-math -fstack-protector-strong <%= strip %>' && \
-      export LDFLAGS='-pipe <%= strip %>' && \
-      <%= "export LIBS='-l:libssp.a' &&" if platform =~ /mingw/ %> \
-      <%= "export CC=#{target}-clang &&" if platform =~ /darwin/ %> \
-      export MAKE='make V=1' && \
-      rake-compiler cross-ruby VERSION=<%= xrubies %> HOST=<%= target %> && \
-      rm -rf ~/.rake-compiler/builds ~/.rake-compiler/sources \
-    "
+  rbenv shell <%= bootstrap_ruby_version %> && \
+  export CPPFLAGS='<%= "-D__USE_MINGW_ANSI_STDIO=1" if platform =~ /x64-mingw-ucrt/ %>' && \
+  export CFLAGS='-O1 -fno-omit-frame-pointer -fno-fast-math -fstack-protector-strong <%= strip %>' && \
+  export LDFLAGS='-pipe <%= strip %>' && \
+  <%= "export LIBS='-l:libssp.a' &&" if platform =~ /mingw/ %> \
+  <%= "export CC=#{target}-clang &&" if platform =~ /darwin/ %> \
+  export MAKE='make V=1' && \
+  rake-compiler cross-ruby VERSION=<%= xrubies %> HOST=<%= target %> && \
+  rm -rf ~/.rake-compiler/builds ~/.rake-compiler/sources \
+"
 <% end %>
 # "
 
@@ -223,8 +224,8 @@ RUN echo 'source /etc/profile.d/rcd-env.sh' >> /etc/rubybashrc
 # Install sudoers configuration
 COPY build/sudoers /etc/sudoers.d/rake-compiler-dock
 
-RUN bash -c "rbenv global 3.1.6"
+RUN bash -c "rbenv global 3.4.1"
 
-ENV RUBY_CC_VERSION=3.4.1:3.3.5:3.2.6:3.1.6:3.0.7:2.7.8:2.6.10:2.5.9:2.4.10
+ENV RUBY_CC_VERSION=3.4.1:3.3.7:3.2.6:3.1.6:3.0.7:2.7.8:2.6.10:2.5.9:2.4.10
 
 CMD bash

data/History.md

@@ -1,5 +1,26 @@
 # `rake-compiler/rake-compiler-dock` Changelog
 
+## v1.9.1 / 2025-01-20
+
+### Features
+
+- Introduce `RakeCompilerDock.set_ruby_cc_version` to make it easier to set `RUBY_CC_VERSION` without hardcoding specific patch-level ruby versions. See the README for more deteails. #149, #150 @flavorjones
+
+
+## v1.9.0 / 2025-01-19
+
+### Changes
+
+- Bump Ruby 3.3 to v3.3.7 (from v3.3.5). #147 @flavorjones
+- The default `rbenv` ruby in the container is now Ruby v3.4.1 (previously the default was 3.1.6), which allows gems to drop Ruby 3.1 from their gemspecs. Fixes #145. #146 @flavorjones
+- Ruby 3.4.x, 3.3.x, 3.2.x, 3.1.x, and 3.0.x are cross-compiled using Ruby v3.4.1. #146 @flavorjones
+
+### CRuby container summary
+
+- native rubies: 3.4.1 (default), 3.1.6, 2.5.9
+- `RUBY_CC_VERSION=3.4.1:3.3.7:3.2.6:3.1.6:3.0.7:2.7.8:2.6.10:2.5.9:2.4.10`
+
+
 ## v1.8.0 / 2025-01-05
 
 ### Notable changes
@@ -13,6 +34,11 @@ All versions of Ruby in the build containers are the latest patch version. #135
 - (Darwin) Set `OSXCROSS_PKG_CONFIG_USE_NATIVE_VARIABLES=1` to successfully build the 3.0 series.
 - (Darwin) The linker flags include `-Wl,-flat_namespace` for 2.7, 3.0, 3.1, 3.2, 3.3, and 3.4 rubies. Previously this was only needed for 3.2+, but code backported to 2.7.7, 3.0.5, and 3.1.3 required it for those versions as well.
 
+### CRuby container summary
+
+- native rubies: 3.1.6 (default), 2.5.9
+- `RUBY_CC_VERSION=3.4.1:3.3.5:3.2.6:3.1.6:3.0.7:2.7.8:2.6.10:2.5.9:2.4.10`
+
 
 ## v1.7.1 / 2025-01-03
 

data/README.md

@@ -352,6 +352,44 @@ Other environment variables can be set or passed through to the container like t
 RakeCompilerDock.sh "rake cross native gem OPENSSL_VERSION=#{ENV['OPENSSL_VERSION']}"
 ```
 
+### Choosing specific Ruby versions to support
+
+If you only want to precompile for certain Ruby versions, you can specify those versions by overwriting the `RUBY_CC_VERSION` environment variable.
+
+For example, if you wanted to only support Ruby 3.4 and 3.3, you might set this variable to:
+
+``` ruby
+ENV["RUBY_CC_VERSION"] = "3.4.1:3.3.7"
+```
+
+In practice, though, hardcoding these versions is brittle because the patch versions in the container may very from release to release.
+
+A more robust way to do this is to use `RakeCompilerDock.ruby_cc_version` which accepts an array of Ruby minor versions or patch version requirements.
+
+``` ruby
+RakeCompilerDock.ruby_cc_version("3.3", "3.4")
+# => "3.4.1:3.3.7"
+
+RakeCompilerDock.ruby_cc_version("~> 3.4.0", "~> 3.3.0")
+# => "3.4.1:3.3.7"
+
+RakeCompilerDock.ruby_cc_version("~> 3.3")
+# => "3.4.1:3.3.7"
+```
+
+So you can either set the environment variable directly:
+
+``` ruby
+ENV["RUBY_CC_VERSION"] = RakeCompilerDock.ruby_cc_version("~> 3.1")
+```
+
+or do the same thing using the `set_ruby_cc_version` convenience method:
+
+``` ruby
+RakeCompilerDock.set_ruby_cc_version("~> 3.1") # equivalent to the above assignment
+```
+
+
 
 ## More information
 

data/lib/rake_compiler_dock/version.rb

@@ -1,4 +1,4 @@
 module RakeCompilerDock
-  VERSION = "1.8.0"
-  IMAGE_VERSION = "1.8.0"
+  VERSION = "1.9.1"
+  IMAGE_VERSION = "1.9.1"
 end

data/lib/rake_compiler_dock.rb

@@ -73,5 +73,86 @@ module RakeCompilerDock
     Starter.exec(*args, &block)
   end
 
-  module_function :exec, :sh, :image_name
+  # Retrieve the cross-rubies that are available in the docker image. This can be used to construct
+  # a custom `RUBY_CC_VERSION` string that is valid.
+  #
+  # Returns a Hash<minor_version => corresponding_patch_version>
+  #
+  # For example:
+  #
+  #   RakeCompilerDock.cross_rubies
+  #   # => {
+  #   #      "3.4" => "3.4.1",
+  #   #      "3.3" => "3.3.5",
+  #   #      "3.2" => "3.2.6",
+  #   #      "3.1" => "3.1.6",
+  #   #      "3.0" => "3.0.7",
+  #   #      "2.7" => "2.7.8",
+  #   #      "2.6" => "2.6.10",
+  #   #      "2.5" => "2.5.9",
+  #   #      "2.4" => "2.4.10",
+  #   #    }
+  #
+  def cross_rubies
+    {
+      "3.4" => "3.4.1",
+      "3.3" => "3.3.7",
+      "3.2" => "3.2.6",
+      "3.1" => "3.1.6",
+      "3.0" => "3.0.7",
+      "2.7" => "2.7.8",
+      "2.6" => "2.6.10",
+      "2.5" => "2.5.9",
+      "2.4" => "2.4.10",
+    }
+  end
+
+  # Returns a valid RUBY_CC_VERSION string for the given requirements,
+  # where each `requirement` may be:
+  #
+  # - a String that matches the minor version exactly
+  # - a String that can be used as a Gem::Requirement constructor argument
+  # - a Gem::Requirement object
+  #
+  # Note that the returned string will contain versions sorted in descending order.
+  #
+  # For example:
+  #   RakeCompilerDock.ruby_cc_version("2.7", "3.4")
+  #   # => "3.4.1:2.7.8"
+  #
+  #   RakeCompilerDock.ruby_cc_version("~> 3.2")
+  #   # => "3.4.1:3.3.7:3.2.6"
+  #
+  #   RakeCompilerDock.ruby_cc_version(Gem::Requirement.new("~> 3.2"))
+  #   # => "3.4.1:3.3.7:3.2.6"
+  #
+  def ruby_cc_version(*requirements)
+    cross = cross_rubies
+    output = []
+
+    if requirements.empty?
+      output += cross.values
+    else
+      requirements.each do |requirement|
+        if cross[requirement]
+          output << cross[requirement]
+        else
+          requirement = Gem::Requirement.new(requirement) unless requirement.is_a?(Gem::Requirement)
+          versions = cross.values.find_all { |v| requirement.satisfied_by?(Gem::Version.new(v)) }
+          raise("No matching ruby version for requirement: #{requirement.inspect}") if versions.empty?
+          output += versions
+        end
+      end
+    end
+
+    output.uniq.sort.reverse.join(":")
+  end
+
+  # Set the environment variable `RUBY_CC_VERSION` to the value returned by `ruby_cc_version`,
+  # for the given requirements.
+  def set_ruby_cc_version(*requirements)
+    ENV["RUBY_CC_VERSION"] = ruby_cc_version(*requirements)
+  end
+
+  module_function :exec, :sh, :image_name, :cross_rubies, :ruby_cc_version, :set_ruby_cc_version
 end

data/test/test_environment_variables.rb

@@ -34,6 +34,8 @@ class TestEnvironmentVariables
         df = File.read(File.expand_path("../../Dockerfile.mri.erb", __FILE__))
         df =~ /^ENV RUBY_CC_VERSION=(.*)$/
         assert_equal $1, rcd_env['RUBY_CC_VERSION']
+
+        assert_equal RakeCompilerDock.ruby_cc_version, rcd_env['RUBY_CC_VERSION']
       end
 
       def test_RAKE_EXTENSION_TASK_NO_NATIVE

data/test/test_versions.rb

@@ -0,0 +1,82 @@
+require 'rake_compiler_dock'
+require 'rbconfig'
+require 'test/unit'
+
+class TestVersions < Test::Unit::TestCase
+  def test_cross_rubies
+    cross = RakeCompilerDock.cross_rubies
+    assert_operator(cross, :is_a?, Hash)
+    cross.each do |minor, patch|
+      assert_match(/^\d+\.\d+$/, minor)
+      assert_match(/^\d+\.\d+\.\d+$/, patch)
+    end
+  end
+
+  def test_ruby_cc_versions_no_args
+    cross = RakeCompilerDock.cross_rubies
+    expected = cross.values.sort.reverse.join(":")
+
+    assert_equal(expected, RakeCompilerDock.ruby_cc_version)
+  end
+
+  def test_ruby_cc_versions_strings
+    cross = RakeCompilerDock.cross_rubies
+
+    expected = cross["3.4"]
+    assert_equal(expected, RakeCompilerDock.ruby_cc_version("3.4"))
+
+    expected = [cross["3.4"], cross["3.2"]].join(":")
+    assert_equal(expected, RakeCompilerDock.ruby_cc_version("3.4", "3.2"))
+
+    expected = [cross["3.4"], cross["3.2"]].join(":")
+    assert_equal(expected, RakeCompilerDock.ruby_cc_version("3.2", "3.4"))
+
+    assert_raises do
+      RakeCompilerDock.ruby_cc_version("9.8")
+    end
+
+    assert_raises do
+      RakeCompilerDock.ruby_cc_version("foo")
+    end
+  end
+
+  def test_ruby_cc_versions_requirements
+    cross = RakeCompilerDock.cross_rubies
+
+    expected = cross["3.4"]
+    assert_equal(expected, RakeCompilerDock.ruby_cc_version("~> 3.4"))
+    assert_equal(expected, RakeCompilerDock.ruby_cc_version(Gem::Requirement.new("~> 3.4")))
+
+    expected = [cross["3.4"], cross["3.3"], cross["3.2"]].join(":")
+    assert_equal(expected, RakeCompilerDock.ruby_cc_version("~> 3.2"))
+    assert_equal(expected, RakeCompilerDock.ruby_cc_version(Gem::Requirement.new("~> 3.2")))
+
+    expected = [cross["3.4"], cross["3.2"]].join(":")
+    assert_equal(expected, RakeCompilerDock.ruby_cc_version("~> 3.2.0", "~> 3.4.0"))
+    assert_equal(expected, RakeCompilerDock.ruby_cc_version(Gem::Requirement.new("~> 3.2.0"), Gem::Requirement.new("~> 3.4.0")))
+
+    expected = [cross["3.4"], cross["3.3"], cross["3.2"]].join(":")
+    assert_equal(expected, RakeCompilerDock.ruby_cc_version(">= 3.2"))
+    assert_equal(expected, RakeCompilerDock.ruby_cc_version(Gem::Requirement.new(">= 3.2")))
+
+    assert_raises do
+      RakeCompilerDock.ruby_cc_version(Gem::Requirement.new("> 9.8"))
+    end
+  end
+
+  def test_set_ruby_cc_versions
+    original_ruby_cc_versions = ENV["RUBY_CC_VERSION"]
+    cross = RakeCompilerDock.cross_rubies
+
+    RakeCompilerDock.set_ruby_cc_version(Gem::Requirement.new("~> 3.2.0"), Gem::Requirement.new("~> 3.4.0"))
+    assert_equal([cross["3.4"], cross["3.2"]].join(":"), ENV["RUBY_CC_VERSION"])
+
+    RakeCompilerDock.set_ruby_cc_version("~> 3.2.0", "~> 3.4.0")
+    assert_equal([cross["3.4"], cross["3.2"]].join(":"), ENV["RUBY_CC_VERSION"])
+
+    RakeCompilerDock.set_ruby_cc_version("~> 3.1")
+    assert_equal([cross["3.4"], cross["3.3"], cross["3.2"], cross["3.1"]].join(":"), ENV["RUBY_CC_VERSION"])
+  ensure
+    ENV["RUBY_CC_VERSION"] = original_ruby_cc_versions
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rake-compiler-dock
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.1
 platform: ruby
 authors:
 - Lars Kanis
 bindir: bin
 cert_chain: []
-date: 2025-01-06 00:00:00.000000000 Z
+date: 2025-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -123,6 +123,7 @@ files:
 - test/test_environment_variables.rb
 - test/test_parallel_docker_build.rb
 - test/test_starter.rb
+- test/test_versions.rb
 homepage: https://github.com/rake-compiler/rake-compiler-dock
 licenses:
 - MIT
@@ -162,3 +163,4 @@ test_files:
 - test/test_environment_variables.rb
 - test/test_parallel_docker_build.rb
 - test/test_starter.rb
+- test/test_versions.rb