Merge pull request #973 from unasuke/breadcrumb

Add breadcrumb list

Author: st0012

lib/rdoc/code_object/class_module.rb

@@ -295,6 +295,25 @@ def full_name
                    end
   end
 
+  ##
+  # Return array of full_name splitted by +::+.
+
+  def nesting_namespaces
+    @namespaces ||= full_name.split("::").reject(&:empty?)
+  end
+
+  ##
+  # Return array of fully qualified nesting namespaces.
+  #
+  # For example, if full_name is +A::B::C+, this method returns <code>["A", "A::B", "A::B::C"]</code>
+
+  def fully_qualified_nesting_namespaces
+    return nesting_namespaces if nesting_namespaces.length < 2
+    @fqns ||= nesting_namespaces.inject([]) do |list, n|
+      list << (list.empty? ? n : "#{list.last}::#{n}")
+    end
+  end
+
   ##
   # TODO: filter included items by #display?
 

lib/rdoc/generator/darkfish.rb

@@ -353,6 +353,8 @@ def generate_class klass, template_file = nil
     asset_rel_prefix = rel_prefix + @asset_rel_path
     svninfo          = get_svninfo(current)
 
+    breadcrumb = generate_nesting_namespaces_breadcrumb(current, rel_prefix)
+
     @title = "#{klass.type} #{klass.full_name} - #{@options.title}"
 
     debug_msg "  rendering #{out_file}"
@@ -821,4 +823,23 @@ def generate_ancestor_list(ancestors, klass)
 
     content << '</li></ul>'
   end
+
+  private
+
+  def nesting_namespaces_to_class_modules klass
+    tree = {}
+
+    klass.nesting_namespaces.zip(klass.fully_qualified_nesting_namespaces) do |ns, fqns|
+      tree[ns] = @store.classes_hash[fqns] || @store.modules_hash[fqns]
+    end
+
+    tree
+  end
+
+  def generate_nesting_namespaces_breadcrumb klass, rel_prefix
+    nesting_namespaces_to_class_modules(klass).map do |namespace, class_module|
+      path = class_module ? (rel_prefix + class_module.path).to_s : ""
+      { name: namespace, path: path, self: klass.full_name == class_module&.full_name }
+    end
+  end
 end

lib/rdoc/generator/template/darkfish/class.rhtml

@@ -18,6 +18,21 @@
 </nav>
 
 <main role="main" aria-labelledby="<%=h klass.aref %>">
+  <%# If nesting level is 1, breadcrumb list is not needed %>
+  <% if breadcrumb.size > 1 %>
+    <ol role="navigation" aria-label="breadcrumb" class="breadcrumb">
+      <% breadcrumb.each do |namespace| %>
+      <li>
+        <% if namespace[:self] %>
+        <span><%= namespace[:name] %></span>
+        <% else %>
+        <a href="<%= namespace[:path] %>"><%= namespace[:name] %></a><span>::</span>
+        <% end %>
+      </li>
+      <% end %>
+    </ol>
+  <% end %>
+
   <h1 id="<%=h klass.aref %>" class="anchor-link <%= klass.type %>">
     <%= klass.type %> <%= klass.full_name %>
   </h1>

lib/rdoc/generator/template/darkfish/css/rdoc.css

@@ -199,6 +199,19 @@ nav h3,
   font-size: 1em;
 }
 
+ol.breadcrumb {
+  display: flex;
+
+  padding: 0;
+  margin: 0 0 1em;
+}
+
+ol.breadcrumb li {
+  display: block;
+  list-style: none;
+  font-size: 125%;
+}
+
 nav ul,
 nav dl,
 nav p {

test/rdoc/test_rdoc_class_module.rb

@@ -1526,6 +1526,28 @@ def test_update_extends_with_colons
     assert_equal [a, c], @c1.extends
   end
 
+  def test_nesting_namespaces
+    cm1 = RDoc::ClassModule.new "A"
+    assert_equal ["A"], cm1.nesting_namespaces
+
+    cm2 = RDoc::ClassModule.new "A::B"
+    assert_equal ["A", "B"], cm2.nesting_namespaces
+
+    cm3 = RDoc::ClassModule.new "::A::B::C"
+    assert_equal ["A", "B", "C"], cm3.nesting_namespaces
+  end
+
+  def test_fully_qualified_nesting_namespaces
+    cm1 = RDoc::ClassModule.new "A"
+    assert_equal ["A"], cm1.fully_qualified_nesting_namespaces
+
+    cm2 = RDoc::ClassModule.new "A::B"
+    assert_equal ["A", "A::B"], cm2.fully_qualified_nesting_namespaces
+
+    cm3 = RDoc::ClassModule.new "::A::B::C"
+    assert_equal ["A", "A::B", "A::B::C"], cm3.fully_qualified_nesting_namespaces
+  end
+
   class TestRDocClassModuleMixins < XrefTestCase
     def setup
       super