Almirah 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4194e03230075235a57516fed73b44215dde4a7cb42474b641bdbd7ce8a6ad55
-  data.tar.gz: f1a4f05ca5b4cf643cd179019c67cb08ea69c8876a235dfa368e99ec782ab21f
+  metadata.gz: 48020d93e573f2cf9f630bc92e1b74f0f64fcdf3fe74986ab1f833437bb13aed
+  data.tar.gz: e38751efb3beaa7abc28c9eb58d0b604c0dc658a22e25498b39e27001e5c163c
 SHA512:
-  metadata.gz: 56dc9e44de93dccbaf9424d6b654c00e08591b9cdcd62b5061d3356441b68f3c5b6a61778cc9d78bcf277fceb8c25d1b6f9bf34ca6f1a0a0f0284ce361d346a2
-  data.tar.gz: 59790d27191f78845e8b7ca8e19f0c26858234dbb419f248de5034a1aac3451ed9afbcc26905fa062c2efc13b0613f3a60e2b9e57b590c3f6cd01ff55df83809
+  metadata.gz: 1cf68af758e43a86e79215b9017084246713b3a72b189a154e609a7f8da1709d7fe30de638493d52668349ed4a49e07977e53b6534f4a6fd92ba3ad8d484c4ac
+  data.tar.gz: 4eed1d68e546d5cb6ef70e7b6f6e2cb2217a22b6c6ba1356108cc341456889e3d857b50551a1398c53fe5d54eb1f27674a17955f60e7606b7fa4003b2eee12f0

data/lib/almirah/doc_fabric.rb

@@ -8,6 +8,7 @@ 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/todo_block"
 require_relative "doc_items/controlled_paragraph"
 require_relative "doc_items/markdown_table"
 require_relative "doc_items/controlled_table"
@@ -58,25 +59,32 @@ class DocFabric
 
                     level = res[1].length
                     value = res[2]
+
+                    if level == 1 && doc.title == ""
+                        doc.title = value
+                        Heading.reset_global_section_number()
+                    end 
+
                     item = Heading.new(value, level)
                     item.parent_doc = doc
                     doc.items.append(item)
                     doc.headings.append(item)
-
-                    if level == 1 && doc.title == ""
-                        doc.title = value
-                    end   
+  
                 elsif res = /^\%\s(.*)/.match(s)     # Pandoc Document Title
 
                     title = res[1]
+
+                    if doc.title == ""
+                        doc.title = title
+                        Heading.reset_global_section_number()
+                    end 
+
                     item = Heading.new(title, 1)
                     item.parent_doc = doc
                     doc.items.append(item)
                     doc.headings.append(item)
 
-                    if doc.title == ""
-                        doc.title = title
-                    end 
+                    Heading.reset_global_section_number()   # Pandoc Document Title is not a section, so it shall not be taken into account in numbering
                     
                 elsif res = /^\[(\S*)\]\s+(.*)/.match(s)     # Controlled Paragraph
 
@@ -91,35 +99,70 @@ class DocFabric
 
                     id = res[1]
                     text = res[2]
+                    up_links = nil
+
+                    #check if it contains the uplink (one or many)
+                    #TODO: check this regular expression
+                    first_pos = text.length # for trailing commas
+                    tmp =  text.scan( /(>\[(?>[^\[\]]|\g<0>)*\])/ )           # >[SRS-001], >[SYS-002]
+                    if tmp.length >0
+                        up_links = Array.new
+                        tmp.each do |ul|
+                            up_links.append(ul[0])
+                            # try to find the real end of text
+                            pos = text.index(ul[0])
+                            if pos < first_pos
+                                first_pos = pos
+                            end
+                            # remove uplink from text
+                            text = text.split(ul[0]).join("")
+                        end
+                        # remove trailing commas and spaces
+                        if text.length > first_pos
+                            first_pos -= 1
+                            text = text[0..first_pos].strip
+                        end
+                    end
 
-                    #check if it contains the uplink
-                    if tmp = /(.*)\s+>\[(\S*)\]$/.match(text)           # >[SRS-001]
+                    # since we already know id and text 
+                    item = ControlledParagraph.new( text, id )
 
