Almirah 0.0.7 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 877a4c7b296af5fa0418113a4287df82661d23903764f73a74b8794d2be22d9a
-  data.tar.gz: 4195b1434e0ca4c75177c4af9ea3e97ffa9a373106bda58fa11621ba273df7cf
+  metadata.gz: 9e500204a8575e500989c7d86e4db4dff7a6247b14d3768904620be7a3cef356
+  data.tar.gz: a12d76101a33fc1938c0c42d361f84ae9a8c796684becd1567e154e67f345cad
 SHA512:
-  metadata.gz: 4425611cadee99f5686c79abbc853d93bbfeb0e729a97168f93842d998daf8e1a879de8e25918fcbd01bd49abe2b842cc192f24d137cd987d77816f606abed15
-  data.tar.gz: ca609c497ebde13428c516a0369f860c323f7bcaba740424d125b9a3c4bd2e1955f8f8aec665d6afd088cc44772c4edfaba5dc64f47827be631253111f82a446
+  metadata.gz: eff42c3d45f0be71488484ce864740c5363e9169450d32469b9044136ea47af2989b32c4cb526c176c4d4721e60be0c5f484db8ed2245285eb042187a9c5df57
+  data.tar.gz: 2e5c4887b584428a71db8cbd33d244242c90df9b7b02aca8804f72f97fb017dfebc4aa8ff2ae52f924ae9895f7ac1b075cac2407ba84888db55cd36d97984344

data/lib/almirah/doc_fabric.rb

@@ -52,6 +52,7 @@ class DocFabric
                     level = res[1].length
                     value = res[2]
                     item = Heading.new(value, level)
+                    item.parent_doc = doc
                     doc.items.append(item)
                     doc.headings.append(item)
 
@@ -85,12 +86,25 @@ class DocFabric
                     end
 
                     item = ControlledParagraph.new( text, id )
-                    item.up_link = up_link
+                    item.parent_doc = doc
+                    if up_link
+                         item.up_link = up_link
+                         doc.items_with_uplinks_number += 1     #for statistics
+                    end
 
                     doc.items.append(item)
                     doc.dictionary[ id.to_s ] = item       #for fast search
                     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.duplicated_ids_number += 1
+                    elsif n > doc.last_used_id_number
+                        doc.last_used_id = id
+                        doc.last_used_id_number = n
+                    end
+
                 elsif res = /^[!]\[(.*)\]\((.*)\)/.match(s)     # Image
 
                     if tempMdTable
@@ -106,10 +120,11 @@ class DocFabric
                     img_path = res[2]
 
                     item = Image.new( img_text, img_path )
+                    item.parent_doc = doc
 
                     doc.items.append(item)
 
-                elsif res = /^(\*\s?)+(.*)/.match(s)   #check if bullet list
+                elsif res = /^(\*\s?)(.*)/.match(s)   #check if unordered list start
                     
                     if tempMdTable
                         doc.items.append tempMdTable
@@ -121,7 +136,27 @@ class DocFabric
                     if tempMdList
                         tempMdList.addRow(row)
                     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(row)
+                    else
+                        item = MarkdownList.new(true)
+                        item.addRow(s)
+                        item.parent_doc = doc
                         tempMdList = item
                     end
 
@@ -139,6 +174,7 @@ class DocFabric
                         else
                             #separator out of table scope consider it just as a regular paragraph
                             item = Paragraph.new(s)
+                            item.parent_doc = doc
                             doc.items.append(item)
                         end
 
@@ -150,11 +186,13 @@ class DocFabric
                             # check if it is a controlled table
                             unless tempMdTable.addRow(row)
                                 tempMdTable = ControlledTable.new(tempMdTable, doc)
+                                tempMdTable.parent_doc = doc
                                 tempMdTable.addRow(row)
                             end
                         else
                             #start table from heading
                             tempMdTable = MarkdownTable.new(row)
+                            tempMdTable.parent_doc = doc
                         end
                     end
 
@@ -170,6 +208,7 @@ class DocFabric
                     end 
 
                     item = Blockquote.new(res[1])
+                    item.parent_doc = doc
                     doc.items.append(item)
 
                 else # Reqular Paragraph
@@ -178,13 +217,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

