Cómo Escribir una Herramienta CLI Simple con Ruby

Ruby es un lenguaje de programación versátil y fácil de aprender, ideal para crear herramientas de línea de comandos (CLI). En este artículo, te guiaré a través del proceso de creación de una herramienta CLI simple utilizando Ruby. Aprenderás sobre la estructura básica de un programa en Ruby, cómo manejar argumentos de línea de comandos y cómo organizar tu código de manera efectiva.

¿Qué es una Herramienta CLI?

Una herramienta de línea de comandos (CLI, por sus siglas en inglés) es un programa que se ejecuta en la terminal y permite a los usuarios interactuar con el sistema operativo mediante comandos de texto. Estas herramientas son útiles para automatizar tareas, procesar datos y realizar operaciones repetitivas de manera eficiente.

Requisitos Previos

Antes de comenzar, asegúrate de tener instalado Ruby en tu sistema. Puedes verificar la instalación ejecutando el siguiente comando en tu terminal:

ruby -v

Si no tienes Ruby instalado, puedes descargarlo desde aquí.

Creando tu Primer Proyecto CLI

Vamos a crear una herramienta CLI simple que tome un nombre como argumento y devuelva un saludo personalizado. Sigue estos pasos:

1. Crear un Nuevo Directorio

Primero, crea un nuevo directorio para tu proyecto y navega a él:

mkdir saludo_cli
cd saludo_cli

2. Crear el Archivo Principal

Ahora, crea un archivo llamado saludo.rb en el directorio del proyecto:

touch saludo.rb

3. Escribir el Código

Abre el archivo saludo.rb en tu editor de texto favorito y agrega el siguiente código:

# saludo.rb

# Verificamos si se ha pasado un argumento
if ARGV.empty?
  puts "Por favor, proporciona un nombre."
  exit
end

# Obtenemos el nombre del primer argumento
nombre = ARGV[0]

# Imprimimos el saludo
puts "¡Hola, #{nombre}! Bienvenido a tu herramienta CLI en Ruby."

4. Ejecutar la Herramienta CLI

Para ejecutar tu herramienta, utiliza el siguiente comando en la terminal, reemplazando TuNombre con el nombre que desees:

ruby saludo.rb TuNombre

Deberías ver un saludo personalizado en la terminal. Si no proporcionas un nombre, recibirás un mensaje pidiéndote que lo hagas.

Manejo de Argumentos de Línea de Comandos

En el ejemplo anterior, utilizamos ARGV, que es un array que contiene los argumentos pasados a la línea de comandos. Aquí hay algunos puntos importantes sobre el manejo de argumentos:

ARGV.length: Devuelve el número de argumentos pasados.
ARGV[index]: Accede a un argumento específico por su índice.
Es buena práctica verificar si se han pasado argumentos antes de intentar usarlos.

Mejorando la Herramienta CLI

Ahora que tienes una herramienta básica, vamos a mejorarla. Agregaremos la capacidad de saludar a múltiples personas a la vez. Modifica el archivo saludo.rb de la siguiente manera:

# saludo.rb

# Verificamos si se han pasado argumentos
if ARGV.empty?
  puts "Por favor, proporciona al menos un nombre."
  exit
end

# Iteramos sobre cada nombre proporcionado
ARGV.each do |nombre|
  puts "¡Hola, #{nombre}! Bienvenido a tu herramienta CLI en Ruby."
end

Ahora, puedes ejecutar tu herramienta con múltiples nombres:

ruby saludo.rb Juan Maria Pedro

Esto imprimirá un saludo para cada nombre proporcionado.

Organizando el Código

A medida que tu herramienta CLI crece, es importante mantener el código organizado. Aquí hay algunas sugerencias:

Divide tu código en métodos para mejorar la legibilidad.
Considera crear un archivo separado para la lógica de negocio.
Utiliza comentarios para explicar partes complejas del código.

Ejemplo de Código Organizado

A continuación, te muestro un ejemplo de cómo podrías organizar el código de tu herramienta CLI:

# saludo.rb

def saludar(nombre)
  puts "¡Hola, #{nombre}! Bienvenido a tu herramienta CLI en Ruby."
end

if ARGV.empty?
  puts "Por favor, proporciona al menos un nombre."
  exit
end

ARGV.each do |nombre|
  saludar(nombre)
end

Agregando Funcionalidades Avanzadas

Una vez que tengas la estructura básica, puedes comenzar a agregar funcionalidades más avanzadas. Aquí hay algunas ideas:

Agregar opciones de configuración utilizando la biblioteca OptionParser.
Guardar los saludos en un archivo de texto.
Implementar un sistema de ayuda que muestre cómo usar la herramienta.

Ejemplo de Uso de OptionParser

Para agregar opciones a tu herramienta, puedes usar la biblioteca OptionParser. Aquí tienes un ejemplo de cómo hacerlo:

require 'optparse'

options = {}
OptionParser.new do |opts|
  opts.banner = "Uso: saludo.rb [opciones] nombres"

  opts.on("-h", "--help", "Mostrar ayuda") do
    puts opts
    exit
  end
end.parse!

if ARGV.empty?
  puts "Por favor, proporciona al menos un nombre."
  exit
end

ARGV.each do |nombre|
  saludar(nombre)
end

Con esto, ahora puedes ejecutar tu herramienta con la opción de ayuda:

ruby saludo.rb -h

Conclusión

Crear una herramienta CLI simple con Ruby es un excelente proyecto para principiantes y una forma efectiva de automatizar tareas. A lo largo de este artículo, hemos cubierto los conceptos básicos de Ruby, cómo manejar argumentos de línea de comandos y cómo organizar tu código. Con estas habilidades, puedes comenzar a construir herramientas más complejas y útiles.

Recuerda que la práctica es clave. No dudes en experimentar con nuevas funcionalidades y mejorar tu herramienta CLI. ¡Diviértete programando!