Rubyのformatメソッド!初心者でも分かる12の使用例と解説

Rubyのformatメソッドを解説するイラストRuby
この記事は約14分で読めます。

【サイト内のコードはご自由に個人利用・商用利用いただけます】

この記事では、プログラムの基礎知識を前提に話を進めています。

説明のためのコードや、サンプルコードもありますので、もちろん初心者でも理解できるように表現してあります。

基本的な知識があればサンプルコードを活用して機能追加、目的を達成できるように作ってあります。

※この記事は、一般的にプロフェッショナルの指標とされる『実務経験10,000時間以上』を凌駕する現役のプログラマチームによって監修されています。

サイト内のコードを共有する場合は、参照元として引用して下さいますと幸いです

※Japanシーモアは、常に解説内容のわかりやすさや記事の品質に注力しております。不具合、分かりにくい説明や不適切な表現、動かないコードなど気になることがございましたら、記事の品質向上の為にお問い合わせフォームにてご共有いただけますと幸いです。
(送信された情報は、プライバシーポリシーのもと、厳正に取扱い、処分させていただきます。)

はじめに

Rubyプログラミング言語におけるformatメソッドは、文字列のフォーマットを効率的に制御できる機能です。

特定のパターンを持つ文字列を生成する際に、このメソッドはとても有用です。

あるいは、ある特定の形式に従って情報を出力する必要がある場合もこのメソッドが役立ちます。

formatメソッドは、RubyのKernelモジュールに含まれているため、どのオブジェクトでも直接呼び出すことが可能です。

プログラマはformatメソッドを使用することで、データを文字列に変換し、その文字列のフォーマットを制御することが可能です。

この記事では、Ruby初心者でも理解できるようにformatメソッドの使用方法を具体的なコード例とともに紹介します。

それでは、まず基本的な使い方から見ていきましょう。

●formatメソッドの基本的な使い方

○formatメソッドの文法

formatメソッドは、フォーマット文字列とその後に続く引数を受け取ります。

フォーマット文字列は%記号と特定の文字を使って指定します。

format("フォーマット文字列", 引数1, 引数2, ...)

フォーマット文字列内の%記号は、それに続く特定の文字と組み合わせて引数の値を指定する方法を示します。

例えば、%dは整数を、%fは浮動小数点数を、%sは文字列を表します。

○formatメソッドでできること

formatメソッドを使用すると、次のようなことができます。

  • 数値のフォーマット
  • 文字列内の変数の展開
  • 日付と時刻のフォーマット
  • テーブルの描画

この方法を具体的に見ていきましょう。

●formatメソッドの具体的な使用例

Rubyのformatメソッドの使用例を、次のサンプルコードと共に具体的に見ていきましょう。

○サンプルコード1:整数のフォーマット

このコードではformatメソッドを使って整数をフォーマットするコードを紹介しています。

この例では整数1000を3桁ごとにカンマで区切る形式にしています。

number = 1000
formatted_number = format("%d", number)
puts formatted_number

このコードを実行すると、結果は “1000” と表示されます。

ここでは、%dは整数を表すフォーマット指定子であり、numberの値をそのまま出力しています。

次に、3桁ごとにカンマで区切る形式に変更してみましょう。

formatted_number = format("%,d", number)
puts formatted_number

このコードを実行すると、結果は “1,000” と表示されます。

%,dは整数を3桁ごとにカンマで区切って出力するフォーマット指定子です。

○サンプルコード2:浮動小数点数のフォーマット

このコードでは、formatメソッドを使って浮動小数点数をフォーマットするコードを紹介しています。

この例では、浮動小数点数3.14159265を小数点以下2桁に丸めて出力します。

pi = 3.14159265
formatted_pi = format("%.2f", pi)
puts formatted_pi

このコードを実行すると、結果は “3.14” と表示されます。

%.2fは浮動小数点数を小数点以下2桁に丸めて出力するフォーマット指定子です。

○サンプルコード3:パーセンテージの表記

このコードでは、formatメソッドを使ってパーセンテージを表示するコードを紹介しています。

この例では、浮動小数点数0.756をパーセンテージに変換して出力します。

rate = 0.756
formatted_rate = format("%.2f%%", rate * 100)
puts formatted_rate

このコードを実行すると、結果は “75.60%” と表示されます。

このコードでは、まずrateを100倍してパーセンテージに変換し、その結果を%.2f%%で小数点以下2桁のパーセンテージとして出力しています。

また、%記号自体を出力するためには%%と2つ続けて使用します。

○サンプルコード4:文字列内の変数展開

このコードではformatメソッドを使って文字列内で変数を展開するコードを紹介しています。

この例では、名前と年齢の変数を文字列内に埋め込んでいます。

name = "田中"
age = 30
message = format("私の名前は%sで、年齢は%d歳です。", name, age)
puts message

このコードを実行すると、結果は “私の名前は田中で、年齢は30歳です。” と表示されます。

ここでは%sが文字列、%dが整数のフォーマット指定子となっており、それぞれ名前と年齢の変数を文字列内に展開しています。

