Mobylette 技术文档

1. 安装指南

Mobylette 是一个用于 Rails 应用的 gem，它通过添加 mobile 格式来支持移动设备的请求。以下是安装步骤：

1. 在 Gemfile 中添加 Mobylette：

   gem 'mobylette'
   

2. 在 ApplicationController.rb 中（或你希望启用此功能的控制器中）添加以下代码：

   include Mobylette::RespondToMobileRequests
   

3. 安装完成后，你可以开始添加 .mobile.erb 视图文件。

2. 项目的使用说明

Mobylette 的工作原理是通过检测访问者的用户代理（User Agent）来判断是否为移动设备请求。如果是移动设备请求，控制器将渲染 .mobile.erb 视图文件，而不是 .html.erb 文件。

2.1 控制器中的使用

在控制器中，你可以使用 respond_to 方法来处理不同的请求格式：

respond_to do |format|
  format.html   { ... }
  format.mobile { ... }
end

2.2 辅助方法

Mobylette 提供了以下辅助方法：

• is_mobile_request?：如果请求来自移动设备，返回 true，否则返回 false。
• is_mobile_view?：如果当前格式为 :mobile，返回 true，否则返回 false。
• request_device?：如果当前请求来自指定的设备，返回 true，否则返回 false。例如：

  request_device?(:iphone)
  request_device?(:android)
  

3. 项目 API 使用文档

3.1 配置

你可以使用 mobylette_config 方法进行配置：

mobylette_config do |config|
  # 自定义用户代理
  config[:mobile_user_agents] = proc { %r{iphone|ipad}i }

  # 跳过特定用户代理
  config[:skip_user_agents] = [:ipad]

  # 设置回退链
  config[:fallback_chains] = {
    mobile: [:mobile, :html],
    iphone: [:iphone, :mobile, :html]
  }

  # 跳过 XHR 请求
  config[:skip_xhr_requests] = false

  # 注册移动设备
  config[:devices] = { my_unique_phone: %r{UniquePhone 1.2.3} }
end

3.2 强制/忽略移动请求

你可以通过设置 session[:mobylette_override] 来强制或忽略移动请求：

session[:mobylette_override] = :ignore_mobile  # 忽略移动请求
session[:mobylette_override] = :force_mobile   # 强制移动请求
session[:mobylette_override] = nil             # 取消强制/忽略

3.3 自定义移动请求检测

你可以通过重写 is_mobile_request? 方法来自定义移动请求的检测逻辑：

class ApplicationController < ActionController::Base
  include Mobylette::RespondToMobileRequests

  private

  def is_mobile_request?
    request.host == "mobile.app.com"
  end
end

4. 项目安装方式

Mobylette 的安装方式非常简单，只需在 Gemfile 中添加 gem 'mobylette'，然后在控制器中引入 Mobylette::RespondToMobileRequests 模块即可。

4.1 安装步骤

1. 在 Gemfile 中添加：

   gem 'mobylette'
   

2. 在 ApplicationController.rb 中引入模块：

   include Mobylette::RespondToMobileRequests
   

3. 安装完成后，你可以开始创建 .mobile.erb 视图文件。

4.2 测试

为了确保你的应用在移动设备上正常工作，建议你使用 Mobylette 提供的测试工具。你可以在测试文件中引入 Mobylette::Helmet 模块：

require 'mobylette/helmet'
include Mobylette::Helmet

对于 RSpec，你可以在 spec/spec_helpers.rb 中添加：

require 'mobylette/helmet'
RSpec.configure do |config|
  config.include Mobylette::Helmet, :type => :controller
end

这将为你的测试环境添加以下方法：

• force_mobile_request_agent(agent = 'Android')：强制使用移动用户代理。
• reset_test_request_agent：重置用户代理为默认的 "Rails Testing"。
• set_session_override(override_value)：强制设置会话覆盖值。

5. 总结

Mobylette 是一个强大的工具，可以帮助你在 Rails 应用中轻松处理移动设备请求。通过简单的配置和使用，你可以为移动用户提供更好的浏览体验。希望本文档能帮助你更好地理解和使用 Mobylette。