cibuildgem 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99cac230a997ce3d919879ca0efd36eab30f2f986180e98a323ff3b071612061
-  data.tar.gz: 695a15ca392fa0eff89f3a2296e76d7a9f74a4adb16471d39d1d951d4d118076
+  metadata.gz: f6f1f69c8bc8ebbbe053eab7e7d12d680c3cf2fce25720165e7bcf5340238eff
+  data.tar.gz: 1a9190614d8194c3bd972dda1bc559e42ee4b69ca7f1a61682fbb8b390f79b2c
 SHA512:
-  metadata.gz: 942a473c81416014f2c4e37442ca035d4a28af007b93b83199bde026288b14f857e0bf3e770f5f1339d003dbe38bc76a69e3718991e3ebe3ea29ffbbc4267eee
-  data.tar.gz: 6eae16529e1501441099024045e812519402d47aa8d80532ea55a464f6b6fbddb22cb2604942ad3faecc1835128498cf927100356b2a7dd591698b27c775b015
+  metadata.gz: a180af046d430b34fe5bd6173d8047d836d2cd623455fbf44a5001a8d51364df28f3ebee1a65b687091535784bd0efd9331a1ba32d54e65e6270738f88f062a1
+  data.tar.gz: c64afb34a1f9927bdb3821fcd281c7c5e6a469176ca14084969290520fde52d180a4cbcd0c918abec847063be42b9999d2daba93f56b586c0c6b571791180c42

data/README.md

