Almirah 0.2.3 → 0.2.5

data/lib/almirah/doc_types/index.rb

@@ -1,161 +1,173 @@
-require_relative "base_document"
-
-class Index < BaseDocument
-
-    attr_accessor :project
-
-    def initialize(project)
-        super()
-        @project = project
-        @title = "Document Index"
-        @id = "index"
+# frozen_string_literal: true
+
+require_relative 'base_document'
+
+class Index < BaseDocument # rubocop:disable Metrics/ClassLength,Style/Documentation
+  attr_accessor :project
+
+  def initialize(project)
+    super()
+    @project = project
+    @title = 'Document Index'
+    @id = 'index'
+  end
+
+  def to_console
+    puts "\e[36mIndex: #{@id}\e[0m"
+  end
+
+  def to_html(output_file_path) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
+    html_rows = []
+
+    html_rows.append('')
+    s = "<h1>#{@title}</h1>\n"
+
+    # Specifications
+    s = "<h2>Specifications</h2>\n"
+    s += "<table class=\"controlled\">\n"
+    s += "\t<thead>\n"
+    s += "\t\t<th title=\"Document title\">Title</th>\n"
+    s += "\t\t<th title=\"Number of Controlled Paragraphs\">Items</th>\n"
+    s += "\t\t<th title=\"Number of Controlled Paragraphs with up-links\">Items<br>w/ Up-links</th>\n"
+    s += "\t\t<th title=\"Number of references from other documents\">Items<br>w/ Down-links</th>\n"
+    s += "\t\t<th title=\"Number of Controlled Paragraphs mentioned in Test Cases\">Covered <br>by Tests</th>\n"
+    s += "\t\t<th title=\"Number of Controlled Paragraphs that have the same ID\">Duplicated<br>IDs</th>\n"
+    s += "\t\t<th title=\"Number of Controlled Paragraphs that link to non-existing items\">Wrong<br>links</th>\n"
+    s += "\t\t<th title=\"Number of 'TODO:' blocks in document\">TODOs</th>\n"
+    s += "\t\t<th title=\"The last Controlled Paragraph sequence number (ID) used in the document\">Last Used<br>ID</th>\n"
+    s += "</thead>\n"
+    html_rows.append s
+
+    sorted_items = @project.specifications.sort_by(&:id)
+
+    sorted_items.each do |doc| # rubocop:disable Metrics/BlockLength
+      s = "\t<tr>\n"
+      s += "\t\t<td class=\"item_text\" style='padding: 5px;'><a href=\"./specifications/#{doc.id}/#{doc.id}.html\" class=\"external\"><i class=\"fa fa-file-text-o\" style='background-color: ##{doc.color};'> </i>&nbsp#{doc.title}</a></td>\n"
+      s += "\t\t<td class=\"item_id\" style='width: 7%;'>#{doc.controlled_items.length}</td>\n"
+      s += "\t\t<td class=\"item_id\" style='width: 7%;'>#{doc.items_with_uplinks_number}</td>\n"
+      s += "\t\t<td class=\"item_id\" style='width: 7%;'>#{doc.items_with_downlinks_number}</td>\n"
+      s += "\t\t<td class=\"item_id\" style='width: 7%;'>#{doc.items_with_coverage_number}</td>\n"
+
+      if doc.duplicated_ids_number.positive?
+        s += "\t\t<td class=\"item_id\" style='width: 7%; background-color: #fcc;'>"
+        s += "<div id=\"DL_#{doc.id}\" style=\"display: block;\">"
+        s += "<a  href=\"#\" onclick=\"downlink_OnClick(this.parentElement); return false;\" class=\"external\" title=\"Number of Controlled Paragraphs that have the same ID\">#{doc.duplicated_ids_number}</a>"
+        s += '</div>'
+        s += "<div id=\"DLS_#{doc.id}\" style=\"display: none;\">"
+        doc.duplicates_list.each do |lnk|
+          s += "\t\t\t<a href=\"./specifications/#{doc.id}/#{doc.id}.html##{lnk.id}\" class=\"external\" title=\"Controlled Paragraph with duplicated ID\">#{lnk.id}</a>\n<br>"
+        end
+        s += '</div>'
+        s += "</td>\n"
+      else
+        s += "\t\t<td class=\"item_id\" style='width: 7%;'>#{doc.duplicated_ids_number}</td>\n"
+      end
+
+      if !doc.wrong_links_hash.empty?
+        s += "\t\t<td class=\"item_id\" style='width: 7%; background-color: #fcc;'>"
+        s += "<div id=\"DL_#{doc.id}wl\" style=\"display: block;\">"
+        s += "<a  href=\"#\" onclick=\"downlink_OnClick(this.parentElement); return false;\" class=\"external\" title=\"Number of Controlled Paragraphs that link to non-existing items\">#{doc.wrong_links_hash.length}</a>"
+        s += '</div>'
+        s += "<div id=\"DLS_#{doc.id}wl\" style=\"display: none;\">"
+        doc.wrong_links_hash.each do |wrong_lnk, item|
+          s += "\t\t\t<a href=\"./specifications/#{doc.id}/#{doc.id}.html##{item.id}\" class=\"external\" title=\"Controlled Paragraphs that link to non-existing items\">#{wrong_lnk}</a>\n<br>"
+        end
+        s += '</div>'
+        s += "</td>\n"
+      else
+        s += "\t\t<td class=\"item_id\" style='width: 7%;'>#{doc.wrong_links_hash.length}</td>\n"
+      end
+
+      color = if !doc.todo_blocks.empty?
+                'background-color: #fcc;'
+              else
+                ''
+              end
+      s += "\t\t<td class=\"item_id\" style='width: 7%; #{color}'>#{doc.todo_blocks.length}</td>\n"
+      s += "\t\t<td class=\"item_id\" style='width: 7%;'>#{doc.last_used_id}</td>\n"
+      s += "</tr>\n"
+      html_rows.append s
     end