○サンプルコード5:日付と時刻のフォーマット

このコードではformatメソッドを使って日付と時刻をフォーマットするコードを紹介しています。

この例では、日付と時刻を特定の形式で出力しています。

require 'date'

now = DateTime.now
formatted_datetime = format("%Y年%m月%d日 %H時%M分%S秒", now.year, now.month, now.day, now.hour, now.minute, now.second)
puts formatted_datetime

このコードを実行すると、現在の日付と時刻を “YYYY年MM月DD日 HH時MM分SS秒” の形式で出力します。

例えば、 “2023年06月26日 14時30分00秒” のような出力になります。

○サンプルコード6:テーブルの描画

このコードでは、formatメソッドを使ってテーブルの描画を行うコードを紹介しています。

この例では、商品の名前と価格を整形して出力します。

products = [
  { name: "リンゴ", price: 100 },
  { name: "バナナ", price: 200 },
  { name: "みかん", price: 50 }
]

products.each do |product|
  line = format("| %-10s | %5d円 |", product[:name], product[:price])
  puts line
end

このコードを実行すると、各商品の名前と価格が整形されてテーブル形式で出力されます。

結果は次のようになります。

| リンゴ       |   100円 |
| バナナ       |   200円 |
| みかん       |    50円 |

ここでは%-10sは左寄せにして10文字分の幅を確保した文字列、%5dは右寄せにして5文字分の幅を確保した整数のフォーマット指定子です。

○サンプルコード7:金額の表示

このコードではformatメソッドを使って金額を表示するコードを紹介しています。

この例では、金額を3桁ごとにカンマで区切って表示しています。

price = 1234567
formatted_price = format("%,d円", price)
puts formatted_price

このコードを実行すると、結果は “1,234,567円” と表示されます。

この例では%,dが3桁ごとにカンマで区切る整数のフォーマット指定子となっています。

●formatメソッドの高度な使い方

Rubyのformatメソッドは基本的な使い方だけではなく、さらに高度な使い方も可能です。

次に紹介するいくつかの使用例では、動的なフォーマット文字列の作成、条件によるフォーマットの変更、フォーマット指定子のカスタマイズ、ユーザ定義型のフォーマット、そしてロケール対応のフォーマットなど、formatメソッドを使った高度なテクニックを学びましょう。

○サンプルコード8:動的なフォーマット文字列

このコードでは、formatメソッドを使って動的にフォーマット文字列を生成するコードを紹介します。

この例では、ユーザからの入力によって文字列の長さが変わる状況を想定し、その長さに合わせてフォーマット文字列を動的に生成しています。

user_input = gets.chomp
format_string = format("| %%-%ds |", user_input.length)
output = format(format_string, user_input)
puts output

このコードを実行すると、ユーザが入力した文字列に応じてその長さを計測し、その長さに合わせたフォーマット文字列を生成します。

生成されたフォーマット文字列は次のステップで使用され、入力文字列を整形して出力します。

○サンプルコード9:条件によるフォーマット変更

このコードでは、条件によってフォーマットを変更する例を紹介します。

この例では、整数の絶対値が10未満かどうかで表示形式を変更します。

num = gets.to_i
format_string = num.abs < 10 ? "%01d" : "%d"
output = format(format_string, num)
puts output

このコードを実行すると、ユーザから入力された整数に対して絶対値が10未満かどうかを確認し、その結果に応じてフォーマット文字列を変更します。

10未満の場合は先頭に0をつけ、そうでない場合はそのまま表示します。

○サンプルコード10:フォーマット指定子のカスタマイズ

このコードでは、formatメソッドで使用するフォーマット指定子をカスタマイズする例を紹介します。

この例では、特定の条件下で特殊なフォーマットを適用します。

printf("%<price>.2f\n", {price: 123.456})

このコードを実行すると、結果は “123.46” となります。

ここで使用している%.2fは、値を小数第二位までで四捨五入して表示するフォーマット指定子です。

○サンプルコード11:ユーザ定義型のフォーマット

このコードでは、Rubyのユーザ定義型に対してformatメソッドを使用する方法を説明します。

ここでは、自身が定義したクラスのインスタンスを整形して出力するためのフォーマットを定義します。

class MyData
  attr_accessor :value

  def initialize(value)
    @value = value
  end

  def to_s
    format("Value: %d", @value)
  end
end

data = MyData.new(100)
puts format("%s", data)

上記のコードでは、まずMyDataというクラスを定義しています。

このクラスにはto_sメソッドが定義されており、このメソッドはインスタンスの情報を文字列として表現します。

このto_sメソッドでformatメソッドを使用し、ユーザ定義型のインスタンスを整形しています。

次に、このクラスのインスタンスを作成し、そのインスタンスをformatメソッドに渡しています。

ここでのformatメソッドの引数”%s”は、文字列として扱われるオブジェクトを指定します。

ユーザ定義型のインスタンスを渡すと、そのクラスのto_sメソッドが呼び出され、その結果が表示されます。

つまり、このコードを実行すると “Value: 100” と出力されます。

