Almirah 0.0.6 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3ac78a8239af2167c9f9e90c66fe8693a51d8909282757710e45b8a0375aba5
-  data.tar.gz: 544347bbb28b9e7b288f3c9b37e93c487bc6fd0ac863fcfa7c12fb2cc36d0bc7
+  metadata.gz: 1841cdb6a5d88bcbe36d8ed926fd8f659e9a630d58763ead2b78e8b7f17281dd
+  data.tar.gz: 13b91603331fe68ff13f4b1917806551f94f11d98084ce773a1e247abb4b1abb
 SHA512:
-  metadata.gz: d0170e32eac2109e8559413261c43a230730da8dc4add50342a807e3a054e57c8f5950e83cce4bdaded5b317697da863c82e13bd13cc0250887336d2ed2de77a
-  data.tar.gz: 8388732d6f4fd9d4b4e796470d1ce153a635484cf1d9400d48a3eb3f1d2146d70c8be649bac7927832a29990c6745b0dcc9e4ca247c00b6a5e5c5546d68228a0
+  metadata.gz: ed609c1862a9f33b46c2379ae8f08904c30a00767939418e28600267ccc449aa88b7bcf96efc661c1c3d39d9a720a12491c01eed4c0c30034623f342a47d5d70
+  data.tar.gz: e5c91e4efbd5d96d915ad2228b22982391ccc91eae8afc545dc8c1fd1a8f077a690d9da988e47794df470eda560e7f6a0a99ec7a173d33660c0cc532de1c5e97

data/lib/almirah/doc_fabric.rb

@@ -0,0 +1,221 @@
+#
+require_relative "doc_types/base_document"
+require_relative "doc_types/specification"
+require_relative "doc_types/protocol"
+#
+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"
+require_relative "doc_items/controlled_table"
+require_relative "doc_items/image"
+require_relative "doc_items/markdown_list"
+
+class DocFabric
+
+    def self.create_specification(path)
+        doc = Specification.new path
+        DocFabric.parse_document doc
+        return doc
+    end
+
+    def self.create_protocol(path)
+        doc = Protocol.new path
+        DocFabric.parse_document doc
+        return doc
+    end
+
+    def self.parse_document(doc)
+
+        tempMdTable = nil
+        tempMdList = nil
+
+        file = File.open( doc.path )
+        file_lines = file.readlines     
+        file.close
+
+        file_lines.each do |s|
+            if s.lstrip != ""
+                if res = /^([#]{1,})\s(.*)/.match(s)     # Heading    
+                    
+                    if tempMdTable
+                        doc.items.append tempMdTable
+                        tempMdTable = nil
+                    end
+                    if  tempMdList
+                        doc.items.append tempMdList
+                        tempMdList = nil
+                    end 
+
+                    level = res[1].length
+                    value = res[2]
+                    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*)\]\s+(.*)/.match(s)     # Controlled Paragraph
+
+                    if tempMdTable
+                        doc.items.append tempMdTable
+                        tempMdTable = nil
+                    end
+                    if tempMdList
+                        doc.items.append tempMdList
+                        tempMdList = nil
+                    end 
+
+                    id = res[1]
+                    text = res[2]
+
+                    #check if it contains the uplink
+                    if tmp = /(.*)\s+>\[(\S*)\]$/.match(text)           # >[SRS-001]
+
+                        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
+                        end
+                    end
+
+                    item = ControlledParagraph.new( text, id )
+                    item.parent_doc = doc
+                    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
+                    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
+                        doc.last_used_id = id
+                        doc.last_used_id_number = n
+                    end
+
+                elsif res = /^[!]\[(.*)\]\((.*)\)/.match(s)     # Image
+
+                    if tempMdTable
+                        doc.items.append tempMdTable
+                        tempMdTable = nil
+                    end
+                    if tempMdList
+                        doc.items.append tempMdList
+                        tempMdList = nil
+                    end
+
+                    img_text = res[1]
+                    img_path = res[2]
+
+                    item = Image.new( img_text, img_path )
+                    item.parent_doc = doc
+
+                    doc.items.append(item)
+
+                elsif res = /^(\*\s?)+(.*)/.match(s)   #check if bullet list
+                    
+                    if tempMdTable
+                        doc.items.append tempMdTable
+                        tempMdTable = nil
+                    end
+
+                    row = res[2]
+
+                    if tempMdList
+                        tempMdList.addRow(row)
+                    else
+                        item = MarkdownList.new(row)
+                        item.parent_doc = doc
+                        tempMdList = item
+                    end
+
+                elsif s[0] == '|'   #check if table
+
+                    if tempMdList
+                        doc.items.append tempMdList
+                        tempMdList = nil
+                    end
+
+                    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)
+                            item.parent_doc = doc
+                            doc.items.append(item)
+                        end
+
+                    elsif res = /^[|](.*[|])/.match(s) #check if it looks as a table
+
+                        row = res[1]
+
+                        if tempMdTable
+                            # check if it is a controlled table
+                            unless tempMdTable.addRow(row)
+                                tempMdTable = ControlledTable.new(tempMdTable, doc)
+                                tempMdTable.parent_doc = doc
+                                tempMdTable.addRow(row)
+                            end
+                        else
+                            #start table from heading
+                            tempMdTable = MarkdownTable.new(row)
+                            tempMdTable.parent_doc = doc
+                        end
+                    end
+
+                elsif res = /^[>](.*)/.match(s)   #check if blockquote
+
+                    if tempMdTable
+                        doc.items.append tempMdTable
+                        tempMdTable = nil
+                    end
+                    if tempMdList
+                        doc.items.append tempMdList
+                        tempMdList = nil
+                    end 
+
+                    item = Blockquote.new(res[1])
+                    item.parent_doc = doc
+                    doc.items.append(item)
+
+                else # Reqular Paragraph
+                    if tempMdTable
+                        doc.items.append tempMdTable
+                        tempMdTable = nil
+                    end
+                    if tempMdList
+                        doc.items.append tempMdList
+                        tempMdList = nil
+                    end
+
+                    item = Paragraph.new(s)
+                    item.parent_doc = doc
+                    doc.items.append(item)
+                end
+            end
+        end
+        # Finalize non-closed elements
+        if tempMdTable
+            doc.items.append tempMdTable
+            tempMdTable = nil
+        end
+        if tempMdList
+            doc.items.append tempMdList
+            tempMdList = nil
+        end
+    end
+end