-
-    def to_console
-        puts "\e[36m" + "Index: " + @id + "\e[0m"
+    html_rows.append "</table>\n"
+
+    # Traceability Matrices
+    s = "<h2>Traceability Matrices</h2>\n"
+    s += "<table class=\"controlled\">\n"
+    s += "\t<thead>\n"
+    s += "\t\t<th title=\"Traceability Matrix Title\">Title</th>\n"
+    s += "\t\t<th title=\"The ratio of Controlled Paragraphs mentioned in other documents and not-mentioned ones\">Coverage</th>\n"
+    s += "\t\t<th title=\"Document, that contains Cotroled Paragraphs to be referenced in Bottom document(s)\">Top Document</th>\n"
+    s += "\t\t<th title=\"Document(s), that contains references to Controlled Paragraphs from the Top Document\">Bottom Document</th>\n"
+    s += "</thead>\n"
+    html_rows.append s
+
+    sorted_items = @project.traceability_matrices.sort_by(&:id)
+    # buble-up design inputs
+    design_inputs = []
+    others = []
+    sorted_items.each do |doc|
+      if doc.bottom_doc
+        others.append doc
+      else
+        design_inputs.append doc
+      end
     end
-
-    def to_html(output_file_path)
-
-        html_rows = Array.new
-
-        html_rows.append('')
-        s = "<h1>#{@title}</h1>\n"
-
-        # Specifications
-        s = "<h2>Specifications</h2>\n"
-        s += "<table class=\"controlled\">\n"
-        s += "\t<thead>\n"
-        s += "\t\t<th title=\"Document title\">Title</th>\n"
-        s += "\t\t<th title=\"Number of Controlled Paragraphs\">Items</th>\n"
-        s += "\t\t<th title=\"Number of Controlled Paragraphs with up-links\">Items<br>w/ Up-links</th>\n"
-        s += "\t\t<th title=\"Number of references from other documents\">Items<br>w/ Down-links</th>\n"
-        s += "\t\t<th title=\"Number of Controlled Paragraphs mentioned in Test Cases\">Covered <br>by Tests</th>\n"
-        s += "\t\t<th title=\"Number of Controlled Paragraphs that have the same ID\">Duplicated<br>IDs</th>\n"
-        s += "\t\t<th title=\"Number of Controlled Paragraphs that link to non-existing items\">Wrong<br>links</th>\n"
-        s += "\t\t<th title=\"Number of 'TODO:' blocks in document\">TODOs</th>\n"
-        s += "\t\t<th title=\"The last Controlled Paragraph sequence number (ID) used in the document\">Last Used<br>ID</th>\n"
-        s += "</thead>\n"
-        html_rows.append s
-
-        sorted_items = @project.specifications.sort_by { |w| w.id }
-
-        sorted_items.each do |doc|
-            s = "\t<tr>\n"
-            s += "\t\t<td class=\"item_text\" style='padding: 5px;'><a href=\"./specifications/#{doc.id}/#{doc.id}.html\" class=\"external\"><i class=\"fa fa-file-text-o\" style='background-color: ##{doc.color};'> </i>&nbsp#{doc.title}</a></td>\n"
-            s += "\t\t<td class=\"item_id\" style='width: 7%;'>#{doc.controlled_items.length.to_s}</td>\n"
-            s += "\t\t<td class=\"item_id\" style='width: 7%;'>#{doc.items_with_uplinks_number.to_s}</td>\n"
-            s += "\t\t<td class=\"item_id\" style='width: 7%;'>#{doc.items_with_downlinks_number.to_s}</td>\n"
-            s += "\t\t<td class=\"item_id\" style='width: 7%;'>#{doc.items_with_coverage_number.to_s}</td>\n"
-            
-            if doc.duplicated_ids_number >0
-                s += "\t\t<td class=\"item_id\" style='width: 7%; background-color: #fcc;'>"
-                s += "<div id=\"DL_#{doc.id}\" style=\"display: block;\">"
-                s += "<a  href=\"#\" onclick=\"downlink_OnClick(this.parentElement); return false;\" class=\"external\" title=\"Number of Controlled Paragraphs that have the same ID\">#{doc.duplicated_ids_number.to_s}</a>"
-                s += "</div>"
-                s += "<div id=\"DLS_#{doc.id}\" style=\"display: none;\">"
-                doc.duplicates_list.each do |lnk|
-                    s += "\t\t\t<a href=\"./specifications/#{doc.id}/#{doc.id}.html##{lnk.id}\" class=\"external\" title=\"Controlled Paragraph with duplicated ID\">#{lnk.id}</a>\n<br>"
-                end
-                s += "</div>"
-                s += "</td>\n"
-            else
-                s += "\t\t<td class=\"item_id\" style='width: 7%;'>#{doc.duplicated_ids_number.to_s}</td>\n"
-            end
-
-            if doc.wrong_links_hash.length >0
-                s += "\t\t<td class=\"item_id\" style='width: 7%; background-color: #fcc;'>"
-                s += "<div id=\"DL_#{doc.id}wl\" style=\"display: block;\">"
-                s += "<a  href=\"#\" onclick=\"downlink_OnClick(this.parentElement); return false;\" class=\"external\" title=\"Number of Controlled Paragraphs that link to non-existing items\">#{doc.wrong_links_hash.length.to_s}</a>"
-                s += "</div>"
-                s += "<div id=\"DLS_#{doc.id}wl\" style=\"display: none;\">"
-                doc.wrong_links_hash.each do |wrong_lnk, item|
-                    s += "\t\t\t<a href=\"./specifications/#{doc.id}/#{doc.id}.html##{item.id}\" class=\"external\" title=\"Controlled Paragraphs that link to non-existing items\">#{wrong_lnk}</a>\n<br>"
-                end
-                s += "</div>"
-                s += "</td>\n"
-            else
-                s += "\t\t<td class=\"item_id\" style='width: 7%;'>#{doc.wrong_links_hash.length.to_s}</td>\n"
-            end
-
-            if doc.todo_blocks.length >0
-                color = "background-color: #fcc;"
-            else
-                color = ""
-            end
-            s += "\t\t<td class=\"item_id\" style='width: 7%; #{color}'>#{doc.todo_blocks.length.to_s}</td>\n"
-            s += "\t\t<td class=\"item_id\" style='width: 7%;'>#{doc.last_used_id.to_s}</td>\n"
-            s += "</tr>\n"
-            html_rows.append s
-        end
-        html_rows.append "</table>\n"
-
-        # Traceability Matrices
-        s = "<h2>Traceability Matrices</h2>\n"
-        s += "<table class=\"controlled\">\n"
-        s += "\t<thead>\n"
-        s += "\t\t<th title=\"Traceability Matrix Title\">Title</th>\n"
-        s += "\t\t<th title=\"The ratio of Controlled Paragraphs mentioned in other documents and not-mentioned ones\">Coverage</th>\n"
-        s += "\t\t<th title=\"Document, that contains Cotroled Paragraphs to be referenced in Bottom document(s)\">Top Document</th>\n"
-        s += "\t\t<th title=\"Document(s), that contains references to Controlled Paragraphs from the Top Document\">Bottom Document</th>\n"
-        s += "</thead>\n"
+    sorted_items = design_inputs + others
+
+    sorted_items.each do |doc|
+      s = "\t<tr>\n"
+      coverage = doc.traced_items.length.to_f / doc.top_doc.controlled_items.length * 100.0
+      s += "\t\t<td class=\"item_text\" style='padding: 5px;'><a href=\"./specifications/#{doc.id}/#{doc.id}.html\" class=\"external\">#{doc.title}</a></td>\n"
+      s += "\t\t<td class=\"item_id\" style='width: 7%;'>#{'%.2f' % coverage}%</td>\n"
+      s += "\t\t<td class=\"item_text\" style='width: 25%; padding: 5px;'><i class=\"fa fa-file-text-o\" style='background-color: ##{doc.top_doc.color};'> </i>&nbsp#{doc.top_doc.title}</td>\n"
+      if doc.bottom_doc
+        s += "\t\t<td class=\"item_text\" style='width: 25%; padding: 5px;'><i class=\"fa fa-file-text-o\" style='background-color: ##{doc.bottom_doc.color};'> </i>&nbsp#{doc.bottom_doc.title}</td>\n"
+      else
+        s += "\t\t<td class=\"item_text\" style='width: 25%; padding: 5px;'><i class=\"fa fa-circle-o\"'> </i>&nbspAll References</td>\n"
+      end
+      s += "</tr>\n"
+      html_rows.append s
+    end
+    html_rows.append "</table>\n"
+
+    # Coverage Matrices
+    unless @project.coverage_matrices.empty?
+      s = "<h2>Coverage Matrices</h2>\n"
+      s += "<table class=\"controlled\">\n"
+      s += "\t<thead>\n"
+      s += "\t\t<th>Title</th>\n"
+      s += "\t\t<th title=\"The ratio of Controlled Paragraphs mentioned in test protocols and total number of Controlled Paragraphs\">Coverage</th>\n"
+      s += "\t\t<th title=\"Numbers of passed and failed test steps\">Test Results</th>\n"
+      s += "\t\t<th>Specification Covered</th>\n"
+      s += "</thead>\n"
+      html_rows.append s
+
+      sorted_items = @project.coverage_matrices.sort_by(&:id)
+
+      sorted_items.each do |doc|
+        s = "\t<tr>\n"
+        coverage = doc.covered_items.length.to_f / doc.top_doc.controlled_items.length * 100.0
+
+        test_step_color = if doc.failed_steps_number.positive?
+                            'background-color: #fcc;'
+                          elsif !doc.failed_steps_number.positive? && doc.passed_steps_number.positive?
+                            'background-color: #cfc;'
+                          else
+                            'background-color: #ffffee;'
+                          end
+
+        s += "\t\t<td class=\"item_text\" style='padding: 5px;'><a href=\"./specifications/#{doc.id}/#{doc.id}.html\" class=\"external\">#{doc.title}</a></td>\n"
+        s += "\t\t<td class=\"item_id\" style='width: 7%;'>#{'%.2f' % coverage}%</td>\n" # rubocop:disable Style/FormatString
+        s += "\t\t<td class=\"item_id\" style='width: 7%; #{test_step_color}' title='pass/fail'> #{doc.passed_steps_number}/#{doc.failed_steps_number} </td>\n"
+        s += "\t\t<td class=\"item_text\" style='width: 25%; padding: 5px;'>\
+                    <i class=\"fa fa-file-text-o\" style='background-color: ##{doc.top_doc.color};'> </i>\
+                    #{doc.top_doc.title}</td>\n"
+        s += "</tr>\n"
         html_rows.append s
