Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

【Ruby3.x】Gem::Version::pretty_print()メソッドの使い方

pretty_printメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

pretty_printメソッドは、Gem::Versionクラスのインスタンスが持つバージョン情報を、人間にとって読みやすい形式で整形して出力するために実行されるメソッドです。Gem::Versionクラスは、RubyGemsなどで利用されるソフトウェアのバージョン番号(例えば "1.0.0" や "2.1.5" など)を厳密に比較したり操作したりするための機能を提供します。

このpretty_printメソッドは、主にRubyの標準ライブラリであるPrettyPrintモジュール(PP)と連携して機能します。PP.pp のような整形出力用のメソッドがバージョンオブジェクトを受け取った際、このpretty_printメソッドが自動的に呼び出されます。これにより、単なるバージョン文字列として表示するだけでなく、バージョンオブジェクトが内部的にどのように構成されているか(例えば、メジャーバージョン、マイナーバージョン、パッチバージョンなどの各要素)を、構造化された分かりやすい形式で表示することが可能になります。特に、プログラムのデバッグ時やオブジェクトの内部状態を詳細に確認したい場合に、開発者がオブジェクトの内容を正確に把握する上で非常に有用なツールとなります。

構文(syntax)

1require 'pretty_print'
2
3version_instance = Gem::Version.new('1.2.3')
4pretty_printer_object = PrettyPrint.new($stdout)
5
6version_instance.pretty_print(pretty_printer_object)

引数(parameters)

pp

Ruby:

  • pp: pretty print 用のオブジェクト

戻り値(return)

PrettyPrint

Gem::Version#pretty_print は、バージョン情報を整形して出力するための PrettyPrint オブジェクトを返します。

関連コンテンツ