cibuildgem 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6f1f69c8bc8ebbbe053eab7e7d12d680c3cf2fce25720165e7bcf5340238eff
-  data.tar.gz: 1a9190614d8194c3bd972dda1bc559e42ee4b69ca7f1a61682fbb8b390f79b2c
+  metadata.gz: da5409562c657378fb90d4f47e47227b9db5d647d179f7f9814ee96409e5e28e
+  data.tar.gz: 7a91e89c2aa9fc6159b69dfdcfb55072ec6c2dad4d84629da51de84dde1af992
 SHA512:
-  metadata.gz: a180af046d430b34fe5bd6173d8047d836d2cd623455fbf44a5001a8d51364df28f3ebee1a65b687091535784bd0efd9331a1ba32d54e65e6270738f88f062a1
-  data.tar.gz: c64afb34a1f9927bdb3821fcd281c7c5e6a469176ca14084969290520fde52d180a4cbcd0c918abec847063be42b9999d2daba93f56b586c0c6b571791180c42
+  metadata.gz: 9b590a75b1288f5a2dbf7318b2fc76eb2ab37203318ba5e5429d6c8afc50962bcd50f0343f2d85ea680d3435ac91334392cd3854b007f95be2fb92ad9a8f2cfe
+  data.tar.gz: 1d3c96ff0c538804a9ccfcfe6187b0819bc1ccf910bccf994b1bb69d190071a507e3c3902c59a5d6256d01e6809f12512a6eca5aede166ae3cd00ec0864cc6cd

data/lib/cibuildgem/cli.rb

@@ -11,6 +11,10 @@ module Cibuildgem
 
     source_root(File.expand_path("templates", __dir__))
 
+    # RubyGems already restricts a gem's name, version and platform to these characters, so every filename
+    # `cibuildgem package` can legitimately produce matches. Anything else was not produced by the package task.
+    RELEASABLE_GEM_FILENAME = /\A[A-Za-z0-9._-]+\.gem\z/
+
     class << self
       def exit_on_failure?
         true
@@ -32,7 +36,7 @@ module Cibuildgem
       run_rake_tasks!("cibuildgem:setup", :compile)
     end
 
-    desc "package", "Compile and package a 'fat gem'.", hide: true
+    desc "package", "Compile and package a 'multi-ABI gem'.", hide: true
     long_desc <<~MSG
       This command should normally run on CI, using the cibuildgem workflow. It will not work locally unless
       the environment is properly setup.
@@ -42,13 +46,20 @@ module Cibuildgem
       - A gem without precompiled binary (Ruby platform).
 
       The gem with precompiled binaries will be packaged with multiple binaries compatible for different
-      Ruby ABI (depending on what Ruby version the gem supports).
+      Ruby ABI (depending on what Ruby version the gem supports). If `--include-single-abi` is passed,
+      cibuildgem will also compile a set of single-ABI gems per Ruby version supported by the gem.
     MSG
     method_option "gemspec", type: "string", required: false, desc: "The gemspec to use. Defaults to the gemspec from the current working directory."
+    method_option "include-single-abi", type: :boolean, required: false, default: false, desc: "Whether to also compile a set of single-ABI gems. Defaults to false."
     def package
       ENV["RUBY_CC_VERSION"] ||= compilation_task.ruby_cc_version
-
-      run_rake_tasks!("cibuildgem:setup", :cross, :native, :gem)
+      run_rake_tasks!(
+        "cibuildgem:setup",
+        :cross,
+        :native,
+        :gem,
+        env: { "CIBUILDGEM_CONTENT_ADDRESSABLE" => options["include-single-abi"] == true ? "true" : "false" },
+      )
     end
 
     desc "test", "Run the test suites of the target gem"
@@ -113,7 +124,9 @@ module Cibuildgem
         pathname = Pathname(file)
         next if pathname.directory? || pathname.extname != ".gem"
 
