Almirah 0.0.4 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0cec091b4437bbdeb9ea83b3a55638fafef7b0d629ba9eb1f069594ec420651c
-  data.tar.gz: 6de241968325f0d89227f25b854332aa697a8af659e49d91fe5130112fcb31ea
+  metadata.gz: b3ac78a8239af2167c9f9e90c66fe8693a51d8909282757710e45b8a0375aba5
+  data.tar.gz: 544347bbb28b9e7b288f3c9b37e93c487bc6fd0ac863fcfa7c12fb2cc36d0bc7
 SHA512:
-  metadata.gz: 5196218711f21202659e7cf84b5e1f8329ace42a00831d80acc275357e4b2b38cecb1af6842cc3b9b439f8a1d8c78610761756af5b9e565ce77b3f0aa64d24fd
-  data.tar.gz: a23964002a9c745e7529182b6e2ae684b4ca6a9fd7c963a7eae553c370ac64565edd6be4412dfa27c8ed4517f9273562e14ab4adfebe818cf13bce6102b72736
+  metadata.gz: d0170e32eac2109e8559413261c43a230730da8dc4add50342a807e3a054e57c8f5950e83cce4bdaded5b317697da863c82e13bd13cc0250887336d2ed2de77a
+  data.tar.gz: 8388732d6f4fd9d4b4e796470d1ce153a635484cf1d9400d48a3eb3f1d2146d70c8be649bac7927832a29990c6745b0dcc9e4ca247c00b6a5e5c5546d68228a0

data/lib/almirah/doc_items/heading.rb

@@ -3,10 +3,12 @@ require_relative "paragraph"
 class Heading < Paragraph
 
     attr_accessor :level
+    attr_accessor :anchor_id
 
     def initialize(text, level)
         @text = text
         @level = level
+        @anchor_id = self.getTextWithoutSpaces()
     end
 
     def to_html
@@ -15,10 +17,9 @@ class Heading < Paragraph
             s += "</table>"
             @@htmlTableRenderInProgress = false
         end
-        headingLevel = level.to_s
-        itemTextNoSpaces = self.getTextWithoutSpaces
-        s += "<a name=\"#{itemTextNoSpaces}\"></a>\n\r"
-        s += "<h#{headingLevel}> #{@text} <a href=\"\##{itemTextNoSpaces}\" class=\"heading_anchor\">"
+        headingLevel = level.to_s 
+        s += "<a name=\"#{@anchor_id}\"></a>\n\r"
+        s += "<h#{headingLevel}> #{@text} <a href=\"\##{@anchor_id}\" class=\"heading_anchor\">"
         s += "&para;</a></h#{headingLevel}>"
         return s
     end

data/lib/almirah/doc_items/image.rb

@@ -0,0 +1,27 @@
+require_relative "doc_item"
+
+class Image < DocItem
+
+    attr_accessor :text
+    attr_accessor :path
+
+    def initialize(text, path)
+        @text = text
+        @path = path
+    end
+
+    def getTextWithoutSpaces
+        return @text.split.join('-')
+    end
+
+    def to_html
+        s = ''
+        if @@htmlTableRenderInProgress
+            s += "</table>\n\r"
+            @@htmlTableRenderInProgress = false
+        end
+
+        s += "<img src=\"#{@path}\" alt=\"#{@text}\">"
+        return s
+    end
+end

data/lib/almirah/doc_items/markdown_list.rb

@@ -0,0 +1,31 @@
+require_relative "doc_item"
+
+class MarkdownList < DocItem
+
+    attr_accessor :rows
+
+    def initialize(first_row)
+        @rows = Array.new
+        @rows.append(first_row)
+    end
+
+    def addRow(row)
+        @rows.append(row)
+    end
+
+    def to_html
+        s = ''
+        if @@htmlTableRenderInProgress
+            s += "</table>/n/r"
+            @@htmlTableRenderInProgress = false
+        end
+
+        s += "<ul>\n\r"
+        @rows.each do |r|
+            s += "\t<li>#{r}</li>\n\r"
+        end
+        s += "</ul>\n\r"
+
+        return s
+    end
+end

data/lib/almirah/html_render.rb

@@ -1,8 +1,6 @@
 require_relative "specification"
 require_relative "doc_items/doc_item"
-require_relative "doc_items/heading"
-require_relative "doc_items/paragraph"
-require_relative "doc_items/controlled_paragraph"
+require_relative "navigation_pane"
 
 class HtmlRender
 
@@ -10,13 +8,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()
@@ -43,6 +43,8 @@ class HtmlRender
                 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

data/lib/almirah/navigation_pane.rb

@@ -0,0 +1,25 @@
+require_relative "doc_items/doc_item"
+require_relative "specification"
+
+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.key.downcase}\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</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,98 @@
+require_relative "doc_items/doc_item"
+require_relative "specification"
+require_relative "html_render"
+require_relative "navigation_pane"
+
+class Project
+
+    attr_accessor :specifications
+    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
+        @gem_root = gem_root
+        @specifications_dictionary = Hash.new
+        
+        parse_all_documents()
+        link_all_specifications()
+        render_all_specifications()
+       
+    end
+
+    def parse_all_documents
+        
+        Dir.glob( "#{@project_root_directory}/**/*.md" ).each do |f|
+            puts f
+            spec = Specification.new(f)
+            @specifications.append(spec)
+        end
+    end
+
+    def link_all_specifications
+        combList = @specifications.combination(2)
+        combList.each do |c|
+            self.link_two_specifications(c[0], c[1])
+        end
+    end
+
+    def link_two_specifications(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
+
+    def render_all_specifications
+        
+        # create a sidebar first
+        nav_pane = NavigationPane.new(@specifications)        
+
+        pass = @project_root_directory
+
+        FileUtils.remove_dir(pass + "/build", true)
+        FileUtils.mkdir_p(pass + "/build/specifications")
+    
+        @specifications.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
+
+            HtmlRender.new( spec, nav_pane,
+            @gem_root + "/lib/almirah/templates/page.html",
+            "#{pass}/build/specifications/#{spec.key.downcase}/#{spec.key.downcase}.html" )
+        end
+    end
+end

data/lib/almirah/specification.rb

@@ -4,26 +4,32 @@ require_relative "doc_items/paragraph"
 require_relative "doc_items/blockquote"
 require_relative "doc_items/controlled_paragraph"
 require_relative "doc_items/markdown_table"
+require_relative "doc_items/image"
+require_relative "doc_items/markdown_list"
 
 class Specification
 
     attr_accessor :path
     attr_accessor :docItems
+    attr_accessor :headings
     attr_accessor :title
     attr_accessor :key
     attr_accessor :up_link_key
     attr_accessor :dictionary
     attr_accessor :controlledParagraphs
     attr_accessor :tempMdTable
+    attr_accessor :tempMdList
 
     def initialize(fele_path)
 
         @path = fele_path
         @title = ""
         @docItems = Array.new
+        @headings = Array.new
         @controlledParagraphs = Array.new
         @dictionary = Hash.new
         @tempMdTable = nil
+        @tempMdList = nil
 
         @key = File.basename(fele_path, File.extname(fele_path)).upcase
         @up_link_key = ""
@@ -44,14 +50,19 @@ class Specification
                     if @tempMdTable
                         self.docItems.append(@tempMdTable)
                         @tempMdTable = nil
+                    end
+                    if @tempMdList
+                        self.docItems.append(@tempMdList)
+                        @tempMdList = nil
                     end 
 
                     level = res[1].length
                     value = res[2]
                     item = Heading.new(value, level)
                     self.docItems.append(item)
-                    
-                    if level == 1
+                    self.headings.append(item)
+
+                    if level == 1 && self.title == ""
                         self.title = value
                     end   
                      
@@ -60,6 +71,10 @@ class Specification
                     if @tempMdTable
                         self.docItems.append(@tempMdTable)
                         @tempMdTable = nil
+                    end
+                    if @tempMdList
+                        self.docItems.append(@tempMdList)
+                        @tempMdList = nil
                     end 
 
                     id = res[1]
@@ -83,8 +98,47 @@ class Specification
                     self.dictionary[ id.to_s ] = item           #for fast search
                     self.controlledParagraphs.append(item)      #for fast search
 
+                elsif res = /^[!]\[(.*)\]\((.*)\)/.match(s)     # Image
+
+                    if @tempMdTable
+                        self.docItems.append(@tempMdTable)
+                        @tempMdTable = nil
+                    end
+                    if @tempMdList
+                        self.docItems.append(@tempMdList)
+                        @tempMdList = nil
+                    end
+
+                    img_text = res[1]
+                    img_path = res[2]
+
+                    item = Image.new( img_text, img_path )
+
+                    self.docItems.append(item)
+
+                elsif res = /^(\*\s?)+(.*)/.match(s)   #check if bullet list
+                    
+                    if @tempMdTable
+                        self.docItems.append(@tempMdTable)
+                        @tempMdTable = nil
+                    end
+
+                    row = res[2]
+
+                    if @tempMdList
+                        @tempMdList.addRow(row)
+                    else
+                        item = MarkdownList.new(row)
+                        @tempMdList = item
+                    end
+
                 elsif s[0] == '|'   #check if table
 
+                    if @tempMdList
+                        self.docItems.append(@tempMdList)
+                        @tempMdList = nil
+                    end
+
                     if res = /^[|](-{3,})[|]/.match(s) #check if it is a separator first
 
                         if @tempMdTable 
@@ -112,6 +166,10 @@ class Specification
                     if @tempMdTable
                         self.docItems.append(@tempMdTable)
                         @tempMdTable = nil
+                    end
+                    if @tempMdList
+                        self.docItems.append(@tempMdList)
+                        @tempMdList = nil
                     end 
 
                     item = Blockquote.new(res[1])
@@ -121,7 +179,12 @@ class Specification
                     if @tempMdTable
                         self.docItems.append(@tempMdTable)
                         @tempMdTable = nil
-                    end 
+                    end
+                    if @tempMdList
+                        self.docItems.append(@tempMdList)
+                        @tempMdList = nil
+                    end
+
                     item = Paragraph.new(s)
                     self.docItems.append(item)
                 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;
     }
