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

【Ruby3.x】CSV::Table::dig()メソッドの使い方

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

作成日: 更新日:

基本的な使い方

digメソッドは、CSV::Tableオブジェクトからネストされたデータ構造の奥深くにある特定の値に安全にアクセスすることを可能にするメソッドです。CSV::Tableは、CSVファイルを読み込んだデータを、行と列を持つ表形式のデータとして扱います。このメソッドは、複数のキーを引数として受け取り、それらのキーを順にたどって目的の値を取り出します。

具体的には、最初のキーが行のインデックス(0から始まる整数)や行の識別子(もしCSV::TableがHashのように振る舞う場合)を指定し、そこから得られたCSV::Rowオブジェクトに対して次のキーを用いて列のインデックスや列ヘッダ名を指定することで、最終的な値に到達します。例えば、table.dig(行番号, "列ヘッダ名") のように使用することで、特定の行の特定の列の値を直接取得できます。

このメソッドの大きな特徴は、アクセスパスの途中に存在する要素がnilであった場合でも、エラー(例えばNoMethodErrorなど)を発生させずにnilを返す点です。これにより、データが欠損している可能性のある複雑なCSVデータ構造から値を取り出す際に、条件分岐によるnilチェックを多数記述する手間を省き、コードをより簡潔かつ安全に保つことができます。システムエンジニアにとって、データの安全な取得とコードの可読性向上に役立つ便利な機能です。

構文(syntax)

1require 'csv'
2
3csv_string = <<~CSV
4  Name,Age,City
5  Alice,30,New York
6  Bob,24,London
7CSV
8
9csv_table = CSV.parse(csv_string, headers: true)
10
11csv_table.dig(0, "Name")

引数(parameters)

index_or_header, *index_or_headers

  • index_or_header: 取得したいデータのインデックス(整数)またはヘッダー名(文字列)
  • *index_or_headers: 複数階層のデータを取得する場合の、残りのインデックス(整数)またはヘッダー名(文字列)

戻り値(return)

Objectまたはnil

dig メソッドは、指定されたインデックスまたはキーに対応する要素を、ネストされた構造(配列やハッシュなど)の中から再帰的に探索して返します。要素が見つからない場合は nil を返します。

関連コンテンツ