Almirah 0.2.4 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2fa95a589e6285719010318ec666da5cf309ef511cd69cb2ffc6629464d64ae0
-  data.tar.gz: f2c8fd5747f9c5e53417744eac9caa15e2c313987d94c36b8d446434089f14fd
+  metadata.gz: 163089850b213b2d22e6f4eacb5497d86afa143ecd5f2c02f1b9f2985e8b22cf
+  data.tar.gz: b6c93f44780216b6d8f898c7f037efe22ebdcf92978d68ab907fc6794e6bdac1
 SHA512:
-  metadata.gz: e0071aa202dac9bd73495fb389db3008f83ff5dff9bd61d8d4f957abb935a1727362e51a3e2c6418a7a388ea28d6baef344500ec9ec46256b803982dbd5275cd
-  data.tar.gz: bcfbdf1cbca81f17d3e305723c111a38327ca16f3a8e8c28795e3135041e8a97d64e0baddd1780ae826bec85ddb0cbcf5533908506debde61d1d27e31caf02bf
+  metadata.gz: dfb26159036daa64ab4107352aab6f1e4ae0f92945050945d46a4742d59eddc223a23e6108189595120ec63e44ad85e07a198222574f238391ac091c903965a3
+  data.tar.gz: fe7a12729f62b9b5faee456c2d6ce9fe31d1730da4e9cd0c1057ad4420043eb8628f79b67b4bc38f57aafc49b890f9ec7627814c4fae44cb0d7486b5c5821b05

data/bin/almirah

@@ -1,5 +1,5 @@
-#!/usr/bin/env ruby
-
-require "almirah"
-
+#!/usr/bin/env ruby
+
+require "almirah"
+
 CLI.start(ARGV)

data/lib/almirah/doc_fabric.rb

@@ -1,65 +1,65 @@
-require_relative 'doc_types/base_document'
-require_relative 'doc_types/specification'
-require_relative 'doc_types/protocol'
-require_relative 'doc_types/coverage'
-require_relative 'doc_parser'
-require_relative 'dom/document'
-require_relative 'doc_items/heading'
-
-class DocFabric
-  @@color_index = 0
-  @@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
-    @@color_index = 0 if @@color_index >= @@spec_colors.length
-    doc = Specification.new path
-    DocFabric.parse_document doc
-    doc.color = color
-    doc
-  end
-
-  def self.create_protocol(path)
-    doc = Protocol.new path
-    DocFabric.parse_document doc
-    doc
-  end
-
-  def self.create_coverage_matrix(specification)
-    doc = Coverage.new specification
-    Heading.reset_global_section_number
-    doc.headings << Heading.new(doc, doc.title, 0)
-    # Build dom
-    doc.dom = Document.new(doc.headings)
-    doc
-  end
-
-  def self.create_traceability_document(top_document, bottom_document)
-    doc = Traceability.new top_document, bottom_document
-    Heading.reset_global_section_number
-    doc.headings << Heading.new(doc, doc.title, 0)
-    # Build dom
-    doc.dom = Document.new(doc.headings)
-    doc
-  end
-
-  def self.parse_document(doc)
-
-    file = File.open(doc.path)
-    file_lines = file.readlines
-    file.close
-
-    DocParser.parse(doc, file_lines)
-
-    # Build dom
-    doc.dom = Document.new(doc.headings) if doc.is_a?(Specification) || doc.is_a?(Protocol)
-  end
-end
+require_relative 'doc_types/base_document'
+require_relative 'doc_types/specification'
+require_relative 'doc_types/protocol'
+require_relative 'doc_types/coverage'
+require_relative 'doc_parser'
+require_relative 'dom/document'
+require_relative 'doc_items/heading'
+
+class DocFabric
+  @@color_index = 0
+  @@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
+    @@color_index = 0 if @@color_index >= @@spec_colors.length
+    doc = Specification.new path
+    DocFabric.parse_document doc
+    doc.color = color
+    doc
+  end
+
+  def self.create_protocol(path)
+    doc = Protocol.new path
+    DocFabric.parse_document doc
+    doc
+  end
+
+  def self.create_coverage_matrix(specification)
+    doc = Coverage.new specification
+    Heading.reset_global_section_number
+    doc.headings << Heading.new(doc, doc.title, 0)
+    # Build dom
+    doc.dom = Document.new(doc.headings)
+    doc
+  end
+
+  def self.create_traceability_document(top_document, bottom_document)
+    doc = Traceability.new top_document, bottom_document
+    Heading.reset_global_section_number
+    doc.headings << Heading.new(doc, doc.title, 0)
+    # Build dom
+    doc.dom = Document.new(doc.headings)
+    doc
+  end
+
+  def self.parse_document(doc)
+
+    file = File.open(doc.path)
+    file_lines = file.readlines
+    file.close
+
+    DocParser.parse(doc, file_lines)
+
+    # Build dom
+    doc.dom = Document.new(doc.headings) if doc.is_a?(Specification) || doc.is_a?(Protocol)
+  end
+end

