Almirah 0.2.2 → 0.2.3

data/lib/almirah/doc_parser.rb

@@ -24,10 +24,7 @@ class DocParser
       if s.lstrip != ''
         if res = /^(\#{1,})\s(.*)/.match(s) # Heading
 
-          if temp_md_table
-            doc.items.append temp_md_table
-            temp_md_table = nil
-          end
+          temp_md_table = process_temp_table(doc, temp_md_table)
           if temp_md_list
             doc.items.append temp_md_list
             temp_md_list = nil
@@ -58,10 +55,7 @@ class DocParser
 
         elsif res = /^\[(\S*)\]\s+(.*)/.match(s) # Controlled Paragraph
 
-          if temp_md_table
-            doc.items.append temp_md_table
-            temp_md_table = nil
-          end
+          temp_md_table = process_temp_table(doc, temp_md_table)
           if temp_md_list
             doc.items.append temp_md_list
             temp_md_list = nil
@@ -137,10 +131,7 @@ class DocParser
 
         elsif res = /^!\[(.*)\]\((.*)\)/.match(s) # Image
 
-          if temp_md_table
-            doc.items.append temp_md_table
-            temp_md_table = nil
-          end
+          temp_md_table = process_temp_table(doc, temp_md_table)
           if temp_md_list
             doc.items.append temp_md_list
             temp_md_list = nil
@@ -157,10 +148,7 @@ class DocParser
 
         elsif res = /^(\*\s+)(.*)/.match(s)   # check if unordered list start
 
-          if temp_md_table
-            doc.items.append temp_md_table
-            temp_md_table = nil
-          end
+          temp_md_table = process_temp_table(doc, temp_md_table)
 
           row = res[2]
 
@@ -174,10 +162,7 @@ class DocParser
 
         elsif res = /^\d[.]\s(.*)/.match(s)   # check if ordered list start
 
-          if temp_md_table
-            doc.items.append temp_md_table
-            temp_md_table = nil
-          end
+          temp_md_table = process_temp_table(doc, temp_md_table)
 
           row = res[1]
 
@@ -199,39 +184,50 @@ class DocParser
           if res = /^[|](-{3,})[|]/.match(s) # check if it is a separator first
 
             if temp_md_table
-            # separator is found after heading - just skip it
+            # separator is found after heading
+            temp_md_table.is_separator_detected = true
             else
               # separator out of table scope consider it just as a regular paragraph
-              item = Paragraph.new(s)
-              item.parent_doc = doc
-              item.parent_heading = doc.headings[-1]
+              item = Paragraph.new(doc, s)
               doc.items.append(item)
             end
 
-          elsif res = /^[|](.*[|])/.match(s) # check if it looks as a table
+          elsif res = /^[|](.*[|])/.match(s) # check if it looks as a table row
 
             row = res[1]
 
             if temp_md_table
-              # check if it is a controlled table
-              unless temp_md_table.addRow(row)
-                temp_md_table = ControlledTable.new(temp_md_table, doc)
-                temp_md_table.parent_doc = doc
+              if temp_md_table.is_separator_detected # if there is a separator
+                # check if parent doc is a Protocol
+                if doc.instance_of? Protocol
+                  # check if it is a controlled table
+                  tmp = /(.*)\s+>\[(\S*)\]/.match(row)
+                  if tmp && (temp_md_table.instance_of? MarkdownTable)
+                    # this is not a regular Markdown table
+                    # so the table type shall be changed and this row shall be passed one more time
+                    temp_md_table = ControlledTable.new(doc, temp_md_table)
+                  end
+                end
                 temp_md_table.addRow(row)
+              else
+                # replece table heading with regular paragraph
+                item = Paragraph.new(doc, temp_md_table.heading_row)
+                doc.items.append(item)
+                # and current row
+                item = Paragraph.new(doc, s)
+                doc.items.append(item)
+                temp_md_table = nil
               end
             else
               # start table from heading
-              temp_md_table = MarkdownTable.new(row)
-              temp_md_table.parent_doc = doc
+              temp_md_table = MarkdownTable.new(doc, s)
             end
           end
 
         elsif res = /^>(.*)/.match(s) # check if blockquote
 
-          if temp_md_table
-            doc.items.append temp_md_table
-            temp_md_table = nil
-          end
+          temp_md_table = process_temp_table(doc, temp_md_table)
+
           if temp_md_list
             doc.items.append temp_md_list
             temp_md_list = nil
@@ -244,10 +240,7 @@ class DocParser
 
         elsif res = /^```(\w*)/.match(s) # check if code block
 
-          if temp_md_table
-            doc.items.append temp_md_table
-            temp_md_table = nil
-          end
+          temp_md_table = process_temp_table(doc, temp_md_table)
           if temp_md_list
             doc.items.append temp_md_list
             temp_md_list = nil
@@ -268,10 +261,7 @@ class DocParser
 
         elsif res = /^TODO:(.*)/.match(s) # check if TODO block
 
-          if temp_md_table
-            doc.items.append temp_md_table
-            temp_md_table = nil
-          end
+          temp_md_table = process_temp_table(doc, temp_md_table)
           if temp_md_list
             doc.items.append temp_md_list
             temp_md_list = nil
@@ -286,10 +276,7 @@ class DocParser
           doc.todo_blocks.append(item)
 
         else # Reqular Paragraph
-          if temp_md_table
-            doc.items.append temp_md_table
-            temp_md_table = nil
-          end
+          temp_md_table = process_temp_table(doc, temp_md_table)
           if temp_md_list
             if MarkdownList.unordered_list_item?(s) || MarkdownList.ordered_list_item?(s)
               temp_md_list.addRow(s)
@@ -302,9 +289,7 @@ class DocParser
           if temp_code_block
             temp_code_block.code_lines.append(s)
           else
-            item = Paragraph.new(s)
-            item.parent_doc = doc
-            item.parent_heading = doc.headings[-1]
+            item = Paragraph.new(doc, s)
             doc.items.append(item)
           end
         end
@@ -314,10 +299,7 @@ class DocParser
       end
     end
     # Finalize non-closed elements
-    if temp_md_table
-      doc.items.append temp_md_table
-      temp_md_table = nil
-    end
+    temp_md_table = process_temp_table(doc, temp_md_table)
     if temp_md_list
       doc.items.append temp_md_list
       temp_md_list = nil
@@ -331,4 +313,18 @@ class DocParser
     item.parent_doc = doc
     doc.items.append(item)
   end
+
+  def self.process_temp_table(doc, temp_md_table) # rubocop:disable Metrics/MethodLength
+    if temp_md_table
+      if temp_md_table.is_separator_detected
+        doc.items.append temp_md_table
+      else # no separator
+        # replece table heading with regular paragraph
+        item = Paragraph.new(doc, temp_md_table.heading_row)
+        doc.items.append(item)
+      end
+      temp_md_table = nil
+    end
+    temp_md_table
+  end
 end

data/lib/almirah/doc_types/index.rb

@@ -26,15 +26,15 @@ class Index < BaseDocument
         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>Wrong<br>links</th>\n"
-        s += "\t\t<th>TODOs</th>\n"
-        s += "\t\t<th>Last Used<br>id</th>\n"
+        s += "\t\t<th title=\"Document title\">Title</th>\n"
+        s += "\t\t<th title=\"Number of Controlled Paragraphs\">Items</th>\n"
+        s += "\t\t<th title=\"Number of Controlled Paragraphs with up-links\">Items<br>w/ Up-links</th>\n"
+        s += "\t\t<th title=\"Number of references from other documents\">Items<br>w/ Down-links</th>\n"
+        s += "\t\t<th title=\"Number of Controlled Paragraphs mentioned in Test Cases\">Covered <br>by Tests</th>\n"
+        s += "\t\t<th title=\"Number of Controlled Paragraphs that have the same ID\">Duplicated<br>IDs</th>\n"
+        s += "\t\t<th title=\"Number of Controlled Paragraphs that link to non-existing items\">Wrong<br>links</th>\n"
+        s += "\t\t<th title=\"Number of 'TODO:' blocks in document\">TODOs</th>\n"
+        s += "\t\t<th title=\"The last Controlled Paragraph sequence number (ID) used in the document\">Last Used<br>ID</th>\n"
         s += "</thead>\n"
         html_rows.append s
 
@@ -51,11 +51,11 @@ class Index < BaseDocument
             if doc.duplicated_ids_number >0
                 s += "\t\t<td class=\"item_id\" style='width: 7%; background-color: #fcc;'>"
                 s += "<div id=\"DL_#{doc.id}\" style=\"display: block;\">"
-                s += "<a  href=\"#\" onclick=\"downlink_OnClick(this.parentElement); return false;\" class=\"external\">#{doc.duplicated_ids_number.to_s}</a>"
+                s += "<a  href=\"#\" onclick=\"downlink_OnClick(this.parentElement); return false;\" class=\"external\" title=\"Number of Controlled Paragraphs that have the same ID\">#{doc.duplicated_ids_number.to_s}</a>"
                 s += "</div>"
                 s += "<div id=\"DLS_#{doc.id}\" style=\"display: none;\">"
                 doc.duplicates_list.each do |lnk|
-                    s += "\t\t\t<a href=\"./specifications/#{doc.id}/#{doc.id}.html##{lnk.id}\" class=\"external\">#{lnk.id}</a>\n<br>"
+                    s += "\t\t\t<a href=\"./specifications/#{doc.id}/#{doc.id}.html##{lnk.id}\" class=\"external\" title=\"Controlled Paragraph with duplicated ID\">#{lnk.id}</a>\n<br>"
                 end
                 s += "</div>"
                 s += "</td>\n"
@@ -66,11 +66,11 @@ class Index < BaseDocument
             if doc.wrong_links_hash.length >0
                 s += "\t\t<td class=\"item_id\" style='width: 7%; background-color: #fcc;'>"
                 s += "<div id=\"DL_#{doc.id}wl\" style=\"display: block;\">"
-                s += "<a  href=\"#\" onclick=\"downlink_OnClick(this.parentElement); return false;\" class=\"external\">#{doc.wrong_links_hash.length.to_s}</a>"
+                s += "<a  href=\"#\" onclick=\"downlink_OnClick(this.parentElement); return false;\" class=\"external\" title=\"Number of Controlled Paragraphs that link to non-existing items\">#{doc.wrong_links_hash.length.to_s}</a>"
                 s += "</div>"
                 s += "<div id=\"DLS_#{doc.id}wl\" style=\"display: none;\">"
                 doc.wrong_links_hash.each do |wrong_lnk, item|
-                    s += "\t\t\t<a href=\"./specifications/#{doc.id}/#{doc.id}.html##{item.id}\" class=\"external\">#{wrong_lnk}</a>\n<br>"
+                    s += "\t\t\t<a href=\"./specifications/#{doc.id}/#{doc.id}.html##{item.id}\" class=\"external\" title=\"Controlled Paragraphs that link to non-existing items\">#{wrong_lnk}</a>\n<br>"
                 end
                 s += "</div>"
                 s += "</td>\n"
@@ -94,10 +94,10 @@ class Index < BaseDocument
         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>Coverage</th>\n"
-        s += "\t\t<th>Top Document</th>\n"
-        s += "\t\t<th>Bottom Document</th>\n"
+        s += "\t\t<th title=\"Traceability Matrix Title\">Title</th>\n"
+        s += "\t\t<th title=\"The ratio of Controlled Paragraphs mentioned in other documents and not-mentioned ones\">Coverage</th>\n"
+        s += "\t\t<th title=\"Document, that contains Cotroled Paragraphs to be referenced in Bottom document(s)\">Top Document</th>\n"
+        s += "\t\t<th title=\"Document(s), that contains references to Controlled Paragraphs from the Top Document\">Bottom Document</th>\n"
         s += "</thead>\n"
         html_rows.append s
 

data/lib/almirah/doc_types/specification.rb

@@ -1,104 +1,67 @@
-require_relative "persistent_document"
+# frozen_string_literal: true
 
-class Specification < PersistentDocument
-
-    attr_accessor :dictionary
-    attr_accessor :todo_blocks
-    attr_accessor :wrong_links_hash
-
-    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 :duplicates_list
-    attr_accessor :last_used_id
-    attr_accessor :last_used_id_number
-    attr_accessor :color
-
-    def initialize(fele_path)
-        super
-        @dictionary = Hash.new
-        @duplicates_list = Array.new
-        @todo_blocks = Array.new
-        @wrong_links_hash = 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
-
-        @color = 'bbb'
+require_relative 'persistent_document'
 
-        @id = File.basename(fele_path, File.extname(fele_path)).downcase
+class Specification < PersistentDocument
+  attr_accessor :dictionary, :todo_blocks, :wrong_links_hash, :items_with_uplinks_number, :items_with_downlinks_number,
+                :items_with_coverage_number, :duplicated_ids_number, :duplicates_list, :last_used_id,
+                :last_used_id_number, :color
+
+  def initialize(fele_path)
+    super
+    @dictionary = {}
+    @duplicates_list = []
+    @todo_blocks = []
+    @wrong_links_hash = {}
+
+    @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
+
+    @color = 'bbb'
+
+    @id = File.basename(fele_path, File.extname(fele_path)).downcase
+  end
+
+  def to_console
+    puts ''
+    puts "\e[33mSpecification: #{@title}\e[0m"
+    puts '-' * 53
+    puts '| Number of Controlled Items           | %10d |' % @controlled_items.length
+    puts format('| Number of Items w/ Up-links          | %10d |', @items_with_uplinks_number)
+    puts format('| Number of Items w/ Down-links        | %10d |', @items_with_downlinks_number)
+
+    # coverage
+    if @controlled_items.length.positive? && (@controlled_items.length == @items_with_coverage_number)
+      puts format("| Number of Items w/ Test Coverage     |\e[1m\e[32m %10d \e[0m|", @items_with_coverage_number)
+    else
+      puts format('| Number of Items w/ Test Coverage     | %10d |', @items_with_coverage_number)
     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
+    # duplicates
+    if @duplicated_ids_number.positive?
+      puts format("| Duplicated Item Ids found            |\e[1m\e[31m %10d \e[0m|", @duplicated_ids_number)
+    else
+      puts format('| Duplicated Item Ids found            | %10d |', @duplicated_ids_number)
     end
 
-    def to_html(nav_pane, output_file_path)
+    puts format("| Last used Item Id                    |\e[1m\e[37m %10s \e[0m|", @last_used_id)
+    puts '-' * 53
+  end
 
-        html_rows = Array.new
+  def to_html(nav_pane, output_file_path)
+    html_rows = []
 
-        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
+    html_rows.append('')
 
-    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
+    @items.each do |item|
+      a = item.to_html
+      html_rows.append a
     end
 
-end
+    save_html_to_file(html_rows, nav_pane, output_file_path)
+  end
+end

data/lib/almirah/dom/doc_section.rb

@@ -12,7 +12,7 @@ class DocSection
 
     def to_html
         s = ''
-        s += "\t<li><span class=\"fa-li\"><i class=\"fa fa-sticky-note-o\"> </i></span>"
+        s += "\t<li><span class=\"fa-li\"><i class=\"fa fa-square-o\"> </i></span>"
         s += "<a href=\"\#" + @heading.anchor_id.to_s + "\">" + @heading.get_section_info + "</a>\n"
         if @sections.length >0
             s += "\t\t<ul class=\"fa-ul\">\n"

data/lib/almirah/search/specifications_db.rb

@@ -23,7 +23,9 @@ class SpecificationsDb
                     }
                     @data.append e                    
                 elsif i.instance_of? MarkdownList
-                    e = add_markdown_list_item_to_db( @data, i, i)    
+                    e = add_markdown_list_item_to_db( @data, i, i)
+                elsif i.instance_of? MarkdownTable
+                    add_markdown_table_item_to_db( @data, i, i)    
                 end
             end
         end
@@ -56,6 +58,21 @@ class SpecificationsDb
         return e
     end
 
+    def add_markdown_table_item_to_db(data, item_for_reference, item_to_process)
+        e = nil
+        table_text = ""
+        item_to_process.rows.each do |row|
+            table_text += "| " + row.join(" | ") + " |"
+        end
+        e = {   "document" => item_for_reference.parent_doc.title, \
+                "doc_color" => item_for_reference.parent_doc.color, \
+                "text" => table_text, \
+                "heading_url" => item_for_reference.parent_heading.get_url(), \
+                "heading_text" => item_for_reference.parent_heading.get_section_info()
+            }
+        data << e
+    end
+
     def save(path)
         json = JSON.generate(@data)
 

data/lib/almirah/templates/css/main.css

@@ -223,13 +223,16 @@ img{
     font-family: "Trebuchet MS", Verdana, sans-serif;
 }
 #top_nav a:hover {
-    background-color: black;
-    color:  white;
+    background-color: #169;
+    color:  #eee;
 }
 #top_nav a.active {
     background-color: #169;
     color: white;
 }
+#top_nav a:focus {
+    text-decoration: underline;
+}
 #searchInput{
     float: left;
     margin: 4px 6px;

data/lib/almirah/templates/page.html

@@ -9,7 +9,9 @@
 </head>
 <body>
     <div id="top_nav">
-        <a href="javascript:void(0)" onclick="navigate_to_home()"><span><i class="fa fa-home" aria-hidden="true"></i></span>&nbsp;Home</a>
+        <a id="home_menu_item" href="javascript:void(0)" onclick="navigate_to_home()"><span><i class="fa fa-home" aria-hidden="true"></i></span>&nbsp;Home</a>
+        <a id="index_menu_item" href="javascript:void(0)" onclick="navigate_to_home()" style="display: none;"><span><i class="fa fa-chevron-left" aria-hidden="true"></i></span>&nbsp;Index</a>
+        <a id="document_tree_menu_item" href="javascript:void(0)" onclick="openNav()" style="display: none;"><span><i class="fa fa-bars" aria-hidden="true"></i></span>&nbsp;Document Tree</a>
         <input type="text" id="searchInput" placeholder="Search.." style="display: none;">
         <a class="split">{{DOCUMENT_TITLE}}</a>
     </div>

data/lib/almirah/templates/scripts/main.js

@@ -1,5 +1,9 @@
 function openNav() {
-    document.getElementById("nav_pane").style.visibility = "visible";
+    if (document.getElementById("nav_pane").style.visibility == "visible"){
+      document.getElementById("nav_pane").style.visibility = "hidden";
+    }else{
+      document.getElementById("nav_pane").style.visibility = "visible";
+    }
   }
   
   function closeNav() {
@@ -15,8 +19,21 @@ function openNav() {
           elem.style.width = "640px";
       }
     }
-    if ((document.title == "Document Index") && (document.URL.includes('http'))){
-      document.getElementById("searchInput").style.display = "block";
+    if (document.title == "Document Index"){
+      document.getElementById('document_tree_menu_item').style.display = "none";
+      document.getElementById('home_menu_item').style.display = "block";
+      document.getElementById('index_menu_item').style.display = "none";
+      if (document.URL.includes('http')){
+        document.getElementById("searchInput").style.display = "block";
+      }
+    }else{
+      document.getElementById('home_menu_item').style.display = "none";
+      document.getElementById('index_menu_item').style.display = "block";
+      if (document.title.includes("Traceability Matrix:")){
+        document.getElementById('document_tree_menu_item').style.display = "none";
+      } else {
+        document.getElementById('document_tree_menu_item').style.display = "block";
+      }
     }
     // Scroll a bit to make navigated anchor visible
     //setTimeout(function() {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: Almirah
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Oleksandr Ivanov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-20 00:00:00.000000000 Z
+date: 2024-06-23 00:00:00.000000000 Z
 dependencies: []
 description: The software part of the Almirah framework
 email: oleksandr.ivanov.development@gmail.com