Almirah 0.0.6 → 0.0.8

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

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

@@ -0,0 +1,77 @@
+require_relative "base_document"
+
+class Specification < BaseDocument
+
+    attr_accessor :up_link_doc_id
+    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
+        @title = ""
+        @items = Array.new
+        @headings = Array.new
+        @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
+            html_rows.append a
+        end
+
+        self.save_html_to_file(html_rows, nav_pane, output_file_path)
+        
+    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/navigation_pane.rb

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

data/lib/almirah/project.rb

@@ -1,57 +1,99 @@
-require_relative "doc_items/doc_item"
-require_relative "specification"
-require_relative "html_render"
+require_relative "doc_fabric"
 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
-        @gem_root = gem_root
+        @protocols = Array.new
         @specifications_dictionary = Hash.new
         
-        parse_all_documents()
-        link_all_specifications()
-        render_all_specifications()
-       
+        FileUtils.remove_dir(@project_root_directory + "/build", true)      
     end
 
-    def parse_all_documents
-        
-        Dir.glob( "#{@project_root_directory}/**/*.md" ).each do |f|
-            puts f
-            spec = Specification.new(f)
-            @specifications.append(spec)
+    def specifications_and_protocols
+
+        parse_all_specifications
+        parse_all_protocols
+        link_all_specifications
+        link_all_protocols
+        render_all_specifications
+        render_all_protocols
+    end
+
+    def specifications_and_results( test_run )
+
+        parse_all_specifications
+        parse_test_run test_run
+        link_all_specifications
+        link_all_protocols
+        render_all_specifications
+        render_all_protocols
+    end
+
+    def parse_all_specifications        
+        Dir.glob( "#{@project_root_directory}/specifications/**/*.md" ).each do |f|
+            puts "Spec: " + f
+            doc = DocFabric.create_specification(f)
+            @specifications.append(doc)
+        end
+    end
+
+    def parse_all_protocols
+        Dir.glob( "#{@project_root_directory}/tests/protocols/**/*.md" ).each do |f|
+            puts "Prot: " + f
+            doc = DocFabric.create_protocol(f)
+            @protocols.append(doc)
+        end
+    end
+
+    def parse_test_run( test_run )
+        Dir.glob( "#{@project_root_directory}/tests/runs/#{test_run}/**/*.md" ).each do |f|
+            puts "Run: " + f
+            doc = DocFabric.create_protocol(f)
+            @protocols.append(doc)
         end
     end
 
     def link_all_specifications
         combList = @specifications.combination(2)
         combList.each do |c|
-            self.link_two_specifications(c[0], c[1])
+            link_two_specifications(c[0], c[1])
+        end
+    end
+
+    def link_all_protocols
+        @protocols.each do |p|
+            @specifications.each do |s|
+                if s.id == p.up_link_doc_id
+                    link_protocol_to_spec(p,s)
+                end
+            end
         end
     end
 
     def link_two_specifications(doc_A, doc_B)
 
-        if doc_A.key == doc_B.up_link_key
+        if doc_A.id == doc_B.up_link_doc_id
             top_document = doc_A
             bottom_document = doc_B
-        elsif doc_B.key == doc_A.up_link_key
+        elsif doc_B.id == doc_A.up_link_doc_id
             top_document = doc_B
             bottom_document = doc_A
         else
             puts "No Links"
             return # no links
         end
-
-        bottom_document.controlledParagraphs.each do |item|
+        
+        bottom_document.controlled_items.each do |item|
 
             if top_document.dictionary.has_key?(item.up_link.to_s)
 
@@ -59,14 +101,37 @@ 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)
+            end
+        end
+        # create treceability document
+        trx = Traceability.new top_document, bottom_document
+        @specifications.append trx
+    end
+
+    def link_protocol_to_spec(protocol, specification)
+
+        top_document = specification
+        bottom_document = protocol
 
-                #if tmp = /^([a-zA-Z]+)[-]\d+/.match(item.id)
-                #    top_document.downlinkKey = tmp[1].upcase
-                #end
+        bottom_document.controlled_items.each do |item|
+
+            if top_document.dictionary.has_key?(item.up_link.to_s)
+
+                topItem = top_document.dictionary[item.up_link.to_s]
+                
+                unless topItem.coverage_links
+                    topItem.coverage_links = Array.new
+                    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
@@ -76,13 +141,39 @@ class Project
 
         pass = @project_root_directory
 
-        FileUtils.remove_dir(pass + "/build", true)
         FileUtils.mkdir_p(pass + "/build/specifications")
     
-        @specifications.each do |spec|
+        @specifications.each do |doc|
+
+            doc.to_console
+
+            img_src_dir = pass + "/specifications/" + doc.id + "/img"
+            img_dst_dir = pass + "/build/specifications/" + doc.id + "/img"
+     
+            FileUtils.mkdir_p(img_dst_dir)
+
+            if File.directory?(img_src_dir)
+                FileUtils.copy_entry( img_src_dir, img_dst_dir )
+            end
+
+            doc.to_html( nav_pane, "#{pass}/build/specifications/" )
+        end
+    end
+
+    def render_all_protocols
+        
+        # create a sidebar first
+        nav_pane = NavigationPane.new(@specifications)        
+
+        pass = @project_root_directory
+
+        # FileUtils.remove_dir(pass + "/build/tests", true)
+        FileUtils.mkdir_p(pass + "/build/tests/protocols")
+    
+        @protocols.each do |doc|
 
-            img_src_dir = pass + "/specifications/" + spec.key.downcase + "/img"
-            img_dst_dir = pass + "/build/specifications/" + spec.key.downcase + "/img"
+            img_src_dir = pass + "/tests/protocols/" + doc.id + "/img"
+            img_dst_dir = pass + "/build/tests/protocols/" + doc.id + "/img"
      
             FileUtils.mkdir_p(img_dst_dir)
 
@@ -90,9 +181,7 @@ class Project
                 FileUtils.copy_entry( img_src_dir, img_dst_dir )
             end
 
-            HtmlRender.new( spec, nav_pane,
-            @gem_root + "/lib/almirah/templates/page.html",
-            "#{pass}/build/specifications/#{spec.key.downcase}/#{spec.key.downcase}.html" )
+            doc.to_html( nav_pane, "#{pass}/build/tests/protocols/" )
         end
     end
 end

data/lib/almirah/templates/page.html

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

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

metadata

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

data/lib/almirah/html_render.rb

@@ -1,55 +0,0 @@
-require_relative "specification"
-require_relative "doc_items/doc_item"
-require_relative "navigation_pane"
-
-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.docItems.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}}')
-                file.puts self.nav_pane.to_html
-            else
-                file.puts s
-            end
-        end
-        file.close
-    end
-
-end