开源项目 Mutations 使用教程

开源项目 Mutations 使用教程

mutationsCompose your business logic into commands that sanitize and validate input.项目地址:https://gitcode.com/gh_mirrors/mu/mutations

项目介绍

Mutations 是一个用于处理 Ruby on Rails 应用中表单验证的开源库。它提供了一种简洁的方式来定义和执行复杂的验证规则，使得开发者能够更高效地处理表单数据的有效性。

项目快速启动

安装

首先，确保你已经安装了 Ruby 和 Rails。然后在你的 Rails 项目目录中，添加以下内容到你的 Gemfile：

gem 'mutations'

接着运行：

bundle install

基本使用

创建一个新的文件 app/commands/create_user.rb，并添加以下代码：

class CreateUser < Mutations::Command
  required do
    string :username
    string :email
  end

  optional do
    string :first_name
    string :last_name
  end

  def execute
    User.create!(inputs)
  end
end

在控制器中使用这个命令：

class UsersController < ApplicationController
  def create
    outcome = CreateUser.run(params[:user])

    if outcome.success?
      render json: outcome.result
    else
      render json: outcome.errors, status: :unprocessable_entity
    end
  end
end

应用案例和最佳实践

应用案例

假设你正在开发一个用户管理系统，你需要确保用户提交的表单数据是有效的。使用 Mutations，你可以轻松地定义复杂的验证规则，例如：

class UpdateUser < Mutations::Command
  required do
    integer :id
  end

  optional do
    string :username, min_length: 3, max_length: 20
    string :email, matches: /@/
  end

  def execute
    user = User.find(id)
    user.update!(inputs.except(:id))
    user
  end
end

最佳实践

1. 分离关注点：将验证逻辑从控制器中分离出来，使得代码更加清晰和易于维护。
2. 使用输入过滤：通过 required 和 optional 块来定义输入字段，确保只处理预期的数据。
3. 错误处理：在控制器中检查 outcome.success? 并相应地处理错误，提供友好的错误信息给用户。

典型生态项目

Mutations 可以与其他 Ruby on Rails 生态系统中的项目很好地集成，例如：

1. ActiveRecord：用于数据库操作，Mutations 可以与 ActiveRecord 模型无缝集成。
2. RSpec：用于测试，你可以编写测试用例来验证你的 Mutations 命令是否按预期工作。
3. Devise：用于用户认证，Mutations 可以用于处理复杂的用户注册和更新逻辑。

通过这些集成，你可以构建一个强大且易于维护的 Rails 应用。

mutationsCompose your business logic into commands that sanitize and validate input.项目地址:https://gitcode.com/gh_mirrors/mu/mutations