-        out, status = Open3.capture2e("gem push #{file}")
+        verify_releasable_filename!(pathname)
+
+        out, status = Open3.capture2e("gem", "push", file)
         next if status.success?
 
         if out =~ /Repushing of gem versions is not allowed/
@@ -139,8 +152,20 @@ module Cibuildgem
 
     private
 
-    def run_rake_tasks!(*tasks)
-      all_tasks = tasks.join(" ")
+    def verify_releasable_filename!(pathname)
+      basename = pathname.basename.to_s
+      return if RELEASABLE_GEM_FILENAME.match?(basename)
+
+      raise(<<~MSG)
+        Refusing to publish #{basename.inspect}.
+
+        A gem filename may only contain letters, digits, dots, dashes and underscores, so this file was not
+        produced by `cibuildgem package`. Artifacts reach the release job from the compile job, which runs
+        without publishing credentials, so an unexpected filename is treated as tampering rather than a gem.
+      MSG
+    end
+
+    def run_rake_tasks!(*tasks, env: {})
       rakelibdir = [File.expand_path("tasks", __dir__), "rakelib"].join(File::PATH_SEPARATOR)
       rake_compiler_path = Gem.loaded_specs["rake-compiler"].full_require_paths
       rake_specs = Gem.loaded_specs["rake"]
@@ -151,8 +176,15 @@ module Cibuildgem
       patch = File.expand_path("../extension_patch.rb", __FILE__)
 
       system(
-        { "RUBYLIB" => load_paths },
-        "bundle exec #{RbConfig.ruby} #{rake_executable} #{all_tasks} -R#{rakelibdir} -r #{patch}",
+        { "RUBYLIB" => load_paths }.merge(env),
+        "bundle",
+        "exec",
+        RbConfig.ruby,
+        rake_executable,
+        *tasks.map(&:to_s),
+        "-R#{rakelibdir}",
+        "-r",
+        patch,
         exception: true,
       )
     end

data/lib/cibuildgem/compilation_tasks.rb

@@ -7,13 +7,18 @@ require_relative "create_makefile_finder"
 
 module Cibuildgem
   class CompilationTasks
-    attr_reader :gemspec, :native, :create_packaging_task, :extension_task
+    attr_reader :gemspec, :native, :create_packaging_task, :extension_task, :content_addressable
 
-    def initialize(create_packaging_task = false, gemspec = nil)
+    def initialize(
+      create_packaging_task = false,
+      gemspec = nil,
+      content_addressable: ENV["CIBUILDGEM_CONTENT_ADDRESSABLE"] == "true"
+    )
       @gemspec = Bundler.load_gemspec(gemspec || find_gemspec)
       verify_gemspec!
 
       @create_packaging_task = create_packaging_task
+      @content_addressable = content_addressable
     end
 
     def setup
@@ -62,6 +67,14 @@ module Cibuildgem
       @extension_task.cross_platform = normalized_platform
       @extension_task.cross_compile = true
       @extension_task.no_native = true
+      if content_addressable
+        if @extension_task.respond_to?(:content_addressable=)
+          @extension_task.content_addressable = true
+        else
+          warn("WARNING: content-addressable packaging was requested, but rake-compiler #{rake_compiler_version} " \
+            "does not support it. Upgrade rake-compiler to >= 1.3.2 to build single-ABI gems.")
+        end
+      end
 
       Rake::ExtensionTask.enable!
       @extension_task.define
@@ -69,6 +82,10 @@ module Cibuildgem
       disable_shared unless Gem.win_platform?
     end
 
+    def rake_compiler_version
+      Gem.loaded_specs["rake-compiler"]&.version&.to_s || "unknown"
+    end
+
     def binary_lib_dir(binary_name)
       dir = File.dirname(binary_name)
       return if dir == "."

data/lib/cibuildgem/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Cibuildgem
-  VERSION = "0.3.0"
+  VERSION = "0.4.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cibuildgem
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Shopify