Set Ruby version in Gemfile and .ruby-version by default #30016

albertoalmagro · 2017-07-31T17:34:44Z

Summary

This pull request sets current Ruby version in the Gemfile and .ruby-version by default.

When running rails new my-app the generated application will include by default:

A .ruby-version file, containing the default Ruby version.
An entry in the Gemfile, with the format ruby '2.x.x' with the same default Ruby version.

Implications

Among other usages:

.ruby-version will help ruby version manager tools such as rbenv to determine which Ruby version should be used for the current Rails project.
The entry ruby 'version' in the Gemfile may be used by deployment tools (i.e. Heroku) to determine the Ruby version that should be used to run Rails.

rails-bot · 2017-07-31T17:34:47Z

Thanks for the pull request, and welcome! The Rails team is excited to review your changes, and you should hear from @schneems (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

This repository is being automatically checked for code quality issues using Code Climate. You can see results for this analysis in the PR status below. Newly introduced issues should be fixed before a Pull Request is considered ready to review.

Please see the contribution instructions for more information.

rafaelfranca · 2017-07-31T17:45:36Z

railties/lib/rails/generators/rails/app/templates/Gemfile

@@ -1,4 +1,5 @@
 source 'https://rubygems.org'
+ruby <%= "'#{RUBY_VERSION}'" %>


Could you put this after the git_source entry?

albertoalmagro · 2017-07-31T17:53:50Z

@rafaelfranca Done. As it was a minor change I have already squashed commits. In case requested changes implied more lines, would you prefer first to review the changes? After it is done I would proceed squashing commits.

rafaelfranca

That is great! Could you add a CHANGELOG entry too and squash the commits?

albertoalmagro · 2017-07-31T18:07:36Z

Done. @rafaelfranca

guilleiguaran

Looking good, waiting for CI to merge 😊

deivid-rodriguez · 2017-07-31T18:52:00Z

railties/lib/rails/generators/rails/app/templates/Gemfile

@@ -1,5 +1,6 @@
 source 'https://rubygems.org'
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+ruby <%= "'#{RUBY_VERSION}'" %>


What about using ruby RUBY_VERSION here? Seems a bit DRYer.

I use this "trick", but I haven't tried it with heroku, so maybe it doesn't work well, not sure.

Thanks @deivid-rodriguez , I already tried that and generating the app with bundle exec rails new ~/my-test-app --dev caused the following error parsing the Gemfile:

[!] There was an error parsing `Gemfile`: unexpected fraction part after numeric literal - ruby 2.3.1 ^ /Users/alberto.almagro/my-test-app/Gemfile:3: syntax error, unexpected tIDENTIFIER, expecting end-of-input git_source(:github) { |repo| "https://github.com/#{repo}.git" } ^. Bundler cannot continue. # from /Users/alberto.almagro/my-test-app/Gemfile:2 # ------------------------------------------- # source 'https://rubygems.org' > ruby 2.3.1 # git_source(:github) { |repo| "https://github.com/#{repo}.git" } # -------------------------------------------

I've surrounded it with single quotes, which is what is used in the line above for the source entry.

Sorry @albertoalmagro, totally forgot to answer this. What I meant is not to generate ruby 2.3.1 without quotes, but to generate ruby RUBY_VERSION, which I think would be generated by using ruby RUBY_VERSION (wihout <%=, %> block).

This defeats the point of putting Ruby version in the Gemfile. Now any version you are using will be valid from 1.8.7 to 2.4.1.

I think we should revert this.

@schneems - I can't see how that would happen ~~as long as the .ruby_version file is committed~~. Am I missing something?

greysteil · 2017-08-09T11:28:28Z

Nice! Would you be up for reading the Ruby version out of the .ruby-version file, rather than having it duplicated? For example, like the ossfirday Gemfile does? I've seen applications get out-of-sync before...

Happy to put in a PR if so.

deivid-rodriguez · 2017-08-09T11:35:21Z

@greysteil What about ruby RUBY_VERSION? Is it something discouraged or not behaving as expected in some cases?

greysteil · 2017-08-09T12:04:16Z

@deivid-rodriguez interesting. It makes an assumption about the Ruby manager respecting the .ruby-version file, but that should basically always be the case. Just tested on Heroku and it works there, too, so I'd be 👍 on that change.

@albertoalmagro - any thoughts?

greysteil · 2017-08-09T12:12:20Z

I suppose one minor objection to the environment variable approach would be that it's less explicit where the Ruby version is being set. Might cause confusion, particularly for a newer developer? And if the .ruby-version file was deleted it would be left as a confusing remnant, rather than erroring.

robin850 · 2017-08-09T13:01:35Z

ISTM that having ruby RUBY_VERSION isn't really useful.

Locally, hard-coding the Ruby version inside the Gemfile prevents it from resolving if someone is trying to bundle install with the wrong version but ruby RUBY_VERSION will always resolve.

As for Heroku, the ruby call inside the Gemfile allows Heroku to automatically pick the specified version. It ensures that people have a similar set-up between their local environment and the production one.

greysteil · 2017-08-09T13:08:21Z

It should be useful - RUBY_VERSION will be set to whatever is in .ruby-version before Bundler evaluates the Gemfile. As a result, Bundler will still give us the behaviour we want (install scoped to specified Ruby version) and a test on Heroku shows that it does the same. So we get equivalent behaviour, but without the hardcoding.

Given the confusion, I'm not sure the environment variable approach is clear enough, though - I think I prefer reading the .ruby-version file explicitly in the Gemfile (which DRYs up what we have here, but is still ultra-explicit).

greysteil · 2017-08-09T13:11:50Z

I'll create a new PR so we're not spamming poor @albertoalmagro. This is still a rad contribution though - nice one @albertoalmagro.

albertoalmagro · 2017-08-09T13:31:46Z

Nice one @greysteil . Opportunities to learn something new and fresh ideas are never spam ;)

