Almirah 0.3.1 → 0.4.1

data/lib/almirah/project_template.rb

@@ -14,6 +14,7 @@ class ProjectTemplate # rubocop:disable Style/Documentation
     create_architecture
     create_tests
     create_test_runs
+    create_decisions
   end
 
   def create_requirements
@@ -265,7 +266,7 @@ class ProjectTemplate # rubocop:disable Style/Documentation
   end
 
   def run_test_003
-    path = File.join(@project_root, 'tests/runs/010/tq-002')
+    path = File.join(@project_root, 'tests/runs/010/tq-001')
     FileUtils.mkdir_p path
 
     file_content = <<~EOS
@@ -295,4 +296,91 @@ class ProjectTemplate # rubocop:disable Style/Documentation
     file.puts file_content
     file.close
   end
+
+  def create_decisions
+    path = File.join(@project_root, 'decisions')
+    FileUtils.mkdir_p path
+
+    file_content = <<~EOS
+      ---
+      title: "ADR-001: Start Project Decision"
+      ---
+
+      # Status
+
+      |  | Date | Status |
+      |:---:|---|---|
+      | * | #{Time.now.strftime('%d-%m-%Y')} | Proposed |
+
+      # Context
+
+      This is an example decision record. It demonstrates how Almirah captures a
+      decision and links it to the requirements it affects.
+
+      # Decision
+
+      Describe the decision here. The leading "*" in the Status table marks the
+      current state of the record.
+
+      # Scope
+
+      | Item | Status | Start Date | Target Date | Description |
+      |---|---|---|---|---|
+      | Requirements | To Do | | | |
+      | Code | To Do | | | |
+      | Tests | To Do | | | |
+
+      # Out of Scope
+
+      The ADR contains the most important sections with no detailed content.
+
+      # Consequences
+
+      ## Positive
+
+      An ADR example will clearly show the approach Almirah framework use for any software changes.
+
+      ## Negative
+
+      The format of this ADR can be different that is required for the real project.
+
+      ## Neutral
+
+      TBD
+
+      # Alternatives Considered
+
+      - **Add an empty `decisions/` directory only.** Rejected: an empty folder neither teaches the format nor causes the overview page to render, so it would not exercise the feature.
+
+      # Affected Documents
+
+      Table below shows a requirement whose text this decision creates or updates.
+
+      | # | Proposed Text | Req-ID |
+      |---|---|---|
+      | 1 | This is a first requirement (controlled paragraph with ID equal to "REQ-001"). | >[REQ-001] |
+
+      # Software Versions
+
+      | Software Version Category | Software Version ID |
+      |---|---|
+      | Latest Released Version | n/a |
+      | Issue Found in Version | n/a |
+      | Target Release Version | 0.0.1 |
+
+      # References
+
+      TBD
+
+      # Review Evidences
+
+      TBD
+
+    EOS
+
+    path = File.join(path, 'adr-001-start-project-decision.md')
+    file = File.open(path, 'w')
+    file.puts file_content
+    file.close
+  end
 end

data/lib/almirah/relative_url.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+# Computes the relative URL between two generated pages, each given as a path
+# relative to the build root (e.g. "decisions/release 0.4.1/adr-185.html").
+# Produces forward-slash separators with spaces percent-encoded. Shared by all
+# internal cross-document links (ADR-186).
+module RelativeUrl
+  module_function
+
+  def between(from_output_rel, to_output_rel, fragment: nil)
+    from_dir = Pathname.new(from_output_rel).dirname
+    rel = Pathname.new(to_output_rel).relative_path_from(from_dir).to_s
+    url = rel.split('/').map { |segment| encode_segment(segment) }.join('/')
+    fragment && !fragment.empty? ? "#{url}##{fragment}" : url
+  end
+
+  def encode_segment(segment)
+    segment.gsub(' ', '%20')
+  end
+end

data/lib/almirah/search/specifications_db.rb

@@ -16,7 +16,7 @@ class SpecificationsDb
     @specifications.each do |sp|
       sp.items.each do |i|
         if (i.instance_of? Paragraph) or (i.instance_of? ControlledParagraph)
