项目技术文档：acts_as_taggable_on_steroids 插件

1. 安装指南

根据 Rails 版本的不同，安装 acts_as_taggable_on_steroids 插件的方式也有所不同：

• 对于 Rails 2.* 版本：

  ruby script/plugin install git://github.com/jviney/acts_as_taggable_on_steroids.git
  

• 对于 Rails 3 版本：

  rails plugin install git://github.com/jviney/acts_as_taggable_on_steroids.git
  

安装完成后，需要对数据库进行迁移。

2. 项目的使用说明

准备数据库

首先，生成迁移脚本并应用迁移：

ruby script/generate acts_as_taggable_migration
rake db:migrate

基本标签使用

假设用户有多种帖子，且希望帖子具有标签功能。首先需要在 Post 类中添加 acts_as_taggable：

class Post < ActiveRecord::Base
  acts_as_taggable
  belongs_to :user
end

此时，可以使用 acts_as_taggable 提供的 tag_list 和 tag_list= 方法。这两个方法类似于常规属性访问器。

例如：

p = Post.find(:first)
p.tag_list # []
p.tag_list = "Funny, Silly"
p.save
p.tag_list # ["Funny", "Silly"]

还可以添加或删除标签数组：

p.tag_list.add("Great", "Awful")
p.tag_list.remove("Funny")

在视图中，可以使用以下代码：

<%= f.label :tag_list %>
<%= f.text_field :tag_list, :size => 80 %>

查找标记对象

使用 find_tagged_with 方法检索具有特定标签的对象：

Post.find_tagged_with('Funny, Silly')

默认情况下，find_tagged_with 将找到具有给定任一标签的对象。若要找到仅具有所有给定标签的对象，请使用 match_all 选项：

Post.find_tagged_with('Funny, Silly', :match_all => true)

更多方法和选项，请参见 ActiveRecord::Acts::Taggable::InstanceMethods。

标签云计算

要构建标签云，需要计算每个标签的频率。因为已在 Post 类中指定了 acts_as_taggable，所以可以使用 Post.tag_counts 来获取所有标签的计数。

若要获取单个用户帖子的标签计数，可以在关联上调用 tag_counts：

User.find(:first).posts.tag_counts

包含一个辅助方法来帮助生成标签云。在帮助文件中包含它：

module ApplicationHelper
  include TagsHelper
end

还可以在 Tag 类上使用 counts 方法来获取数据库中所有标签的计数：

Tag.counts

以下是一个生成标签云的示例：

控制器：

class PostController < ApplicationController
  def tag_cloud
    @tags = Post.tag_counts
  end
end

视图：

<% tag_cloud @tags, %w(css1 css2 css3 css4) do |tag, css_class| %>
  <%= link_to tag.name, { :action => :tag, :id => tag.name }, :class => css_class %>
<% end %>

CSS：

.css1 { font-size: 1.0em; }
.css2 { font-size: 1.2em; }
.css3 { font-size: 1.4em; }
.css4 { font-size: 1.6em; }

缓存

为了减少执行查询的数量，可以缓存标签列表。为此，需要在被标记的模型中添加一个名为 cached_tag_list 的列。该列应足够长，以容纳完整的标签列表，并且必须具有默认值为 null，而不是空字符串。

迁移示例：

class CachePostTagList < ActiveRecord::Migration
  def self.up
    add_column :posts, :cached_tag_list, :string
  end
end

在 Post 类中，可以指定缓存的列名（默认为 cached_tag_list）：

class Post < ActiveRecord::Base
  acts_as_taggable
  # 可以更改缓存的列名：
  # set_cached_tag_list_column_name "my_caching_column_name"
end

缓存细节会自动处理。但是，如果直接创建 Tagging 对象或手动修改 tags 或 taggings 关联，缓存的标签列表将不会更新。要更新缓存的标签列表，应手动调用 save_cached_tag_list。

分隔符

如果想要更改用于解析和显示标签的分隔符，可以设置 TagList.delimiter。例如，若要使用空格代替逗号，可以在 config/environment.rb 中添加以下内容：

TagList.delimiter = " "

未使用标签

设置 Tag.destroy_unused 为 true 时，当标签不再被任何对象使用时，将自动删除该标签。默认为 false。

其他

有任何问题、评论或建议，欢迎通过邮箱 [e-mail] 联系。

3. 项目API使用文档

此插件提供了多种方法供开发者使用，以下是一些主要方法的简要说明：

• acts_as_taggable: 在模型中启用标签功能。
• tag_list: 获取模型的标签列表。
• tag_list=: 设置模型的标签列表。
• find_tagged_with: 根据标签查找模型。
• tag_counts: 获取标签的使用次数。

更多方法和详细说明请参考插件的代码和文档。

4. 项目安装方式

请参考本文档的“安装指南”部分。