robin850 · 2017-08-09T15:23:05Z

RUBY_VERSION will be set to whatever is in .ruby-version before Bundler evaluates the Gemfile

Not everybody uses a Ruby version manager.

schneems · 2017-08-09T15:54:10Z

I use chruby which does not use the .ruby-version file. It would be better to have rbenv understand how to read the ruby version from Gemfile.lock.

I would like to revert this change.

schneems · 2017-08-09T21:30:43Z

I reverted the change a8f5904.

The good news is you get to keep your contributor points for contributors.rubyonrails.org !! Reverts don't actually remove a commit, it adds an extra "undo" commit that changes back all your changes.

Thanks for the PR, sorry I wasn't paying more attention before. It's always better to have people involved earlier than later. I appreciate all the effort that went into making this.

albertoalmagro · 2017-08-09T21:48:25Z

@schneems Lets get more on my next PR, which is already in CR. The most important thing is to make Rails better, thanks.

dhh · 2017-08-09T22:34:59Z

I think we've crossed wires here a bit. Given that I originally requested this feature, perhaps I was unclear with the rational. I'm fine with the fact that the version is duplicated between .ruby-version and Gemfile. Just as long as they're set by default.

If at some point rbenv learns to read the version from a Gemfile, then we can drop the .ruby-version. But until that I'd like that to stay.

dhh · 2017-08-09T22:37:35Z

Setting the Ruby version in the Gemfile just raises an exception if it doesn't match. You still need to ensure that the correct Ruby version is actually running, which is what .ruby-version supplies for rbenv and rvm.

dhh · 2017-08-09T22:39:44Z

I reverted the revert. Sorry for the confusion! Happy to drop .ruby-version if the day should come that rbenv and rvm support parsing the Gemfile to get the Ruby version. But it seems uncertain whether, and if so, when that would happen. In the mean time this will do.

…ult"" This reverts commit a8f5904. See discussion on #30016.

schneems · 2017-08-09T22:53:19Z

Ahh, yes. Sorry. I made the mistake here.

n-rodriguez · 2018-03-21T09:31:30Z

@dhh rvm already support Ruby version detection through Gemfile : https://rvm.io/workflow/projects#supported-files

headius · 2018-04-19T21:00:24Z

.ruby-version does not work the same way with JRuby and has led to #32639. It needs to be engine-engine_version to correctly be able to switch to JRuby.

I would strongly advocate against using .ruby-version, however, since we have many users on JRuby that use both JRuby and CRuby interchangeably for local development.

rafaelfranca · 2018-04-19T21:06:51Z

Those users can remove the file, if they want. I don't think we should avoid using a good feature that make sure everyone in the same project is using the same version of Ruby that works in 80% of the cases just because it doesn't work for 20%.

guilleiguaran · 2018-04-19T21:16:35Z

This .ruby_version is compatible with both CRuby and JRuby: #32649

headius · 2018-04-19T22:05:15Z

@rafaelfranca Fair enough...we'll see if anyone cares.

rafaelfranca · 2018-04-19T22:10:17Z

I mean, we should fix, with Guillermo PR, I don't think JRuby should be broken by default. I just think that the cases where you need to have different implementations, which is not common, should be handled differently.

One could say that if people want to use JRuby and CRuby for local development they can use rbenv shell feature (that I think have similars in the other version manager) to override the .ruby-version for the duration of the shell. This is what I do when upgrading Ruby for example in a repository that have a .ruby-version file.

