Configurable 使用与技术文档

1. 安装指南

首先，确保您的项目是一个基于 Rails 4 的应用程序。接下来，执行以下步骤来安装 Configurable Engine：

将以下内容添加到您的 Rails 4 应用的 Gemfile 文件中：

gem 'configurable_engine'

然后，在命令行中运行以下命令来安装该宝石：

$ bundle install

安装宝石后，运行以下生成器来添加配置文件和迁移：

$ rails generate configurable_engine:install

这将添加以下内容：

• config/configurable.yml 配置文件
• 为可配置变量创建数据库迁移
• 在路由中挂载 UI（默认为 /admin/configurable）

完成迁移：

$ rake db:migrate

2. 项目使用说明

Configurable 允许您在 config/configurable.yml 文件中定义应用程序范围配置变量和值。以下是一个示例配置：

site_title:
  name: Site Title
  default: My Site

在应用程序中，您可以通过以下方式访问配置变量：

Configurable[:site_title] # 或者 Configurable.site_title

如果您想要更新配置，您可以创建或更新一个 Configurable 记录：

Configurable.create!(:name => 'site_title', :value => 'My New Site')

您还可以设置字段类型为 boolean、decimal、integer 或 list。

3. 项目API使用文档

Configurable Engine 的 API 使用非常直接。以下是一些基本的使用方法：

• 获取配置变量：

Configurable[:variable_name]

• 设置配置变量：

configurable = Configurable.find_by(name: 'variable_name')
configurable.value = 'new_value'
configurable.save

• 创建新的配置变量：

Configurable.create!(name: 'new_variable', value: 'new_value')

• 删除配置变量：

configurable = Configurable.find_by(name: 'variable_name')
configurable.destroy

4. 项目安装方式

请参考上述“安装指南”部分。

通过以上文档，您应该能够顺利安装并使用 Configurable Engine 来管理和配置您的 Rails 应用程序。如果有任何问题或需要进一步的澄清，请查阅 GitHub 上的项目文档或在相关社区寻求帮助。