在 Gemfile 和 .ruby-version Dotfile 中列出 Ruby 版本是一种不好的做法吗？

Posted 2023-02-15

【中文标题】在 Gemfile 和 .ruby-version Dotfile 中列出 Ruby 版本是一种不好的做法吗？

【英文标题】：Is It A Bad Practice to List Ruby Version in Both Gemfile and .ruby-version Dotfile?

【发布时间】：2016-01-01 06:52:08

【问题描述】：

我最新的 Rails 项目或多或少是为了让我尝试打破很多东西并在此过程中学习。我的 gemfile 中指定了最新版本的 Ruby：

ruby '2.2.3'

而且我在项目中还有一个.ruby-version dotfile，内容如下：

2.2.3

除了明显的重复之外，这有什么问题？这两个公约的目的是什么？如果我应该只有一个约定来列出我的 Ruby 版本，为什么我应该有一个（Gemfile）而不是另一个（dotfile）？

在一个项目中同时拥有这两种约定是否完美？

我将成为这个实验项目的唯一维护者，我不觉得维护这个微妙的重复会是个问题。我不打算为这个项目升级 Ruby，如果我这样做，我不会有记住在这两个地方都这样做的问题。除了这个细节之外，我当然会避免在我的应用程序代码库中出现任何此类重复。

【问题讨论】：

我认为您根本不需要在 Gemfile 中指定 ruby​​ 版本。

Afaik .ruby-version 为 RVM 或 rbenv 设置 Ruby 版本，但 Heroku 例如从 Gemfile (source) 获取 Ruby 版本。

谢谢@spickermann，听起来两者兼备是个好主意。

【参考方案1】：

我认为最好避免两次列出相同的信息，除非有充分的理由 - 即保持干燥。

您可以将 ruby​​ 版本存储在“.ruby-version”中，然后在 Gemfile 中执行以下操作：

ruby File.read('.ruby-version').strip

我最初发布了以下内容，然后 collimarco 将其缩短为上述内容：

ruby File.open('.ruby-version', 'rb')  |f| f.read.chomp 

如果您这样做，那么每当您更改 .ruby-version 时，Gemfile 都会神奇地做同样的事情。

【讨论】：

这太干了，很烦人。无论如何，您都需要手动更改 .ruby-version 中的版本，用您最喜欢的编辑器替换多个实例是微不足道的。

@Dennis 这就是 DRY 的全部意义所在。有人可能会忘记进行搜索替换。此代码告诉您我想使用与 .ruby-version 中相同的版本

这个比较简洁和等价：ruby File.read('.ruby-version', mode: 'rb').chomp

查看this article 中的“DRY 的谬误”部分。我同意，这太干了，很烦人！

这对于空白来说更加干燥和可靠：ruby File.read('.ruby-version').strip

【参考方案2】：

在您的Gemfile 中使用它：

ruby File.read('.ruby-version').strip

优点：

干燥 您不要忘记更新其中一个文件中的版本 它确保您始终运行正确的版本。

【参考方案3】：

它们分别由不同的团队在不同的时间开发，并被不同的软件使用。

在 Gemfile 中列出的 ruby​​ 版本是 feature in bundler。

由于 Gemfile 主要仅由 bundler 使用，因此它主要只会在您运行 with bundler 时产生影响——使用bundle exec 或自动为您触发 bundler 的软件（如 Rails）。如果您没有使用指定的 ruby​​ 版本，它的效果只是出错并拒绝运行。这是一个要求——在这个 ruby​​ 下运行，否则我会抛出一个错误警告你在错误的 ruby​​ 下运行。

但是，heroku also pays attention 到 Gemfile 中指定的版本，并将在该版本下运行。 Heroku 也决定在 bundler 中使用该功能。但是您的工作站上的大多数其他软件，甚至travis，都不使用该约定。 （Travis 让您编辑 .travis.yml ENV 以指定要使用的 ruby​​ 版本）。

Bundler 中的功能于 2012 年 8 月在 Bundler 1.2 中引入。

.ruby-version 文件是由第一个 ruby​​ 版本管理器rvm 首次引入的。如果您使用的是 rvm，并且您切换到带有 .ruby-version 文件的项目目录，rvm 将自动切换您的 shell 以使用指定的 ruby​​ 版本。

我不确定 rvm 何时引入此功能，但我认为是在 Gemfile 的“ruby”功能之前。

自从 rvm 引入它之后，其他 ruby​​ 版本切换软件如 rbenv 和 chruby 也采用了它来做同样的事情——当你 cd 进入目录时自动切换到指定的 ruby​​ 版本。虽然我认为 rbenv 和 chruby 都可能是一个可选功能。

所以它们是不同的软件包在不同的时间引入和支持的不同功能，做的事情有些不同。

我同意维护两者并保持同步会很烦人。

它们实际上都是可选的，你不需要使用任何一个。除了您可能需要使用 Heroku 的 Gemfile ruby​​ 规范，告诉它您希望它运行哪个 ruby​​。

我个人也不使用。但是，如果您需要在不同的项目中使用不同的 ruby​​ 版本，并且发现让您的 ruby​​ 版本管理器（rvm、rbenv 或 chruby）自动切换到正确的项目特定的 ruby​​ 版本很方便，.ruby-version 可能会很有用。

除了 heroku 的目的，在 Gemfile 中列出 ruby​​ 主要是为了防止自己犯错误，例如在部署时。或者，内部自动化部署或 CI 环境可能会像 heroku 一样使用它们，或者其他云部署堆栈将会或已经采用它。我认为许多人发现它并不太有用——这个也是，我不会使用，直到你遇到或看到它正在解决的问题。有些人在 Gemfile 中列出 ruby​​ 版本时遇到的一个不便是，随着新的 ruby​​ 总是出现，您必须一直更新所有 Gemfile。

总的来说，过去几年的 ruby​​ 版本都非常向后兼容，限制了确保您使用的是 ruby​​ 的确切版本的需要，最新的代码将在最新的 ruby​​ 上运行，即使它最初是为一个年长的人写的。

我不相信这两个功能都可以让您指定一系列 ruby​​ 版本，例如 2.2.* 或您有什么。

使用其中一个/两个功能，仅在您需要它们或发现它们有用时才使用它们，您不必使用任何一个，如果您需要两者都使用，则可以同时使用它们（如果烦人）。

由于 Gemfile 是实时 ruby​​ 代码，理论上您可以让 Gemfile 读取您的 .ruby-version 文件并自动将该值用作 Gemfile ruby 值。如果您想同时使用两者，并且“不要重复自己”。我不知道这是否是一种常见的事情，我只是想到了它。但它应该可以正常工作。

【讨论】：

感谢您的详尽回答。

另外，我在这里有一个可能相关的问题：***.com/questions/34905560/…，你是否愿意再次提供这样的智慧:)

也许值得一提的是 RVM 实际上也支持 Gemfile 方法。我不确定为什么有人使用.ruby-version

啊哈，当我写这篇文章时，我认为 RVM 还不支持在 Gemfile 中使用 ruby​​ 版本，我不知道它支持（我目前不是 RVM 用户）。