-          e = { 'document' => i.parent_doc.title, \
+          e = { 'doc_title' => i.parent_doc.title, \
                 'doc_color' => i.parent_doc.color, \
                 'text' => i.text, \
                 'heading_url' => i.parent_heading.get_url, \
@@ -36,7 +36,7 @@ class SpecificationsDb
     item_to_process.rows.each do |r|
       if r.is_a?(MarkdownList)
         f_text = r.text
-        e = {   'document' => item_for_reference.parent_doc.title, \
+        e = {   'doc_title' => item_for_reference.parent_doc.title, \
                 'doc_color' => item_for_reference.parent_doc.color, \
                 'text' => f_text, \
                 'heading_url' => item_for_reference.parent_heading.get_url, \
@@ -45,7 +45,7 @@ class SpecificationsDb
         add_markdown_list_item_to_db(data, item_for_reference, r)
       else
         f_text = r
-        e = {   'document' => item_for_reference.parent_doc.title, \
+        e = {   'doc_title' => item_for_reference.parent_doc.title, \
                 'doc_color' => item_for_reference.parent_doc.color, \
                 'text' => f_text, \
                 'heading_url' => item_for_reference.parent_heading.get_url, \
@@ -61,7 +61,7 @@ class SpecificationsDb
     item_to_process.rows.each do |row|
       table_text += "| #{row.join(' | ')} |"
     end
-    e = {   'document' => item_for_reference.parent_doc.title, \
+    e = {   'doc_title' => item_for_reference.parent_doc.title, \
             'doc_color' => item_for_reference.parent_doc.color, \
             'text' => table_text, \
             'heading_url' => item_for_reference.parent_heading.get_url, \

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

@@ -64,11 +64,14 @@ table.markdown_table th{
     background-color:#EEEEEE;
 }
 table.markdown_table td{
-    border: 1px solid #bbb; 
+    border: 1px solid #bbb;
     padding: 4px;
     display: table-cell;
     vertical-align: inherit;
 }
+table.markdown_table tr.current_status td {
+    background-color: #ffffee;
+}
 table.controlled{
     border: 1px solid #e4e4e4;
     border-collapse: collapse;
@@ -110,9 +113,32 @@ table.controlled td.item_id {
     width: 3%;
     text-align: center;
 }
+table.controlled td.item_type {
+    width: 5%;
+    text-align: center;
+    font-weight: normal;
+}
+table.controlled td.item_status {
+    width: 5%;
+    text-align: center;
+    white-space: nowrap;
+}
 table.controlled td.item_text{
     text-align: left;
 }
+.decisions_overview_charts {
+    display: grid;
+    grid-template-columns: repeat(3, 1fr);
+    gap: 16px;
+    margin-bottom: 16px;
+}
+.decisions_overview_charts .chart_cell {
+    min-height: 240px;
+}
+.decisions_overview_charts .chart_cell canvas {
+    max-width: 100%;
+    max-height: 300px;
+}
 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,
@@ -128,6 +154,11 @@ a:active {
     text-decoration: none;
     display: inline-block;
 }
+a.broken_link, a.broken_link:link, a.broken_link:visited, span.broken_link {
+    color: #c00;
+    text-decoration: underline wavy #c00;
+    cursor: help;
+}
 div.blockquote {
     display: block;
     background:#f9f9fb;
@@ -146,6 +177,15 @@ code {
     margin-top: 4px;
     margin-bottom: 4px;
 }
+code.inline {
+    display: inline;
+    background:#f4f4f4;
+    border: 1px solid #ddd;
+    border-left: 1px solid #ddd;
+    border-radius: 3px;
+    padding: 0 4px;
+    margin: 0;
+}
 div.todoblock {
     display: block;
     background:#fcc;

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

@@ -50,7 +50,13 @@ function openNav() {
     clicked.style.display = 'none';
     id_parts = clicked.id.split("_");
     required_id = "COVS_" + id_parts[1];
-    document.getElementById(required_id).style.display = 'block';  
+    document.getElementById(required_id).style.display = 'block';
+  }
+  function decisionLink_OnClick(clicked){
+    clicked.style.display = 'none';
+    id_parts = clicked.id.split("_");
+    required_id = "DRS_" + id_parts[1];
+    document.getElementById(required_id).style.display = 'block';
   }
   function upLink_OnClick(clicked){
     clicked.style.display = 'none';

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

@@ -1,5 +1,5 @@
 // Do search only on the Index Page
-import { create, search, insert } from 'https://unpkg.com/@orama/orama@latest/dist/index.js'
+import { create, search, insert } from 'https://unpkg.com/@orama/orama@3.1.18/dist/browser/index.js'
 
 // Create DB
 const db = await create({
@@ -19,7 +19,7 @@ const data_rows = await response.json();
 let i = 0;
 while (i < data_rows.length) {
     await insert(db, {
-        document: data_rows[i]["document"],
+        doc_title: data_rows[i]["doc_title"],
         doc_color: data_rows[i]["doc_color"],
         text: data_rows[i]["text"],
         heading_url: data_rows[i]["heading_url"],
@@ -66,7 +66,7 @@ async function search_onKeyUp(){
     }else{
 
         searchResult.hits.forEach ((value, index, array) =>{
-            const doc_title = value.document["document"]
+            const doc_title = value.document["doc_title"]
             const doc_color = value.document["doc_color"]
             const heading_url = value.document["heading_url"]
             const heading_text = value.document["heading_text"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: Almirah
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.1
 platform: ruby
 authors:
 - Oleksandr Ivanov
@@ -58,6 +58,7 @@ extra_rdoc_files: []
 files:
 - bin/almirah
 - lib/almirah.rb
+- lib/almirah/console_reporter.rb
 - lib/almirah/doc_fabric.rb
 - lib/almirah/doc_items/blockquote.rb
 - lib/almirah/doc_items/code_block.rb
@@ -78,6 +79,8 @@ files:
 - lib/almirah/doc_parser.rb
 - lib/almirah/doc_types/base_document.rb
 - lib/almirah/doc_types/coverage.rb
+- lib/almirah/doc_types/decision.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
@@ -87,6 +90,7 @@ files:
 - lib/almirah/doc_types/traceability.rb
 - lib/almirah/dom/doc_section.rb
 - lib/almirah/dom/document.rb
+- lib/almirah/link_registry.rb
 - lib/almirah/navigation_pane.rb
 - lib/almirah/project.rb
 - lib/almirah/project/doc_linker.rb
@@ -94,6 +98,7 @@ files:
 - lib/almirah/project_configuration.rb
 - lib/almirah/project_template.rb
 - lib/almirah/project_utility.rb
+- lib/almirah/relative_url.rb
 - lib/almirah/search/specifications_db.rb
 - lib/almirah/source_file_parser.rb
 - lib/almirah/templates/css/main.css