Add `bundle fund` command #3390

gjtorikian · 2020-03-16T10:52:36Z

What was the end-user or developer problem that led to this PR?

This PR implements the bundle fund proposal in this accepted RFC.

What is your fix for the problem, implemented in this PR?

The rationale and technical details for the bundle fund command are explained in the RFC, but roughly:

A new metadata key, funding_uri, can be specified, that points to a funding page for a gem
On a successful bundle install or bundle update, a message will be printed out that indicates gems which require support: 4 gems you depend on are looking for funding
bundle fund will list out all those gems, with their funding links
bundle info will include the funding_uri in its printout
You can restrict bundle fund to only list information for a specific group
Dependencies of dependencies are currently not listed in bundle fund; this is by design

welcome · 2020-03-16T10:52:38Z

Thanks for opening a pull request and helping make RubyGems better! Someone from the RubyGems team will take a look at your pull request shortly and leave any feedback. Please make sure that your pull request has tests for any changes or added functionality.

We use Github Actions to test and make sure your change works functionally and uses acceptable conventions, you can review the current progress of Github Actions in the PR status window below.

If you have any questions or concerns that you wish to ask, feel free to leave a comment in this PR or join our #rubygems channel on Slack.

For more information about contributing to the RubyGems project feel free to review our CONTRIBUTING guide

gjtorikian · 2020-03-29T20:28:04Z

Just bumping this to hope to get some attention to it. ✌️

simi · 2020-06-07T16:18:18Z

Overall looks good to me. I have two suggestions:

Once merged, promote funding_uri at https://guides.rubygems.org/specification-reference/#metadata as well.
What about to make it part of bundle gem gemspec template?

gjtorikian · 2020-06-07T17:30:51Z

1. Once merged, promote `funding_uri` at https://guides.rubygems.org/specification-reference/#metadata as well.

Sure, and individual rubygems.org/gems pages too.

2\. What about to make it part of `bundle gem` gemspec template?

From the RFC, I didn't want to do this. Maybe in a future iteration?

gjtorikian · 2020-09-14T19:39:28Z

Hey, just bumping this...again.

deivid-rodriguez · 2020-09-14T19:56:04Z

@gjtorikian I'm so sorry nobody stepped in to review this before. Thanks so much for being so patient.

I'm going to put this on my list for this week. If I haven't reviewed this by next Monday, please ping me again.

deivid-rodriguez · 2020-09-15T16:38:01Z

@gjtorikian Could you rebase this PR, it's 1289 commits behind current HEAD, I'd like to make sure it's green before reviewing. I can also do that for you as well if you're busy.

gjtorikian · 2020-09-16T07:07:20Z

@deivid-rodriguez Ok, I've rebased.

deivid-rodriguez · 2020-09-16T08:58:43Z

Tests are failing. It's because we removed the bundle! test helper. You should use bundle now.

gjtorikian · 2020-09-16T09:18:11Z

Ah, ok. Done!

deivid-rodriguez · 2020-09-17T09:59:17Z

Hello @gjtorikian!

I just read the RFC, it looks really really good ❤️. I agree with everything, including the potentially most controversial parts like not adding an opt-out flag to skip the <n> gems you depend on are looking for funding message. It's just a small unintrusive line, I don't think people will be bothered by it.

Regarding the message, what do you think about tweaking it to <n> gems you **directly** depend on are looking for funding. That way we give some clue that they might not be the only code you depend on that it's looking for funding.

Regarding the functionality, it looks all good other than that little tweak. I'll go ahead with reviewing the implementation now.

gjtorikian · 2020-09-17T10:27:03Z

@deivid-rodriguez That makes complete sense to me, and I've tweaked the message. I also removed the ! as it felt a bit too enthusiastic.

deivid-rodriguez

Made a first pass. Looking good!

bundler/lib/bundler/cli/common.rb

bundler/spec/update/gems/fund_spec.rb

bundler/spec/install/gems/fund_spec.rb

gjtorikian

Thanks @deivid-rodriguez ! Everything made sense and I've made the changes.

bundler/lib/bundler/cli/common.rb

bundler/spec/update/gems/fund_spec.rb

gjtorikian · 2020-09-17T15:09:20Z

So many test issues 🙈! But all good now.

deivid-rodriguez

I made another pass, mainly little style issues now.

bundler/lib/bundler/cli/common.rb

bundler/lib/bundler/cli/fund.rb

bundler/spec/commands/fund_spec.rb

bundler/spec/install/gems/fund_spec.rb

bundler/spec/update/gems/fund_spec.rb

deivid-rodriguez · 2020-09-30T10:51:42Z

Ok @gjtorikian, sorry for the back and forth here.

The problem is that specs already does the filtering of excluding not configured groups, so we can't get the funding information for those from there. We could try resolve.materialize(current_dependencies) instead to get all materialized specs (without any group filtering), but in order for that to work, it turns out we'd need to actually install those specs, and that didn't happen because groups were filtered out in the first place.