-
-        sorted_items = @project.traceability_matrices.sort_by { |w| w.id }
-        # buble-up design inputs
-        design_inputs = [] 
-        others = []
-        sorted_items.each do |doc|
-            if doc.bottom_doc
-                others.append doc
-            else
-                design_inputs.append doc
-            end
-        end
-        sorted_items = design_inputs + others
-
-        sorted_items.each do |doc|
-            s = "\t<tr>\n"
-            coverage = doc.traced_items.length.to_f / doc.top_doc.controlled_items.length.to_f * 100.0
-            s += "\t\t<td class=\"item_text\" style='padding: 5px;'><a href=\"./specifications/#{doc.id}/#{doc.id}.html\" class=\"external\">#{doc.title}</a></td>\n"
-            s += "\t\t<td class=\"item_id\" style='width: 7%;'>#{'%.2f' % coverage}%</td>\n"
-            s += "\t\t<td class=\"item_text\" style='width: 25%; padding: 5px;'><i class=\"fa fa-file-text-o\" style='background-color: ##{doc.top_doc.color};'> </i>&nbsp#{doc.top_doc.title}</td>\n"
-            if doc.bottom_doc
-                s += "\t\t<td class=\"item_text\" style='width: 25%; padding: 5px;'><i class=\"fa fa-file-text-o\" style='background-color: ##{doc.bottom_doc.color};'> </i>&nbsp#{doc.bottom_doc.title}</td>\n"
-            else
-                s += "\t\t<td class=\"item_text\" style='width: 25%; padding: 5px;'><i class=\"fa fa-circle-o\"'> </i>&nbspAll References</td>\n"
-            end
-            s += "</tr>\n"
-            html_rows.append s
-        end
-        html_rows.append "</table>\n"
-
-        # Coverage Matrices
-        if @project.coverage_matrices.length > 0
-            s = "<h2>Coverage Matrices</h2>\n"
-            s += "<table class=\"controlled\">\n"
-            s += "\t<thead>\n"
-            s += "\t\t<th>Title</th>\n"
-            s += "\t\t<th>Specification Covered</th>\n"
-            s += "</thead>\n"
-            html_rows.append s
-
-            sorted_items = @project.coverage_matrices.sort_by { |w| w.id }
-
-            sorted_items.each do |doc|
-                s = "\t<tr>\n"
-                s += "\t\t<td class=\"item_text\" style='padding: 5px;'><a href=\"./specifications/#{doc.id}/#{doc.id}.html\" class=\"external\">#{doc.title}</a></td>\n"
-                s += "\t\t<td class=\"item_text\" style='width: 25%; padding: 5px;'>#{doc.top_doc.title}</td>\n"
-                s += "</tr>\n"
-                html_rows.append s
-            end
-            html_rows.append "</table>\n"
-        end
-
-        self.save_html_to_file(html_rows, nil, output_file_path)
-        
+      end
+      html_rows.append "</table>\n"
     end
 
