Almirah 0.1.9 → 0.2.1

data/lib/almirah/doc_parser.rb

@@ -0,0 +1,334 @@
+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
+
+          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
+          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
+
+          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].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
+
+          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
+          item.parent_heading = doc.headings[-1]
+
+          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(doc, false)
+            item.addRow(s)
+            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(doc, true)
+            item.addRow(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 - just skip it
+            else
+              # separator out of table scope consider it just as a regular paragraph
+              item = Paragraph.new(s)
+              item.parent_doc = doc
+              item.parent_heading = doc.headings[-1]
+              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
+          item.parent_heading = doc.headings[-1]
+          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
+          item.parent_heading = doc.headings[-1]
+          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
+            item.parent_heading = doc.headings[-1]
+            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
+    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
+    # Add footer to close opened tables if any
+    item = DocFooter.new
+    item.parent_doc = doc
+    doc.items.append(item)
+  end
+end

data/lib/almirah/doc_types/base_document.rb

@@ -1,16 +1,11 @@
 
 class BaseDocument
 
-    attr_accessor :path
-    attr_accessor :items
-    attr_accessor :headings
     attr_accessor :title
     attr_accessor :id
     attr_accessor :dom
 
-    def initialize(fele_path)
-
-        @path = fele_path
+    def initialize()
         @items = Array.new
         @headings = Array.new
         @title = ""
@@ -44,6 +39,27 @@ class BaseDocument
                 end
             elsif s.include?('{{DOCUMENT_TITLE}}')
                 file.puts s.gsub! '{{DOCUMENT_TITLE}}', @title
+            elsif s.include?('{{STYLES_AND_SCRIPTS}}')
+                if @id == 'index'
+                    file.puts '<script type="module" src="./scripts/orama_search.js"></script>'
+                    file.puts '<link rel="stylesheet" href="./css/search.css">'
+                    file.puts '<link rel="stylesheet" href="./css/main.css">'
+                    file.puts '<script src="./scripts/main.js"></script>'
+                elsif self.instance_of? Specification
+                    file.puts '<link rel="stylesheet" href="../../css/main.css">'
+                    file.puts '<script src="../../scripts/main.js"></script>'
+                elsif self.instance_of? Traceability
+                    file.puts '<link rel="stylesheet" href="../../css/main.css">'
+                    file.puts '<script src="../../scripts/main.js"></script>'
+                elsif self.instance_of? Coverage
+                    file.puts '<link rel="stylesheet" href="../../css/main.css">'
+                    file.puts '<script src="../../scripts/main.js"></script>'
+                elsif self.instance_of? Protocol
+                    file.puts '<link rel="stylesheet" href="../../../css/main.css">'
+                    file.puts '<script src="../../../scripts/main.js"></script>'
+                end
+            elsif  s.include?('{{GEM_VERSION}}')
+                file.puts "(" + Gem.loaded_specs['Almirah'].version.version + ")"
             else
                 file.puts s
             end

data/lib/almirah/doc_types/coverage.rb

@@ -4,16 +4,12 @@ class Coverage < BaseDocument
 
     attr_accessor :top_doc
     attr_accessor :bottom_doc
-    attr_accessor :items
 
     def initialize(top_doc)
-
+        super()
         @top_doc = top_doc
         @bottom_doc = bottom_doc
 
-        @items = Array.new
-        @headings = Array.new
-
         @id = top_doc.id + "-" + "tests"
         @title = "Coverage Matrix: " + @id
     end

data/lib/almirah/doc_types/index.rb

@@ -2,13 +2,11 @@ require_relative "base_document"
 
 class Index < BaseDocument
 
-    attr_accessor :items
     attr_accessor :project
 
     def initialize(project)
-        @items = Array.new
+        super()
         @project = project
-
         @title = "Document Index"
         @id = "index"
     end

data/lib/almirah/doc_types/persistent_document.rb

@@ -0,0 +1,20 @@
+require_relative "base_document"
+
+class PersistentDocument < BaseDocument
+
+    attr_accessor :path
+    attr_accessor :items
+    attr_accessor :controlled_items
+    attr_accessor :headings
+    attr_accessor :up_link_docs
+
+    def initialize(fele_path)
+        super()
+        @path = fele_path
+        @items = []
+        @controlled_items = []
+        @headings = []
+        @up_link_docs = {}
+    end
+
+end

data/lib/almirah/doc_types/protocol.rb

@@ -1,22 +1,10 @@
-require_relative "base_document"
+require_relative "persistent_document"
 
-class Protocol < BaseDocument
-
-    attr_accessor :up_link_doc_id
-    #attr_accessor :dictionary
-    attr_accessor :controlled_items
+class Protocol < PersistentDocument
 
     def initialize(fele_path)
-
-        @path = fele_path
-        @title = ""
-        @items = Array.new
-        @headings = Array.new
-        @controlled_items = Array.new
-        #@dictionary = Hash.new
-
+        super
         @id = File.basename(fele_path, File.extname(fele_path)).downcase
-        @up_link_doc_id = Hash.new
     end
 
     def to_html(nav_pane, output_file_path)

data/lib/almirah/doc_types/specification.rb

@@ -1,10 +1,8 @@
-require_relative "base_document"
+require_relative "persistent_document"
 
-class Specification < BaseDocument
+class Specification < PersistentDocument
 
-    attr_accessor :up_link_doc_id
     attr_accessor :dictionary
-    attr_accessor :controlled_items
     attr_accessor :todo_blocks
     attr_accessor :wrong_links_hash
 
@@ -18,12 +16,7 @@ class Specification < BaseDocument
     attr_accessor :color
 
     def initialize(fele_path)
-
-        @path = fele_path
-        @title = ""
-        @items = Array.new
-        @headings = Array.new
-        @controlled_items = Array.new
+        super
         @dictionary = Hash.new
         @duplicates_list = Array.new
         @todo_blocks = Array.new
@@ -39,7 +32,6 @@ class Specification < BaseDocument
         @color = 'bbb'
 
         @id = File.basename(fele_path, File.extname(fele_path)).downcase
-        @up_link_doc_id = Hash.new
     end
 
     def to_console

data/lib/almirah/doc_types/traceability.rb

@@ -9,15 +9,12 @@ class Traceability < BaseDocument
     attr_accessor :traced_items
 
     def initialize(top_doc, bottom_doc, is_agregated)
-
+        super()
         @top_doc = top_doc
         @bottom_doc = bottom_doc
         @is_agregated = is_agregated
         @traced_items = {}
 
-        @items = Array.new
-        @headings = Array.new
-
         if @is_agregated 
             @id = top_doc.id + "-all"
         else

data/lib/almirah/dom/document.rb

@@ -49,7 +49,7 @@ class Document
 
     def section_tree_to_html
         s = ''
-        s += "<a href=\"\#" + @root_section.heading.anchor_id.to_s + "\">" + @root_section.heading.text + "</a>\n"
+        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|