Almirah 0.3.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be9e792ca43617f09611a801b8e8c8efde741ec531a97295de8d65378232c0d2
-  data.tar.gz: 492000cb9aadaf0731e077b46ec3a32b573da9c8cd2acfaff6f282dec75c394d
+  metadata.gz: b4a6b0c92714af081d54b235449ab825fa86842d61869f31cd331a44c702efdc
+  data.tar.gz: cf2074e5c3f500689359912872166c1f13c08e59bde29408c90ee7b34fbe18fe
 SHA512:
-  metadata.gz: 51e65415ee9d0a8c0f77d19d21ab525a01cbc4c025bc5572f92f2df13bc56ceed8b04be5e18d3c0308c468c43986dd267046d9b1c125e281ad01476b08a93569
-  data.tar.gz: b64d9b5a0da5d254ecbc6dd861db05017b8cd81e13c0f58071413816d9b20d879187cbda5b2a703d5eae9f92ec044000010fc6b1b103fa30a9de04b265562cde
+  metadata.gz: 21654dccede23f1828f02b4446f11f626d12ee5d7d3689b96636d6b1be0465de44fddbacd05606935326a27d4317bfaf0b5596813e907a38580ea6591bc430ca
+  data.tar.gz: d3821259aeb7e5ff6306c3d9ccec25720030e659e351cd2c32a7791a8520ddea0039e6cab7f083b0244c82095e7c219c14de465bcda55b326eca184d06ce3bc7

data/lib/almirah/console_reporter.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# Reporter prints concise, aligned progress lines for the processing pipeline:
+#
+#   parsing specifications ..... 4 ok
+#   parsing test protocols ..... 2 ok
+#   parsing decisions .......... 14 ok
+#   traceability matrices ...... 4 ok
+#   coverage matrices .......... 1 ok
+#   implementation matrices .... 1 ok
+#   decision links ............. 5 ok
+#   rendering HTML ............. ./build/index.html
+#
+# ANSI colour is applied only when writing to an interactive terminal, so piped
+# or captured output stays clean.
+module ConsoleReporter
+  COLUMN = 28 # label is dot-padded out to this column, then the value follows
+
+  module_function
+
+  def count(label, number)
+    emit(label, "#{number} ok", 92) # green highlight
+  end
+
+  def result(label, value)
+    emit(label, value, 96) # cyan highlight
+  end
+
+  def warn(label, value)
+    emit(label, value.to_s, 91) # red highlight
+  end
+
+  # Colourises a detail line with the same red as warn (TTY-gated).
+  def warn_detail(text)
+    colorize(text, 91)
+  end
+
+  def emit(label, value, color_code)
+    dotted = "#{label} ".ljust(COLUMN, '.')
+    puts "#{dotted} #{colorize(value, color_code)}"
+  end
+
+  def colorize(text, color_code)
+    $stdout.tty? ? "\e[#{color_code}m#{text}\e[0m" : text
+  end
+end

data/lib/almirah/doc_fabric.rb

@@ -5,6 +5,8 @@ require_relative 'doc_types/protocol'
 require_relative 'doc_types/coverage'
 require_relative 'doc_types/implementation'
 require_relative 'doc_types/traceability'
+require_relative 'doc_types/decision'
+require_relative 'doc_types/decisions_overview'
 require_relative 'doc_parser'
 require_relative 'source_file_parser'
 require_relative 'dom/document'
@@ -15,12 +17,6 @@ class DocFabric
   @@spec_colors = %w[cff4d2 fbeee6 ffcad4 bce6ff e4dfd9 f9e07f cbe54e d3e7ee eab595 86e3c3
                      ffdca2 ffffff ffdd94 d0e6a5 ffb284 f3dbcf c9bbc8 c6c09c]
 
-  def self.add_lazy_doc_id(path)
-    if res = /(\w+)[.]md$/.match(path)
-      TextLine.add_lazy_doc_id(res[1])
-    end
-  end
-
   def self.create_specification(path)
     color = @@spec_colors[@@color_index]
     @@color_index += 1
@@ -64,6 +60,19 @@ class DocFabric
     doc
   end
 
+  def self.create_decision(path)
+    doc = Decision.new path
+    DocFabric.parse_document doc
+    doc.extract_current_status
+    doc.extract_start_date
+    doc.extract_target_release_version
+    doc
+  end
+
+  def self.create_decisions_overview(project)
+    DecisionsOverview.new project
+  end
+
   def self.create_source_file(repository_path, path, repository_name)
     doc = SourceFile.new repository_path, path, repository_name
     DocFabric.parse_source_file doc
@@ -78,7 +87,7 @@ class DocFabric
     DocParser.parse(doc, file_lines)
 
     # Build dom