data/lib/almirah/doc_items/blockquote.rb

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

data/lib/almirah/doc_items/controlled_paragraph.rb

@@ -5,47 +5,54 @@ class ControlledParagraph < Paragraph
     attr_accessor :id
     attr_accessor :up_link
     attr_accessor :down_links
+    attr_accessor :coverage_links
 
     def initialize(text, id)
-        @text = text
+        @text = text.strip
         @id = id
         @up_link = nil
         @down_links = nil
+        @coverage_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"
+            s += "<table class=\"controlled\">\n"
+            s += "\t<thead> <th>#</th> <th>Text</th> <th>UL</th> <th>DL</th> <th>COV</th> </thead>\n"
             @@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"
+        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"
 
         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"
+            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\r"
+            s += "\t\t<td class=\"item_id\"></td>\n"
         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"
+            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"
         else
-            s += "\t\t<td class=\"item_id\"></td>\n\r"
+            s += "\t\t<td class=\"item_id\"></td>\n"
         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"
+        if @coverage_links
+            if tmp = /^(.+)[.]\d+/.match(@coverage_links[0].id)    # guessing that all the links refer to one document
+                cov_link_doc_name = tmp[1].downcase
+            end
+            s += "\t\t<td class=\"item_id\"><a href=\"./../../tests/protocols/#{cov_link_doc_name}/#{cov_link_doc_name}.html\" class=\"external\">#{@coverage_links.length}</a></td>\n"
+        else
+            s += "\t\t<td class=\"item_id\"></td>\n"
+        end
+        s += "\t</tr>\n"
         return s
     end 
 

data/lib/almirah/doc_items/controlled_table.rb

