Almirah 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48020d93e573f2cf9f630bc92e1b74f0f64fcdf3fe74986ab1f833437bb13aed
-  data.tar.gz: e38751efb3beaa7abc28c9eb58d0b604c0dc658a22e25498b39e27001e5c163c
+  metadata.gz: 99a9591235fc0f0e1820c572da3c24a1365e93ff7f32a78ceda1083e982f9ad3
+  data.tar.gz: 95a400de1b4ad0c471d1fbbc1ee68339618127ac18d9cb5e9429dc36bda2d252
 SHA512:
-  metadata.gz: 1cf68af758e43a86e79215b9017084246713b3a72b189a154e609a7f8da1709d7fe30de638493d52668349ed4a49e07977e53b6534f4a6fd92ba3ad8d484c4ac
-  data.tar.gz: 4eed1d68e546d5cb6ef70e7b6f6e2cb2217a22b6c6ba1356108cc341456889e3d857b50551a1398c53fe5d54eb1f27674a17955f60e7606b7fa4003b2eee12f0
+  metadata.gz: f77bcf2b93586fe371b48b863d27604390c22180666441cc8bc7329d2e87d361ce33d08da873b410245d77cabbc0784c285fad17946838fbd9f4d30d1ca34da2
+  data.tar.gz: 5f227475da116c2b5d13a023d3d1cb4476a49a862392819a854ac35e4d0624af20f7abe8730fa092177fa733259953bf1ab410dc96ba3f37d1e635955b4b0647

data/lib/almirah/doc_fabric.rb

@@ -8,12 +8,14 @@ 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/code_block"
 require_relative "doc_items/todo_block"
 require_relative "doc_items/controlled_paragraph"
 require_relative "doc_items/markdown_table"
 require_relative "doc_items/controlled_table"
 require_relative "doc_items/image"
 require_relative "doc_items/markdown_list"
+require_relative "doc_items/doc_footer"
 
 class DocFabric
 
@@ -39,6 +41,7 @@ class DocFabric
 
         tempMdTable = nil
         tempMdList = nil
+        tempCodeBlock = nil
 
         file = File.open( doc.path )
         file_lines = file.readlines     
@@ -186,7 +189,7 @@ class DocFabric
 
                     doc.items.append(item)
 
-                elsif res = /^(\*\s?)(.*)/.match(s)   #check if unordered list start
+                elsif res = /^(\*\s+)(.*)/.match(s)   #check if unordered list start
                     
                     if tempMdTable
                         doc.items.append tempMdTable
@@ -272,6 +275,32 @@ class DocFabric
                     item = Blockquote.new(res[1])
                     item.parent_doc = doc
                     doc.items.append(item)
