Spec-Zone.ru › Ruby on Rails 7.2

модуль ActionView::Helpers::AtomFeedHelper

Справочник по помощникам Action View для Atom-лент

Публичные методы экземпляров

atom_feed(options = {}) { |atom_feed_builder| ... } Показать исходный код
# File actionview/lib/action_view/helpers/atom_feed_helper.rb, line 98
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.delete(:xml) || block.binding.local_variable_get(:xml)
  xml.instruct!
  if options[:instruct]
    options[:instruct].each do |target, attrs|
      if attrs.respond_to?(:keys)
        xml.instruct!(target, attrs)
      elsif attrs.respond_to?(:each)
        attrs.each { |attr_group| xml.instruct!(target, attr_group) }
      end
    end
  end

  feed_opts = { "xml:lang" => options[:language] || "en-US", "xmlns" => "http://www.w3.org/2005/Atom" }
  feed_opts.merge!(options).select! { |k, _| k.start_with?("xml") }

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

Добавляет удобные значения по умолчанию для создания Atom-лент с помощью шаблонизатора Builder (это не работает с ERB или другими языками шаблонов).

Полный пример использования:

config/routes.rb:
  Rails.application.routes.draw do
    resources :posts
    root to: "posts#index"
  end

app/controllers/posts_controller.rb:
  class PostsController < ApplicationController
    # GET /posts.html
    # GET /posts.atom
    def index
      @posts = Post.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[0].created_at) if @posts.length > 0

    @posts.each do |post|
      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

Параметры для atom_feed:

  • :language: По умолчанию «en-US».

  • :root_url: Альтернативный HTML-вариант, для которого дублируется эта лента. По умолчанию / на текущем хосте.

  • :url: URL этой ленты. По умолчанию текущий URL.

  • :id: Идентификатор этой ленты. По умолчанию «tag:localhost,2005:/posts» в данном случае.

  • :schema_date: Дата, когда впервые использовалась схема тегов для ленты. Хорошее значение по умолчанию — год создания ленты. Подробнее см. feedvalidator.org/docs/error/InvalidTAG.html. Если не указано, используется 2005 год (значение «мне всё равно»).

  • :instruct: Hash инструкций по обработке XML в формате {target => {attribute => value, }} или {target => [{attribute => value, }, ]}

Другие пространства имён могут быть добавлены к корневому элементу:

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)

    @posts.each do |post|
      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 определяет пять элементов (content rights title subtitle summary), которые могут напрямую содержать XHTML-контент, если в качестве атрибута указан тип: ‘xhtml’. В этом случае этот помощник позаботится о содержащем div и объявлении пространства имён XHTML. Пример использования:

entry.summary type: 'xhtml' do |xhtml|
  xhtml.p pluralize(order.line_items.count, "line item")
  xhtml.p "Shipped to #{order.address}"
  xhtml.p "Paid by #{order.pay_type}"
end

atom_feed возвращает экземпляр AtomFeedBuilder. Вложенные элементы возвращают экземпляр AtomBuilder.

© 2004–2021 David Heinemeier Hansson
Licensed under the MIT License.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API