@@ -0,0 +1,175 @@
+require_relative "controlled_table_row"
+
+
+class ControlledTableColumn
+
+    attr_accessor :text
+    
+    def initialize(text)
+        @text = text.strip
+    end
+
+    def to_html
+        "\t\t<td>#{@text}</td>\n\r"
+    end
+end
+
+
+class RegualrColumn < ControlledTableColumn
+
+end
+
+
+class TestStepNumberColumn < ControlledTableColumn
+
+    attr_accessor :step_number
+    attr_accessor :row_id
+    
+    def initialize(text)
+        text = text.strip
+        @step_number = text.to_i
+        @text =  text
+        @row_id = ""
+    end
+
+    def to_html
+        "\t\t<td style=\"text-align: center;\"><a name=\"#{@row_id}\" id=\"#{@row_id}\" href=\"##{@row_id}\">#{@text}</a></td>\n\r"
+    end
+end 
+
+
+class TestStepResultColumn <  ControlledTableColumn
+
+    def to_html
+        if @text.downcase == "pass"
+            "\t\t<td style=\"background-color: #cfc;\">#{@text}</td>\n\r"
+        elsif @text.downcase == "fail"
+            "\t\t<td style=\"background-color: #fcc;\">#{@text}</td>\n\r"
+        else
+            "\t\t<td>#{@text}</td>\n\r"
+        end
+    end
+end
+
+
+class TestStepReferenceColumn <  ControlledTableColumn
+
+    attr_accessor :up_link
+    attr_accessor :up_link_doc_id
+
+    def initialize(text)
+        
+        @up_link = nil
+        @up_link_doc_id = nil
+
+        if tmp = />\[(\S*)\]/.match(text)   # >[SRS-001]
+            @up_link = tmp[1]
+            if tmp = /^([a-zA-Z]+)[-]\d+/.match(@up_link)   # SRS
+                @up_link_doc_id = tmp[1].downcase 
+            end
+        end
+    end
+
+    def to_html
+        if @up_link
+            "\t\t<td class=\"item_id\"><a href=\"./../../../specifications/#{@up_link_doc_id}/#{@up_link_doc_id}.html##{@up_link}\" class=\"external\">#{@up_link}</a></td>\n\r"
+        else
+            "\t\t<td style=\"text-align: center;\"></td>\n\r"
+        end
+    end
+    
+end
+
+
+class ControlledTable < DocItem
+
+    attr_accessor :column_names
+    attr_accessor :rows
+
+    def initialize(markdown_table, parent_doc)
+        @parent_doc = parent_doc
+        @column_names = markdown_table.column_names
+        # copy and re-format existing rows
+        @rows = Array.new
+
+        markdown_table.rows.each do |r|
+            @rows.append(format_columns(r))
+        end  
+    end
+
+    def addRow(row)
+
+        columns = row.split('|')
+
+        @rows.append(format_columns(columns))
+
+        return true
+    end
+
+    def format_columns(columns)
+
+        new_row = ControlledTableRow.new
+        new_row.parent_doc = @parent_doc
+
+        columns.each_with_index do | element, index |
+
+            if index == 0 # it is expected that test step id is placed in the first columl
+                
+                col = TestStepNumberColumn.new element
+                new_row.columns.append col
+                new_row.id = @parent_doc.id + '.' + col.text
+                col.row_id = new_row.id
+
+            elsif index + 1 == columns.length # it is expected that a link is placed to the last column only
+                
+                col = TestStepReferenceColumn.new element
+                new_row.columns.append col
+                # save uplink key but do not rewrite
+                if col.up_link_doc_id != nil 
+                    if @parent_doc.up_link_doc_id == ""
+                        @parent_doc.up_link_doc_id = col.up_link_doc_id
+                    end
+                    # save reference to the test step
+                    new_row.up_link = col.up_link
+                    @parent_doc.controlled_items.append new_row
+                end               
+
+            elsif index + 2 == columns.length # it is expected that test step result is placed to the pre-last column only
+                
+                col = TestStepResultColumn.new element
+                new_row.columns.append col
+
+            else
+                col = RegualrColumn.new element
+                new_row.columns.append col
+            end             
+        end
+        return new_row
+    end
+
+    def to_html
+        s = ''
+        if @@htmlTableRenderInProgress
+            s += "</table>\n"
+            @@htmlTableRenderInProgress = false
+        end
+                   
+        s += "<table class=\"markdown_table\">\n"
+        s += "\t<thead>" 
+
+        @column_names.each do |h|
+            s += " <th>#{h}</th>"
+        end
+
+        s += " </thead>\n"
+
+        @rows.each do |row|
+            s += row.to_html
+        end
+
+        s += "</table>\n"
+
+        return s
+    end
+
+end

data/lib/almirah/doc_items/controlled_table_row.rb

@@ -0,0 +1,23 @@
+require_relative "doc_item"
+
+class ControlledTableRow < DocItem
+
+    attr_accessor :id
+    attr_accessor :up_link
+    attr_accessor :columns
+    
+    def initialize
+        @id = ""
+        @up_link = ""
+        @columns = Array.new
+    end
+
+    def to_html
+        s = ""
+        s += "\t<tr>\n"
+        @columns.each do |col|
+            s += col.to_html    # "\t\t<td>#{col}</td>\n\r"
+        end
+        s += "\t</tr>\n"
+    end
+end

data/lib/almirah/doc_items/doc_item.rb

