Almirah 0.1.6 → 0.1.8

data/lib/almirah/doc_fabric.rb

@@ -1,377 +1,370 @@
-#
-require_relative "doc_types/base_document"
-require_relative "doc_types/specification"
-require_relative "doc_types/protocol"
-#
-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 "dom/document"
+require_relative 'doc_types/base_document'
+require_relative 'doc_types/specification'
+require_relative 'doc_types/protocol'
+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 'dom/document'
 
 class DocFabric
+  @@color_index = 0
+  @@spec_colors = %w[cff4d2 fbeee6 ffcad4 bce6ff e4dfd9 f9e07f cbe54e d3e7ee eab595 86e3c3
+                     ffdca2 ffffff ffdd94 d0e6a5 ffb284 f3dbcf c9bbc8 c6c09c]
 
-    def self.add_lazy_doc_id(path)
-        if res = /(\w+)[.]md$/.match(path)
-            TextLine.add_lazy_doc_id(res[1])
-        end
+  def self.add_lazy_doc_id(path)
+    if res = /(\w+)[.]md$/.match(path)
+      TextLine.add_lazy_doc_id(res[1])
     end
+  end
+
+  def self.create_specification(path)
+    color = @@spec_colors[@@color_index]
+    @@color_index += 1
+    @@color_index = 0 if @@color_index >= @@spec_colors.length
+    doc = Specification.new path
+    DocFabric.parse_document doc
+    doc.color = color
+    doc
+  end
+
+  def self.create_protocol(path)
+    doc = Protocol.new path
+    DocFabric.parse_document doc
+    doc
+  end
+
+  def self.parse_document(doc)
+    temp_md_table = nil
+    temp_md_list = nil
+    temp_code_block = nil
+
+    file = File.open(doc.path)
+    file_lines = file.readlines
+    file.close
+
+    file_lines.each do |s|
+      if s.lstrip != ''
+        if res = /^(\#{1,})\s(.*)/.match(s) # Heading
+
+          if temp_md_table
+            doc.items.append temp_md_table
+            temp_md_table = nil
+          end
+          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
+            level = 0 # Doc Title is a Root
+            Heading.reset_global_section_number
+          end
+
+          item = Heading.new(value, level)
+          item.parent_doc = doc
+          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
+            Heading.reset_global_section_number
+          end
+
+          item = Heading.new(title, 0)
+          item.parent_doc = doc
+          doc.items.append(item)
+          doc.headings.append(item)
+
+          Heading.reset_global_section_number # Pandoc Document Title is not a section, so it shall not be taken into account in numbering
+
+        elsif res = /^\[(\S*)\]\s+(.*)/.match(s) # Controlled Paragraph
+
+          if temp_md_table
+            doc.items.append temp_md_table
+            temp_md_table = nil
+          end
+          if temp_md_list
+            doc.items.append temp_md_list
+            temp_md_list = nil
+          end
+
+          id = res[1]
+          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|
+              up_links.append(ul[0])
+              # try to find the real end of text
+              pos = text.index(ul[0])
+              first_pos = pos if pos < first_pos
+              # remove uplink from text
+              text = text.split(ul[0]).join('')
+            end
+            # remove trailing commas and spaces
+            if text.length > first_pos
+              first_pos -= 1
+              text = text[0..first_pos].strip
+            end
+          end
 
-    def self.create_specification(path)
-        doc = Specification.new path
-        DocFabric.parse_document doc
-        return doc
-    end
+          # since we already know id and text
+          item = ControlledParagraph.new(text, id)
 
-    def self.create_protocol(path)
-        doc = Protocol.new path
-        DocFabric.parse_document doc
-        return doc
-    end
+          if up_links
+            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]
 