Rails 5.2.0 will give us ActiveStorage and all sorts of other goodies: http://edgeguides.rubyonrails.org/5_2_release_notes.html rails/rails#30016 introduced `Rails::AppBuilder#ruby_version` to create a .ruby_version file. To avoid getting stuck in an overwrite prompt when we try to create our own .ruby_version file based on `Suspenders::RUBY_VERSION`, I overrode `ruby_version`. Rails 5.2.0 adds bootsnap to the Gemfile and to config/boot.rb. I added it to our Gemfile, but we could also `skip_bootsnap` by default if we don't want to use it.

Since rails#30016 Rails generates `.ruby-version` file in order to help Ruby version manager tools like `rbenv`, `rvm` determine which Ruby version should be used for the current Rails project. Since rails#32649 Rails sets Ruby version to the file compatible with MRI/JRuby by default. Pull Request rails#31496 reports that `.ruby-version` doesn't match ruby version other than stable version and recommends to use `ENV["RBENV_VERSION"]`, and `ENV["rvm_ruby_string"]` in order to set correct Ruby version to the file that `rbenv` or `rvm` can understand. Also, there is another similar issue that reports the same case if use JRuby jruby/jruby#5144. Closes rails#31496, jruby/jruby#5144.

This updates the version of ruby tested in the application to be ruby 2.6.0. This still relies on the `RUBY_VERSION` constant that's defined in ruby to know what version of ruby to include. This also removes the code that will add the ruby version to the Gemfile. Rails 5.2 will add the ruby version to the Gemfile for you, based on this contribution: rails/rails#30016.

This updates the version of ruby tested in the application to be ruby 2.6.1. This still relies on the `RUBY_VERSION` constant that's defined in ruby to know what version of ruby to include. This also removes the code that will add the ruby version to the Gemfile. Rails 5.2 will add the ruby version to the Gemfile for you, based on this contribution: rails/rails#30016. The latest Circle images utilize bundler >= 2, which is causing issues for the template install process. This circumvents that by modifying the image to remove the currently-installed version of bundler, and replacing it with a specific version that's known to work. Additional effort will be required to support bundler >= 2.

rails/rails#30016

Rails 5.2.0 will give us ActiveStorage and all sorts of other goodies: http://edgeguides.rubyonrails.org/5_2_release_notes.html rails/rails#30016 introduced `Rails::AppBuilder#ruby_version` to create a .ruby_version file. To avoid getting stuck in an overwrite prompt when we try to create our own .ruby_version file based on `Suspenders::RUBY_VERSION`, I overrode `ruby_version`. Rails 5.2.0 adds bootsnap to the Gemfile and to config/boot.rb. I added it to our Gemfile, but we could also `skip_bootsnap` by default if we don't want to use it.

rails-bot assigned schneems Jul 31, 2017

albertoalmagro mentioned this pull request Jul 31, 2017

Set Ruby version in Gemfile and .ruby-version by default #30007

Closed

rafaelfranca requested changes Jul 31, 2017

View reviewed changes

rafaelfranca approved these changes Jul 31, 2017

View reviewed changes

Set Ruby version in Gemfile and .ruby-version by default

fd7f978

guilleiguaran approved these changes Jul 31, 2017

View reviewed changes

deivid-rodriguez reviewed Jul 31, 2017

View reviewed changes

guilleiguaran merged commit 0d58e7e into rails:master Jul 31, 2017

greysteil mentioned this pull request Aug 9, 2017

DRY up Gemfile by reading Ruby version from .ruby-version file #30157

Closed

dhh added a commit that referenced this pull request Aug 9, 2017

Revert "Revert "Set Ruby version in Gemfile and .ruby-version by defa…

3645263

…ult"" This reverts commit a8f5904. See discussion on #30016.

ttanimichi mentioned this pull request Dec 18, 2017

Fix .ruby-version doesn't match ruby version other than stable version #31496

Closed

guilleiguaran mentioned this pull request Apr 19, 2018

Rails 5.2 generates apps for JRuby that switches rvm to CRuby #32639

Closed

composerinteralia mentioned this pull request May 2, 2018

Update to Rails 5.2.0 thoughtbot/suspenders#912

Closed

bogdanvlviv mentioned this pull request Jun 18, 2018

Fix Ruby version in .ruby-version #33152

Merged

kevin-j-m mentioned this pull request Aug 14, 2018

Bump Rails to 5.2.1 TheGnarCo/gnarails#118

Merged

viktorsmari mentioned this pull request Oct 17, 2018

Add docker compose support coopdevs/timeoverflow#441

Closed

brettgoss mentioned this pull request Dec 25, 2018

Update local setup damwhit/harvest_helper#52

Merged

kevin-j-m mentioned this pull request Jan 10, 2019