-                        text = tmp[1]
-                        up_link = tmp[2]
-                        
-                        if tmp = /^([a-zA-Z]+)[-]\d+/.match(up_link)    # SRS
-                            doc.up_link_doc_id[ tmp[1].downcase.to_s ] = tmp[1].downcase       # multiple documents could be up-linked                            
+                    if up_links
+                        doc.items_with_uplinks_number += 1     #for statistics
+                        up_links.each do |ul|
+                            if tmp = />\[(\S*)\]$/.match(ul)                    # >[SRS-001]
+                                up_link_id = tmp[1]
+
+                                unless item.up_link_ids
+                                    item.up_link_ids = Array.new
+                                end
+
+                                item.up_link_ids.append(up_link_id)      
+                                    
+                                if tmp = /^([a-zA-Z]+)[-]\d+/.match(up_link_id) # SRS
+                                    doc.up_link_doc_id[ tmp[1].downcase.to_s ] = tmp[1].downcase       # multiple documents could be up-linked                            
+                                end
+                            end
                         end
                     end
 
-                    item = ControlledParagraph.new( text, id )
+                    
                     item.parent_doc = doc
                     item.parent_heading = doc.headings[-1]
-                    if up_link
-                         item.up_link = up_link
-                         doc.items_with_uplinks_number += 1     #for statistics
-                    end
 
                     doc.items.append(item)
-                    doc.dictionary[ id.to_s ] = item       #for fast search
+                    #for statistics
+                    if doc.dictionary.has_key?( id.to_s )
+                        doc.duplicated_ids_number += 1
+                        doc.duplicates_list.append(item)
+                    else
+                        doc.dictionary[ id.to_s ] = item       #for fast search
+                    end
                     doc.controlled_items.append(item)      #for fast search
 
                     #for statistics
                     n = /\d+/.match(id)[0].to_i
-                    if n == doc.last_used_id_number
-                        doc.duplicated_ids_number += 1
-                    elsif n > doc.last_used_id_number
+                    if n > doc.last_used_id_number
                         doc.last_used_id = id
                         doc.last_used_id_number = n
                     end
@@ -229,6 +272,24 @@ class DocFabric
                     item = Blockquote.new(res[1])
                     item.parent_doc = doc
                     doc.items.append(item)
+                
+                elsif res = /^TODO\:(.*)/.match(s)   #check if TODO block
+
+                    if tempMdTable
+                        doc.items.append tempMdTable
+                        tempMdTable = nil
+                    end
+                    if tempMdList
+                        doc.items.append tempMdList
+                        tempMdList = nil
+                    end 
+
+                    text = "**TODO**: " + res[1]
+
+                    item = TodoBlock.new(text)
+                    item.parent_doc = doc
+                    doc.items.append(item)
+                    doc.todo_blocks.append(item)
 
                 else # Reqular Paragraph
                     if tempMdTable

data/lib/almirah/doc_items/controlled_paragraph.rb

@@ -3,14 +3,14 @@ require_relative "paragraph"
 class ControlledParagraph < Paragraph
 
     attr_accessor :id
-    attr_accessor :up_link
+    attr_accessor :up_link_ids
     attr_accessor :down_links
     attr_accessor :coverage_links
 
     def initialize(text, id)
         @text = text.strip
         @id = id
-        @up_link = nil
+        @up_link_ids = nil
         @down_links = nil
         @coverage_links = nil
     end
@@ -27,11 +27,27 @@ class ControlledParagraph < Paragraph
         s += "\t\t<td class=\"item_id\"> <a name=\"#{@id}\" id=\"#{@id}\" href=\"##{@id}\">#{@id}</a></td>\n"
         s += "\t\t<td class=\"item_text\">#{f_text}</td>\n"
 
