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

<% 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。 View 示例在 div 中正确显示图像,代码示例显示相关的 HTML。在这种情况下,相关的 HTML 包含一个 anchor 标记 - 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>

我希望用户能够复制代码示例并将其粘贴到新 View 中,而不必将 HTML 转换回生成它们的帮助程序。我认为我基本上需要的是一个替代的 ERB 分隔符,就像 '" (甚至 %q{} )因字符串而异。似乎即使最终的 ERB 分隔符出现在字符串内部,它实际上也是作为块的结尾进行处理的。 <% foo = '<%= bar %>' %> 最简单的例子在某种程度上展示了我想要完成的事情。在生成器中,您可能会使用 <% foo = '<%%= bar %>' %>(或类似的东西)来告诉它不要立即作为 ERB 处理。当从文件中读取时,甚至在纯 rb 文件(如助手)中,这一切都可以正常工作,但将它放在 View 中是最有意义的,在这种情况下,因为它旨在易于我们的操作设计师。

最佳答案

如果我对你的理解是正确的,那么你真正的问题是就插值而言,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 使用 TiltSprockets 来处理模板处理管道,它们允许您以正确的顺序使正确的事情发生在 pancakes.js.coffee.erb 上。

  • 使用上面的内容,您可以添加自己的模板格式,即带有不同分隔符的 ERB,并且您可以让 Rails 使用这种新格式来处理您的“特殊”部分,以免正常的 ERB 处理造成困惑。

    首先,您需要连接 Tilt。如果您查看 Tilt 安装中的 lib/tilt/erb.rb,您会在底部的 Tilt::ErubisTemplate 中看到 Erubis 内容。您应该能够对 Tilt::ErubisTemplate 进行子类化并提供 prepare 覆盖,例如向父类(super class)添加 :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 之类的名称将 klerb 与 erb 链接起来,文件将在 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 向链轮注册。
  • ...
  • 利润。
  • 关于ruby-on-rails - 在 ERB 块中的字符串内包含 ERB 分隔符,我们在Stack Overflow上找到一个类似的问题:https://stackoverflow.com/questions/13261376/

    10-15 13:09