@@ -8,7 +8,7 @@ class ControlledParagraph < Paragraph
     attr_accessor :coverage_links
 
     def initialize(text, id)
-        @text = text
+        @text = text.strip
         @id = id
         @up_link = nil
         @down_links = nil
@@ -22,15 +22,16 @@ class ControlledParagraph < Paragraph
             s += "\t<thead> <th>#</th> <th>Text</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}\"></a>#{@id} </td>\n"
-        s += "\t\t<td class=\"item_text\">#{@text}</td>\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\">#{f_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"
+            s += "\t\t<td class=\"item_id\"><a href=\"./../#{up_link_doc_name}/#{up_link_doc_name}.html##{@up_link}\" class=\"external\">#{@up_link}</a></td>\n"
         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
 
@@ -23,15 +24,17 @@ end
 class TestStepNumberColumn < ControlledTableColumn
 
     attr_accessor :step_number
+    attr_accessor :row_id
     
     def initialize(text)
         text = text.strip
         @step_number = text.to_i
         @text =  text
+        @row_id = ""
     end
 
     def to_html
-        "\t\t<td style=\"text-align: center;\">#{@text}</td>\n\r"
+        "\t\t<td style=\"text-align: center;\"><a name=\"#{@row_id}\" id=\"#{@row_id}\" href=\"##{@row_id}\">#{@text}</a></td>\n\r"
     end
 end 
 
@@ -39,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
@@ -70,7 +74,7 @@ class TestStepReferenceColumn <  ControlledTableColumn
 
     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"
+            "\t\t<td class=\"item_id\"><a href=\"./../../../specifications/#{@up_link_doc_id}/#{@up_link_doc_id}.html##{@up_link}\" class=\"external\">#{@up_link}</a></td>\n\r"
         else
             "\t\t<td style=\"text-align: center;\"></td>\n\r"
         end
@@ -83,7 +87,6 @@ class ControlledTable < DocItem
 
     attr_accessor :column_names
     attr_accessor :rows
-    attr_accessor :parent_doc
 
     def initialize(markdown_table, parent_doc)
         @parent_doc = parent_doc
@@ -108,6 +111,7 @@ class ControlledTable < DocItem
     def format_columns(columns)
 
         new_row = ControlledTableRow.new
+        new_row.parent_doc = @parent_doc
 
         columns.each_with_index do | element, index |
 
@@ -116,6 +120,7 @@ class ControlledTable < DocItem
                 col = TestStepNumberColumn.new element
                 new_row.columns.append col
                 new_row.id = @parent_doc.id + '.' + col.text
+                col.row_id = new_row.id
 
             elsif index + 1 == columns.length # it is expected that a link is placed to the last column only
                 

data/lib/almirah/doc_items/doc_item.rb

@@ -1,4 +1,10 @@
-class DocItem
+require_relative "text_line"
+
+class DocItem < TextLine
+    attr_accessor :parent_doc
+    
+    @parent_doc = nil
+
     @@htmlTableRenderInProgress = false
 end
 

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/markdown_list.rb

