Almirah 0.4.2 → 0.4.4

data/lib/almirah/project_template.rb

@@ -2,7 +2,7 @@
 
 require 'fileutils'
 
-class ProjectTemplate # rubocop:disable Style/Documentation
+class ProjectTemplate
   attr_accessor :project_root
 
   def initialize(project_name)
@@ -324,11 +324,11 @@ class ProjectTemplate # rubocop:disable Style/Documentation
 
       # Scope
 
-      | Item | Status | Start Date | Target Date | Description |
-      |---|---|---|---|---|
-      | Requirements | To Do | | | |
-      | Code | To Do | | | |
-      | Tests | To Do | | | |
+      | # | Item | Owner | Depends On | Est (focused) | Est (safe) | Status | Start Date | Target Date | Description |
+      |---|---|---|---|---|---|---|---|---|---|
+      | 1 | Requirements | BA | | 2 | 3 | To Do | | | |
+      | 2 | Code | DEV | | 3 | 5 | To Do | | | |
+      | 3 | Tests | TEST | | 2 | 4 | To Do | | | |
 
       # Out of Scope
 

data/lib/almirah/project_utility.rb

@@ -2,7 +2,7 @@
 
 require 'fileutils'
 
-class ProjectUtility # rubocop:disable Style/Documentation
+class ProjectUtility
   attr_accessor :configuration
 
   def initialize(configuration)
@@ -19,7 +19,7 @@ class ProjectUtility # rubocop:disable Style/Documentation
 
   private
 
-  def combine(run_id) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+  def combine(run_id)
     path = @configuration.project_root_directory
     dst_folder = "#{@configuration.project_root_directory}/build"
     FileUtils.mkdir_p(dst_folder)
@@ -29,9 +29,7 @@ class ProjectUtility # rubocop:disable Style/Documentation
     dst_f = File.open(dst_file, 'a')
 
     src_path = if run_id
-                 unless Dir.exist? "#{path}/tests/runs/#{run_id}"
-                   puts "\e[1m\e[31m Run #{run_id} folder does not exists"
-                 end
+                 puts "\e[1m\e[31m Run #{run_id} folder does not exists" unless Dir.exist? "#{path}/tests/runs/#{run_id}"
                  "#{path}/tests/runs/#{run_id}/**/*.md"
                else
                  "#{path}/tests/protocols/**/*.md"

data/lib/almirah/search/specifications_db.rb

@@ -12,7 +12,7 @@ class SpecificationsDb
     create_data
   end
 
-  def create_data # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+  def create_data
     @specifications.each do |sp|
       sp.items.each do |i|
         if (i.instance_of? Paragraph) or (i.instance_of? ControlledParagraph)
@@ -31,7 +31,7 @@ class SpecificationsDb
     end
   end
 
-  def add_markdown_list_item_to_db(data, item_for_reference, item_to_process) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+  def add_markdown_list_item_to_db(data, item_for_reference, item_to_process)
     e = nil
     item_to_process.rows.each do |r|
       if r.is_a?(MarkdownList)

data/lib/almirah/source_file_parser.rb

@@ -2,7 +2,7 @@ require_relative 'doc_items/doc_item'
 require_relative 'doc_items/heading'
 require_relative 'doc_items/source_code_paragraph'
 
-class SourceFileParser # rubocop:disable Style/Documentation
+class SourceFileParser
   def self.parse(doc, file_lines)
     # restart section numbering for each new document
     Heading.reset_global_section_number
@@ -19,7 +19,7 @@ class SourceFileParser # rubocop:disable Style/Documentation
     doc.headings.append(item)
 
     # main loop
-    file_lines.each do |s| # rubocop:disable Metrics/BlockLength
+    file_lines.each do |s|
       res = %r{<REQ>(.*)</REQ>}.match(s) # Document Referece Item
       next unless res
 
@@ -36,7 +36,6 @@ class SourceFileParser # rubocop:disable Style/Documentation
         up_links = []
         tmp.each do |ul|
           lnk = ul[0]
