Almirah 0.0.8 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1841cdb6a5d88bcbe36d8ed926fd8f659e9a630d58763ead2b78e8b7f17281dd
-  data.tar.gz: 13b91603331fe68ff13f4b1917806551f94f11d98084ce773a1e247abb4b1abb
+  metadata.gz: 4bc6867a502188fb11b4632e9ab695d6fda2af0d1bfef94d3976d069acfb409f
+  data.tar.gz: 7d993b275d67bf0fa9cc6f40bfb3c43c2d16f6bb8cab5b76135866b5d81b59b9
 SHA512:
-  metadata.gz: ed609c1862a9f33b46c2379ae8f08904c30a00767939418e28600267ccc449aa88b7bcf96efc661c1c3d39d9a720a12491c01eed4c0c30034623f342a47d5d70
-  data.tar.gz: e5c91e4efbd5d96d915ad2228b22982391ccc91eae8afc545dc8c1fd1a8f077a690d9da988e47794df470eda560e7f6a0a99ec7a173d33660c0cc532de1c5e97
+  metadata.gz: '087e3aa7b1792ef031d42945fa29d05e5d2231b3e6b83177bfd529e3e7de646a24ac091a0be6e175575c814f87154641aad2036aa9ea7bd8f9247e6e50bd5aca'
+  data.tar.gz: 223acb70d369cdb753635b67b424815cee057ce0309d379a9547ec7769aa9ec78385a178a4862b859444cdd0a187e37c9eaf9771860a2756f1dfea68439133d5

data/lib/almirah/doc_fabric.rb

@@ -3,6 +3,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"
@@ -15,6 +16,12 @@ require_relative "doc_items/markdown_list"
 
 class DocFabric
 
+    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)
         doc = Specification.new path
         DocFabric.parse_document doc
@@ -59,7 +66,18 @@ class DocFabric
                     if level == 1 && doc.title == ""
                         doc.title = value
                     end   
-                        
+                elsif res = /^\%\s(.*)/.match(s)     # Pandoc Document Title
+
+                    title = res[1]
+                    item = Heading.new(title, 1)
+                    item.parent_doc = doc
+                    doc.items.append(item)
+                    doc.headings.append(item)
+
+                    if doc.title == ""
+                        doc.title = title
+                    end 
+                    
                 elsif res = /^\[(\S*)\]\s+(.*)/.match(s)     # Controlled Paragraph
 
                     if tempMdTable
@@ -81,7 +99,7 @@ class DocFabric
                         up_link = tmp[2]
                         
                         if tmp = /^([a-zA-Z]+)[-]\d+/.match(up_link)    # SRS
-                            doc.up_link_doc_id = tmp[1].downcase
+                            doc.up_link_doc_id[ tmp[1].downcase.to_s ] = tmp[1].downcase       # multiple documents could be up-linked                            
                         end
                     end
 
@@ -124,7 +142,7 @@ class DocFabric
 
                     doc.items.append(item)
 
-                elsif res = /^(\*\s?)+(.*)/.match(s)   #check if bullet list
+                elsif res = /^(\*\s?)(.*)/.match(s)   #check if unordered list start
                     
                     if tempMdTable
                         doc.items.append tempMdTable
@@ -134,9 +152,28 @@ class DocFabric
                     row = res[2]
 
                     if tempMdList
-                        tempMdList.addRow(row)
+                        tempMdList.addRow(s)
                     else
-                        item = MarkdownList.new(row)
+                        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
@@ -198,14 +235,24 @@ class DocFabric
                         tempMdTable = nil
                     end
                     if tempMdList
-                        doc.items.append tempMdList
-                        tempMdList = nil
+                        if MarkdownList.unordered_list_item?(s) || MarkdownList.ordered_list_item?(s)
+                            tempMdList.addRow(s)
+                            next
+                        else
+                            doc.items.append tempMdList
+                            tempMdList = nil
+                        end
                     end
 
                     item = Paragraph.new(s)
                     item.parent_doc = doc
                     doc.items.append(item)
                 end
+            else
+                if tempMdList   # lists are separated by emty line from each other
+                    doc.items.append tempMdList
+                    tempMdList = nil
+                end
             end
         end
         # Finalize non-closed elements

data/lib/almirah/doc_items/blockquote.rb

@@ -10,12 +10,13 @@ class Blockquote < DocItem
 
     def to_html
         s = ''
+        f_text = format_string(@text)
         if @@htmlTableRenderInProgress
             s += "</table>\n"
             @@htmlTableRenderInProgress = false
         end
 
-        s += "<div class=\"blockquote\"><p>#{@text}</div>\n"
+        s += "<div class=\"blockquote\"><p>#{f_text}</div>\n"
         return s
     end
 end

data/lib/almirah/doc_items/controlled_paragraph.rb

@@ -19,12 +19,13 @@ class ControlledParagraph < Paragraph
         s = ''
         unless @@htmlTableRenderInProgress                    
             s += "<table class=\"controlled\">\n"
