Almirah 0.4.5 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7ecb1c0f1633226eaccd34b70d7c45c6d00e6f8ec4b605231f71b7bea725dcd
-  data.tar.gz: a223709af5754031b0efef8c443fd158fad6c2c3fde08fbba83233e82075d82a
+  metadata.gz: 8f66f0846c24a185b1abb415b4772edd12d7e7dfe93a0802ce8017ade9d0a249
+  data.tar.gz: 5f542c8b0aa5aa363310f049041a8e4f4341e49fd54ce8eaf1f26c442746d337
 SHA512:
-  metadata.gz: 4d57afaec80f6e7370aec60e254f6650832ed2808a2b1550efc7a5271f69bd4e2bbce2e636eb2f7128b1a8ccee6e2bf978e0ca032ad275c399bbc334c12c57ab
-  data.tar.gz: a5e6de48b94a5de8a77ab8cb7e744116b3c9ecb5b92e3f81d1231c9436e412d9f1e53e97f2db9c2dc733f3dfdda6966e305b3b7faf9963453d1abff970358985
+  metadata.gz: 57099abaaeb800be450638dcd8cfc8915eda501389ab4833082b8006229e7d42eb9f861c82f07bbf828c79054e2c463b3a7cf52a897f6858354d50eb5a3d4395
+  data.tar.gz: a75661f96e5198cc71ffdec7da16577f58f23e18ff02c2c8fcd846d01dd332ded1995c8193ccfbf1789766ce657a3fd5fb328af6a1ae6312936733f6eeec4998

data/lib/almirah/doc_items/controlled_table.rb

@@ -103,15 +103,17 @@ class TestStepReferenceColumn < ControlledTableColumn
     s = ''
     specifications_path = @parent_row.parent_doc.specifications_path
     if @up_link_ids
+      cell_style = 'text-align: center;'
+      cell_style += ' background-color: #fcc;' if @up_link_ids.any? { |lnk| dangling?(lnk) }
       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;\">\
+        s += "\t\t<td class=\"item_id\" style=\"#{cell_style}\">\
                     <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"
+                    class=\"#{link_class(@up_link_ids[0])}\" title=\"#{link_title(@up_link_ids[0], 'Linked to')}\">#{@up_link_ids[0]}</a></td>\n"
       else
-        s += "\t\t<td class=\"item_id\" style=\"text-align: center;\">"
+        s += "\t\t<td class=\"item_id\" style=\"#{cell_style}\">"
         s += "<div id=\"COV_#{@parent_row.id}\" style=\"display: block;\">"
         s += "<a  href=\"#\" onclick=\"coverageLink_OnClick(this.parentElement); return false;\" \
                     class=\"external\" title=\"Number of verified items\">#{@up_link_ids.length}</a>"
@@ -122,7 +124,7 @@ class TestStepReferenceColumn < ControlledTableColumn
             up_link_doc_name = tmp[1].downcase
           end
           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>"
+                    class=\"#{link_class(lnk)}\" title=\"#{link_title(lnk, 'Verifies')}\">#{lnk}</a>\n<br>"
         end
         s += '</div>'
         s += "</td>\n"
@@ -131,6 +133,23 @@ class TestStepReferenceColumn < ControlledTableColumn
       "\t\t<td style=\"text-align: center;\"></td>\n\r"
     end
   end
+
+  # An uplink to a paragraph missing from an existing specification, per the
+  # owning document's wrong-links collection (ENH-225). The cell renders it
+  # with the wrong-links red background and the broken-link style, keeping
+  # the link to the target document clickable.
+  def dangling?(link_id)
+    doc = @parent_row.parent_doc
+    doc.respond_to?(:wrong_links_hash) && doc.wrong_links_hash.key?(link_id)
+  end
+
+  def link_class(link_id)
+    dangling?(link_id) ? 'external broken_link' : 'external'
+  end
+
+  def link_title(link_id, resolved_title)
+    dangling?(link_id) ? 'Linked item does not exist' : resolved_title
+  end
 end
 
 class ControlledTable < DocItem

