Опции командной строки в Ruby CLI

Ruby — это мощный и гибкий язык программирования, который часто используется для создания различных приложений, включая командные интерфейсы (CLI). В этой статье мы рассмотрим, как использовать опции командной строки в Ruby, чтобы сделать ваши приложения более интерактивными и удобными для пользователей.

Что такое опции командной строки?

Опции командной строки — это параметры, которые можно передавать вашему приложению при его запуске из терминала. Они позволяют пользователям настраивать поведение программы без необходимости изменять код. Например, вы можете создать приложение, которое принимает имя файла в качестве аргумента и выполняет с ним определенные действия.

Зачем использовать опции командной строки?

Использование опций командной строки имеет несколько преимуществ:

Гибкость: Пользователи могут изменять поведение программы без изменения кода.
Удобство: Позволяет пользователям легко взаимодействовать с приложением.
Автоматизация: Упрощает интеграцию с другими инструментами и скриптами.

Как обрабатывать опции командной строки в Ruby

В Ruby есть несколько способов обработки опций командной строки. Наиболее распространенные методы включают использование встроенного массива ARGV и библиотеки, такие как OptionParser.

Использование массива ARGV

Массив ARGV содержит все аргументы, переданные вашему приложению. Например, если вы запустите ваше приложение с командой:

ruby my_app.rb file.txt --verbose

То массив ARGV будет содержать:

["file.txt", "--verbose"]

Вот пример простого приложения, использующего ARGV:

puts "Аргументы командной строки: #{ARGV.join(', ')}"

Этот код выведет все переданные аргументы на экран.

Использование OptionParser

Для более сложных сценариев рекомендуется использовать библиотеку OptionParser, которая предоставляет удобный способ обработки опций командной строки. Вот пример использования OptionParser:

require 'optparse'

options = {}
OptionParser.new do |opts|
  opts.banner = "Использование: my_app.rb [опции]"

  opts.on("-f", "--file FILE", "Укажите файл для обработки") do |file|
    options[:file] = file
  end

  opts.on("-v", "--verbose", "Выводить подробную информацию") do
    options[:verbose] = true
  end
end.parse!

puts "Обработанный файл: #{options[:file]}" if options[:file]
puts "Режим подробного вывода включен" if options[:verbose]

В этом примере мы определяем две опции: -f (или --file) для указания файла и -v (или --verbose) для включения подробного вывода. После парсинга опций мы можем использовать их в нашем приложении.

Создание пользовательских опций

Вы можете создавать свои собственные опции, чтобы сделать ваше приложение более удобным. Например, вы можете добавить опцию для указания формата вывода:

opts.on("-o", "--output FORMAT", "Укажите формат вывода (json, xml)") do |format|
  options[:output] = format
end

Теперь пользователи могут указать формат вывода при запуске приложения:

ruby my_app.rb -o json

Обработка ошибок

Важно обрабатывать ошибки, которые могут возникнуть при передаче неверных опций. OptionParser автоматически выводит сообщение об ошибке, если пользователь передает неверные параметры. Вы можете добавить свои собственные проверки:

if options[:file].nil?
  puts "Ошибка: необходимо указать файл с помощью -f или --file"
  exit
end

Примеры использования опций командной строки

Давайте рассмотрим несколько примеров использования опций командной строки в Ruby.

Пример 1: Простой калькулятор

Создадим простой калькулятор, который принимает два числа и операцию (сложение, вычитание, умножение или деление) в качестве аргументов:

require 'optparse'

options = {}
OptionParser.new do |opts|
  opts.banner = "Использование: calculator.rb [опции]"

  opts.on("-a", "--add NUM1 NUM2", "Сложить два числа") do |num1, num2|
    options[:result] = num1.to_f + num2.to_f
  end

  opts.on("-s", "--subtract NUM1 NUM2", "Вычесть два числа") do |num1, num2|
    options[:result] = num1.to_f - num2.to_f
  end

  opts.on("-m", "--multiply NUM1 NUM2", "Умножить два числа") do |num1, num2|
    options[:result] = num1.to_f * num2.to_f
  end

  opts.on("-d", "--divide NUM1 NUM2", "Разделить два числа") do |num1, num2|
    options[:result] = num1.to_f / num2.to_f
  end
end.parse!

puts "Результат: #{options[:result]}" if options[:result]

Теперь вы можете использовать этот калькулятор из командной строки:

ruby calculator.rb --add 5 3

Пример 2: Сканер файлов

Создадим приложение, которое сканирует файлы в указанной директории и выводит их имена:

require 'optparse'
require 'find'

options = {}
OptionParser.new do |opts|
  opts.banner = "Использование: file_scanner.rb [опции]"

  opts.on("-d", "--directory DIR", "Укажите директорию для сканирования") do |dir|
    options[:directory] = dir
  end
end.parse!

if options[:directory]
  Find.find(options[:directory]) do |path|
    puts path if File.file?(path)
  end
else
  puts "Ошибка: необходимо указать директорию с помощью -d или --directory"
end

Теперь вы можете запустить сканер файлов:

ruby file_scanner.rb --directory /path/to/dir

Заключение

Опции командной строки — это мощный инструмент для создания интерактивных приложений на Ruby. Используя массив ARGV или библиотеку OptionParser, вы можете легко обрабатывать пользовательские вводы и настраивать поведение вашего приложения. Надеемся, что эта статья помогла вам лучше понять, как использовать опции командной строки в Ruby CLI!