Almirah 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3ac78a8239af2167c9f9e90c66fe8693a51d8909282757710e45b8a0375aba5
-  data.tar.gz: 544347bbb28b9e7b288f3c9b37e93c487bc6fd0ac863fcfa7c12fb2cc36d0bc7
+  metadata.gz: 877a4c7b296af5fa0418113a4287df82661d23903764f73a74b8794d2be22d9a
+  data.tar.gz: 4195b1434e0ca4c75177c4af9ea3e97ffa9a373106bda58fa11621ba273df7cf
 SHA512:
-  metadata.gz: d0170e32eac2109e8559413261c43a230730da8dc4add50342a807e3a054e57c8f5950e83cce4bdaded5b317697da863c82e13bd13cc0250887336d2ed2de77a
-  data.tar.gz: 8388732d6f4fd9d4b4e796470d1ce153a635484cf1d9400d48a3eb3f1d2146d70c8be649bac7927832a29990c6745b0dcc9e4ca247c00b6a5e5c5546d68228a0
+  metadata.gz: 4425611cadee99f5686c79abbc853d93bbfeb0e729a97168f93842d998daf8e1a879de8e25918fcbd01bd49abe2b842cc192f24d137cd987d77816f606abed15
+  data.tar.gz: ca609c497ebde13428c516a0369f860c323f7bcaba740424d125b9a3c4bd2e1955f8f8aec665d6afd088cc44772c4edfaba5dc64f47827be631253111f82a446

data/lib/almirah/doc_fabric.rb

@@ -0,0 +1,200 @@
+#
+require_relative "doc_types/base_document"
+require_relative "doc_types/specification"
+require_relative "doc_types/protocol"
+#
+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/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"
+
+class DocFabric
+
+    def self.create_specification(path)
+        doc = Specification.new path
+        DocFabric.parse_document doc
+        return doc
+    end
+
+    def self.create_protocol(path)
+        doc = Protocol.new path
+        DocFabric.parse_document doc
+        return doc
+    end
+
+    def self.parse_document(doc)
+
+        tempMdTable = nil
+        tempMdList = 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]
+                    item = Heading.new(value, level)
+                    doc.items.append(item)
+                    doc.headings.append(item)
+
+                    if level == 1 && doc.title == ""
+                        doc.title = value
+                    end   
+                        
+                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]
+
+                    #check if it contains the uplink
+                    if tmp = /(.*)\s+>\[(\S*)\]$/.match(text)           # >[SRS-001]
+
+                        text = tmp[1]
+                        up_link = tmp[2]
+                        
+                        if tmp = /^([a-zA-Z]+)[-]\d+/.match(up_link)    # SRS
+                            doc.up_link_doc_id = tmp[1].downcase
+                        end
+                    end
+
+                    item = ControlledParagraph.new( text, id )
+                    item.up_link = up_link
+
+                    doc.items.append(item)
+                    doc.dictionary[ id.to_s ] = item       #for fast search
+                    doc.controlled_items.append(item)      #for fast search
+
+                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 )
+
+                    doc.items.append(item)
+
+                elsif res = /^(\*\s?)+(.*)/.match(s)   #check if bullet list
+                    
+                    if tempMdTable
+                        doc.items.append tempMdTable
+                        tempMdTable = nil
+                    end
+
+                    row = res[2]
+
+                    if tempMdList
+                        tempMdList.addRow(row)
+                    else
+                        item = MarkdownList.new(row)
+                        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)
+                            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.addRow(row)
+                            end
+                        else
+                            #start table from heading
+                            tempMdTable = MarkdownTable.new(row)
+                        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])
+                    doc.items.append(item)
+
+                else # Reqular Paragraph
+                    if tempMdTable
+                        doc.items.append tempMdTable
+                        tempMdTable = nil
+                    end
+                    if tempMdList
+                        doc.items.append tempMdList
+                        tempMdList = nil
+                    end
+
+                    item = Paragraph.new(s)
+                    doc.items.append(item)
+                end
+            end
+        end
+        # Finalize non-closed elements
+        if tempMdTable
+            doc.items.append tempMdTable
+            tempMdTable = nil
+        end
+        if tempMdList
+            doc.items.append tempMdList
+            tempMdList = nil
+        end
+    end
+end

data/lib/almirah/doc_items/blockquote.rb