-    doc.dom = Document.new(doc.headings) if doc.is_a?(Specification) || doc.is_a?(Protocol)
+    doc.dom = Document.new(doc.headings) if doc.is_a?(Specification) || doc.is_a?(Protocol) || doc.is_a?(Decision)
   end
 
   def self.parse_source_file(doc)

data/lib/almirah/doc_items/controlled_paragraph.rb

@@ -2,7 +2,7 @@ require_relative 'paragraph'
 
 # <REQ> Implementa a controlled paragraph as a subclass of the DocItem >[SRS-001] </REQ>
 class ControlledParagraph < Paragraph
-  attr_accessor :id, :up_link_ids, :down_links, :coverage_links, :source_code_links
+  attr_accessor :id, :up_link_ids, :down_links, :coverage_links, :source_code_links, :decision_record_links
 
   def initialize(doc, text, id)
     super(doc, text)
@@ -12,6 +12,7 @@ class ControlledParagraph < Paragraph
     @down_links = nil
     @coverage_links = nil
     @source_code_links = nil
+    @decision_record_links = nil
   end
 
   def to_html
@@ -19,7 +20,7 @@ class ControlledParagraph < Paragraph
     unless @@html_table_render_in_progress
       s += "<table class=\"controlled\">\n"
       s += "\t<thead> <th>#</th> <th></th> <th title=\"Up-links\">UL</th> <th title=\"Down-links\">DL</th> \
-        <th title=\"Test Coverage\">COV</th> </thead>\n"
+        <th title=\"Test Coverage\">COV</th> <th title=\"Decision Record\">DR</th> </thead>\n"
       @@html_table_render_in_progress = true # rubocop:disable Style/ClassVars
     end
     f_text = format_string(@text)
@@ -108,6 +109,31 @@ class ControlledParagraph < Paragraph
     else
       s += "\t\t<td class=\"item_id\"></td>\n"
     end
+
+    if @decision_record_links
+      if @decision_record_links.length == 1
+        dr_doc = @decision_record_links[0].parent_doc
+        s += "\t\t<td class=\"item_id\">\
+            <a href=\"./../../decisions/#{dr_doc.html_rel_path}\" \
+            class=\"external\" title=\"Decision Record\">#{dr_doc.id.upcase}</a></td>\n"
+      else
+        s += "\t\t<td class=\"item_id\">"
+        s += "<div id=\"DR_#{@id}\" style=\"display: block;\">"
+        s += "<a  href=\"#\" onclick=\"decisionLink_OnClick(this.parentElement); return false;\" \
+            class=\"external\" title=\"Number of decision records\">#{@decision_record_links.length}</a>"
+        s += '</div>'
+        s += "<div id=\"DRS_#{@id}\" style=\"display: none;\">"
+        @decision_record_links.each do |lnk|
+          dr_doc = lnk.parent_doc
+          s += "\t\t\t<a href=\"./../../decisions/#{dr_doc.html_rel_path}\" \
+            class=\"external\" title=\"Referenced in\">#{dr_doc.id.upcase}</a>\n<br>"
+        end
+        s += '</div>'
+        s += "</td>\n"
+      end
+    else
+      s += "\t\t<td class=\"item_id\"></td>\n"
+    end
     s += "\t</tr>\n"
     s
   end

data/lib/almirah/doc_items/controlled_table.rb

@@ -101,13 +101,14 @@ class TestStepReferenceColumn < ControlledTableColumn # rubocop:disable Style/Do
 
   def to_html # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
     s = ''
+    specifications_path = @parent_row.parent_doc.specifications_path
     if @up_link_ids
       if @up_link_ids.length == 1
         if tmp = /^([a-zA-Z]+)-\d+/.match(@up_link_ids[0])
           up_link_doc_name = tmp[1].downcase
         end
         s += "\t\t<td class=\"item_id\" style=\"text-align: center;\">\
-                    <a href=\"./../../../specifications/#{up_link_doc_name}/#{up_link_doc_name}.html##{@up_link_ids[0]}\" \
+                    <a href=\"#{specifications_path}#{up_link_doc_name}/#{up_link_doc_name}.html##{@up_link_ids[0]}\" \
                     class=\"external\" title=\"Linked to\">#{@up_link_ids[0]}</a></td>\n"
       else
         s += "\t\t<td class=\"item_id\" style=\"text-align: center;\">"
@@ -120,7 +121,7 @@ class TestStepReferenceColumn < ControlledTableColumn # rubocop:disable Style/Do
           if tmp = /^([a-zA-Z]+)-\d+/.match(lnk)
             up_link_doc_name = tmp[1].downcase
           end
