Almirah 0.2.3 → 0.2.5

data/lib/almirah/doc_items/doc_item.rb

@@ -1,20 +1,22 @@
-require_relative "text_line"
+# frozen_string_literal: true
 
-class DocItem < TextLine
-    attr_accessor :parent_doc
-    attr_accessor :parent_heading
-    
-    @parent_doc = nil
-    @parent_heading = nil
-
-    @@html_table_render_in_progress = false
-
-    def get_url
-        ''
-    end
-end
+require_relative 'text_line'
 
+class DocItem < TextLine # rubocop:disable Style/Documentation
+  attr_accessor :parent_doc, :parent_heading
 
+  @parent_doc = nil
+  @parent_heading = nil
 
+  @@html_table_render_in_progress = false # rubocop:disable Style/ClassVars
 
+  def initialize(doc)
+    super()
+    @parent_doc = doc
+    @parent_heading = doc.headings[-1]
+  end
 
+  def get_url
+    ''
+  end
+end

data/lib/almirah/doc_items/frontmatter.rb

@@ -0,0 +1,9 @@
+require 'yaml'
+
+class Frontmatter
+  attr_accessor :parameters
+
+  def initialize(yaml_text_line)
+    @parameters = YAML.safe_load(yaml_text_line)
+  end
+end

data/lib/almirah/doc_items/markdown_list.rb

@@ -8,9 +8,7 @@ class MarkdownList < DocItem
   @@lists_stack = []
 
   def initialize(doc, is_ordered)
-    super()
-    @parent_doc = doc
-    @parent_heading = doc.headings[-1]
+    super(doc)
 
     @rows = []
     @is_ordered = is_ordered
@@ -21,7 +19,7 @@ class MarkdownList < DocItem
     @@lists_stack.push(self)
   end
 
-  def addRow(raw_text)
+  def add_row(raw_text)
     pos = calculate_text_position(raw_text)
     row = raw_text[pos..-1]
 
@@ -44,7 +42,7 @@ class MarkdownList < DocItem
         prev_lists_stack_item.rows[-1] = nested_list
       end
 
-      nested_list.addRow(raw_text)
+      nested_list.add_row(raw_text)
 
     elsif pos < @@lists_stack[-1].indent_position
 

data/lib/almirah/doc_items/markdown_table.rb

@@ -6,9 +6,7 @@ class MarkdownTable < DocItem
   attr_accessor :column_names, :rows, :heading_row, :is_separator_detected
 
   def initialize(doc, heading_row)
-    super()
-    @parent_doc = doc
-    @parent_heading = doc.headings[-1]
+    super(doc)
     @heading_row = heading_row
 
     res = /^[|](.*[|])/.match(heading_row)
@@ -21,7 +19,7 @@ class MarkdownTable < DocItem
     @is_separator_detected = false
   end
 
-  def addRow(row)
+  def add_row(row)
     columns = row.split('|')
     @rows.append(columns.map!(&:strip))
     true

data/lib/almirah/doc_items/paragraph.rb

@@ -1,27 +1,25 @@
-require_relative "doc_item"
+require_relative 'doc_item'
 
 class Paragraph < DocItem
+  attr_accessor :text
 
-    attr_accessor :text
+  def initialize(doc, text)
+    super(doc)
+    @text = text.strip
+  end
 
-    def initialize(doc, text)
-        @parent_doc = doc
-        @parent_heading = doc.headings[-1]
-        @text = text
-    end
+  def getTextWithoutSpaces
+    @text.split.join('-').downcase
+  end
 
-    def getTextWithoutSpaces
-        return @text.split.join('-').downcase
+  def to_html
+    s = ''
+    if @@html_table_render_in_progress
+      s += '</table>'
+      @@html_table_render_in_progress = false
     end
 
-    def to_html
-        s = ''
-        if @@html_table_render_in_progress
-            s += "</table>"
-            @@html_table_render_in_progress = false
-        end
-
-        s += "<p>" + format_string(@text)
-        return s
-    end
-end
+    s += "<p>#{format_string(@text)}"
+    s
+  end
+end

data/lib/almirah/doc_parser.rb

@@ -11,15 +11,53 @@ require_relative 'doc_items/controlled_table'
 require_relative 'doc_items/image'
 require_relative 'doc_items/markdown_list'
 require_relative 'doc_items/doc_footer'