data/lib/almirah/doc_items/blockquote.rb

@@ -1,22 +1,22 @@
-require_relative "doc_item"
-
-class Blockquote < DocItem
-
-    attr_accessor :text
-
-    def initialize(text)
-        @text = text
-    end
-
-    def to_html
-        s = ''
-        f_text = format_string(@text)
-        if @@html_table_render_in_progress
-            s += "</table>\n"
-            @@html_table_render_in_progress = false
-        end
-
-        s += "<div class=\"blockquote\"><p>#{f_text}</div>\n"
-        return s
-    end
+require_relative "doc_item"
+
+class Blockquote < DocItem
+
+    attr_accessor :text
+
+    def initialize(text)
+        @text = text
+    end
+
+    def to_html
+        s = ''
+        f_text = format_string(@text)
+        if @@html_table_render_in_progress
+            s += "</table>\n"
+            @@html_table_render_in_progress = false
+        end
+
+        s += "<div class=\"blockquote\"><p>#{f_text}</div>\n"
+        return s
+    end
 end

data/lib/almirah/doc_items/code_block.rb

@@ -1,27 +1,27 @@
-require_relative "doc_item"
-
-class CodeBlock < DocItem
-
-    attr_accessor :suggested_format
-    attr_accessor :code_lines
-
-    def initialize(suggested_format)
-        @suggested_format = suggested_format
-        @code_lines = Array.new
-    end
-
-    def to_html
-        s = ''
-
-        if @@html_table_render_in_progress
-            s += "</table>\n"
-            @@html_table_render_in_progress = false
-        end
-        s += "<code>"
-        @code_lines.each do |l|
-            s += l + " </br>"
-        end
-        s += "</code>\n"
-        return s
-    end
+require_relative "doc_item"
+
+class CodeBlock < DocItem
+
+    attr_accessor :suggested_format
+    attr_accessor :code_lines
+
+    def initialize(suggested_format)
+        @suggested_format = suggested_format
+        @code_lines = Array.new
+    end
+
+    def to_html
+        s = ''
+
+        if @@html_table_render_in_progress
+            s += "</table>\n"
+            @@html_table_render_in_progress = false
+        end
+        s += "<code>"
+        @code_lines.each do |l|
+            s += l + " </br>"
+        end
+        s += "</code>\n"
+        return s
+    end
 end

data/lib/almirah/doc_items/controlled_paragraph.rb