-
-
-end
+    save_html_to_file(html_rows, nil, output_file_path)
+  end
+end

data/lib/almirah/doc_types/persistent_document.rb

@@ -1,20 +1,17 @@
-require_relative "base_document"
+# frozen_string_literal: true
 
-class PersistentDocument < BaseDocument
+require_relative 'base_document'
 
-    attr_accessor :path
-    attr_accessor :items
-    attr_accessor :controlled_items
-    attr_accessor :headings
-    attr_accessor :up_link_docs
+class PersistentDocument < BaseDocument # rubocop:disable Style/Documentation
+  attr_accessor :path, :items, :controlled_items, :headings, :up_link_docs, :frontmatter
 
-    def initialize(fele_path)
-        super()
-        @path = fele_path
-        @items = []
-        @controlled_items = []
-        @headings = []
-        @up_link_docs = {}
-    end
-
-end
+  def initialize(fele_path)
+    super()
+    @path = fele_path
+    @items = []
+    @controlled_items = []
+    @headings = []
+    @up_link_docs = {}
+    @frontmatter = nil
+  end
+end

data/lib/almirah/doc_types/traceability.rb

@@ -8,11 +8,15 @@ class Traceability < BaseDocument
     attr_accessor :is_agregated
     attr_accessor :traced_items
 
