Ruby 文件操作

文件操作总是最为基本和常用的，本文主要介绍 Ruby 中一些常用的文件操作 api 和陷阱

文件读写

通常使用 open 方法来读取和写入文件

  open('file', 'w'){|f| f.write('ruby') }
  open('file') {|f| f.read }
  # => "ruby"

open 方法的代码块参数可以自动释放文件资源；第二个参数可以指定读取文件的编码，在 Windows 平台下经常会用到

  open('gbk.txt', 'r:gbk') {|f| p f.read.encoding.name }
  # => "GBK" 
  open('gbk.txt', 'r:gbk:utf-8') {|f| p f.read.encoding.name }
  # => "UTF-8"

如果只关注的整个文件的内容，使用类方法也许更为简单

  # :mode 选项的作用和 open 的第二参数相同 
  File.read('file', :mode => 'r:gbk')
  File.write('file', 'text')

  # readlines 读取文件的每一行到一个数组中
  File.readlines('123')
  # => ["1\n", "2\n", "3"]

File 类继承自IO 类，因此可以使用 puts 方法输出数组到文件

  open('file', 'w') { |f| f.puts([1,2,3])}
  File.read('file')
  # =>  "1\n2\n3\n"

File.expand_path

将相对路径转换为绝对路径，能够识别以 ~ 开头的用户路径

  File.expand_path('~/.vim')
  # mac  => /Users/john1king/.vim 
  # win7 => C:/Users/john1king/.vim

除此之外还可以用于转换 Windows 路径中的斜杠

  File.expand_path('C:\Windows\System32\cmd.exe')
  # => C:/Windows/System32/cmd.exe

FileUtils

FileUtils 标准库包含很多 shell like 的文件操作方法，在 rake 中就混入了此模块。

mkdir_p 一次性建立多级路径，如果目标文件夹已存在则什么都不做

  FileUtils.mkdir_p('one/two/three')

cp_r 复制文件夹到目标文件夹下，将文件夹 src 复制到 target/src 时, 最好使用 target/ 做为目标路径

  FileUtils.cp_r('src/', 'target/src/') 
  # target/src 不存在时，将被复制到 target/src
  # target/src 已存在时，将被复制到 target/src/src

常见陷阱

Dir[]/Dir.glob

Dir.glob 是遍历文件夹最简单快捷的方法。但在处理命名不太规范的文件夹时，还是得留个心眼

  # Files: [ruby]/glob.rb, r/glob.rb
  Dir[File.join('[ruby]/*.rb')]
  # => ["r/glob.rb"]

文件名中包含了 '[]' 元字符，因此没有得到预期的结果。一个简单的解决办法是进入目标文件夹后再使用 Dir[] 方法

  path = '[ruby]'
  Dir.chdir(path) do 
    Dir['*.rb'].map {|f| File.join(path, f)}
  end
  # => ["[ruby]/glob.rb"]

文件名编码

在 Windows 下编码是个永远的痛苦。Ruby 1.9.3 已经能够比较好的转换文件名编码，不过还是存在一些陷阱

  # Version: ruby 1.9.3p194

  # File: Ruby文件操作.md
  Dir["*.md"].first.encoding
  # => #<Encoding:GB2312>

  # Directory: 文件夹/
  File.expand_path('Rakefile').encoding
  # => #<Encoding:GBK>

ascii 编码的字符串与 gbk 相兼容，因此不会发生编码转换。可以通过显示的指定 utf-8 字符编码来解决

  Dir["*.md".encode("utf-8")].first.encoding
  # => #<Encoding:UTF-8>

换行符

使用 open 方法的 b 模式将直接写入和读取文件，不处理换行；使用 t 文件模式，Ruby 会尝试将 CR(\r), CRLF(\r\n) 换行符转换为 LF(\n),

  File.write('newline', "\r \n \r\n", :mode => 'wb')
  open('newline', 'rt'){|f| f.read}
  # => "\n \n \n"

open 的默认模式为 r, 但在 Windows 平台下表现为 rt, *nix 下表现为 rb。

  open('newline'){|f| f.read}
  # *nix => "\r \n \r\n"
  # win => "\n \n \n"

File.read 方法在 Windows 平台下会转换 CRLF 为 LF

  File.read('newline')
  # *nix => "\r \n \r\n"
  # win => "\r \n \n"