Almirah 0.2.4 → 0.2.6

data/lib/almirah/doc_types/base_document.rb

@@ -1,70 +1,64 @@
-
-class BaseDocument
-
-    attr_accessor :title
-    attr_accessor :id
-    attr_accessor :dom
-    attr_accessor :headings
-
-    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"
-
-        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"
-        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
-        end
-        file.close
-    end
-end
+# frozen_string_literal: true
+
+class BaseDocument # rubocop:disable Style/Documentation
+  attr_accessor :title, :id, :dom, :headings
+
+  def initialize
+    @items = []
+    @headings = []
+    @title = ''
+    @id = ''
+    @dom = nil
+  end
+
+  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
+
+    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
+      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
+      elsif s.include?('{{GEM_VERSION}}')
+        file.puts "(#{Gem.loaded_specs['Almirah'].version.version})"
+      else
+        file.puts s
+      end
+    end
+    file.close
+  end
+end

data/lib/almirah/doc_types/coverage.rb

@@ -1,81 +1,95 @@
-require_relative "base_document"
-
-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 = nil
-
-        @id = top_doc.id + "-" + "tests"
-        @title = "Coverage Matrix: " + @id
-        @covered_items = {}
-    end
-
-    def to_console
-        puts "\e[35m" + "Traceability: " + @id + "\e[0m"
-    end
-
-    def to_html(nav_pane, output_file_path)
-
-        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
-
-        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"
-
-        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
-            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
-
-                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
-        return s
-    end
-end
+# frozen_string_literal: true
+
+require_relative 'base_document'
+
+class Coverage < BaseDocument # rubocop:disable Style/Documentation
+  attr_accessor :top_doc, :bottom_doc, :covered_items, :passed_steps_number, :failed_steps_number
+
+  def initialize(top_doc)
+    super()
+    @top_doc = top_doc
+    @bottom_doc = nil
+
+    @id = "#{top_doc.id}-tests"
+    @title = "Coverage Matrix: #{@id}"
+    @covered_items = {}
+    @passed_steps_number = 0
+    @failed_steps_number = 0
+  end
+
+  def to_console
+    puts "\e[35mTraceability: #{@id}\e[0m"
+  end
+
+  def to_html(nav_pane, output_file_path) # rubocop:disable Metrics/MethodLength
+    html_rows = []
+
+    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> "
+    s += "<th title='TestCaseId.TestStepId'>#</th> <th style='font-weight: bold;'>Test Step Description</th> "
+    s += "<th style='font-weight: bold;'>Result</th> </thead>\n"
+    html_rows.append s
+
+    sorted_items = @top_doc.controlled_items.sort_by(&:id)
+
+    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
+
+  def render_table_row(top_item) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+    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: 40%;'>#{top_item.text}</td>\n"
+
+        test_step_color = case bottom_item.columns[-2].text.downcase
+                          when 'pass'
+                            @passed_steps_number += 1
+                            "style='background-color: #cfc;'"
+                          when 'fail'
+                            @failed_steps_number += 1
+                            "style='background-color: #fcc;'"
+                          else
+                            "style='background-color: #ffffee;'"
+                          end
+        test_step_result =  case bottom_item.columns[-2].text.downcase
+                            when 'pass'
+                              'PASS'
+                            when 'fail'
+                              'FAIL'
+                            else
+                              'N/A'
+                            end
+
+        s += "\t\t<td class=\"item_id\"><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\t<td class=\"item_id\" #{test_step_color}>#{test_step_result}</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: 40%;'>#{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\t<td class=\"item_id\"></td>\n"
+      s += "\t</tr>\n"
+    end
+    s
+  end
+end