Ruby on Rails:使用XML Builder Partials

时间:2010-06-06 22:49:19

标签: ruby-on-rails ruby xml xml-builder

XML构建器中的部分被证明是非平凡的。

经过一些初步的Google搜索后,我发现以下内容有效,但不是100%

 xml.foo do
     xml.id(foo.id)
     xml.created_at(foo.created_at)
     xml.last_updated(foo.updated_at)
     foo.bars.each do |bar|
         xml << render(:partial => 'bar/_bar', :locals => { :bar => bar })
     end
 end

这将解决问题,除了XML输出没有正确缩进。输出看起来类似于:

<foo>
  <id>1</id>
  <created_at>sometime</created_at>
  <last_updated>sometime</last_updated>
<bar>
  ...
</bar>
<bar>
  ...
</bar>
</foo>

<bar>元素应该在<last_updated>元素下方对齐,它是<foo>的子元素,如下所示:

<foo>
  <id>1</id>
  <created_at>sometime</created_at>
  <last_updated>sometime</last_updated>
  <bar>
    ...
  </bar>
  <bar>
    ...
  </bar>
</foo>

如果我将bar / _bar.xml.builder中的内容复制到模板中,那么效果会非常好,但事情就是不干。

3 个答案:

答案 0 :(得分:30)

我通过将构建器引用作为局部的局部传递来解决这个问题。不需要猴子补丁。使用原始示例:

xml.foo do
     xml.id(foo.id)
     xml.created_at(foo.created_at)
     xml.last_updated(foo.updated_at)
     foo.bars.each do |bar|
         render(:partial => 'bar/_bar', :locals => {:builder => xml, :bar => bar })
     end
 end

然后在你的部分确保使用'builder'对象。

builder.bar do
  builder.id bar.id
end

此外,上面似乎只适用于Rails 4. Rails 5及以上@ srghma的评论如下

答案 1 :(得分:17)

遗憾的是,这并不是一个直截了当的解决方案。在查看ActionPack将初始化Builder对象的代码时,缩进大小被硬编码为2并且未设置边距大小。遗憾的是,目前没有机制可以覆盖这一点。

这里的理想解决方案是修复ActionPack以允许将这些选项传递给构建器,但这需要一些时间投入。我有2个可能的修复程序。两个都很脏,你可以选择感觉不那么脏的。

将要渲染的局部渲染修改为字符串,然后对其执行一些正则表达式。这看起来像这样

_bar.xml.builder

xml.bar do
  xml.id(bar.id)
  xml.name(bar.name)
   xml.created_at(bar.created_at)
   xml.last_updated(bar.updated_at)
end

FOOS / index.xml.builder

xml.foos do
  @foos.each do |foo|
    xml.foo do
      xml.id(foo.id)
      xml.name(foo.name)
      xml.created_at(foo.created_at)
      xml.last_updated(foo.updated_at)
      xml.bars do
        foo.bars.each do |bar|
          xml << render(:partial => 'bars/bar', 
                 :locals => { :bar => bar } ).gsub(/^/, '      ')
        end
      end
    end
  end
end

注意渲染线末尾的gsub。这会产生以下结果

<?xml version="1.0" encoding="UTF-8"?>
<foos>
  <foo>
    <id>1</id>
    <name>Foo 1</name>
    <created_at>2010-06-11 21:54:16 UTC</created_at>
    <last_updated>2010-06-11 21:54:16 UTC</last_updated>
    <bars>
      <bar>
        <id>1</id>
        <name>Foo 1 Bar 1</name>
        <created_at>2010-06-11 21:57:29 UTC</created_at>
        <last_updated>2010-06-11 21:57:29 UTC</last_updated>
      </bar>
    </bars>
  </foo>
</foos>

这有点hacky并且非常脏,但具有包含在您的代码中的优势。下一个解决方案是对ActionPack进行修补,以使Builder实例按照我们想要的方式工作

配置/初始化/ builder_mods.rb

module ActionView
  module TemplateHandlers
    class BuilderOptions
      cattr_accessor :margin, :indent
    end
  end
end

module ActionView
  module TemplateHandlers
    class Builder < TemplateHandler

      def compile(template)
        "_set_controller_content_type(Mime::XML);" +
          "xml = ::Builder::XmlMarkup.new(" +
          ":indent => #{ActionView::TemplateHandlers::BuilderOptions.indent}, " +
          ":margin => #{ActionView::TemplateHandlers::BuilderOptions.margin});" +
          "self.output_buffer = xml.target!;" +
          template.source +
          ";xml.target!;"
      end
    end
  end
end

ActionView::TemplateHandlers::BuilderOptions.margin = 0
ActionView::TemplateHandlers::BuilderOptions.indent = 2

这在Rails初始化中创建了一个名为BuilderOptions的新类,其唯一目的是为缩进和边距托管2个值(尽管我们只需要边距值)。我尝试将这些变量作为类变量直接添加到Builder模板类中,但该对象被冻结,我无法更改值。

创建该类后,我们在TemplateHandler中修补compile方法以使用这些值。

然后模板如下所示: -

xml.foos do
  @foos.each do |foo|
    xml.foo do
      xml.id(foo.id)
      xml.name(foo.name)
      xml.created_at(foo.created_at)
      xml.last_updated(foo.updated_at)
      xml.bars do
        ActionView::TemplateHandlers::BuilderOptions.margin = 3    
        foo.bars.each do |bar|
          xml << render(:partial => 'bars/bar', :locals => { :bar => bar } )
        end
        ActionView::TemplateHandlers::BuilderOptions.margin = 0
      end
    end
  end
end

基本思想是将边距值设置为渲染局部时的缩进级别。生成的XML与上面显示的相同。

请不要复制/粘贴此代码而不检查Rails版本,以确保它们来自相同的代码库。 (我认为以上是2.3.5)

答案 2 :(得分:0)

也许你应该这样做:

xml.foo do
  xml.id(foo.id)
  xml.created_at(foo.created_at)
  xml.last_updated(foo.updated_at)
  xml.bars do
    foo.bars.each do |bar|
      xml.bar bar.to_xml # or "xml.bar render(:xml => bar)"
                         # or "xml.bar render(bar)" (loads bar/_bar partial)
    end
  end
end

查看this link about the xml builder

在最后一个替代方案中,您可以用以下内容替换内部循环:

xml.bars render(foo.bars) # will loop over bars automatically using bar/_bar

您也可以尝试:

xml << foo.to_xml(:include => :bars)

如果要在结果中包含所有字段。

我不确定所有这些的缩进,因此您可能需要回退以创建内部循环的内容,就像在外部块中一样,例如不使用部分内容。