Module: ActionView::Helpers::AtomFeedHelper

Defined in:
lib/action_view/helpers/atom_feed_helper.rb

Defined Under Namespace

Classes: AtomFeedBuilder

Instance Method Summary collapse

Instance Method Details

#atom_feed(options = {}, &block) ⇒ Object

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:

  • :language: Defaults to "en-US".
  • :root_url: The HTML alternative that this feed is doubling for. Defaults to / on the current host.
  • :url: The URL for this feed. Defaults to the current URL.
  • :schema_date: The date at which the tag scheme for the feed was first used. A good default is the year you created the feed. See http://feedvalidator.org/docs/error/InvalidTAG.html for more information. If not specified, 2005 is used (as an "I don't care" value).

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.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/action_view/helpers/atom_feed_helper.rb', line 78

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[:xml] || eval("xml", block.binding)
  xml.instruct!

  feed_opts = {"xml:lang" => options[:language] || "en-US", "xmlns" => 'http://www.w3.org/2005/Atom'}
  feed_opts.merge!(options).reject!{|k,v| !k.to_s.match(/^xml/)}

  xml.feed(feed_opts) do
    xml.id("tag:#{request.host},#{options[:schema_date]}:#{request.request_uri.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