跳至內容 跳至搜尋

Action 視圖 Atom Feed 輔助程式

方法
A

執行個體公開方法

atom_feed(options = {}, &block)

為 Atom Feed 新增預設值,並使用 Builder 範本引擎撰寫(這不適用於 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:型式為 {target => {attribute => value, }} 或 {target => [{attribute => value, }, ]} 的 XML 處理指令Hash

其他命名空間可以新增至 root 元素

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 規範定義五個元素(內容權利標題副標題摘要),如果屬性指定為 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 執行個體。

# 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