assignable_values 项目使用教程

assignable_values 项目使用教程

assignable_values Restrict the values assignable to ActiveRecord attributes or associations. 项目地址: https://gitcode.com/gh_mirrors/as/assignable_values

1. 项目介绍

assignable_values 是一个用于限制 ActiveRecord 模型属性或关联赋值的开源项目。它允许你在运行时动态生成允许的值列表，并在验证过程中检查这些值。这个项目特别适用于需要对属性值进行严格控制的场景，例如在 Web 表单中使用 <select> 标签时，确保用户只能选择预定义的选项。

assignable_values 提供了以下主要功能：

• 限制标量属性：可以限制字符串、整数等标量属性的赋值。
• 人性化标签：支持在 I18n 字典中定义人性化的标签，便于在用户界面中展示。
• 默认值设置：可以为属性设置默认值，支持使用 Proc 动态生成默认值。
• 允许空白值：可以选择是否允许属性值为空。
• 关联限制：可以限制 belongs_to 关联的赋值。

2. 项目快速启动

安装

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

gem 'assignable_values'

然后运行 bundle install 安装依赖。

基本使用

假设你有一个 Song 模型，并且你希望限制 genre 属性的值为 ['pop', 'rock', 'electronic']，你可以这样做：

class Song < ActiveRecord::Base
  assignable_values_for :genre do
    ['pop', 'rock', 'electronic']
  end
end

验证

assignable_values 会在验证过程中检查属性的值是否在允许的列表中：

song = Song.new(genre: 'rock')
song.valid? # => true

song = Song.new(genre: 'elephant')
song.valid? # => false

人性化标签

你可以在 I18n 字典中定义人性化的标签：

en:
  assignable_values:
    song:
      genre:
        pop: 'Pop music'
        rock: 'Rock music'
        electronic: 'Electronic music'

然后你可以获取人性化的标签：

song = Song.new(genre: 'pop')
song.humanized_genre # => 'Pop music'

默认值

你可以为属性设置默认值：

class Song < ActiveRecord::Base
  assignable_values_for :genre, default: 'rock' do
    ['pop', 'rock', 'electronic']
  end
end

允许空白值

如果你希望允许属性值为空，可以使用 allow_blank 选项：

class Song < ActiveRecord::Base
  assignable_values_for :genre, default: 'rock', allow_blank: true do
    ['pop', 'rock', 'electronic']
  end
end

3. 应用案例和最佳实践

案例1：音乐分类

假设你正在开发一个音乐管理应用，你需要确保用户只能选择预定义的音乐分类。使用 assignable_values 可以轻松实现这一需求：

class Song < ActiveRecord::Base
  assignable_values_for :genre do
    ['pop', 'rock', 'electronic', 'classical', 'jazz']
  end
end

案例2：用户角色

在用户管理系统中，你可能需要限制用户角色的选择。使用 assignable_values 可以确保用户只能选择预定义的角色：

class User < ActiveRecord::Base
  assignable_values_for :role do
    ['admin', 'editor', 'viewer']
  end
end

最佳实践

• 动态生成值：在运行时动态生成允许的值列表，确保列表的实时性。
• 人性化标签：使用 I18n 字典定义人性化的标签，提升用户体验。
• 默认值设置：为属性设置合理的默认值，简化用户操作。

4. 典型生态项目

ActiveRecord

assignable_values 是基于 ActiveRecord 的扩展，适用于所有使用 ActiveRecord 的 Rails 项目。它可以帮助你更好地管理模型属性的赋值，确保数据的完整性和一致性。

I18n

assignable_values 与 Rails 的 I18n 系统紧密集成，支持多语言环境下的属性值人性化展示。你可以轻松地在不同语言环境中定义和使用人性化的标签。

Rails 表单

在 Rails 表单中，assignable_values 可以与 collection_select 等表单助手结合使用，生成带有预定义选项的 <select> 标签，提升表单的用户体验。

通过以上模块的介绍和示例，你应该能够快速上手并使用 assignable_values 项目来限制 ActiveRecord 模型属性的赋值。

assignable_values Restrict the values assignable to ActiveRecord attributes or associations. 项目地址: https://gitcode.com/gh_mirrors/as/assignable_values