rails / jbuilder

Jbuilder: generate JSON objects with a Builder-style DSL
MIT License
4.34k stars 440 forks source link

Add base64 to gemfiles #566

Closed M-Yamashita01 closed 6 months ago

M-Yamashita01 commented 6 months ago

This commit adds base64 gem to rails_6_0.gemfiles, rails_6_1.gemfiles and rails_7_0.gemfiles in gemfiles directory for the following reasons.

warning: base64 was loaded from the standard library, but will no longer be part of the default gems since Ruby 3.4.0. Add base64 to your Gemfile or gemspec. Also contact author of activesupport-6.0.6.1 to add base64 into its gemspec.

However, we do not add base64 gem to jbuilder.gemspec for the following reason.

Refer to https://bugs.ruby-lang.org/issues/20187 https://github.com/ruby/ruby/pull/9550 https://github.com/rails/rails/blob/v7.1.0/activesupport/activesupport.gemspec https://github.com/ruby/base64/blob/v0.1.0/base64.gemspec

yahonda commented 6 months ago

Hi, As far as I understand Jbuilder does not depend on the base64 gem directly. Would you explain the reason why the base64 needs added here?

M-Yamashita01 commented 6 months ago

Jbuilder does not depend on the base64 gem directly.

Yes, that’s true. However, jbuilder depends on activesupport which depends on base64 gem. In the 7.0.8.3 version of activesupport and below, base64 gem does not be added to the activesupport.gemspec, but MessageVerifier class in activesupport calls require base64. Refer: https://github.com/rails/rails/blob/v7.0.8.3/activesupport/lib/active_support/message_verifier.rb

Therefore, when jbuilder load the MessageVerifier class, Ruby 3.3 raise the following warning.

/home/runner/work/jbuilder/jbuilder/vendor/bundle/ruby/3.3.0/gems/activesupport-7.0.8.3/lib/active_support/message_verifier.rb:4: warning: base64 was loaded from the standard library, but will no longer be part of the default gems since Ruby 3.4.0. Add base64 to your Gemfile or gemspec. Also contact author of activesupport-7.0.8.3 to add base64 into its gemspec.

Refer:

The only activesupport that has base64 added to gemspec is the 7.1.0 version or higher. Refer: https://github.com/rails/rails/pull/48907

So if jbuilder is using an activesupport with less than 7.1.0 version, we think it is necessary to add the base64 gem to the gemfile.

yahonda commented 6 months ago

Thanks for the update.

base64 has been added to Active Support dependency via https://github.com/rails/rails/pull/48907 and this commit has been released as Rails 7.1.

To address warning: base64 will be not part of the default gems since Ruby 3.4.0, upgrading Rails version to 7.1 would be a first choice. If you want to run Rails 7.0 or older version of Rails, you can add it to your application's Gemfile.

Closing this pull request because this indirect dependency should not be added to Jbuilder.