Puffer 项目技术文档

1. 安装指南

1.1 安装方式

Puffer 可以通过以下两种方式进行安装：

1.1.1 通过 Gem 安装

gem install puffer

1.1.2 在 Gemfile 中添加

gem "puffer", :git => "git://github.com/puffer/puffer.git"

1.2 安装后的操作

安装完成后，需要为管理界面创建安全系统，包括用户模型和会话控制器。有两种情况：

1.2.1 集成认证系统

执行以下命令以激活集成认证系统：

rails g puffer:puffer_user

这将创建模型、迁移、控制器和路由。

1.2.2 外部认证系统

如果应用程序已经使用了某种认证系统（如 Devise、Clearance 或 Sorcery），则需要创建自定义的 SessionsController。

例如，使用 Clearance 时：

class Admin::SessionsController < Puffer::Sessions::Clearance
end

2. 项目使用说明

2.1 生成控制器

假设应用程序的数据结构如下：

create_table "users", :force => true do |t|
  t.string   "email"
  t.string   "password"
  t.datetime "created_at"
  t.datetime "updated_at"
end

create_table "posts", :force => true do |t|
  t.integer  "user_id"
  t.string   "title"
  t.text     "body"
  t.datetime "created_at"
  t.datetime "updated_at"
end

模型如下：

class User < ActiveRecord::Base
  has_many :posts
  validates_presence_of :email, :password
  validates_length_of :password, :minimum => 6
end

class Profile < ActiveRecord::Base
  belongs_to :user
  validates_presence_of :name, :surname
end

生成 Puffer 控制器：

rails g puffer:controller User
rails g puffer:controller Post

生成的控制器代码如下：

class Admin::PostsController < Puffer::Base
  setup do
    group :posts
  end

  index do
    field :id
    field :user_id
    field :title
    field :body
    field :created_at
    field :updated_at
  end

  form do
    field :id
    field :user_id
    field :title
    field :body
    field :created_at
    field :updated_at
  end
end

2.2 路由配置

配置路由：

namespace :admin do
  resources :users do
    resources :posts
  end
  resources :posts
end

3. 项目 API 使用文档

3.1 控制器 DSL

Puffer 使用 DSL 定义管理界面，以下是一些常用的 DSL 方法：

3.1.1 setup

用于设置控制器的组和操作：

setup do
  group :posts
end

3.1.2 index

定义索引页面的字段：

index do
  field :id
  field :user_id
  field :title
  field :body
  field :created_at
  field :updated_at
end

3.1.3 form

定义表单页面的字段：

form do
  field :id
  field :user_id
  field :title
  field :body
  field :created_at
  field :updated_at
end

3.2 高级用法

Puffer 支持在不同命名空间下工作：

rails g puffer:controller moderator/posts

生成的控制器代码如下：

class Moderator::PostsController < Puffer::Base
  before_filter :require_moderator

  setup do
    destroy false
    group :posting
  end

  index do
    field :user_id
    field :title
    field :body
  end

  form do
    field :user_id
    field :title
    field :body
    field :created_at
    field :updated_at
  end
end

配置路由：

namespace :moderator do
  resources :posts
end

4. 项目安装方式

Puffer 可以通过以下两种方式进行安装：

4.1 通过 Gem 安装

gem install puffer

4.2 在 Gemfile 中添加

gem "puffer", :git => "git://github.com/puffer/puffer.git"

安装完成后，按照上述步骤进行配置和使用。