-    def initialize(top_doc, bottom_doc, is_agregated)
+    def initialize(top_doc, bottom_doc)
         super()
         @top_doc = top_doc
         @bottom_doc = bottom_doc
-        @is_agregated = is_agregated
+        @is_agregated = if bottom_doc
+                          false
+                        else
+                          true
+                        end
         @traced_items = {}
 
         if @is_agregated 

data/lib/almirah/dom/doc_section.rb

@@ -1,28 +1,25 @@
 class DocSection
+  attr_accessor :sections, :heading, :parent_section
 
-    attr_accessor :sections
-    attr_accessor :heading
-    attr_accessor :parent_section
+  def initialize(heading)
+    @sections = []
+    @heading = heading
+    @parent_section = nil
+  end
 
-    def initialize(heading)
-        @sections = Array.new
-        @heading = heading
-        @parent_section = nil
+  def to_html # rubocop:disable Metrics/MethodLength
+    s = ''
+    s += "\t<li onclick=\"nav_toggle_expand_list(this, event)\">" \
+      '<span class="fa-li"><i class="fa fa-minus-square-o"> </i></span>'
+    s += "<a href=\"##{@heading.anchor_id}\">#{@heading.get_section_info}</a>\n"
+    unless @sections.empty?
+      s += "\t\t<ul class=\"fa-ul\">\n"
+      @sections.each do |sub_section|
+        s += sub_section.to_html
+      end
+      s += "\t\t</ul>\n"
     end
