Almirah 0.0.5 → 0.0.7

data/lib/almirah/html_render.rb

@@ -1,5 +1,3 @@
-require_relative "specification"
-require_relative "doc_items/doc_item"
 
 class HtmlRender
 
@@ -7,13 +5,15 @@ class HtmlRender
     attr_accessor :htmlRows
     attr_accessor :outputFile
     attr_accessor :document
+    attr_accessor :nav_pane
 
-    def initialize(document, template, outputFile)
+    def initialize(document, nav_pane, template, outputFile)
 
         @template = template
         @outputFile = outputFile
         @htmlRows = Array.new
         @document = document
+        @nav_pane = nav_pane
 
         self.render()
         self.saveRenderToFile()
@@ -22,7 +22,7 @@ class HtmlRender
     def render()
         self.htmlRows.append('')
 
-        self.document.docItems.each do |item|    
+        self.document.items.each do |item|    
             a = item.to_html
             self.htmlRows.append a
         end
@@ -40,6 +40,10 @@ class HtmlRender
                 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

data/lib/almirah/navigation_pane.rb

@@ -0,0 +1,23 @@
+
+class NavigationPane
+
+    attr_accessor :specifications
+
+    def initialize(specifications)
+        @specifications = specifications
+    end
+
+    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.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.id }\\#{spec.id }.html\">#{spec.title}</a>\n"
+                s += "\t\t\t</li>\n"
+                s += "\t\t</ul>\n"
+            s += "\t</li>\n"
+        end
+        s += "</ul>\n"
+    end
+end

data/lib/almirah/project.rb

@@ -0,0 +1,186 @@
+require_relative "doc_fabric"
+require_relative "html_render"
+require_relative "navigation_pane"
+
+class Project
+
+    attr_accessor :specifications
+    attr_accessor :protocols
+    attr_accessor :project_root_directory
+    attr_accessor :gem_root
+    attr_accessor :specifications_dictionary
+
+    def initialize(path, gem_root)
+        @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)      
+    end
+
+    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|
+            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.id == doc_B.up_link_doc_id
+            top_document = doc_A
+            bottom_document = doc_B
+        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.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.down_links
+                    topItem.down_links = Array.new
+                end
+                topItem.down_links.append(item)
+
+                #if tmp = /^([a-zA-Z]+)[-]\d+/.match(item.id)
+                #    top_document.downlinkKey = tmp[1].upcase
+                #end
+            end
+        end
+    end
+
+    def link_protocol_to_spec(protocol, specification)
+
+        top_document = specification
+        bottom_document = protocol
+
+        bottom_document.controlled_items.each do |item|
+
+            if top_document.dictionary.has_key?(item.up_link.to_s)
+
+                topItem = top_document.dictionary[item.up_link.to_s]
+                
+                unless topItem.coverage_links
+                    topItem.coverage_links = Array.new
+                end
+                topItem.coverage_links.append(item)
+            end
+        end
+    end
+
+    def render_all_specifications
+        
+        # create a sidebar first
+        nav_pane = NavigationPane.new(@specifications)        
+
+        pass = @project_root_directory
+
+        FileUtils.mkdir_p(pass + "/build/specifications")
+    
+        @specifications.each do |doc|
+
+            img_src_dir = pass + "/specifications/" + doc.id + "/img"
+            img_dst_dir = pass + "/build/specifications/" + doc.id + "/img"
+     
+            FileUtils.mkdir_p(img_dst_dir)
+
+            if File.directory?(img_src_dir)
+                FileUtils.copy_entry( img_src_dir, img_dst_dir )
+            end
+
+            HtmlRender.new( doc, nav_pane,
+            @gem_root + "/lib/almirah/templates/page.html",
+            "#{pass}/build/specifications/#{doc.id}/#{doc.id}.html" )
+        end
+    end
+
+    def render_all_protocols
+        
+        # create a sidebar first
+        #nav_pane = NavigationPane.new(@specifications)        
+
+        pass = @project_root_directory
+
+        # FileUtils.remove_dir(pass + "/build/tests", true)
+        FileUtils.mkdir_p(pass + "/build/tests/protocols")
+    
+        @protocols.each do |doc|
+
+            img_src_dir = pass + "/tests/protocols/" + doc.id + "/img"
+            img_dst_dir = pass + "/build/tests/protocols/" + doc.id + "/img"
+     
+            FileUtils.mkdir_p(img_dst_dir)
+
+            if File.directory?(img_src_dir)
+                FileUtils.copy_entry( img_src_dir, img_dst_dir )
+            end
+
+            HtmlRender.new( doc, nil,
+            @gem_root + "/lib/almirah/templates/page.html",
+            "#{pass}/build/tests/protocols/#{doc.id}/#{doc.id}.html" )
+        end
+    end
+end