@@ -11,11 +11,11 @@ class Blockquote < DocItem
     def to_html
         s = ''
         if @@htmlTableRenderInProgress
-            s += "</table>\n\r"
+            s += "</table>\n"
             @@htmlTableRenderInProgress = false
         end
 
-        s += "<div class=\"blockquote\"><p>#{@text}</div>\n\r"
+        s += "<div class=\"blockquote\"><p>#{@text}</div>\n"
         return s
     end
 end

data/lib/almirah/doc_items/controlled_paragraph.rb

@@ -5,47 +5,54 @@ class ControlledParagraph < Paragraph
     attr_accessor :id
     attr_accessor :up_link
     attr_accessor :down_links
+    attr_accessor :coverage_links
 
     def initialize(text, id)
         @text = text
         @id = id
         @up_link = nil
         @down_links = nil
+        @coverage_links = nil
     end
 
     def to_html
         s = ''
         unless @@htmlTableRenderInProgress                    
-            s += "<table class=\"controlled\">\n\r"
-            s += "\t<thead> <th>#</th> <th>Text</th> <th>UL</th> <th>DL</th> <th>COV</th> </thead>\n\r"
+            s += "<table class=\"controlled\">\n"
+            s += "\t<thead> <th>#</th> <th>Text</th> <th>UL</th> <th>DL</th> <th>COV</th> </thead>\n"
             @@htmlTableRenderInProgress = true
         end
-        s += "\t<tr>\n\r"
-        s += "\t\t<td class=\"item_id\"> <a name=\"#{@id}\"></a>#{@id} </td>\n\r"
-        s += "\t\t<td class=\"item_text\">#{@text}</td>\n\r"
+        s += "\t<tr>\n"
+        s += "\t\t<td class=\"item_id\"> <a name=\"#{@id}\"></a>#{@id} </td>\n"
+        s += "\t\t<td class=\"item_text\">#{@text}</td>\n"
 
         if @up_link
             if tmp = /^([a-zA-Z]+)[-]\d+/.match(@up_link)
                 up_link_doc_name = tmp[1].downcase
             end
-            s += "\t\t<td class=\"item_id\"><a href=\"./../#{up_link_doc_name}/#{up_link_doc_name}.html\" class=\"external\">#{@up_link}</a></td>\n\r"
+            s += "\t\t<td class=\"item_id\"><a href=\"./../#{up_link_doc_name}/#{up_link_doc_name}.html\" class=\"external\">#{@up_link}</a></td>\n"
         else
-            s += "\t\t<td class=\"item_id\"></td>\n\r"
+            s += "\t\t<td class=\"item_id\"></td>\n"
         end
 
         if @down_links
             if tmp = /^([a-zA-Z]+)[-]\d+/.match(@down_links[0].id)    # guessing that all the links refer to one document
                 down_link_doc_name = tmp[1].downcase
             end
-            s += "\t\t<td class=\"item_id\"><a href=\"./../#{down_link_doc_name}/#{down_link_doc_name}.html\" class=\"external\">#{@down_links.length}</a></td>\n\r"
+            s += "\t\t<td class=\"item_id\"><a href=\"./../#{down_link_doc_name}/#{down_link_doc_name}.html\" class=\"external\">#{@down_links.length}</a></td>\n"
         else
-            s += "\t\t<td class=\"item_id\"></td>\n\r"
+            s += "\t\t<td class=\"item_id\"></td>\n"
         end
 
-        #s += "\t\t<td></td>\n\r"    # UL
-        #s += "\t\t<td></td>\n\r"    # DL
-        s += "\t\t<td class=\"item_id\"></td>\n\r"    # COV
-        s += "\t</tr>\n\r"
+        if @coverage_links
+            if tmp = /^(.+)[.]\d+/.match(@coverage_links[0].id)    # guessing that all the links refer to one document
+                cov_link_doc_name = tmp[1].downcase
+            end
+            s += "\t\t<td class=\"item_id\"><a href=\"./../../tests/protocols/#{cov_link_doc_name}/#{cov_link_doc_name}.html\" class=\"external\">#{@coverage_links.length}</a></td>\n"
+        else
+            s += "\t\t<td class=\"item_id\"></td>\n"
+        end
+        s += "\t</tr>\n"
         return s
     end 
 

