【頻出】mysql2 gemがインストールに失敗したときの解決方法

問題

railsではmysql2のgemはよく使うのですが、これよくビルドに失敗するんですよね。

全部のプロジェクトがDocker化されていて、環境をPortableにする仕組みが整っていれれば素晴らしいのですが、現実はそのようにはいきません。

なのでいくつかのプロジェクトでは、Mac環境下でRails開発を行っていくことになります。

この記事では、gem mysql2をbundle installしようとしたときにコンパイルに失敗してbundle installが完了できない問題の解決策を書きます。

解決プロセス

コマンドで brew info openssl を打ちます

openssl@1.1: stable 1.1.1d (bottled) [keg-only]
Cryptography and SSL/TLS Toolkit
https://openssl.org/
/usr/local/Cellar/openssl@1.1/1.1.1d (7,983 files, 17.9MB)
Poured from bottle on 2019-09-25 at 12:59:29
From: https://github.com/Homebrew/homebrew-core/blob/master/Formula/[e-mail]
==> Caveats
A CA file has been bootstrapped using certificates from the system
keychain. To add additional certificates, place .pem files in
/usr/local/etc/openssl@1.1/certs

and run
/usr/local/opt/openssl@1.1/bin/c_rehash

openssl@1.1 is keg-only, which means it was not symlinked into /usr/local,
because openssl/libressl is provided by macOS so don't link an incompatible version.

If you need to have openssl@1.1 first in your PATH run:
echo 'export PATH="/usr/local/opt/openssl@1.1/bin:$PATH"' >> ~/.zshrc

For compilers to find openssl@1.1 you may need to set:
export LDFLAGS="-L/usr/local/opt/openssl@1.1/lib"
export CPPFLAGS="-I/usr/local/opt/openssl@1.1/include"

For pkg-config to find openssl@1.1 you may need to set:
export PKG_CONFIG_PATH="/usr/local/opt/openssl@1.1/lib/pkgconfig"

==> Analytics
install: 410,459 (30 days), 1,382,523 (90 days), 3,038,465 (365 days)
install-on-request: 63,098 (30 days), 183,588 (90 days), 495,271 (365 days)
build-error: 0 (30 days)

ご丁寧にコンパイラがOpenSSLを見つけるためのパスが書いてあります。

export LDFLAGS="-L/usr/local/opt/openssl@1.1/lib"
export CPPFLAGS="-I/usr/local/opt/openssl@1.1/include"

この部分ですね。

bundle configの設定の修正&再ビルド

$ bundle config --local build.mysql2 "--with-ldflags=-L/usr/local/opt/openssl@1.1/lib"
$ bundle config --local build.mysql2 "--with-cppflags=-I/usr/local/opt/openssl@1.1/include"

これでMySQLを動かすための準備は整ったので、改めて bundle installで通せば完了！