Almirah 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 239bc6813a8ad20ae8cf8a99d5a36968acf8679965c123ace4f981082f08813f
-  data.tar.gz: bfe821957ccd6adebf87f21052fe1b3cb8bdffe3761c68be8dfb9bd619fc9605
+  metadata.gz: da8737eaa32966b6559639becfd0737c25394340b1f32cc682a1063a78205190
+  data.tar.gz: 40914f94ceda02630a170c04965d65a83a5073db6d5aa32eb678caaf2823ee96
 SHA512:
-  metadata.gz: e633985b182351caa581c6dc8e0133b78a98bd56ade57f8ab152d1bf8442e161775d4c7a161a8421c32e272edab1d9798fe5d5157ba558c6b267d5a503e25fa2
-  data.tar.gz: 72cfef9d334a4522b9fa3dea553ace439299a62dae4ba79dba7db5b284164f33d41280ecea602945068e01ce183ceac4591e408026400ec2bbbbc31ec3648c64
+  metadata.gz: a3f545f59badec9c749b0b9104eb9a2ae7737bd47f2c36a1c5d2b743df8a6931654500b798b6309b3a96368b926d64e8dd52f4faae4fd83affe453a861cbad9e
+  data.tar.gz: eeb982a3da8bbba0dadf6832fc9491d334e31b06aaf8749921e8a4bb0dc6fa9b94a8a249b05c883f3a288b242550be46342a9bccdec11b809910caaa5644930c

data/lib/almirah/doc_fabric.rb

@@ -1,20 +1,7 @@
 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 'doc_parser'
 require_relative 'dom/document'
 
 class DocFabric
@@ -45,332 +32,15 @@ class DocFabric
   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
-
-          # 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|
-              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_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
-          item.parent_heading = doc.headings[-1]
-
-          doc.items.append(item)
-
-        elsif res = /^(\*\s+)(.*)/.match(s)   # check if unordered list start
+    DocParser.parse(doc, file_lines)
 
-          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
-            item.parent_heading = doc.headings[-1]
-            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)
     # Build dom
     doc.dom = Document.new(doc.headings) if doc.is_a?(Specification)
+    
   end
 end

data/lib/almirah/doc_items/controlled_paragraph.rb

@@ -7,7 +7,9 @@ class ControlledParagraph < Paragraph
     attr_accessor :down_links
     attr_accessor :coverage_links
 
-    def initialize(text, id)
+    def initialize(doc, text, id)
+        @parent_doc = doc
+        @parent_heading = doc.headings[-1]
         @text = text.strip
         @id = id
         @up_link_ids = nil

data/lib/almirah/doc_items/controlled_table.rb

@@ -129,7 +129,7 @@ class ControlledTable < DocItem
                 # save uplink key but do not rewrite
                 if col.up_link_doc_id != nil 
                     
-                    @parent_doc.up_link_doc_id[ col.up_link_doc_id.to_s ] = col.up_link_doc_id
+                    @parent_doc.up_link_docs[ col.up_link_doc_id.to_s ] = col.up_link_doc_id
 
                     # save reference to the test step
                     new_row.up_link = col.up_link

data/lib/almirah/doc_items/heading.rb

@@ -8,7 +8,8 @@ class Heading < Paragraph
 
     @@global_section_number = ""
 
-    def initialize(text, level)
+    def initialize(doc, text, level)
+        @parent_doc = doc
         @text = text
         @level = level
 
@@ -51,7 +52,11 @@ class Heading < Paragraph
     end
 
     def get_section_info
-        s = @section_number + " " + @text
+        if level == 0 # Doc Title
+            s = @text
+        else
+            s = @section_number + " " + @text
+        end
     end
 
     def get_anchor_text()

data/lib/almirah/doc_items/markdown_list.rb

@@ -10,7 +10,10 @@ class MarkdownList < DocItem
 
     @@lists_stack = Array.new
 
-    def initialize(is_ordered)
+    def initialize(doc, is_ordered)
+        @parent_doc = doc
+        @parent_heading = doc.headings[-1]
+
         @rows = Array.new
         @is_ordered = is_ordered
         @current_nesting_level = 0
