| Module | ActionView::Helpers::AtomFeedHelper |
| In: |
vendor/rails/actionpack/lib/action_view/helpers/atom_feed_helper.rb
|
Full usage example:
config/routes.rb:
ActionController::Routing::Routes.draw do |map|
map.resources :posts
map.root :controller => "posts"
end
app/controllers/posts_controller.rb:
class PostsController < ApplicationController::Base
# GET /posts.html
# GET /posts.atom
def index
@posts = Post.find(: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.first.created_at))
for post in @posts
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
The options for atom_feed are:
Other namespaces can be added to the root element:
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)
for post in @posts
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_feed yields an AtomFeedBuilder instance.
# File vendor/rails/actionpack/lib/action_view/helpers/atom_feed_helper.rb, line 78
78: def atom_feed(options = {}, &block)
79: if options[:schema_date]
80: options[:schema_date] = options[:schema_date].strftime("%Y-%m-%d") if options[:schema_date].respond_to?(:strftime)
81: else
82: options[:schema_date] = "2005" # The Atom spec copyright date
83: end
84:
85: xml = options[:xml] || eval("xml", block.binding)
86: xml.instruct!
87:
88: feed_opts = {"xml:lang" => options[:language] || "en-US", "xmlns" => 'http://www.w3.org/2005/Atom'}
89: feed_opts.merge!(options).reject!{|k,v| !k.to_s.match(/^xml/)}
90:
91: xml.feed(feed_opts) do
92: xml.id("tag:#{request.host},#{options[:schema_date]}:#{request.request_uri.split(".")[0]}")
93: xml.link(:rel => 'alternate', :type => 'text/html', :href => options[:root_url] || (request.protocol + request.host_with_port))
94: xml.link(:rel => 'self', :type => 'application/atom+xml', :href => options[:url] || request.url)
95:
96: yield AtomFeedBuilder.new(xml, self, options)
97: end
98: end