data/lib/almirah/doc_items/controlled_table.rb

@@ -0,0 +1,172 @@
+require_relative "controlled_table_row"
+
+
+class ControlledTableColumn
+
+    attr_accessor :text
+    
+    def initialize(text)
+        @text = text.strip
+    end
+
+    def to_html
+        "\t\t<td>#{@text}</td>\n\r"
+    end
+end
+
+
+class RegualrColumn < ControlledTableColumn
+
+end
+
+
+class TestStepNumberColumn < ControlledTableColumn
+
+    attr_accessor :step_number
+    
+    def initialize(text)
+        text = text.strip
+        @step_number = text.to_i
+        @text =  text
+    end
+
+    def to_html
+        "\t\t<td style=\"text-align: center;\">#{@text}</td>\n\r"
+    end
+end 
+
+
+class TestStepResultColumn <  ControlledTableColumn
+
+    def to_html
+        if @text.downcase == "pass"
+            "\t\t<td style=\"background-color: #cfc;\">#{@text}</td>\n\r"
+        elsif @text.downcase == "fail"
+            "\t\t<td style=\"background-color: #fcc;\">#{@text}</td>\n\r"
+        else
+            "\t\t<td>#{@text}</td>\n\r"
+        end
+    end
+end
+
+
+class TestStepReferenceColumn <  ControlledTableColumn
+
+    attr_accessor :up_link
+    attr_accessor :up_link_doc_id
+
+    def initialize(text)
+        
+        @up_link = nil
+        @up_link_doc_id = nil
+
+        if tmp = />\[(\S*)\]/.match(text)   # >[SRS-001]
+            @up_link = tmp[1]
+            if tmp = /^([a-zA-Z]+)[-]\d+/.match(@up_link)   # SRS
+                @up_link_doc_id = tmp[1].downcase 
+            end
+        end
+    end
+
+    def to_html
+        if @up_link
+            "\t\t<td class=\"item_id\"><a href=\"./../../../specifications/#{@up_link_doc_id}/#{@up_link_doc_id}.html\" class=\"external\">#{@up_link}</a></td>\n\r"
+        else
+            "\t\t<td style=\"text-align: center;\"></td>\n\r"
+        end
+    end
+    
+end
+
+
+class ControlledTable < DocItem
+
+    attr_accessor :column_names
+    attr_accessor :rows
+    attr_accessor :parent_doc
+
+    def initialize(markdown_table, parent_doc)
+        @parent_doc = parent_doc
+        @column_names = markdown_table.column_names
+        # copy and re-format existing rows
+        @rows = Array.new
+
+        markdown_table.rows.each do |r|
+            @rows.append(format_columns(r))
+        end  
+    end
+
+    def addRow(row)
+
+        columns = row.split('|')
+
+        @rows.append(format_columns(columns))
+
+        return true
+    end
+
+    def format_columns(columns)
+
+        new_row = ControlledTableRow.new
+
+        columns.each_with_index do | element, index |
+
+            if index == 0 # it is expected that test step id is placed in the first columl
+                
+                col = TestStepNumberColumn.new element
+                new_row.columns.append col
+                new_row.id = @parent_doc.id + '.' + col.text
+
+            elsif index + 1 == columns.length # it is expected that a link is placed to the last column only
+                
+                col = TestStepReferenceColumn.new element
+                new_row.columns.append col
+                # save uplink key but do not rewrite
+                if col.up_link_doc_id != nil 
+                    if @parent_doc.up_link_doc_id == ""
+                        @parent_doc.up_link_doc_id = col.up_link_doc_id
+                    end
+                    # save reference to the test step
+                    new_row.up_link = col.up_link
+                    @parent_doc.controlled_items.append new_row
+                end               
+
+            elsif index + 2 == columns.length # it is expected that test step result is placed to the pre-last column only
+                
+                col = TestStepResultColumn.new element
+                new_row.columns.append col
+
+            else
+                col = RegualrColumn.new element
+                new_row.columns.append col
+            end             
+        end
+        return new_row
+    end
+
+    def to_html
+        s = ''
+        if @@htmlTableRenderInProgress
+            s += "</table>\n"
+            @@htmlTableRenderInProgress = false
+        end
+                   
+        s += "<table class=\"markdown_table\">\n"
+        s += "\t<thead>" 
+
+        @column_names.each do |h|
+            s += " <th>#{h}</th>"
+        end
+
+        s += " </thead>\n"
+
+        @rows.each do |row|
+            s += row.to_html
+        end
+
+        s += "</table>\n"
+
+        return s
+    end
+
+end

