Almirah 0.0.1 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a29ec9ab722212c37c713f3c6bc21466d4e5c346fac874df35668e6870b8fea6
-  data.tar.gz: 9b77c2ef7c49daa90bb4eb9b0113e9f5058f0bdf02c36d91a1c80ec68555d57e
+  metadata.gz: 0cec091b4437bbdeb9ea83b3a55638fafef7b0d629ba9eb1f069594ec420651c
+  data.tar.gz: 6de241968325f0d89227f25b854332aa697a8af659e49d91fe5130112fcb31ea
 SHA512:
-  metadata.gz: 6470130f1031b6bbaba1b1fda333172242c63638cbafcd98f628072d100d2ed135dba1c638abac86da92f7869e004eaf9bf6a42fec56893223f75846e631efc5
-  data.tar.gz: 8d37951766677fabb80f64840816539c48b38da9fe5fadc778da5f1e5cf64a0ddc06b5ef636231b01446facd8cbb4b2326adec0505558d21ad3062691cd7a681
+  metadata.gz: 5196218711f21202659e7cf84b5e1f8329ace42a00831d80acc275357e4b2b38cecb1af6842cc3b9b439f8a1d8c78610761756af5b9e565ce77b3f0aa64d24fd
+  data.tar.gz: a23964002a9c745e7529182b6e2ae684b4ca6a9fd7c963a7eae553c370ac64565edd6be4412dfa27c8ed4517f9273562e14ab4adfebe818cf13bce6102b72736

data/bin/almirah

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "almirah"
+
+CLI.start(ARGV)

data/lib/almirah/doc_items/blockquote.rb

@@ -0,0 +1,21 @@
+require_relative "doc_item"
+
+class Blockquote < DocItem
+
+    attr_accessor :text
+
+    def initialize(text)
+        @text = text
+    end
+
+    def to_html
+        s = ''
+        if @@htmlTableRenderInProgress
+            s += "</table>\n\r"
+            @@htmlTableRenderInProgress = false
+        end
+
+        s += "<div class=\"blockquote\"><p>#{@text}</div>\n\r"
+        return s
+    end
+end

data/lib/almirah/doc_items/controlled_paragraph.rb

@@ -0,0 +1,52 @@
+require_relative "paragraph"
+
+class ControlledParagraph < Paragraph
+
+    attr_accessor :id
+    attr_accessor :up_link
+    attr_accessor :down_links
+
+    def initialize(text, id)
+        @text = text
+        @id = id
+        @up_link = nil
+        @down_links = nil
+    end
+
+    def to_html
+        s = ''
+        unless @@htmlTableRenderInProgress                    
+            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 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 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 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 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 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 class=\"item_id\"></td>\n\r"    # COV
+        s += "\t</tr>\n\r"
+        return s
+    end 
+
+end

data/lib/almirah/doc_items/doc_item.rb

@@ -0,0 +1,8 @@
+class DocItem
+    @@htmlTableRenderInProgress = false
+end
+
+
+
+
+

data/lib/almirah/doc_items/heading.rb

@@ -0,0 +1,25 @@
+require_relative "paragraph"
+
+class Heading < Paragraph
+
+    attr_accessor :level
+
+    def initialize(text, level)
+        @text = text
+        @level = level
+    end
+
+    def to_html
+        s = ''
+        if @@htmlTableRenderInProgress
+            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\">"
+        s += "&para;</a></h#{headingLevel}>"
+        return s
+    end
+end

data/lib/almirah/doc_items/markdown_table.rb

@@ -0,0 +1,47 @@
+require_relative "doc_item"
+
+class MarkdownTable < DocItem
+
+    attr_accessor :column_names
+    attr_accessor :rows
+
+    def initialize(heading_row)
+        @column_names = heading_row.split('|')
+        @rows = Array.new
+    end
+
+    def addRow(row)
+        columns = row.split('|')
+        @rows.append(columns)
+    end
+
+    def to_html
+        s = ''
+        if @@htmlTableRenderInProgress
+            s += "</table>"
+            @@htmlTableRenderInProgress = false
+        end
+                   
+        s += "<table class=\"markdown_table\">\n\r"
+        s += "\t<thead>" 
+
+        @column_names.each do |h|
+            s += " <th>#{h}</th>"
+        end
+
+        s += " </thead>\n\r"
+
+        @rows.each do |row|
+            s += "\t<tr>\n\r"
+            row.each do |col|
+                s += "\t\t<td>#{col}</td>\n\r"
+            end
+            s += "\t</tr>\n\r"
+        end
+
+        s += "</table>\n\r"
+
+        return s
+    end
+
+end

data/lib/almirah/doc_items/paragraph.rb

@@ -0,0 +1,25 @@
+require_relative "doc_item"
+
+class Paragraph < DocItem
+
+    attr_accessor :text
+
+    def initialize(text)
+        @text = text
+    end
+
+    def getTextWithoutSpaces
+        return @text.split.join('-')
+    end
+
+    def to_html
+        s = ''
+        if @@htmlTableRenderInProgress
+            s += "</table>"
+            @@htmlTableRenderInProgress = false
+        end
+
+        s += "<p>#{@text}"
+        return s
+    end
+end

data/lib/almirah/html_render.rb