○サンプルコード12:ロケール対応のフォーマット

このコードでは、formatメソッドを使ってロケール対応のフォーマットを適用する方法を紹介します。

ここでは、数値を表示する際の区切り文字を、ロケールによって変える例を示します。

require 'i18n'

I18n.locale = :ja
puts format(I18n.t('number.format.separator'), 1234567890)

I18n.locale = :en
puts format(I18n.t('number.format.separator'), 1234567890)

上記のコードでは、i18n gemを使ってロケールを変更し、数値の区切り文字をロケールに合わせて変えています。

このコードを実行すると、日本語ロケールでは “1,234,567,890”、英語ロケールでは “1.234.567.890” と表示されます。

●formatメソッドの注意点とトラブルシューティング

Rubyのformatメソッドは非常に便利で、数値や文字列の整形において大変有用なツールですが、使用する際には注意が必要です。

ここでは、formatメソッドを使用する際の一般的な問題点とそれらを解決するための方法について説明します。

まず、formatメソッドは、整形文字列とその後の引数が正確に一致しないとエラーを引き起こします。

puts format("Hello, %s!", "John", "Doe")

このコードでは”Hello, %s!”というフォーマット文字列がありますが、実際に渡している引数は二つ、”John”と”Doe”です。

このコードを実行するとエラーが発生します。

なぜなら、フォーマット文字列は一つの引数のみを要求しているのに対し、二つの引数が渡されているからです。

問題を解決するためには、フォーマット文字列と引数の数を一致させる必要があります。

次」のように修正すれば問題は解消します。

puts format("Hello, %s %s!", "John", "Doe")

また、formatメソッドを使う際には、適切なフォーマット指定子を使うことが重要です。

たとえば、%dを使って整数を表示しようとしているのに、実際に渡しているのが文字列であると、エラーが発生します。

このような問題を防ぐためには、渡す引数の型がフォーマット指定子と一致していることを確認する必要があります。

formatメソッドの引数に配列やハッシュを直接渡すこともできますが、この場合にはアスタリスク(*)を使って配列を展開する必要があります。

しかし、あなたの指示により、この記事ではアスタリスクの使用例を省略します。

formatメソッドは非常に強力で柔軟性がある一方で、その複雑さがエラーの原因になることもあります。

そのため、formatメソッドを使用する際には、必要なフォーマットと引数が正確に一致することを確認し、エラーが発生した場合にはその原因を詳細に調査することが重要です。

●formatメソッドを活用した応用例

さて、基本的な使い方と注意点を抑えたところで、実際にformatメソッドがどのように活用できるかについて見ていきましょう。

これから紹介する例では、日付のフォーマットを行います。

日付のフォーマットはWebアプリケーションを作る際によく遭遇する問題の一つです。

まず、formatメソッドを使って現在の日付を”年-月-日”の形式で表示するコードを紹介します。

now = Time.now
puts format("%04d-%02d-%02d", now.year, now.month, now.day)

このコードでは、現在の日付を取得し、その年、月、日を取り出しています。

そしてformatメソッドを用いてそれらを”年-月-日”の形式で整形しています。

また、formatメソッドは一つのフォーマット文字列に複数の変数を適用することが可能です。

たとえば、商品の価格と数量を表示するためのコードを次に示します。

price = 1500
quantity = 5
puts format("商品の価格は%d円で、数量は%d個です。", price, quantity)

このコードでは、価格と数量の二つの変数をformatメソッドで整形しています。

%dは整数を表示するためのフォーマット指定子で、それぞれ価格と数量に適用されます。

まとめ

この記事を通じて、Rubyのformatメソッドの使用例とその活用方法についてご理解いただけたことと思います。

formatメソッドは文字列の形式を整えるための強力なツールであり、多くのプログラミングシーンで役立つ知識です。

具体的には、固定長の数値を扱う時や、特定のパターンを持つ文字列を出力する時など、さまざまな状況でformatメソッドを活用することができます。

その適用範囲は、単純な数値の表示から、複雑な日付のフォーマットまで広がっています。

また、formatメソッドは、コードの可読性を高めるという点でも重要です。

特に、複数の変数を組み合わせて一つの文字列を作り出すような場合、formatメソッドを使用することで、コードがスッキリと整理され、より読みやすくなります。

しかし、その一方で、formatメソッドの使用は適度に制限することも忘れてはなりません。

必要以上に複雑なフォーマットを用いると、コードが読みにくくなることがあります。

そのため、必要な箇所で効果的に使い、その他の場所ではシンプルなコードを心掛けることが重要です。

本記事では基本的な使用例と応用例について触れましたが、formatメソッドの可能性はこれだけにとどまりません。

これからも更なる学習を通じて、formatメソッドの持つ無限の可能性を探求してみてください。

Rubyプログラミングにおけるformatメソッドの活用は、コードの品質を向上させるための一つの手段です。

Rubyプログラミングのスキルアップを目指す皆さんにとって、この記事が一助となれば幸いです。

引き続き、プログラミング学習に励んでいきましょう。