Almirah 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fb9468eb0f2bd41ef114392ac41e3954da577bcbf008b0e1302d0436cd1222c
-  data.tar.gz: fe5652461a3f368c77df81bbffafa4c127168bd3eb3af4c2f0c181c50e23a59e
+  metadata.gz: a4e770388ae634e216ef325d7f82a5d32d44bb5405dbea4e32783e3f0d2eea91
+  data.tar.gz: 20871334c2ba2179e361abd1319634281bde45ba38032ec2fd3dabdea98f6e3a
 SHA512:
-  metadata.gz: 5b8ecdb79e738a58f1a8992735adbb7fe07f883f587f2d4b8314083bfdc2d750b31217738886c8c4abbba02b672e819d01257dd0fb6c70febe0bfe15e6912760
-  data.tar.gz: bca5f63cab9daa24e21dbaaf1af7e3f9fa0297b60a9ea1a31bf5ebc38f5306290810ade574df8bd3979cc4df21d32bdfe1a4478813f3a016e7d4a51995f4e827
+  metadata.gz: ad3b925c13c5a6794a82eabb3cfc81894c3f5711e5250cb0cb1dbaee0e79ff56e0e571e1dbcedb969c8384b3db82a021c082017d0cba001cb4ea1a2c314d21cd
+  data.tar.gz: 38532ef2204233611d5330e5825c0ccc0234043eec49f54f81e768d2caecdbc20df78999a8dfed3b074b924fe7ae6c2bcc6d3658771863f7663ab75b8c5167d4

data/lib/almirah/doc_items/blockquote.rb

@@ -11,11 +11,11 @@ class Blockquote < DocItem
     def to_html
         s = ''
         if @@htmlTableRenderInProgress
-            s += "</table>"
+            s += "</table>\n\r"
             @@htmlTableRenderInProgress = false
         end
 
-        s += "<p>Note: #{@text}\n\r"
+        s += "<div class=\"blockquote\"><p>#{@text}</div>\n\r"
         return s
     end
 end

data/lib/almirah/doc_items/controlled_paragraph.rb

@@ -16,35 +16,35 @@ class ControlledParagraph < Paragraph
     def to_html
         s = ''
         unless @@htmlTableRenderInProgress                    
-            s += "<table>\n\r"
+            s += "<table class=\"controlled\">\n\r"
             s += "\t<thead> <th>#</th> <th>Text</th> <th>UL</th> <th>DL</th> <th>COV</th> </thead>\n\r"
             @@htmlTableRenderInProgress = true
         end
         s += "\t<tr>\n\r"
-        s += "\t\t<td> <a name=\"#{@id}\"></a>#{@id} </td>\n\r"
-        s += "\t\t<td>#{@text}</td>\n\r"
+        s += "\t\t<td class=\"item_id\"> <a name=\"#{@id}\"></a>#{@id} </td>\n\r"
+        s += "\t\t<td class=\"item_text\">#{@text}</td>\n\r"
 
         if @up_link
             if tmp = /^([a-zA-Z]+)[-]\d+/.match(@up_link)
                 up_link_doc_name = tmp[1].downcase
             end
-            s += "\t\t<td><a href=\"./../#{up_link_doc_name}/#{up_link_doc_name}.html\" class=\"external\">#{@up_link}</a></td>\n\r"
+            s += "\t\t<td class=\"item_id\"><a href=\"./../#{up_link_doc_name}/#{up_link_doc_name}.html\" class=\"external\">#{@up_link}</a></td>\n\r"
         else
-            s += "\t\t<td></td>\n\r"
+            s += "\t\t<td class=\"item_id\"></td>\n\r"
         end
 
         if @down_links
             if tmp = /^([a-zA-Z]+)[-]\d+/.match(@down_links[0].id)    # guessing that all the links refer to one document
                 down_link_doc_name = tmp[1].downcase
             end
-            s += "\t\t<td><a href=\"./../#{down_link_doc_name}/#{down_link_doc_name}.html\" class=\"external\">#{@down_links.length}</a></td>\n\r"
+            s += "\t\t<td class=\"item_id\"><a href=\"./../#{down_link_doc_name}/#{down_link_doc_name}.html\" class=\"external\">#{@down_links.length}</a></td>\n\r"
         else