Upgrade ruby to 2.6.0 TheGnarCo/gnarails#131

Closed

kevin-j-m mentioned this pull request Feb 18, 2019

Upgrade ruby to 2.6.1 TheGnarCo/gnarails#134

Merged

frankywahl added a commit to mydots/railsrc that referenced this pull request Aug 26, 2021

Remove .ruby-version creation

fc75e7e

rails/rails#30016

yahonda mentioned this pull request Sep 9, 2022

Support prerelease rubies in Gemfile template #45979

Merged

9 tasks

Set Ruby version in Gemfile and .ruby-version by default #30016

Set Ruby version in Gemfile and .ruby-version by default #30016

albertoalmagro commented Jul 31, 2017

rails-bot commented Jul 31, 2017

rafaelfranca Jul 31, 2017

albertoalmagro commented Jul 31, 2017

rafaelfranca left a comment

albertoalmagro commented Jul 31, 2017

guilleiguaran left a comment

deivid-rodriguez Jul 31, 2017

deivid-rodriguez Jul 31, 2017

albertoalmagro Jul 31, 2017 •

edited

deivid-rodriguez Aug 9, 2017

schneems Aug 9, 2017

greysteil Aug 9, 2017 •

edited

greysteil commented Aug 9, 2017 •

edited

deivid-rodriguez commented Aug 9, 2017

greysteil commented Aug 9, 2017 •

edited

greysteil commented Aug 9, 2017

robin850 commented Aug 9, 2017

greysteil commented Aug 9, 2017 •

edited

greysteil commented Aug 9, 2017

albertoalmagro commented Aug 9, 2017

robin850 commented Aug 9, 2017

schneems commented Aug 9, 2017 •

edited

schneems commented Aug 9, 2017

albertoalmagro commented Aug 9, 2017

dhh commented Aug 9, 2017

dhh commented Aug 9, 2017

dhh commented Aug 9, 2017 •

edited

schneems commented Aug 9, 2017

n-rodriguez commented Mar 21, 2018

headius commented Apr 19, 2018

rafaelfranca commented Apr 19, 2018

guilleiguaran commented Apr 19, 2018

headius commented Apr 19, 2018

rafaelfranca commented Apr 19, 2018

		@@ -1,4 +1,5 @@
		source 'https://rubygems.org'
		ruby <%= "'#{RUBY_VERSION}'" %>

Set Ruby version in Gemfile and .ruby-version by default #30016

Set Ruby version in Gemfile and .ruby-version by default #30016

Conversation

albertoalmagro commented Jul 31, 2017

Summary

Implications

rails-bot commented Jul 31, 2017

rafaelfranca Jul 31, 2017

Choose a reason for hiding this comment

albertoalmagro commented Jul 31, 2017

rafaelfranca left a comment

Choose a reason for hiding this comment

albertoalmagro commented Jul 31, 2017

guilleiguaran left a comment

Choose a reason for hiding this comment

deivid-rodriguez Jul 31, 2017

Choose a reason for hiding this comment

deivid-rodriguez Jul 31, 2017

Choose a reason for hiding this comment

albertoalmagro Jul 31, 2017 • edited

Choose a reason for hiding this comment

deivid-rodriguez Aug 9, 2017

Choose a reason for hiding this comment

schneems Aug 9, 2017

Choose a reason for hiding this comment

greysteil Aug 9, 2017 • edited

Choose a reason for hiding this comment

greysteil commented Aug 9, 2017 • edited

deivid-rodriguez commented Aug 9, 2017

greysteil commented Aug 9, 2017 • edited

greysteil commented Aug 9, 2017

robin850 commented Aug 9, 2017

greysteil commented Aug 9, 2017 • edited

greysteil commented Aug 9, 2017

albertoalmagro commented Aug 9, 2017

robin850 commented Aug 9, 2017

schneems commented Aug 9, 2017 • edited

schneems commented Aug 9, 2017

albertoalmagro commented Aug 9, 2017

dhh commented Aug 9, 2017

dhh commented Aug 9, 2017

dhh commented Aug 9, 2017 • edited

schneems commented Aug 9, 2017

n-rodriguez commented Mar 21, 2018

headius commented Apr 19, 2018

rafaelfranca commented Apr 19, 2018

guilleiguaran commented Apr 19, 2018

headius commented Apr 19, 2018

rafaelfranca commented Apr 19, 2018

albertoalmagro Jul 31, 2017 •

edited

greysteil Aug 9, 2017 •

edited

greysteil commented Aug 9, 2017 •

edited

greysteil commented Aug 9, 2017 •

edited

greysteil commented Aug 9, 2017 •

edited

schneems commented Aug 9, 2017 •

edited

dhh commented Aug 9, 2017 •

edited