Class: ActionView::Helpers::AtomFeedHelper::AtomFeedBuilder

Inherits:
AtomBuilder
  • Object
show all
Defined in:
lib/action_view/helpers/atom_feed_helper.rb

Overview

:nodoc:

Constant Summary

Constants inherited from AtomBuilder

ActionView::Helpers::AtomFeedHelper::AtomBuilder::XHTML_TAG_NAMES

Instance Method Summary collapse

Constructor Details

#initialize(xml, view, feed_options = {}) ⇒ AtomFeedBuilder

Returns a new instance of AtomFeedBuilder.



165
166
167
 
# File 'lib/action_view/helpers/atom_feed_helper.rb', line 165

def initialize(xml, view, feed_options = {})
  @xml, @view, @feed_options = xml, view, feed_options
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class ActionView::Helpers::AtomFeedHelper::AtomBuilder

Instance Method Details

#entry(record, options = {}) ⇒ Object

Creates an entry tag for a specific record and prefills the id using class and id.

Options:

  • :published: Time first published. Defaults to the created_at attribute on the record if one such exists.

  • :updated: Time of update. Defaults to the updated_at attribute on the record if one such exists.

  • :url: The URL for this entry or false or nil for not having a link tag. Defaults to the polymorphic_url for the record.

  • :id: The ID for this entry. Defaults to “tag:#ActionView::Helpers::AtomFeedHelper::AtomFeedBuilder.@view@view.request@view.request.host,#href=":schema_date">feed_options:#ActionView::Helpers::AtomFeedHelper::AtomFeedBuilder.recordrecord.class/#ActionView::Helpers::AtomFeedHelper::AtomFeedBuilder.recordrecord.id”

  • :type: The TYPE for this entry. Defaults to “text/html”.



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/action_view/helpers/atom_feed_helper.rb', line 183

def entry(record, options = {})
  @xml.entry do
    @xml.id(options[:id] || "tag:#{@view.request.host},#{@feed_options[:schema_date]}:#{record.class}/#{record.id}")

    if options[:published] || (record.respond_to?(:created_at) && record.created_at)
      @xml.published((options[:published] || record.created_at).xmlschema)
    end

    if options[:updated] || (record.respond_to?(:updated_at) && record.updated_at)
      @xml.updated((options[:updated] || record.updated_at).xmlschema)
    end

    type = options.fetch(:type, "text/html")

    url = options.fetch(:url) { @view.polymorphic_url(record) }
    @xml.link(rel: "alternate", type: type, href: url) if url

    yield AtomBuilder.new(@xml)
  end
end

#updated(date_or_time = nil) ⇒ Object

Accepts a Date or Time object and inserts it in the proper format. If nil is passed, current time in UTC is used.



170
171
172
 
# File 'lib/action_view/helpers/atom_feed_helper.rb', line 170

def updated(date_or_time = nil)
  @xml.updated((date_or_time || Time.now.utc).xmlschema)
end