Analytical 项目技术文档

2024-12-20 08:39:48作者：幸俭卉

1. 安装指南

1.1 环境要求

Ruby on Rails 应用程序
支持的 Ruby 版本

1.2 安装步骤

在 Gemfile 中添加以下内容：
```
gem 'analytical'
```
运行以下命令安装 gem：
```
bundle install
```

在 Rails 应用程序的 config/initializers 目录下创建一个名为 analytical.rb 的文件，并添加以下内容：

Analytical.setup do |config|
  config.google.key = 'UA-5555555-5'
  config.clicky.key = '55555'
  # 其他配置项
end

2. 项目的使用说明

2.1 基本使用

在 Rails 控制器中添加以下代码以启用 Analytical：

analytical

2.2 配置文件

在 config/analytical.yml 文件中配置 API 密钥：

production:
  google:
    key: UA-5555555-5
  clicky:
    key: 55555
development:
test:

2.3 模板文件

在模板文件中添加 Analytical 的辅助方法以初始化跟踪 JavaScript：

<!DOCTYPE html>
<html>
  <head>
    <%= raw analytical.head_prepend_javascript %>
    <title>Example</title>
    <%= stylesheet_link_tag :all %>
    <%= javascript_include_tag :defaults %>
    <%= csrf_meta_tag %>
    <% analytical.identify '5', :email=>'josh@transfs.com' %>
    <%= raw analytical.head_append_javascript %>
  </head>
  <body>
    <%= raw analytical.body_prepend_javascript %>
    <%= yield %>
    <%= raw analytical.body_append_javascript %>
  </body>
</html>

2.4 条件性识别

在模板文件中添加条件性识别命令：

<% analytical.identify(current_user.id, :email=>current_user.email) if current_user %>

2.5 跟踪方法

在视图和控制器中使用 track() 和 event() 方法进行跟踪：

analytical.track '/a/really/nice/url'
analytical.event 'Some Awesome Event', :with=>:data

3. 项目API使用文档

3.1 模块配置

在控制器中配置模块：

analytical :modules=>[:console, :google, :clicky]

3.2 动态模块配置

动态指定模块及其配置：

analytical :modules => lambda{ |controller| controller.analytical_modules }

3.3 禁用分析

条件性禁用分析：

analytical :disable_if => lambda{ |controller| controller.i_can_haz_tracking? }

3.4 过滤模块

动态过滤活动模块：

analytical :filter_modules => lambda{ |controller, modules|
  controller.use_google_analytics? ? modules : modules - [:google]
}

4. 项目安装方式

4.1 通过 Gemfile 安装

在 Gemfile 中添加 gem 'analytical'，然后运行 bundle install。

4.2 手动安装

通过命令行手动安装 gem：

gem install analytical

4.3 配置文件

在 config/analytical.yml 中配置 API 密钥。

4.4 初始化

在 config/initializers/analytical.rb 中进行初始化配置。

通过以上步骤，您可以成功安装并使用 Analytical 项目，实现对多个分析服务的管理。

登录后查看全文