@@ -3,14 +3,107 @@ 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)
+        puts 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)
+        pos = 0
+        s.each_char do |c|
+            if non_blank?(c)
+                break
+            end
+            pos += 1
+        end
+        return pos
+    end
+    def calculate_text_position(s)
+        pos = 0
+        s.each_char do |c|
+            if letter?(c)
+                break
+            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 +113,29 @@ 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)
+                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,169 @@
+class TextLine
+
+    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
+                    state = 'first_asterisk_detected'
+
+                elsif state == 'first_asterisk_detected'
+                    prev_state = state
+                    state = 'second_asterisk_detected'
+                
+                elsif state == 'second_asterisk_detected'
+                    prev_state = state
+                    state = 'third_asterisk_detected'
+                
+                elsif state == 'second_asterisk_detected'
+                    prev_state = state
+                    state = 'third_asterisk_detected' 
+
+                elsif state == 'italic_started'
+                    prev_state = state
+                    state = 'default'
+                    result += italic(stack)
+
+                elsif state == 'bold_started'
+                    prev_state = state
+                    state = 'first_asterisk_after_bold_detected'
+
+                elsif state == 'first_asterisk_after_bold_detected'
+                    prev_state = state
+                    state = 'default'
+                    result += bold(stack)
+
+                elsif state == 'bold_and_italic_started'
+                    prev_state = state
+                    state = 'first_asterisk_after_bold_and_italic_detected'
+
+                elsif state == 'first_asterisk_after_bold_and_italic_detected'
+                    prev_state = state
+                    state = 'second_asterisk_after_bold_and_italic_detected'
+
+                elsif state == 'second_asterisk_after_bold_and_italic_detected'
+                    prev_state = state
+                    state = 'default'
+                    result += bold_and_italic(stack)
+
+                else
+                end
+            elsif c == '['
+                if state == 'default'
+                    prev_state = state
+                    state = 'square_bracket_left_detected'
+                else
+                end
+            elsif c == ']'
+                if state == 'square_bracket_left_detected'
+                    prev_state = state
+                    state = 'default'
+                    result += '[]'
+
+                elsif state == 'link_text_started'
+                    prev_state = state
+                    state = 'square_bracket_right_detected'
+                    link_text = stack
+
+                else
+                end
+            elsif c == '('
+                if state == 'square_bracket_right_detected'
+                    prev_state = state
+                    state = 'brace_left_detected'
+                else
+                end
+            elsif c == ')'
+                if state == 'brace_left_detected'
+                    prev_state = state
+                    state = 'default'
+                    result += '()'
+
+                elsif state == 'link_url_started'
+                    prev_state = state
+                    state = 'default'
+                    link_url = stack
+                    result += link(link_text, link_url)
+
+                else
+                end
+            else
+                if state == 'default'
+                    result += c
+                else
+                    if state == 'first_asterisk_detected'
+                        prev_state = state
+                        state = 'italic_started'
+                        stack = ''
+
+                    elsif state == 'second_asterisk_detected'
+                        prev_state = state
+                        state = 'bold_started'
+                        stack = ''
+
+                    elsif state == 'third_asterisk_detected'
+                        prev_state = state
+                        state = 'bold_and_italic_started'
+                        stack = ''
+                    
+                    elsif state == 'first_asterisk_after_bold_detected'
+                        prev_state = state
+                        state = 'bold_started'
+
+                    elsif state == 'first_asterisk_after_bold_and_italic_detected'
+                        prev_state = state
+                        state = 'bold_and_italic_started'
+
+                    elsif state == 'second_asterisk_after_bold_and_italic_detected'
+                        prev_state = state
+                        state = 'bold_and_italic_started'
+
+                    elsif state == 'square_bracket_left_detected'
+                        prev_state = state
+                        state = 'link_text_started'
+                        stack = ''
+
+                    elsif state == 'square_bracket_right_detected'
+                        prev_state = state
+                        state = 'default'
+                        result += stack + c
+                        c = ''
+
+                    elsif state == 'brace_left_detected'
+                        prev_state = state
+                        state = 'link_url_started'
+                        stack = ''
+
+                    else
+                    end
+                    stack += c
+                end
+            end
+            prev_c = c
+        end
+        return result
+    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)
+        "<a href=\"#{link_url}\" class=\"external\">#{link_text}</a>"
+    end
+end

data/lib/almirah/doc_types/base_document.rb

@@ -15,4 +15,31 @@ class BaseDocument
         @title = ""
         @id = ""
     end
+
+    def save_html_to_file html_rows, nav_pane, output_file_path
+
+        gem_root = File.expand_path './../../..', File.dirname(__FILE__)
+        template_file =  gem_root + "/lib/almirah/templates/page.html"
+
+        file = File.open( template_file )
+        file_data = file.readlines
+        file.close
+
+        output_file_path += "#{@id}/#{@id}.html"
+        file = File.open( output_file_path, "w" )
+        file_data.each do |s|
+            if s.include?('{{CONTENT}}')
+                html_rows.each do |r|
+                    file.puts r
+                end
+            elsif s.include?('{{NAV_PANE}}')
+                if nav_pane
+                    file.puts nav_pane.to_html
+                end
+            else
+                file.puts s
+            end
+        end
+        file.close
+    end
 end

data/lib/almirah/doc_types/coverage.rb

