:pぴー.sendせんど(:pぴー, :pぴー)

Dirクラス IOクラス Fileクラス

Ruby技術者認定試験の書籍写経メモ

• この辺りは駆け足で進みます
• 書籍もおざなりな説明で理解が進まない悔しい
• 中の人も同じ気持ちなんだとは思う

Dirクラス

ディレクトリの移動、作成、ファイル一覧など、ディレクトリを扱うクラス

ディレクトリを開く

それは Dirクラスのインスタンスを取得する という事

dir = Dir.open('/usr/local/bin')
=> #<Dir:/usr/local/bin>

ファイル一覧の取得

dir = Dir.open('/usr/local/bin')

dir.each do |path|
  p path
end
# 大量のパスが表示される

開いたパスはちゃんと閉じる

Dir以外でも言える事だとは思うが、パスの開きっぱなしはファイルディスクリプタがどうのとか、絶対によろしくないのでちゃんと閉じる

dir = Dir.open('/usr/local/bin')

dir.close

ていうか、Dir#openメソッドはブロックを取ることができ、ブロックが終了したら自動的にcloseしてくれるので、それ以外の書き方は積極的に使う理由がない場合は使わないようにしましょう

Dir.open('/usr/local/bin') do |dir|
  dir.each do |path|
    p path
  end
  # 大量のパスが表示される
end

カレントディレクトリの取得

Dir.pwd
=> "/Users/mokoaki"

Dir.getwd
=> "/Users/mokoaki"

カレントディレクトリを移動する

Dir.chdir メソッド

• カレントディレクトリを引数で指定したディレクトリに変更する
• 指定がない場合、環境変数HOME, LOGDIRが設定されていればそのディレクトリに移動する
• ブロックが渡された場合は、ブロック終了時に元のディレクトリに戻る

Dir.chdir('/Users/mokoaki')
=> 0

Dir.pwd
=> "/Users/mokoaki"

Dir.chdir('/usr/local/bin') do |_dir|
  p Dir.pwd
end
=> "/usr/local/bin"

Dir.pwd
=> "/Users/mokoaki"

ディレクトリの作成

適当にこんな感じだよくらいで

Dir.mkdir('ディレクトリパス')

Dir.mkdir('ディレクトリパス', 0755)

ディレクトリの削除

適当にこんな感じだよくらいで

Dir.rmdir('ディレクトリパス')
Dir.unlink('ディレクトリパス')
Dir.delete('ディレクトリパス')

Fileクラス

IOクラスの子クラスであり、ファイルの読み取り、書き込み、新規作成、削除などファイルを扱うクラス

ファイルを開く

• File.new, File.open でファイルが開く事ができる
• それは Fileクラスのインスタンスを取得する という事
• File#read でファイル内容を読み込む
• もちろんcloseを忘れずに

file = File.new('README.txt')

file.read
=> "aaaaaaa"

file.close

もちろんブロックが使えるので、以降はブロックを使ってclose忘れが無いようにしましょう

File.open('README.txt') do |file|
  p file.read
end
=> "aaaaaaa"

ファイルを開く時のモード

File.open 時の第2引数はモードを指定できます

モードの後ろに読み込み時のエンコーディング、内部処理のエンコーディングを指定できる

# 外部（読み込むファイル）はshift_jis
# 内部処理はUTF-8
# のような指定ができる

# file = File.open('shift_jis.txt', 'r:shift_jis:utf-8')

# file.read
# => "UTF-8の文字列"

ファイルに書き込む時にも同様な指定ができる

# 外部（書き込むファイル）はshift_jis
# 内部処理はEUC-JP
# のような指定ができる

# file = File.open('shift_jis.txt', 'w+:shift_jis:euc-jp')

# file.write("EUC-JPからSHIFT_JISへ変換される文字列".encode('euc-jp'))

# file.read
# => "EUC-JPからSHIFT_JISへ変換される文字列" # shift_jisに変換されて書き込まれる

ファイルに書き込む

もう上記しちゃいましたけど File#write でファイルに書き込めます。

他にも同じようなメソッドはあるので IO 辺りで説明します

file.write('書き込みたい内容')

入出力時のエンコーディング

詳しくは IO の辺りで説明します

Encoding.default_external
=> #<Encoding:UTF-8>

File.open('README.txt') do |file|
  p file.read.encoding
end
=> #<Encoding:UTF-8>

ファイルの内容を読み込む他のメソッド

File#read 以外にも gets readlines メソッドなどがあります、 IO の辺りで説明します

ファイルの属性を取得する

クラスメソッドとインスタンスメソッド、どっちにもあったりする。評価結果は同一

他にもメソッドはいっぱいある

ファイルの属性を設定する

他にもメソッドはいっぱいある

ファイルの最終アクセス時刻、更新時刻を設定する