-        if @up_link
-            if tmp = /^([a-zA-Z]+)[-]\d+/.match(@up_link)
-                up_link_doc_name = tmp[1].downcase
+        if @up_link_ids
+            if @up_link_ids.length == 1
+                if tmp = /^([a-zA-Z]+)[-]\d+/.match(@up_link_ids[0])
+                    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##{@up_link_ids[0]}\" class=\"external\">#{@up_link_ids[0]}</a></td>\n"
+            else
+                s += "\t\t<td class=\"item_id\">"
+                s += "<div id=\"DL_#{@id}\" style=\"display: block;\">"
+                s += "<a  href=\"#\" onclick=\"downlink_OnClick(this.parentElement); return false;\" class=\"external\">#{@up_link_ids.length}</a>"
+                s += "</div>"
+                s += "<div id=\"DLS_#{@id}\" style=\"display: none;\">"
+                @up_link_ids.each do |lnk|
+                    if tmp = /^([a-zA-Z]+)[-]\d+/.match(lnk)
+                        up_link_doc_name = tmp[1].downcase
+                    end
+                    s += "\t\t\t<a href=\"./../#{up_link_doc_name}/#{up_link_doc_name}.html##{lnk}\" class=\"external\">#{lnk}</a>\n<br>"
+                end
+                s += "</div>"
+                s += "</td>\n"
             end
-            s += "\t\t<td class=\"item_id\"><a href=\"./../#{up_link_doc_name}/#{up_link_doc_name}.html##{@up_link}\" class=\"external\">#{@up_link}</a></td>\n"
         else
             s += "\t\t<td class=\"item_id\"></td>\n"
         end

data/lib/almirah/doc_items/heading.rb

@@ -13,7 +13,7 @@ class Heading < Paragraph
         @level = level
         @anchor_id = getTextWithoutSpaces()
 
-        if @@global_section_number = ""
+        if @@global_section_number == ""
             @@global_section_number = "1"
             for n in 1..(level-1) do
                 @@global_section_number += ".1"
@@ -27,16 +27,21 @@ class Heading < Paragraph
                 a[-1] = (a[-1].to_i() +1).to_s
                 @@global_section_number = a.join(".")
 
-            elsif previous_level < level
+            elsif level > previous_level
 
                 a = @@global_section_number.split(".")
                 a.push("1")
                 @@global_section_number = a.join(".")
             
-            else # previous_level > level
+            else # level < previous_level
 
                 a = @@global_section_number.split(".")
-                a.pop
+                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
@@ -59,4 +64,8 @@ class Heading < Paragraph
         s += "&para;</a></h#{headingLevel}>"
         return s
     end
+
+    def self.reset_global_section_number
+        @@global_section_number = ""
+    end
 end

data/lib/almirah/doc_items/image.rb

@@ -21,7 +21,8 @@ class Image < DocItem
             @@htmlTableRenderInProgress = false
         end
 
-        s += "<p style=\"margin-top: 15px;\"><img src=\"#{@path}\" alt=\"#{@text}\">"
+        s += "<p style=\"margin-top: 15px;\"><img src=\"#{@path}\" alt=\"#{@text}\" "
+        s += "href=\"javascript:void(0)\" onclick=\"image_OnClick(this)\">"
         return s
     end
 end

data/lib/almirah/doc_items/todo_block.rb

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

data/lib/almirah/doc_types/index.rb

@@ -34,6 +34,7 @@ class Index < BaseDocument
         s += "\t\t<th>Items<br>w/ Downlinks</th>\n"
         s += "\t\t<th>Covered<br>by Tests</th>\n"
         s += "\t\t<th>Duplicated<br>ids</th>\n"
+        s += "\t\t<th>TODOs</th>\n"
         s += "\t\t<th>Last Used<br>id</th>\n"
         s += "</thead>\n"
         html_rows.append s
@@ -47,7 +48,27 @@ class Index < BaseDocument
             s += "\t\t<td class=\"item_id\" style='width: 7%;'>#{doc.items_with_uplinks_number.to_s}</td>\n"
             s += "\t\t<td class=\"item_id\" style='width: 7%;'>#{doc.items_with_downlinks_number.to_s}</td>\n"
             s += "\t\t<td class=\"item_id\" style='width: 7%;'>#{doc.items_with_coverage_number.to_s}</td>\n"