data/lib/almirah/templates/page.html

@@ -3,6 +3,7 @@
 <head>
 <meta charset="utf-8" />
 <!-- CSS -->
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
 <style>
     body {
         font-family: Verdana, sans-serif;
@@ -15,12 +16,12 @@
     #main {
         flex-grow: 2;
         display: flex;
-        flex-direction: row-reverse;
+        flex-direction: row;
     }
     #content {
         flex-grow: 1;
         background-color: #fff;
-        margin: 0px;
+        margin-top: 30px;
         padding: 10px 16px 10px 16px;
         overflow-x: auto;
     }
@@ -88,7 +89,7 @@
         background-color:#e1f1fa;
         padding: 4px;
         white-space:nowrap;
-        font-weight:bold;
+        font-weight:normal;
         border: 1px solid #bbb;
     }
     table.controlled td {
@@ -135,11 +136,68 @@
         margin-top: 4px;
         margin-bottom: 4px;
     }
+    #nav_pane{
+        flex-shrink: 0;
+        padding: 16px 8px 2px 8px;
+        background: #EEEEEE;
+        border-left: 1px solid #ddd;
+        position: fixed;
+        height: 100%;       /* 100% Full-height */
+        visibility: hidden;
+    }
+    @media screen and (min-width: 0px) and (max-width: 1089px) {#nav_pane{width: 22%;}}
+    @media screen and (min-width: 1090px) and (max-width: 1279px) {#nav_pane{width: 240px;}}
+    @media screen and (min-width: 1280px) and (max-width: 1599px) {#nav_pane{width: 280px;}}
+    @media screen and (min-width: 1600px) and (max-width: 1919px) {#nav_pane{width: 320px;}}
+    @media screen and (min-width: 1920px) and (max-width: 2559px) {#nav_pane{width: 360px;}}
+    @media screen and (min-width: 2560px) {#nav_pane{width: 380px;}}
+    #top_nav{
+        background-color: #169;
+        overflow: hidden;
+        position: fixed;
+        width: 100%;    
+    }
+    #top_nav a {
+        float: left;
+        color: white;
+        text-align: center;
+        padding: 4px 6px;
+        text-decoration: none;
+        font-size: 1.5em;
+        font-family: "Trebuchet MS", Verdana, sans-serif;
+    }
+    #top_nav a:hover {
+        background-color: black;
+        color:  white;
+    }
+    #top_nav a.active {
+        background-color: #169;
+        color: white;
+    }
+
 </style>
+<script>
+function openNav() {
+  document.getElementById("nav_pane").style.visibility = "visible";
+  console.log("Mouse In")
+}
+
+function closeNav() {
+  document.getElementById("nav_pane").style.visibility = "hidden";
+  console.log("Mouse Out");
+}
+</script>
 </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>
+    </div>
     <div id="main">
-        <div id="content">
+        <div id="nav_pane">
+            {{NAV_PANE}}
+        </div>
+        <div id="content" href="javascript:void(0)" onclick="closeNav()">
             {{CONTENT}}
         </div>
     </div>

data/lib/almirah.rb

@@ -1,58 +1,37 @@
 require "thor"
-require_relative "almirah/specification"
-require_relative "almirah/linker"
-require_relative "almirah/html_render"
+require_relative "almirah/project"
 
 class CLI < Thor
-  desc "please <pass>", "say <pass>"
-    def please(pass)
-      Almirah.new().start(pass)
+  desc "please <project_folder>", "say <project_folder>"
+  option :results
+    def please(project_folder)
+      a = Almirah.new project_folder
+      if options[:results]
+        a.results options[:results]
+      else
+        a.default
+      end
     end
 end
 
 class Almirah
 
+  attr_accessor :project
+
+  def initialize project_folder
+    @project = Project.new project_folder, getGemRoot
+  end
+
   def getGemRoot
     File.expand_path './..', File.dirname(__FILE__)
   end
 
-  def start(pass)
-    # Documents
-    documentList = Array.new
-
-    # Parse
-    Dir.glob( "#{pass}/**/*.md" ).each do |f|
-      puts f
-      spec = Specification.new(f)
-      documentList.append(spec)
-    end
-
-    # Link
-    linker = Linker.new
-    combList = documentList.combination(2)
-    combList.each do |c|
-      linker.link(c[0], c[1])
-    end
-
-    # Render
-    FileUtils.remove_dir(pass + "/build", true)
-    FileUtils.mkdir_p(pass + "/build/specifications")
-    
-    documentList.each do |spec|
-
-      img_src_dir = pass + "/specifications/" + spec.key.downcase + "/img"
-      img_dst_dir = pass + "/build/specifications/" + spec.key.downcase + "/img"
-     
-      FileUtils.mkdir_p(img_dst_dir)
-
-      if File.directory?(img_src_dir)
-        FileUtils.copy_entry( img_src_dir, img_dst_dir )
-      end
+  def results( test_run )
+    @project.specifications_and_results test_run
+  end
 
-      HtmlRender.new( spec,
-      getGemRoot() + "/lib/almirah/templates/page.html",
-       "#{pass}/build/specifications/#{spec.key.downcase}/#{spec.key.downcase}.html" )
-    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.5
+  version: 0.0.7
 platform: ruby
 authors:
 - Oleksandr Ivanov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-29 00:00:00.000000000 Z
+date: 2024-02-10 00:00:00.000000000 Z
 dependencies: []
 description: The software part of the Almirah system
 email: oleksandr.ivanov.development@gmail.com
@@ -19,17 +19,23 @@ extra_rdoc_files: []
 files:
 - bin/almirah
 - lib/almirah.rb
+- lib/almirah/doc_fabric.rb
 - lib/almirah/doc_items/blockquote.rb
 - lib/almirah/doc_items/controlled_paragraph.rb
+- lib/almirah/doc_items/controlled_table.rb
+- lib/almirah/doc_items/controlled_table_row.rb
 - lib/almirah/doc_items/doc_item.rb
 - lib/almirah/doc_items/heading.rb
 - lib/almirah/doc_items/image.rb
 - lib/almirah/doc_items/markdown_list.rb
 - lib/almirah/doc_items/markdown_table.rb
 - lib/almirah/doc_items/paragraph.rb
+- lib/almirah/doc_types/base_document.rb
+- lib/almirah/doc_types/protocol.rb
+- lib/almirah/doc_types/specification.rb
 - lib/almirah/html_render.rb
-- lib/almirah/linker.rb
-- lib/almirah/specification.rb
+- lib/almirah/navigation_pane.rb
+- lib/almirah/project.rb
 - lib/almirah/templates/page.html
 homepage: http://almirah.site
 licenses:

data/lib/almirah/linker.rb

@@ -1,42 +0,0 @@
-require_relative "doc_items/doc_item"
-require_relative "specification"
-
-class Linker
-
-    attr_accessor :field
-
-    def initialize()
-        @field = "field"
-    end
-
-    def link(doc_A, doc_B)
-
-        if doc_A.key == doc_B.up_link_key
-            top_document = doc_A
-            bottom_document = doc_B
-        elsif doc_B.key == doc_A.up_link_key
-            top_document = doc_B
-            bottom_document = doc_A
-        else
-            puts "No Links"
-            return # no links
-        end
-
-        bottom_document.controlledParagraphs.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.down_links
-                    topItem.down_links = Array.new
-                end
-                topItem.down_links.append(item)
-
-                #if tmp = /^([a-zA-Z]+)[-]\d+/.match(item.id)
-                #    top_document.downlinkKey = tmp[1].upcase
-                #end
-            end
-        end
-    end
-end