跳至内容 跳至搜索

Action View Atom Feed 帮助器

方法
A

实例公共方法

atom_feed(options = {}, &block)

使用 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: 此 Feed 的 URL。默认值为当前 URL。

  • :id: 此 Feed 的 ID。在本例中,默认值为“tag:localhost,2005:/posts”。

  • :schema_date: Feed 的标签方案首次使用的时间。一个很好的默认值是您创建 Feed 的年份。有关更多信息,请参见 feedvalidator.org/docs/error/InvalidTAG.html。如果未指定,则使用 2005(作为“我不关心”值)。

  • :instruct: Hash,用于以 {target => {attribute => value, }} 或 {target => [{attribute => value, }, ]} 的形式指定 XML 处理指令。

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

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 规范定义了五个元素(内容、权利、标题、副标题、摘要),如果类型:‘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 实例。

# File actionview/lib/action_view/helpers/atom_feed_helper.rb, line 96
def atom_feed(options = {}, &block)
  if options[:schema_date]
    options[:schema_date] = options[:schema_date].strftime("%Y-%m-%d") if options[:schema_date].respond_to?(:strftime)
  else
    options[:schema_date] = "2005" # The Atom spec copyright date
  end

  xml = options.delete(:xml) || block.binding.local_variable_get(:xml)
  xml.instruct!
  if options[:instruct]
    options[:instruct].each do |target, attrs|
      if attrs.respond_to?(:keys)
        xml.instruct!(target, attrs)
      elsif attrs.respond_to?(:each)
        attrs.each { |attr_group| xml.instruct!(target, attr_group) }
      end
    end
  end

  feed_opts = { "xml:lang" => options[:language] || "en-US", "xmlns" => "http://www.w3.org/2005/Atom" }
  feed_opts.merge!(options).select! { |k, _| k.start_with?("xml") }

  xml.feed(feed_opts) do
    xml.id(options[:id] || "tag:#{request.host},#{options[:schema_date]}:#{request.fullpath.split(".")[0]}")
    xml.link(rel: "alternate", type: "text/html", href: options[:root_url] || (request.protocol + request.host_with_port))
    xml.link(rel: "self", type: "application/atom+xml", href: options[:url] || request.url)

    yield AtomFeedBuilder.new(xml, self, options)
  end
end