Almirah 0.2.4 → 0.2.6

data/lib/almirah/doc_parser.rb

@@ -1,330 +1,378 @@
-require_relative 'doc_items/text_line'
-require_relative 'doc_items/doc_item'
-require_relative 'doc_items/heading'
-require_relative 'doc_items/paragraph'
-require_relative 'doc_items/blockquote'
-require_relative 'doc_items/code_block'
-require_relative 'doc_items/todo_block'
-require_relative 'doc_items/controlled_paragraph'
-require_relative 'doc_items/markdown_table'
-require_relative 'doc_items/controlled_table'
-require_relative 'doc_items/image'
-require_relative 'doc_items/markdown_list'
-require_relative 'doc_items/doc_footer'
-
-class DocParser
-  def self.parse(doc, text_lines)
-    temp_md_table = nil
-    temp_md_list = nil
-    temp_code_block = nil
-    # restart section numbering for each new document
-    Heading.reset_global_section_number
-
-    text_lines.each do |s|
-      if s.lstrip != ''
-        if res = /^(\#{1,})\s(.*)/.match(s) # Heading
-
-          temp_md_table = process_temp_table(doc, temp_md_table)
-          if temp_md_list
-            doc.items.append temp_md_list
-            temp_md_list = nil
-          end
-
-          level = res[1].length
-          value = res[2]
-
-          if level == 1 && doc.title == ''
-            doc.title = value
-          end
-
-          item = Heading.new(doc, value, level)
-          doc.items.append(item)
-          doc.headings.append(item)
-
-        elsif res = /^%\s(.*)/.match(s) # Pandoc Document Title
-
-          title = res[1]
-
-          if doc.title == ''
-            doc.title = title
-          end
-
-          item = Heading.new(doc, title, 0)
-          doc.items.append(item)
-          doc.headings.append(item)
-
-        elsif res = /^\[(\S*)\]\s+(.*)/.match(s) # Controlled Paragraph
-
-          temp_md_table = process_temp_table(doc, temp_md_table)
-          if temp_md_list
-            doc.items.append temp_md_list
-            temp_md_list = nil
-          end
-
-          id = res[1].upcase
-          text = res[2]
-          up_links = nil
-
-          # check if it contains the uplink (one or many)
-          # TODO: check this regular expression
-          first_pos = text.length # for trailing commas
-          tmp = text.scan(/(>\[(?>[^\[\]]|\g<0>)*\])/) # >[SRS-001], >[SYS-002]
-          if tmp.length > 0
-            up_links = []
-            tmp.each do |ul|
-              lnk = ul[0]            
-              # do not add links for the self document
-              doc_id = /([a-zA-Z]+)-\d+/.match(lnk) # SRS
-              if (doc_id) and (doc_id[1].downcase != doc.id.downcase)
-                up_links << lnk.upcase
-              end
-              # try to find the real end of text
-              pos = text.index(lnk)
-              first_pos = pos if pos < first_pos
-              # remove uplink from text
-              text = text.split(lnk, 1).join('')
-            end
-            # remove trailing commas and spaces
-            if text.length > first_pos
-              first_pos -= 1
-              text = text[0..first_pos].strip
-            end
-          end
-
-          # since we already know id and text
-          item = ControlledParagraph.new(doc, text, id)
-
-          if up_links
-            up_links.uniq! #remove duplicates
-            doc.items_with_uplinks_number += 1 # for statistics
-            up_links.each do |ul|
-              next unless tmp = />\[(\S*)\]$/.match(ul) # >[SRS-001]
-
-              up_link_id = tmp[1]
-
-              item.up_link_ids = [] unless item.up_link_ids
-
-              item.up_link_ids.append(up_link_id)
-
-              if tmp = /^([a-zA-Z]+)-\d+/.match(up_link_id) # SRS
-                doc.up_link_docs[tmp[1].downcase.to_s] = tmp[1].downcase # multiple documents could be up-linked
-              end
-            end
-          end
-
-          doc.items.append(item)
-          # for statistics
-          if doc.dictionary.has_key?(id.to_s)
-            doc.duplicated_ids_number += 1
-            doc.duplicates_list.append(item)
-          else
-            doc.dictionary[id.to_s] = item # for fast search
-          end
-          doc.controlled_items.append(item) # for fast search
-
-          # for statistics
-          n = /\d+/.match(id)[0].to_i
-          if n > doc.last_used_id_number
-            doc.last_used_id = id
-            doc.last_used_id_number = n
-          end
-
-        elsif res = /^!\[(.*)\]\((.*)\)/.match(s) # Image
-
-          temp_md_table = process_temp_table(doc, temp_md_table)
-          if temp_md_list
-            doc.items.append temp_md_list
-            temp_md_list = nil
-          end
-
-          img_text = res[1]
-          img_path = res[2]
-
-          item = Image.new(img_text, img_path)
-          item.parent_doc = doc
-          item.parent_heading = doc.headings[-1]
-
-          doc.items.append(item)
-
-        elsif res = /^(\*\s+)(.*)/.match(s)   # check if unordered list start
-
-          temp_md_table = process_temp_table(doc, temp_md_table)
-
-          row = res[2]
-
-          if temp_md_list
-            temp_md_list.add_row(s)
-          else
-            item = MarkdownList.new(doc, false)
-            item.add_row(s)
-            temp_md_list = item
-          end
-
-        elsif res = /^\d[.]\s(.*)/.match(s)   # check if ordered list start
-
-          temp_md_table = process_temp_table(doc, temp_md_table)
-
-          row = res[1]
-
-          if temp_md_list
-            temp_md_list.add_row(s)
-          else
-            item = MarkdownList.new(doc, true)
-            item.add_row(s)
-            temp_md_list = item
-          end
-
-        elsif s[0] == '|' # check if table
-
-          if temp_md_list
-            doc.items.append temp_md_list
-            temp_md_list = nil
-          end
-
-          if res = /^[|](-{3,})[|]/.match(s) # check if it is a separator first
-
-            if temp_md_table
-            # separator is found after heading
-            temp_md_table.is_separator_detected = true
-            else
-              # separator out of table scope consider it just as a regular paragraph
-              item = Paragraph.new(doc, s)
-              doc.items.append(item)
-            end
-
-          elsif res = /^[|](.*[|])/.match(s) # check if it looks as a table row
-
-            row = res[1]
-
-            if temp_md_table
-              if temp_md_table.is_separator_detected # if there is a separator
-                # check if parent doc is a Protocol
-                if doc.instance_of? Protocol
-                  # check if it is a controlled table
-                  tmp = /(.*)\s+>\[(\S*)\]/.match(row)
-                  if tmp && (temp_md_table.instance_of? MarkdownTable)
-                    # this is not a regular Markdown table
-                    # so the table type shall be changed and this row shall be passed one more time
-                    temp_md_table = ControlledTable.new(doc, temp_md_table)
-                  end
-                end
-                temp_md_table.add_row(row)
-              else
-                # replece table heading with regular paragraph
-                item = Paragraph.new(doc, temp_md_table.heading_row)
-                doc.items.append(item)
-                # and current row
-                item = Paragraph.new(doc, s)
-                doc.items.append(item)
-                temp_md_table = nil
-              end
-            else
-              # start table from heading
-              temp_md_table = MarkdownTable.new(doc, s)
-            end
-          end
-
-        elsif res = /^>(.*)/.match(s) # check if blockquote
-
-          temp_md_table = process_temp_table(doc, temp_md_table)
-
-          if temp_md_list
-            doc.items.append temp_md_list
-            temp_md_list = nil
-          end
-
-          item = Blockquote.new(res[1])
-          item.parent_doc = doc
-          item.parent_heading = doc.headings[-1]
-          doc.items.append(item)
-
-        elsif res = /^```(\w*)/.match(s) # check if code block
-
-          temp_md_table = process_temp_table(doc, temp_md_table)
-          if temp_md_list
-            doc.items.append temp_md_list
-            temp_md_list = nil
-          end
-
-          suggested_format = ''
-          suggested_format = res[1] if res.length == 2
-
-          if temp_code_block
-            # close already opened block
-            doc.items.append(temp_code_block)
-            temp_code_block = nil
-          else
-            # start code block
-            temp_code_block = CodeBlock.new(suggested_format)
-            temp_code_block.parent_doc = doc
-          end
-
-        elsif res = /^TODO:(.*)/.match(s) # check if TODO block
-
-          temp_md_table = process_temp_table(doc, temp_md_table)
-          if temp_md_list
-            doc.items.append temp_md_list
-            temp_md_list = nil
-          end
-
-          text = '**TODO**: ' + res[1]
-
-          item = TodoBlock.new(text)
-          item.parent_doc = doc
-          item.parent_heading = doc.headings[-1]
-          doc.items.append(item)
-          doc.todo_blocks.append(item)
-
-        else # Reqular Paragraph
-          temp_md_table = process_temp_table(doc, temp_md_table)
-          if temp_md_list
-            if MarkdownList.unordered_list_item?(s) || MarkdownList.ordered_list_item?(s)
-              temp_md_list.add_row(s)
-              next
-            else
-              doc.items.append temp_md_list
-              temp_md_list = nil
-            end
-          end
-          if temp_code_block
-            temp_code_block.code_lines.append(s)
-          else
-            item = Paragraph.new(doc, s)
-            doc.items.append(item)
-          end
-        end
-      elsif temp_md_list
-        doc.items.append temp_md_list
-        temp_md_list = nil # lists are separated by emty line from each other
-      end
-    end
-    # Finalize non-closed elements
-    temp_md_table = process_temp_table(doc, temp_md_table)
-    if temp_md_list
-      doc.items.append temp_md_list
-      temp_md_list = nil
-    end
-    if temp_code_block
-      doc.items.append temp_code_block
-      temp_code_block = nil
-    end
-    # Add footer to close opened tables if any
-    item = DocFooter.new
-    item.parent_doc = doc
-    doc.items.append(item)
-  end
-
-  def self.process_temp_table(doc, temp_md_table) # rubocop:disable Metrics/MethodLength
-    if temp_md_table
-      if temp_md_table.is_separator_detected
-        doc.items.append temp_md_table
-      else # no separator
-        # replece table heading with regular paragraph
-        item = Paragraph.new(doc, temp_md_table.heading_row)
-        doc.items.append(item)
-      end
-      temp_md_table = nil
-    end
-    temp_md_table
-  end
-end
+require_relative 'doc_items/text_line'
+require_relative 'doc_items/doc_item'
+require_relative 'doc_items/heading'
+require_relative 'doc_items/paragraph'
+require_relative 'doc_items/blockquote'
+require_relative 'doc_items/code_block'
+require_relative 'doc_items/todo_block'
+require_relative 'doc_items/controlled_paragraph'
+require_relative 'doc_items/markdown_table'
+require_relative 'doc_items/controlled_table'
+require_relative 'doc_items/image'
+require_relative 'doc_items/markdown_list'
+require_relative 'doc_items/doc_footer'
+require_relative 'doc_items/frontmatter'
+
+class DocParser # rubocop:disable Metrics/ClassLength,Style/Documentation
+  def self.try_to_extract_frontmatter(doc, text_lines) # rubocop:disable Metrics/MethodLength
+    lines_to_remove = 0
+    frontmatter_lines = ''
+    if /^(-{3,})/.match(text_lines[0])
+      frontmatter_started = false
+      text_lines.each do |s|
+        lines_to_remove += 1
+        if /^(-{3,})/.match(s)
+          if frontmatter_started
+            doc.frontmatter = Frontmatter.new(frontmatter_lines)
+            frontmatter_started = false
+            break
+          else
+            frontmatter_started = true
+          end
+        elsif frontmatter_started
+          frontmatter_lines += s
+        end
+      end
+    end
+    text_lines.shift(lines_to_remove)
+    text_lines
+  end
+
+  def self.parse(doc, text_lines)
+    temp_md_table = nil
+    temp_md_list = nil
+    temp_code_block = nil
+    # restart section numbering for each new document
+    Heading.reset_global_section_number
+    # try to get frontmatter first
+    text_lines = try_to_extract_frontmatter(doc, text_lines)
+    # There is no document without heading
+    title = "#{doc.id}.md"
+    item = Heading.new(doc, title, 0)
+    doc.items.append(item)
+    doc.headings.append(item)
+    doc.title = title
+    # replace dummy title with extracted from frontmatter
+    if doc.frontmatter && (doc.frontmatter.parameters.key? 'title')
+      doc.title = doc.frontmatter.parameters['title']
+      doc.headings[0].text = doc.frontmatter.parameters['title']
+    end
+    # main loop
+    text_lines.each do |s|
+      if s.lstrip != ''
+        if res = /^(\#{1,})\s(.*)/.match(s) # Heading
+
+          temp_md_table = process_temp_table(doc, temp_md_table)
+          if temp_md_list
+            doc.items.append temp_md_list
+            temp_md_list = nil
+          end
+
+          level = res[1].length
+          value = res[2]
+
+          item = Heading.new(doc, value, level)
+          doc.items.append(item)
+          doc.headings.append(item)
+
+        elsif res = /^%\s(.*)/.match(s) # Pandoc Document Title
+
+          title = res[1]
+
+          # Rewrite
+          doc.title = title
+          doc.headings[0].text = title
+
+        elsif res = /^\[(\S*)\]\s+(.*)/.match(s) # Controlled Paragraph
+
+          temp_md_table = process_temp_table(doc, temp_md_table)
+          if temp_md_list
+            doc.items.append temp_md_list
+            temp_md_list = nil
+          end
+
+          id = res[1].upcase
+          text = res[2]
+          up_links = nil
+
+          # check if it contains the uplink (one or many)
+          # TODO: check this regular expression
+          first_pos = text.length # for trailing commas
+          tmp = text.scan(/(>\[(?>[^\[\]]|\g<0>)*\])/) # >[SRS-001], >[SYS-002]
+          if tmp.length > 0
+            up_links = []
+            tmp.each do |ul|
+              lnk = ul[0]
+              # do not add links for the self document
+              doc_id = /([a-zA-Z]+)-\d+/.match(lnk) # SRS
+              up_links << lnk.upcase if doc_id and (doc_id[1].downcase != doc.id.downcase)
+              # try to find the real end of text
+              pos = text.index(lnk)
+              first_pos = pos if pos < first_pos
+              # remove uplink from text
+              text = text.split(lnk, 1).join('')
+            end
+            # remove trailing commas and spaces
+            if text.length > first_pos
+              first_pos -= 1
+              text = text[0..first_pos].strip
+            end
+          end
+
+          # since we already know id and text
+          item = ControlledParagraph.new(doc, text, id)
+
+          if up_links
+            up_links.uniq! # remove duplicates
+            doc.items_with_uplinks_number += 1 # for statistics
+            up_links.each do |ul|
+              next unless tmp = />\[(\S*)\]$/.match(ul) # >[SRS-001]
+
+              up_link_id = tmp[1]
+
+              item.up_link_ids = [] unless item.up_link_ids
+
+              item.up_link_ids.append(up_link_id)
+
+              if tmp = /^([a-zA-Z]+)-\d+/.match(up_link_id) # SRS
+                doc.up_link_docs[tmp[1].downcase.to_s] = tmp[1].downcase # multiple documents could be up-linked
+              end
+            end
+          end
+
+          doc.items.append(item)
+          # for statistics
+          if doc.dictionary.has_key?(id.to_s)
+            doc.duplicated_ids_number += 1
+            doc.duplicates_list.append(item)
+          else
+            doc.dictionary[id.to_s] = item # for fast search
+          end
+          doc.controlled_items.append(item) # for fast search
+
+          # for statistics
+          n = /\d+/.match(id)[0].to_i
+          if n > doc.last_used_id_number
+            doc.last_used_id = id
+            doc.last_used_id_number = n
+          end
+
+        elsif res = /^!\[(.*)\]\((.*)\)/.match(s) # Image
+
+          temp_md_table = process_temp_table(doc, temp_md_table)
+          if temp_md_list
+            doc.items.append temp_md_list
+            temp_md_list = nil
+          end
+
+          img_text = res[1]
+          img_path = res[2]
+
+          item = Image.new(img_text, img_path)
+          item.parent_doc = doc
+          item.parent_heading = doc.headings[-1]
+
+          doc.items.append(item)
+
+        elsif res = /^(\*\s+)(.*)/.match(s) # check if unordered list start
+
+          if doc.title == ''
+            # dummy section if root is not a Document Title (level 0)
+            title = "#{doc.id}.md"
+            item = Heading.new(doc, title, 0)
+            doc.items.append(item)
+            doc.headings.append(item)
+            doc.title = title
+          end
+
+          temp_md_table = process_temp_table(doc, temp_md_table)
+
+          row = res[2]
+
+          if temp_md_list
+            temp_md_list.add_row(s)
+          else
+            item = MarkdownList.new(doc, false)
+            item.add_row(s)
+            temp_md_list = item
+          end
+
+        elsif res = /^\d[.]\s(.*)/.match(s) # check if ordered list start
+
+          temp_md_table = process_temp_table(doc, temp_md_table)
+
+          row = res[1]
+
+          if temp_md_list
+            temp_md_list.add_row(s)
+          else
+            item = MarkdownList.new(doc, true)
+            item.add_row(s)
+            temp_md_list = item
+          end
+
+        elsif s[0] == '|' # check if table
+
+          if doc.title == ''
+            # dummy section if root is not a Document Title (level 0)
+            title = "#{doc.id}.md"
+            item = Heading.new(doc, title, 0)
+            doc.items.append(item)
+            doc.headings.append(item)
+            doc.title = title
+          end
+
+          if temp_md_list
+            doc.items.append temp_md_list
+            temp_md_list = nil
+          end
+
+          if res = /^[|](-{3,})[|]/.match(s) # check if it is a separator first
+
+            if temp_md_table
+              # separator is found after heading
+              temp_md_table.is_separator_detected = true
+            else
+              # separator out of table scope consider it just as a regular paragraph
+              item = Paragraph.new(doc, s)
+              doc.items.append(item)
+            end
+
+          elsif res = /^[|](.*[|])/.match(s) # check if it looks as a table row
+
+            row = res[1]
+
+            if temp_md_table
+              if temp_md_table.is_separator_detected # if there is a separator
+                # check if parent doc is a Protocol
+                if doc.instance_of? Protocol
+                  # check if it is a controlled table
+                  tmp = /(.*)\s+>\[(\S*)\]/.match(row)
+                  if tmp && (temp_md_table.instance_of? MarkdownTable)
+                    # this is not a regular Markdown table
+                    # so the table type shall be changed and this row shall be passed one more time
+                    temp_md_table = ControlledTable.new(doc, temp_md_table)
+                  end
+                end
+                temp_md_table.add_row(row)
+              else
+                # replece table heading with regular paragraph
+                item = Paragraph.new(doc, temp_md_table.heading_row)
+                doc.items.append(item)
+                # and current row
+                item = Paragraph.new(doc, s)
+                doc.items.append(item)
+                temp_md_table = nil
+              end
+            else
+              # start table from heading
+              temp_md_table = MarkdownTable.new(doc, s)
+            end
+          end
+
+        elsif res = /^>(.*)/.match(s) # check if blockquote
+
+          temp_md_table = process_temp_table(doc, temp_md_table)
+
+          if temp_md_list
+            doc.items.append temp_md_list
+            temp_md_list = nil
+          end
+
+          item = Blockquote.new(res[1])
+          item.parent_doc = doc
+          item.parent_heading = doc.headings[-1]
+          doc.items.append(item)
+
+        elsif res = /^```(\w*)/.match(s) # check if code block
+
+          temp_md_table = process_temp_table(doc, temp_md_table)
+          if temp_md_list
+            doc.items.append temp_md_list
+            temp_md_list = nil
+          end
+
+          suggested_format = ''
+          suggested_format = res[1] if res.length == 2
+
+          if temp_code_block
+            # close already opened block
+            doc.items.append(temp_code_block)
+            temp_code_block = nil
+          else
+            # start code block
+            temp_code_block = CodeBlock.new(suggested_format)
+            temp_code_block.parent_doc = doc
+            temp_code_block.parent_heading = doc.headings[-1]
+          end
+
+        elsif res = /^TODO:(.*)/.match(s) # check if TODO block
+
+          temp_md_table = process_temp_table(doc, temp_md_table)
+          if temp_md_list
+            doc.items.append temp_md_list
+            temp_md_list = nil
+          end
+
+          text = '**TODO**: ' + res[1]
+
+          item = TodoBlock.new(text)
+          item.parent_doc = doc
+          item.parent_heading = doc.headings[-1]
+          doc.items.append(item)
+          doc.todo_blocks.append(item)
+
+        else # Reqular Paragraph
+
+          temp_md_table = process_temp_table(doc, temp_md_table)
+          if temp_md_list
+            if MarkdownList.unordered_list_item?(s) || MarkdownList.ordered_list_item?(s)
+              temp_md_list.add_row(s)
+              next
+            else
+              doc.items.append temp_md_list
+              temp_md_list = nil
+            end
+          end
+          if temp_code_block
+            temp_code_block.code_lines.append(s)
+          else
+            item = Paragraph.new(doc, s)
+            doc.items.append(item)
+          end
+        end
+      elsif temp_md_list
+        doc.items.append temp_md_list
+        temp_md_list = nil # lists are separated by emty line from each other
+      end
+    end
+    # Finalize non-closed elements
+    temp_md_table = process_temp_table(doc, temp_md_table)
+    if temp_md_list
+      doc.items.append temp_md_list
+      temp_md_list = nil
+    end
+    if temp_code_block
+      doc.items.append temp_code_block
+      temp_code_block = nil
+    end
+    # Add footer to close opened tables if any
+    item = DocFooter.new
+    item.parent_doc = doc
+    doc.items.append(item)
+  end
+
+  def self.process_temp_table(doc, temp_md_table)
+    if temp_md_table
+      if temp_md_table.is_separator_detected
+        doc.items.append temp_md_table
+      else # no separator
+        # replece table heading with regular paragraph
+        item = Paragraph.new(doc, temp_md_table.heading_row)
+        doc.items.append(item)
+      end
+      temp_md_table = nil
+    end
+    temp_md_table
+  end
+end