Windows環境で日本語を含むRDocが生成できない場合

発生した問題

日本語が含まれるRDocをWindows環境で生成しようとすると、"No newer files."と表示され、docディレクトリにcreated.ridというファイルが作成されるだけで、それ以外何も出力されない。

以下はその実行例。

money.rb

# お金を表すクラスです。
class Money
end

>rdoc money.rb
Parsing sources...
100% [ 1/ 1]  lib\gate.rb

No newer files.

  Files:      1

  Classes:    0 (0 undocumented)
  Modules:    0 (0 undocumented)
  Constants:  0 (0 undocumented)
  Attributes: 0 (0 undocumented)
  Methods:    0 (0 undocumented)

  Total:      0 (0 undocumented)
    0.00% documented

  Elapsed: 0.0s

>dir doc
 ドライブ C のボリューム ラベルがありません。
 ボリューム シリアル番号は DCBD-3B40 です

 C:\Users\JunichiIto\ruby-book\doc のディレクトリ

2017/06/17  10:22    <DIR>          .
2017/06/17  10:22    <DIR>          ..
2017/06/17  10:22                 0 created.rid
               1 個のファイル                   0 バイト
               2 個のディレクトリ  45,016,821,760 バイトの空き領域

ただし、RDocを英語だけにすると、ちゃんとRDocが生成される。

money.rb

# This is money.
class Money
end

>rdoc money.rb
Parsing sources...
100% [ 1/ 1]  .\money.rb

Generating Darkfish format into C:/Users/JunichiIto/ruby-book/doc...

  Files:      1

  Classes:    1 (0 undocumented)
  Modules:    0 (0 undocumented)
  Constants:  2 (2 undocumented)
  Attributes: 0 (0 undocumented)
  Methods:    4 (4 undocumented)

  Total:      7 (6 undocumented)
   14.29% documented

  Elapsed: 0.2s

問題が発生した環境

• Windows 10 Home 日本語版
• Ruby 2.4.1（RubyInstallerでインストール）
• RDoc 5.0.0（rdoc --versionで確認）

原因

RDoc 5.0.0の不具合っぽい。

参考

このpull reqで修正？

• fix an issue that rdoc fails when running on Windows with RUBYOPT=-U by dogatana · Pull Request #430 · rdoc/rdoc

解決策

RDocの最新版をインストールする。

>gem install rdoc
Fetching: rdoc-5.1.0.gem (100%)
rdoc's executable "rdoc" conflicts with C:/Ruby24-x64/bin/rdoc
Overwrite the executable? [yN]  y
rdoc's executable "ri" conflicts with C:/Ruby24-x64/bin/ri
Overwrite the executable? [yN]  y
Successfully installed rdoc-5.1.0
Parsing documentation for rdoc-5.1.0
Installing ri documentation for rdoc-5.1.0
Done installing documentation for rdoc after 11 seconds
1 gem installed

>rdoc --version
5.1.0

RDoc 5.1.0以上であれば、日本語が含まれている場合でもRDocが生成される。

money.rb

# お金を表すクラスです。
class Money
end

>rdoc money.rb
Parsing sources...
100% [ 1/ 1]  .\money.rb

Generating Darkfish format into C:/Users/JunichiIto/ruby-book/doc...

  Files:      1

  Classes:    1 (0 undocumented)
  Modules:    0 (0 undocumented)
  Constants:  2 (2 undocumented)
  Attributes: 0 (0 undocumented)
  Methods:    4 (4 undocumented)

  Total:      7 (6 undocumented)
   14.29% documented

  Elapsed: 0.2s

よかった