Almirah 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1841cdb6a5d88bcbe36d8ed926fd8f659e9a630d58763ead2b78e8b7f17281dd
-  data.tar.gz: 13b91603331fe68ff13f4b1917806551f94f11d98084ce773a1e247abb4b1abb
+  metadata.gz: 9e500204a8575e500989c7d86e4db4dff7a6247b14d3768904620be7a3cef356
+  data.tar.gz: a12d76101a33fc1938c0c42d361f84ae9a8c796684becd1567e154e67f345cad
 SHA512:
-  metadata.gz: ed609c1862a9f33b46c2379ae8f08904c30a00767939418e28600267ccc449aa88b7bcf96efc661c1c3d39d9a720a12491c01eed4c0c30034623f342a47d5d70
-  data.tar.gz: e5c91e4efbd5d96d915ad2228b22982391ccc91eae8afc545dc8c1fd1a8f077a690d9da988e47794df470eda560e7f6a0a99ec7a173d33660c0cc532de1c5e97
+  metadata.gz: eff42c3d45f0be71488484ce864740c5363e9169450d32469b9044136ea47af2989b32c4cb526c176c4d4721e60be0c5f484db8ed2245285eb042187a9c5df57
+  data.tar.gz: 2e5c4887b584428a71db8cbd33d244242c90df9b7b02aca8804f72f97fb017dfebc4aa8ff2ae52f924ae9895f7ac1b075cac2407ba84888db55cd36d97984344

data/lib/almirah/doc_fabric.rb

@@ -124,7 +124,7 @@ class DocFabric
 
                     doc.items.append(item)
 
-                elsif res = /^(\*\s?)+(.*)/.match(s)   #check if bullet list
+                elsif res = /^(\*\s?)(.*)/.match(s)   #check if unordered list start
                     
                     if tempMdTable
                         doc.items.append tempMdTable
@@ -136,7 +136,26 @@ class DocFabric
                     if tempMdList
                         tempMdList.addRow(row)
                     else
-                        item = MarkdownList.new(row)
+                        item = MarkdownList.new(false)
+                        item.addRow(s)
+                        item.parent_doc = doc
+                        tempMdList = item
+                    end
+
+                elsif res = /^\d[.]\s(.*)/.match(s)   #check if ordered list start
+                    
+                    if tempMdTable
+                        doc.items.append tempMdTable
+                        tempMdTable = nil
+                    end
+
+                    row = res[1]
+
+                    if tempMdList
+                        tempMdList.addRow(row)
+                    else
+                        item = MarkdownList.new(true)
+                        item.addRow(s)
                         item.parent_doc = doc
                         tempMdList = item
                     end
@@ -198,14 +217,24 @@ class DocFabric
                         tempMdTable = nil
                     end
                     if tempMdList
-                        doc.items.append tempMdList
-                        tempMdList = nil
+                        if MarkdownList.unordered_list_item?(s) || MarkdownList.ordered_list_item?(s)
+                            tempMdList.addRow(s)
+                            next
+                        else
+                            doc.items.append tempMdList
+                            tempMdList = nil
+                        end
                     end
 
                     item = Paragraph.new(s)
                     item.parent_doc = doc
                     doc.items.append(item)
                 end
+            else
+                if tempMdList   # lists are separated by emty line from each other
+                    doc.items.append tempMdList
+                    tempMdList = nil
+                end
             end
         end
         # Finalize non-closed elements

data/lib/almirah/doc_items/blockquote.rb

@@ -10,12 +10,13 @@ class Blockquote < DocItem
 
     def to_html
         s = ''
+        f_text = format_string(@text)
         if @@htmlTableRenderInProgress
             s += "</table>\n"
             @@htmlTableRenderInProgress = false
         end
 
-        s += "<div class=\"blockquote\"><p>#{@text}</div>\n"
+        s += "<div class=\"blockquote\"><p>#{f_text}</div>\n"
         return s
     end
 end

data/lib/almirah/doc_items/controlled_paragraph.rb

@@ -22,9 +22,10 @@ class ControlledParagraph < Paragraph
             s += "\t<thead> <th>#</th> <th>Text</th> <th>UL</th> <th>DL</th> <th>COV</th> </thead>\n"
             @@htmlTableRenderInProgress = true
         end
+        f_text = format_string(@text)
         s += "\t<tr>\n"
         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\">#{@text}</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)

data/lib/almirah/doc_items/controlled_table.rb

@@ -1,7 +1,7 @@
 require_relative "controlled_table_row"
+require_relative "text_line"
 
