Question

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

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

<%= raw code %>
<%= content_tag :pre, code, class: "prettyprint linenums" %>

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

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

我能在这个问题上找到的唯一信息是here，使用<%= "<" + "%=" %> link_to <%= image.css_tag.humanize %> <%= "%" + ">" %> %>，但在此用例中不起作用（如果有的话）。

那么，有没有办法在ERB字符串中指定包含ERB结束分隔符（%>）的字符串，还是我使用稍微笨重的文件读取方法？谢谢！

修改

我最终想要的是这个的工作版本：

<%# Idealized code - does not work %>
<% code = <<PLACE_THE_EXAMPLE_CODE_BETWEEN_THESE_TWO_LINES_EXACTLY_AS_YOU_WANT_IT_TO_APPEAR
<div>
  <% image_tag 'image.png' %>
</div>  
PLACE_THE_EXAMPLE_CODE_BETWEEN_THESE_TWO_LINES_EXACTLY_AS_YOU_WANT_IT_TO_APPEAR
%>

这样<%= raw code %>会（继续）输出：

<div>
  <img src="/images/image.png" alt="Image" />
</div>

<%= content_tag :pre, code, class: "prettyprint linenums" %>会输出：

<pre class="prettyprint linenums">
  <div>
    <% image_tag 'image.png' %>
  </div>  
</pre>

而不是使用变量时的当前操作，即：

<pre class="prettyprint linenums">
  <div>
    <img src="/images/image.png" alt="Image" />
  </div>
</pre>

我希望用户能够复制代码示例并将其粘贴到新视图中，而无需将HTML转换回生成它们的帮助程序。我认为我基本上需要的是另一种ERB分隔符，就像'和"（或甚至%q{}）字符串不同一样。似乎即使最终的ERB定界符发生在字符串内部，它实际上也被处理为块的结尾。最简单的<% foo = '<%= bar %>' %>案例展示了我想要实现的目标。在生成器中，您可以使用<% foo = '<%%= bar %>' %>（或类似的东西），告诉它不要在那时和那里处理ERB。这在从文件中读取时甚至在纯rb文件（如帮助程序）中都可以正常工作，但是最好将它放在视图中，在这种情况下，因为它很容易被我们操作设计师。

Answer 1

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

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

如果您愿意，可以使用其他分隔符：%q|...|，%q(...)等。当然还有变化，但至少您没有担心插值问题。

如果您真的想使用heredoc，可以指定heredoc terminator with quotes，相应的引用样式将适用于内容：

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

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

当然，这些东西都不适用于嵌入式ERB：

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

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

一些预赛：

Rails使用Erubis进行ERB处理。
Erubis允许您change the delimiters with the :pattern option到其构造函数。
Rails使用Tilt和Sprockets来处理模板处理管道，这些允许您按正确的顺序将正确的事情发送到pancakes.js.coffee.erb。

使用上面的内容，您可以使用不同的分隔符添加自己的ERB模板格式，并且可以让Rails使用这种新格式来处理您的特殊情况＆＃34;在正常的ERB处理之前的部分可能会弄得一团糟。

首先你需要连接Tilt。如果您在Tilt安装中查看lib/tilt/erb.rb，则会在底部的Tilt::ErubisTemplate中看到Erubis内容。您应该能够继承Tilt::ErubisTemplate并提供prepare覆盖，例如，将:pattern => ''选项添加到超类中。然后在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的文件中）：

<!--% code = <<PLACE_THE_EXAMPLE_CODE_BETWEEN_THESE_TWO_LINES_EXACTLY_AS_YOU_WANT_IT_TO_APPEAR
<div>
  <% image_tag 'image.png' %>
</div>  
PLACE_THE_EXAMPLE_CODE_BETWEEN_THESE_TWO_LINES_EXACTLY_AS_YOU_WANT_IT_TO_APPEAR
%-->
<!--%= "code = escape_the_erb_as_needed(%q{#{code}})" %-->
<% do_normal_erb_stuff %>

会做正确的事。

当然，您需要帮助程序来实现escape_the_erb_as_needed功能;一些实验应该可以帮助你理清需要逃避的东西以及以何种方式。

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

Tilt::Template子类，您可以通过Tilt::ErubisTemplate。
致电Tilt.register注册Tilt。
通过致电Rails.application.assets.register_engine注册Sprockets。
...
利润。

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

1 个答案: