Add `--ext=rust` support to `bundle gem` for creating simple gems with Rust extensions #6149

simi · 2022-12-19T03:09:05Z

Supporting just raw Rust without magnus. I would like to add additional extension skeleton using magnus (like --ext=magnus).

based on combination of:

I would like to add another PR as followup to do something at least "almost usual" in generated extensions (for example define "hello" method and return "hello world") for both C and Rust variants (and potentially magnus as well once introduced).

@ianks feel free to review 🙏

hsbt

I added comment for cometic.

bundler/lib/bundler/cli/gem.rb

ianks · 2022-12-19T15:15:20Z

This looks good for the most part. Great work @simi

Although I do really think we should default to Magnus (with the rb-sys-interop feature). Defaulting to rb-sys is not something I would encourage for gem authors. Are you open to doing that?

ianks · 2022-12-19T15:17:18Z

So essentially the CLI interface I’d recommend would be like this:

ext=rust -> Magnus
ext=rb-sys -> rb-sys

simi · 2022-12-19T17:06:03Z

So essentially the CLI interface I’d recommend would be like this:

ext=rust -> Magnus

ext=rb-sys -> rb-sys

What about following?

ext=magnus -> Magnus
ext=rb-sys -> rb-sys

simi · 2022-12-19T18:48:28Z

I'm going to submit magnus implementation and we can decide on the naming later. We can use generic names like rust and rust-minimal or similar, so the underlying implementation is not important.

hsbt · 2022-12-19T22:26:47Z

ext=magnus -> Magnus

ext=rb-sys -> rb-sys

Can we alias rust to rb-sys? I'm not sure which is the better recommendation for the Rubyists. I'm also okay to alias magnus.

ianks · 2022-12-20T01:17:00Z

ext=magnus -> Magnus

ext=rb-sys -> rb-sys

Can we alias rust to rb-sys? I'm not sure which is the better recommendation for the Rubyists. I'm okay to alias magnus.

I'd prefer not to, because really gem authors should be using a high-level / safe library like magnus when writing gems. With magnus they also have the ability to opt-in to the low-level / unsafe bindings from rb-sys (via the rb-sys-interop feature) when they need to do, but the default should be safe.

simi · 2022-12-20T06:28:05Z

@ianks ok, for now I decided to just got with --ext=rust and in docs mention currently it will generate code based on magnus. That should be enough to be able to change this in the future. I have used magnus crate only for now (following magnus README) to keep it as simple as possible.

Next to those changes, I have updated CIs to be able to compile Rust by default (when selected). I have used diferent approach per CI since each work in different way. At some of them I have opted-in to install latest RubyGems and Bundler, since bundler can now auto-switch. That seems the easiest option for now to keep it compatible accross various Rubies.

simi · 2022-12-20T06:35:07Z

Also I have added required_rubygems_version constraint to rust extension gemspec, since older rubygems can't handle Rust extensions.

bundler/lib/bundler/cli/gem.rb

ianks · 2022-12-20T17:25:53Z

bundler/lib/bundler/templates/newgem/github/workflows/main.yml.tt

@@ -23,5 +23,8 @@ jobs:
      with:
        ruby-version: ${{ matrix.ruby }}
        bundler-cache: true
+<%- if config[:ext] == 'rust' -%>
+        rubygems: 'latest' # for best Rust extension support


We should use https://github.com/oxidize-rb/actions/blob/main/setup-ruby-and-rust/readme.md for CI on rust if possible. It’s well supported and this current configuration will probably not work in all scenarios, it also will be slow due to no caching etc

@ianks there is only v1 tag and that doesn't support needed rubygems option. Would it be possible to tag new version?

simi · 2022-12-20T17:33:31Z

Can we keep CI improvement discussion out of this PR? I'll open following PR with all suggested improvements once merged.

simi · 2022-12-20T17:49:02Z

@deivid-rodriguez I have reverted all changes into CI templates for this PR. I'll continue on improving those in following PR keeping in mind all suggestions from comments in here.

deivid-rodriguez

Awesome, thanks @simi!

ianks · 2022-12-20T18:09:18Z

Looks good to me! Thanks so much @simi, this will have a huge impact. Let's give @matsadler a chance to chime in as well :)

simi · 2022-12-20T18:10:47Z

@ianks cool, we would like to release this soon before Ruby 3.2 (to be included in there). I'm going to prepare followup (based on this one) for CI thingies meanwhile.

Also I would like to support this by upgrading guides and maybe writing small blog explaning how this works.

matsadler · 2022-12-20T21:42:08Z

No comments from me apart from this is very cool.

Let me know if you'd like a hand with any documentation, like if you want examples of how to do something in particular with Magnus.

simi · 2022-12-20T21:58:36Z

Should I squash, rebase and merge?

hsbt · 2022-12-20T22:56:32Z

You can merge this without squash, I think.

simi · 2022-12-21T05:53:17Z

@deivid-rodriguez can you please check 6853738 is what you suggested? I can squash and merge once approved.

deivid-rodriguez

❤️

- generates simple Rust extension skeleton - currently based on magnus rust crate - limit to only supported RubyGems

simi force-pushed the rust-ext branch 3 times, most recently from 0a66ffe to b86351c Compare December 19, 2022 03:47

simi mentioned this pull request Dec 19, 2022

Validate Cargo.lock is present for Rust based extensions. #6151

Merged

simi force-pushed the rust-ext branch from b86351c to 563a025 Compare December 19, 2022 04:23

hsbt reviewed Dec 19, 2022

