Forty Facets 使用教程

项目介绍

Forty Facets 是一个用于在 Rails 应用程序中轻松构建探索性搜索界面的 Ruby gem。它基于 ActiveRecord 模型的字段，提供了强大的搜索和过滤功能。Forty Facets 的目标是简化搜索界面的开发过程，使开发者能够快速实现复杂的搜索需求。

项目快速启动

安装

首先，在您的 Gemfile 中添加以下内容：

gem 'forty_facets'

然后运行：

bundle install

创建搜索类

假设您有一个名为 Movie 的 ActiveRecord 模型，您可以创建一个对应的搜索类：

class MovieSearch < FortyFacets::FacetSearch
  model 'Movie'
  text :title, name: '标题'
  range :price, name: '价格'
  facet :genre, name: '类型'
  facet :year, order: Proc.new { |year| -year }
  facet :studio, name: '工作室', order: :name
  orders '标题' => :title,
         '价格低优先' => "price asc",
         '价格高优先' => [price: :desc, title: :desc]
end

在控制器中使用

在您的控制器中，您可以这样使用：

class MoviesController < ApplicationController
  def index
    @search = MovieSearch.new(params)
    @movies = @search.result.paginate(page: params[:page], per_page: 9)
  end
end

视图中渲染

在您的视图中，您可以这样渲染搜索结果和过滤器：

<%= form_tag movies_path, method: :get do %>
  <%= text_field_tag :title, params[:title] %>
  <%= submit_tag '搜索' %>
<% end %>

<% @search.filter(:studio).facet_each do |facet_value| %>
  <% if facet_value.selected? %>
    <%= link_to "#{facet_value.name} (#{facet_value.count})", @search.filter_add(facet_value).path %>
  <% else %>
    <%= link_to facet_value.name, @search.filter_remove(facet_value).path %>
  <% end %>
<% end %>

<% @movies.each do |movie| %>
  <div>
    <h2><%= movie.title %></h2>
    <p>价格: <%= movie.price %></p>
    <p>类型: <%= movie.genre.name %></p>
    <p>年份: <%= movie.year %></p>
    <p>工作室: <%= movie.studio.name %></p>
  </div>
<% end %>

应用案例和最佳实践

应用案例

Forty Facets 可以用于各种需要复杂搜索和过滤功能的 Rails 应用程序，例如：

• 电子商务网站的产品搜索
• 内容管理系统的内容过滤
• 数据分析平台的报表筛选

最佳实践

• 保持搜索类简洁：尽量保持搜索类的定义简洁明了，避免过度复杂的逻辑。
• 充分利用 ActiveRecord 功能：Forty Facets 基于 ActiveRecord，因此可以充分利用 ActiveRecord 提供的各种查询功能。
• 考虑性能：虽然 Forty Facets 在数据库层面处理搜索和过滤，但在处理大量数据时仍需考虑性能问题。

典型生态项目

Forty Facets 可以与其他 Rails 生态项目结合使用，例如：

• Kaminari：用于分页功能。
• Simple Form：用于生成表单。
• Devise：用于用户认证。

通过这些生态项目的结合，可以进一步增强 Forty Facets 的功能和用户体验。