-
-class ControlledTableColumn
+class ControlledTableColumn < TextLine
 
     attr_accessor :text
     
@@ -10,7 +10,8 @@ class ControlledTableColumn
     end
 
     def to_html
-        "\t\t<td>#{@text}</td>\n\r"
+        f_text = format_string(@text)
+        "\t\t<td>#{f_text}</td>\n\r"
     end
 end
 
@@ -41,12 +42,13 @@ end
 class TestStepResultColumn <  ControlledTableColumn
 
     def to_html
+        f_text = format_string(@text)
         if @text.downcase == "pass"
-            "\t\t<td style=\"background-color: #cfc;\">#{@text}</td>\n\r"
+            "\t\t<td style=\"background-color: #cfc;\">#{f_text}</td>\n\r"
         elsif @text.downcase == "fail"
-            "\t\t<td style=\"background-color: #fcc;\">#{@text}</td>\n\r"
+            "\t\t<td style=\"background-color: #fcc;\">#{f_text}</td>\n\r"
         else
-            "\t\t<td>#{@text}</td>\n\r"
+            "\t\t<td>#{f_text}</td>\n\r"
         end
     end
 end

data/lib/almirah/doc_items/doc_item.rb

@@ -1,4 +1,6 @@
-class DocItem
+require_relative "text_line"
+
+class DocItem < TextLine
     attr_accessor :parent_doc
     
     @parent_doc = nil

data/lib/almirah/doc_items/heading.rb

@@ -8,7 +8,7 @@ class Heading < Paragraph
     def initialize(text, level)
         @text = text
         @level = level
-        @anchor_id = self.getTextWithoutSpaces()
+        @anchor_id = getTextWithoutSpaces()
     end
 
     def to_html

data/lib/almirah/doc_items/markdown_list.rb

@@ -3,14 +3,107 @@ require_relative "doc_item"
 class MarkdownList < DocItem
 
     attr_accessor :rows
+    attr_accessor :text
+    attr_accessor :is_ordered
+    attr_accessor :indent_position
+    attr_accessor :current_nesting_level
 
-    def initialize(first_row)
+    @@lists_stack = Array.new
+
+    def initialize(is_ordered)
         @rows = Array.new
-        @rows.append(first_row)
+        @is_ordered = is_ordered
+        @current_nesting_level = 0
+        @indent_position = 0
+        @text = ''
+
+        @@lists_stack.push(self)
+    end
+
+    def addRow(raw_text)
+        puts raw_text
+        pos = calculate_text_position(raw_text)
+        row = raw_text[pos..-1]
+
+        pos = calculate_indent_position(raw_text)
+
+        if pos > @@lists_stack[-1].indent_position
+
+            prev_lists_stack_item = @@lists_stack[-1]
+            # the following line pushes new list to the lists_stack in the constructor!
+            nested_list = MarkdownList.new( MarkdownList.ordered_list_item?(raw_text) )
+            nested_list.current_nesting_level = @current_nesting_level + 1
+            nested_list.indent_position = pos
+            
+            prev_row = prev_lists_stack_item.rows[-1]
+            if prev_row.is_a?(MarkdownList)
+                #cannot be there
+            else
+                nested_list.text = prev_row
+                puts "Length: " + prev_lists_stack_item.rows.length.to_s
+                prev_lists_stack_item.rows[-1] = nested_list
+            end
+            
+            nested_list.addRow(raw_text)
+
+        elsif pos < @@lists_stack[-1].indent_position
+
+            @@lists_stack.pop
+            @@lists_stack[-1].rows.append(row)
+
+        else
+            @@lists_stack[-1].rows.append(row)
+
+        end
+    end
+
+    def calculate_indent_position(s)
+        pos = 0
+        s.each_char do |c|
+            if non_blank?(c)
+                break
+            end
+            pos += 1
+        end
+        return pos
+    end
+    def calculate_text_position(s)
+        pos = 0
+        s.each_char do |c|
+            if letter?(c)
+                break
+            end
+            pos += 1
+        end
+        return pos
+    end
+
+    def letter?(c)
+        c.match?(/[[:alpha:]]/)
+    end
+      
+    def numeric?(c)
+        c.match?(/[[:digit:]]/)
     end
 
-    def addRow(row)
-        @rows.append(row)
+    def non_blank?(c)
+        c.match?(/[[:graph:]]/)
+    end
+
+    def self.unordered_list_item?(raw_text)
+
+        if res = /(\*\s?)(.*)/.match(raw_text)
+            return true
+        end
+        return false
+    end
+
+    def self.ordered_list_item?(raw_text)
+
+        if res = /\d[.]\s(.*)/.match(raw_text)
+            return true
+        end
+        return false
     end
 
     def to_html