+
+                elsif res = /^```(\w*)/.match(s)   #check if code block
+
+                    if tempMdTable
+                        doc.items.append tempMdTable
+                        tempMdTable = nil
+                    end
+                    if tempMdList
+                        doc.items.append tempMdList
+                        tempMdList = nil
+                    end 
+
+                    suggested_format = ""
+                    if res.length == 2
+                        suggested_format = res[1]
+                    end
+
+                    if tempCodeBlock
+                        # close already opened block
+                        doc.items.append(tempCodeBlock)
+                        tempCodeBlock = nil
+                    else
+                        #start code block
+                        tempCodeBlock = CodeBlock.new(suggested_format)
+                        tempCodeBlock.parent_doc = doc
+                    end
                 
                 elsif res = /^TODO\:(.*)/.match(s)   #check if TODO block
 
@@ -305,10 +334,13 @@ class DocFabric
                             tempMdList = nil
                         end
                     end
-
-                    item = Paragraph.new(s)
-                    item.parent_doc = doc
-                    doc.items.append(item)
+                    if tempCodeBlock
+                        tempCodeBlock.code_lines.append(s)
+                    else
+                        item = Paragraph.new(s)
+                        item.parent_doc = doc
+                        doc.items.append(item)
+                    end
                 end
             else
                 if tempMdList   # lists are separated by emty line from each other
@@ -326,5 +358,13 @@ class DocFabric
             doc.items.append tempMdList
             tempMdList = nil
         end
+        if tempCodeBlock
+            doc.items.append tempCodeBlock
+            tempCodeBlock = nil
+        end
+        # Add footer to close opened tables if any
+        item = DocFooter.new
+        item.parent_doc = doc
+        doc.items.append(item)
     end
 end

data/lib/almirah/doc_items/code_block.rb

@@ -0,0 +1,27 @@
+require_relative "doc_item"
+
+class CodeBlock < DocItem
+
+    attr_accessor :suggested_format
+    attr_accessor :code_lines
+
+    def initialize(suggested_format)
+        @suggested_format = suggested_format
+        @code_lines = Array.new
+    end
+
+    def to_html
+        s = ''
+
+        if @@htmlTableRenderInProgress
+            s += "</table>\n"
+            @@htmlTableRenderInProgress = false
+        end
+        s += "<code>"
+        @code_lines.each do |l|
+            s += l + " </br>"
+        end
+        s += "</code>\n"
+        return s
+    end
+end

data/lib/almirah/doc_items/doc_footer.rb

@@ -0,0 +1,17 @@
+require_relative "doc_item"
+
+class DocFooter < DocItem
+
+    def initialize
+    end
+
+    def to_html
+        s = ''
+        if @@htmlTableRenderInProgress
+            s += "</table>\n"
+            @@htmlTableRenderInProgress = false
+        end
+        return s
+    end
+
+end

data/lib/almirah/doc_items/markdown_list.rb

@@ -47,7 +47,9 @@ class MarkdownList < DocItem
 
         elsif pos < @@lists_stack[-1].indent_position
 
-            @@lists_stack.pop
+            while pos < @@lists_stack[-1].indent_position
+                @@lists_stack.pop
+            end
             @@lists_stack[-1].rows.append(row)
 
         else
@@ -70,14 +72,27 @@ class MarkdownList < DocItem
     def calculate_text_position(s)
         s.downcase
         pos = 0
-        space_detected = false
+        state = 'looking_for_list_item_marker'
         s.each_char do |c|
-            if space_detected
-                if c != ' ' && c != '\t' && c != '*' && c != '.' && !numeric?(c)
+            if state == 'looking_for_list_item_marker'
+                if c == '*'
+                    state = 'looking_for_space'
+                elsif numeric?(c)
+                    state = 'looking_for_dot'
+                end
+            elsif state == 'looking_for_dot'
+                if c == '.'
+                    state = 'looking_for_space'
+                end
+            elsif state == 'looking_for_space'
+                if c == ' ' || c == '\t'
+                    state = 'looking_for_non_space'
+                end
+            elsif state == 'looking_for_non_space'
+                if c != ' ' || c != '\t'
+                    state = 'list_item_text_pos_found'
                     break
                 end
-            elsif c == ' ' || c == '\t'
-                space_detected = true
             end
             pos += 1
         end

data/lib/almirah/doc_items/text_line.rb

@@ -155,7 +155,7 @@ class TextLine
     def link(link_text, link_url)
 
         # define default result first
-        result = "<a href=\"#{link_url}\" class=\"external\">#{link_text}</a>"
+        result = "<a target=\"_blank\" rel=\"noopener\" href=\"#{link_url}\" class=\"external\">#{link_text}</a>"
 
         lazy_doc_id, anchor = nil, nil
 

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>Wrong<br>links</th>\n"
         s += "\t\t<th>TODOs</th>\n"
         s += "\t\t<th>Last Used<br>id</th>\n"
         s += "</thead>\n"
@@ -63,6 +64,22 @@ class Index < BaseDocument
             else
                 s += "\t\t<td class=\"item_id\" style='width: 7%;'>#{doc.duplicated_ids_number.to_s}</td>\n"
             end
+
+            if doc.wrong_links_hash.length >0
+                s += "\t\t<td class=\"item_id\" style='width: 7%; background-color: #fcc;'>"
+                s += "<div id=\"DL_#{doc.id}wl\" style=\"display: block;\">"
+                s += "<a  href=\"#\" onclick=\"downlink_OnClick(this.parentElement); return false;\" class=\"external\">#{doc.wrong_links_hash.length.to_s}</a>"
+                s += "</div>"
+                s += "<div id=\"DLS_#{doc.id}wl\" style=\"display: none;\">"
+                doc.wrong_links_hash.each do |wrong_lnk, item|
+                    s += "\t\t\t<a href=\"./specifications/#{doc.id}/#{doc.id}.html##{item.id}\" class=\"external\">#{wrong_lnk}</a>\n<br>"
+                end
+                s += "</div>"
+                s += "</td>\n"
+            else
+                s += "\t\t<td class=\"item_id\" style='width: 7%;'>#{doc.wrong_links_hash.length.to_s}</td>\n"
+            end
+
             if doc.todo_blocks.length >0
                 color = "background-color: #fcc;"
             else

data/lib/almirah/doc_types/specification.rb

@@ -6,6 +6,7 @@ class Specification < BaseDocument
     attr_accessor :dictionary
     attr_accessor :controlled_items
     attr_accessor :todo_blocks
+    attr_accessor :wrong_links_hash
 
     attr_accessor :items_with_uplinks_number
     attr_accessor :items_with_downlinks_number
@@ -25,6 +26,7 @@ class Specification < BaseDocument
         @dictionary = Hash.new
         @duplicates_list = Array.new
         @todo_blocks = Array.new
+        @wrong_links_hash = Hash.new
 
         @items_with_uplinks_number = 0
         @items_with_downlinks_number = 0

data/lib/almirah/doc_types/traceability.rb

@@ -57,7 +57,7 @@ class Traceability < BaseDocument
     def render_table_row(top_item)
         s = ""
         top_f_text = top_item.format_string( top_item.text )
-
+        
         if top_item.down_links
 
             if @is_agregated
@@ -81,6 +81,7 @@ class Traceability < BaseDocument
                 end
 
             else
+                top_item_rendered = false
                 top_item.down_links.each do |bottom_item|
 
                     id_color = ""
@@ -97,8 +98,18 @@ class Traceability < BaseDocument
                         s += "\t\t<td class=\"item_text\" style='width: 34%;'>#{bottom_f_text}</td>\n"
                         s += "\t\t<td class=\"item_text\" style='width: 16%;'>#{document_section}</td>\n"
                         s += "\t</tr>\n"
+                        top_item_rendered = true
                     end
                 end
+                unless top_item_rendered
+                    s += "\t<tr>\n"
+                    s += "\t\t<td class=\"item_id\" #{id_color}><a href=\"./../#{top_item.parent_doc.id}/#{top_item.parent_doc.id}.html##{top_item.id}\" class=\"external\">#{top_item.id}</a></td>\n"
+                    s += "\t\t<td class=\"item_text\" style='width: 34%;'>#{top_f_text}</td>\n"
+                    s += "\t\t<td class=\"item_id\"></td>\n"
+                    s += "\t\t<td class=\"item_text\" style='width: 34%;'></td>\n"
+                    s += "\t\t<td class=\"item_text\" style='width: 16%;'></td>\n"
+                    s += "\t</tr>\n"
+                end
             end
         else
             s += "\t<tr>\n"

data/lib/almirah/project.rb

@@ -15,6 +15,7 @@ class Project
     attr_accessor :specifications_dictionary
     attr_accessor :index
     attr_accessor :project
+    attr_accessor :on_server
 
     def initialize(path)
         @project_root_directory = path
@@ -25,6 +26,7 @@ class Project
         @specifications_dictionary = Hash.new
         @index = nil
         @project = self
+        @on_server = false
 
         FileUtils.remove_dir(@project_root_directory + "/build", true)      
     end
@@ -35,6 +37,7 @@ class Project
         parse_all_protocols
         link_all_specifications
         link_all_protocols
+        check_wrong_specification_referenced
         create_index
         render_all_specifications(@specifications)
         render_all_specifications(@traceability_matrices)
@@ -49,6 +52,7 @@ class Project
         parse_test_run test_run
         link_all_specifications
         link_all_protocols
+        check_wrong_specification_referenced
         create_index
         render_all_specifications(@specifications)
         render_all_specifications(@traceability_matrices)
@@ -123,6 +127,37 @@ class Project
         end
     end
 
+    def check_wrong_specification_referenced
+
+        available_specification_ids = Hash.new
+
+        @specifications.each do |s|
+            available_specification_ids[ s.id.to_s.downcase ] = s
+        end
+
+        @specifications.each do |s|
+            s.up_link_doc_id.each do |key, value|
+                unless available_specification_ids.has_key?(key)
+                    # now key points to the doc_id that does not exist
+                    wrong_doc_id = key
+                    # find the item that reference to it
+                    s.controlled_items.each do |item|
+                        unless item.up_link_ids.nil?
+                            item.up_link_ids.each do |up_link_id|
+                                if tmp = /^([a-zA-Z]+)[-]\d+/.match(up_link_id) # SRS
+                                    if tmp[1].downcase == wrong_doc_id
+                                        # we got it finally!
+                                        s.wrong_links_hash[ up_link_id.to_s ] = item
+                                    end
+                                end
+                            end
+                        end
+                    end
+                end
+            end
+        end
+    end
+
     def link_two_specifications(doc_A, doc_B)
 
         if doc_B.up_link_doc_id.has_key?(doc_A.id.to_s)
@@ -149,6 +184,13 @@ class Project
                             top_document.items_with_downlinks_number += 1   # for statistics
                         end
                         topItem.down_links.append(item)
+                    else
+                        # check if there is a non existing link with the right doc_id
+                        if tmp = /^([a-zA-Z]+)[-]\d+/.match(up_lnk) # SRS
+                            if tmp[1].downcase == top_document.id.downcase
+                                bottom_document.wrong_links_hash[ up_lnk ] = item
+                            end
+                        end
                     end
                 end
             end

data/lib/almirah/templates/page.html

@@ -145,6 +145,15 @@
         margin-top: 4px;
         margin-bottom: 4px;
     }
+    code {
+        display: block;
+        background:#ffffee;
+        border-left: 3px double #bbb;
+        font-family: Consolas, Menlo, "Liberation Mono", Courier, monospace;
+        padding: 4px 1em 4px 4px;
+        margin-top: 4px;
+        margin-bottom: 4px;
+    }
     div.todoblock {
         display: block;
         background:#fcc;
@@ -294,6 +303,13 @@ window.onload = (event) => {
         elem.style.width = "640px";
     }
   }
+  // Scroll a bit to make navigated anchor visible
+  setTimeout(function() {
+        window.scrollBy({ 
+        top: -40,
+        behavior: "smooth"
+        });
+    }, 200);
 };
 
 function downlink_OnClick(clicked){
@@ -307,6 +323,8 @@ function navigate_to_home(){
     if (document.title != "Document Index")
     {
         window.location.href = "./../../index.html";
+    }else{
+        window.location.href = "./index.html";
     }
 }
 
@@ -341,16 +359,16 @@ function modal_close_OnClick(clicked){
         </div>
         <div id="content" href="javascript:void(0)" onclick="closeNav()">
             {{CONTENT}}
-        </div>
-    </div>
+        </div><!-- content -->
+    </div><!-- main -->
+    <div id="footer">
+        Powered by <a target="_blank" rel="noopener" href="https://www.almirah.site/">Almirah Framework</a>
+    </div><!-- footer -->
     <!-- 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>
 

data/lib/almirah.rb

@@ -7,9 +7,9 @@ class CLI < Thor
     def please(project_folder)
       a = Almirah.new project_folder
       if options[:results]
-        a.results options[:results]
+        a.results( options[:results], false )
       else
-        a.default
+        a.default(false)
       end
     end
 
@@ -18,6 +18,17 @@ class CLI < Thor
     a = Almirah.new project_folder
     a.transform "docx"
   end
+
+  option :results
+  desc "server <project_folder>", "say <project_folder>"
+  def server(project_folder)
+    a = Almirah.new project_folder
+    if options[:results]
+      a.results( options[:results], true )
+    else
+      a.default(true)
+    end
+  end
 end
 
 class Almirah
@@ -32,7 +43,8 @@ class Almirah
     File.expand_path './..', File.dirname(__FILE__)
   end
 
-  def results( test_run )
+  def results( test_run, on_server )
+    @project.on_server = on_server
     @project.specifications_and_results test_run
   end
 
@@ -40,7 +52,8 @@ class Almirah
     @project.transform file_extension
   end
 
-  def default()
+  def default(on_server)
+    @project.on_server = on_server
     @project.specifications_and_protocols
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: Almirah
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Oleksandr Ivanov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-30 00:00:00.000000000 Z
+date: 2024-04-28 00:00:00.000000000 Z
 dependencies: []
 description: The software part of the Almirah framework
 email: oleksandr.ivanov.development@gmail.com
@@ -21,9 +21,11 @@ files:
 - lib/almirah.rb
 - lib/almirah/doc_fabric.rb
 - lib/almirah/doc_items/blockquote.rb
+- lib/almirah/doc_items/code_block.rb
 - lib/almirah/doc_items/controlled_paragraph.rb
 - lib/almirah/doc_items/controlled_table.rb
 - lib/almirah/doc_items/controlled_table_row.rb
+- lib/almirah/doc_items/doc_footer.rb
 - lib/almirah/doc_items/doc_item.rb
 - lib/almirah/doc_items/heading.rb
 - lib/almirah/doc_items/image.rb
@@ -60,7 +62,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Almirah