RubyでシンプルなCLIツールを書く方法

コマンドラインインターフェース（CLI）ツールは、プログラミングの学習や日常のタスクを自動化するために非常に便利です。Rubyはそのシンプルさと強力な機能から、CLIツールを作成するのに適した言語です。このガイドでは、Rubyを使ってシンプルなCLIツールを作成する方法を説明します。

CLIツールとは？

CLIツールは、コマンドラインから実行されるプログラムで、ユーザーがコマンドを入力することで操作します。これにより、グラフィカルユーザーインターフェース（GUI）を使用せずに、さまざまなタスクを実行できます。CLIツールは、スクリプトの実行、データの処理、システム管理など、さまざまな用途に利用されます。

Rubyのインストール

まず、Rubyをインストールする必要があります。以下の手順に従って、Rubyをインストールしてください。

公式サイト（https://www.ruby-lang.org/ja/downloads/）からインストーラーをダウンロードします。
インストーラーを実行し、指示に従ってインストールします。
ターミナルを開き、以下のコマンドを入力してインストールが成功したか確認します。

$ ruby -v

これでRubyが正しくインストールされていれば、バージョン情報が表示されます。

CLIツールの基本構造

CLIツールは、通常、以下の要素で構成されます。

コマンドライン引数の処理
メインロジック
出力の表示

これらの要素を組み合わせて、シンプルなCLIツールを作成します。

1. コマンドライン引数の処理

コマンドライン引数は、ユーザーがCLIツールを実行する際に指定する追加情報です。Rubyでは、`ARGV`という配列を使用して、コマンドライン引数を取得できます。

# 引数を取得する例
args = ARGV
puts "引数の数: #{args.length}"
puts "引数の内容: #{args.join(', ')}"

2. メインロジック

メインロジックは、CLIツールの中心となる部分です。ここでは、引数に基づいて処理を行います。例えば、引数として与えられた数値の合計を計算するツールを作成してみましょう。

# 合計を計算するCLIツール
def calculate_sum(args)
  sum = 0
  args.each do |arg|
    sum += arg.to_i
  end
  sum
end

if ARGV.empty?
  puts "数値を引数として指定してください。"
else
  sum = calculate_sum(ARGV)
  puts "合計: #{sum}"
end

3. 出力の表示

出力は、ユーザーに結果を伝えるための重要な部分です。上記の例では、合計を計算した後、その結果を表示しています。

CLIツールの作成手順

それでは、実際にシンプルなCLIツールを作成してみましょう。以下の手順に従ってください。

ステップ1: 新しいRubyファイルを作成

まず、任意のディレクトリに新しいRubyファイルを作成します。例えば、`sum_tool.rb`という名前にしましょう。

$ touch sum_tool.rb

ステップ2: コードを記述

次に、先ほど説明したコードを`sum_tool.rb`に記述します。

# sum_tool.rb
def calculate_sum(args)
  sum = 0
  args.each do |arg|
    sum += arg.to_i
  end
  sum
end

if ARGV.empty?
  puts "数値を引数として指定してください。"
else
  sum = calculate_sum(ARGV)
  puts "合計: #{sum}"
end

ステップ3: ツールを実行

ターミナルを開き、作成したRubyファイルを実行します。数値を引数として指定してみましょう。

$ ruby sum_tool.rb 10 20 30
合計: 60

引数を指定しなかった場合の動作も確認してみましょう。

$ ruby sum_tool.rb
数値を引数として指定してください。

CLIツールの拡張

基本的なCLIツールが完成したら、次は機能を拡張してみましょう。以下は、追加できる機能の例です。

引数のバリデーション: 数値以外の引数が指定された場合にエラーメッセージを表示する。
オプションの追加: `-h`や`--help`オプションを追加して、使い方を表示する。
ファイルからの入力: 引数としてファイル名を指定し、そのファイルに含まれる数値の合計を計算する。

引数のバリデーションの追加

引数が数値であることを確認するために、以下のようにコードを修正します。

def calculate_sum(args)
  sum = 0
  args.each do |arg|
    if arg =~ /^\d+$/
      sum += arg.to_i
    else
      puts "#{arg} は無効な数値です。"
      return nil
    end
  end
  sum
end

オプションの追加

ヘルプメッセージを表示するためのオプションを追加します。

if ARGV.include?('-h') || ARGV.include?('--help')
  puts "使い方: ruby sum_tool.rb [数値...]"
  puts "指定した数値の合計を計算します。"
else
  # 既存のコード
end

まとめ

Rubyを使ってシンプルなCLIツールを作成する方法を学びました。コマンドライン引数の処理、メインロジックの実装、出力の表示など、基本的な要素を組み合わせることで、さまざまな機能を持つツールを作成できます。さらに、引数のバリデーションやオプションの追加など、機能を拡張することで、より使いやすいツールにすることができます。

ぜひ、今回の内容を参考にして、自分だけのCLIツールを作成してみてください。Rubyの楽しさを感じながら、プログラミングスキルを向上させる良い機会になるでしょう。