@@ -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,7 +1,5 @@
 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>"
@@ -17,30 +15,9 @@ class Almirah
   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
-    linker.link(documentList[0], documentList[1])
+    prj = Project.new pass, getGemRoot
 
-    # Render
-    FileUtils.remove_dir(pass + "/build", true)
-    FileUtils.mkdir_p(pass + "/build/specifications")
-    
-    documentList.each do |spec|
-      FileUtils.mkdir_p(pass + "/build/specifications/" + spec.key.downcase)
-      HtmlRender.new( spec,
-      getGemRoot() + "/lib/almirah/templates/page.html",
-       "#{pass}/build/specifications/#{spec.key.downcase}/#{spec.key.downcase}.html" )
-    end
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: Almirah
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
 platform: ruby
 authors:
 - Oleksandr Ivanov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-27 00:00:00.000000000 Z
+date: 2024-01-31 00:00:00.000000000 Z
 dependencies: []
 description: The software part of the Almirah system
 email: oleksandr.ivanov.development@gmail.com
@@ -23,13 +23,16 @@ files:
 - lib/almirah/doc_items/controlled_paragraph.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/linker.rb
+- lib/almirah/navigation_pane.rb
+- lib/almirah/project.rb
 - lib/almirah/specification.rb
 - lib/almirah/templates/page.html
-homepage: https://rubygems.org/gems/almirah
+homepage: http://almirah.site
 licenses:
 - MIT
 metadata: {}

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