So, since I don't see an easy fix for this, I propose we go back to #3390 (comment) and address that instead by further tweaking the message to

<n> installed gems you directly depend on are looking for funding.

to make it more clear that any gem exclusions happening before gem installation, for example without production, are not included in the count.

deivid-rodriguez · 2020-09-30T14:15:33Z

@gjtorikian This looks good to me now! 🎉

Could you rebase and squash the PR into two commits (one for the post_install_message and tests, and one for the addition of bundle fund and tests)?

gjtorikian · 2020-09-30T17:44:36Z

🎆

deivid-rodriguez

Hi!

I'm aware that at this point I'm probably just being annoying, but technically the commit that needs requested_dependencies to be made public is the second, so the change making that method public belongs in there 😅.

Other than that, I'd like to thank you so much for your infinite patience and for your polite well-spaced pings along these past months 💜.

gjtorikian · 2020-09-30T20:02:37Z

Heh, no worries. It's fixed up!

I am just excited to be able to add this and get some visibility for support. I have another change pending for visualizing this metadata on rubygems.org next. 😄

deivid-rodriguez · 2020-10-01T10:50:23Z

Hei, that's awesome to hear. This will make a better ecosystem overall.

Regarding my last request, I don't think it's actually fixed because bundle fund requires dependencies_for to be made public, so that part should go with the first commit, while the post_install method requires requested_dependencies to be made public, so that part should be included in the second commit. The reason I ask for this is not only for a better git history, but also if I ever need to bisect something, I'd like each individual commit to pass specs individually.

gjtorikian · 2020-10-01T14:38:40Z

The reason I ask for this is not only for a better git history, but also if I ever need to bisect something, I'd like each individual commit to pass specs individually

It's all good! It's your project, I'm just committing to it. 😆

Re-rebased and pushed.

deivid-rodriguez · 2020-10-01T15:46:33Z

Awesome, thanks so much @gjtorikian!! 🎉

simi · 2020-10-01T15:48:42Z

🥳

gjtorikian · 2020-10-03T10:46:56Z

As a maintainer I know how problematic the next question is but I am compelled to ask: when can we expect a new release with these changes? 🙈

deivid-rodriguez · 2020-10-03T10:49:24Z

We hope to release bundler 2.2.0.rc.2 next week including this feature.

Add `bundle fund` command (cherry picked from commit ce27b98)

For more information: - rubygems/rubygems#3390 - rubygems/rubygems#3060

bronzdoc added the status: triage label Mar 16, 2020

deivid-rodriguez added the Bundler label Mar 16, 2020

gjtorikian closed this Sep 16, 2020

gjtorikian deleted the go-fund-me branch September 16, 2020 06:59

gjtorikian restored the go-fund-me branch September 16, 2020 07:04

gjtorikian reopened this Sep 16, 2020

gjtorikian force-pushed the go-fund-me branch from b25fce4 to 2821205 Compare September 16, 2020 07:06

deivid-rodriguez added bundler: feature and removed status: triage labels Sep 17, 2020

gjtorikian force-pushed the go-fund-me branch 2 times, most recently from e5c684e to 5f586f1 Compare September 17, 2020 10:29

deivid-rodriguez reviewed Sep 17, 2020

View reviewed changes

gjtorikian commented Sep 17, 2020

View reviewed changes

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

bundler/spec/update/gems/fund_spec.rb Outdated Show resolved Hide resolved

bundler/spec/update/gems/fund_spec.rb Outdated Show resolved Hide resolved

gjtorikian force-pushed the go-fund-me branch 2 times, most recently from 5dddf03 to 2efc5f3 Compare September 17, 2020 14:45

deivid-rodriguez reviewed Sep 17, 2020

View reviewed changes

bundler/spec/update/gems/fund_spec.rb Outdated Show resolved Hide resolved

gjtorikian force-pushed the go-fund-me branch from 88fe4f7 to 8e9c31b Compare September 30, 2020 16:16

deivid-rodriguez approved these changes Sep 30, 2020

View reviewed changes

gjtorikian force-pushed the go-fund-me branch from 5aac6f8 to 9c73af3 Compare September 30, 2020 20:01

gjtorikian added 2 commits October 1, 2020 15:38

Add a bundle fund command

4978bad

Show funding information post-install/update

664db8e

gjtorikian force-pushed the go-fund-me branch from 9c73af3 to 664db8e Compare October 1, 2020 14:38

deivid-rodriguez merged commit ce27b98 into rubygems:master Oct 1, 2020

gjtorikian deleted the go-fund-me branch October 1, 2020 18:47

gjtorikian mentioned this pull request Oct 1, 2020

Add funding links to sidebar rubygems/rubygems.org#2522

Merged

deivid-rodriguez added a commit that referenced this pull request Oct 5, 2020

Merge pull request #3390 from gjtorikian/go-fund-me

6756d3c