-            s += "\t<thead> <th>#</th> <th>Text</th> <th>UL</th> <th>DL</th> <th>COV</th> </thead>\n"
+            s += "\t<thead> <th>#</th> <th></th> <th>UL</th> <th>DL</th> <th>COV</th> </thead>\n"
             @@htmlTableRenderInProgress = true
         end
+        f_text = format_string(@text)
         s += "\t<tr>\n"
         s += "\t\t<td class=\"item_id\"> <a name=\"#{@id}\" id=\"#{@id}\" href=\"##{@id}\">#{@id}</a></td>\n"
-        s += "\t\t<td class=\"item_text\">#{@text}</td>\n"
+        s += "\t\t<td class=\"item_text\">#{f_text}</td>\n"
 
         if @up_link
             if tmp = /^([a-zA-Z]+)[-]\d+/.match(@up_link)
@@ -39,7 +40,11 @@ class ControlledParagraph < Paragraph
             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"
+            if @down_links.length == 1
+                s += "\t\t<td class=\"item_id\"><a href=\"./../#{down_link_doc_name}/#{down_link_doc_name}.html##{@down_links[0].id}\" class=\"external\">#{@down_links[0].id}</a></td>\n"
+            else
+                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"
+            end
         else
             s += "\t\t<td class=\"item_id\"></td>\n"
         end

data/lib/almirah/doc_items/controlled_table.rb

@@ -1,7 +1,7 @@
 require_relative "controlled_table_row"
+require_relative "text_line"
 
-
-class ControlledTableColumn
+class ControlledTableColumn < TextLine
 
     attr_accessor :text
     
@@ -10,7 +10,8 @@ class ControlledTableColumn
     end
 
     def to_html
-        "\t\t<td>#{@text}</td>\n\r"
+        f_text = format_string(@text)
+        "\t\t<td>#{f_text}</td>\n\r"
     end
 end
 
@@ -41,12 +42,13 @@ end
 class TestStepResultColumn <  ControlledTableColumn
 
     def to_html
+        f_text = format_string(@text)
         if @text.downcase == "pass"
-            "\t\t<td style=\"background-color: #cfc;\">#{@text}</td>\n\r"
+            "\t\t<td style=\"background-color: #cfc;\">#{f_text}</td>\n\r"
         elsif @text.downcase == "fail"
-            "\t\t<td style=\"background-color: #fcc;\">#{@text}</td>\n\r"
+            "\t\t<td style=\"background-color: #fcc;\">#{f_text}</td>\n\r"
         else
-            "\t\t<td>#{@text}</td>\n\r"
+            "\t\t<td>#{f_text}</td>\n\r"
         end
     end
 end
@@ -126,9 +128,9 @@ class ControlledTable < DocItem
                 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