@@ -20,11 +113,29 @@ class MarkdownList < DocItem
             @@htmlTableRenderInProgress = false
         end
 
-        s += "<ul>\n"
+        if @is_ordered
+            s += "<ol>\n"
+        else
+            s += "<ul>\n"
+        end
+        
         @rows.each do |r|
-            s += "\t<li>#{r}</li>\n"
+            if r.is_a?(MarkdownList)
+                f_text = format_string(r.text)
+                s += "\t<li>#{f_text}\n"
+                s += r.to_html()
+                s += "</li>\n"
+            else
+                f_text = format_string(r)
+                s += "\t<li>#{f_text}</li>\n"
+            end
         end
-        s += "</ul>\n"
+
+        if @is_ordered
+            s += "</ol>\n"
+        else
+            s += "</ul>\n"
+        end       
 
         return s
     end

data/lib/almirah/doc_items/markdown_table.rb

@@ -44,7 +44,8 @@ class MarkdownTable < DocItem
                 if col.to_i > 0 && col.to_i.to_s == col  # autoalign cells with numbers
                     s += "\t\t<td style=\"text-align: center;\">#{col}</td>\n"
                 else
-                    s += "\t\t<td>#{col}</td>\n"
+                    f_text = format_string(col)
+                    s += "\t\t<td>#{f_text}</td>\n"
                 end
             end
             s += "\t</tr>\n"

data/lib/almirah/doc_items/paragraph.rb

@@ -9,7 +9,7 @@ class Paragraph < DocItem
     end
 
     def getTextWithoutSpaces
-        return @text.split.join('-')
+        return @text.split.join('-').downcase
     end
 
     def to_html
@@ -19,7 +19,7 @@ class Paragraph < DocItem
             @@htmlTableRenderInProgress = false
         end
 
-        s += "<p>#{@text}"
+        s += "<p>" + format_string(@text)
         return s
     end
 end

data/lib/almirah/doc_items/text_line.rb

@@ -0,0 +1,169 @@
+class TextLine
+
+    def format_string(str)
+        state = 'default'
+        prev_state = 'default'
+        result = ''
+        stack = ''
+        prev_c = ''
+        link_text = ''
+        link_url = ''
+        str.each_char do |c|
+            if c == '*'
+                if state == 'default'
+                    prev_state = state
+                    state = 'first_asterisk_detected'
+
+                elsif state == 'first_asterisk_detected'
+                    prev_state = state
+                    state = 'second_asterisk_detected'
+                
+                elsif state == 'second_asterisk_detected'
+                    prev_state = state
+                    state = 'third_asterisk_detected'
+                
+                elsif state == 'second_asterisk_detected'
+                    prev_state = state
+                    state = 'third_asterisk_detected' 
+
+                elsif state == 'italic_started'
+                    prev_state = state
+                    state = 'default'
+                    result += italic(stack)
+
+                elsif state == 'bold_started'
+                    prev_state = state
+                    state = 'first_asterisk_after_bold_detected'
+
+                elsif state == 'first_asterisk_after_bold_detected'
+                    prev_state = state
+                    state = 'default'
+                    result += bold(stack)
+
+                elsif state == 'bold_and_italic_started'
+                    prev_state = state
+                    state = 'first_asterisk_after_bold_and_italic_detected'
+
+                elsif state == 'first_asterisk_after_bold_and_italic_detected'
+                    prev_state = state
+                    state = 'second_asterisk_after_bold_and_italic_detected'
+
+                elsif state == 'second_asterisk_after_bold_and_italic_detected'
+                    prev_state = state
+                    state = 'default'
+                    result += bold_and_italic(stack)
+
+                else
+                end
+            elsif c == '['
+                if state == 'default'
+                    prev_state = state
+                    state = 'square_bracket_left_detected'
+                else
+                end
+            elsif c == ']'
+                if state == 'square_bracket_left_detected'
+                    prev_state = state
+                    state = 'default'
+                    result += '[]'
+
+                elsif state == 'link_text_started'
+                    prev_state = state
+                    state = 'square_bracket_right_detected'
+                    link_text = stack
+
+                else
+                end
+            elsif c == '('
+                if state == 'square_bracket_right_detected'
+                    prev_state = state
+                    state = 'brace_left_detected'
+                else
+                end
+            elsif c == ')'
+                if state == 'brace_left_detected'
+                    prev_state = state
+                    state = 'default'
+                    result += '()'
+
+                elsif state == 'link_url_started'
+                    prev_state = state
+                    state = 'default'
+                    link_url = stack
+                    result += link(link_text, link_url)
+
+                else
+                end
+            else
+                if state == 'default'
+                    result += c
+                else
+                    if state == 'first_asterisk_detected'
+                        prev_state = state
+                        state = 'italic_started'
+                        stack = ''
+
+                    elsif state == 'second_asterisk_detected'
+                        prev_state = state
+                        state = 'bold_started'
+                        stack = ''
+
+                    elsif state == 'third_asterisk_detected'
+                        prev_state = state
+                        state = 'bold_and_italic_started'
+                        stack = ''
+                    
+                    elsif state == 'first_asterisk_after_bold_detected'
+                        prev_state = state
+                        state = 'bold_started'
+
+                    elsif state == 'first_asterisk_after_bold_and_italic_detected'
+                        prev_state = state
+                        state = 'bold_and_italic_started'
+
+                    elsif state == 'second_asterisk_after_bold_and_italic_detected'
+                        prev_state = state
+                        state = 'bold_and_italic_started'
+
+                    elsif state == 'square_bracket_left_detected'
+                        prev_state = state
+                        state = 'link_text_started'
+                        stack = ''
+
+                    elsif state == 'square_bracket_right_detected'
+                        prev_state = state
+                        state = 'default'
+                        result += stack + c
+                        c = ''
+
+                    elsif state == 'brace_left_detected'
+                        prev_state = state
+                        state = 'link_url_started'
+                        stack = ''
+
+                    else
+                    end
+                    stack += c
+                end
+            end
+            prev_c = c
+        end
+        return result
+    end
+
+    def italic(str)
+        "<i>#{str}</i>"
+    end
+
+    def bold(str)
+        "<b>#{str}</b>"
+    end
+
+    def bold_and_italic(str)
+        "<b><i>#{str}</i></b>"
+    end
+
+    def link(link_text, link_url)
+        "<a href=\"#{link_url}\" class=\"external\">#{link_text}</a>"
+    end
+end