data/lib/almirah/doc_items/controlled_table_row.rb

@@ -0,0 +1,23 @@
+require_relative "doc_item"
+
+class ControlledTableRow < DocItem
+
+    attr_accessor :id
+    attr_accessor :up_link
+    attr_accessor :columns
+    
+    def initialize
+        @id = ""
+        @up_link = ""
+        @columns = Array.new
+    end
+
+    def to_html
+        s = ""
+        s += "\t<tr>\n"
+        @columns.each do |col|
+            s += col.to_html    # "\t\t<td>#{col}</td>\n\r"
+        end
+        s += "\t</tr>\n"
+    end
+end

data/lib/almirah/doc_items/heading.rb

@@ -14,11 +14,11 @@ class Heading < Paragraph
     def to_html
         s = ''
         if @@htmlTableRenderInProgress
-            s += "</table>"
+            s += "</table>\n"
             @@htmlTableRenderInProgress = false
         end
         headingLevel = level.to_s 
-        s += "<a name=\"#{@anchor_id}\"></a>\n\r"
+        s += "<a name=\"#{@anchor_id}\"></a>\n"
         s += "<h#{headingLevel}> #{@text} <a href=\"\##{@anchor_id}\" class=\"heading_anchor\">"
         s += "&para;</a></h#{headingLevel}>"
         return s

data/lib/almirah/doc_items/image.rb

@@ -17,7 +17,7 @@ class Image < DocItem
     def to_html
         s = ''
         if @@htmlTableRenderInProgress
-            s += "</table>\n\r"
+            s += "</table>\n"
             @@htmlTableRenderInProgress = false
         end
 

data/lib/almirah/doc_items/markdown_list.rb

@@ -16,15 +16,15 @@ class MarkdownList < DocItem
     def to_html
         s = ''
         if @@htmlTableRenderInProgress
-            s += "</table>/n/r"
+            s += "</table>\n"
             @@htmlTableRenderInProgress = false
         end
 
-        s += "<ul>\n\r"
+        s += "<ul>\n"
         @rows.each do |r|
-            s += "\t<li>#{r}</li>\n\r"
+            s += "\t<li>#{r}</li>\n"
         end
-        s += "</ul>\n\r"
+        s += "</ul>\n"
 
         return s
     end

data/lib/almirah/doc_items/markdown_table.rb

@@ -11,35 +11,46 @@ class MarkdownTable < DocItem
     end
 
     def addRow(row)
+        #check if row contains a link
+        if tmp = /(.*)\s+>\[(\S*)\]/.match(row)
+            return false # this is not a regular Markdown table.
+            # so the table type shall be changed and this row shall be passed one more time
+        end
+
         columns = row.split('|')
-        @rows.append(columns)
+        @rows.append(columns.map!{ |x| x.strip })
+        return true
     end
 
     def to_html
         s = ''
         if @@htmlTableRenderInProgress
-            s += "</table>"
+            s += "</table>\n"
             @@htmlTableRenderInProgress = false
         end
                    
-        s += "<table class=\"markdown_table\">\n\r"
+        s += "<table class=\"markdown_table\">\n"
         s += "\t<thead>" 
 
         @column_names.each do |h|
             s += " <th>#{h}</th>"
         end
 
-        s += " </thead>\n\r"
+        s += " </thead>\n"
 
         @rows.each do |row|
-            s += "\t<tr>\n\r"
+            s += "\t<tr>\n"
             row.each do |col|
-                s += "\t\t<td>#{col}</td>\n\r"
+                if col.to_i > 0 && col.to_i.to_s == col  # autoalign cells with numbers
+                    s += "\t\t<td style=\"text-align: center;\">#{col}</td>\n"
+                else
+                    s += "\t\t<td>#{col}</td>\n"
+                end
             end
-            s += "\t</tr>\n\r"
+            s += "\t</tr>\n"
         end
 
-        s += "</table>\n\r"
+        s += "</table>\n"
 
         return s
     end

data/lib/almirah/doc_types/base_document.rb

