Almirah 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99a9591235fc0f0e1820c572da3c24a1365e93ff7f32a78ceda1083e982f9ad3
-  data.tar.gz: 95a400de1b4ad0c471d1fbbc1ee68339618127ac18d9cb5e9429dc36bda2d252
+  metadata.gz: c28aa00ca57d213d56625d51372284eaff2668db942bb08fccd4d2c0bae10a72
+  data.tar.gz: ce278d1ab81147f9bddae86230da83575921ef26fcd849133e7d138433a6a7fd
 SHA512:
-  metadata.gz: f77bcf2b93586fe371b48b863d27604390c22180666441cc8bc7329d2e87d361ce33d08da873b410245d77cabbc0784c285fad17946838fbd9f4d30d1ca34da2
-  data.tar.gz: 5f227475da116c2b5d13a023d3d1cb4476a49a862392819a854ac35e4d0624af20f7abe8730fa092177fa733259953bf1ab410dc96ba3f37d1e635955b4b0647
+  metadata.gz: 73fb32081f15b4314046976855e4474edf94cca23e146507210a6e232418e6b844d1d51c6bf1d7cbaad0b32a203abbc24cf38c1608e400a68485f58d7911ae2d
+  data.tar.gz: 71155f2804459d0ac0d82777f070e8628f3d1d8d3949bab4468bae35f9d04f495d78523b239a8ed5fff2df16ba98cf789c1b97017deb3b92d01a58ef81a5fe49

data/lib/almirah/doc_fabric.rb

@@ -17,6 +17,8 @@ require_relative "doc_items/image"
 require_relative "doc_items/markdown_list"
 require_relative "doc_items/doc_footer"
 
+require_relative "dom/document"
+
 class DocFabric
 
     def self.add_lazy_doc_id(path)
@@ -65,6 +67,7 @@ class DocFabric
 
                     if level == 1 && doc.title == ""
                         doc.title = value
+                        level = 0 # Doc Title is a Root
                         Heading.reset_global_section_number()
                     end 
 
@@ -82,7 +85,7 @@ class DocFabric
                         Heading.reset_global_section_number()
                     end 
 
-                    item = Heading.new(title, 1)
+                    item = Heading.new(title, 0)
                     item.parent_doc = doc
                     doc.items.append(item)
                     doc.headings.append(item)
@@ -366,5 +369,9 @@ class DocFabric
         item = DocFooter.new
         item.parent_doc = doc
         doc.items.append(item)
+        # Build dom
+        if doc.is_a?(Specification)
+            doc.dom = Document.new(doc.headings)
+        end
     end
 end

data/lib/almirah/doc_items/heading.rb

@@ -11,57 +11,68 @@ class Heading < Paragraph
     def initialize(text, level)
         @text = text
         @level = level
-        @anchor_id = getTextWithoutSpaces()
 
-        if @@global_section_number == ""
-            @@global_section_number = "1"
-            for n in 1..(level-1) do
-                @@global_section_number += ".1"
-            end
-        else
-            previous_level = @@global_section_number.split(".").length
+        if level != 0 # skip Doc Title
+            if @@global_section_number == ""
+                @@global_section_number = "1"
+                for n in 1..(level-1) do
+                    @@global_section_number += ".1"
+                end
+            else
+                previous_level = @@global_section_number.split(".").length
 
-            if previous_level == level
+                if previous_level == level
 
-                a = @@global_section_number.split(".")
-                a[-1] = (a[-1].to_i() +1).to_s
-                @@global_section_number = a.join(".")
+                    a = @@global_section_number.split(".")
+                    a[-1] = (a[-1].to_i() +1).to_s
+                    @@global_section_number = a.join(".")
 
-            elsif level > previous_level
+                elsif level > previous_level
 
-                a = @@global_section_number.split(".")
-                a.push("1")
-                @@global_section_number = a.join(".")
-            
-            else # level < previous_level
+                    a = @@global_section_number.split(".")
+                    a.push("1")
+                    @@global_section_number = a.join(".")
+                
+                else # level < previous_level
 
-                a = @@global_section_number.split(".")
-                delta = previous_level - level
-                a.pop(delta)
-                @@global_section_number = a.join(".")
-                # increment
-                a = @@global_section_number.split(".")
-                a[-1] = (a[-1].to_i() +1).to_s
-                @@global_section_number = a.join(".")
+                    a = @@global_section_number.split(".")
+                    delta = previous_level - level
+                    a.pop(delta)
+                    @@global_section_number = a.join(".")
+                    # increment
+                    a = @@global_section_number.split(".")
+                    a[-1] = (a[-1].to_i() +1).to_s
+                    @@global_section_number = a.join(".")
+                end
             end
         end
         @section_number = @@global_section_number