data/lib/almirah/doc_types/base_document.rb

@@ -6,7 +6,7 @@ class BaseDocument
   attr_accessor :title, :id, :dom, :headings, :output_rel_path
 
   class << self
-    attr_accessor :show_decisions_link, :show_risks_link
+    attr_accessor :show_decisions_link, :show_risks_link, :font_size
   end
 
   def initialize
@@ -55,6 +55,7 @@ class BaseDocument
         file.puts s.gsub! '{{DOCUMENT_TITLE}}', @title
       elsif s.include?('{{STYLES_AND_SCRIPTS}}')
         file.puts "<link rel=\"stylesheet\" href=\"#{rel_to('css/main.css')}\">"
+        file.puts font_size_style if BaseDocument.font_size
         file.puts "<script src=\"#{rel_to('scripts/main.js')}\"></script>"
         if @id == 'index'
           file.puts "<script type=\"module\" src=\"#{rel_to('scripts/orama_search.js')}\"></script>"
@@ -63,11 +64,7 @@ class BaseDocument
           file.puts '<script src="https://cdn.jsdelivr.net/npm/chart.js"></script>'
         end
       elsif s.include?('{{HOME_BUTTON}}')
-        if @id == 'index'
-          file.puts home_link(rel_to('index.html'))
-        else
-          file.puts index_link(rel_to('index.html'))
-        end
+        file.puts index_link(rel_to('index.html'))
         file.puts decisions_link(rel_to('decisions/overview.html')) if BaseDocument.show_decisions_link
         file.puts risks_link(rel_to('risks/overview.html')) if BaseDocument.show_risks_link
       elsif s.include?('{{GEM_VERSION}}')