@@ -0,0 +1,82 @@
+require_relative "base_document"
+
+class Coverage < BaseDocument
+
+    attr_accessor :top_doc
+    attr_accessor :bottom_doc
+    attr_accessor :items
+
+    def initialize(top_doc)
+
+        @top_doc = top_doc
+        @bottom_doc = bottom_doc
+
+        @items = Array.new
+        @headings = Array.new
+
+        @id = top_doc.id + "-" + "tests"
+        @title = "Coverage Matrix: " + @id
+    end
+
+    def to_console
+        puts "\e[35m" + "Traceability: " + @id + "\e[0m"
+    end
+
+    def to_html(nav_pane, output_file_path)
+
+        html_rows = Array.new
+
+        html_rows.append('')
+        s = "<h1>#{@title}</h1>\n"
+        s += "<table class=\"controlled\">\n"
+        s += "\t<thead> <th>#</th> <th style='font-weight: bold;'>#{@top_doc.title}</th> <th>#</th> <th style='font-weight: bold;'>Test CaseId.StepId</th> </thead>\n"
+        html_rows.append s
+
+        sorted_items = @top_doc.controlled_items.sort_by { |w| w.id }
+
+        sorted_items.each do |top_item|
+            row = render_table_row top_item
+            html_rows.append row
+        end
+        html_rows.append "</table>\n"
+
+        self.save_html_to_file(html_rows, nav_pane, output_file_path)
+        
+    end
+
+    def render_table_row(top_item)
+        s = ""
+        if top_item.coverage_links
+            if top_item.coverage_links.length > 1
+                id_color = "" # "style='background-color: #fff8c5;'" # disabled for now
+            else
+                id_color = ""
+            end 
+            top_item.coverage_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"
+                
+                if bottom_item.columns[-2].text.downcase == "pass"
+                    test_step_color = "style='background-color: #cfc;'"
+                elsif bottom_item.columns[-2].text.downcase == "fail"
+                    test_step_color = "style='background-color: #fcc;'"
+                else
+                    test_step_color = ""
+                end
+
+                s += "\t\t<td class=\"item_id\" #{test_step_color}><a href=\"./../../tests/protocols/#{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.columns[1].text}</td>\n"
+                s += "\t</tr>\n"
+            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_id\"></td>\n"
+            s += "\t\t<td class=\"item_text\" style='width: 42%;'></td>\n"
+            s += "\t</tr>\n"
+        end
+        return s
+    end
+end

data/lib/almirah/doc_types/protocol.rb

@@ -19,4 +19,19 @@ class Protocol < BaseDocument
         @up_link_doc_id = ""
     end
 
+    def to_html(nav_pane, output_file_path)
+
+        html_rows = Array.new
+
+        html_rows.append('')
+
+        @items.each do |item|    
+            a = item.to_html
+            html_rows.append a
+        end
+
+        self.save_html_to_file(html_rows, nav_pane, output_file_path)
+        
+    end
+
 end

data/lib/almirah/doc_types/specification.rb

@@ -6,6 +6,13 @@ class Specification < BaseDocument
     attr_accessor :dictionary
     attr_accessor :controlled_items
 
+    attr_accessor :items_with_uplinks_number
+    attr_accessor :items_with_downlinks_number
+    attr_accessor :items_with_coverage_number
+    attr_accessor :duplicated_ids_number
+    attr_accessor :last_used_id
+    attr_accessor :last_used_id_number
+
     def initialize(fele_path)
 
         @path = fele_path
@@ -15,8 +22,82 @@ class Specification < BaseDocument
         @controlled_items = Array.new
         @dictionary = Hash.new
 
+        @items_with_uplinks_number = 0
+        @items_with_downlinks_number = 0
+        @items_with_coverage_number = 0
+        @duplicated_ids_number = 0
+        @last_used_id = ""
+        @last_used_id_number = 0
+
         @id = File.basename(fele_path, File.extname(fele_path)).downcase
         @up_link_doc_id = ""
     end
 