@@ -0,0 +1,18 @@
+
+class BaseDocument
+
+    attr_accessor :path
+    attr_accessor :items
+    attr_accessor :headings
+    attr_accessor :title
+    attr_accessor :id
+
+    def initialize(fele_path)
+
+        @path = fele_path
+        @items = Array.new
+        @headings = Array.new
+        @title = ""
+        @id = ""
+    end
+end

data/lib/almirah/doc_types/protocol.rb

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

data/lib/almirah/doc_types/specification.rb

@@ -0,0 +1,22 @@
+require_relative "base_document"
+
+class Specification < BaseDocument
+
+    attr_accessor :up_link_doc_id
+    attr_accessor :dictionary
+    attr_accessor :controlled_items
+
+    def initialize(fele_path)
+
+        @path = fele_path
+        @title = ""
+        @items = Array.new
+        @headings = Array.new
+        @controlled_items = Array.new
+        @dictionary = Hash.new
+
+        @id = File.basename(fele_path, File.extname(fele_path)).downcase
+        @up_link_doc_id = ""
+    end
+
+end

data/lib/almirah/html_render.rb

@@ -1,6 +1,3 @@
-require_relative "specification"
-require_relative "doc_items/doc_item"
-require_relative "navigation_pane"
 
 class HtmlRender
 
@@ -25,7 +22,7 @@ class HtmlRender
     def render()
         self.htmlRows.append('')
 
-        self.document.docItems.each do |item|    
+        self.document.items.each do |item|    
             a = item.to_html
             self.htmlRows.append a
         end
@@ -44,7 +41,9 @@ class HtmlRender
                     file.puts r
                 end
             elsif s.include?('{{NAV_PANE}}')
-                file.puts self.nav_pane.to_html
+                if @nav_pane
+                    file.puts self.nav_pane.to_html
+                end
             else
                 file.puts s
             end

data/lib/almirah/navigation_pane.rb

@@ -1,5 +1,3 @@
-require_relative "doc_items/doc_item"
-require_relative "specification"
 
 class NavigationPane
 
@@ -12,10 +10,10 @@ class NavigationPane
     def to_html        
         s = "<ul class=\"fa-ul\">\n"
         @specifications.each do |spec|
-            s += "\t<li><span class=\"fa-li\"><i class=\"fa fa-folder-open-o\"> </i></span> #{spec.key.downcase}\n"
+            s += "\t<li><span class=\"fa-li\"><i class=\"fa fa-folder-open-o\"> </i></span> #{spec.id}\n"
                 s += "\t\t<ul class=\"fa-ul\">\n"
                 s += "\t\t\t<li><span class=\"fa-li\"><i class=\"fa fa-plus-square-o\"> </i></span>\n"
-                s += "\t\t\t\t<a href=\".\\..\\#{spec.key.downcase }\\#{spec.key.downcase }.html\">#{spec.title}</a>\n"
+                s += "\t\t\t\t<a href=\".\\..\\#{spec.id }\\#{spec.id }.html\">#{spec.title}</a>\n"
                 s += "\t\t\t</li>\n"
                 s += "\t\t</ul>\n"
             s += "\t</li>\n"

data/lib/almirah/project.rb

@@ -1,11 +1,11 @@
-require_relative "doc_items/doc_item"
-require_relative "specification"
+require_relative "doc_fabric"
 require_relative "html_render"
 require_relative "navigation_pane"
 
 class Project
 
     attr_accessor :specifications
+    attr_accessor :protocols
     attr_accessor :project_root_directory
     attr_accessor :gem_root
     attr_accessor :specifications_dictionary
@@ -13,45 +13,88 @@ class Project
     def initialize(path, gem_root)
         @project_root_directory = path
         @specifications = Array.new
+        @protocols = Array.new
         @gem_root = gem_root
         @specifications_dictionary = Hash.new
         
-        parse_all_documents()
-        link_all_specifications()
-        render_all_specifications()
-       
+        FileUtils.remove_dir(@project_root_directory + "/build", true)      
     end
 