@@ -1,112 +1,112 @@
-require_relative 'paragraph'
-
-class ControlledParagraph < Paragraph
-  attr_accessor :id, :up_link_ids, :down_links, :coverage_links
-
-  def initialize(doc, text, id)
-    super(doc, text)
-    @parent_heading = doc.headings[-1]
-    @id = id
-    @up_link_ids = nil
-    @down_links = nil
-    @coverage_links = nil
-  end
-
-  def to_html
-    s = ''
-    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"
-      @@html_table_render_in_progress = true # rubocop:disable Style/ClassVars
-    end
-    f_text = format_string(@text)
-    s += "\t<tr>\n"
-    s += "\t\t<td class=\"item_id\"> \
-        <a name=\"#{@id}\" id=\"#{@id}\" href=\"##{@id}\" title=\"Paragraph ID\">#{@id}</a></td>\n"
-    s += "\t\t<td class=\"item_text\">#{f_text}</td>\n"
-
-    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\">\
-            <a href=\"./../#{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\">"
-        s += "<div id=\"UL_#{@id}\" style=\"display: block;\">"
-        s += "<a  href=\"#\" onclick=\"upLink_OnClick(this.parentElement); return false;\" \
-            class=\"external\" title=\"Number of up-links\">#{@up_link_ids.length}</a>"
-        s += '</div>'
-        s += "<div id=\"ULS_#{@id}\" style=\"display: none;\">"
-        @up_link_ids.each do |lnk|
-          if tmp = /^([a-zA-Z]+)-\d+/.match(lnk)
-            up_link_doc_name = tmp[1].downcase
-          end
-          s += "\t\t\t<a href=\"./../#{up_link_doc_name}/#{up_link_doc_name}.html##{lnk}\" \
-            class=\"external\" title=\"Linked to\">#{lnk}</a>\n<br>"
-        end
-        s += '</div>'
-        s += "</td>\n"
-      end
-    else
-      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
-      if @down_links.length == 1
-        s += "\t\t<td class=\"item_id\">\
-            <a href=\"./../#{down_link_doc_name}/#{down_link_doc_name}.html##{@down_links[0].id}\" \
-            class=\"external\" title=\"Referenced in\">#{@down_links[0].id}</a></td>\n"
-      else
-        s += "\t\t<td class=\"item_id\">"
-        s += "<div id=\"DL_#{@id}\" style=\"display: block;\">"
-        s += "<a  href=\"#\" onclick=\"downlink_OnClick(this.parentElement); return false;\" \
-            class=\"external\" title=\"Number of references\">#{@down_links.length}</a>"
-        s += '</div>'
-        s += "<div id=\"DLS_#{@id}\" style=\"display: none;\">"
-        @down_links.each do |lnk|
-          s += "\t\t\t<a href=\"./../#{lnk.parent_doc.id}/#{lnk.parent_doc.id}.html##{lnk.id}\" \
-            class=\"external\" title=\"Referenced in\">#{lnk.id}</a>\n<br>"
-        end
-        s += '</div>'
-        s += "</td>\n"
-      end
-    else
-      s += "\t\t<td class=\"item_id\"></td>\n"
-    end
-
-    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
-      if @coverage_links.length == 1
-        s += "\t\t<td class=\"item_id\">\
-            <a href=\"./../../tests/protocols/#{cov_link_doc_name}/#{cov_link_doc_name}.html\" \
-            class=\"external\" title=\"Number of verification steps\">#{@coverage_links[0].id}</a></td>\n"
-      else
-        s += "\t\t<td class=\"item_id\">"
-        s += "<div id=\"COV_#{@id}\" style=\"display: block;\">"
-        s += "<a  href=\"#\" onclick=\"coverageLink_OnClick(this.parentElement); return false;\" \
-            class=\"external\" title=\"Number of verification steps\">#{@coverage_links.length}</a>"
-        s += '</div>'
-        s += "<div id=\"COVS_#{@id}\" style=\"display: none;\">"
-        @coverage_links.each do |lnk|
-          s += "\t\t\t<a href=\"./../../tests/protocols/#{lnk.parent_doc.id}/#{lnk.parent_doc.id}.html##{lnk.id}\" \
-            class=\"external\" title=\"Covered in\">#{lnk.id}</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
-end
+require_relative 'paragraph'
+
+class ControlledParagraph < Paragraph
+  attr_accessor :id, :up_link_ids, :down_links, :coverage_links
+
+  def initialize(doc, text, id)
+    super(doc, text)
+    @parent_heading = doc.headings[-1]
+    @id = id
+    @up_link_ids = nil
+    @down_links = nil
+    @coverage_links = nil
+  end
+
+  def to_html
+    s = ''
+    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"
+      @@html_table_render_in_progress = true # rubocop:disable Style/ClassVars
+    end
+    f_text = format_string(@text)
+    s += "\t<tr>\n"
+    s += "\t\t<td class=\"item_id\"> \
+        <a name=\"#{@id}\" id=\"#{@id}\" href=\"##{@id}\" title=\"Paragraph ID\">#{@id}</a></td>\n"
+    s += "\t\t<td class=\"item_text\">#{f_text}</td>\n"
+
+    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\">\
+            <a href=\"./../#{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\">"
+        s += "<div id=\"UL_#{@id}\" style=\"display: block;\">"
+        s += "<a  href=\"#\" onclick=\"upLink_OnClick(this.parentElement); return false;\" \
+            class=\"external\" title=\"Number of up-links\">#{@up_link_ids.length}</a>"
+        s += '</div>'
+        s += "<div id=\"ULS_#{@id}\" style=\"display: none;\">"
+        @up_link_ids.each do |lnk|
+          if tmp = /^([a-zA-Z]+)-\d+/.match(lnk)
+            up_link_doc_name = tmp[1].downcase
+          end
+          s += "\t\t\t<a href=\"./../#{up_link_doc_name}/#{up_link_doc_name}.html##{lnk}\" \
+            class=\"external\" title=\"Linked to\">#{lnk}</a>\n<br>"
+        end
+        s += '</div>'
+        s += "</td>\n"
+      end
+    else
+      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
+      if @down_links.length == 1
+        s += "\t\t<td class=\"item_id\">\
+            <a href=\"./../#{down_link_doc_name}/#{down_link_doc_name}.html##{@down_links[0].id}\" \
+            class=\"external\" title=\"Referenced in\">#{@down_links[0].id}</a></td>\n"
+      else
+        s += "\t\t<td class=\"item_id\">"
+        s += "<div id=\"DL_#{@id}\" style=\"display: block;\">"
+        s += "<a  href=\"#\" onclick=\"downlink_OnClick(this.parentElement); return false;\" \
+            class=\"external\" title=\"Number of references\">#{@down_links.length}</a>"
+        s += '</div>'
+        s += "<div id=\"DLS_#{@id}\" style=\"display: none;\">"
+        @down_links.each do |lnk|
+          s += "\t\t\t<a href=\"./../#{lnk.parent_doc.id}/#{lnk.parent_doc.id}.html##{lnk.id}\" \
+            class=\"external\" title=\"Referenced in\">#{lnk.id}</a>\n<br>"
+        end
+        s += '</div>'
+        s += "</td>\n"
+      end
+    else
+      s += "\t\t<td class=\"item_id\"></td>\n"
+    end
+
+    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
+      if @coverage_links.length == 1
+        s += "\t\t<td class=\"item_id\">\
+            <a href=\"./../../tests/protocols/#{cov_link_doc_name}/#{cov_link_doc_name}.html\" \
+            class=\"external\" title=\"Number of verification steps\">#{@coverage_links[0].id}</a></td>\n"
+      else
+        s += "\t\t<td class=\"item_id\">"
+        s += "<div id=\"COV_#{@id}\" style=\"display: block;\">"
+        s += "<a  href=\"#\" onclick=\"coverageLink_OnClick(this.parentElement); return false;\" \
+            class=\"external\" title=\"Number of verification steps\">#{@coverage_links.length}</a>"
+        s += '</div>'
+        s += "<div id=\"COVS_#{@id}\" style=\"display: none;\">"
+        @coverage_links.each do |lnk|
+          s += "\t\t\t<a href=\"./../../tests/protocols/#{lnk.parent_doc.id}/#{lnk.parent_doc.id}.html##{lnk.id}\" \
+            class=\"external\" title=\"Covered in\">#{lnk.id}</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
+end