+    def to_console
+        puts ""
+        puts "\e[33m" + "Specification: " + @title + "\e[0m"
+        puts "-" * 53
+        puts "| Number of Controlled Items           | %10d |" % @controlled_items.length
+        puts "| Number of Items w/ Up-links          | %10d |" % @items_with_uplinks_number
+        puts "| Number of Items w/ Down-links        | %10d |" % @items_with_downlinks_number
+
+        # coverage
+        if (@controlled_items.length > 0) && (@controlled_items.length == @items_with_coverage_number)
+            puts "| Number of Items w/ Test Coverage     |\e[1m\e[32m %10d \e[0m|" % @items_with_coverage_number
+        else
+            puts "| Number of Items w/ Test Coverage     | %10d |" % @items_with_coverage_number
+        end
+
+        # duplicates
+        if @duplicated_ids_number >0
+            puts "| Duplicated Item Ids found            |\e[1m\e[31m %10d \e[0m|" % @duplicated_ids_number
+        else
+            puts "| Duplicated Item Ids found            | %10d |" % @duplicated_ids_number
+        end
+        
+        puts "| Last used Item Id                    |\e[1m\e[37m %10s \e[0m|" % @last_used_id
+        puts "-" * 53
+    end
+
+    def to_html(nav_pane, output_file_path)
+
+        html_rows = Array.new
+
+        html_rows.append('')
+
+        @items.each do |item|    
+            a = item.to_html
+            a = adjust_internal_links(a, nav_pane.specifications)
+            html_rows.append a
+        end
+
+        self.save_html_to_file(html_rows, nav_pane, output_file_path)
+        
+    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

@@ -0,0 +1,73 @@
+require_relative "base_document"
+
+class Traceability < BaseDocument
+
+    attr_accessor :top_doc
+    attr_accessor :bottom_doc
+    attr_accessor :items
+
+    def initialize(top_doc, bottom_doc)
+
+        @top_doc = top_doc
+        @bottom_doc = bottom_doc
+
+        @items = Array.new
+        @headings = Array.new
+
+        @id = top_doc.id + "-" + bottom_doc.id
+        @title = "Traceability Matrix: " + @id
+    end
+
+    def to_console
+        puts "\e[35m" + "Traceability: " + @id + "\e[0m"
+    end
+
+    def to_html(nav_pane, output_file_path)
+
+        html_rows = Array.new
+
+        html_rows.append('')
+        s = "<h1>#{@title}</h1>\n"
+        s += "<table class=\"controlled\">\n"
+        s += "\t<thead> <th>#</th> <th style='font-weight: bold;'>#{@top_doc.title}</th> <th>#</th> <th style='font-weight: bold;'>#{@bottom_doc.title}</th> </thead>\n"
+        html_rows.append s
+
+        sorted_items = @top_doc.controlled_items.sort_by { |w| w.id }
+
+        sorted_items.each do |top_item|
+            row = render_table_row top_item
+            html_rows.append row
+        end
+        html_rows.append "</table>\n"
+
+        self.save_html_to_file(html_rows, nav_pane, output_file_path)
+        
+    end
+
+    def render_table_row(top_item)
+        s = ""
+        if top_item.down_links
+            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|
+                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"
+            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_id\"></td>\n"
+            s += "\t\t<td class=\"item_text\" style='width: 42%;'></td>\n"
+            s += "\t</tr>\n"
+        end
+        return s
+    end
+end

data/lib/almirah/project.rb

@@ -1,20 +1,20 @@
+require 'fileutils'
 require_relative "doc_fabric"
-require_relative "html_render"
 require_relative "navigation_pane"
+require_relative "doc_types/traceability"
+require_relative "doc_types/coverage"
 
 class Project
 
     attr_accessor :specifications
     attr_accessor :protocols
     attr_accessor :project_root_directory
-    attr_accessor :gem_root
     attr_accessor :specifications_dictionary
 
-    def initialize(path, gem_root)
+    def initialize(path)
         @project_root_directory = path
         @specifications = Array.new
         @protocols = Array.new
-        @gem_root = gem_root
         @specifications_dictionary = Hash.new
         
         FileUtils.remove_dir(@project_root_directory + "/build", true)      
@@ -102,14 +102,14 @@ class Project
                 
                 unless topItem.down_links
                     topItem.down_links = Array.new
+                    top_document.items_with_downlinks_number += 1   # for statistics
                 end
                 topItem.down_links.append(item)
