Rubyのヒアドキュメントの基本と使い方を解説

プログラミングにおいて文字列の扱いは非常に重要です。特に複数行にわたる長い文字列を扱う場合、通常の文字列リテラルでは可読性が低下してしまいます。そこでRubyでは「ヒアドキュメント」という便利な機能を提供しています。

ヒアドキュメントとは

ヒアドキュメントとは、複数行の文字列を簡単に扱うための機能です。特に以下のような場合に便利です：

HTMLやSQLなど、複数行にわたる長い文字列を扱う場合
整形された文字列を出力する必要がある場合
改行を含む長いテキストを変数に格納する場合

基本的な書き方

ヒアドキュメントの最も基本的な書き方は以下の通りです：

text = <<EOS
これは1行目です。
これは2行目です。
これは3行目です。
EOS

puts text

このコードでは：

<<EOS がヒアドキュメントの開始を示します
EOS までの間のテキストが文字列として扱われます
最後の EOS は必ず行の先頭に置く必要があります

インデントの扱い方

ヒアドキュメントには3種類のインデント制御方法があります：

1. 基本形（<<識別子）

def hello
  puts <<EOS
  こんにちは
  世界！
EOS
end

この方法では、終端の識別子（EOS）は必ず行の先頭になければなりません。

2. インデント可能形（<<-識別子）

def hello
  puts <<-EOS
    こんにちは
    世界！
  EOS
end

<<-を使うことで、終端の識別子にもインデントを付けることができます。

3. スペース除去形（<<~識別子）

def hello
  puts <<~EOS
    こんにちは
    世界！
  EOS
end

<<~を使うと、各行の先頭の余分な空白が自動的に除去されます。これが最も美しいコードを書くことができる方法です。

式展開とエスケープシーケンス

ヒアドキュメントでは、通常の文字列と同様に式展開とエスケープシーケンスが使用できます：

name = "太郎"
age = 25

text = <<EOS
私の名前は#{name}です。
年齢は#{age}歳です。
タブ\tを入れることもできます。
EOS

puts text

実践的な使用例

HTMLテンプレートの作成

ウェブ開発でよく使用される例を見てみましょう：

def generate_html(title, content)
  <<~HTML
    <!DOCTYPE html>
    <html>
      <head>
        <meta charset="UTF-8">
        <title>#{title}</title>
      </head>
      <body>
        <h1>#{title}</h1>
        <div class="content">
          #{content}
        </div>
      </body>
    </html>
  HTML
end

page = generate_html("私のブログ", "こんにちは！")
puts page

SQLクエリの作成

データベース操作でも活用できます：

def build_search_query(keywords, category)
  <<~SQL
    SELECT 
      products.name,
      products.price,
      categories.name as category_name
    FROM 
      products
    JOIN 
      categories ON products.category_id = categories.id
    WHERE 
      products.name LIKE '%#{keywords}%'
      AND categories.name = '#{category}'
    ORDER BY 
      products.created_at DESC;
  SQL
end

高度な使い方

複数のヒアドキュメント

1つのコードブロック内で複数のヒアドキュメントを使用することができます：

def generate_email(user_name)
  subject = <<~SUBJECT
    【重要】会員登録完了のお知らせ
  SUBJECT

  body = <<~BODY
    #{user_name}様

    会員登録が完了しましたことをお知らせいたします。
    引き続き、サービスをお楽しみください。

    ※このメールは自動送信されています。
  BODY

  return subject, body
end

メソッドチェーン

ヒアドキュメントに対して直接メソッドを呼び出すことができます：

message = <<~TEXT.upcase.strip
  hello
  world
TEXT

puts message  # "HELLO\nWORLD"

配列やハッシュとの組み合わせ

data = <<~DATA.split("\n").map(&:strip)
  りんご
  バナナ
  オレンジ
DATA

puts data  # ["りんご", "バナナ", "オレンジ"]

注意点とベストプラクティス

1. 識別子の命名規則

識別子（EOSなど）は慣習的に大文字で書かれることが多いですが、実際には任意の文字列が使えます：

text = <<終了
これも有効です
終了

text = <<"END"
これも可能です
END

ただし、以下のような命名規則が推奨されます：

内容を表す意味のある名前（HTML, SQL, JSONなど）
単純な場合はEOS（End Of String）やEOFを使用
プロジェクト内で一貫性のある命名を使用

2. エスケープ処理の注意点

ヒアドキュメント内でバックスラッシュやシングルクォート、ダブルクォートを使用する場合の注意点：

# 正しい使用例
text = <<~TEXT
  バックスラッシュ（\\）を表示する
  "ダブルクォート"も問題なし
  'シングルクォート'も使えます
TEXT

3. パフォーマンスへの配慮

大量のヒアドキュメントを扱う場合は、メモリ使用量に注意が必要です：

# メモリ効率の良い書き方
File.open('output.txt', 'w') do |file|
  file.puts <<~TEXT
    大量のテキストデータ
    を書き込む場合は
    ファイルに直接書き込むことを
    検討しましょう
  TEXT
end

実践的なユースケース

テキストテンプレートエンジン

class Template
  def initialize(template)
    @template = template
  end

  def render(variables)
    result = @template.dup
    variables.each do |key, value|
      result.gsub!("%{#{key}}", value.to_s)
    end
    result
  end
end

# 使用例
template = Template.new(<<~TEMPLATE)
  こんにちは、%{name}さん！

  本日は%{date}です。
  %{event}へのご参加ありがとうございます。

  開始時刻：%{start_time}
  場所：%{location}
TEMPLATE

params = {
  name: '山田',
  date: '2025年1月2日',
  event: '新年会',
  start_time: '18:00',
  location: '東京都渋谷区'
}

puts template.render(params)

コンフィグファイルの生成

def generate_config(environment)
  case environment
  when 'development'
    <<~CONFIG
      database:
        host: localhost
        port: 5432
        name: app_development

      redis:
        host: 127.0.0.1
        port: 6379

      log_level: debug
    CONFIG
  when 'production'
    <<~CONFIG
      database:
        host: db.example.com
        port: 5432
        name: app_production

      redis:
        host: redis.example.com
        port: 6379

      log_level: info
    CONFIG
  end
end