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(:tag_uri => "2008") 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:

  • :schema_date: Required. The date at which the tag scheme for the feed was first used. A good default is the year you created the feed. See feedvalidator.org/docs/error/InvalidTAG.html for more information.

  • :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 an AtomFeedBuilder instance.



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/action_view/helpers/atom_feed_helper.rb', line 53

def atom_feed(options = {}, &block)
  if options[:schema_date].blank?
    logger.warn("You must provide the :schema_date option to atom_feed for your feed to be valid. A good default is the year you first created this feed.") unless logger.nil?
  else
    options[:schema_date] = options[:schema_date].strftime("%Y-%m-%d") if options[:schema_date].respond_to?(:strftime)
  end
  
  xml = options[:xml] || eval("xml", block.binding)
  xml.instruct!

  xml.feed "xml:lang" => options[:language] || "en-US", "xmlns" => 'http://www.w3.org/2005/Atom' 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