Almirah 0.2.3 → 0.2.4

data/lib/almirah/doc_items/paragraph.rb

@@ -7,7 +7,7 @@ class Paragraph < DocItem
     def initialize(doc, text)
         @parent_doc = doc
         @parent_heading = doc.headings[-1]
-        @text = text
+        @text = text.strip
     end
 
     def getTextWithoutSpaces

data/lib/almirah/doc_parser.rb

@@ -153,10 +153,10 @@ class DocParser
           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
 
@@ -167,10 +167,10 @@ class DocParser
           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
 
@@ -208,7 +208,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)
@@ -279,7 +279,7 @@ class DocParser
           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

data/lib/almirah/doc_types/base_document.rb

@@ -4,6 +4,7 @@ class BaseDocument
     attr_accessor :title
     attr_accessor :id
     attr_accessor :dom
+    attr_accessor :headings
 
     def initialize()
         @items = Array.new

data/lib/almirah/doc_types/coverage.rb

@@ -4,14 +4,16 @@ class Coverage < BaseDocument
 
     attr_accessor :top_doc
     attr_accessor :bottom_doc
+    attr_accessor :covered_items
 
     def initialize(top_doc)
         super()
         @top_doc = top_doc
-        @bottom_doc = bottom_doc
+        @bottom_doc = nil
 
         @id = top_doc.id + "-" + "tests"
         @title = "Coverage Matrix: " + @id
+        @covered_items = {}
     end
 
     def to_console
@@ -64,6 +66,7 @@ class Coverage < BaseDocument
                 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"

data/lib/almirah/doc_types/index.rb

@@ -136,6 +136,9 @@ class Index < BaseDocument
             s += "<table class=\"controlled\">\n"
             s += "\t<thead>\n"
             s += "\t\t<th>Title</th>\n"
+            s += "\t\t<th title=\"The ratio of Controlled Paragraphs mentioned in test protocols \
+                and total number of Controlled Paragraphs\">Coverage</th>\n"
+            s += "\t\t<th title=\"Numbers of passed and failed test steps\">Test Results</th>\n"
             s += "\t\t<th>Specification Covered</th>\n"
             s += "</thead>\n"
             html_rows.append s
@@ -144,8 +147,13 @@ class Index < BaseDocument
 
             sorted_items.each do |doc|
                 s = "\t<tr>\n"
+                coverage = doc.covered_items.length.to_f / doc.top_doc.controlled_items.length * 100.0
                 s += "\t\t<td class=\"item_text\" style='padding: 5px;'><a href=\"./specifications/#{doc.id}/#{doc.id}.html\" class=\"external\">#{doc.title}</a></td>\n"
-                s += "\t\t<td class=\"item_text\" style='width: 25%; padding: 5px;'>#{doc.top_doc.title}</td>\n"
+                s += "\t\t<td class=\"item_id\" style='width: 7%;'>#{'%.2f' % coverage}%</td>\n"
+                s += "\t\t<td class=\"item_id\" style='width: 7%;'> n/a </td>\n"
+                s += "\t\t<td class=\"item_text\" style='width: 25%; padding: 5px;'>\
+                    <i class=\"fa fa-file-text-o\" style='background-color: ##{doc.top_doc.color};'> </i>\
+                    #{doc.top_doc.title}</td>\n"
                 s += "</tr>\n"
                 html_rows.append s
             end

data/lib/almirah/doc_types/traceability.rb

@@ -8,11 +8,15 @@ class Traceability < BaseDocument
     attr_accessor :is_agregated
     attr_accessor :traced_items
 
-    def initialize(top_doc, bottom_doc, is_agregated)
+    def initialize(top_doc, bottom_doc)
         super()
         @top_doc = top_doc
         @bottom_doc = bottom_doc
-        @is_agregated = is_agregated
+        @is_agregated = if bottom_doc
+                          false
+                        else
+                          true
+                        end
         @traced_items = {}
 
         if @is_agregated 

data/lib/almirah/dom/doc_section.rb

@@ -1,28 +1,25 @@
 class DocSection
+  attr_accessor :sections, :heading, :parent_section
 
-    attr_accessor :sections
-    attr_accessor :heading
-    attr_accessor :parent_section
+  def initialize(heading)
+    @sections = []
+    @heading = heading
+    @parent_section = nil
+  end
 
-    def initialize(heading)
-        @sections = Array.new
-        @heading = heading
-        @parent_section = nil
+  def to_html # rubocop:disable Metrics/MethodLength
+    s = ''
+    s += "\t<li onclick=\"nav_toggle_expand_list(this, event)\">" \
+      '<span class="fa-li"><i class="fa fa-minus-square-o"> </i></span>'
+    s += "<a href=\"##{@heading.anchor_id}\">#{@heading.get_section_info}</a>\n"
+    unless @sections.empty?
+      s += "\t\t<ul class=\"fa-ul\">\n"
+      @sections.each do |sub_section|
+        s += sub_section.to_html
+      end
+      s += "\t\t</ul>\n"
     end