+require_relative 'doc_items/frontmatter'
+
+class DocParser # rubocop:disable Metrics/ClassLength,Style/Documentation
+  def self.try_to_extract_frontmatter(doc, text_lines) # rubocop:disable Metrics/MethodLength
+    lines_to_remove = 0
+    frontmatter_lines = ''
+    if /^(-{3,})/.match(text_lines[0])
+      frontmatter_started = false
+      text_lines.each do |s|
+        lines_to_remove += 1
+        if /^(-{3,})/.match(s)
+          if frontmatter_started
+            doc.frontmatter = Frontmatter.new(frontmatter_lines)
+            frontmatter_started = false
+            break
+          else
+            frontmatter_started = true
+          end
+        elsif frontmatter_started
+          frontmatter_lines += s
+        end
+      end
+    end
+    text_lines.shift(lines_to_remove)
+    text_lines
+  end
 
-class DocParser
   def self.parse(doc, text_lines)
     temp_md_table = nil
     temp_md_list = nil
     temp_code_block = nil
     # restart section numbering for each new document
     Heading.reset_global_section_number
-
+    # try to get frontmatter first
+    text_lines = try_to_extract_frontmatter(doc, text_lines)
+    # There is no document without heading
+    title = "#{doc.id}.md"
+    item = Heading.new(doc, title, 0)
+    doc.items.append(item)
+    doc.headings.append(item)
+    doc.title = title
+    # replace dummy title with extracted from frontmatter
+    if doc.frontmatter && (doc.frontmatter.parameters.key? 'title')
+      doc.title = doc.frontmatter.parameters['title']
+      doc.headings[0].text = doc.frontmatter.parameters['title']
+    end
+    # main loop
     text_lines.each do |s|
       if s.lstrip != ''
         if res = /^(\#{1,})\s(.*)/.match(s) # Heading
@@ -33,10 +71,6 @@ class DocParser
           level = res[1].length
           value = res[2]
 
-          if level == 1 && doc.title == ''
-            doc.title = value
-          end
-
           item = Heading.new(doc, value, level)
           doc.items.append(item)
           doc.headings.append(item)
@@ -45,13 +79,9 @@ class DocParser
 
           title = res[1]
 
-          if doc.title == ''
-            doc.title = title
-          end
-
-          item = Heading.new(doc, title, 0)
-          doc.items.append(item)
-          doc.headings.append(item)
+          # Rewrite
+          doc.title = title
+          doc.headings[0].text = title
 
         elsif res = /^\[(\S*)\]\s+(.*)/.match(s) # Controlled Paragraph
 
@@ -72,12 +102,10 @@ class DocParser
           if tmp.length > 0
             up_links = []
             tmp.each do |ul|
-              lnk = ul[0]            
+              lnk = ul[0]
               # do not add links for the self document
               doc_id = /([a-zA-Z]+)-\d+/.match(lnk) # SRS
-              if (doc_id) and (doc_id[1].downcase != doc.id.downcase)
-                up_links << lnk.upcase
-              end
+              up_links << lnk.upcase if doc_id and (doc_id[1].downcase != doc.id.downcase)
               # try to find the real end of text
               pos = text.index(lnk)
               first_pos = pos if pos < first_pos
@@ -95,7 +123,7 @@ class DocParser
           item = ControlledParagraph.new(doc, text, id)
 
           if up_links
-            up_links.uniq! #remove duplicates
+            up_links.uniq! # remove duplicates
             doc.items_with_uplinks_number += 1 # for statistics
             up_links.each do |ul|
               next unless tmp = />\[(\S*)\]$/.match(ul) # >[SRS-001]
@@ -146,36 +174,54 @@ class DocParser
 
           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 doc.title == ''
+            # dummy section if root is not a Document Title (level 0)
+            title = "#{doc.id}.md"
+            item = Heading.new(doc, title, 0)
+            doc.items.append(item)
+            doc.headings.append(item)
+            doc.title = title
+          end
 
           temp_md_table = process_temp_table(doc, temp_md_table)
 
           row = res[2]
 
           if temp_md_list
-            temp_md_list.addRow(s)
+            temp_md_list.add_row(s)
           else
             item = MarkdownList.new(doc, false)
-            item.addRow(s)
+            item.add_row(s)
             temp_md_list = item
           end
 
-        elsif res = /^\d[.]\s(.*)/.match(s)   # check if ordered list start
+        elsif res = /^\d[.]\s(.*)/.match(s) # check if ordered list start
 
           temp_md_table = process_temp_table(doc, temp_md_table)
 
           row = res[1]
 
           if temp_md_list
-            temp_md_list.addRow(s)
+            temp_md_list.add_row(s)
           else
             item = MarkdownList.new(doc, true)
-            item.addRow(s)
+            item.add_row(s)
             temp_md_list = item
           end
 
         elsif s[0] == '|' # check if table
 
+          if doc.title == ''
+            # dummy section if root is not a Document Title (level 0)
+            title = "#{doc.id}.md"
+            item = Heading.new(doc, title, 0)
+            doc.items.append(item)
+            doc.headings.append(item)
+            doc.title = title
+          end
+
           if temp_md_list
             doc.items.append temp_md_list
             temp_md_list = nil
@@ -184,8 +230,8 @@ class DocParser
           if res = /^[|](-{3,})[|]/.match(s) # check if it is a separator first
 
             if temp_md_table
-            # separator is found after heading
-            temp_md_table.is_separator_detected = true
+              # separator is found after heading
+              temp_md_table.is_separator_detected = true
             else
               # separator out of table scope consider it just as a regular paragraph
               item = Paragraph.new(doc, s)
@@ -208,7 +254,7 @@ class DocParser
                     temp_md_table = ControlledTable.new(doc, temp_md_table)
                   end
                 end
-                temp_md_table.addRow(row)
+                temp_md_table.add_row(row)
               else
                 # replece table heading with regular paragraph
                 item = Paragraph.new(doc, temp_md_table.heading_row)
@@ -257,6 +303,7 @@ class DocParser
             # start code block
             temp_code_block = CodeBlock.new(suggested_format)
             temp_code_block.parent_doc = doc
+            temp_code_block.parent_heading = doc.headings[-1]
           end
 
         elsif res = /^TODO:(.*)/.match(s) # check if TODO block
@@ -276,10 +323,11 @@ class DocParser
           doc.todo_blocks.append(item)
 
         else # Reqular Paragraph
+
           temp_md_table = process_temp_table(doc, temp_md_table)
           if temp_md_list
             if MarkdownList.unordered_list_item?(s) || MarkdownList.ordered_list_item?(s)
-              temp_md_list.addRow(s)
+              temp_md_list.add_row(s)
               next
             else
               doc.items.append temp_md_list
@@ -314,7 +362,7 @@ class DocParser
     doc.items.append(item)
   end
 
-  def self.process_temp_table(doc, temp_md_table) # rubocop:disable Metrics/MethodLength
+  def self.process_temp_table(doc, temp_md_table)
     if temp_md_table
       if temp_md_table.is_separator_detected
         doc.items.append temp_md_table

data/lib/almirah/doc_types/base_document.rb

@@ -1,69 +1,64 @@
+# frozen_string_literal: true
 
-class BaseDocument
+class BaseDocument # rubocop:disable Style/Documentation
+  attr_accessor :title, :id, :dom, :headings
 
-    attr_accessor :title
-    attr_accessor :id
-    attr_accessor :dom
+  def initialize
+    @items = []
+    @headings = []
+    @title = ''
+    @id = ''
+    @dom = nil
+  end
 
-    def initialize()
-        @items = Array.new
-        @headings = Array.new
-        @title = ""
-        @id = ""
-        @dom = nil
-    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"
+  def save_html_to_file(html_rows, nav_pane, output_file_path) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
+    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
+    file = File.open(template_file)
+    file_data = file.readlines
+    file.close
 
-        if @id == 'index'
-            output_file_path += "#{@id}.html"
-        else
-            output_file_path += "#{@id}/#{@id}.html"
+    output_file_path += if @id == 'index'
+                          "#{@id}.html"
+                        else
+                          "#{@id}/#{@id}.html"
+                        end
+    file = File.open(output_file_path, 'w')
+    file_data.each do |s| # rubocop:disable Metrics/BlockLength
+      if s.include?('{{CONTENT}}')
+        html_rows.each do |r|
+          file.puts r
         end
-        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
-            elsif s.include?('{{DOCUMENT_TITLE}}')
-                file.puts s.gsub! '{{DOCUMENT_TITLE}}', @title
-            elsif s.include?('{{STYLES_AND_SCRIPTS}}')
-                if @id == 'index'
-                    file.puts '<script type="module" src="./scripts/orama_search.js"></script>'
-                    file.puts '<link rel="stylesheet" href="./css/search.css">'
-                    file.puts '<link rel="stylesheet" href="./css/main.css">'
-                    file.puts '<script src="./scripts/main.js"></script>'
-                elsif self.instance_of? Specification
-                    file.puts '<link rel="stylesheet" href="../../css/main.css">'
-                    file.puts '<script src="../../scripts/main.js"></script>'
-                elsif self.instance_of? Traceability
-                    file.puts '<link rel="stylesheet" href="../../css/main.css">'
-                    file.puts '<script src="../../scripts/main.js"></script>'
-                elsif self.instance_of? Coverage
-                    file.puts '<link rel="stylesheet" href="../../css/main.css">'
-                    file.puts '<script src="../../scripts/main.js"></script>'
-                elsif self.instance_of? Protocol
-                    file.puts '<link rel="stylesheet" href="../../../css/main.css">'
-                    file.puts '<script src="../../../scripts/main.js"></script>'
-                end
-            elsif  s.include?('{{GEM_VERSION}}')
-                file.puts "(" + Gem.loaded_specs['Almirah'].version.version + ")"
-            else
-                file.puts s
-            end
+      elsif s.include?('{{NAV_PANE}}')
+        file.puts nav_pane.to_html if nav_pane
+      elsif s.include?('{{DOCUMENT_TITLE}}')
+        file.puts s.gsub! '{{DOCUMENT_TITLE}}', @title
+      elsif s.include?('{{STYLES_AND_SCRIPTS}}')
+        if @id == 'index'
+          file.puts '<script type="module" src="./scripts/orama_search.js"></script>'
+          file.puts '<link rel="stylesheet" href="./css/search.css">'
+          file.puts '<link rel="stylesheet" href="./css/main.css">'
+          file.puts '<script src="./scripts/main.js"></script>'
+        elsif instance_of? Specification
+          file.puts '<link rel="stylesheet" href="../../css/main.css">'
+          file.puts '<script src="../../scripts/main.js"></script>'
+        elsif instance_of? Traceability
+          file.puts '<link rel="stylesheet" href="../../css/main.css">'
+          file.puts '<script src="../../scripts/main.js"></script>'
+        elsif instance_of? Coverage
+          file.puts '<link rel="stylesheet" href="../../css/main.css">'
+          file.puts '<script src="../../scripts/main.js"></script>'
+        elsif instance_of? Protocol
+          file.puts '<link rel="stylesheet" href="../../../css/main.css">'
+          file.puts '<script src="../../../scripts/main.js"></script>'
         end
-        file.close
+      elsif s.include?('{{GEM_VERSION}}')
+        file.puts "(#{Gem.loaded_specs['Almirah'].version.version})"
+      else
+        file.puts s
+      end
     end
-end
+    file.close
+  end
+end

data/lib/almirah/doc_types/coverage.rb

@@ -1,78 +1,80 @@
-require_relative "base_document"
+require_relative 'base_document'
 
 class Coverage < BaseDocument
+  attr_accessor :top_doc, :bottom_doc, :covered_items, :passed_steps_number, :failed_steps_number
 
-    attr_accessor :top_doc
-    attr_accessor :bottom_doc
+  def initialize(top_doc)
+    super()
+    @top_doc = top_doc
+    @bottom_doc = nil
 
-    def initialize(top_doc)
-        super()
-        @top_doc = top_doc
-        @bottom_doc = bottom_doc
+    @id = top_doc.id + '-' + 'tests'
+    @title = 'Coverage Matrix: ' + @id
+    @covered_items = {}
+    @passed_steps_number = 0
+    @failed_steps_number = 0
+  end
 
-        @id = top_doc.id + "-" + "tests"
-        @title = "Coverage Matrix: " + @id
-    end
-
-    def to_console
-        puts "\e[35m" + "Traceability: " + @id + "\e[0m"
-    end
+  def to_console
+    puts "\e[35m" + 'Traceability: ' + @id + "\e[0m"
+  end
 
-    def to_html(nav_pane, output_file_path)
+  def to_html(nav_pane, output_file_path)
+    html_rows = []
 
-        html_rows = Array.new
+    html_rows.append('')
+    s = "<h1>#{@title}</h1>\n"
+    s += "<table class=\"controlled\">\n"
+    s += "\t<thead> <th>#</th> <th style='font-weight: bold;'>#{@top_doc.title}</th> <th>#</th> <th style='font-weight: bold;'>Test CaseId.StepId</th> </thead>\n"
+    html_rows.append s
 
-        html_rows.append('')
-        s = "<h1>#{@title}</h1>\n"
-        s += "<table class=\"controlled\">\n"
-        s += "\t<thead> <th>#</th> <th style='font-weight: bold;'>#{@top_doc.title}</th> <th>#</th> <th style='font-weight: bold;'>Test CaseId.StepId</th> </thead>\n"
-        html_rows.append s
+    sorted_items = @top_doc.controlled_items.sort_by { |w| w.id }
 
-        sorted_items = @top_doc.controlled_items.sort_by { |w| w.id }
+    sorted_items.each do |top_item|
+      row = render_table_row top_item
+      html_rows.append row
+    end
+    html_rows.append "</table>\n"
 
-        sorted_items.each do |top_item|
-            row = render_table_row top_item
-            html_rows.append row
-        end
-        html_rows.append "</table>\n"
+    save_html_to_file(html_rows, nav_pane, output_file_path)
+  end
 
-        self.save_html_to_file(html_rows, nav_pane, output_file_path)
-        
-    end
+  def render_table_row(top_item)
+    s = ''
+    if top_item.coverage_links
+      id_color = if top_item.coverage_links.length > 1
+                   '' # "style='background-color: #fff8c5;'" # disabled for now
+                 else
+                   ''
+                 end
+      top_item.coverage_links.each do |bottom_item|
+        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: 42%;'>#{top_item.text}</td>\n"
 
-    def render_table_row(top_item)
-        s = ""
-        if top_item.coverage_links
-            if top_item.coverage_links.length > 1
-                id_color = "" # "style='background-color: #fff8c5;'" # disabled for now
-            else
-                id_color = ""
-            end 
-            top_item.coverage_links.each do |bottom_item|
-                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: 42%;'>#{top_item.text}</td>\n"
-                
-                if bottom_item.columns[-2].text.downcase == "pass"
-                    test_step_color = "style='background-color: #cfc;'"
-                elsif bottom_item.columns[-2].text.downcase == "fail"
-                    test_step_color = "style='background-color: #fcc;'"
-                else
-                    test_step_color = ""
-                end
+        test_step_color = if bottom_item.columns[-2].text.downcase == 'pass'
+                            @passed_steps_number += 1
+                            "style='background-color: #cfc;'"
+                          elsif bottom_item.columns[-2].text.downcase == 'fail'
+                            @failed_steps_number += 1
+                            "style='background-color: #fcc;'"
+                          else
+                            ''
+                          end
 
-                s += "\t\t<td class=\"item_id\" #{test_step_color}><a href=\"./../../tests/protocols/#{bottom_item.parent_doc.id}/#{bottom_item.parent_doc.id}.html##{bottom_item.id}\" class=\"external\">#{bottom_item.id}</a></td>\n"
-                s += "\t\t<td class=\"item_text\" style='width: 42%;'>#{bottom_item.columns[1].text}</td>\n"
-                s += "\t</tr>\n"
-            end
-        else
-            s += "\t<tr>\n"
-            s += "\t\t<td class=\"item_id\"><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: 42%;'>#{top_item.text}</td>\n"
-            s += "\t\t<td class=\"item_id\"></td>\n"
-            s += "\t\t<td class=\"item_text\" style='width: 42%;'></td>\n"
-            s += "\t</tr>\n"
-        end
-        return s
+        s += "\t\t<td class=\"item_id\" #{test_step_color}><a href=\"./../../tests/protocols/#{bottom_item.parent_doc.id}/#{bottom_item.parent_doc.id}.html##{bottom_item.id}\" class=\"external\">#{bottom_item.id}</a></td>\n"
+        s += "\t\t<td class=\"item_text\" style='width: 42%;'>#{bottom_item.columns[1].text}</td>\n"
+        s += "\t</tr>\n"
+        @covered_items[top_item.id.to_s.downcase] = top_item
+      end
+    else
+      s += "\t<tr>\n"
+      s += "\t\t<td class=\"item_id\"><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: 42%;'>#{top_item.text}</td>\n"
+      s += "\t\t<td class=\"item_id\"></td>\n"
+      s += "\t\t<td class=\"item_text\" style='width: 42%;'></td>\n"
+      s += "\t</tr>\n"
     end
+    s
+  end
 end