-    def self.parse_document(doc)
-
-        tempMdTable = nil
-        tempMdList = nil
-        tempCodeBlock = nil
-
-        file = File.open( doc.path )
-        file_lines = file.readlines     
-        file.close
-
-        file_lines.each do |s|
-            if s.lstrip != ""
-                if res = /^([#]{1,})\s(.*)/.match(s)     # Heading    
-                    
-                    if tempMdTable
-                        doc.items.append tempMdTable
-                        tempMdTable = nil
-                    end
-                    if  tempMdList
-                        doc.items.append tempMdList
-                        tempMdList = nil
-                    end 
-
-                    level = res[1].length
-                    value = res[2]
-
-                    if level == 1 && doc.title == ""
-                        doc.title = value
-                        level = 0 # Doc Title is a Root
-                        Heading.reset_global_section_number()
-                    end 
-
-                    item = Heading.new(value, level)
-                    item.parent_doc = doc
-                    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
-                        Heading.reset_global_section_number()
-                    end 
-
-                    item = Heading.new(title, 0)
-                    item.parent_doc = doc
-                    doc.items.append(item)
-                    doc.headings.append(item)
-
-                    Heading.reset_global_section_number()   # Pandoc Document Title is not a section, so it shall not be taken into account in numbering
-                    
-                elsif res = /^\[(\S*)\]\s+(.*)/.match(s)     # Controlled Paragraph
-
-                    if tempMdTable
-                        doc.items.append tempMdTable
-                        tempMdTable = nil
-                    end
-                    if tempMdList
-                        doc.items.append tempMdList
-                        tempMdList = nil
-                    end 
-
-                    id = res[1]
-                    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 = Array.new
-                        tmp.each do |ul|
-                            up_links.append(ul[0])
-                            # try to find the real end of text
-                            pos = text.index(ul[0])
-                            if pos < first_pos
-                                first_pos = pos
-                            end
-                            # remove uplink from text
-                            text = text.split(ul[0]).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( text, id )
-
-                    if up_links
-                        doc.items_with_uplinks_number += 1     #for statistics
-                        up_links.each do |ul|
-                            if tmp = />\[(\S*)\]$/.match(ul)                    # >[SRS-001]
-                                up_link_id = tmp[1]
-
-                                unless item.up_link_ids
-                                    item.up_link_ids = Array.new
-                                end
-
-                                item.up_link_ids.append(up_link_id)      
-                                    
-                                if tmp = /^([a-zA-Z]+)[-]\d+/.match(up_link_id) # SRS
-                                    doc.up_link_doc_id[ tmp[1].downcase.to_s ] = tmp[1].downcase       # multiple documents could be up-linked                            
-                                end
-                            end
-                        end
-                    end
-
-                    
-                    item.parent_doc = doc
-                    item.parent_heading = doc.headings[-1]
-
-                    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
-
-                    if tempMdTable
-                        doc.items.append tempMdTable
-                        tempMdTable = nil
-                    end
-                    if tempMdList
-                        doc.items.append tempMdList
-                        tempMdList = nil
-                    end
-
-                    img_text = res[1]
-                    img_path = res[2]
-
-                    item = Image.new( img_text, img_path )
-                    item.parent_doc = doc
-
-                    doc.items.append(item)
-
-                elsif res = /^(\*\s+)(.*)/.match(s)   #check if unordered list start
-                    
-                    if tempMdTable
-                        doc.items.append tempMdTable
-                        tempMdTable = nil
-                    end
-
-                    row = res[2]
-
-                    if tempMdList
-                        tempMdList.addRow(s)
-                    else
-                        item = MarkdownList.new(false)
-                        item.addRow(s)
-                        item.parent_doc = doc
-                        tempMdList = item
-                    end
-
-                elsif res = /^\d[.]\s(.*)/.match(s)   #check if ordered list start
-                    
-                    if tempMdTable
-                        doc.items.append tempMdTable
-                        tempMdTable = nil
-                    end
-
-                    row = res[1]
-
-                    if tempMdList
-                        tempMdList.addRow(s)
-                    else
-                        item = MarkdownList.new(true)
-                        item.addRow(s)
-                        item.parent_doc = doc
-                        tempMdList = item
-                    end
-
-                elsif s[0] == '|'   #check if table
-
-                    if tempMdList
-                        doc.items.append tempMdList
-                        tempMdList = nil
-                    end
-
-                    if res = /^[|](-{3,})[|]/.match(s) #check if it is a separator first
-
-                        if tempMdTable 
-                            #separator is found after heading - just skip it
-                        else
-                            #separator out of table scope consider it just as a regular paragraph
-                            item = Paragraph.new(s)
-                            item.parent_doc = doc
-                            doc.items.append(item)
-                        end
-
-                    elsif res = /^[|](.*[|])/.match(s) #check if it looks as a table
-
-                        row = res[1]
-
-                        if tempMdTable
-                            # check if it is a controlled table
-                            unless tempMdTable.addRow(row)
-                                tempMdTable = ControlledTable.new(tempMdTable, doc)
-                                tempMdTable.parent_doc = doc
-                                tempMdTable.addRow(row)
-                            end
-                        else
-                            #start table from heading
-                            tempMdTable = MarkdownTable.new(row)
-                            tempMdTable.parent_doc = doc
-                        end
-                    end
-
-                elsif res = /^[>](.*)/.match(s)   #check if blockquote
-
-                    if tempMdTable
-                        doc.items.append tempMdTable
-                        tempMdTable = nil
-                    end
-                    if tempMdList
-                        doc.items.append tempMdList
-                        tempMdList = nil
-                    end 
-
-                    item = Blockquote.new(res[1])
-                    item.parent_doc = doc
-                    doc.items.append(item)
-
-                elsif res = /^```(\w*)/.match(s)   #check if code block
-
-                    if tempMdTable
-                        doc.items.append tempMdTable
-                        tempMdTable = nil
-                    end
-                    if tempMdList
-                        doc.items.append tempMdList
-                        tempMdList = nil
-                    end 
-
-                    suggested_format = ""
-                    if res.length == 2
-                        suggested_format = res[1]
-                    end
-
-                    if tempCodeBlock
-                        # close already opened block
-                        doc.items.append(tempCodeBlock)
-                        tempCodeBlock = nil
-                    else
-                        #start code block
-                        tempCodeBlock = CodeBlock.new(suggested_format)
-                        tempCodeBlock.parent_doc = doc
-                    end
-                
-                elsif res = /^TODO\:(.*)/.match(s)   #check if TODO block
-
-                    if tempMdTable
-                        doc.items.append tempMdTable
-                        tempMdTable = nil
-                    end
-                    if tempMdList
-                        doc.items.append tempMdList
-                        tempMdList = nil
-                    end 
-
-                    text = "**TODO**: " + res[1]
-
-                    item = TodoBlock.new(text)
-                    item.parent_doc = doc
-                    doc.items.append(item)
-                    doc.todo_blocks.append(item)
-
-                else # Reqular Paragraph
-                    if tempMdTable
-                        doc.items.append tempMdTable
-                        tempMdTable = nil
-                    end
-                    if tempMdList
-                        if MarkdownList.unordered_list_item?(s) || MarkdownList.ordered_list_item?(s)
-                            tempMdList.addRow(s)
-                            next
-                        else
-                            doc.items.append tempMdList
-                            tempMdList = nil
-                        end
-                    end
-                    if tempCodeBlock
-                        tempCodeBlock.code_lines.append(s)
-                    else
-                        item = Paragraph.new(s)
-                        item.parent_doc = doc
-                        doc.items.append(item)
-                    end
-                end
+              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_doc_id[tmp[1].downcase.to_s] = tmp[1].downcase # multiple documents could be up-linked
+              end
+            end
+          end
+
+          item.parent_doc = doc
+          item.parent_heading = doc.headings[-1]
+
+          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
+
+          if temp_md_table
+            doc.items.append temp_md_table
+            temp_md_table = nil
+          end
+          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
+
+          doc.items.append(item)
+
+        elsif res = /^(\*\s+)(.*)/.match(s)   # check if unordered list start
+
+          if temp_md_table
+            doc.items.append temp_md_table
+            temp_md_table = nil
+          end
+
+          row = res[2]
+
+          if temp_md_list
+            temp_md_list.addRow(s)
+          else
+            item = MarkdownList.new(false)
+            item.addRow(s)
+            item.parent_doc = doc
+            temp_md_list = item
+          end
+
+        elsif res = /^\d[.]\s(.*)/.match(s)   # check if ordered list start
+
+          if temp_md_table
+            doc.items.append temp_md_table
+            temp_md_table = nil
+          end
+
+          row = res[1]
+
+          if temp_md_list
+            temp_md_list.addRow(s)
+          else
+            item = MarkdownList.new(true)
+            item.addRow(s)
+            item.parent_doc = doc
+            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 - just skip it
             else
-                if tempMdList   # lists are separated by emty line from each other
-                    doc.items.append tempMdList
-                    tempMdList = nil
-                end
+              # separator out of table scope consider it just as a regular paragraph
+              item = Paragraph.new(s)
+              item.parent_doc = doc
+              doc.items.append(item)
             end
+
+          elsif res = /^[|](.*[|])/.match(s) # check if it looks as a table
+
+            row = res[1]
+
+            if temp_md_table
+              # check if it is a controlled table
+              unless temp_md_table.addRow(row)
+                temp_md_table = ControlledTable.new(temp_md_table, doc)
+                temp_md_table.parent_doc = doc
+                temp_md_table.addRow(row)
+              end
+            else
+              # start table from heading
+              temp_md_table = MarkdownTable.new(row)
+              temp_md_table.parent_doc = doc
+            end
+          end
+
+        elsif res = /^>(.*)/.match(s) # check if blockquote
+
+          if temp_md_table
+            doc.items.append temp_md_table
+            temp_md_table = nil
+          end
+          if temp_md_list
+            doc.items.append temp_md_list
+            temp_md_list = nil
+          end
+
+          item = Blockquote.new(res[1])
+          item.parent_doc = doc
+          doc.items.append(item)
+
+        elsif res = /^```(\w*)/.match(s) # check if code block
+
+          if temp_md_table
+            doc.items.append temp_md_table
+            temp_md_table = nil
+          end
+          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
+
+          if temp_md_table
+            doc.items.append temp_md_table
+            temp_md_table = nil
+          end
+          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
+          doc.items.append(item)
+          doc.todo_blocks.append(item)
+
+        else # Reqular Paragraph
+          if temp_md_table
+            doc.items.append temp_md_table
+            temp_md_table = nil
+          end
+          if temp_md_list
+            if MarkdownList.unordered_list_item?(s) || MarkdownList.ordered_list_item?(s)
+              temp_md_list.addRow(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(s)
+            item.parent_doc = doc
+            doc.items.append(item)
+          end
         end
-        # Finalize non-closed elements
-        if tempMdTable
-            doc.items.append tempMdTable
-            tempMdTable = nil
-        end
-        if tempMdList
-            doc.items.append tempMdList
-            tempMdList = nil
-        end
-        if tempCodeBlock
-            doc.items.append tempCodeBlock
-            tempCodeBlock = nil
-        end
-        # Add footer to close opened tables if any
-        item = DocFooter.new
-        item.parent_doc = doc
-        doc.items.append(item)
-        # Build dom
-        if doc.is_a?(Specification)
-            doc.dom = Document.new(doc.headings)
-        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
+    if temp_md_table
+      doc.items.append temp_md_table
+      temp_md_table = nil
+    end
+    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
-end
+    # Add footer to close opened tables if any
+    item = DocFooter.new
+    item.parent_doc = doc
+    doc.items.append(item)
+    # Build dom
+    doc.dom = Document.new(doc.headings) if doc.is_a?(Specification)
+  end
+end