-
-                #if tmp = /^([a-zA-Z]+)[-]\d+/.match(item.id)
-                #    top_document.downlinkKey = tmp[1].upcase
-                #end
             end
         end
+        # create treceability document
+        trx = Traceability.new top_document, bottom_document
+        @specifications.append trx
     end
 
     def link_protocol_to_spec(protocol, specification)
@@ -125,10 +125,14 @@ class Project
                 
                 unless topItem.coverage_links
                     topItem.coverage_links = Array.new
+                    top_document.items_with_coverage_number += 1    # for statistics
                 end
                 topItem.coverage_links.append(item)
             end
         end
+        # create coverage document
+        trx = Coverage.new top_document
+        @specifications.append trx
     end
 
     def render_all_specifications
@@ -142,6 +146,8 @@ class Project
     
         @specifications.each do |doc|
 
+            doc.to_console
+
             img_src_dir = pass + "/specifications/" + doc.id + "/img"
             img_dst_dir = pass + "/build/specifications/" + doc.id + "/img"
      
@@ -151,16 +157,14 @@ class Project
                 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" )
+            doc.to_html( nav_pane, "#{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
 
@@ -178,9 +182,7 @@ class Project
                 FileUtils.copy_entry( img_src_dir, img_dst_dir )
             end
 
-            HtmlRender.new( doc, nil,
-            @gem_root + "/lib/almirah/templates/page.html",
-            "#{pass}/build/tests/protocols/#{doc.id}/#{doc.id}.html" )
+            doc.to_html( nav_pane, "#{pass}/build/tests/protocols/" )
         end
     end
 end

data/lib/almirah/templates/page.html

@@ -126,6 +126,13 @@
     a, a:link, a:visited {
         color: #169;
         text-decoration: none;
+        display: inline-block;
+    }
+    a:active {
+        color: #555;
+        background-color:#deb887;
+        text-decoration: none;
+        display: inline-block;
     }
     div.blockquote {
         display: block;

data/lib/almirah.rb

@@ -18,11 +18,11 @@ class Almirah
 
   attr_accessor :project
 
-  def initialize project_folder
-    @project = Project.new project_folder, getGemRoot
+  def initialize(project_folder)
+    @project = Project.new project_folder
   end
 
-  def getGemRoot
+  def getGemRoot()
     File.expand_path './..', File.dirname(__FILE__)
   end
 
@@ -30,7 +30,7 @@ class Almirah
     @project.specifications_and_results test_run
   end
 
-  def default
+  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.7
+  version: 0.0.9
 platform: ruby
 authors:
 - Oleksandr Ivanov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-10 00:00:00.000000000 Z
+date: 2024-03-03 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,10 +30,12 @@ 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/protocol.rb
 - lib/almirah/doc_types/specification.rb
-- lib/almirah/html_render.rb
+- lib/almirah/doc_types/traceability.rb
 - lib/almirah/navigation_pane.rb
 - lib/almirah/project.rb
 - lib/almirah/templates/page.html
@@ -56,7 +58,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

data/lib/almirah/html_render.rb

@@ -1,54 +0,0 @@
-
-class HtmlRender
-
-    attr_accessor :template
-    attr_accessor :htmlRows
-    attr_accessor :outputFile
-    attr_accessor :document
-    attr_accessor :nav_pane
-
-    def initialize(document, nav_pane, template, outputFile)
-
-        @template = template
-        @outputFile = outputFile
-        @htmlRows = Array.new
-        @document = document
-        @nav_pane = nav_pane
-
-        self.render()
-        self.saveRenderToFile()
-    end
-
-    def render()
-        self.htmlRows.append('')
-
-        self.document.items.each do |item|    
-            a = item.to_html
-            self.htmlRows.append a
-        end
-    end
-
-    def saveRenderToFile()
-
-        file = File.open( self.template )
-        file_data = file.readlines
-        file.close
-
-        file = File.open( self.outputFile, "w" )
-        file_data.each do |s|
-            if s.include?('{{CONTENT}}')
-                self.htmlRows.each do |r|
-                    file.puts r
-                end
-            elsif s.include?('{{NAV_PANE}}')
-                if @nav_pane
-                    file.puts self.nav_pane.to_html
-                end
-            else
-                file.puts s
-            end
-        end
-        file.close
-    end
-
-end