Action View Atom Feed Helpers¶ ↑

使用 Builder 模板引擎方便地编写 Atom feed。 (这不适用于 ERB 或任何其他模板语言)。

完整使用示例

config/routes.rb:
  Rails.application.routes.draw do
    resources :posts
    root to: "posts#index"
  end

app/controllers/posts_controller.rb:
  class PostsController < ApplicationController
    # GET /posts.html
    # GET /posts.atom
    def index
      @posts = Post.all

      respond_to do |format|
        format.html
        format.atom
      end
    end
  end

app/views/posts/index.atom.builder:
  atom_feed do |feed|
    feed.title("My great blog!")
    feed.updated(@posts[0].created_at) if @posts.length > 0

    @posts.each do |post|
      feed.entry(post) do |entry|
        entry.title(post.title)
        entry.content(post.body, type: 'html')

        entry.author do |author|
          author.name("DHH")
        end
      end
    end
  end

atom_feed 的选项有：

• :language：默认为 “en-US”。

• :root_url：此 feed 所对应的 HTML 备用 URL。默认为当前主机的 /。

• :url：此 feed 的 URL。默认为当前 URL。

• :id：此 feed 的 ID。在此情况下，默认为 “tag:localhost,2005:/posts”。

• :schema_date：feed 的 tag 方案首次使用的日期。一个好的默认值是创建 feed 的年份。更多信息请参阅 feedvalidator.org/docs/error/InvalidTAG.html。如果未指定，则使用 2005 (作为 “不关心” 的值)。

• :instruct：XML 处理指令的 Hash，形式为 {target => {attribute => value, }} 或 {target => [{attribute => value, }, ]}

其他命名空间可以添加到根元素

app/views/posts/index.atom.builder:
  atom_feed({'xmlns:app' => 'http://www.w3.org/2007/app',
      'xmlns:openSearch' => 'http://a9.com/-/spec/opensearch/1.1/'}) do |feed|
    feed.title("My great blog!")
    feed.updated((@posts.first.created_at))
    feed.tag!('openSearch:totalResults', 10)

    @posts.each do |post|
      feed.entry(post) do |entry|
        entry.title(post.title)
        entry.content(post.body, type: 'html')
        entry.tag!('app:edited', Time.now)

        entry.author do |author|
          author.name("DHH")
        end
      end
    end
  end

Atom 规范定义了五个元素 (content rights title subtitle summary)，如果指定了 type: ‘xhtml’ 属性，它们可以直接包含 XHTML 内容。如果是这样，此助手将处理包含的 div 和 XHTML 命名空间声明。用法示例

entry.summary type: 'xhtml' do |xhtml|
  xhtml.p pluralize(order.line_items.count, "line item")
  xhtml.p "Shipped to #{order.address}"
  xhtml.p "Paid by #{order.pay_type}"
end

atom_feed 块会生成一个 AtomFeedBuilder 实例。嵌套元素会生成一个 AtomBuilder 实例。