Informal 项目技术文档

以下为Informal项目的详细技术文档，包含安装指南、使用说明以及API使用文档。

1. 安装指南

Informal是一个Ruby gem，可以通过以下方式安装：

• 使用gem install informal命令安装。
• 将其添加到Bundler的Gemfile中。

安装完成后，无需进行任何配置。

2. 项目的使用说明

Informal项目允许用户使用Rails 3的表单助手替代ActiveRecord模型。它可以与form_for助手以及simple_form一起使用。

以下是一个示例：

# models/command.rb
require "informal"
class Command
  include Informal::Model
  attr_accessor :command, :args
  validates_presence_of :command
  def run; `#{command} #{args}`; end
end

# views/commands/new.html.erb
<%= form_for @command do |form| %>
  <%= form.text_field :command %>
  <%= form.text_field :args %>
  <%= form.submit "Do It!" %>
<% end %>

# controllers/commands_controller.rb
def create
  command = Command.new(params[:command])
  if command.valid?
    command.run
  end
end

初始化、#super 和属性

如果你包含Informal::Model，你的类将自动获得一个#initialize方法，该方法接受一个params哈希，并为哈希中的所有属性调用setter方法。如果你的模型类继承自一个具有自己的#initialize方法且需要调用super的类，你应该包含Informal::ModelNoInit，它不会创建#initialize方法。你需要自己创建#initialize方法，并在其中使用#attributes=方法分配属性，同时使用所需的参数调用super。

重写model_name

如果你的模型名为InformalCommand，表单参数将被传递到控制器的params[:informal_command]哈希中。由于这种方式略显丑陋，且可能不符合替代真实ActiveRecord模型的要求，Informal提供了重写模型名称的方法。

class InformalCommand
  informal_model_name "Command"
  # ...
end

注意：informal_model_name功能仅在Rails 3.1或更高版本中可用（除非有人将所需的API更改回传到3.0.x版本）。

特殊行为

Rails通常为新建记录生成的ID格式为command_new，而持久化记录为command_17。在使用informal模型时，经常需要在每个页面上使用多个模型，因此使用模型的object_id来获取唯一ID会很有帮助。在DOM中，这些ID看起来像command_2157193640，如果你只是用它们来附加脚本，这些内存地址的用途并不会让人感到害怕。

3. 项目API使用文档

• include Informal::Model：包含Informal模型功能。
• attr_accessor：定义模型的属性。
• validates_presence_of：验证属性是否存在。
• run：执行命令。
• informal_model_name：重写模型名称。

4. 项目安装方式

请参考上述安装指南。