@@ -30,7 +33,7 @@ class MarkdownList < DocItem
 
             prev_lists_stack_item = @@lists_stack[-1]
             # the following line pushes new list to the lists_stack in the constructor!
-            nested_list = MarkdownList.new( MarkdownList.ordered_list_item?(raw_text) )
+            nested_list = MarkdownList.new( @parent_doc, MarkdownList.ordered_list_item?(raw_text) )
             nested_list.current_nesting_level = @current_nesting_level + 1
             nested_list.indent_position = pos
             

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 = ""

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|

data/lib/almirah/project.rb

@@ -149,7 +149,7 @@ class Project
     def link_all_protocols
         @protocols.each do |p|
             @specifications.each do |s|
-                if p.up_link_doc_id.has_key?(s.id.to_s)
+                if p.up_link_docs.has_key?(s.id.to_s)
                     link_protocol_to_spec(p,s)
                 end
             end
@@ -165,7 +165,7 @@ class Project
         end
 
         @specifications.each do |s|
-            s.up_link_doc_id.each do |key, value|
+            s.up_link_docs.each do |key, value|
                 unless available_specification_ids.has_key?(key)
                     # now key points to the doc_id that does not exist
                     wrong_doc_id = key
@@ -189,10 +189,10 @@ class Project
 
     def link_two_specifications(doc_A, doc_B)
 
-        if doc_B.up_link_doc_id.has_key?(doc_A.id.to_s)
+        if doc_B.up_link_docs.has_key?(doc_A.id.to_s)
             top_document = doc_A
             bottom_document = doc_B
-        elsif doc_A.up_link_doc_id.has_key?(doc_B.id.to_s)
+        elsif doc_A.up_link_docs.has_key?(doc_B.id.to_s)
             top_document = doc_B
             bottom_document = doc_A
         else

data/lib/almirah/search/specifications_db.rb

@@ -21,12 +21,41 @@ class SpecificationsDb
                         "heading_url" => i.parent_heading.get_url(), \
                         "heading_text" => i.parent_heading.get_section_info()
                     }
-                    @data.append e
+                    @data.append e                    
+                elsif i.instance_of? MarkdownList
+                    e = add_markdown_list_item_to_db( @data, i, i)    
                 end
             end
         end
     end
 
+    def add_markdown_list_item_to_db(data, item_for_reference, item_to_process)
+        e = nil
+        item_to_process.rows.each do |r|
+            if r.is_a?(MarkdownList)
+                f_text = r.text
+                e = {   "document" => item_for_reference.parent_doc.title, \
+                        "doc_color" => item_for_reference.parent_doc.color, \
+                        "text" => f_text, \
+                        "heading_url" => item_for_reference.parent_heading.get_url(), \
+                        "heading_text" => item_for_reference.parent_heading.get_section_info()
+                    }
+                data << e
+                add_markdown_list_item_to_db(data, item_for_reference, r)
+            else
+                f_text = r
+                e = {   "document" => item_for_reference.parent_doc.title, \
+                        "doc_color" => item_for_reference.parent_doc.color, \
+                        "text" => f_text, \
+                        "heading_url" => item_for_reference.parent_heading.get_url(), \
+                        "heading_text" => item_for_reference.parent_heading.get_section_info()
+                    }
+                data << e
+            end
+        end
+        return e
+    end
+
     def save(path)
         json = JSON.generate(@data)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: Almirah
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Oleksandr Ivanov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-04 00:00:00.000000000 Z
+date: 2024-06-09 00:00:00.000000000 Z
 dependencies: []
 description: The software part of the Almirah framework
 email: oleksandr.ivanov.development@gmail.com
@@ -34,9 +34,11 @@ files:
 - lib/almirah/doc_items/paragraph.rb
 - lib/almirah/doc_items/text_line.rb
 - lib/almirah/doc_items/todo_block.rb
+- lib/almirah/doc_parser.rb
 - lib/almirah/doc_types/base_document.rb
 - lib/almirah/doc_types/coverage.rb
 - lib/almirah/doc_types/index.rb
+- lib/almirah/doc_types/persistent_document.rb
 - lib/almirah/doc_types/protocol.rb
 - lib/almirah/doc_types/specification.rb
 - lib/almirah/doc_types/traceability.rb