data/lib/almirah/doc_types/specification.rb

@@ -67,6 +67,7 @@ class Specification < BaseDocument
 
         @items.each do |item|    
             a = item.to_html
+            a = adjust_internal_links(a, nav_pane.specifications)
             html_rows.append a
         end
 
@@ -74,4 +75,29 @@ class Specification < BaseDocument
         
     end
 
+    def adjust_internal_links(line, specifications)
+        # check if there are internal links to md files and replace them
+        if tmp = /<a\shref="(.*)"\sclass="external">.*<\/a>/.match(line)
+            if res = /(\w*)[.]md/.match(tmp[1])
+                id = res[1].downcase
+                res = /(\w*)[.]md(#.*)/.match(tmp[1])
+                
+                specifications.each do |spec|
+                    if spec.id.downcase == id
+                        if res && res.length > 2
+                            anchor = res[2]
+                            line.sub!(/<a\shref="(.*)"\sclass="external">/,
+                            "<a href=\".\\..\\#{id}\\#{id}.html#{anchor}\" class=\"external\">")
+                        else
+                            line.sub!(/<a\shref="(.*)"\sclass="external">/,
+                            "<a href=\".\\..\\#{id}\\#{id}.html\" class=\"external\">")
+                        end
+                        break
+                    end
+                end
+            end
+        end
+        return line
+    end
+
 end

data/lib/almirah/project.rb

@@ -1,3 +1,4 @@
+require 'fileutils'
 require_relative "doc_fabric"
 require_relative "navigation_pane"
 require_relative "doc_types/traceability"

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: Almirah
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Oleksandr Ivanov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-17 00:00:00.000000000 Z
+date: 2024-03-03 00:00:00.000000000 Z
 dependencies: []
-description: The software part of the Almirah system
+description: The software part of the Almirah framework
 email: oleksandr.ivanov.development@gmail.com
 executables:
 - almirah
@@ -30,6 +30,7 @@ files:
 - lib/almirah/doc_items/markdown_list.rb
 - lib/almirah/doc_items/markdown_table.rb
 - lib/almirah/doc_items/paragraph.rb
+- lib/almirah/doc_items/text_line.rb
 - lib/almirah/doc_types/base_document.rb
 - lib/almirah/doc_types/coverage.rb
 - lib/almirah/doc_types/protocol.rb
@@ -57,7 +58,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.5.6
 signing_key:
 specification_version: 4
 summary: Almirah