これはFileのクラスメソッドを使います（おそらく他にもある）

File.utime(Time.now, Time.now, 'README.txt')

ファイルをテストする

• 存在確認、ディレクトリなのかファイルなのかの判定などたくさんのメソッドがあります
• これらは FileTestモジュールのメソッドと同じものです リファレンスに一度目を通しておくといいでしょう
• 同じメソッドが別のクラスから使える、と言うのは逆に言うと、今どのクラスのメソッドを使っているのか迷子になりそうだと言うことです

しかも、他にもメソッドはいっぱいある

ファイルのパスを絶対パスに展開する

カレントからの相対位置を絶対パスに変換するって事かね？

File.expand_path('README.txt')
=> 'full_path/README.txt'

ファイルを削除する

ファイルを切り詰める

fileオブジェクトのインスタンスメソッドにもあるようです

ファイル名をリネームする

ファイルをロックする

ぶっちゃけ、システムに依存してるらしく、「ぐぐれ」だそうです

連結してファイルパスを作る

• File::SEPARATOR（ぶっちゃけ “/”）を間に入れて文字列を連結します
• ”//” みたいにならないようにいい感じしてくれます

File.join('a')
=> "a"

File.join('a', 'b')
=> "a/b"

File.join('a', 'b', '/')
=> "a/b/"

File.join('/', 'a', '/', 'b', '/')
=> "/a/b/"

File.join('/', '/', 'a', '/', '/', 'b', '/', '/')
=> "/a/b/"

IOクラス

• ファイルやプロセスなどの基本的な入出力を備えたクラス
• STDIN(標準入力) STDOUT(標準出力) STDERR(標準エラー出力) もこのIOクラスのオブジェクト
• Fileクラスのスーパークラスでもあります

IOを開く

• 「ファイルを開くにはKernelモジュールのopenメソッドを使います」
• 「IO.openメソッドでも同様にファイルを開くことができます」

どれを使えばいいのよ・・そしてIO.openはエラーになるんだけど・・

• モードやエンコーディングを指定したい時は このあたり を参照

path = 'README.txt'

open(path)
=> #<File:/Users/mokoaki/.../README.md>

Kernel.open(path)
=> #<File:/Users/mokoaki/.../README.md>

File.open(path)
=> #<File:/Users/mokoaki/.../README.md>

IO.open(path)
=> TypeError: no implicit conversion of String into Integer

IOクラスを使ってコマンドの実行結果を得る

• openメソッドで

  に続いてコマンドを指定するとコマンドの出力結果を得ることができる

• IOオブジェクトが返る
• IOオブジェクトを読むにはreadメソッド
• 入力のエンコーディングが設定されていない場合は Encoding.default_external が使用される

io = open('| pwd')
=> #<IO:fd 16>

io_read = io.read
=> "/Users/mokoaki\n"

io_read.encoding
=> #<Encoding:UTF-8>

IOオブジェクトに書き込む

には、writeメソッドを使う

STDOUT.write('123456789')
123456789=> 9

IOオブジェクトを閉じる

io = open('| pwd')
io.close

ていうか、閉じ忘れ防止の為にブロック使ってね

open('| pwd') do |io|
  io.read
end

パイプを開く

• IO.popenメソッドを使うとコマンドをサブプロセスとして実行し、そのプロセスと入出力のパイプを開く事ができます

お、おう、動かないんですけど・・

IO.popen('grep -i ruby') do |io|
  io.write('I am a ruby process')
  io.close_write

  p io.read
end

• close_write メソッドは書き込み用のIOを閉じるメソッド
• close_read メソッドは読み込み用のIOを閉じるメソッド

あぁ、辛い

IOからの入力

• readメソッドで長さを指定したときのみバイナリ読み込みとなる為、エンコーディングがASCII-8BITとなる
• それ以外は
  • IOオブジェクトに内部エンコーディングが指定されているなら外部エンコーディングから内部エンコーディングへ変換される
  • IOオブジェクトに内部エンコーディングが指定されていないなら外部エンコーディングが内部エンコーディングで使用される
• IO.read とio#read は共にIOから内容を読み込みます。長さが指定されているならその長さだけ読み込みます

read メソッド

IO.read(path, 10).encoding
=> #<Encoding:ASCII-8BIT>

IO.foreach io#each io#each_lines メソッド

1行毎にブロックに渡して評価する

IO.foreach(path) do |line|
  p line
end

open(path) do |io|
  io.each do |line|
    p line
  end
end

io#readlines メソッド

各行を直接配列で取得

open(path) do |io|
  io.readlines
end

io#readline io#gets メソッド

メソッド実行の度に1行読み込む

open(path) do |io|
  io.readline #=> "1行目"
  io.gets #=> "2行目"
end

