RubyのYAMLライブラリを操作する方法を解説

YAMLは、データを構造化して表現するためのフォーマットで、設定ファイルやデータの保存、交換などに広く使用されています。特にRuby on Railsでは頻繁に利用されるため、Rubyプログラマーにとって重要なスキルの一つです。この記事では、RubyでYAMLを操作する方法と基本的な書き方について、初心者向けに詳しく解説していきます。

YAMLとは
RubyでYAMLを扱うための準備
YAMLファイルの読み込み
YAMLデータの解析
YAMLファイルへの書き込み
YAMLの基本的な書き方
YAMLにおける特殊文字の扱い
1. クォーティング
2. 複数行の文字列
YAMLの実践的な使用例
1. アプリケーション設定
2. 国際化（i18n）
まとめ

YAMLとは

YAMLは “YAML Ain’t Markup Language” の略で、人間にとって読み書きしやすい形式でデータを表現するためのフォーマットです。主な特徴として以下が挙げられます：

インデントを使って階層構造を表現
キーと値のペアでデータを表現
配列やハッシュなどの複雑なデータ構造も表現可能
コメントを記述可能

RubyでYAMLを扱うための準備

RubyでYAMLを扱うには、標準ライブラリの yaml を使用します。以下のようにして読み込みます：

require 'yaml'

これで、YAMLを操作するためのメソッドが使えるようになります。

YAMLファイルの読み込み

YAMLファイルを読み込むには、YAML.load_file メソッドを使用します。以下は基本的な使い方です：

data = YAML.load_file('config.yml')

例えば、以下のような内容の config.yml ファイルがあるとします：

database:
  host: localhost
  port: 3306
  username: root
  password: secret

app_settings:
  debug_mode: true
  max_users: 1000

このファイルを読み込むと、以下のようなRubyのハッシュオブジェクトが得られます：

{
  "database" => {
    "host" => "localhost",
    "port" => 3306,
    "username" => "root",
    "password" => "secret"
  },
  "app_settings" => {
    "debug_mode" => true,
    "max_users" => 1000
  }
}

YAMLデータの解析

YAMLデータを文字列として持っている場合は、YAML.load メソッドを使用して解析できます：

yaml_string = "
name: John Doe
age: 30
hobbies:
  - reading
  - swimming
  - coding
"

data = YAML.load(yaml_string)
puts data["name"]  # => John Doe
puts data["hobbies"][1]  # => swimming

YAMLファイルへの書き込み

RubyオブジェクトをYAML形式で保存するには、YAML.dump メソッドを使用します：

data = {
  'fruits' => ['apple', 'banana', 'orange'],
  'vegetables' => {
    'green' => ['spinach', 'broccoli'],
    'red' => ['tomato', 'bell pepper']
  }
}

File.open('food.yml', 'w') do |file|
  file.write(YAML.dump(data))
end

これにより、以下のような内容の food.yml ファイルが作成されます：

---
fruits:
- apple
- banana
- orange
vegetables:
  green:
  - spinach
  - broccoli
  red:
  - tomato
  - bell pepper

YAMLの基本的な書き方

YAMLの基本的な書き方について解説します。

スカラー値

文字列や数値などの単純な値は、キーと値のペアで表現します：

name: John Doe
age: 30
is_student: false

リスト（配列）

ハイフンを使ってリストを表現します：

fruits:
  - apple
  - banana
  - orange

ネストされたハッシュ

インデントを使って階層構造を表現します：

address:
  street: 123 Main St
  city: Anytown
  country: USA

複合構造

リストとハッシュを組み合わせて、複雑なデータ構造も表現できます：

employees:
  - name: Alice
    position: Developer
    skills:
      - Ruby
      - JavaScript
  - name: Bob
    position: Designer
    skills:
      - Photoshop
      - Illustrator

YAMLにおける特殊文字の扱い

YAMLでは、特殊文字を含む文字列を扱う際に注意が必要です。

クォーティング

特殊文字を含む文字列は、シングルクォートまたはダブルクォートで囲みます：

special_string: "This is a string with: colon"
another_special: 'String with ''single quotes'''

複数行の文字列

パイプ記号 | を使用して、複数行の文字列を表現できます：

long_text: |
  This is a long text
  that spans multiple lines.
  Each line break is preserved.

折りたたみ記号 > を使用すると、行末の改行が空白に置き換えられます：

folded_text: >
  This is a long text
  that will be folded
  into a single line.

YAMLの実践的な使用例

実際のプロジェクトでYAMLがどのように使用されるか、いくつかの例を見てみましょう。

アプリケーション設定

アプリケーションの設定をYAMLで管理する例：

# config.yml
development:
  database:
    adapter: sqlite3
    database: db/development.sqlite3
  logging:
    level: debug

production:
  database:
    adapter: postgresql
    host: db.example.com
    username: app_user
    password: secret_password
  logging:
    level: warn

このYAMLファイルを読み込んで使用する例：

require 'yaml'

config = YAML.load_file('config.yml')
env = ENV['RACK_ENV'] || 'development'

database_config = config[env]['database']
DB.connect(database_config)

log_level = config[env]['logging']['level']
Logger.set_level(log_level)

国際化（i18n）

多言語対応のためのテキストリソースをYAMLで管理する例：

# ja.yml
ja:
  greeting: こんにちは
  farewell: さようなら
  errors:
    not_found: ページが見つかりません
    server_error: サーバーエラーが発生しました

# en.yml
en:
  greeting: Hello
  farewell: Goodbye
  errors:
    not_found: Page not found
    server_error: Server error occurred

これらのYAMLファイルを使用して多言語対応を実装する例：

require 'yaml'

def load_translations(locale)
  YAML.load_file("#{locale}.yml")[locale]
end

def t(key, locale = 'en')
  translations = load_translations(locale)
  keys = key.split('.')
  keys.reduce(translations) { |acc, k| acc[k] }
end

puts t('greeting', 'ja')  # => こんにちは
puts t('errors.not_found', 'en')  # => Page not found