Encoding.default_internal と Encoding.defaut_external を翻訳します

[ima1zumi]

解決すること

Encoding.default_internal と Encoding.defaut_external は英語版ドキュメントに比べ情報量が少ないため、英語版を翻訳しました。
ただし一部英語版から削っています。

また、Ruby 3.0 対応もとりこみました。 ref: #2458
Feature #16604: Set default for Encoding.default_external to UTF-8 on Windows - Ruby master - Ruby Issue Tracking System

削除箇所

英語版から、このオブジェクトにはデフォルトで Encoding.default_internal と Encoding.default_external が使用される…という説明を削除しています。

例えば、英語版に書いてある Time#zone $PROGRAM_NAME は rdoc の説明と異なり Encoding.default_internal が適用されません。
また、列挙されている以外に Encoding.default_internal Encoding.default_external が使用されるオブジェクトがあるか不明でした。
ドキュメントに列挙するオブジェクトだけが Encoding.default_internal Encoding.default_external が使用されるかのような紛らわしい記述になりうるため意図的に削除しています。

検証コード

$PROGRAM_NAME と Time#zone が Encoding.default_internal に影響されないこと、 ARGV ENV は影響されること

サンプル.rb

puts "default_internal is #{Encoding.default_internal}"
puts "ARGV[0] encoding is #{ARGV[0].encoding}"
puts "$PROGRAM_NAME encoding is #{$PROGRAM_NAME.encoding}"
puts "ENV encoding is #{ENV['PATH'].encoding}"
puts "Time#zone encoding is #{Time.new.zone.encoding}"

実行結果

❯ ruby -E:sjis サンプル.rb ほげ
default_internal is Windows-31J
ARGV[0] encoding is Windows-31J
$PROGRAM_NAME encoding is UTF-8
ENV encoding is Windows-31J
Time#zone encoding is US-ASCII

[[m:String#encode]] と [[m:String#encode!]] は、引数に Encoding が与えられていない場合、 default_internal を使用します。

Encoding.default_internal = Encoding::SJIS

str = 'hoge'
p str.encoding
# => #<Encoding:UTF-8>
p str.encode.encoding
# => #<Encoding:Windows-31J>
p str.encode!.encoding
# => #<Encoding:Windows-31J>

スクリーンショット

修正前

修正後

リンク

class Encoding - Documentation for Ruby 3.0.0
class Encoding (Ruby 3.0.0 リファレンスマニュアル)

[znz]

__ENCODING__ 特殊変数で参照できるスクリプトエンコーディング のように「スクリプトエンコーディング」という言葉を入れると良さそうです。

[ima1zumi]

そうですね！77aa3b8 で追加しました。

[ima1zumi]

読み直して少し加筆しました。 b0f9e86

[znz]

「等」と「など」が重複しているので、「open で開くファイルなどで、」のように「標準入出力、コマンドライン引数、open で開くファイル」だけに「など」をつければ良さそうに思いました。

[ima1zumi]

#2578 (comment) 消しました！

ce74730