Merge pull request #303 from jonathanhefner/meta-tags-description-aft…

…er-any-headings Extract page description after any leading headings
rails · Sep 14, 2023 · 12ee375 · 12ee375
2 parents 6a202e1 + 413567c
commit 12ee375
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 2 deletions.
diff --git a/lib/sdoc/helpers.rb b/lib/sdoc/helpers.rb
@@ -2,6 +2,9 @@ module SDoc::Helpers
   require_relative "helpers/git"
   include SDoc::Helpers::Git
 
+  LEADING_PARAGRAPH_XPATH =
+    "./*[not(self::h1 or self::h2 or self::h3 or self::h4 or self::h5 or self::h6)][1][self::p]"
+
   def link_to(text, url = nil, html_attributes = {})
     url, html_attributes = nil, url if url.is_a?(Hash)
     url ||= text
@@ -79,7 +82,7 @@ def og_modified_time
   def page_description(leading_html, max_length: 160)
     return if leading_html.nil? || !leading_html.include?("</p>")
 
-    text = Nokogiri::HTML.fragment(leading_html).at_css("h1 + p, p:first-child")&.inner_text
+    text = Nokogiri::HTML.fragment(leading_html).at(LEADING_PARAGRAPH_XPATH)&.inner_text
     return unless text
 
     if text.length > max_length

diff --git a/lib/sdoc/search_index.rb b/lib/sdoc/search_index.rb
@@ -1,5 +1,6 @@
 require "base64"
 require "nokogiri"
+require_relative "helpers"
 
 module SDoc::SearchIndex
   extend self
@@ -120,7 +121,7 @@ def signature_for(rdoc_method)
 
   def truncate_description(description, limit)
     return if description.empty?
-    leading_paragraph = Nokogiri::HTML.fragment(description).at_css("h1 + p, p:first-child")
+    leading_paragraph = Nokogiri::HTML.fragment(description).at(SDoc::Helpers::LEADING_PARAGRAPH_XPATH)
     return unless leading_paragraph
 
     # Treat <code> elements as a whole when truncating

diff --git a/spec/helpers_spec.rb b/spec/helpers_spec.rb
@@ -412,6 +412,11 @@ module Foo; module Bar; module Qux; end; end; end
         <h1>headline</h1>
         <p>paragraph</p>
       HTML
+
+      _(@helpers.page_description(<<~HTML)).must_equal "paragraph"
+        <h1>1</h1><h2>2</h2><h3>3</h3><h4>4</h4><h5>5</h5><h6>6</h6>
+        <p>paragraph</p>
+      HTML
     end
 
     it "returns nil when there is no leading paragraph" do
@@ -420,6 +425,11 @@ module Foo; module Bar; module Qux; end; end; end
         <p>other</p>
       HTML
 
+      _(@helpers.page_description(<<~HTML)).must_be_nil
+        <ul><li><p>item</p></li></ul>
+        <p>other</p>
+      HTML
+
       _(@helpers.page_description("")).must_be_nil
       _(@helpers.page_description(nil)).must_be_nil
     end