-            s += "\t\t<td></td>\n\r"
+            s += "\t\t<td class=\"item_id\"></td>\n\r"
         end
 
         #s += "\t\t<td></td>\n\r"    # UL
         #s += "\t\t<td></td>\n\r"    # DL
-        s += "\t\t<td></td>\n\r"    # COV
+        s += "\t\t<td class=\"item_id\"></td>\n\r"    # COV
         s += "\t</tr>\n\r"
         return s
     end 

data/lib/almirah/doc_items/heading.rb

@@ -18,7 +18,7 @@ class Heading < Paragraph
         headingLevel = level.to_s
         itemTextNoSpaces = self.getTextWithoutSpaces
         s += "<a name=\"#{itemTextNoSpaces}\"></a>\n\r"
-        s += "<h#{headingLevel}> #{@text} <a href=\"\##{itemTextNoSpaces}\">"
+        s += "<h#{headingLevel}> #{@text} <a href=\"\##{itemTextNoSpaces}\" 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/doc_items/markdown_table.rb

@@ -22,7 +22,7 @@ class MarkdownTable < DocItem
             @@htmlTableRenderInProgress = false
         end
                    
-        s += "<table>\n\r"
+        s += "<table class=\"markdown_table\">\n\r"
         s += "\t<thead>" 
 
         @column_names.each do |h|

data/lib/almirah/html_render.rb

@@ -1,8 +1,5 @@
 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"
 
 class HtmlRender
 

data/lib/almirah/specification.rb

@@ -4,6 +4,8 @@ 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
 
@@ -15,6 +17,7 @@ class Specification
     attr_accessor :dictionary
     attr_accessor :controlledParagraphs
     attr_accessor :tempMdTable
+    attr_accessor :tempMdList
 
     def initialize(fele_path)
 
@@ -24,6 +27,7 @@ class Specification
         @controlledParagraphs = Array.new
         @dictionary = Hash.new
         @tempMdTable = nil
+        @tempMdList = nil
 
         @key = File.basename(fele_path, File.extname(fele_path)).upcase
         @up_link_key = ""
@@ -44,6 +48,10 @@ class Specification
                     if @tempMdTable
                         self.docItems.append(@tempMdTable)
                         @tempMdTable = nil
+                    end
+                    if @tempMdList
+                        self.docItems.append(@tempMdList)
+                        @tempMdList = nil
                     end 
 
                     level = res[1].length
@@ -60,11 +68,14 @@ class Specification
                     if @tempMdTable
                         self.docItems.append(@tempMdTable)
                         @tempMdTable = nil
+                    end
+                    if @tempMdList
+                        self.docItems.append(@tempMdList)
+                        @tempMdList = nil
                     end 
 
                     id = res[1]
                     text = res[2]
-                    item = ControlledParagraph.new( text, id )
 
                     #check if it contains the uplink
                     if tmp = /(.*)\s+>\[(\S*)\]$/.match(text)
@@ -72,19 +83,59 @@ class Specification
                         text = tmp[1]
                         up_link = tmp[2]
                         
-                        item.up_link = up_link
-
                         if tmp = /^([a-zA-Z]+)[-]\d+/.match(up_link)
                             self.up_link_key = tmp[1]
                         end
                     end
 
+                    item = ControlledParagraph.new( text, id )
+                    item.up_link = up_link
+
                     self.docItems.append(item)
                     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 +163,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 +176,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

@@ -2,8 +2,146 @@
 <html lang="en">
 <head>
 <meta charset="utf-8" />