-
-    def to_html
-        s = ''
-        s += "\t<li><span class=\"fa-li\"><i class=\"fa fa-square-o\"> </i></span>"
-        s += "<a href=\"\#" + @heading.anchor_id.to_s + "\">" + @heading.get_section_info + "</a>\n"
-        if @sections.length >0
-            s += "\t\t<ul class=\"fa-ul\">\n"
-                @sections.each do |sub_section|
-                    s += sub_section.to_html()
-                end
-            s += "\t\t</ul>\n"
-        end
-        s += "</li>\n"
-        return s
-    end
-
-end
+    s += "</li>\n"
+    s
+  end
+end

data/lib/almirah/dom/document.rb

@@ -1,63 +1,72 @@
-require_relative "doc_section"
+require_relative 'doc_section'
 
 class Document
-
-    attr_accessor :root_section
-
-    @@sections_stack = Array.new
-
-    def initialize(headings_list)
-        @root_section = nil
-
-        build_sections_tree(headings_list)
-    end
-
-    def build_sections_tree(headings_list)
-
-        headings_list.each do |h|
-
-            if @root_section == nil
-
-                s = DocSection.new(h)
-                s.parent_section = nil
-                @root_section = s
-                @@sections_stack.push s
-
-            elsif @@sections_stack[-1].heading.level == h.level
-
-                s = DocSection.new(h)
-                @@sections_stack[-2].sections.append(s)
-                @@sections_stack[-1] = s
-
-            elsif h.level > @@sections_stack[-1].heading.level
-
-                s = DocSection.new(h)
-                @@sections_stack[-1].sections.append(s)
-                @@sections_stack.push s
-
-            else
-                while h.level < @@sections_stack[-1].heading.level
-                    @@sections_stack.pop
-                end
-
-                s = DocSection.new(h)
-                @@sections_stack[-2].sections.append(s)
-                @@sections_stack[-1] = s
-            end
+  attr_accessor :root_section
+
+  def initialize(headings_list)
+    @root_section = nil
+
+    build_sections_tree(headings_list)
+  end
+
+  def build_sections_tree(headings_list)
+    sections_stack = []
+    headings_list.each do |h|
+      if @root_section.nil?
+
+        s = DocSection.new(h)
+        s.parent_section = nil
+        @root_section = s
+        sections_stack.push s
+        # one more artificial section copy if root is not a Document Title (level 0)
+        if h.level.positive?
+          a = DocSection.new(h)
+          a.parent_section = @root_section
+          @root_section.sections.append(a)
+          sections_stack.push a
         end
-    end
 
-    def section_tree_to_html
-        s = ''
-        s += "<a href=\"\#" + @root_section.heading.anchor_id.to_s + "\">" + @root_section.heading.get_section_info + "</a>\n"
-        if @root_section.sections.length >0
-            s += "\t<ul class=\"fa-ul\" style=\"margin-top: 2px;\">\n"
-            @root_section.sections.each do |sub_section|
-                s += sub_section.to_html()
-            end
-            s += "\t</ul>\n"
+      elsif sections_stack[-1].heading.level == h.level
+
+        s = DocSection.new(h)
+        s.parent_section = sections_stack[-1].parent_section
+        sections_stack[-1].parent_section.sections.append(s)
+        sections_stack[-1] = s
+
+      elsif h.level > sections_stack[-1].heading.level
+
+        s = DocSection.new(h)
+        s.parent_section = sections_stack[-1]
+        sections_stack[-1].sections.append(s)
+        sections_stack.push s
+
+      else
+        sections_stack.pop while h.level < sections_stack[-1].heading.level
+        sections_stack.push @root_section if sections_stack.empty?
+        s = DocSection.new(h)
+        if h.level == sections_stack[-1].heading.level
+          s.parent_section = sections_stack[-1].parent_section
+          sections_stack[-1].parent_section.sections.append(s)
+        else
+          s.parent_section = sections_stack[-1]
+          sections_stack[-1].sections.append(s)
         end
-
-        return s
+        sections_stack[-1] = s
+      end
     end
-end
+  end
+
+  def section_tree_to_html
+    s = ''
+    s += "<a href=\"##{@root_section.heading.anchor_id}\">#{@root_section.heading.get_section_info}</a>\n"
+    unless @root_section.sections.empty?
+      s += "\t<ul class=\"fa-ul\" style=\"margin-top: 2px;\">\n"
+      @root_section.sections.each do |sub_section|
+        s += sub_section.to_html
+      end
+      s += "\t</ul>\n"
+    end
+
+    s
+  end
+end