Add `bundle fund` command (cherry picked from commit ce27b98)

deivid-rodriguez added a commit that referenced this pull request Oct 5, 2020

Merge pull request #3390 from gjtorikian/go-fund-me

0a20529

Add `bundle fund` command (cherry picked from commit ce27b98)

deivid-rodriguez added a commit that referenced this pull request Oct 5, 2020

Merge pull request #3390 from gjtorikian/go-fund-me

11541dc

Add `bundle fund` command (cherry picked from commit ce27b98)

deivid-rodriguez added a commit that referenced this pull request Oct 6, 2020

Merge pull request #3390 from gjtorikian/go-fund-me

0b7e987

Add `bundle fund` command (cherry picked from commit ce27b98)

deivid-rodriguez added a commit that referenced this pull request Oct 6, 2020

Merge pull request #3390 from gjtorikian/go-fund-me

6a8c26a

Add `bundle fund` command (cherry picked from commit ce27b98)

deivid-rodriguez added a commit that referenced this pull request Oct 6, 2020

Merge pull request #3390 from gjtorikian/go-fund-me

2e96357

Add `bundle fund` command (cherry picked from commit ce27b98)

This was referenced Oct 21, 2020

Adding funding_uri & other metadata MikeRogers0/puma-ngrok-tunnel#31

Merged

Adding funding_uri metadata to gemspec PigCI/pig-ci-rails#43

Merged

Adding funding_uri & metadata in bt-rb/bridgetown-minify-html#13

Merged

EduardoGHdez added a commit to EduardoGHdez/ruby_jard that referenced this pull request Aug 11, 2021

Adding funding_uri & other metadata

3c17aab

For more information: - rubygems/rubygems#3390 - rubygems/rubygems#3060

EduardoGHdez mentioned this pull request Aug 11, 2021

Adding funding_uri & other metadata nguyenquangminh0711/ruby_jard#99

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `bundle fund` command #3390

Add `bundle fund` command #3390

gjtorikian commented Mar 16, 2020

welcome bot commented Mar 16, 2020

gjtorikian commented Mar 29, 2020

simi commented Jun 7, 2020

gjtorikian commented Jun 7, 2020

gjtorikian commented Sep 14, 2020

deivid-rodriguez commented Sep 14, 2020

deivid-rodriguez commented Sep 15, 2020

gjtorikian commented Sep 16, 2020

deivid-rodriguez commented Sep 16, 2020

gjtorikian commented Sep 16, 2020

deivid-rodriguez commented Sep 17, 2020 •

edited

gjtorikian commented Sep 17, 2020

deivid-rodriguez left a comment

gjtorikian left a comment

gjtorikian commented Sep 17, 2020

deivid-rodriguez left a comment

deivid-rodriguez commented Sep 30, 2020

deivid-rodriguez commented Sep 30, 2020

gjtorikian commented Sep 30, 2020

deivid-rodriguez left a comment

gjtorikian commented Sep 30, 2020

deivid-rodriguez commented Oct 1, 2020

gjtorikian commented Oct 1, 2020

deivid-rodriguez commented Oct 1, 2020

simi commented Oct 1, 2020

gjtorikian commented Oct 3, 2020

deivid-rodriguez commented Oct 3, 2020

Add bundle fund command #3390

Add bundle fund command #3390

Conversation

gjtorikian commented Mar 16, 2020

What was the end-user or developer problem that led to this PR?

What is your fix for the problem, implemented in this PR?

welcome bot commented Mar 16, 2020

gjtorikian commented Mar 29, 2020

simi commented Jun 7, 2020

gjtorikian commented Jun 7, 2020

gjtorikian commented Sep 14, 2020

deivid-rodriguez commented Sep 14, 2020

deivid-rodriguez commented Sep 15, 2020

gjtorikian commented Sep 16, 2020

deivid-rodriguez commented Sep 16, 2020

gjtorikian commented Sep 16, 2020

deivid-rodriguez commented Sep 17, 2020 • edited

gjtorikian commented Sep 17, 2020

deivid-rodriguez left a comment

Choose a reason for hiding this comment

gjtorikian left a comment

Choose a reason for hiding this comment

gjtorikian commented Sep 17, 2020

deivid-rodriguez left a comment

Choose a reason for hiding this comment

deivid-rodriguez commented Sep 30, 2020

deivid-rodriguez commented Sep 30, 2020

gjtorikian commented Sep 30, 2020

deivid-rodriguez left a comment

Choose a reason for hiding this comment

gjtorikian commented Sep 30, 2020

deivid-rodriguez commented Oct 1, 2020

gjtorikian commented Oct 1, 2020

deivid-rodriguez commented Oct 1, 2020

simi commented Oct 1, 2020

gjtorikian commented Oct 3, 2020

deivid-rodriguez commented Oct 3, 2020

Add `bundle fund` command #3390

Add `bundle fund` command #3390

deivid-rodriguez commented Sep 17, 2020 •

edited