@@ -22,49 +22,22 @@ As noted by [@flavorjones](https://github.com/flavorjones), this toolchain works
 
 ## 💻 cibuildgem
 
-> [!NOTE]
-> cibuildgem is for now not able to compile projects that needs to link on external libraries. Unless the project vendors those libraries or uses [mini_portile](https://github.com/flavorjones/mini_portile).
-
-### How to use it
-
-While cibuildgem is generally **not** meant to be used locally, it provides a command to generate the right GitHub workflow for your project:
-
-1. Install cibuildgem: `gem install cibuildgem`
-2. Generate the workflow: `cd` in your gem's folder and run `cibuildgem ci_template`
-3. Commit the `.github/workflows/cibuildgem.yaml` file.
-
-### Triggering the workflow
-
-Once pushed in your repository **default** branch, the workflow that we just generated is actionable manually on the GitHub action page. It will run in sequence:
-
-1. Compile the gem on the target platform (defaults to MacOS ARM, MacOS Intel, Windows, Ubuntu 24)
-2. Once the compilation succeeds on all platform, it proceeds to run the test suite on the target platform. This will trigger many CI steps as the testing matrix is big.
-3. Once the test suite passes for all platforms and all Ruby versions the gem is compatible with, the action proceeds to installing the gem we just packaged. This step ensure that the gem is actually installable.
-4. [OPTIONAL] When trigering the workflow manually, you can tick the box to automatically release the gems that were packaged. This works using the RubyGems trusted publisher feature (documentation to write later). If you do no want the tool to make the release, you can download all the GitHub artifacts that were uploaded. It will contain all the gems with precompiled binaries in the `pkg` folder. You are free to download them locally and release them yourself from your machine.
+Head to the [documentation Wiki](https://github.com/Shopify/cibuildgem/wiki) to setup and configure cibuildgem for your gem.
 
+## Working examples
 
-### Changes to make in your gem to support precompiled binaries
+Here are some working examples on gem that have setup cibuildgem
 
-Due to the RubyGems specification, we can't release a gem with precompiled binaries for a specific Ruby version. Because the Ruby ABI is incompatible between minor versions, Rake Compiler (the tool underneath cibuildgem), compiles the binary for every minor Ruby versions your gem supports. All those binaries will be packaged in the gem (called a fat gem) in different folder such as `3.0/date.so`, `3.1/date.so` etc...
-At runtime, your gem need to require the right binary based on the running ruby version.
+| Name      | Example Run | Published Gem |
+|-----------|-------------|---------------|
+| [Rubydex](https://github.com/shopify/rubydex) | [CI Run](https://github.com/Shopify/rubydex/actions/runs/21880161517) | [Gem](https://rubygems.org/gems/rubydex/versions/0.1.0.beta4-arm64-darwin) |
+| [Heap Profiler](https://github.com/shopify/heap-profiler) | [CI Run](https://github.com/Shopify/heap-profiler/actions/runs/20996043558) | [Gem](https://rubygems.org/gems/heap-profiler/versions/0.8.0.rc1-x86_64-linux) |
+| [djb2](https://github.com/Shopify/djb2) | [CI Run](https://github.com/Shopify/djb2/actions/runs/22188688549) | [Gem](https://rubygems.org/gems/djb2/versions/0.1.1-x86_64-linux) |
+| [Blake3](https://github.com/Shopify/blake3-rb) | [CI Run](https://github.com/Shopify/blake3-rb/actions/runs/21253662535) | [Gem](https://rubygems.org/gems/blake3-rb/versions/1.5.6.rc1-x86_64-linux) |
+| [Raindrops (fork)](https://github.com/Edouard-chin/raindrops) | [CI Run](https://github.com/Edouard-chin/raindrops/actions/runs/22045845221) | [Gem](https://rubygems.org/gems/precompiled-raindrops) |
+| [Stack Frames](https://github.com/Shopify/stack_frames) | [CI Run](https://github.com/Shopify/stack_frames/actions/runs/19969899178) | [Gem](https://rubygems.org/gems/stack_frames/versions/0.1.4-x86_64-linux) |
 
-```ruby
-# Before
-
-require 'date_core.so'
-
-# After
-
-begin
-  ruby_version = /(\d+\.\d+)/.match(::RUBY_VERSION)
-  require "#{ruby_version}/date_core"
-rescue LoadError
-  # It's important to leave for users that can not or don't want to use the gem with precompiled binaries.
-  require "date_core"
-end
-```
-
-### Supported platforms/Ruby versions
+## Supported platforms/Ruby versions
 
 |         | MacOS Intel  | MacOS ARM | Windows x64 UCRT | Linux GNU x86_64|Linux AARCH64 |
 |---------|------------- | --------- | ------------|-----------------|-----------------|
@@ -72,7 +45,4 @@ end
 | Ruby 3.2| 🟢           | 🟢        | 🟢          | 🟢             | 🟢             |
 | Ruby 3.3| 🟢           | 🟢        | 🟢          | 🟢             | 🟢             |
 | Ruby 3.4| 🟢           | 🟢        | 🟢          | 🟢             | 🟢             |
-
-## 🧪 Development
-
-If you'd like to run a end-to-end test, the `date` gem is vendored in this project. You can trigger a manual run to do the whole compile, test, install dance from the GitHub action menu.
+| Ruby 4.0| 🟢           | 🟢        | 🟠 (not tested)| 🟢             | 🟢             |

data/lib/cibuildgem/cli.rb

@@ -3,6 +3,7 @@
 require "thor"
 require "rake/extensiontask"
 require "prism"
+require "open3"
 
 module Cibuildgem
   class CLI < Thor
@@ -112,14 +113,23 @@ module Cibuildgem
         pathname = Pathname(file)
         next if pathname.directory? || pathname.extname != ".gem"
 
-        Kernel.system("gem push #{file}", exception: true)
+        out, status = Open3.capture2e("gem push #{file}")
+        next if status.success?
+
+        if out =~ /Repushing of gem versions is not allowed/
+          puts "Gem #{file} already exists on RubyGems.org, skipping..."
+
+          next
+        end
+
+        raise out
       end
     end
 
     desc "print_ruby_cc_version", "Output the cross compile ruby version needed for the gem. For internal usage", hide: true
     method_option "gemspec", type: "string", required: false, desc: "The gemspec to use. If the option is not passed, a gemspec file from the current working directory will be used."
     def print_ruby_cc_version
-      print(compilation_task.ruby_cc_version)
+      print(ENV["RUBY_CC_VERSION"] || compilation_task.ruby_cc_version)
     end
 
     desc "normalized_platform", "The platform name for compilation purposes", hide: true

data/lib/cibuildgem/compilation_tasks.rb

@@ -17,8 +17,6 @@ module Cibuildgem
     end
 
     def setup
-      Rake::ExtensionTask.enable!
-
       gemspec.extensions.each do |path|
         binary_name = parse_extconf(path)
         define_task(path, binary_name)
@@ -54,16 +52,19 @@ module Cibuildgem
     end
 
     def define_task(path, binary_name)
-      @extension_task = Rake::ExtensionTask.new do |ext|
-        ext.name = File.basename(binary_name)
-        ext.config_script = File.basename(path)
-        ext.ext_dir = File.dirname(path)
-        ext.lib_dir = binary_lib_dir(binary_name) if binary_lib_dir(binary_name)
-        ext.gem_spec = gemspec
-        ext.cross_platform = normalized_platform
-        ext.cross_compile = true
-        ext.no_native = true
-      end
+      @extension_task = Rake::ExtensionTask.current || Rake::ExtensionTask.new
+
+      @extension_task.name = File.basename(binary_name)
+      @extension_task.config_script = File.basename(path)
+      @extension_task.ext_dir = File.dirname(path)
+      @extension_task.lib_dir = binary_lib_dir(binary_name) if binary_lib_dir(binary_name)
+      @extension_task.gem_spec = gemspec
+      @extension_task.cross_platform = normalized_platform
+      @extension_task.cross_compile = true
+      @extension_task.no_native = true
+
+      Rake::ExtensionTask.enable!
+      @extension_task.define
 
       disable_shared unless Gem.win_platform?
     end
@@ -92,6 +93,17 @@ module Cibuildgem
 
             File.write(task.name, makefile_content)
           end
+
+          makefile_content.match(/^ldflags\W+=(.*)/) do |match|
+            ldflags = match[1].split(" ")
+            next if ldflags.include?("-s")
+
+            ldflags << "-s"
+
+            makefile_content.gsub!(/^(ldflags\W+=)(.*)/, "\\1#{ldflags.join(" ")}")
+
+            File.write(task.name, makefile_content)
+          end
         end
       end
     end

data/lib/cibuildgem/extension_patch.rb

@@ -7,7 +7,7 @@ module Cibuildgem
     class << self
       def prepended(mod)
         class << mod
-          attr_accessor :enabled
+          attr_accessor :enabled, :current
 
           def enable!
             @enabled = true
@@ -16,6 +16,12 @@ module Cibuildgem
       end
     end
 
+    def initialize(*)
+      super
+
+      self.class.current = self
+    end
+
     def define
       super if self.class.enabled
     end

data/lib/cibuildgem/tasks/wrapper.rake

@@ -12,11 +12,9 @@ task "cibuildgem:setup" do
 end
 
 task "copy:stage:lib" do
-  version = RUBY_VERSION.match(/(\d\.\d)/)[1]
-  dest = File.join(task.extension_task.lib_dir, version)
-  src = File.join("tmp", task.extension_task.cross_platform, "stage", dest)
+  src = File.join("tmp", task.extension_task.cross_platform, "stage")
 
-  cp_r(src, dest, remove_destination: true)
+  cp_r(Dir.glob("#{src}/*"), ".", remove_destination: true)
 end
 
 unless Rake::Task.task_defined?(:test)

data/lib/cibuildgem/templates/github/workflows/cibuildgem.yaml.tt

@@ -7,6 +7,8 @@ on:
         required: false
         type: boolean
         default: false
+env:
+  CIBUILDGEM: 1
 jobs:
   compile:
     timeout-minutes: 20

data/lib/cibuildgem/version.rb

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

metadata

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