-            s += "\t\t<td class=\"item_id\" style='width: 7%;'>#{doc.duplicated_ids_number.to_s}</td>\n"
+            
+            if doc.duplicated_ids_number >0
+                s += "\t\t<td class=\"item_id\" style='width: 7%; background-color: #fcc;'>"
+                s += "<div id=\"DL_#{doc.id}\" style=\"display: block;\">"
+                s += "<a  href=\"#\" onclick=\"downlink_OnClick(this.parentElement); return false;\" class=\"external\">#{doc.duplicated_ids_number.to_s}</a>"
+                s += "</div>"
+                s += "<div id=\"DLS_#{doc.id}\" style=\"display: none;\">"
+                doc.duplicates_list.each do |lnk|
+                    s += "\t\t\t<a href=\"./specifications/#{doc.id}/#{doc.id}.html##{lnk.id}\" class=\"external\">#{lnk.id}</a>\n<br>"
+                end
+                s += "</div>"
+                s += "</td>\n"
+            else
+                s += "\t\t<td class=\"item_id\" style='width: 7%;'>#{doc.duplicated_ids_number.to_s}</td>\n"
+            end
+            if doc.todo_blocks.length >0
+                color = "background-color: #fcc;"
+            else
+                color = ""
+            end
+            s += "\t\t<td class=\"item_id\" style='width: 7%; #{color}'>#{doc.todo_blocks.length.to_s}</td>\n"
             s += "\t\t<td class=\"item_id\" style='width: 7%;'>#{doc.last_used_id.to_s}</td>\n"
             s += "</tr>\n"
             html_rows.append s

data/lib/almirah/doc_types/specification.rb

@@ -5,11 +5,13 @@ class Specification < BaseDocument
     attr_accessor :up_link_doc_id
     attr_accessor :dictionary
     attr_accessor :controlled_items
+    attr_accessor :todo_blocks
 
     attr_accessor :items_with_uplinks_number
     attr_accessor :items_with_downlinks_number
     attr_accessor :items_with_coverage_number
     attr_accessor :duplicated_ids_number
+    attr_accessor :duplicates_list
     attr_accessor :last_used_id
     attr_accessor :last_used_id_number
 
@@ -21,6 +23,8 @@ class Specification < BaseDocument
         @headings = Array.new
         @controlled_items = Array.new
         @dictionary = Hash.new
+        @duplicates_list = Array.new
+        @todo_blocks = Array.new
 
         @items_with_uplinks_number = 0
         @items_with_downlinks_number = 0

data/lib/almirah/project.rb

@@ -137,15 +137,20 @@ class Project
         #puts "Link: #{doc_A.id} - #{doc_B.id}" 
         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
-                    top_document.items_with_downlinks_number += 1   # for statistics
+            if item.up_link_ids
+                item.up_link_ids.each do |up_lnk|
+
+                    if top_document.dictionary.has_key?(up_lnk.to_s)
+
+                        topItem = top_document.dictionary[up_lnk.to_s]
+                        
+                        unless topItem.down_links
+                            topItem.down_links = Array.new
+                            top_document.items_with_downlinks_number += 1   # for statistics
+                        end
+                        topItem.down_links.append(item)
+                    end
                 end
-                topItem.down_links.append(item)
             end
         end
         # create treceability document

data/lib/almirah/templates/page.html

@@ -2,6 +2,7 @@
 <html lang="en">
 <head>
 <meta charset="utf-8" />
+<title>{{DOCUMENT_TITLE}}</title>
 <!-- CSS -->
 <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
 <style>
@@ -144,6 +145,25 @@
         margin-top: 4px;
         margin-bottom: 4px;
     }
+    div.todoblock {
+        display: block;
+        background:#fcc;
+        border-left: 3px double #bbb;
+        font-style: italic;
+        padding: 4px 1em 4px 4px;
+        margin-top: 4px;
+        margin-bottom: 4px;
+    }
+    img:hover{
+        transition: 0.3s;
+    }
+    img{
+        opacity: 0.9;
+        cursor: pointer;
+    }
+    #modal_image_id{
+        cursor: default;
+    } 
     #nav_pane{
         flex-shrink: 0;
         padding: 16px 8px 2px 8px;
@@ -164,6 +184,7 @@
         overflow: hidden;
         position: fixed;
         width: 100%;    
+        z-index: 1;
     }
     #top_nav a {
         float: left;
@@ -191,7 +212,67 @@
         background-color: #169;
         color: white;
     }
