Ruby CLI工具开发

在本章中，我们将深入探讨如何使用 Ruby 开发命令行界面（CLI）工具。这些工具可以执行各种任务，从简单的文件操作到复杂的系统管理任务。我们将从基础开始，逐步介绍如何构建一个功能齐全的 CLI 应用程序。

环境搭建

首先，确保你的计算机上安装了 Ruby 和 Bundler。你可以通过以下命令来检查是否已经安装了 Ruby：

ruby -v

如果尚未安装 Ruby，可以从 Ruby 官方网站下载并安装最新版本。接着，安装 Bundler：

gem install bundler

Bundler 是一个 Ruby 包管理器，它允许我们更方便地管理和安装项目依赖。

创建一个新的 CLI 应用程序

我们将使用 thor 来创建我们的 CLI 应用程序。thor 是一个用于创建命令行工具的库，它提供了许多有用的功能，如子命令、选项等。首先，我们需要初始化一个新的 Ruby 项目：

mkdir my_cli_tool
cd my_cli_tool
bundle init

编辑 Gemfile 文件，添加 thor 作为依赖项：

source 'https://rubygems.org'

git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }

# gem "rails"

gem 'thor'

运行以下命令来安装依赖：

bundle install

编写基本的 CLI 应用程序

接下来，我们将创建一个基本的 CLI 应用程序。在项目的根目录下创建一个名为 cli.rb 的文件，并添加以下代码：

// www.javascriptcn.com code example
require 'thor'

class MyCLI < Thor
  desc "hello NAME", "says hello to NAME"
  def hello(name)
    puts "Hello, #{name}!"
  end

  desc "goodbye NAME", "says goodbye to NAME"
  def goodbye(name)
    puts "Goodbye, #{name}!"
  end
end

MyCLI.start

这个 CLI 应用程序定义了两个命令：hello 和 goodbye。它们分别接受一个参数 name 并打印一条问候语。

运行 CLI 应用程序

为了方便运行 CLI 应用程序，我们可以创建一个 bin 目录并在其中放置一个可执行脚本。在项目根目录下创建 bin 目录，并在该目录中创建一个名为 my_cli 的文件：

mkdir bin
touch bin/my_cli

编辑 bin/my_cli 文件，添加以下内容：

#!/usr/bin/env ruby
require_relative '../lib/cli.rb'

确保脚本具有可执行权限：

chmod +x bin/my_cli

现在，你可以通过运行以下命令来测试你的 CLI 应用程序：

./bin/my_cli hello world
./bin/my_cli goodbye world

你应该会看到如下输出：

Hello, world!
Goodbye, world!

添加更多的功能

现在，让我们为 CLI 应用程序添加更多的功能。我们将实现一个简单的计数器功能，用户可以增加或减少计数器的值。

首先，在 MyCLI 类中添加新的方法：

// www.javascriptcn.com code example
class MyCLI < Thor
  desc "hello NAME", "says hello to NAME"
  def hello(name)
    puts "Hello, #{name}!"
  end

  desc "goodbye NAME", "says goodbye to NAME"
  def goodbye(name)
    puts "Goodbye, #{name}!"
  end

  desc "increment COUNT", "increments the counter by COUNT"
  method_option :count, aliases: '-c', type: :numeric, default: 1, desc: 'The number to increment by'
  def increment(count)
    @counter ||= 0
    @counter += count
    puts "Counter incremented by #{count}. Current value: #{@counter}"
  end

  desc "decrement COUNT", "decrements the counter by COUNT"
  method_option :count, aliases: '-c', type: :numeric, default: 1, desc: 'The number to decrement by'
  def decrement(count)
    @counter ||= 0
    @counter -= count
    puts "Counter decremented by #{count}. Current value: #{@counter}"
  end
end

MyCLI.start

这里我们添加了 increment 和 decrement 方法。这两个方法都接受一个选项 count，默认值为 1。@counter 变量用于存储计数器的当前值。

现在，你可以运行以下命令来测试这些新功能：

./bin/my_cli increment 5
./bin/my_cli decrement 3

你应该会看到如下输出：

Counter incremented by 5. Current value: 5
Counter decremented by 3. Current value: 2

处理异常和错误

在实际应用中，我们需要处理可能出现的错误和异常。例如，用户可能输入了无效的数字。我们可以使用 Thor::Error 来抛出异常并提供友好的错误信息。

修改 increment 和 decrement 方法，添加错误处理逻辑：

// www.javascriptcn.com code example
class MyCLI < Thor
  desc "hello NAME", "says hello to NAME"
  def hello(name)
    puts "Hello, #{name}!"
  end

  desc "goodbye NAME", "says goodbye to NAME"
  def goodbye(name)
    puts "Goodbye, #{name}!"
  end

  desc "increment COUNT", "increments the counter by COUNT"
  method_option :count, aliases: '-c', type: :numeric, default: 1, desc: 'The number to increment by'
  def increment(count)
    raise Thor::Error, "Count must be a positive number" unless count.positive?
    @counter ||= 0
    @counter += count
    puts "Counter incremented by #{count}. Current value: #{@counter}"
  end

  desc "decrement COUNT", "decrements the counter by COUNT"
  method_option :count, aliases: '-c', type: :numeric, default: 1, desc: 'The number to decrement by'
  def decrement(count)
    raise Thor::Error, "Count must be a positive number" unless count.positive?
    @counter ||= 0
    @counter -= count
    puts "Counter decremented by #{count}. Current value: #{@counter}"
  end
end

MyCLI.start

现在，如果你尝试传递一个负数给 increment 或 decrement 命令，CLI 应用程序将抛出一个错误并终止执行：

./bin/my_cli increment -5

输出：

Error: Count must be a positive number

总结

通过本章的学习，你已经掌握了如何使用 Ruby 和 Thor 库来创建一个功能丰富的 CLI 应用程序。你可以根据需要继续扩展这个应用程序，添加更多的命令和功能。希望你在构建 CLI 工具的过程中能够享受到编程的乐趣！