+<!-- CSS -->
+<style>
+    body {
+        font-family: Verdana, sans-serif;
+        font-size: 12px;
+        color: #333;
+        margin: 0;
+        padding: 0;
+        min-width: 900px;
+    }
+    #main {
+        flex-grow: 2;
+        display: flex;
+        flex-direction: row-reverse;
+    }
+    #content {
+        flex-grow: 1;
+        background-color: #fff;
+        margin: 0px;
+        padding: 10px 16px 10px 16px;
+        overflow-x: auto;
+    }
+    #content h1, h2, h3, h4, h5, h6 {
+        color: #555;
+        font-family: "Trebuchet MS", Verdana, sans-serif;
+        padding: 2px 10px 1px 0px;
+        margin: 0 0 10px 0;
+    }
+    h1 {
+        font-size: 2em;
+    }
+    h2 {
+        font-size: 1.8em;
+    }
+    h3 {
+        font-size: 1.5em;
+    }
+    h4 {
+        font-size: 1.2em;
+        border: none;
+        font-weight: bold;
+    }
+    h5 {
+        font-size: 1em;
+    }
+    h6 {
+        font-size: 1em; color: #8e8e8e;
+    }
+    a.heading_anchor { 
+        display: none;
+        margin-left: 6px;
+        text-decoration: none;
+    }
+    table.markdown_table{
+        border: 1px solid #bbb;
+        border-collapse: collapse;
+        padding: 4px;
+        margin-bottom: 4px;        
+        overflow: hidden;
+    }
+    table.markdown_table th{
+        border: 1px solid #bbb; 
+        padding: 4px;
+        display: table-cell;
+        vertical-align: inherit;
+        background-color:#EEEEEE;
+    }
+    table.markdown_table td{
+        border: 1px solid #bbb; 
+        padding: 4px;
+        display: table-cell;
+        vertical-align: inherit;
+    }
+    table.controlled{
+        border: 1px solid #e4e4e4;
+        border-collapse: collapse;
+        width: 100%;
+        margin-bottom: 4px;
+        border-spacing: 0px;
+        border-radius: 3px;
+        overflow: hidden;
+    }
+    table.controlled th {
+        background-color:#e1f1fa;
+        padding: 4px;
+        white-space:nowrap;
+        font-weight:bold;
+        border: 1px solid #bbb;
+    }
+    table.controlled td {
+        text-align:center;
+        vertical-align:middle;
+        padding-right:10px;
+        border: 1px solid #bbb;
+    }
+    table.controlled tr:first-child th {
+        border-top: 0;
+    }
+    table.controlled tr:last-child td {
+        border-bottom: 0;
+    }
+    table.controlled tr td:first-child,
+    table.controlled tr th:first-child {
+        border-left: 0;
+    }
+    table.controlled tr td:last-child,
+    table.controlled tr th:last-child {
+        border-right: 0;
+    }
+    table.controlled td.item_id {
+        width: 3%;
+        text-align: center;
+    }
+    table.controlled td.item_text{
+        text-align: left;
+    }
+    table.controlled:not(.odd-even) tbody tr:nth-child(odd) { background-color:#f6f7f8; }
+    table.controlled:not(.odd-even) tbody tr:nth-child(even) { background-color: #fff; }
+    table.controlled:not(.odd-even) tbody tr:nth-child(odd):hover,
+    table.controlled:not(.odd-even) tbody tr:nth-child(even):hover { background-color:#ffffdd; }
+    a, a:link, a:visited {
+        color: #169;
+        text-decoration: none;
+    }
+    div.blockquote {
+        display: block;
+        background:#f9f9fb;
+        border-left: 3px double #bbb;
+        font-style: italic;
+        padding: 4px 1em 4px 4px;
+        margin-top: 4px;
+        margin-bottom: 4px;
+    }
+</style>
 </head>
 <body>
-    {{CONTENT}}
+    <div id="main">
+        <div id="content">
+            {{CONTENT}}
+        </div>
+    </div>
 </body>
 

data/lib/almirah.rb

@@ -29,14 +29,26 @@ class Almirah
 
     # Link
     linker = Linker.new
-    linker.link(documentList[0], documentList[1])
+    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|
-      FileUtils.mkdir_p(pass + "/build/specifications/" + spec.key.downcase)
+
+      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,
       getGemRoot() + "/lib/almirah/templates/page.html",
        "#{pass}/build/specifications/#{spec.key.downcase}/#{spec.key.downcase}.html" )

metadata

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