View reviewed changes

bundler/lib/bundler/cli/gem.rb Show resolved Hide resolved

bundler/lib/bundler/cli/gem.rb Show resolved Hide resolved

simi force-pushed the rust-ext branch 2 times, most recently from fa6ffed to 2fc1993 Compare December 20, 2022 06:24

simi marked this pull request as ready for review December 20, 2022 06:25

deivid-rodriguez reviewed Dec 20, 2022

View reviewed changes

bundler/lib/bundler/cli/gem.rb Show resolved Hide resolved

ianks reviewed Dec 20, 2022

View reviewed changes

simi requested review from ianks, deivid-rodriguez and hsbt December 20, 2022 17:37

deivid-rodriguez approved these changes Dec 20, 2022

View reviewed changes

simi force-pushed the rust-ext branch from 9211687 to b24082f Compare December 20, 2022 19:35

hsbt approved these changes Dec 20, 2022

View reviewed changes

simi force-pushed the rust-ext branch 4 times, most recently from d6f5d71 to 6853738 Compare December 21, 2022 04:13

simi requested a review from deivid-rodriguez December 21, 2022 05:53

deivid-rodriguez approved these changes Dec 21, 2022

View reviewed changes

simi force-pushed the rust-ext branch from 6853738 to 59e4576 Compare December 21, 2022 08:46

Add --ext=rust support to bundle gem command.

c9bc4d8

- generates simple Rust extension skeleton - currently based on magnus rust crate - limit to only supported RubyGems

simi force-pushed the rust-ext branch from 59e4576 to c9bc4d8 Compare December 21, 2022 08:49

simi enabled auto-merge December 21, 2022 08:49

simi merged commit 742cc95 into master Dec 21, 2022

simi deleted the rust-ext branch December 21, 2022 10:29

deivid-rodriguez added the bundler: enhancement label Dec 21, 2022

deivid-rodriguez changed the title ~~Add --ext=rust support for simple Rust extension.~~ Add --ext=rust support to bundle gem for simple Rust extension. Dec 21, 2022

deivid-rodriguez added bundler: feature and removed bundler: enhancement labels Dec 21, 2022

deivid-rodriguez changed the title ~~Add --ext=rust support to bundle gem for simple Rust extension.~~ Add --ext=rust support to bundle gem for creating simple gems with Rust extensions Dec 21, 2022

yous mentioned this pull request Dec 29, 2022

Translate 'Ruby 3.2.0 Released' (ko) ruby/www.ruby-lang.org#2942

Merged

dentarg mentioned this pull request Mar 31, 2023

Replace parser C-extension with pure Ruby puma/puma#1889

Open

This was referenced May 5, 2023

Write specs for new Ruby 3.2 features and changes ruby/spec#1016

Open

Ruby 3.2 support oracle/truffleruby#3039

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `--ext=rust` support to `bundle gem` for creating simple gems with Rust extensions #6149

Add `--ext=rust` support to `bundle gem` for creating simple gems with Rust extensions #6149

simi commented Dec 19, 2022 •

edited

hsbt left a comment

ianks commented Dec 19, 2022

ianks commented Dec 19, 2022

simi commented Dec 19, 2022

simi commented Dec 19, 2022

hsbt commented Dec 19, 2022 •

edited

ianks commented Dec 20, 2022

simi commented Dec 20, 2022

simi commented Dec 20, 2022

ianks Dec 20, 2022

simi Dec 20, 2022

simi commented Dec 20, 2022 •

edited

simi commented Dec 20, 2022

deivid-rodriguez left a comment

ianks commented Dec 20, 2022

simi commented Dec 20, 2022 •

edited

matsadler commented Dec 20, 2022

simi commented Dec 20, 2022 •

edited

hsbt commented Dec 20, 2022

simi commented Dec 21, 2022 •

edited

deivid-rodriguez left a comment

Add --ext=rust support to bundle gem for creating simple gems with Rust extensions #6149

Add --ext=rust support to bundle gem for creating simple gems with Rust extensions #6149

Conversation

simi commented Dec 19, 2022 • edited

hsbt left a comment

Choose a reason for hiding this comment

ianks commented Dec 19, 2022

ianks commented Dec 19, 2022

simi commented Dec 19, 2022

simi commented Dec 19, 2022

hsbt commented Dec 19, 2022 • edited

ianks commented Dec 20, 2022

simi commented Dec 20, 2022

simi commented Dec 20, 2022

ianks Dec 20, 2022

Choose a reason for hiding this comment

simi Dec 20, 2022

Choose a reason for hiding this comment

simi commented Dec 20, 2022 • edited

simi commented Dec 20, 2022

deivid-rodriguez left a comment

Choose a reason for hiding this comment

ianks commented Dec 20, 2022

simi commented Dec 20, 2022 • edited

matsadler commented Dec 20, 2022

simi commented Dec 20, 2022 • edited

hsbt commented Dec 20, 2022

simi commented Dec 21, 2022 • edited

deivid-rodriguez left a comment

Choose a reason for hiding this comment

Add `--ext=rust` support to `bundle gem` for creating simple gems with Rust extensions #6149

Add `--ext=rust` support to `bundle gem` for creating simple gems with Rust extensions #6149

simi commented Dec 19, 2022 •

edited

hsbt commented Dec 19, 2022 •

edited

simi commented Dec 20, 2022 •

edited

simi commented Dec 20, 2022 •

edited

simi commented Dec 20, 2022 •

edited

simi commented Dec 21, 2022 •

edited