Add short_name helper

Similar to the `full_name` helper, the `short_name` helper escapes its
input and wraps the result in a `<code>` tag.  But, whereas `full_name`
will call `RDoc::CodeObject#full_name` when given an `RDoc::CodeObject`,
`short_name` will call `RDoc::CodeObject#name`.

This commit also changes the `link_to` helper to no longer escape its
input text.  Thus it can be used together with the `short_name` helper.

Author: jonathanhefner

lib/rdoc/generator/template/rails/_context.rhtml

@@ -26,7 +26,7 @@
     <div class="sectiontitle">Sections</div>
     <ul>
       <% sections.each do |section| %>
-        <li><%= link_to section.title, "##{section.aref}" %></li>
+        <li><%= link_to h(section.title), "##{section.aref}" %></li>
       <% end %>
     </ul>
   <% end %>
@@ -43,7 +43,7 @@
               <%
                 comma = methods.size == i+1 ? '' : ','
               %>
-              <li><%= link_to method.name, method %><%= comma %></li>
+              <li><%= link_to short_name(method), method %><%= comma %></li>
             <% end %>
           </ul>
         </dd>
@@ -89,7 +89,7 @@
       <table border='0' cellpadding='5'>
         <% constants.each do |const| %>
           <tr valign='top'>
-            <td class="attr-name"><%= h const.name %></td>
+            <td class="attr-name"><%= short_name const %></td>
             <td>=</td>
             <td class="attr-value"><%= h const.value %></td>
           </tr>
@@ -113,7 +113,7 @@
             <td class='attr-rw'>
               [<%= attrib.rw %>]
             </td>
-            <td class='attr-name'><%= h attrib.name %></td>
+            <td class='attr-name'><%= short_name attrib %></td>
             <td class='attr-desc'><%= attrib.description.strip %></td>
           </tr>
         <% end %>
@@ -144,14 +144,14 @@
             <p class="aka">
               Also aliased as:
               <%# Sometimes a parent cannot be determined. See ruby/rdoc@85ebfe13dc. %>
-              <%= method.aliases.map { |aka| link_to_if aka.parent, aka.name, aka }.join(", ") %>.
+              <%= method.aliases.map { |aka| link_to_if aka.parent, short_name(aka), aka }.join(", ") %>.
             </p>
           <% end %>
 
           <% if alias_for = method.is_alias_for then %>
             <p class="aka">
               Alias for:
-              <%= link_to alias_for.name, alias_for %>.
+              <%= link_to short_name(alias_for), alias_for %>.
             </p>
           <% end %>
 

lib/sdoc/helpers.rb

@@ -15,7 +15,7 @@ def _link_url(url)
   end
 
   def _link_body(text)
-    text.is_a?(RDoc::CodeObject) ? full_name(text) : h(text)
+    text.is_a?(RDoc::CodeObject) ? full_name(text) : text
   end
 
   def link_to_if(condition, text, *args)
@@ -35,6 +35,11 @@ def full_name(named)
     "<code>#{named.split(%r"(?<=./|.::)").map { |part| h part }.join("<wbr>")}</code>"
   end
 
+  def short_name(named)
+    named = named.name if named.is_a?(RDoc::CodeObject)
+    "<code>#{h named}</code>"
+  end
+
   def base_tag_for_context(context)
     relative_root = "../" * context.path.count("/")
     %(<base href="./#{relative_root}" data-current-path="#{context.path}">)

spec/helpers_spec.rb

@@ -86,9 +86,14 @@
         must_equal %(<a href="bar" class="qux" data-hoge="fuga">foo</a>)
     end
 
-    it "escapes the link text and attributes" do
-      _(@helpers.link_to("Bar < Foo", "qux", title: "Foo > Bar")).
-        must_equal %(<a href="qux" title="Foo &gt; Bar">Bar &lt; Foo</a>)
+    it "escapes the HTML attributes" do
+      _(@helpers.link_to("Foo", "foo", title: "Foo < Object")).
+        must_equal %(<a href="foo" title="Foo &lt; Object">Foo</a>)
+    end
+
+    it "does not escape the link body" do
+      _(@helpers.link_to("<code>Foo</code>", "foo")).
+        must_equal %(<a href="foo"><code>Foo</code></a>)
     end
 
     it "uses the first argument as the URL when no URL is specified" do
@@ -134,12 +139,12 @@ module Foo; class Bar; def qux; end; end; end
 
   describe "#link_to_if" do
     it "returns the link's HTML when the condition is true" do
-      args = ["Bar < Foo", "qux", title: "Foo > Bar"]
+      args = ["<code>Foo</code>", "foo", title: "Foo < Object"]
       _(@helpers.link_to_if(true, *args)).must_equal @helpers.link_to(*args)
     end
 
     it "returns the link's inner HTML when the condition is false" do
-      _(@helpers.link_to_if(false, "Bar < Foo", "url")).must_equal ERB::Util.h("Bar < Foo")
+      _(@helpers.link_to_if(false, "<code>Foo</code>", "url")).must_equal "<code>Foo</code>"
 
       rdoc_module = rdoc_top_level_for(<<~RUBY).find_module_named("Foo::Bar")
         module Foo; class Bar; end; end
@@ -199,6 +204,24 @@ module Foo; module Bar; class Qux; end; end; end
     end
   end
 
+  describe "#short_name" do
+    it "wraps name in <code>" do
+      _(@helpers.short_name("foo")).must_equal "<code>foo</code>"
+    end
+
+    it "escapes the name" do
+      _(@helpers.short_name("<=>")).must_equal "<code>&lt;=&gt;</code>"
+    end
+
+    it "uses RDoc::CodeObject#name when argument is an RDoc::CodeObject" do
+      rdoc_method = rdoc_top_level_for(<<~RUBY).find_module_named("Foo").find_method("bar", false)
+        module Foo; def bar; end; end
+      RUBY
+
+      _(@helpers.short_name(rdoc_method)).must_equal "<code>bar</code>"
+    end
+  end
+
   describe "#base_tag_for_context" do
     it "returns a <base> tag with an appropriate path for the given RDoc::Context" do
       top_level = rdoc_top_level_for <<~RUBY