-          s += "\t\t\t<a href=\"./../../../specifications/#{up_link_doc_name}/#{up_link_doc_name}.html##{lnk}\" \
+          s += "\t\t\t<a href=\"#{specifications_path}#{up_link_doc_name}/#{up_link_doc_name}.html##{lnk}\" \
                     class=\"external\" title=\"Verifies\">#{lnk}</a>\n<br>"
         end
         s += '</div>'
@@ -150,7 +151,7 @@ class ControlledTable < DocItem # rubocop:disable Style/Documentation
   end
 
   def add_row(row)
-    columns = row.split('|')
+    columns = split_table_cells(row)
 
     @rows.append(format_columns(columns))
 
@@ -184,7 +185,7 @@ class ControlledTable < DocItem # rubocop:disable Style/Documentation
           end
         end
 
-      elsif index + 2 == columns.length # it is expected that test step result is placed to the pre-last column only
+      elsif (index + 2 == columns.length) && @parent_doc.instance_of?(Protocol) # test step result column applies only to Protocols
 
         col = TestStepResultColumn.new element
         new_row.columns.append col

data/lib/almirah/doc_items/doc_item.rb

@@ -19,4 +19,16 @@ class DocItem < TextLine # rubocop:disable Style/Documentation
   def get_url
     ''
   end
+
+  # Splits a Markdown table row into its cell strings, treating a backslash-escaped
+  # pipe (\|) as a literal character within a cell rather than a column separator
+  # (e.g. a "|" inside an inline code span such as `[[target\|alias]]`). The escaping
+  # backslash is dropped so the cell renders the intended literal pipe.
+  def split_table_cells(row)
+    row.split(/(?<!\\)\|/).map { |cell| cell.gsub('\\|', '|') }
+  end
+
+  def owner_document
+    @parent_doc
+  end
 end

data/lib/almirah/doc_items/markdown_list.rb

@@ -73,7 +73,7 @@ class MarkdownList < DocItem
     s.each_char do |c|
       case state
       when 'looking_for_list_item_marker'
-        if c == '*'
+        if c == '*' || c == '-'
           state = 'looking_for_space'
         elsif numeric?(c)
           state = 'looking_for_dot'
@@ -106,7 +106,7 @@ class MarkdownList < DocItem
   end
 
   def self.unordered_list_item?(raw_text)
-    res = /(\*\s?)(.*)/.match(raw_text)
+    res = /^\s*([*\-]\s+)(.*)/.match(raw_text)
     return true if res
 
     false

data/lib/almirah/doc_items/markdown_table.rb

@@ -3,21 +3,23 @@
 require_relative 'doc_item'
 
 class MarkdownTable < DocItem
-  attr_accessor :column_names, :rows, :heading_row, :is_separator_detected, :column_aligns
+  attr_accessor :column_names, :rows, :heading_row, :is_separator_detected, :column_aligns,
+                :is_decision_status_table
 
-  def initialize(doc, heading_row)
+  def initialize(doc, heading_row) # rubocop:disable Metrics/MethodLength
     super(doc)
     @heading_row = heading_row
 
     res = /^[|](.*[|])/.match(heading_row)
     @column_names = if res
-                      res[1].split('|')
+                      split_table_cells(res[1])
                     else
                       ['# ERROR# ']
                     end
     @rows = []
     @is_separator_detected = false
     @column_aligns = []
+    @is_decision_status_table = false
   end
 
   def add_separator(line)
@@ -47,7 +49,7 @@ class MarkdownTable < DocItem
   end
 
   def add_row(row)
-    columns = row.split('|')
+    columns = split_table_cells(row)
     @rows.append(columns.map!(&:strip))
     true
   end
@@ -69,10 +71,17 @@ class MarkdownTable < DocItem
     s += " </thead>\n"
 
     @rows.each do |row|
-      s += "\t<tr>\n"
+      tr_class = if @is_decision_status_table && row[0].to_s.strip == '*'
+                   ' class="current_status"'
+                 else
+                   ''
+                 end
+      s += "\t<tr#{tr_class}>\n"
       row.each_with_index do |col, index|
-        if col.to_i.positive? && col.to_i.to_s == col  # autoalign cells with numbers
-          s += "\t\t<td style=\"text-align: center;\">#{col}</td>\n"
+        cell = col
+        cell = '▶' if @is_decision_status_table && index.zero? && col.strip == '*'
+        if cell.to_i.positive? && cell.to_i.to_s == cell  # autoalign cells with numbers
+          s += "\t\t<td style=\"text-align: center;\">#{cell}</td>\n"
         else
           align = ''
           case @column_aligns[index]
@@ -83,7 +92,7 @@ class MarkdownTable < DocItem
           when 'center'
             align = 'style="text-align: center;"'
           end
-          f_text = format_string(col)
+          f_text = format_string(cell)
           s += "\t\t<td #{align}>#{f_text}</td>\n"
         end
       end