Amountable 开源项目教程

Amountable 开源项目教程

amountable An easy and transparent way to attach, manage and sum Money fields to your ActiveRecord models. 项目地址: https://gitcode.com/gh_mirrors/am/amountable

1. 项目介绍

Amountable 是一个用于在 ActiveRecord 模型中轻松、透明地附加、管理和汇总 Money 字段的开源项目。它通过避免每次添加新列来简化 Money 字段的集成，并帮助管理模型中各个组件的汇总，以确保金额定义在整个应用程序中保持一致。

2. 项目快速启动

安装

首先，将 amountable 添加到你的 Gemfile 中：

gem 'amountable', github: 'instacart/amountable'

然后运行以下命令来安装和迁移数据库：

bundle install
rake amountable:install:migrations
rake db:migrate

使用

在你的模型中使用 act_as_amountable 方法来定义金额字段：

class Order < ActiveRecord::Base
  act_as_amountable amount: :subtotal, sets: [:total]
  act_as_amountable amount: :delivery_fee, sets: [:total, :fees]
  act_as_amountable amount: :bags_fee, sets: [:total, :fees]
  act_as_amountable amount: :sales_tax, sets: [:total, :taxes]
  act_as_amountable amount: :local_tax, sets: [:total, :taxes]
end

创建一个订单并设置金额：

order = Order.create(
  subtotal: Money.new(123),
  delivery_fee: Money.new(100),
  bags_fee: Money.new(10),
  sales_tax: Money.new(56)
)

order.subtotal # => #<Money fractional:123 currency:USD>
order.total # => #<Money fractional:289 currency:USD>
order.fees # => #<Money fractional:110 currency:USD>
order.taxes # => #<Money fractional:56 currency:USD>

3. 应用案例和最佳实践

应用案例

Amountable 适用于需要处理多种货币和金额的电子商务平台、财务管理系统等场景。例如，一个在线商店可以使用 Amountable 来管理订单的总金额、运费、税费等。

最佳实践

1. 金额字段定义：在模型中清晰定义每个金额字段及其对应的汇总字段，确保金额计算的准确性。
2. 金额存储方式：根据需求选择 :table 或 :jsonb 存储方式，:jsonb 适合需要灵活存储金额的场景。
3. 金额计算优化：避免在查询中频繁计算金额，尽量在创建或更新时完成金额的汇总。

4. 典型生态项目

Amountable 可以与其他处理货币和金额的开源项目结合使用，例如：

• Money：一个用于处理货币和金额的 Ruby 库，与 Amountable 配合使用可以更好地管理货币类型和金额计算。
• ActiveRecord：Ruby on Rails 的 ORM 框架，Amountable 作为 ActiveRecord 的扩展，可以无缝集成到 Rails 应用中。
• RailsAdmin：一个用于管理 Rails 应用后台的 gem，可以与 Amountable 结合使用，方便管理后台中的金额字段。

通过这些生态项目的结合，可以构建一个功能强大且易于维护的金额管理系统。

amountable An easy and transparent way to attach, manage and sum Money fields to your ActiveRecord models. 项目地址: https://gitcode.com/gh_mirrors/am/amountable