rbenvでRubyバージョンを切り替え後インストールしたGemを実行できない

Ruby3の挙動を確かめるためrbenvでRubyのバージョンを切り替えたとき、インストールしたGemを実行できない事象があったので対応方法などをメモしておきます。

rbenv 1.1.2

事象の再現

普段はRuby2.7.3を使っている。Ruby3を試すために、任意のディレクトリで下記を実行。

$ rbenv local 3.0.2
$ ruby -v
ruby 3.0.2p107

型チェックのためにtypeprofなどが必要なので、インストールして実行しようとするがcommand not foundのエラーとなる。

$ gem install typeprof
$ typeprof xxx.rb
zsh: command not found: typeprof

対応

結論としては、rbenv rehashを実行する必要があった。またrbenv rehash実行にあたり、下記エラーが発生したため、.rbenv-shimを削除する対応をとった。

$ rbenv rehash
rbenv: cannot rehash: /usr/local/var/rbenv/shims/.rbenv-shim exists
$ cd /Users/xxx/.rbenv/shims
$ rm .rbenv-shim
$ rbenv rehash

rbenvの仕組みなどをちゃんと調べてこなかったので、以下ではrbenvの仕組みやrehashが何をしているのかについて調べた内容をメモしている。

Shimsとはなにか

公式のREADMEに記載がある。

rbenv/rbenv: README

  • rbenvはPATHの先頭にshimsのディレクトリを追加する
  • インストールされた全てのバージョンのRubyコマンドにマッチするshimをディレクトリに維持する。

rehashは何をするのか

rbenv rehash コマンドを実行すると、大まかには ~/.rbenv/versions/*/bin/ 以下のファイルを ~/.rbenv/shims/ 以下にコピーする。

rbenv rehashをちゃんと理解する

# List basenames of executables for every Ruby version
list_executable_names() {
  local version file
  rbenv-versions --bare --skip-aliases | \
  while read -r version; do
    for file in "${RBENV_ROOT}/versions/${version}/bin/"*; do
      echo "${file##*/}"
    done
  done
}

rbenv/rbenv-rehash at master · rbenv/rbenv

gem install hogeを実行したときには、rehashが自動で実行される。もともとはrbenv/rbenv-gem-rehashというプラグインがこれを担っていた。現在はDEPRECATEDとなっていて、現在はrbenvの中に移植されている。

rbenv/rubygems_plugin.rb at master · rbenv/rbenv

なのでgem installを実行するたびにrehashを実行しなくてもそのGemを使用できる状態となる。

一時ファイル.rbenv-shim

rehashのプロセスでは並列で実行されないように、一時ファイル.rbenv-shimを作成する。rbenv rehashを実行したとき、この一時ファイルが存在すると失敗するような挙動となっている。

During the rehash process, rbenv writes out the temporary file .rbenv-shim to indicate that the rehash is in progress. Then, if a parallel rbenv rehash process tries to run at the same time, it will fail because the file already exists. This guards against race conditions in parallel rehashes.

https://github.com/rbenv/rbenv/issues/759#issuecomment-124748535

今回の事象について

  • 何らかの理由で本来削除されるはずの一時ファイル.rbenv-shimが残ったままとなっていた。
  • gem install typeprofを実行したとき、Gemのインストールは正常終了したが、rbenv rehashは失敗していた。
    • rehashに失敗しているので、~/.rbenv/shims/にコピーが作成されておらず実行できなかった。

なので.rbenv-shimを削除して、rbenv rehashを実行すると~/.rbenv/shims/以下に正しくコピーが作成された状態となるため、動作するようになった。

Source code