-          #
           doc_id = /([a-zA-Z]+)-\d+/.match(lnk) # SRS
           up_links << lnk.upcase if doc_id
           # try to find the real end of text

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

@@ -77,6 +77,9 @@ table.markdown_table td{
 table.markdown_table tr.current_status td {
     background-color: #ffffee;
 }
+table.markdown_table td.scope_date {
+    white-space: nowrap;
+}
 table.controlled{
     border: 1px solid #e4e4e4;
     border-collapse: collapse;
@@ -144,6 +147,163 @@ table.controlled td.item_text{
     max-width: 100%;
     max-height: 300px;
 }
+.workitem_gantt {
+    --gantt-owner-width: 120px;
+    --gantt-day-width: 26px;
+    --gantt-month-h: 18px;
+    overflow: auto;
+    max-height: 420px;
+    margin-bottom: 16px;
+    border: 1px solid #e1e4e8;
+}
+.workitem_gantt .gantt_grid {
+    display: grid;
+    gap: 0;
+    width: max-content;
+    padding: 4px;
+}
+.workitem_gantt .gantt_corner,
+.workitem_gantt .gantt_owner,
+.workitem_gantt .gantt_owner_tracking,
+.workitem_gantt .gantt_band_corner,
+.workitem_gantt .gantt_buffer {
+    position: sticky;
+    left: 0;
+    background: #fff;
+    padding: 2px 8px;
+    font-weight: 600;
+    white-space: nowrap;
+    border-right: 1px solid #e1e4e8;
+    z-index: 2;
+}
+.workitem_gantt .gantt_corner {
+    top: 0;
+    border-bottom: 1px solid #bbb;
+    z-index: 3;
+}
+.workitem_gantt .gantt_month_head {
+    position: sticky;
+    top: 0;
+    background: #fff;
+    text-align: center;
+    font-size: 11px;
+    font-weight: 600;
+    color: #57606a;
+    border-bottom: 1px solid #e1e4e8;
+    border-left: 1px solid #d0d7de;
+    white-space: nowrap;
+    overflow: hidden;
+    z-index: 1;
+}
+.workitem_gantt .gantt_day_head {
+    position: sticky;
+    top: var(--gantt-month-h);
+    background: #fff;
+    text-align: center;
+    font-size: 11px;
+    color: #57606a;
+    border-bottom: 1px solid #bbb;
+    z-index: 1;
+}
+/* Weekday-holiday highlight in the Chart.js palette red (ADR-205 amendment):
+   the column carries the buffer bar's diagonal stripe texture, in red; the
+   header stays a solid tint so the day number reads. */
+.workitem_gantt .gantt_day_head.gantt_nonworking { background: rgba(255, 99, 132, 0.22); color: #b23a52; }
+.workitem_gantt .gantt_day_head.gantt_friday { background: rgb(225, 241, 250); }
+.workitem_gantt .gantt_nonworking_col {
+    background: repeating-linear-gradient(45deg,
+        rgba(255, 99, 132, 0.20), rgba(255, 99, 132, 0.20) 5px,
+        rgba(255, 99, 132, 0.07) 5px, rgba(255, 99, 132, 0.07) 10px);
+}
+.workitem_gantt .gantt_friday_col { background: rgb(225, 241, 250); }
+.workitem_gantt .gantt_bar,
+.workitem_gantt .gantt_track_bar {
+    font-size: 11px;
+    line-height: 1.5;
+    margin: 1px;
+    padding: 1px 5px;
+    border-radius: 3px;
+    overflow: hidden;
+    white-space: nowrap;
+    text-overflow: ellipsis;
+    color: #fff;
+    cursor: default;
+}
+.workitem_gantt .gantt_todo { background: #9aa5b1; }
+.workitem_gantt .gantt_inprogress { background: #ffffdd; color: #333; box-shadow: inset 0 0 0 1px #bbb; }
+.workitem_gantt .gantt_done { background: #cfc; color: #57606a; box-shadow: inset 0 0 0 1px #e1e4e8; }
+.workitem_gantt .gantt_blocked { box-shadow: inset 0 0 0 1px #bbb; }
+.workitem_gantt .gantt_critical { outline: 1px solid #9a6700; outline-offset: -1px; } /* buffer-bar amber (dark) */
+.workitem_gantt .gantt_release_band {
+    text-align: center;
+    font-size: 11px;
+    font-weight: 600;
+    color: #57606a;
+    background: #eef1f4;
+    border-bottom: 1px solid #e1e4e8;
+    border-left: 1px solid #d0d7de;
+    padding: 2px 4px;
+    white-space: nowrap;
+    overflow: hidden;
+    text-overflow: ellipsis;
+}
+.workitem_gantt .gantt_buffer { color: #9a6700; }
+.critical_chain { margin-bottom: 16px; }
+.critical_chain h2 { font-size: 1.1em; margin-bottom: 6px; }
+.critical_chain .cc_group { margin: 8px 0; }
+.critical_chain .cc_group h3 { font-size: 0.95em; margin: 4px 0; }
+.critical_chain table.cc_chain { border-collapse: collapse; margin: 4px 0; }
+.critical_chain table.cc_chain th,
+.critical_chain table.cc_chain td { border: 1px solid #e1e4e8; padding: 2px 8px; text-align: left; font-size: 12px; }
+.critical_chain .cc_buffer,
+.critical_chain .cc_consumed,
+.critical_chain .cc_projected,
+.critical_chain .cc_finish { margin: 2px 0; font-size: 12px; }
+.critical_chain .cc_consumed { color: #57606a; }
+.critical_chain .cc_finish { font-weight: 600; }
+.critical_chain .cc_unestimated { color: #9a6700; font-style: italic; font-size: 12px; }
+.critical_chain .cc_group_body { display: flex; flex-wrap: wrap; gap: 24px; align-items: flex-start; }
+.critical_chain .cc_plan { flex: 1 1 320px; }
+.critical_chain .cc_fever { flex: 1 1 360px; max-width: 480px; height: 320px; position: relative; }
+.critical_chain .cc_fever .fever_canvas { width: 100%; height: 100%; }
+.workitem_gantt .gantt_buffer_bar {
+    font-size: 11px;
+    line-height: 1.5;
+    margin: 1px;
+    padding: 1px 5px;
+    border-radius: 3px;
+    text-align: center;
+    overflow: hidden;
+    white-space: nowrap;
+    text-overflow: ellipsis;
+    color: #9a6700;
+    background: repeating-linear-gradient(45deg, #ffe9b3, #ffe9b3 5px, #fff3d4 5px, #fff3d4 10px);
+    box-shadow: inset 0 0 0 1px #e0c068;
+    cursor: default;
+}
+.workitem_gantt .gantt_today { border-left: 2px solid #d33; z-index: 5; pointer-events: none; }
+/* Plan-vs-actual tracking lanes (ADR-213): hidden until the toolbar toggle adds
+   show-actuals; a hidden lane's grid tracks collapse to zero height. */
+.workitem_gantt .gantt_tracking_lane { display: none; }
+.workitem_gantt.show-actuals .gantt_tracking_lane { display: block; }
+.workitem_gantt .gantt_owner_tracking { font-weight: 400; font-style: italic; color: #57606a; }
+.workitem_gantt .gantt_track_committed { background: #b0b6bd; }
+.workitem_gantt .gantt_track_logged { background: #36a2eb; }
+.gantt_container .gantt_toolbar {
+    display: flex;
+    justify-content: flex-end;
+    gap: 6px;
+    padding: 4px 0;
+}
+.gantt_container .gantt_actuals_toggle {
+    font-size: 12px;
+    padding: 3px 10px;
+    border: 1px solid #d0d7de;
+    border-radius: 4px;
+    background: #f6f8fa;
+    cursor: pointer;
+}
+.gantt_container .gantt_actuals_toggle:hover { background: #eef1f4; }
 table.controlled:not(.odd-even) tbody tr:nth-child(odd) { background-color:#f6f7f8; }
 table.controlled:not(.odd-even) tbody tr:nth-child(even) { background-color: #fff; }
 table.controlled:not(.odd-even) tbody tr:nth-child(odd):hover,
@@ -345,4 +505,16 @@ img{
     padding: 5px;
     text-align:center;
     background:#fff;
-}
+}/* Risk register RPN threshold bands (ADR-217): acceptable / ALARP caution / unacceptable */
+td.item_rpn {
+    text-align: center;
+}
+td.rpn_acceptable {
+    background-color: #d5f5e3;
+}
+td.rpn_caution {
+    background-color: #fdebd0;
+}
+td.rpn_unacceptable {
+    background-color: #fadbd8;
+}

data/lib/almirah/templates/scripts/main.js

@@ -25,7 +25,9 @@ function openNav() {
         document.getElementById("searchInput").style.display = "block";
       }
     }else{
-      if (document.title.includes("Traceability Matrix:")){
+      var navPane = document.getElementById('nav_pane');
+      var hasNav = navPane && navPane.innerHTML.trim() !== "";
+      if (document.title.includes("Traceability Matrix:") || !hasNav){
         document.getElementById('document_tree_menu_item').style.display = "none";
       } else {
         document.getElementById('document_tree_menu_item').style.display = "block";

data/lib/almirah.rb

@@ -54,8 +54,7 @@ class CLI < Thor
 end
 
 class Almirah
-  attr_accessor :project
-  attr_accessor :project_utility
+  attr_accessor :project, :project_utility
 
   def initialize(project_folder)
     config = ProjectConfiguration.new project_folder

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: Almirah
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.4
 platform: ruby
 authors:
 - Oleksandr Ivanov
@@ -73,18 +73,27 @@ files:
 - lib/almirah/doc_items/markdown_list.rb
 - lib/almirah/doc_items/markdown_table.rb
 - lib/almirah/doc_items/paragraph.rb
+- lib/almirah/doc_items/scope_table.rb
 - lib/almirah/doc_items/source_code_paragraph.rb
 - lib/almirah/doc_items/text_line.rb
 - lib/almirah/doc_items/todo_block.rb
+- lib/almirah/doc_items/work_item.rb
 - lib/almirah/doc_parser.rb
 - lib/almirah/doc_types/base_document.rb
 - lib/almirah/doc_types/coverage.rb
+- lib/almirah/doc_types/critical_chain_page.rb
 - lib/almirah/doc_types/decision.rb
+- lib/almirah/doc_types/decision_grouping.rb
 - lib/almirah/doc_types/decisions_overview.rb
 - lib/almirah/doc_types/implementation.rb
 - lib/almirah/doc_types/index.rb
 - lib/almirah/doc_types/persistent_document.rb
+- lib/almirah/doc_types/planning_dates.rb
 - lib/almirah/doc_types/protocol.rb
+- lib/almirah/doc_types/risk_record.rb
+- lib/almirah/doc_types/risk_registry_page.rb
+- lib/almirah/doc_types/risks_overview.rb
+- lib/almirah/doc_types/rpn_rendering.rb
 - lib/almirah/doc_types/source_file.rb
 - lib/almirah/doc_types/specification.rb
 - lib/almirah/doc_types/traceability.rb
@@ -94,8 +103,12 @@ files:
 - lib/almirah/link_registry.rb
 - lib/almirah/navigation_pane.rb
 - lib/almirah/project.rb
+- lib/almirah/project/critical_chain.rb
 - lib/almirah/project/doc_linker.rb
+- lib/almirah/project/fever_chart.rb
 - lib/almirah/project/project_data.rb
+- lib/almirah/project/work_item_scheduler.rb
+- lib/almirah/project/working_calendar.rb
 - lib/almirah/project_configuration.rb
 - lib/almirah/project_template.rb
 - lib/almirah/project_utility.rb