@@ -1,4 +1,8 @@
 class DocItem
+    attr_accessor :parent_doc
+    
+    @parent_doc = nil
+
     @@htmlTableRenderInProgress = false
 end
 

data/lib/almirah/doc_items/heading.rb

@@ -14,11 +14,11 @@ class Heading < Paragraph
     def to_html
         s = ''
         if @@htmlTableRenderInProgress
-            s += "</table>"
+            s += "</table>\n"
             @@htmlTableRenderInProgress = false
         end
         headingLevel = level.to_s 
-        s += "<a name=\"#{@anchor_id}\"></a>\n\r"
+        s += "<a name=\"#{@anchor_id}\"></a>\n"
         s += "<h#{headingLevel}> #{@text} <a href=\"\##{@anchor_id}\" class=\"heading_anchor\">"
         s += "&para;</a></h#{headingLevel}>"
         return s

data/lib/almirah/doc_items/image.rb

@@ -17,7 +17,7 @@ class Image < DocItem
     def to_html
         s = ''
         if @@htmlTableRenderInProgress
-            s += "</table>\n\r"
+            s += "</table>\n"
             @@htmlTableRenderInProgress = false
         end
 

data/lib/almirah/doc_items/markdown_list.rb

@@ -16,15 +16,15 @@ class MarkdownList < DocItem
     def to_html
         s = ''
         if @@htmlTableRenderInProgress
-            s += "</table>/n/r"
+            s += "</table>\n"
             @@htmlTableRenderInProgress = false
         end
 
-        s += "<ul>\n\r"
+        s += "<ul>\n"
         @rows.each do |r|
-            s += "\t<li>#{r}</li>\n\r"
+            s += "\t<li>#{r}</li>\n"
         end
-        s += "</ul>\n\r"
+        s += "</ul>\n"
 
         return s
     end

data/lib/almirah/doc_items/markdown_table.rb

@@ -11,35 +11,46 @@ class MarkdownTable < DocItem
     end
 
     def addRow(row)
+        #check if row contains a link
+        if tmp = /(.*)\s+>\[(\S*)\]/.match(row)
+            return false # this is not a regular Markdown table.
+            # so the table type shall be changed and this row shall be passed one more time
+        end
+
         columns = row.split('|')
-        @rows.append(columns)
+        @rows.append(columns.map!{ |x| x.strip })
+        return true
     end
 
     def to_html
         s = ''
         if @@htmlTableRenderInProgress
-            s += "</table>"
+            s += "</table>\n"
             @@htmlTableRenderInProgress = false
         end
                    
-        s += "<table class=\"markdown_table\">\n\r"
+        s += "<table class=\"markdown_table\">\n"
         s += "\t<thead>" 
 
         @column_names.each do |h|
             s += " <th>#{h}</th>"
         end
 
-        s += " </thead>\n\r"
+        s += " </thead>\n"
 
         @rows.each do |row|
-            s += "\t<tr>\n\r"
+            s += "\t<tr>\n"
             row.each do |col|
-                s += "\t\t<td>#{col}</td>\n\r"
+                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"
+                end
             end
-            s += "\t</tr>\n\r"
+            s += "\t</tr>\n"
         end
 
-        s += "</table>\n\r"
+        s += "</table>\n"
 
         return s
     end

data/lib/almirah/doc_types/base_document.rb

@@ -0,0 +1,45 @@
+
+class BaseDocument
+
+    attr_accessor :path
+    attr_accessor :items
+    attr_accessor :headings
+    attr_accessor :title
+    attr_accessor :id
+
+    def initialize(fele_path)
+
+        @path = fele_path
+        @items = Array.new
+        @headings = Array.new
+        @title = ""
+        @id = ""
+    end
+
+    def save_html_to_file html_rows, nav_pane, output_file_path
+
+        gem_root = File.expand_path './../../..', File.dirname(__FILE__)
+        template_file =  gem_root + "/lib/almirah/templates/page.html"
+
+        file = File.open( template_file )
+        file_data = file.readlines
+        file.close
+
+        output_file_path += "#{@id}/#{@id}.html"
+        file = File.open( output_file_path, "w" )
+        file_data.each do |s|
+            if s.include?('{{CONTENT}}')
+                html_rows.each do |r|
+                    file.puts r
+                end
+            elsif s.include?('{{NAV_PANE}}')
+                if nav_pane
+                    file.puts nav_pane.to_html
+                end
+            else
+                file.puts s
+            end
+        end
+        file.close
+    end
+end