-
-    def to_html
-        s = ''
-        s += "\t<li><span class=\"fa-li\"><i class=\"fa fa-square-o\"> </i></span>"
-        s += "<a href=\"\#" + @heading.anchor_id.to_s + "\">" + @heading.get_section_info + "</a>\n"
-        if @sections.length >0
-            s += "\t\t<ul class=\"fa-ul\">\n"
-                @sections.each do |sub_section|
-                    s += sub_section.to_html()
-                end
-            s += "\t\t</ul>\n"
-        end
-        s += "</li>\n"
-        return s
-    end
-
-end
+    s += "</li>\n"
+    s
+  end
+end

data/lib/almirah/dom/document.rb

@@ -1,63 +1,78 @@
-require_relative "doc_section"
+require_relative 'doc_section'
 
 class Document
-
-    attr_accessor :root_section
-
-    @@sections_stack = Array.new
-
-    def initialize(headings_list)
-        @root_section = nil
-
-        build_sections_tree(headings_list)
-    end
-
-    def build_sections_tree(headings_list)
-
-        headings_list.each do |h|
-
-            if @root_section == nil
-
-                s = DocSection.new(h)
-                s.parent_section = nil
-                @root_section = s
-                @@sections_stack.push s
-
-            elsif @@sections_stack[-1].heading.level == h.level
-
-                s = DocSection.new(h)
-                @@sections_stack[-2].sections.append(s)
-                @@sections_stack[-1] = s
-
-            elsif h.level > @@sections_stack[-1].heading.level
-
-                s = DocSection.new(h)
-                @@sections_stack[-1].sections.append(s)
-                @@sections_stack.push s
-
-            else
-                while h.level < @@sections_stack[-1].heading.level
-                    @@sections_stack.pop
-                end
-
-                s = DocSection.new(h)
-                @@sections_stack[-2].sections.append(s)
-                @@sections_stack[-1] = s
-            end
+  attr_accessor :root_section
+
+  def initialize(headings_list)
+    @root_section = nil
+
+    build_sections_tree(headings_list)
+  end
+
+  def build_sections_tree(headings_list)
+    sections_stack = []
+    headings_list.each do |h|
+      if @root_section.nil?
+
+        s = DocSection.new(h)
+        s.parent_section = nil
+        @root_section = s
+        sections_stack.push s
+        # one more artificial section copy if root is not a Document Title (level 0)
+        if h.level.positive?
+          a = DocSection.new(h)
+          a.parent_section = @root_section
+          @root_section.sections.append(a)
+          sections_stack.push a
         end