+        @anchor_id = get_anchor_text()
     end
 
     def get_section_info
         s = @section_number + " " + @text
     end
 
+    def get_anchor_text()
+        s = @section_number + "-" + getTextWithoutSpaces()
+    end
+
     def to_html
         s = ''
         if @@htmlTableRenderInProgress
             s += "</table>\n"
             @@htmlTableRenderInProgress = false
         end
-        headingLevel = level.to_s 
+        heading_level = level.to_s
+        heading_text = get_section_info()
+        if level == 0
+            heading_level = 1.to_s  # Render Doc Title as a regular h1
+            heading_text = @text    # Doc Title does not have a section number
+        end 
         s += "<a name=\"#{@anchor_id}\"></a>\n"
-        s += "<h#{headingLevel}> #{@text} <a href=\"\##{@anchor_id}\" class=\"heading_anchor\">"
-        s += "&para;</a></h#{headingLevel}>"
+        s += "<h#{heading_level}> #{heading_text} <a href=\"\##{@anchor_id}\" class=\"heading_anchor\">"
+        s += "&para;</a></h#{heading_level}>"
         return s
     end
 

data/lib/almirah/doc_types/base_document.rb

@@ -6,6 +6,7 @@ class BaseDocument
     attr_accessor :headings
     attr_accessor :title
     attr_accessor :id
+    attr_accessor :dom
 
     def initialize(fele_path)
 
@@ -14,6 +15,7 @@ class BaseDocument
         @headings = Array.new
         @title = ""
         @id = ""
+        @dom = nil
     end
 
     def save_html_to_file html_rows, nav_pane, output_file_path
@@ -37,7 +39,7 @@ class BaseDocument
                     file.puts r
                 end
             elsif s.include?('{{NAV_PANE}}')
-                if nav_pane
+                if nav_pane 
                     file.puts nav_pane.to_html
                 end
             elsif s.include?('{{DOCUMENT_TITLE}}')

data/lib/almirah/dom/doc_section.rb

@@ -0,0 +1,28 @@
+class DocSection
+
+    attr_accessor :sections
+    attr_accessor :heading
+    attr_accessor :parent_section
+
+    def initialize(heading)
+        @sections = Array.new
+        @heading = heading
+        @parent_section = nil
+    end
+
+    def to_html
+        s = ''
+        s += "\t<li><span class=\"fa-li\"><i class=\"fa fa-plus-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"
+                @sections.each do |sub_section|
+                    s += sub_section.to_html()
+                end
+            s += "\t\t</ul>\n"
+        end
+        s += "</li>\n"
+        return s
+    end
+
+end

data/lib/almirah/dom/document.rb

@@ -0,0 +1,63 @@
+require_relative "doc_section"
+
+class Document
+
+    attr_accessor :root_section
+
+    @@sections_stack = Array.new
+
+    def initialize(headings_list)
+        @root_section = nil
+
+        build_sections_tree(headings_list)
+    end
+
+    def build_sections_tree(headings_list)
+
+        headings_list.each do |h|
+
+            if @root_section == nil
+
+                s = DocSection.new(h)
+                s.parent_section = nil
+                @root_section = s
+                @@sections_stack.push s
+
+            elsif @@sections_stack[-1].heading.level == h.level
+
+                s = DocSection.new(h)
+                @@sections_stack[-2].sections.append(s)
+                @@sections_stack[-1] = s
+
+            elsif h.level > @@sections_stack[-1].heading.level
+
+                s = DocSection.new(h)
+                @@sections_stack[-1].sections.append(s)
+                @@sections_stack.push s
+
+            else
+                while h.level < @@sections_stack[-1].heading.level
+                    @@sections_stack.pop
+                end
+
+                s = DocSection.new(h)
+                @@sections_stack[-2].sections.append(s)
+                @@sections_stack[-1] = s
+            end
+        end
+    end
+
+    def section_tree_to_html
+        s = ''
+        s += "<a href=\"\#" + @root_section.heading.anchor_id.to_s + "\">" + @root_section.heading.text + "</a>\n"
+        if @root_section.sections.length >0
+            s += "\t<ul class=\"fa-ul\" style=\"margin-top: 2px;\">\n"
+            @root_section.sections.each do |sub_section|
+                s += sub_section.to_html()
+            end
+            s += "\t</ul>\n"
+        end
+
+        return s
+    end
+end