open('| ls') do |io|
  p io.readline #=> "1行目"
  p io.gets #=> "2行目"
  p io.readline #=> "3行目"
end

io#each_byte メソッド

1バイト毎にブロックに渡して評価する

open(path) do |io|
  io.each_byte do |byte|
    p byte
  end
end

io#getbyte io#readbyte メソッド

メソッド実行の度に1バイト読み込む

open(path) do |io|
  io.getbyte #=> "1バイト目"
  io.getbyte #=> "2バイト目"
end

io#each_char メソッド

1文字毎にブロックに渡して評価する

open(path) do |io|
  io.each_char do |char|
    p char
  end
end

io#getc io#readchar メソッド

メソッド実行の度に1バイト読み込む

open(path) do |io|
  io.getc #=> "1文字目"
  io.getc #=> "2文字目"
end

空ファイルやEOFになった時の振る舞い

上記の読み込みメソッド達は同じような処理内容で名前が違うメソッドがありますが、ファイル末端に達したときや空ファイルだった時の振る舞いが違ったりします

こんなん暗記するのは無理

IOへの出力

io#write メソッド

• IOに対して文字列を出力する
• 引数が文字列以外なら to_s される
• 戻り値は出力したバイト数

STDOUT.write('12345')

io#puts メソッド

• 複数の文字列、配列を引数に取り、IOに対して文字列を出力する
• 引数が文字列、配列以外なら to_ary.to_s される
• 各文字列毎に「$,」が入る（？
• 戻り値はnil

STDOUT.puts('12345')
STDOUT.puts('12345', '67890')
STDOUT.puts(['12345'])
STDOUT.puts(['12345'], ['67890'])

io#print メソッド

• 複数の文字列、配列を引数に取り、IOに対して文字列を出力する
• 引数が文字列、配列以外なら to_ary.to_s される
• 各引数毎に「$,」が入る（？
• 「$\」が設定されていたなら最後に出力（？
• 戻り値はnil

STDOUT.print('12345')
STDOUT.print('12345', '67890')
STDOUT.print(['12345'])
STDOUT.print(['12345'], ['67890'])

io#printf メソッド

• 指定されたフォーマットに従って引数の値を出力する
• ぐぐれとの事
• 戻り値はnil

STDOUT.printf('%010d', 123456)

io#putc メソッド

• 1バイトの文字を出力する
• 引数が文字列の場合は先頭の1バイト
• 引数が数値の場合は対応する文字
• どちらでも無い場合はto_intで整数化を図る
• 戻り値は出力した文字

STDOUT.putc('a')

io#<< メソッド

• 指定したオブジェクトを出力
• 戻り値は自分自身（つまり、メソッドチェーン可能）

STDOUT << 'a' << 'b'

io#flush メソッド

ioへの出力は一旦内部バッファへ蓄えられるので明示的にio出力させる

open(path) do |io|
  io.write('a')

  io.flush
end

IOオブジェクトの状態を調べる

io#stat メソッド

• IOオブジェクトの状態を返す File::Statオブジェクトを返す
• ぐぐれ

io#closed? メソッド

既に閉じられているかどうか

io#eof io#eof? メソッド

IO末端かどうか

io#lineno io#lineno= メソッド

• 現在の行番号(getsメソッドが呼び出された回数)
• 設定もできる

io#sync メソッド

• 出力バッファのモードを調べる
• 戻り値がtrueの場合は出力メソッド実行毎にバッファがフラッシュされる（されてしまう）

ファイルポインタの移動

IOオブジェクトへのメソッドだが、ファイルに対して行うことになるのではないかと予想

io#rewind メソッド

• ファイルポインタを先頭に移動する
• io#lineno も0にリセットされる
• 戻り値はファイルポインタの位置、すなわち0

open(path) do |io|
  io.read

  io.rewind

  # もう一回読み込む
  io.read
end

io#pos io#pos= メソッド

• ファイルポインタを指定された場所(n文字目)へ移動する
• 戻り値はファイルポインタの位置

open(path) do |io|
  io.pos = 10

  io.read
end

io#seek メソッド

• ファイルポインタを第1引数に指定した数だけ、第2引数に指定した位置から移動します
• 第2引数に指定できる定数は
  • IO::SEEK_SET ファイルの先頭（省略時のデフォルト）
  • IO::SEEK_CUR 現在のポインタの位置
  • IO::SEEK_END ファイルの末端
• 戻り値は0

open(path) do |io|
  # 先頭から10文字目
  io.seek(10)

  # 先頭から10文字目
  io.seek(10, IO:SEEK_SET)

  # 現在のポイントから10文字目
  io.seek(10 IO::SEEK_CUR)

  # ファイル末端の10文字前
  io.seek(-10 IO::SEEK_END)

  io.read
end