@@ -0,0 +1,53 @@
+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
+
+    attr_accessor :template
+    attr_accessor :htmlRows
+    attr_accessor :outputFile
+    attr_accessor :document
+
+    def initialize(document, template, outputFile)
+
+        @template = template
+        @outputFile = outputFile
+        @htmlRows = Array.new
+        @document = document
+
+        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
+            else
+                file.puts s
+            end
+        end
+        file.close
+    end
+
+end

data/lib/almirah/linker.rb

@@ -0,0 +1,42 @@
+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

data/lib/almirah/specification.rb

@@ -0,0 +1,131 @@
+require_relative "doc_items/doc_item"
+require_relative "doc_items/heading"
+require_relative "doc_items/paragraph"
+require_relative "doc_items/blockquote"
+require_relative "doc_items/controlled_paragraph"
+require_relative "doc_items/markdown_table"
+
+class Specification
+
+    attr_accessor :path
+    attr_accessor :docItems
+    attr_accessor :title
+    attr_accessor :key
+    attr_accessor :up_link_key
+    attr_accessor :dictionary
+    attr_accessor :controlledParagraphs
+    attr_accessor :tempMdTable
+
+    def initialize(fele_path)
+
+        @path = fele_path
+        @title = ""
+        @docItems = Array.new
+        @controlledParagraphs = Array.new
+        @dictionary = Hash.new
+        @tempMdTable = nil
+
+        @key = File.basename(fele_path, File.extname(fele_path)).upcase
+        @up_link_key = ""
+
+        self.parse()
+    end
+
+    def parse()
+
+        file = File.open( self.path )
+        file_lines = file.readlines     
+        file.close
+
+        file_lines.each do |s|
+            if s.lstrip != ""
+                if res = /^([#]{1,})\s(.*)/.match(s)     # Heading    
+                    
+                    if @tempMdTable
+                        self.docItems.append(@tempMdTable)
+                        @tempMdTable = nil
+                    end 
+
+                    level = res[1].length
+                    value = res[2]
+                    item = Heading.new(value, level)
+                    self.docItems.append(item)
+                    
+                    if level == 1
+                        self.title = value
+                    end   
+                     
+                elsif res = /^\[(\S*)\]\s+(.*)/.match(s)     # Controlled Paragraph
+
+                    if @tempMdTable
+                        self.docItems.append(@tempMdTable)
+                        @tempMdTable = nil
+                    end 
+
+                    id = res[1]
+                    text = res[2]
+
+                    #check if it contains the uplink
+                    if tmp = /(.*)\s+>\[(\S*)\]$/.match(text)
+
+                        text = tmp[1]
+                        up_link = tmp[2]
+                        
+                        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 s[0] == '|'   #check if table
+
+                    if res = /^[|](-{3,})[|]/.match(s) #check if it is a separator first
+
+                        if @tempMdTable 
+                            #separator is found after heading - just skip it
+                        else
+                            #separator out of table scope consider it just as a regular paragraph
+                            item = Paragraph.new(s)
+                            self.docItems.append(item)
+                        end
+
+                    elsif res = /^[|](.*[|])/.match(s) #check if it looks as a table
+
+                        row = res[1]
+
+                        if @tempMdTable
+                            @tempMdTable.addRow(row)
+                        else
+                            #start table from heading
+                            @tempMdTable = MarkdownTable.new(row)
+                        end
+                    end
+
+                elsif res = /^[>](.*)/.match(s)   #check if blockquote
+
+                    if @tempMdTable
+                        self.docItems.append(@tempMdTable)
+                        @tempMdTable = nil
+                    end 
+
+                    item = Blockquote.new(res[1])
+                    self.docItems.append(item)
+
+                else # Reqular Paragraph
+                    if @tempMdTable
+                        self.docItems.append(@tempMdTable)
+                        @tempMdTable = nil
+                    end 
+                    item = Paragraph.new(s)
+                    self.docItems.append(item)
+                end
+            end
+        end
+    end
+end

data/lib/almirah/templates/page.html

@@ -0,0 +1,147 @@
+<!DOCTYPE html>
+<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>
+    <div id="main">
+        <div id="content">
+            {{CONTENT}}
+        </div>
+    </div>
+</body>
+

data/lib/almirah.rb

@@ -1,5 +1,46 @@
+require "thor"
+require_relative "almirah/specification"
+require_relative "almirah/linker"
+require_relative "almirah/html_render"
+
+class CLI < Thor
+  desc "please <pass>", "say <pass>"
+    def please(pass)
+      Almirah.new().start(pass)
+    end
+end
+
 class Almirah
-  def self.hi
-    puts "Hi, this is Almirah gem. My development is in-progress."
+
+  def getGemRoot
+    File.expand_path './..', File.dirname(__FILE__)
   end
-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])
+
+    # 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,22 +1,34 @@
 --- !ruby/object:Gem::Specification
 name: Almirah
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.4
 platform: ruby
 authors:
 - Oleksandr Ivanov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-16 00:00:00.000000000 Z
+date: 2024-01-27 00:00:00.000000000 Z
 dependencies: []
 description: The software part of the Almirah system
 email: oleksandr.ivanov.development@gmail.com
-executables: []
+executables:
+- almirah
 extensions: []
 extra_rdoc_files: []
 files:
+- bin/almirah
 - lib/almirah.rb
+- lib/almirah/doc_items/blockquote.rb
+- lib/almirah/doc_items/controlled_paragraph.rb
+- lib/almirah/doc_items/doc_item.rb
+- lib/almirah/doc_items/heading.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
 licenses:
 - MIT