data/lib/almirah/navigation_pane.rb

@@ -3,21 +3,15 @@ class NavigationPane
 
     attr_accessor :specifications
 
-    def initialize(specifications)
-        @specifications = specifications
+    def initialize(specification)
+        @doc = specification
     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"
+    def to_html
+        if  @doc.dom
+            return @doc.dom.section_tree_to_html()
+        else
+            return ''
         end
-        s += "</ul>\n"
     end
 end

data/lib/almirah/project.rb

@@ -227,10 +227,7 @@ class Project
         @index = Index.new( @project )
     end
 
-    def render_all_specifications(spec_list)
-        
-        # create a sidebar first
-        # nav_pane = NavigationPane.new(@specifications)        
+    def render_all_specifications(spec_list)     
 
         pass = @project_root_directory
 
@@ -249,7 +246,9 @@ class Project
                 FileUtils.copy_entry( img_src_dir, img_dst_dir )
             end
 
-            doc.to_html( nil, "#{pass}/build/specifications/" )
+            # create a sidebar first
+            nav_pane = NavigationPane.new(doc) 
+            doc.to_html( nav_pane, "#{pass}/build/specifications/" )
         end
     end
 

data/lib/almirah/templates/page.html

@@ -173,14 +173,30 @@
     #modal_image_id{
         cursor: default;
     } 
+    #closed_nav_pane{
+        padding: 0px;
+        background: #169;
+        border: 0px;
+        position: fixed;
+        width: 5px;
+        height: 100%;       /* 100% Full-height */
+        visibility: visible;
+        cursor: pointer;
+    }
+    #closed_nav_pane:hover{
+        width: 10px;
+    }
     #nav_pane{
         flex-shrink: 0;
-        padding: 16px 8px 2px 8px;
+        padding: 32px 8px 8px 8px;
         background: #EEEEEE;
-        border-left: 1px solid #ddd;
+        border: 1px solid #ddd;
         position: fixed;
         height: 100%;       /* 100% Full-height */
         visibility: hidden;
+        z-index: 1;
+        overflow-y: auto;
+        cursor: pointer;
     }
     @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;}}
@@ -188,12 +204,13 @@
     @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%;    
-        z-index: 1;
+        z-index: 2;
     }
     #top_nav a {
         float: left;
@@ -286,12 +303,10 @@
 <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");
 }
 
 window.onload = (event) => {
@@ -304,12 +319,12 @@ window.onload = (event) => {
     }
   }
   // Scroll a bit to make navigated anchor visible
-  setTimeout(function() {
-        window.scrollBy({ 
-        top: -40,
-        behavior: "smooth"
-        });
-    }, 200);
+  //setTimeout(function() {
+  //      window.scrollBy({ 
+  //      top: -40,
+  //      behavior: "smooth"
+  //      });
+  //  }, 200);
 };
 
 function downlink_OnClick(clicked){
@@ -350,11 +365,12 @@ function modal_close_OnClick(clicked){
 <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 href="javascript:void(0)"> About</a-->
         <a class="split">{{DOCUMENT_TITLE}}</a>
     </div>
     <div id="main">
-        <div id="nav_pane">
+        <div id="closed_nav_pane" href="javascript:void(0)" onclick="openNav()">
+        </div>
+        <div id="nav_pane" onclick="closeNav()">
             {{NAV_PANE}}
         </div>
         <div id="content" href="javascript:void(0)" onclick="closeNav()">

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: Almirah
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Oleksandr Ivanov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-28 00:00:00.000000000 Z
+date: 2024-05-07 00:00:00.000000000 Z
 dependencies: []
 description: The software part of the Almirah framework
 email: oleksandr.ivanov.development@gmail.com
@@ -40,6 +40,8 @@ files:
 - lib/almirah/doc_types/protocol.rb
 - lib/almirah/doc_types/specification.rb
 - lib/almirah/doc_types/traceability.rb
+- lib/almirah/dom/doc_section.rb
+- lib/almirah/dom/document.rb
 - lib/almirah/navigation_pane.rb
 - lib/almirah/project.rb
 - lib/almirah/templates/page.html