在ERB块中的字符串内包含ERB分隔符

我正在开发一个样式指南,显示代码和输出。 它目前的结构使得代码只需要描述一次,并以原始版本和解释版本显示,如下所示:

<% code = <<PLACE_THE_EXAMPLE_CODE_BETWEEN_THESE_TWO_LINES_EXACTLY_AS_YOU_WANT_IT_TO_APPEAR 
#{ image_tag 'image.png' }
PLACE_THE_EXAMPLE_CODE_BETWEEN_THESE_TWO_LINES_EXACTLY_AS_YOU_WANT_IT_TO_APPEAR %>

这很棒,而且相当容易维护。 问题来自rails帮助程序,如上例中的image_tag 。 视图示例正确显示div中的图像,代码示例显示相关的HTML。 在这种情况下,相关的HTML包含一个锚标记 – image_tag方法的结果,而不是调用本身。

我更喜欢代码示例来显示辅助方法,而不是它们的结果。 我可以通过在文件中指定示例代码并渲染或读取文件来完成此工作。 我更喜欢通过在变量中指定代码来完成这项工作,如上所述,但我似乎无法在erb块内部的字符串内部使用ERB分隔符。 即使最简单的<% foo = '' %>也不起作用。 我尝试使用语法( ),使用官方文档中的详细信息,但没有取得多大成功。

我能找到的唯一信息就是这里 ,使用<%= " link_to " %> %> ,在这个用例中不起作用(如果有的话)。

那么,有没有办法在ERB字符串中指定包含ERB结束分隔符( %> )的字符串,还是使用稍微笨重的文件读取方法? 谢谢!

编辑:

我想最终得到的是这个的工作版本:

  <% code = <<PLACE_THE_EXAMPLE_CODE_BETWEEN_THESE_TWO_LINES_EXACTLY_AS_YOU_WANT_IT_TO_APPEAR 
PLACE_THE_EXAMPLE_CODE_BETWEEN_THESE_TWO_LINES_EXACTLY_AS_YOU_WANT_IT_TO_APPEAR %>

这样会(继续)输出:

 
Image

并且将输出:

 
 

而不是使用变量时它当前做什么,这是:

 
 
Image

我希望用户能够复制代码示例并将其粘贴到新视图中,而无需将HTML转换回生成它们的帮助程序。 我认为我基本上需要的是一个替代的ERB分隔符,就像'" (或甚至%q{} )在字符串中的变化一样。看来即使最后的ERB分隔符出现在字符串内部,它也是实际上是作为块的结尾处理的。 <% foo = '' %>的最简单的情况说明了我想要完成的事情。在生成器中,你可以使用<% foo = '' %> (或类似的东西),告诉它不要当时和那里处理ERB。这一切都可以在从文件中读取,或者甚至在纯rb文件(如帮助器)中工作,但在这种情况下,将它放在视图中是最有意义的,因为我们的设计师很容易操纵它。

如果我理解你的话,你的真正问题是就插值而言,heredocs的行为就像双引号一样。 所以你需要的只是一个引用机制,其行为类似于单引号。 Ruby有很多字符串引用机制,特别是我们有%q{...}

 <% code = %q{ 
#{ image_tag 'image.png' }
} %>

如果您愿意,可以使用其他分隔符: %q|...|%q(...)等。当然还有一个变化,但至少你不必担心插值问题。

如果您确实想使用heredoc,可以使用引号指定heredoc终止符,相应的引用样式将应用于内容:

 <% code = <<'PLACE_THE_EXAMPLE_CODE_BETWEEN_THESE_TWO_LINES_EXACTLY_AS_YOU_WANT_IT_TO_APPEAR' 
#{ image_tag 'image.png' }
PLACE_THE_EXAMPLE_CODE_BETWEEN_THESE_TWO_LINES_EXACTLY_AS_YOU_WANT_IT_TO_APPEAR %>

<<'PLACE...'的单引号指定单引号规则(即无插值)适用于heredoc的内容。


当然,这些内容都不适用于嵌入式ERB,如下所示:

 <% code = %q{ 
<% ... %>
} %>

因为ERB解析器会将第一个%>视为外部<% code...部分的结束分隔符。 不要害怕,我想我有一个计划,可以在不涉及严重黑客或太多工作的情况下工作。

一些预赛

  • Rails使用Erubis进行ERB处理。
  • Erubis允许您使用:pattern选项将分隔符更改为其构造函数。
  • Rails使用Tilt和Sprockets来处理模板处理管道,这些允许您以正确的顺序将正确的事情发生在pancakes.js.coffee.erb上。

使用上面的内容,你可以添加自己的ERB模板格式,使用不同的分隔符,你可以让Rails使用这种新的格式来处理你的“特殊”部分,然后正常的ERB处理就会搞乱。

首先,您需要连接Tilt。 如果您在Tilt安装中查看lib/tilt/erb.rb ,您会在底部看到Tilt::ErubisTemplate中的Erubis内容。 您应该能够Tilt::ErubisTemplate并提供一个prepare覆盖,例如,添加一个:pattern => ''选项和Tilt::ErubisTemplate类别。 然后使用Rails初始值设定项中的Tilt和Sprockets注册它,如下所示:

 Tilt.register(Your::Template::Subclass, 'klerb') # "kl" for "kludge" :) Rails.application.assets.register_engine('.klerb', Your::Template::Subclass) 

现在,您的应用程序应该能够处理带有 .klerb文件作为模板分隔符。 你也可以使用像pancakes.html.erb.klerb这样的名字用erb链接你的klerb,文件将在ERB之前通过klerb; 这意味着像这样的模板(在一个名为whatever.html.erb.klerb的文件中):

   <% do_normal_erb_stuff %> 

会做正确的事。

当然,你需要一个帮助器来实现escape_the_erb_as_neededfunction; 一些实验应该可以帮助你理清需要逃避的东西以及以何种方式逃脱。

所有这些看起来有点复杂,但实际上非常简单。 我已经使用Tilt和Sprockets添加了自定义模板处理步骤,结果最终变得非常简单; 弄清楚哪些简单的事情需要做些工作,但我已经为你完成了这项工作:

  1. Tilt::Template子类,你可以通过Tilt::ErubisTemplate获得这个。
  2. 通过致电Tilt.register注册Tilt。
  3. 通过调用Rails.application.assets.register_engine注册Sprockets。
  4. ...
  5. 利润。