I18nAlchemy 技术文档

1. 安装指南

在开始使用 I18nAlchemy 之前，请确保您的系统已经安装了 Ruby 和 Rails 环境。以下是安装 I18nAlchemy 的步骤：

1. 将以下代码添加到您的 Gemfile 文件中：

   gem 'i18n_alchemy'
   

2. 在 Gemfile 文件所在目录下运行以下命令安装 Gem：

   bundle install
   

3. 在 Rails 应用的配置文件（通常是 config/application.rb）中，确保已经加载了 i18n_alchemy：

   config.autoload_paths += %W(#{config.root}/app/models/concerns)
   

4. 在 ActiveRecord 模型中包含 I18n::Alchemy：

   class Product < ActiveRecord::Base
     include I18n::Alchemy
   end
   

2. 项目的使用说明

I18nAlchemy 旨在处理日期、时间和数字的解析和本地化。主要思想是让 ORM（如当前的 ActiveRecord）自动接受当前语言环境格式的日期/数字，并返回本地化的值。

使用示例

假设我们正在处理一个 Product 模型：

class Product < ActiveRecord::Base
  include I18n::Alchemy
end

@product = Product.first
@localized = @product.localized

以下是使用数字的一些示例：

@localized.price = "1.99"

@product.price   # => 1.99
@localized.price # => "1.99"

I18n.with_locale :pt do
  @localized.price = "1,88"

  @product.price   # => 1.88
  @localized.price # => "1,88"
end

以下是使用日期对象的示例：

@localized.released_at = "12/31/2011"

@product.released_at   # => Date.new(2011, 12, 31)
@localized.released_at # => "12/31/2011"

I18n.with_locale :pt do
  @localized.released_at = "31/12/2011"

  @product.released_at   # => Date.new(2011, 12, 31)
  @localized.released_at # => "31/12/2011"
end

本地化方法

localized 方法的行为类似于 ActiveRecord：您可以提供一个包含属性的哈希和额外选项，它将代理所有内容，并在代理之前解析属性：

I18n.with_locale :pt do
  @localized = @product.localized(:price => "1,88")

  @product.price   # => 1.88
  @localized.price # => "1,88"
end

本地化方法

给定一个具有 total 方法的 Product 模型，该方法简单地计算 quantity * price，您可以让 I18n::Alchemy 为您本地化该方法以及属性：

class Product < ActiveRecord::Base
  include I18n::Alchemy
  localize :total, :using => :number

  def total
    quantity * price
  end
end

@product          = Product.first
@product.price    = 1.99
@product.quantity = 10

@product.total   # => 19.90
@localized.total # => "19,90"

如果方法具有设置器方法（如 total=），那么输入值也会得到解析版本。

使用 localize 可以本地化不是从 ActiveRecord::Base 继承的对象，只要您的类具有读写方法：

class Product
  include I18n::Alchemy
  localize :released_at, :using => :date

  attr_accessor :released_at
end

3. 项目API使用文档

I18nAlchemy 提供以下模块和方法供您使用：

• I18n::Alchemy: 主模块，包含日期、时间和数字解析和本地化的功能。
• include I18n::Alchemy: 在模型中包含该模块，以使用其功能。
• localized: 方法用于本地化模型属性。
• localize: 类方法，用于指定要本地化的属性和方法。

4. 项目安装方式

请参考上述“安装指南”部分的内容进行安装。

以上是关于 I18nAlchemy 的技术文档，希望对您有所帮助。