Module ActionView::Helpers::AtomFeedHelper
In: vendor/rails/actionpack/lib/action_view/helpers/atom_feed_helper.rb

Methods

atom_feed  

Classes and Modules

Class ActionView::Helpers::AtomFeedHelper::AtomFeedBuilder

Public Instance methods

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 are 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.

atom_feed yields a AtomFeedBuilder instance.

[Source]

    # File vendor/rails/actionpack/lib/action_view/helpers/atom_feed_helper.rb, line 52
52:       def atom_feed(options = {}, &block)
53:         xml = options[:xml] || eval("xml", block.binding)
54:         xml.instruct!
55: 
56:         xml.feed "xml:lang" => options[:language] || "en-US", "xmlns" => 'http://www.w3.org/2005/Atom' do
57:           xml.id("tag:#{request.host}:#{request.request_uri.split(".")[0].gsub("/", "")}")      
58:           xml.link(:rel => 'alternate', :type => 'text/html', :href => options[:root_url] || (request.protocol + request.host_with_port))
59: 
60:           if options[:url]
61:             xml.link(:rel => 'self', :type => 'application/atom+xml', :href => options[:url] || request.url)
62:           end
63: 
64:           yield AtomFeedBuilder.new(xml, self)
65:         end
66:       end

[Validate]