-    def parse_all_documents
-        
-        Dir.glob( "#{@project_root_directory}/**/*.md" ).each do |f|
-            puts f
-            spec = Specification.new(f)
-            @specifications.append(spec)
+    def specifications_and_protocols
+
+        parse_all_specifications
+        parse_all_protocols
+        link_all_specifications
+        link_all_protocols
+        render_all_specifications
+        render_all_protocols
+    end
+
+    def specifications_and_results( test_run )
+
+        parse_all_specifications
+        parse_test_run test_run
+        link_all_specifications
+        link_all_protocols
+        render_all_specifications
+        render_all_protocols
+    end
+
+    def parse_all_specifications        
+        Dir.glob( "#{@project_root_directory}/specifications/**/*.md" ).each do |f|
+            puts "Spec: " + f
+            doc = DocFabric.create_specification(f)
+            @specifications.append(doc)
+        end
+    end
+
+    def parse_all_protocols
+        Dir.glob( "#{@project_root_directory}/tests/protocols/**/*.md" ).each do |f|
+            puts "Prot: " + f
+            doc = DocFabric.create_protocol(f)
+            @protocols.append(doc)
+        end
+    end
+
+    def parse_test_run( test_run )
+        Dir.glob( "#{@project_root_directory}/tests/runs/#{test_run}/**/*.md" ).each do |f|
+            puts "Run: " + f
+            doc = DocFabric.create_protocol(f)
+            @protocols.append(doc)
         end
     end
 
     def link_all_specifications
         combList = @specifications.combination(2)
         combList.each do |c|
-            self.link_two_specifications(c[0], c[1])
+            link_two_specifications(c[0], c[1])
+        end
+    end
+
+    def link_all_protocols
+        @protocols.each do |p|
+            @specifications.each do |s|
+                if s.id == p.up_link_doc_id
+                    link_protocol_to_spec(p,s)
+                end
+            end
         end
     end
 
     def link_two_specifications(doc_A, doc_B)
 
-        if doc_A.key == doc_B.up_link_key
+        if doc_A.id == doc_B.up_link_doc_id
             top_document = doc_A
             bottom_document = doc_B
-        elsif doc_B.key == doc_A.up_link_key
+        elsif doc_B.id == doc_A.up_link_doc_id
             top_document = doc_B
             bottom_document = doc_A
         else
             puts "No Links"
             return # no links
         end
-
-        bottom_document.controlledParagraphs.each do |item|
+        
+        bottom_document.controlled_items.each do |item|
 
             if top_document.dictionary.has_key?(item.up_link.to_s)
 
@@ -69,6 +112,25 @@ class Project
         end
     end
 
+    def link_protocol_to_spec(protocol, specification)
+
+        top_document = specification
+        bottom_document = protocol
+
+        bottom_document.controlled_items.each do |item|
+
+            if top_document.dictionary.has_key?(item.up_link.to_s)
+
+                topItem = top_document.dictionary[item.up_link.to_s]
+                
+                unless topItem.coverage_links
+                    topItem.coverage_links = Array.new
+                end
+                topItem.coverage_links.append(item)
+            end
+        end
+    end
+
     def render_all_specifications
         
         # create a sidebar first
@@ -76,13 +138,39 @@ class Project
 
         pass = @project_root_directory
 
-        FileUtils.remove_dir(pass + "/build", true)
         FileUtils.mkdir_p(pass + "/build/specifications")
     
-        @specifications.each do |spec|
+        @specifications.each do |doc|
+
+            img_src_dir = pass + "/specifications/" + doc.id + "/img"
+            img_dst_dir = pass + "/build/specifications/" + doc.id + "/img"
+     
+            FileUtils.mkdir_p(img_dst_dir)
+
+            if File.directory?(img_src_dir)
+                FileUtils.copy_entry( img_src_dir, img_dst_dir )
+            end
+
+            HtmlRender.new( doc, nav_pane,
+            @gem_root + "/lib/almirah/templates/page.html",
+            "#{pass}/build/specifications/#{doc.id}/#{doc.id}.html" )
+        end
+    end
+
+    def render_all_protocols
+        
+        # create a sidebar first
+        #nav_pane = NavigationPane.new(@specifications)        
+
+        pass = @project_root_directory
+
+        # FileUtils.remove_dir(pass + "/build/tests", true)
+        FileUtils.mkdir_p(pass + "/build/tests/protocols")
+    
+        @protocols.each do |doc|
 
