首页 文章

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

提问于
浏览 次
4

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

<% 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结束分隔符（ %> ）的字符串，还是我使用稍微笨重的文件读取方法？谢谢！

Edit:

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

<%# 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文件（如帮助程序）中都可以正常工作，但是最好将它放在视图中，在这种情况下，因为它很容易被我们操作设计师 .

ruby-on-rails ruby erb

1 回答

  • 5

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

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

    如果您愿意，可以使用其他分隔符： %q|...| ， %q(...) 等 . 有's still a change of course but at least you don'吨必须担心插值问题 .

    如果您确实想使用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... 部分的结束分隔符 . 不要害怕，我想我有一个计划，可以在不涉及严重黑客或太多工作的情况下工作 .

    Some preliminaries ：

    使用上面的方法，你可以添加自己的ERB模板格式，使用不同的分隔符，你可以让Rails使用这种新的格式来处理你的“特殊”部分，然后正常的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 .

    • ......

    • 利润 .

    回复于

相关问题