Class: JekyllPagesApi::GeneratedPageParser

Inherits:

Object

Object
JekyllPagesApi::GeneratedPageParser

show all

Defined in:: lib/jekyll_pages_api/generated_page_parser.rb

Overview

Contains helper methods for parsing values from HTML.

Class Method Summary collapse

.parse_basic_tag(tag_name, content) ⇒ String^?
Parses a value from content from between tags that cannot be nested, e.g.
.parse_content_from_body(content, body_element_tag) ⇒ Object
Parse actual content from an HTML page, leaving out boilerplate.
.parse_generated_page(content, title_prefix, body_element_tag) ⇒ Hash<String, String>, String
Parses elements from a generated page's content needed by GeneratedPage.
.parse_meta_tags(head_element) ⇒ Hash<String, String>
Parses the (name, content) pairs from tags in the element.

Class Method Details

.parse_basic_tag(tag_name, content) ⇒ `String`^?

Parses a value from content from between tags that cannot be nested, e.g. , , . </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> tag_name (<tt>String</tt>) — <div class='inline'>name of the tag to parse</div> </li> <li> content (<tt>String</tt>) — <div class='inline'>HTML content from which to parse a value</div> </li> </ul> Returns: <ul class="return"> <li> (<tt>String</tt>) — <div class='inline'>if a value is successfully parsed</div> </li> <li> (<tt>nil</tt>) — <div class='inline'>if the tag isn't present in content, or is not well-formed</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 33 34 35 36 37 38 39 40 41 42</pre> </td> <td> <pre class="code"># File 'lib/jekyll_pages_api/generated_page_parser.rb', line 33 def self.parse_basic_tag(tag_name, content) open_tag = "<#{tag_name}" close_tag = "</#{tag_name}>" open_i = content.index open_tag return nil if open_i.nil? open_i = content.index('>', open_i + open_tag.size) + 1 close_i = content.index close_tag, open_i return nil if close_i.nil? content[open_i..close_i-1] end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="parse_content_from_body-class_method"> .parse_content_from_body(content, body_element_tag) ⇒ <tt>Object</tt> </h3><script> document.getElementById("parse_content_from_body-class_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/jekyll_pages_api/JekyllPagesApi%2FGeneratedPageParser%2Eparse_content_from_body">permalink</a>' ); </script> <div class="docstring"> <div class="discussion"> Parse actual content from an HTML page, leaving out boilerplate. </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> content (<tt>String</tt>) — <div class='inline'>content of an HTML document</div> </li> <li> body_element_tag — <div class='inline'>see <a href="/gems/jekyll_pages_api/JekyllPagesApi/GeneratedSite#initialize-instance_method" title="JekyllPagesApi::GeneratedSite#initialize (method)">JekyllPagesApi::GeneratedSite#initialize</a></div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119</pre> </td> <td> <pre class="code"># File 'lib/jekyll_pages_api/generated_page_parser.rb', line 85 def self.parse_content_from_body(content, body_element_tag) body = parse_basic_tag 'body', content return content if body.nil? start_body = body.index body_element_tag unless body_element_tag.empty? return body if start_body.nil? start_body += 1 end_name_i = body.index ' ', start_body bracket_i = body.index '>', start_body end_name_i = bracket_i if bracket_i < end_name_i tag_name = body[start_body..end_name_i-1] open_tag = "<#{tag_name}" end_tag = "</#{tag_name}>" start_body = bracket_i + 1 search_i = start_body open_tag_i = body.index open_tag, search_i end_tag_i = body.index end_tag, search_i depth = 1 until depth == 0 if end_tag_i.nil? raise "End tag missing: #{end_tag}" end if !open_tag_i.nil? && open_tag_i < end_tag_i depth += 1 search_i = open_tag_i + open_tag.size open_tag_i = body.index open_tag, search_i else depth -= 1 search_i = end_tag_i + end_tag.size end_tag_i = body.index end_tag, search_i unless depth == 0 end end body[start_body..end_tag_i-1] end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="parse_generated_page-class_method"> .parse_generated_page(content, title_prefix, body_element_tag) ⇒ <tt>Hash<String, String></tt>, <tt>String</tt> </h3><script> document.getElementById("parse_generated_page-class_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/jekyll_pages_api/JekyllPagesApi%2FGeneratedPageParser%2Eparse_generated_page">permalink</a>' ); </script> <div class="docstring"> <div class="discussion"> Parses elements from a generated page's content needed by GeneratedPage. </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> content — <div class='inline'>see <a href="/gems/jekyll_pages_api/JekyllPagesApi/GeneratedPage#initialize-instance_method" title="JekyllPagesApi::GeneratedPage#initialize (method)">JekyllPagesApi::GeneratedPage#initialize</a></div> </li> <li> title_prefix — <div class='inline'>see <a href="/gems/jekyll_pages_api/JekyllPagesApi/GeneratedSite#initialize-instance_method" title="JekyllPagesApi::GeneratedSite#initialize (method)">JekyllPagesApi::GeneratedSite#initialize</a></div> </li> <li> body_element_tag — <div class='inline'>see <a href="/gems/jekyll_pages_api/JekyllPagesApi/GeneratedSite#initialize-instance_method" title="JekyllPagesApi::GeneratedSite#initialize (method)">JekyllPagesApi::GeneratedSite#initialize</a></div> </li> </ul> Returns: <ul class="return"> <li> (<tt>Hash<String, String></tt>, <tt>String</tt>) — <div class='inline'>the metadata hash containing the <code>title</code>, <code>tags</code>, and <code>skip-index</code> elements; and the body content stripped of boilerplate</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 13 14 15 16 17 18 19 20 21 22 23 24 25</pre> </td> <td> <pre class="code"># File 'lib/jekyll_pages_api/generated_page_parser.rb', line 13 def self.parse_generated_page(content, title_prefix, body_element_tag) data = {} head_element = self.parse_basic_tag 'head', content return data, "" if head_element.nil? title = self.parse_basic_tag 'title', head_element if !title.nil? && title.start_with?(title_prefix) title = title[title_prefix.size..title.size] end data['title'] = title data.merge!(self.parse_meta_tags head_element) return data, self.parse_content_from_body(content, body_element_tag) end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="parse_meta_tags-class_method"> .parse_meta_tags(head_element) ⇒ <tt>Hash<String, String></tt> </h3><script> document.getElementById("parse_meta_tags-class_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/jekyll_pages_api/JekyllPagesApi%2FGeneratedPageParser%2Eparse_meta_tags">permalink</a>' ); </script> <div class="docstring"> <div class="discussion"> Parses the (name, content) pairs from <meta> tags in the <head> element. Note that it parses only the <code>name</code> and <code>content</code> fields. </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> head_element (<tt>String</tt>) — <div class='inline'><head> element from an HTML document</div> </li> </ul> Returns: <ul class="return"> <li> (<tt>Hash<String, String></tt>) — <div class='inline'>a collection of (name, content) values</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80</pre> </td> <td> <pre class="code"># File 'lib/jekyll_pages_api/generated_page_parser.rb', line 48 def self.parse_meta_tags(head_element) open_tag = "<meta " open_i = head_element.index open_tag meta_tags = {} until open_i.nil? do # -1 to remove the space at the end. open_i += open_tag.size - 1 close_i = head_element.index '>', open_i return meta_tags if close_i.nil? current = head_element[open_i..close_i] attrs = {'name' => nil, 'content' => nil} attrs.keys.each do |attr| attr_begin = " #{attr}=" attr_begin_i = current.index attr_begin unless attr_begin_i.nil? attr_begin_i += attr_begin.size + 1 delim = current[attr_begin_i-1] attr_end_i = current.index delim, attr_begin_i next if attr_end_i.nil? attr_end_i -= 1 attrs[attr] = current[attr_begin_i..attr_end_i] end end meta_name = attrs['name'] meta_tags[meta_name] = attrs['content'] unless meta_name.nil? close_i += 1 open_i = head_element.index open_tag, close_i end meta_tags end</pre> </td> </tr> </table> </div> </div> </div> <div id="footer"> Generated on Mon Sep 21 05:08:59 2026 by <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.45 (ruby-4.0.7). </div> </div> </body> </html>

Class: JekyllPagesApi::GeneratedPageParser

Overview

Class Method Summary collapse

Class Method Details

.parse_basic_tag(tag_name, content) ⇒ String?

.parse_basic_tag(tag_name, content) ⇒ `String`^?