@@ -89,14 +86,19 @@ class BaseDocument
     %(<a id="risks_menu_item" href="#{href}">#{icon}&nbsp;Risks</a>)
   end
 
+  # The Documents item (ADR-223): the same link on every page, the Index page
+  # included, where it self-links — no Home variant. The element id stays
+  # index_menu_item; the label is presentation, the id is an interface.
   def index_link(href)
-    icon = '<span><i class="fa fa-info" aria-hidden="true"></i></span>'
-    %(<a id="index_menu_item" href="#{href}">#{icon}&nbsp;Index</a>)
+    icon = '<span><i class="fa fa-home" aria-hidden="true"></i></span>'
+    %(<a id="index_menu_item" href="#{href}">#{icon}&nbsp;Documents</a>)
   end
 
-  def home_link(href)
-    icon = '<span><i class="fa fa-home" aria-hidden="true"></i></span>'
-    %(<a id="home_menu_item" href="#{href}">#{icon}&nbsp;Home</a>)
+  # The inline override carrying the project.yml font_size (ADR-224). Emitted
+  # after the main.css link only when the setting exists, so unconfigured
+  # projects render exactly as before.
+  def font_size_style
+    "<style>:root { --almirah-font-size: #{BaseDocument.font_size}px; }</style>"
   end
 
   # Relative URL from this page to a target path under the build root.

data/lib/almirah/doc_types/protocol.rb

@@ -1,12 +1,15 @@
 require_relative 'persistent_document'
 
 class Protocol < PersistentDocument
-  attr_accessor :specifications_path
+  attr_accessor :specifications_path, :wrong_links_hash
 
   def initialize(fele_path)
     super
     @id = File.basename(fele_path, File.extname(fele_path)).downcase
     @specifications_path = './../../../specifications/'
+    # The linker records dangling Req-IDs here as for every other linked
+    # document type (ISSUE-226); without it a dangling reference crashed the build.
+    @wrong_links_hash = {}
   end
 
   def to_html(nav_pane, output_file_path)

data/lib/almirah/doc_types/risks_overview.rb

@@ -61,8 +61,8 @@ class RisksOverview < BaseDocument
     s += "\t\t<td class=\"item_text\" style='padding: 5px;'>\
 <a name=\"#{name}\" id=\"#{name}\" href=\"./#{name}/overview.html\" class=\"external\" \
 title=\"Risk Registry\">#{registry_title(name)}</a></td>\n"
-    s += "\t\t<td class=\"item_rpn\">#{records.length}</td>\n"
-    s += "\t\t<td class=\"item_rpn\">#{open_count(records)}</td>\n"
+    s += "\t\t<td class=\"item_rpn\" style='width: 7%;'>#{records.length}</td>\n"
+    s += "\t\t<td class=\"item_rpn\" style='width: 7%;'>#{open_count(records)}</td>\n"
     s += render_highest_cell(values, group)
     s += render_average_cell(values)
     s + "\t</tr>\n"
@@ -86,17 +86,17 @@ title=\"Risk Registry\">#{registry_title(name)}</a></td>\n"
   # The worst risk's verdict carries up: the cell keeps the leading group's
   # threshold colouring. Blank without a group or computable values.
   def render_highest_cell(values, group)
-    return "\t\t<td class=\"item_rpn\"></td>\n" if values.empty?
+    return "\t\t<td class=\"item_rpn\" style='width: 7%;'></td>\n" if values.empty?
 
     highest = values.max
     classes = ['item_rpn', rpn_threshold_class(highest, group)].compact.join(' ')
-    "\t\t<td class=\"#{classes}\">#{format_rpn(highest)}</td>\n"
+    "\t\t<td class=\"#{classes}\" style='width: 7%;'>#{format_rpn(highest)}</td>\n"
   end
 
   def render_average_cell(values)
-    return "\t\t<td class=\"item_rpn\"></td>\n" if values.empty?
+    return "\t\t<td class=\"item_rpn\" style='width: 7%;'></td>\n" if values.empty?
 
     average = (values.sum.to_f / values.length).round(1)
-    "\t\t<td class=\"item_rpn\">#{format_rpn(average)}</td>\n"
+    "\t\t<td class=\"item_rpn\" style='width: 7%;'>#{format_rpn(average)}</td>\n"
   end
 end

data/lib/almirah/doc_types/source_file.rb

@@ -94,9 +94,10 @@ class SourceFile < PersistentDocument
         file.puts s.gsub! '{{DOCUMENT_TITLE}}', @title
       elsif s.include?('{{STYLES_AND_SCRIPTS}}')
         file.puts "<link rel=\"stylesheet\" href=\"#{css_path}\">"
+        file.puts font_size_style if BaseDocument.font_size
         file.puts "<script src=\"#{js_path}\"></script>"
       elsif s.include?('{{HOME_BUTTON}}')
-        file.puts "<a id=\"index_menu_item\" href=\"#{index_path}\"><span><i class=\"fa fa-info\" aria-hidden=\"true\"></i></span>&nbsp;Index</a>"
+        file.puts "<a id=\"index_menu_item\" href=\"#{index_path}\"><span><i class=\"fa fa-home\" aria-hidden=\"true\"></i></span>&nbsp;Documents</a>"
       elsif s.include?('{{GEM_VERSION}}')
         file.puts "(#{Gem.loaded_specs['Almirah'].version.version})"
       else

data/lib/almirah/project.rb

@@ -18,6 +18,7 @@ class Project
   def initialize(configuration)
     @configuration = configuration
     @project_data = ProjectData.new
+    BaseDocument.font_size = @configuration.get_font_size
 
     @index = nil
     @project = self
@@ -59,6 +60,7 @@ class Project
     render_all_protocols
     render_all_source_files
     render_all_specifications(@project_data.implementation_matrices) # intentionally after source file rendering
+    copy_decision_and_risk_images
     render_decisions_overview
     render_all_decisions
     render_all_risk_records
@@ -90,6 +92,7 @@ class Project
     render_all_protocols
     render_all_source_files
     render_all_specifications(@project_data.implementation_matrices) # intentionally after source file rendering
+    copy_decision_and_risk_images
     render_decisions_overview
     render_all_decisions
     render_all_risk_records
@@ -473,6 +476,25 @@ class Project
     end
   end
 
+  # Every folder named img under decisions/ and risks/ is copied to the same
+  # relative location under build/ (ADR-227, SRS-176), so relative image
+  # references in decision records, risk records, and registry prefaces
+  # resolve in the rendered HTML. Folder-based rather than doc-id-based like
+  # the specification and protocol copies, because these records share their
+  # release and registry folders.
+  def copy_decision_and_risk_images
+    root = @configuration.project_root_directory
+    %w[decisions risks].each do |subroot|
+      Dir.glob("#{root}/#{subroot}/**/img").each do |src|
+        next unless File.directory?(src)
+
+        dst = "#{root}/build/#{src.sub("#{root}/", '')}"
+        FileUtils.mkdir_p(File.dirname(dst))
+        FileUtils.copy_entry(src, dst)
+      end
+    end
+  end
+
   def render_all_source_files
     path = @configuration.project_root_directory
     FileUtils.mkdir_p("#{path}/build/source_files")

data/lib/almirah/project_configuration.rb

@@ -29,6 +29,13 @@ class ProjectConfiguration
     []
   end
 
+  # The optional base text size in pixels (ADR-224), from the top-level
+  # font_size: number. nil when absent or not a positive number.
+  def get_font_size
+    value = @parameters.is_a?(Hash) ? @parameters['font_size'] : nil
+    value.is_a?(Numeric) && value.positive? ? value : nil
+  end
+
   # The ordered register-column list for a risk registry folder (ADR-216),
   # read from the risks: root — a list of { folder:, columns: } entries.
   # nil when the registry carries no configuration; such a registry renders

data/lib/almirah/templates/css/main.css

@@ -5,7 +5,10 @@ html {
 }
 body {
     font-family: Verdana, sans-serif;
-    font-size: 12px;
+    /* Base text size, overridable per project via font_size in project.yml
+       (ADR-224). Headings, top menu and footer are pinned in px below so the
+       setting scales only the reading text and the navigation pane. */
+    font-size: var(--almirah-font-size, 12px);
     color: #333;
     margin: 0;
     padding: 0;
@@ -30,24 +33,24 @@ body {
     margin: 0 0 10px 0;
 }
 h1 {
-    font-size: 2em;
+    font-size: 24px;
 }
 h2 {
-    font-size: 1.8em;
+    font-size: 21.6px;
 }
 h3 {
-    font-size: 1.5em;
+    font-size: 18px;
 }
 h4 {
-    font-size: 1.2em;
+    font-size: 14.4px;
     border: none;
     font-weight: bold;
 }
 h5 {
-    font-size: 1em;
+    font-size: 12px;
 }
 h6 {
-    font-size: 1em; color: #8e8e8e;
+    font-size: 12px; color: #8e8e8e;
 }
 a.heading_anchor { 
     display: none;
@@ -260,7 +263,7 @@ img{
     text-align: center;
     padding: 4px 6px;
     text-decoration: none;
-    font-size: 1.5em;
+    font-size: 18px;
     font-family: "Trebuchet MS", Verdana, sans-serif;
 }
 #top_nav a.split {
@@ -269,7 +272,7 @@ img{
     text-align: center;
     padding: 4px 6px;
     text-decoration: none;
-    font-size: 1.5em;
+    font-size: 18px;
     font-family: "Trebuchet MS", Verdana, sans-serif;
 }
 #top_nav a:hover {
@@ -343,7 +346,7 @@ img{
 #footer {
     clear: both;
     border-top: 1px solid #bbb;
-    font-size: 0.9em;
+    font-size: 10.8px;
     color: #aaa;
     padding: 5px;
     text-align:center;

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: Almirah
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.6
 platform: ruby
 authors:
 - Oleksandr Ivanov