+                    
+                    @parent_doc.up_link_doc_id[ 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
                     @parent_doc.controlled_items.append new_row

data/lib/almirah/doc_items/doc_item.rb

@@ -1,4 +1,6 @@
-class DocItem
+require_relative "text_line"
+
+class DocItem < TextLine
     attr_accessor :parent_doc
     
     @parent_doc = nil

data/lib/almirah/doc_items/heading.rb

@@ -8,7 +8,7 @@ class Heading < Paragraph
     def initialize(text, level)
         @text = text
         @level = level
-        @anchor_id = self.getTextWithoutSpaces()
+        @anchor_id = getTextWithoutSpaces()
     end
 
     def to_html

data/lib/almirah/doc_items/image.rb

@@ -21,7 +21,7 @@ class Image < DocItem
             @@htmlTableRenderInProgress = false
         end
 
-        s += "<img src=\"#{@path}\" alt=\"#{@text}\">"
+        s += "<p style=\"margin-top: 15px;\"><img src=\"#{@path}\" alt=\"#{@text}\">"
         return s
     end
 end

data/lib/almirah/doc_items/markdown_list.rb

@@ -3,14 +3,113 @@ require_relative "doc_item"
 class MarkdownList < DocItem
 
     attr_accessor :rows
+    attr_accessor :text
+    attr_accessor :is_ordered
+    attr_accessor :indent_position
+    attr_accessor :current_nesting_level
 
-    def initialize(first_row)
+    @@lists_stack = Array.new
+
+    def initialize(is_ordered)
         @rows = Array.new
-        @rows.append(first_row)
+        @is_ordered = is_ordered
+        @current_nesting_level = 0
+        @indent_position = 0
+        @text = ''
+
+        @@lists_stack.push(self)
+    end
+
+    def addRow(raw_text)
+        pos = calculate_text_position(raw_text)
+        row = raw_text[pos..-1]
+
+        pos = calculate_indent_position(raw_text)
+
+        if pos > @@lists_stack[-1].indent_position
+
+            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.current_nesting_level = @current_nesting_level + 1
+            nested_list.indent_position = pos
+            
+            prev_row = prev_lists_stack_item.rows[-1]
+            if prev_row.is_a?(MarkdownList)
+                #cannot be there
+            else
+                nested_list.text = prev_row
+                #puts "Length: " + prev_lists_stack_item.rows.length.to_s
+                prev_lists_stack_item.rows[-1] = nested_list
+            end
+            
+            nested_list.addRow(raw_text)
+
+        elsif pos < @@lists_stack[-1].indent_position
+
+            @@lists_stack.pop
+            @@lists_stack[-1].rows.append(row)
+
+        else
+            @@lists_stack[-1].rows.append(row)
+
+        end
+    end
+
+    def calculate_indent_position(s)
+        s.downcase
+        pos = 0
+        s.each_char do |c|
+            if c != ' ' && c != '\t'
+                break
+            end
+            pos += 1
+        end
+        return pos
+    end
+    def calculate_text_position(s)
+        s.downcase
+        pos = 0
+        space_detected = false
+        s.each_char do |c|
+            if space_detected
+                if c != ' ' && c != '\t' && c != '*' && c != '.' && !numeric?(c)
+                    break
+                end
+            elsif c == ' ' || c == '\t'
+                space_detected = true
+            end
+            pos += 1
+        end
+        return pos
+    end
+
+    def letter?(c)
+        c.match?(/[[:alpha:]]/)
+    end
+      
+    def numeric?(c)
+        c.match?(/[[:digit:]]/)
     end
 
-    def addRow(row)
-        @rows.append(row)
+    def non_blank?(c)
+        c.match?(/[[:graph:]]/)
+    end
+
+    def self.unordered_list_item?(raw_text)
+
+        if res = /(\*\s?)(.*)/.match(raw_text)
+            return true
+        end
+        return false
+    end
+
+    def self.ordered_list_item?(raw_text)
+
+        if res = /\d[.]\s(.*)/.match(raw_text)
+            return true
+        end
+        return false
     end
 
     def to_html
@@ -20,11 +119,30 @@ class MarkdownList < DocItem
             @@htmlTableRenderInProgress = false
         end
 
-        s += "<ul>\n"
+        if @is_ordered
+            s += "<ol>\n"
+        else
+            s += "<ul>\n"
+        end
+        
         @rows.each do |r|
-            s += "\t<li>#{r}</li>\n"
+            if r.is_a?(MarkdownList)
+                f_text = format_string(r.text)
+                s += "\t<li>#{f_text}\n"
+                s += r.to_html()
+                s += "</li>\n"
+            else
+                f_text = format_string(r)
+                #puts f_text
+                s += "\t<li>#{f_text}</li>\n"
+            end
         end
-        s += "</ul>\n"
+
+        if @is_ordered
+            s += "</ol>\n"
+        else
+            s += "</ul>\n"
+        end       
 
         return s
     end

data/lib/almirah/doc_items/markdown_table.rb

@@ -44,7 +44,8 @@ class MarkdownTable < DocItem
                 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"
+                    f_text = format_string(col)
+                    s += "\t\t<td>#{f_text}</td>\n"
                 end
             end
             s += "\t</tr>\n"

data/lib/almirah/doc_items/paragraph.rb

@@ -9,7 +9,7 @@ class Paragraph < DocItem
     end
 
     def getTextWithoutSpaces
-        return @text.split.join('-')
+        return @text.split.join('-').downcase
     end
 
     def to_html
@@ -19,7 +19,7 @@ class Paragraph < DocItem
             @@htmlTableRenderInProgress = false
         end
 
-        s += "<p>#{@text}"
+        s += "<p>" + format_string(@text)
         return s
     end
 end

data/lib/almirah/doc_items/text_line.rb

@@ -0,0 +1,183 @@
+class TextLine
+
+    @@lazy_doc_id_dict = Hash.new
+
+    def self.add_lazy_doc_id(id)
+        doc_id = id.to_s.downcase
+        @@lazy_doc_id_dict[doc_id] = doc_id
+    end
+
+    def format_string(str)
+        state = 'default'
+        prev_state = 'default'
+        result = ''
+        stack = ''
+        prev_c = ''
+        link_text = ''
+        link_url = ''
+        str.each_char do |c|
+            if c == '*'
+                if state == 'default'
+                    prev_state, state = change_state(c, state, 'first_asterisk_detected')
+
+                elsif state == 'first_asterisk_detected'
+                    prev_state, state = change_state(c, state, 'second_asterisk_detected')
+                
+                elsif state == 'second_asterisk_detected'
+                    prev_state, state = change_state(c, state, 'third_asterisk_detected')
+                
+                elsif state == 'second_asterisk_detected'
+                    prev_state, state = change_state(c, state, 'third_asterisk_detected')
+
+                elsif state == 'italic_started'
+                    prev_state, state = change_state(c, state, 'default')
+                    result += italic(stack)
+
+                elsif state == 'bold_started'
+                    prev_state, state = change_state(c, state, 'first_asterisk_after_bold_detected')
+
+                elsif state == 'first_asterisk_after_bold_detected'
+                    prev_state, state = change_state(c, state, 'default')
+                    result += bold(stack)
+
+                elsif state == 'bold_and_italic_started'
+                    prev_state, state = change_state(c, state, 'first_asterisk_after_bold_and_italic_detected')
+
+                elsif state == 'first_asterisk_after_bold_and_italic_detected'
+                    prev_state, state = change_state(c, state, 'second_asterisk_after_bold_and_italic_detected')
+
+                elsif state == 'second_asterisk_after_bold_and_italic_detected'
+                    prev_state, state = change_state(c, state, 'default')
+                    result += bold_and_italic(stack)
+
+                else
+                end
+            elsif c == '['
+                if state == 'default'
+                    prev_state, state = change_state(c, state, 'square_bracket_left_detected')
+                else
+                end
+            elsif c == ']'
+                if state == 'square_bracket_left_detected'
+                    prev_state, state = change_state(c, state, 'default')
+                    result += '[]'
+
+                elsif state == 'link_text_started'
+                    prev_state, state = change_state(c, state, 'square_bracket_right_detected')
+                    link_text = stack
+
+                else
+                end
+            elsif c == '('
+                if state == 'square_bracket_right_detected'
+                    prev_state, state = change_state(c, state, 'brace_left_detected')
+                else
+                    result += c
+                end
+            elsif c == ')'
+                if state == 'brace_left_detected'
+                    prev_state, state = change_state(c, state, 'default')
+                    result += '()'
+
+                elsif state == 'link_url_started'
+                    prev_state, state = change_state(c, state, 'default')
+                    link_url = stack
+                    result += link(link_text, link_url)
+
+                else
+                    result += c
+                end
+            else
+                if state == 'default'
+                    result += c
+                else
+                    if state == 'first_asterisk_detected'
+                        prev_state, state = change_state(c, state, 'italic_started')
+                        stack = ''
+
+                    elsif state == 'second_asterisk_detected'
+                        prev_state, state = change_state(c, state, 'bold_started')
+                        stack = ''
+
+                    elsif state == 'third_asterisk_detected'
+                        prev_state, state = change_state(c, state, 'bold_and_italic_started')
+                        stack = ''
+                    
+                    elsif state == 'first_asterisk_after_bold_detected'
+                        prev_state, state = change_state(c, state, 'bold_started')
+
+                    elsif state == 'first_asterisk_after_bold_and_italic_detected'
+                        prev_state, state = change_state(c, state, 'bold_and_italic_started')
+
+                    elsif state == 'second_asterisk_after_bold_and_italic_detected'
+                        prev_state, state = change_state(c, state, 'bold_and_italic_started')
+
+                    elsif state == 'square_bracket_left_detected'
+                        prev_state, state = change_state(c, state, 'link_text_started')
+                        stack = ''
+
+                    elsif state == 'square_bracket_right_detected'
+                        prev_state, state = change_state(c, state, 'default')
+                        result += stack + c
+                        c = ''
+
+                    elsif state == 'brace_left_detected'
+                        prev_state, state = change_state(c, state, 'link_url_started')
+                        stack = ''
+
+                    else
+                    end
+                    stack += c
+                end
+            end
+            prev_c = c
+        end
+        return result
+    end
+
+    def change_state(c, cur_state, new_state)
+        # puts "[#{c}] Transition: #{cur_state} --> #{new_state}"
+        return cur_state, new_state
+    end
+
+    def italic(str)
+        "<i>#{str}</i>"
+    end
+
+    def bold(str)
+        "<b>#{str}</b>"
+    end
+
+    def bold_and_italic(str)
+        "<b><i>#{str}</i></b>"
+    end
+
+    def link(link_text, link_url)
+
+        # define default result first
+        result = "<a href=\"#{link_url}\" class=\"external\">#{link_text}</a>"
+
+        lazy_doc_id, anchor = nil, nil
+
+        if res = /(\w+)[.]md$/.match(link_url)          #link
+            lazy_doc_id = res[1].to_s.downcase
+
+        elsif res = /(\w*)[.]md(#.*)$/.match(link_url)  # link with anchor
+            if res && res.length > 2
+                lazy_doc_id = res[1]
+                anchor = res[2]
+            end
+        end
+
+        if lazy_doc_id
+            if @@lazy_doc_id_dict.has_key?(lazy_doc_id)
+                if anchor
+                    result = "<a href=\".\\..\\#{lazy_doc_id}\\#{lazy_doc_id}.html#{anchor}\" class=\"external\">#{link_text}</a>"
+                else
+                    result = "<a href=\".\\..\\#{lazy_doc_id}\\#{lazy_doc_id}.html\" class=\"external\">#{link_text}</a>"
+                end
+            end
+        end
+        return result
+    end
+end

data/lib/almirah/doc_types/base_document.rb

@@ -25,7 +25,11 @@ class BaseDocument
         file_data = file.readlines
         file.close
 
-        output_file_path += "#{@id}/#{@id}.html"
+        if @id == 'index'
+            output_file_path += "#{@id}.html"
+        else
+            output_file_path += "#{@id}/#{@id}.html"
+        end
         file = File.open( output_file_path, "w" )
         file_data.each do |s|
             if s.include?('{{CONTENT}}')

data/lib/almirah/doc_types/index.rb

@@ -0,0 +1,107 @@
+require_relative "base_document"
+
+class Index < BaseDocument
+
+    attr_accessor :items
+    attr_accessor :project
+
+    def initialize(project)
+        @items = Array.new
+        @project = project
+
+        @title = "Document Index"
+        @id = "index"
+    end
+
+    def to_console
+        puts "\e[36m" + "Index: " + @id + "\e[0m"
+    end
+
+    def to_html(output_file_path)
+
+        html_rows = Array.new
+
+        html_rows.append('')
+        s = "<h1>#{@title}</h1>\n"
+
+        # Specifications
+        s = "<h2>Specifications</h2>\n"
+        s += "<table class=\"controlled\">\n"
+        s += "\t<thead>\n"
+        s += "\t\t<th>Title</th>\n"
+        s += "\t\t<th>Items</th>\n"
+        s += "\t\t<th>Items<br>w/ Uplinks</th>\n"
+        s += "\t\t<th>Items<br>w/ Downlinks</th>\n"
+        s += "\t\t<th>Covered<br>by Tests</th>\n"
+        s += "\t\t<th>Duplicated<br>ids</th>\n"
+        s += "\t\t<th>Last Used<br>id</th>\n"
+        s += "</thead>\n"
+        html_rows.append s
+
+        sorted_items = @project.specifications.sort_by { |w| w.id }
+
+        sorted_items.each do |doc|
+            s = "\t<tr>\n"
+            s += "\t\t<td class=\"item_text\" style='padding: 5px;'><a href=\"./specifications/#{doc.id}/#{doc.id}.html\" class=\"external\">#{doc.title}</a></td>\n"
+            s += "\t\t<td class=\"item_id\" style='width: 7%;'>#{doc.controlled_items.length.to_s}</td>\n"
+            s += "\t\t<td class=\"item_id\" style='width: 7%;'>#{doc.items_with_uplinks_number.to_s}</td>\n"
+            s += "\t\t<td class=\"item_id\" style='width: 7%;'>#{doc.items_with_downlinks_number.to_s}</td>\n"
+            s += "\t\t<td class=\"item_id\" style='width: 7%;'>#{doc.items_with_coverage_number.to_s}</td>\n"
+            s += "\t\t<td class=\"item_id\" style='width: 7%;'>#{doc.duplicated_ids_number.to_s}</td>\n"
+            s += "\t\t<td class=\"item_id\" style='width: 7%;'>#{doc.last_used_id.to_s}</td>\n"
+            s += "</tr>\n"
+            html_rows.append s
+        end
+        html_rows.append "</table>\n"
+
+        # Traceability Matrices
+        s = "<h2>Traceability Matrices</h2>\n"
+        s += "<table class=\"controlled\">\n"
+        s += "\t<thead>\n"
+        s += "\t\t<th>Title</th>\n"
+        s += "\t\t<th>Top Document</th>\n"
+        s += "\t\t<th>Bottom Document</th>\n"
+        s += "</thead>\n"
+        html_rows.append s
+
+        sorted_items = @project.traceability_matrices.sort_by { |w| w.id }
+
+        sorted_items.each do |doc|
+            s = "\t<tr>\n"
+            s += "\t\t<td class=\"item_text\" style='padding: 5px;'><a href=\"./specifications/#{doc.id}/#{doc.id}.html\" class=\"external\">#{doc.title}</a></td>\n"
+            s += "\t\t<td class=\"item_text\" style='width: 25%; padding: 5px;'>#{doc.top_doc.title}</td>\n"
+            s += "\t\t<td class=\"item_text\" style='width: 25%; padding: 5px;'>#{doc.bottom_doc.title}</td>\n"
+            s += "</tr>\n"
+            html_rows.append s
+        end
+        html_rows.append "</table>\n"
+
+        # Coverage Matrices
+        if @project.coverage_matrices.length > 0
+            s = "<h2>Coverage Matrices</h2>\n"
+            s += "<table class=\"controlled\">\n"
+            s += "\t<thead>\n"
+            s += "\t\t<th>Title</th>\n"
+            s += "\t\t<th>Specification Covered</th>\n"
+            s += "</thead>\n"
+            html_rows.append s
+
+            sorted_items = @project.coverage_matrices.sort_by { |w| w.id }
+
+            sorted_items.each do |doc|
+                s = "\t<tr>\n"
+                s += "\t\t<td class=\"item_text\" style='padding: 5px;'><a href=\"./specifications/#{doc.id}/#{doc.id}.html\" class=\"external\">#{doc.title}</a></td>\n"
+                s += "\t\t<td class=\"item_text\" style='width: 25%; padding: 5px;'>#{doc.top_doc.title}</td>\n"
+                s += "</tr>\n"
+                html_rows.append s
+            end
+            html_rows.append "</table>\n"
+        end
+
+        self.save_html_to_file(html_rows, nil, output_file_path)
+        
+    end
+
+
+
+end

data/lib/almirah/doc_types/protocol.rb

@@ -16,7 +16,7 @@ class Protocol < BaseDocument
         #@dictionary = Hash.new
 
         @id = File.basename(fele_path, File.extname(fele_path)).downcase
-        @up_link_doc_id = ""
+        @up_link_doc_id = Hash.new
     end
 
     def to_html(nav_pane, output_file_path)

data/lib/almirah/doc_types/specification.rb

@@ -30,7 +30,7 @@ class Specification < BaseDocument
         @last_used_id_number = 0
 
         @id = File.basename(fele_path, File.extname(fele_path)).downcase
-        @up_link_doc_id = ""
+        @up_link_doc_id = Hash.new
     end
 
     def to_console
@@ -67,6 +67,7 @@ class Specification < BaseDocument
 
         @items.each do |item|    
             a = item.to_html
+            #a = adjust_internal_links(a, nav_pane.specifications)
             html_rows.append a
         end
 
@@ -74,4 +75,29 @@ class Specification < BaseDocument
         
     end
 
+    def adjust_internal_links(line, specifications)
+        # check if there are internal links to md files and replace them
+        if tmp = /<a\shref="(.*)"\sclass="external">.*<\/a>/.match(line)
+            if res = /(\w*)[.]md/.match(tmp[1])
+                id = res[1].downcase
+                res = /(\w*)[.]md(#.*)/.match(tmp[1])
+                
+                specifications.each do |spec|
+                    if spec.id.downcase == id
+                        if res && res.length > 2
+                            anchor = res[2]
+                            line.sub!(/<a\shref="(.*)"\sclass="external">/,
+                            "<a href=\".\\..\\#{id}\\#{id}.html#{anchor}\" class=\"external\">")
+                        else
+                            line.sub!(/<a\shref="(.*)"\sclass="external">/,
+                            "<a href=\".\\..\\#{id}\\#{id}.html\" class=\"external\">")
+                        end
+                        break
+                    end
+                end
+            end
+        end
+        return line
+    end
+
 end

data/lib/almirah/doc_types/traceability.rb

@@ -5,16 +5,23 @@ class Traceability < BaseDocument
     attr_accessor :top_doc
     attr_accessor :bottom_doc
     attr_accessor :items
+    attr_accessor :is_agregated
 
-    def initialize(top_doc, bottom_doc)
+    def initialize(top_doc, bottom_doc, is_agregated)
 
         @top_doc = top_doc
         @bottom_doc = bottom_doc
+        @is_agregated = is_agregated
 
         @items = Array.new
         @headings = Array.new
 
-        @id = top_doc.id + "-" + bottom_doc.id
+        if @is_agregated 
+            @id = top_doc.id + "-all"
+        else
+            @id = top_doc.id + "-" + bottom_doc.id
+        end
+
         @title = "Traceability Matrix: " + @id
     end
 
@@ -46,24 +53,49 @@ class Traceability < BaseDocument
 
     def render_table_row(top_item)
         s = ""
+        top_f_text = top_item.format_string( top_item.text )
+
         if top_item.down_links
-            if top_item.down_links.length > 1
-                id_color = "style='background-color: #fff8c5;'"
+
+            if @is_agregated
+
+                if top_item.down_links.length > 1
+                    id_color = "style='background-color: #fff8c5;'"
+                else
+                    id_color = ""
+                end
+
+                top_item.down_links.each do |bottom_item|
+                    bottom_f_text = bottom_item.format_string( bottom_item.text )
+                    s += "\t<tr>\n"
+                    s += "\t\t<td class=\"item_id\" #{id_color}><a href=\"./../#{top_item.parent_doc.id}/#{top_item.parent_doc.id}.html##{top_item.id}\" class=\"external\">#{top_item.id}</a></td>\n"
+                    s += "\t\t<td class=\"item_text\" style='width: 42%;'>#{top_f_text}</td>\n"
+                    s += "\t\t<td class=\"item_id\"><a href=\"./../#{bottom_item.parent_doc.id}/#{bottom_item.parent_doc.id}.html##{bottom_item.id}\" class=\"external\">#{bottom_item.id}</a></td>\n"
+                    s += "\t\t<td class=\"item_text\" style='width: 42%;'>#{bottom_f_text}</td>\n"
+                    s += "\t</tr>\n"
+                end
+
             else
-                id_color = ""
-            end 
-            top_item.down_links.each do |bottom_item|
-                s += "\t<tr>\n"
-                s += "\t\t<td class=\"item_id\" #{id_color}><a href=\"./../#{top_item.parent_doc.id}/#{top_item.parent_doc.id}.html##{top_item.id}\" class=\"external\">#{top_item.id}</a></td>\n"
-                s += "\t\t<td class=\"item_text\" style='width: 42%;'>#{top_item.text}</td>\n"
-                s += "\t\t<td class=\"item_id\"><a href=\"./../#{bottom_item.parent_doc.id}/#{bottom_item.parent_doc.id}.html##{bottom_item.id}\" class=\"external\">#{bottom_item.id}</a></td>\n"
-                s += "\t\t<td class=\"item_text\" style='width: 42%;'>#{bottom_item.text}</td>\n"
-                s += "\t</tr>\n"
+                top_item.down_links.each do |bottom_item|
+
+                    id_color = ""
+
+                    if bottom_item.parent_doc.id == @bottom_doc.id
+
+                        bottom_f_text = bottom_item.format_string( bottom_item.text )
+                        s += "\t<tr>\n"
+                        s += "\t\t<td class=\"item_id\" #{id_color}><a href=\"./../#{top_item.parent_doc.id}/#{top_item.parent_doc.id}.html##{top_item.id}\" class=\"external\">#{top_item.id}</a></td>\n"
+                        s += "\t\t<td class=\"item_text\" style='width: 42%;'>#{top_f_text}</td>\n"
+                        s += "\t\t<td class=\"item_id\"><a href=\"./../#{bottom_item.parent_doc.id}/#{bottom_item.parent_doc.id}.html##{bottom_item.id}\" class=\"external\">#{bottom_item.id}</a></td>\n"
+                        s += "\t\t<td class=\"item_text\" style='width: 42%;'>#{bottom_f_text}</td>\n"
+                        s += "\t</tr>\n"
+                    end
+                end
             end
         else
             s += "\t<tr>\n"
             s += "\t\t<td class=\"item_id\"><a href=\"./../#{top_item.parent_doc.id}/#{top_item.parent_doc.id}.html##{top_item.id}\" class=\"external\">#{top_item.id}</a></td>\n"
-            s += "\t\t<td class=\"item_text\" style='width: 42%;'>#{top_item.text}</td>\n"
+            s += "\t\t<td class=\"item_text\" style='width: 42%;'>#{top_f_text}</td>\n"
             s += "\t\t<td class=\"item_id\"></td>\n"
             s += "\t\t<td class=\"item_text\" style='width: 42%;'></td>\n"
             s += "\t</tr>\n"

data/lib/almirah/project.rb

@@ -1,21 +1,31 @@
+require 'fileutils'
 require_relative "doc_fabric"
 require_relative "navigation_pane"
 require_relative "doc_types/traceability"
 require_relative "doc_types/coverage"
+require_relative "doc_types/index"
 
 class Project
 
     attr_accessor :specifications
     attr_accessor :protocols
+    attr_accessor :traceability_matrices
+    attr_accessor :coverage_matrices
     attr_accessor :project_root_directory
     attr_accessor :specifications_dictionary
+    attr_accessor :index
+    attr_accessor :project
 
     def initialize(path)
         @project_root_directory = path
         @specifications = Array.new
         @protocols = Array.new
+        @traceability_matrices = Array.new
+        @coverage_matrices = Array.new
         @specifications_dictionary = Hash.new
-        
+        @index = nil
+        @project = self
+
         FileUtils.remove_dir(@project_root_directory + "/build", true)      
     end
 
@@ -25,8 +35,12 @@ class Project
         parse_all_protocols
         link_all_specifications
         link_all_protocols
-        render_all_specifications
+        create_index
+        render_all_specifications(@specifications)
+        render_all_specifications(@traceability_matrices)
+        render_all_specifications(@coverage_matrices)
         render_all_protocols
+        render_index
     end
 
     def specifications_and_results( test_run )
@@ -35,13 +49,41 @@ class Project
         parse_test_run test_run
         link_all_specifications
         link_all_protocols
-        render_all_specifications
+        create_index
+        render_all_specifications(@specifications)
+        render_all_specifications(@traceability_matrices)
+        render_all_specifications(@coverage_matrices)
         render_all_protocols
+        render_index
+    end
+
+    def transform( file_extension )
+        transform_all_specifications file_extension 
+    end
+
+    def transform_all_specifications( file_extension )
+
+        path = @project_root_directory
+
+        # find all specifications
+        Dir.glob( "#{@project_root_directory}/specifications/**/*.md" ).each do |f|
+            puts f
+            # make a copy with another extention to preserve the content
+            f_directory = File.dirname(f)
+            f_name = File.basename(f, File.extname(f)).downcase + "._md"
+            FileUtils.copy_file( f, "#{f_directory}/#{f_name}")
+            # transform the original one
+            # but do nothing for now - TODO
+        end
     end
 
-    def parse_all_specifications        
+    def parse_all_specifications
+        # do a lasy pass first to get the list of documents id
+        Dir.glob( "#{@project_root_directory}/specifications/**/*.md" ).each do |f|
+            DocFabric.add_lazy_doc_id(f)
+        end
+        # parse documents in the second pass
         Dir.glob( "#{@project_root_directory}/specifications/**/*.md" ).each do |f|
-            puts "Spec: " + f
             doc = DocFabric.create_specification(f)
             @specifications.append(doc)
         end
@@ -67,13 +109,14 @@ class Project
         combList = @specifications.combination(2)
         combList.each do |c|
             link_two_specifications(c[0], c[1])
+            # puts "Link: #{c[0].id} - #{c[1].id}"
         end
     end
 
     def link_all_protocols
         @protocols.each do |p|
             @specifications.each do |s|
-                if s.id == p.up_link_doc_id
+                if p.up_link_doc_id.has_key?(s.id.to_s)
                     link_protocol_to_spec(p,s)
                 end
             end
@@ -82,17 +125,16 @@ class Project
 
     def link_two_specifications(doc_A, doc_B)
 
-        if doc_A.id == doc_B.up_link_doc_id
+        if doc_B.up_link_doc_id.has_key?(doc_A.id.to_s)
             top_document = doc_A
             bottom_document = doc_B
-        elsif doc_B.id == doc_A.up_link_doc_id
+        elsif doc_A.up_link_doc_id.has_key?(doc_B.id.to_s)
             top_document = doc_B
             bottom_document = doc_A
         else
-            puts "No Links"
             return # no links
         end
-        
+        #puts "Link: #{doc_A.id} - #{doc_B.id}" 
         bottom_document.controlled_items.each do |item|
 
             if top_document.dictionary.has_key?(item.up_link.to_s)
@@ -107,8 +149,8 @@ class Project
             end
         end
         # create treceability document
-        trx = Traceability.new top_document, bottom_document
-        @specifications.append trx
+        trx = Traceability.new top_document, bottom_document, false
+        @traceability_matrices.append trx
     end
 
     def link_protocol_to_spec(protocol, specification)
@@ -131,19 +173,23 @@ class Project
         end
         # create coverage document
         trx = Coverage.new top_document
-        @specifications.append trx
+        @coverage_matrices.append trx
+    end
+
+    def create_index
+        @index = Index.new( @project )
     end
 
-    def render_all_specifications
+    def render_all_specifications(spec_list)
         
         # create a sidebar first
-        nav_pane = NavigationPane.new(@specifications)        
+        # nav_pane = NavigationPane.new(@specifications)        
 
         pass = @project_root_directory
 
         FileUtils.mkdir_p(pass + "/build/specifications")
     
-        @specifications.each do |doc|
+        spec_list.each do |doc|
 
             doc.to_console
 
@@ -156,14 +202,14 @@ class Project
                 FileUtils.copy_entry( img_src_dir, img_dst_dir )
             end
 
-            doc.to_html( nav_pane, "#{pass}/build/specifications/" )
+            doc.to_html( nil, "#{pass}/build/specifications/" )
         end
     end
 
     def render_all_protocols
         
         # create a sidebar first
-        nav_pane = NavigationPane.new(@specifications)        
+        # nav_pane = NavigationPane.new(@specifications)        
 
         pass = @project_root_directory
 
@@ -181,7 +227,17 @@ class Project
                 FileUtils.copy_entry( img_src_dir, img_dst_dir )
             end
 
-            doc.to_html( nav_pane, "#{pass}/build/tests/protocols/" )
+            doc.to_html( nil, "#{pass}/build/tests/protocols/" )
         end
     end
+
+    def render_index    
+
+        path = @project_root_directory
+
+        doc = @index
+        doc.to_console
+
+        doc.to_html("#{path}/build/")
+    end
 end

data/lib/almirah/templates/page.html

@@ -93,6 +93,7 @@
         border: 1px solid #bbb;
     }
     table.controlled td {
+        padding: 4px;
         text-align:center;
         vertical-align:middle;
         padding-right:10px;
@@ -197,8 +198,8 @@ function closeNav() {
 </head>
 <body>
     <div id="top_nav">
-        <a href="javascript:void(0)" onclick="openNav()"><span><i class="fa fa-bars" aria-hidden="true"></i></span>&nbsp;Navigation</a>
-        <a href="javascript:void(0)"> About</a>
+        <a href="./../../index.html"><span><i class="fa fa-home" aria-hidden="true"></i></span>&nbsp;Home</a>
+        <!--a href="javascript:void(0)"> About</a-->
     </div>
     <div id="main">
         <div id="nav_pane">

data/lib/almirah.rb

@@ -2,8 +2,8 @@ require "thor"
 require_relative "almirah/project"
 
 class CLI < Thor
-  desc "please <project_folder>", "say <project_folder>"
   option :results
+  desc "please <project_folder>", "say <project_folder>"
     def please(project_folder)
       a = Almirah.new project_folder
       if options[:results]
@@ -12,6 +12,12 @@ class CLI < Thor
         a.default
       end
     end
+
+  desc "transform <project_folder>", "say <project_folder>"
+  def transform(project_folder)
+    a = Almirah.new project_folder
+    a.transform "docx"
+  end
 end
 
 class Almirah
@@ -30,6 +36,10 @@ class Almirah
     @project.specifications_and_results test_run
   end
 
+  def transform( file_extension )
+    @project.transform file_extension
+  end
+
   def default()
     @project.specifications_and_protocols
   end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: Almirah
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.1.0
 platform: ruby
 authors:
 - Oleksandr Ivanov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-17 00:00:00.000000000 Z
+date: 2024-03-09 00:00:00.000000000 Z
 dependencies: []
-description: The software part of the Almirah system
+description: The software part of the Almirah framework
 email: oleksandr.ivanov.development@gmail.com
 executables:
 - almirah
@@ -30,8 +30,10 @@ files:
 - lib/almirah/doc_items/markdown_list.rb
 - lib/almirah/doc_items/markdown_table.rb
 - lib/almirah/doc_items/paragraph.rb
+- lib/almirah/doc_items/text_line.rb
 - lib/almirah/doc_types/base_document.rb
 - lib/almirah/doc_types/coverage.rb
+- lib/almirah/doc_types/index.rb
 - lib/almirah/doc_types/protocol.rb
 - lib/almirah/doc_types/specification.rb
 - lib/almirah/doc_types/traceability.rb
@@ -57,7 +59,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.5.6
 signing_key:
 specification_version: 4
 summary: Almirah