to_lang 项目技术文档

1. 安装指南

要安装 to_lang，您需要执行以下命令：

gem install to_lang

此命令将使用 Ruby 的包管理器 Gem 来安装库。

2. 项目使用说明

to_lang 是一个 Ruby 库，可以为字符串和数组添加语言翻译方法，这些方法基于 Google Translate API。要使用这个库，您需要先加载库，然后通过您的 Google Translate API 密钥调用 ToLang.start 方法。之后，您将可以使用形如 to_language 的翻译方法，其中 "language" 是您希望翻译成的语言。

Google Translate 会尝试检测源语言，但您也可以通过调用形式为 to_target_language_from_source_language 的方法来显式指定源语言，其中 "target language" 是您要翻译成的语言，而 "source_language" 是起始语言。也存在一个功能相同但顺序颠倒的方法 from_source_language_to_target_language。这些方法是动态生成的，在调用 String.instance_methods 或 Array.instance_methods 时不会出现，直到它们被调用一次后。但是，字符串和数组会在调用 respond_to? 方法之前响应这些方法。

动态方法仅仅是 String#translate 和 Array#translate 方法的语法糖，您可以直接使用这些方法。

to_lang 还提供了一个命令行工具，用于从 shell 进行快速翻译。

3. 项目API使用文档

以下是使用 to_lang 的几个示例：

字符串示例

加载并初始化 to_lang：

require 'to_lang'

ToLang.start('YOUR_GOOGLE_TRANSLATE_API_KEY')

将一些文本翻译成西班牙语：

"Very cool gem!".to_spanish # => "Muy fresco joya!"

在源语言模糊的情况下：

"a pie".to_spanish # => "a pie"
"a pie".to_spanish_from_english # => "un pastel"

或者等价地：

"a pie".from_english_to_spanish # => "un pastel"

直接使用 String#translate 方法：

"hello world".translate('es') # => "hola mundo"
"a pie".translate('es', from: 'en') # => "un pastel"

数组示例

数组可以用来在一次方法调用和单个 HTTP 请求中翻译一批字符串。上面显示的相同方法也适用于数组。例如，将一个字符串数组翻译成西班牙语：

["One", "Two", "Three"].to_spanish # => ["Uno", "Dos", "Tres"]

调试

translate 方法还允许您为翻译获取调试输出。translate 接受一个 :debug 选项，该选项有三个可能的值：:request、:response 和 :all。:request 将使方法返回一个哈希，该哈希包含将发送到 Google Translate API 的参数。:response 将使方法返回 API 调用的完整响应，作为一个哈希。:all 将使方法返回一个哈希，该哈希包含请求哈希和完整响应。

"hello world".translate('es', debug: :request)
# => {:key=>"my_key", :q=>"hello world", :target=>"es"}

"hello world".translate('es', debug: :response)
# => {"data"=>{"translations"=>[{"translatedText"=>"hola mundo", "detectedSourceLanguage"=>"en"}]}}

"hello world".translate('es', debug: :all)
# => {:request=>{:key=>"my_key", :q=>"hello world", :target=>"es"},
#    :response=>{"data"=>{"translations"=>[{"translatedText"=>"hola mundo",
#    "detectedSourceLanguage"=>"en"}]}}}

命令行接口

命令行工具 to_lang 具有以下接口：

to_lang [--key API_KEY] [--from 源语言] --to 目标语言 字符串 [字符串, ...]

to_lang 接受一个空格分隔的字符串列表进行翻译。至少需要一个字符串，同时必须要有 --to 选项，它接受一个语言代码（例如 "es"）。to_lang 将尝试从 GOOGLE_TRANSLATE_API_KEY 环境变量中加载 Google Translate API 密钥。如果没有可用的密钥，它必须通过 --key 选项从命令行传递。要获取完整的用法说明，请使用 --help 选项调用实用程序。

示例：

直接从命令行传递密钥的简单翻译：

to_lang --key YOUR_GOOGLE_TRANSLATE_API_KEY --to es "hello world"
hola mundo

当密钥在环境变量中，并且有多个字符串时：

to_lang --to es "hello world" "a pie"
hola mundo
a pie

指定源语言：

to_lang --from en --to es "hello world" "a pie"
hola mundo
un pastel

4. 项目安装方式

关于安装方式的详细说明，请参考本文档的“安装指南”部分。简而言之，您可以通过 Ruby 的 Gem 包管理器使用以下命令来安装 to_lang：

gem install to_lang