Add precompiled binary gem support and modernize build system#2
Open
wesleyjellis wants to merge 4 commits into
Open
Add precompiled binary gem support and modernize build system#2wesleyjellis wants to merge 4 commits into
wesleyjellis wants to merge 4 commits into
Conversation
- Build a static, self-contained extension: vendor OpsLevel's jq fork
(env/$ENV always return {}) plus Onigmo 6.2.0 for regex support,
compiled with --disable-shared --enable-static --with-pic
- Move the binary to lib/jq/jq_core.so and load a per-Ruby-minor
precompiled binary when present, falling back to the source build
- Add .github/workflows/cibuildgem.yaml to compile, test, verify, and
release fat platform gems (x86_64-linux, arm64-darwin) for Ruby
3.3/3.4/4.0 via Shopify's cibuildgem
- Declare required_ruby_version >= 3.3; drop mini_portile2 from
platform gems
- Add specs guarding regex support and the fork's empty env behavior
- Bump version to 0.3.0; update README; remove stale .travis.yml
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01PpxfE1fTm5fFQYBqWTzg4y
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
libruby exports its own onig_* functions and ELF's flat namespace lets calls bind across copies of Onigmo; today both are 6.2.0 so it works by coincidence, but a version skew would cause crashes. Keep the vendored jq/Onigmo symbols local to the extension. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
wesleyjellis
commented
Jul 20, 2026
wesleyjellis
left a comment
wesleyjellis
left a comment
Author
There was a problem hiding this comment.
https://github.com/flavorjones/mini_portile mentions that "gem "mini_portile2", "~> 2.0.0" # NECESSARY if used in extconf.rb. see below." which seems missing
| recipe = MiniPortile.new('jq', '1.6') | ||
| recipe.files = ['https://github.com/stedolan/jq/archive/jq-1.6.tar.gz'] | ||
| onigmo = MiniPortile.new('onigmo', '6.2.0') | ||
| onigmo.files = ['https://github.com/k-takata/Onigmo/releases/download/Onigmo-6.2.0/onigmo-6.2.0.tar.gz'] |
Author
There was a problem hiding this comment.
We should add the expected sha256
| require 'mkmf' | ||
|
|
||
| def using_system_libraries? | ||
| arg_config('--use-system-libraries', ENV.key?('RUBYJQ_USE_SYSTEM_LIBRARIES')) |
Author
There was a problem hiding this comment.
we set this in Opslevel, might have to remove it
| begin | ||
| # Load the precompiled binary matching the current Ruby, if this is a | ||
| # platform-specific gem packaged by cibuildgem. | ||
| require "jq/#{RUBY_VERSION[/\d+\.\d+/]}/jq_core" |
Author
There was a problem hiding this comment.
I don't understand how this magic works
Author
There was a problem hiding this comment.
but it is the suggested path here: https://github.com/Shopify/cibuildgem/wiki/1.-Setup-cibuildgem-on-your-project#prepare-your-gem-to-load-the-right-binary
|
|
||
| Rake::ExtensionTask.new('jq_core') do |ext| | ||
| ext.ext_dir = 'ext' | ||
| ext.lib_dir = 'lib/jq' |
|
|
||
| # OpsLevel fork of jq: `env`/`$ENV` always return an empty object. | ||
| recipe = MiniPortile.new('jq', '1.6.opslevel') | ||
| recipe.files = ['https://github.com/OpsLevel/jq/archive/845f4206dd8a82355325bafffbb54a5155cf67ec.tar.gz'] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR modernizes the ruby-jq gem's build and release infrastructure by adding support for precompiled platform-specific binaries, updating to use OpsLevel's jq fork, and migrating from Travis CI to GitHub Actions with cibuildgem.
Key Changes
.github/workflows/cibuildgem.yaml) to build and release platform-specific gems forx86_64-linuxandarm64-darwinacross multiple Ruby versions (3.3, 3.4, 4.0)env/$ENValways return an empty objectRakefileto output compiled extensions tolib/jq/and excludemini_portile2from platform gem dependencieslib/jq.rbto load precompiled binaries matching the Ruby version, with fallback to source-compiled extensionextconf.rbto compile both Onigmo and jq statically with proper configuration options.travis.ymlin favor of GitHub Actions workflowREADME.mdto document precompiled binary availability and build requirementsMetrics/LineLengthtoLayout/LineLength)Notable Implementation Details
jq/3.3/jq_core) with graceful fallbackenvbehaviorhttps://claude.ai/code/session_01PpxfE1fTm5fFQYBqWTzg4y