-            img_src_dir = pass + "/specifications/" + spec.key.downcase + "/img"
-            img_dst_dir = pass + "/build/specifications/" + spec.key.downcase + "/img"
+            img_src_dir = pass + "/tests/protocols/" + doc.id + "/img"
+            img_dst_dir = pass + "/build/tests/protocols/" + doc.id + "/img"
      
             FileUtils.mkdir_p(img_dst_dir)
 
@@ -90,9 +178,9 @@ class Project
                 FileUtils.copy_entry( img_src_dir, img_dst_dir )
             end
 
-            HtmlRender.new( spec, nav_pane,
+            HtmlRender.new( doc, nil,
             @gem_root + "/lib/almirah/templates/page.html",
-            "#{pass}/build/specifications/#{spec.key.downcase}/#{spec.key.downcase}.html" )
+            "#{pass}/build/tests/protocols/#{doc.id}/#{doc.id}.html" )
         end
     end
 end

data/lib/almirah/templates/page.html

@@ -89,7 +89,7 @@
         background-color:#e1f1fa;
         padding: 4px;
         white-space:nowrap;
-        font-weight:bold;
+        font-weight:normal;
         border: 1px solid #bbb;
     }
     table.controlled td {

data/lib/almirah.rb

@@ -2,22 +2,36 @@ require "thor"
 require_relative "almirah/project"
 
 class CLI < Thor
-  desc "please <pass>", "say <pass>"
-    def please(pass)
-      Almirah.new().start(pass)
+  desc "please <project_folder>", "say <project_folder>"
+  option :results
+    def please(project_folder)
+      a = Almirah.new project_folder
+      if options[:results]
+        a.results options[:results]
+      else
+        a.default
+      end
     end
 end
 
 class Almirah
 
+  attr_accessor :project
+
+  def initialize project_folder
+    @project = Project.new project_folder, getGemRoot
+  end
+
   def getGemRoot
     File.expand_path './..', File.dirname(__FILE__)
   end
 
-  def start(pass)
-
-    prj = Project.new pass, getGemRoot
+  def results( test_run )
+    @project.specifications_and_results test_run
+  end
 
+  def default
+    @project.specifications_and_protocols
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: Almirah
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Oleksandr Ivanov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-31 00:00:00.000000000 Z
+date: 2024-02-10 00:00:00.000000000 Z
 dependencies: []
 description: The software part of the Almirah system
 email: oleksandr.ivanov.development@gmail.com
@@ -19,18 +19,23 @@ extra_rdoc_files: []
 files:
 - bin/almirah
 - lib/almirah.rb
+- lib/almirah/doc_fabric.rb
 - lib/almirah/doc_items/blockquote.rb
 - lib/almirah/doc_items/controlled_paragraph.rb
+- lib/almirah/doc_items/controlled_table.rb
+- lib/almirah/doc_items/controlled_table_row.rb
 - lib/almirah/doc_items/doc_item.rb
 - lib/almirah/doc_items/heading.rb
 - lib/almirah/doc_items/image.rb
 - lib/almirah/doc_items/markdown_list.rb
 - lib/almirah/doc_items/markdown_table.rb
 - lib/almirah/doc_items/paragraph.rb
+- lib/almirah/doc_types/base_document.rb
+- lib/almirah/doc_types/protocol.rb
+- lib/almirah/doc_types/specification.rb
 - lib/almirah/html_render.rb
 - lib/almirah/navigation_pane.rb
 - lib/almirah/project.rb
-- lib/almirah/specification.rb
 - lib/almirah/templates/page.html
 homepage: http://almirah.site
 licenses:

data/lib/almirah/specification.rb

@@ -1,194 +0,0 @@
-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/controlled_paragraph"
-require_relative "doc_items/markdown_table"
-require_relative "doc_items/image"
-require_relative "doc_items/markdown_list"
-
-class Specification
-
-    attr_accessor :path
-    attr_accessor :docItems
-    attr_accessor :headings
-    attr_accessor :title
-    attr_accessor :key
-    attr_accessor :up_link_key
-    attr_accessor :dictionary
-    attr_accessor :controlledParagraphs
-    attr_accessor :tempMdTable
-    attr_accessor :tempMdList
-
-    def initialize(fele_path)
-
-        @path = fele_path
-        @title = ""
-        @docItems = Array.new
-        @headings = Array.new
-        @controlledParagraphs = Array.new
-        @dictionary = Hash.new
-        @tempMdTable = nil
-        @tempMdList = nil
-
-        @key = File.basename(fele_path, File.extname(fele_path)).upcase
-        @up_link_key = ""
-
-        self.parse()
-    end
-
-    def parse()
-
-        file = File.open( self.path )
-        file_lines = file.readlines     
-        file.close
-
-        file_lines.each do |s|
-            if s.lstrip != ""
-                if res = /^([#]{1,})\s(.*)/.match(s)     # Heading    
-                    
-                    if @tempMdTable
-                        self.docItems.append(@tempMdTable)
-                        @tempMdTable = nil
-                    end
-                    if @tempMdList
-                        self.docItems.append(@tempMdList)
-                        @tempMdList = nil
-                    end 
-
-                    level = res[1].length
-                    value = res[2]
-                    item = Heading.new(value, level)
-                    self.docItems.append(item)
-                    self.headings.append(item)
-
-                    if level == 1 && self.title == ""
-                        self.title = value
-                    end   
-                     
-                elsif res = /^\[(\S*)\]\s+(.*)/.match(s)     # Controlled Paragraph
-
-                    if @tempMdTable
-                        self.docItems.append(@tempMdTable)
-                        @tempMdTable = nil
-                    end
-                    if @tempMdList
-                        self.docItems.append(@tempMdList)
-                        @tempMdList = nil
-                    end 
-
-                    id = res[1]
-                    text = res[2]
-
-                    #check if it contains the uplink
-                    if tmp = /(.*)\s+>\[(\S*)\]$/.match(text)
-
-                        text = tmp[1]
-                        up_link = tmp[2]
-                        
-                        if tmp = /^([a-zA-Z]+)[-]\d+/.match(up_link)
-                            self.up_link_key = tmp[1]
-                        end
-                    end
-
-                    item = ControlledParagraph.new( text, id )
-                    item.up_link = up_link
-
-                    self.docItems.append(item)
-                    self.dictionary[ id.to_s ] = item           #for fast search
-                    self.controlledParagraphs.append(item)      #for fast search
-
-                elsif res = /^[!]\[(.*)\]\((.*)\)/.match(s)     # Image
-
-                    if @tempMdTable
-                        self.docItems.append(@tempMdTable)
-                        @tempMdTable = nil
-                    end
-                    if @tempMdList
-                        self.docItems.append(@tempMdList)
-                        @tempMdList = nil
-                    end
-
-                    img_text = res[1]
-                    img_path = res[2]
-
-                    item = Image.new( img_text, img_path )
-
-                    self.docItems.append(item)
-
-                elsif res = /^(\*\s?)+(.*)/.match(s)   #check if bullet list
-                    
-                    if @tempMdTable
-                        self.docItems.append(@tempMdTable)
-                        @tempMdTable = nil
-                    end
-
-                    row = res[2]
-
-                    if @tempMdList
-                        @tempMdList.addRow(row)
-                    else
-                        item = MarkdownList.new(row)
-                        @tempMdList = item
-                    end
-
-                elsif s[0] == '|'   #check if table
-
-                    if @tempMdList
-                        self.docItems.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)
-                            self.docItems.append(item)
-                        end
-
-                    elsif res = /^[|](.*[|])/.match(s) #check if it looks as a table
-
-                        row = res[1]
-
-                        if @tempMdTable
-                            @tempMdTable.addRow(row)
-                        else
-                            #start table from heading
-                            @tempMdTable = MarkdownTable.new(row)
-                        end
-                    end
-
-                elsif res = /^[>](.*)/.match(s)   #check if blockquote
-
-                    if @tempMdTable
-                        self.docItems.append(@tempMdTable)
-                        @tempMdTable = nil
-                    end
-                    if @tempMdList
-                        self.docItems.append(@tempMdList)
-                        @tempMdList = nil
-                    end 
-
-                    item = Blockquote.new(res[1])
-                    self.docItems.append(item)
-
-                else # Reqular Paragraph
-                    if @tempMdTable
-                        self.docItems.append(@tempMdTable)
-                        @tempMdTable = nil
-                    end
-                    if @tempMdList
-                        self.docItems.append(@tempMdList)
-                        @tempMdList = nil
-                    end
-
-                    item = Paragraph.new(s)
-                    self.docItems.append(item)
-                end
-            end
-        end
-    end
-end