-
+    .modal {
+        display: none; /* Hidden by default */
+        position: fixed; /* Stay in place */
+        z-index: 1; /* Sit on top */
+        padding-top: 100px; /* Location of the box */
+        left: 0;
+        top: 0;
+        width: 100%; /* Full width */
+        height: 100%; /* Full height */
+        overflow: auto; /* Enable scroll if needed */
+        background-color: rgb(0,0,0); /* Fallback color */
+        background-color: rgba(0,0,0,0.9); /* Black w/ opacity */
+    }
+    .modal_image {
+        margin: auto;
+        display: block;
+        width: 97%;
+        /*max-width: 700px;*/
+    }
+    #modal_image_caption {
+        margin: auto;
+        display: block;
+        width: 80%;
+        max-width: 700px;
+        text-align: center;
+        color: #ccc;
+        padding: 10px 0;
+        height: 150px;
+    }
+    .modal_image, #modal_image_caption {  
+        animation-name: zoom;
+        animation-duration: 0.6s;
+    }
+    @keyframes zoom {
+        from {transform: scale(0.1)} 
+        to {transform: scale(1)}
+    }
+    .modal_close_btn {
+        position: absolute;
+        top: 15px;
+        right: 35px;
+        color: #f1f1f1;
+        font-size: 30px;
+        font-weight: bold;
+        transition: 0.3s;
+    }
+    .modal_close_btn:hover,
+    .modal_close_btn:focus {
+        color: #bbb;
+        text-decoration: none;
+        cursor: pointer;
+    }
+    #footer {
+        clear: both;
+        border-top: 1px solid #bbb;
+        font-size: 0.9em;
+        color: #aaa;
+        padding: 5px;
+        text-align:center;
+        background:#fff;
+    }
 </style>
 <script>
 function openNav() {
@@ -221,11 +302,36 @@ function downlink_OnClick(clicked){
     required_id = "DLS_" + id_parts[1];
     document.getElementById(required_id).style.display = 'block';
 }
+
+function navigate_to_home(){
+    if (document.title != "Document Index")
+    {
+        window.location.href = "./../../index.html";
+    }
+}
+
+// Modal window for image zoom
+function image_OnClick(clicked){
+
+    var modal = document.getElementById('image_modal_div');
+    var modalImg = document.getElementById("modal_image_id");
+    var captionText = document.getElementById("modal_image_caption");
+
+    modal.style.display = "block";
+    modalImg.src = clicked.src;
+    captionText.innerHTML = clicked.alt;
+}
+
+function modal_close_OnClick(clicked){
+    var modal = document.getElementById('image_modal_div');
+    modal.style.display = "none";
+}
+
 </script>
 </head>
 <body>
     <div id="top_nav">
-        <a href="./../../index.html"><span><i class="fa fa-home" aria-hidden="true"></i></span>&nbsp;Home</a>
+        <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>
@@ -237,5 +343,14 @@ function downlink_OnClick(clicked){
             {{CONTENT}}
         </div>
     </div>
+    <!-- The modal window for image zoom -->
+    <div id="image_modal_div" class="modal">
+        <span class="modal_close_btn" href="javascript:void(0)" onclick="modal_close_OnClick(this)">&times;</span>
+        <img class="modal_image" id="modal_image_id">
+        <div id="modal_image_caption"></div>
+    </div>
+    <div id="footer">
+        Powered by <a target="_blank" rel="noopener" href="https://www.almirah.site/">Almirah Framework</a>
+    </div>
 </body>
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: Almirah
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Oleksandr Ivanov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-13 00:00:00.000000000 Z
+date: 2024-03-30 00:00:00.000000000 Z
 dependencies: []
 description: The software part of the Almirah framework
 email: oleksandr.ivanov.development@gmail.com
@@ -31,6 +31,7 @@ files:
 - lib/almirah/doc_items/markdown_table.rb
 - lib/almirah/doc_items/paragraph.rb
 - lib/almirah/doc_items/text_line.rb
+- lib/almirah/doc_items/todo_block.rb
 - lib/almirah/doc_types/base_document.rb
 - lib/almirah/doc_types/coverage.rb
 - lib/almirah/doc_types/index.rb