Configatron 使用与技术文档

1. 安装指南

Configatron 的安装非常简单。您可以通过将其添加到应用程序的 Gemfile 中来实现：

gem 'configatron'

然后执行以下命令：

$ bundle

或者，您也可以自行安装：

$ gem install configatron --pre

2. 项目使用说明

Configatron 使得配置您的应用程序和脚本变得极其简单。现在，您无需再使用常量或全局变量。您可以使用一个简单且无痛的系统来配置生活。而且，因为它是 Ruby 编写的，您可以做任何您想做的疯狂事情！

简单配置

configatron.email = '[e-mail]'
configatron.database.url = "postgres://localhost/foo"

现在，在任何代码中，您都可以：

configatron.email # => "[e-mail]"
configatron.database.url # => "postgres://localhost/foo"

默认配置与覆盖

如果您想要设置默认选项，稍后根据其他信息覆盖它们，也非常简单。以下是一个示例：

configatron.database.url = "postgres://localhost/foo_development"

这样，其他配置参数不会改变。

使用 Hash/YAML 配置

您还可以从哈希（特别是如果需要配置文件）中配置 Configatron：

configatron.configure_from_hash(email: {pop: {address: 'pop.example.com', port: 110}}, smtp: {address: 'smtp.example.com'})

命名空间

Configatron 允许您创建命名空间，这样您就可以轻松地管理和访问嵌套的配置参数。

configatron.email.pop.address = "pop.example.com"
configatron.email.pop.port = 110

您可以无限地嵌套命名空间，并且还可以使用块来清理配置。

临时配置

在某些测试或其他情况下，您可能想要临时更改一些设置。您可以使用 temp 方法来做到这一点。

configatron.temp do
  configatron.letters.b = 'bb'
  configatron.letters.c = 'c'
end

延迟和动态配置

Configatron 还支持延迟和动态设置，允许您根据其他配置设置来引用配置设置。

延迟配置

使用 Delayed 设置，设置的实际执行将在首次调用时进行。

动态配置

与 Delayed 设置类似，但每次调用动态设置时都会执行。

重置配置

在某些测试场景中，将 Configatron 重置为其默认状态可能很有用。

configatron.reset!

检查键

即使参数尚未设置，您仍然可以调用它们，但会得到一个 Configatron::Store 对象。您可以使用 .has_key? 来确定键是否存在。

强制获取键

您还可以在键的末尾附加一个 !。如果键存在，它将返回它，否则将引发错误。

核心功能

您可以选择不使用全局的 configatron 辅助方法，通过要求 configatron/core 而不是 configatron。

锁定配置

一旦设置好所有配置，您可以通过调用 lock! 方法来锁定设置。

3. 项目API使用文档

Configatron 提供了丰富的 API 用于配置管理。以下是部分 API 的使用说明：

• configatron.set(key, value)：设置配置值。
• configatron.get(key)：获取配置值。
• configatron.has_key?(key)：检查配置键是否存在。
• configatron.reset!：重置所有配置为默认值。
• configatron.lock!：锁定配置，防止进一步更改。

更多 API 文档，请参考官方文档。

4. 项目安装方式

请遵循以下步骤来安装 Configatron：

1. 将 gem 'configatron' 添加到您的 Gemfile。
2. 运行 bundle install 命令或手动安装 Gem。
3. 在您的 Ruby 应用程序中 require 'configatron'。
4. 按照使用说明配置您的项目。

通过上述步骤，您应该可以成功安装并开始使用 Configatron。