-    end
 
-    def section_tree_to_html
-        s = ''
-        s += "<a href=\"\#" + @root_section.heading.anchor_id.to_s + "\">" + @root_section.heading.get_section_info + "</a>\n"
-        if @root_section.sections.length >0
-            s += "\t<ul class=\"fa-ul\" style=\"margin-top: 2px;\">\n"
-            @root_section.sections.each do |sub_section|
-                s += sub_section.to_html()
-            end
-            s += "\t</ul>\n"
+      elsif sections_stack[-1].heading.level == h.level
+
+        s = DocSection.new(h)
+        s.parent_section = sections_stack[-1].parent_section
+        sections_stack[-1].parent_section.sections.append(s)
+        sections_stack[-1] = s
+        # for search engine
+        s.heading.parent_heading = s.parent_section.heading
+
+      elsif h.level > sections_stack[-1].heading.level
+
+        s = DocSection.new(h)
+        s.parent_section = sections_stack[-1]
+        sections_stack[-1].sections.append(s)
+        sections_stack.push s
+        # for search engine
+        s.heading.parent_heading = s.parent_section.heading
+
+      else
+        sections_stack.pop while h.level < sections_stack[-1].heading.level
+        sections_stack.push @root_section if sections_stack.empty?
+        s = DocSection.new(h)
+        if h.level == sections_stack[-1].heading.level
+          s.parent_section = sections_stack[-1].parent_section
+          sections_stack[-1].parent_section.sections.append(s)
+        else
+          s.parent_section = sections_stack[-1]
+          sections_stack[-1].sections.append(s)
         end
-
-        return s
+        sections_stack[-1] = s
+        # for search engine
+        s.heading.parent_heading = s.parent_section.heading
+      end
     end
-end
+  end
+
+  def section_tree_to_html
+    s = ''
+    s += "<a href=\"##{@root_section.heading.anchor_id}\">#{@root_section.heading.get_section_info}</a>\n"
+    unless @root_section.sections.empty?
+      s += "\t<ul class=\"fa-ul\" style=\"margin-top: 2px;\">\n"
+      @root_section.sections.each do |sub_section|
+        s += sub_section.to_html
+      end
+      s += "\t</ul>\n"
+    end
+
+    s
+  end
+end