WillFilter 项目技术文档

1. 安装指南

1.1 环境准备

在开始安装之前，请确保您的开发环境已经安装了以下工具：

• Ruby
• Rails
• Bundler

1.2 安装步骤

1. 在您的 Rails 项目的 Gemfile 中添加以下 gem：

   gem 'will_filter'
   gem 'kaminari'
   

2. 运行以下命令安装 gem：

   $ bundle
   

3. 配置并初始化 will_filter 引擎，运行以下命令：

   $ rails generate will_filter
   $ rake db:migrate
   

4. 在 config/routes.rb 文件的顶部添加以下行：

   mount WillFilter::Engine => "/will_filter"
   

2. 项目的使用说明

2.1 基本使用

在您的控制器中，使用 filter 方法来添加过滤功能。例如，在 UsersController 中：

class UsersController < ApplicationController
  def index
    @users = User.filter(:params => params)
  end
end

在视图中，使用 will_filter_tag 和 will_filter_table_tag 来渲染过滤器和结果表：

<%= will_filter_tag(@users) %>
<%= will_filter_table_tag(@users) %>

2.2 自定义过滤器

您可以通过创建自定义过滤器来排除某些属性。例如，创建一个 UserFilter 类：

class UserFilter < WillFilter::Filter
  def definition
    super.except(:id, :created_at, :updated_at)
  end
end

然后在控制器中使用该过滤器：

@users = User.filter(:params => params, :filter => :user_filter)

2.3 自定义表格视图

您可以通过指定列来定制表格的显示。例如，只显示 id、first_name、last_name、birthday 和 sex 列：

<%= will_filter_table_tag(@users, :columns => [:id, :first_name, :last_name, :birthday, :sex]) %>

3. 项目API使用文档

3.1 filter 方法

filter 方法用于在控制器中生成过滤后的结果集。其基本用法如下：

@users = User.filter(:params => params)

3.2 will_filter_tag 方法

will_filter_tag 方法用于在视图中渲染过滤器。其基本用法如下：

<%= will_filter_tag(@users) %>

3.3 will_filter_table_tag 方法

will_filter_table_tag 方法用于在视图中渲染过滤后的结果表。其基本用法如下：

<%= will_filter_table_tag(@users) %>

4. 项目安装方式

4.1 通过 Gemfile 安装

在 Gemfile 中添加 will_filter 和 kaminari gem，然后运行 bundle 命令进行安装。

4.2 初始化引擎

运行以下命令初始化 will_filter 引擎：

$ rails generate will_filter
$ rake db:migrate

4.3 配置路由

在 config/routes.rb 文件中添加以下行：

mount WillFilter::Engine => "/will_filter"

通过以上步骤，您可以成功安装并使用 will_filter 插件，为您的 Rails 项目添加强大的过滤功能。