Almirah 0.1.9 → 0.2.1

data/lib/almirah/templates/page.html

@@ -5,368 +5,15 @@
 <title>{{DOCUMENT_TITLE}}</title>
 <!-- CSS -->
 <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
-<style>
-    body {
-        font-family: Verdana, sans-serif;
-        font-size: 12px;
-        color: #333;
-        margin: 0;
-        padding: 0;
-        min-width: 900px;
-    }
-    #main {
-        flex-grow: 2;
-        display: flex;
-        flex-direction: row;
-    }
-    #content {
-        flex-grow: 1;
-        background-color: #fff;
-        margin-top: 30px;
-        padding: 10px 16px 10px 16px;
-        overflow-x: auto;
-    }
-    #content h1, h2, h3, h4, h5, h6 {
-        color: #555;
-        font-family: "Trebuchet MS", Verdana, sans-serif;
-        padding: 2px 10px 1px 0px;
-        margin: 0 0 10px 0;
-    }
-    h1 {
-        font-size: 2em;
-    }
-    h2 {
-        font-size: 1.8em;
-    }
-    h3 {
-        font-size: 1.5em;
-    }
-    h4 {
-        font-size: 1.2em;
-        border: none;
-        font-weight: bold;
-    }
-    h5 {
-        font-size: 1em;
-    }
-    h6 {
-        font-size: 1em; color: #8e8e8e;
-    }
-    a.heading_anchor { 
-        display: none;
-        margin-left: 6px;
-        text-decoration: none;
-    }
-    table.markdown_table{
-        border: 1px solid #bbb;
-        border-collapse: collapse;
-        padding: 4px;
-        margin-bottom: 4px;        
-        overflow: hidden;
-    }
-    table.markdown_table th{
-        border: 1px solid #bbb; 
-        padding: 4px;
-        display: table-cell;
-        vertical-align: inherit;
-        background-color:#EEEEEE;
-    }
-    table.markdown_table td{
-        border: 1px solid #bbb; 
-        padding: 4px;
-        display: table-cell;
-        vertical-align: inherit;
-    }
-    table.controlled{
-        border: 1px solid #e4e4e4;
-        border-collapse: collapse;
-        width: 100%;
-        margin-bottom: 4px;
-        border-spacing: 0px;
-        border-radius: 3px;
-        overflow: hidden;
-    }
-    table.controlled th {
-        background-color:#e1f1fa;
-        padding: 4px;
-        white-space:nowrap;
-        font-weight:normal;
-        border: 1px solid #bbb;
-    }
-    table.controlled td {
-        padding: 4px;
-        text-align:center;
-        vertical-align:middle;
-        padding-right:10px;
-        border: 1px solid #bbb;
-    }
-    table.controlled tr:first-child th {
-        border-top: 0;
-    }
-    table.controlled tr:last-child td {
-        border-bottom: 0;
-    }
-    table.controlled tr td:first-child,
-    table.controlled tr th:first-child {
-        border-left: 0;
-    }
-    table.controlled tr td:last-child,
-    table.controlled tr th:last-child {
-        border-right: 0;
-    }
-    table.controlled td.item_id {
-        width: 3%;
-        text-align: center;
-    }
-    table.controlled td.item_text{
-        text-align: left;
-    }
-    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,
-    table.controlled:not(.odd-even) tbody tr:nth-child(even):hover { background-color:#ffffdd; }
-    a, a:link, a:visited {
-        color: #169;
-        text-decoration: none;
-        display: inline-block;
-    }
-    a:active {
-        color: #555;
-        background-color:#deb887;
-        text-decoration: none;
-        display: inline-block;
-    }
-    div.blockquote {
-        display: block;
-        background:#f9f9fb;
-        border-left: 3px double #bbb;
-        font-style: italic;
-        padding: 4px 1em 4px 4px;
-        margin-top: 4px;
-        margin-bottom: 4px;
-    }
-    code {
-        display: block;
-        background:#ffffee;
-        border-left: 3px double #bbb;
-        font-family: Consolas, Menlo, "Liberation Mono", Courier, monospace;
-        padding: 4px 1em 4px 4px;
-        margin-top: 4px;
-        margin-bottom: 4px;
-    }
-    div.todoblock {
-        display: block;
-        background:#fcc;
-        border-left: 3px double #bbb;
-        font-style: italic;
-        padding: 4px 1em 4px 4px;
-        margin-top: 4px;
-        margin-bottom: 4px;
-    }
-    img:hover{
-        transition: 0.3s;
-    }
-    img{
-        opacity: 0.9;
-        cursor: pointer;
-    }
-    #modal_image_id{
-        cursor: default;
-    } 
-    #closed_nav_pane{
-        padding: 0px;
-        background: #169;
-        border: 0px;
-        position: fixed;
-        width: 5px;
-        height: 100%;       /* 100% Full-height */
-        visibility: visible;
-        cursor: pointer;
-    }
-    #closed_nav_pane:hover{
-        width: 10px;
-    }
-    #nav_pane{
-        flex-shrink: 0;
-        padding: 32px 8px 8px 8px;
-        background: #EEEEEE;
-        border: 1px solid #ddd;
-        position: fixed;
-        height: 100%;       /* 100% Full-height */
-        visibility: hidden;
-        z-index: 1;
-        overflow-y: auto;
-        cursor: pointer;
-    }
-    @media screen and (min-width: 0px) and (max-width: 1089px) {#nav_pane{width: 22%;}}
-    @media screen and (min-width: 1090px) and (max-width: 1279px) {#nav_pane{width: 240px;}}
-    @media screen and (min-width: 1280px) and (max-width: 1599px) {#nav_pane{width: 280px;}}
-    @media screen and (min-width: 1600px) and (max-width: 1919px) {#nav_pane{width: 320px;}}
-    @media screen and (min-width: 1920px) and (max-width: 2559px) {#nav_pane{width: 360px;}}
-    @media screen and (min-width: 2560px) {#nav_pane{width: 380px;}}
-
-    #top_nav{
-        background-color: #169;
-        overflow: hidden;
-        position: fixed;
-        width: 100%;    
-        z-index: 2;
-    }
-    #top_nav a {
-        float: left;
-        color: white;
-        text-align: center;
-        padding: 4px 6px;
-        text-decoration: none;
-        font-size: 1.5em;
-        font-family: "Trebuchet MS", Verdana, sans-serif;
-    }
-    #top_nav a.split {
-        float: right;
-        color: white;
-        text-align: center;
-        padding: 4px 6px;
-        text-decoration: none;
-        font-size: 1.5em;
-        font-family: "Trebuchet MS", Verdana, sans-serif;
-    }
-    #top_nav a:hover {
-        background-color: black;
-        color:  white;
-    }
-    #top_nav a.active {
-        background-color: #169;
-        color: white;
-    }
-    .modal {
-        display: none; /* Hidden by default */
-        position: fixed; /* Stay in place */
-        z-index: 1; /* Sit on top */
-        padding-top: 100px; /* Location of the box */
-        left: 0;
-        top: 0;
-        width: 100%; /* Full width */
-        height: 100%; /* Full height */
-        overflow: auto; /* Enable scroll if needed */
-        background-color: rgb(0,0,0); /* Fallback color */
-        background-color: rgba(0,0,0,0.9); /* Black w/ opacity */
-    }
-    .modal_image {
-        margin: auto;
-        display: block;
-        width: 97%;
-        /*max-width: 700px;*/
-    }
-    #modal_image_caption {
-        margin: auto;
-        display: block;
-        width: 80%;
-        max-width: 700px;
-        text-align: center;
-        color: #ccc;
-        padding: 10px 0;
-        height: 150px;
-    }
-    .modal_image, #modal_image_caption {  
-        animation-name: zoom;
-        animation-duration: 0.6s;
-    }
-    @keyframes zoom {
-        from {transform: scale(0.1)} 
-        to {transform: scale(1)}
-    }
-    .modal_close_btn {
-        position: absolute;
-        top: 15px;
-        right: 35px;
-        color: #f1f1f1;
-        font-size: 30px;
-        font-weight: bold;
-        transition: 0.3s;
-    }
-    .modal_close_btn:hover,
-    .modal_close_btn:focus {
-        color: #bbb;
-        text-decoration: none;
-        cursor: pointer;
-    }
-    #footer {
-        clear: both;
-        border-top: 1px solid #bbb;
-        font-size: 0.9em;
-        color: #aaa;
-        padding: 5px;
-        text-align:center;
-        background:#fff;
-    }
-</style>
-<script>
-function openNav() {
-  document.getElementById("nav_pane").style.visibility = "visible";
-}
-
-function closeNav() {
-  document.getElementById("nav_pane").style.visibility = "hidden";
-}
-
-window.onload = (event) => {
-  for (var i = 0, n = document.images.length; i < n; i++) 
-  {
-    elem = document.images[i];
-    if (elem.width > 640)
-    {
-        elem.style.width = "640px";
-    }
-  }
-  // Scroll a bit to make navigated anchor visible
-  //setTimeout(function() {
-  //      window.scrollBy({ 
-  //      top: -40,
-  //      behavior: "smooth"
-  //      });
-  //  }, 200);
-};
-
-function downlink_OnClick(clicked){
-    clicked.style.display = 'none';
-    id_parts = clicked.id.split("_");
-    required_id = "DLS_" + id_parts[1];
-    document.getElementById(required_id).style.display = 'block';
-}
-
-function navigate_to_home(){
-    if (document.title != "Document Index")
-    {
-        window.location.href = "./../../index.html";
-    }else{
-        window.location.href = "./index.html";
-    }
-}
-
-// Modal window for image zoom
-function image_OnClick(clicked){
-
-    var modal = document.getElementById('image_modal_div');
-    var modalImg = document.getElementById("modal_image_id");
-    var captionText = document.getElementById("modal_image_caption");
-
-    modal.style.display = "block";
-    modalImg.src = clicked.src;
-    captionText.innerHTML = clicked.alt;
-}
-
-function modal_close_OnClick(clicked){
-    var modal = document.getElementById('image_modal_div');
-    modal.style.display = "none";
-}
-
-</script>
+{{STYLES_AND_SCRIPTS}}
 </head>
 <body>
     <div id="top_nav">
         <a href="javascript:void(0)" onclick="navigate_to_home()"><span><i class="fa fa-home" aria-hidden="true"></i></span>&nbsp;Home</a>
+        <input type="text" id="searchInput" placeholder="Search.." style="display: none;">
         <a class="split">{{DOCUMENT_TITLE}}</a>
     </div>
+    <div id="search_dropdown" class="search-results-content" style="display: none;"></div>
     <div id="main">
         <div id="closed_nav_pane" href="javascript:void(0)" onclick="openNav()">
         </div>
@@ -378,7 +25,10 @@ function modal_close_OnClick(clicked){
         </div><!-- content -->
     </div><!-- main -->
     <div id="footer">
-        Powered by <a target="_blank" rel="noopener" href="https://www.almirah.site/">Almirah Framework (0.1.8)</a>
+        Powered by <a target="_blank" rel="noopener" href="https://www.almirah.site/">
+            Almirah Framework 
+            {{GEM_VERSION}}
+        </a>
     </div><!-- footer -->
     <!-- The modal window for image zoom -->
     <div id="image_modal_div" class="modal">

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

@@ -0,0 +1,61 @@
+function openNav() {
+    document.getElementById("nav_pane").style.visibility = "visible";
+  }
+  
+  function closeNav() {
+    document.getElementById("nav_pane").style.visibility = "hidden";
+  }
+  
+  window.onload = (event) => {
+    for (var i = 0, n = document.images.length; i < n; i++) 
+    {
+      elem = document.images[i];
+      if (elem.width > 640)
+      {
+          elem.style.width = "640px";
+      }
+    }
+    if ((document.title == "Document Index") && (document.URL.includes('http'))){
+      document.getElementById("searchInput").style.display = "block";
+    }
+    // Scroll a bit to make navigated anchor visible
+    //setTimeout(function() {
+    //      window.scrollBy({ 
+    //      top: -40,
+    //      behavior: "smooth"
+    //      });
+    //  }, 200);
+  };
+  
+  function downlink_OnClick(clicked){
+      clicked.style.display = 'none';
+      id_parts = clicked.id.split("_");
+      required_id = "DLS_" + id_parts[1];
+      document.getElementById(required_id).style.display = 'block';
+  }
+  
+  function navigate_to_home(){
+      if (document.title != "Document Index")
+      {
+          window.location.href = "./../../index.html";
+      }else{
+          window.location.href = "./index.html";
+      }
+  }
+  
+  // Modal window for image zoom
+  function image_OnClick(clicked){
+  
+      var modal = document.getElementById('image_modal_div');
+      var modalImg = document.getElementById("modal_image_id");
+      var captionText = document.getElementById("modal_image_caption");
+  
+      modal.style.display = "block";
+      modalImg.src = clicked.src;
+      captionText.innerHTML = clicked.alt;
+  }
+  
+  function modal_close_OnClick(clicked){
+      var modal = document.getElementById('image_modal_div');
+      modal.style.display = "none";
+  }

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

@@ -0,0 +1,136 @@
+// Do search only on the Index Page
+import { create, search, insert } from 'https://unpkg.com/@orama/orama@latest/dist/index.js'
+
+// Create DB
+const db = await create({
+    schema: {
+    doc_title: 'string',
+    doc_color: 'string',
+    text: 'string',
+    heading_url: 'string',
+    heading_text: 'string'
+    }
+})
+// Load JSON DB
+const response = await fetch("/data/specifications_db.json");
+const data_rows = await response.json();
+let i = 0;
+while (i < data_rows.length) {
+    await insert(db, {
+        document: data_rows[i]["document"],
+        doc_color: data_rows[i]["doc_color"],
+        text: data_rows[i]["text"],
+        heading_url: data_rows[i]["heading_url"],
+        heading_text: data_rows[i]["heading_text"]
+    })
+    i++;
+}
+
+// Main db search function 
+async function search_onKeyUp(){
+
+    const search_input_text = document.getElementById("searchInput").value;
+    // Close drop down when empty
+    if ( search_input_text == ''){
+        document.getElementById("search_dropdown").style.display = "none";
+    }else{
+        document.getElementById("search_dropdown").style.display = "block";
+    }
+
+    const searchResult = await search(db, {
+        term: search_input_text,
+        properties: ['text', 'heading_text'],
+        exact: true,
+        });
+    if (searchResult == null){
+        return;
+    }
+    //console.log(searchResult.hits.map((hit) => hit.document));
+
+    // clear previous search
+    const myNode = document.getElementById("search_dropdown");
+    while (myNode.firstChild) {
+        myNode.removeChild(myNode.lastChild);
+    }
+
+    if (searchResult.count == 0){
+
+        const node = document.createElement("div");
+        node.classList.add('search-item');
+        const textnode = document.createTextNode("There are no matches found");
+        node.appendChild(textnode);
+        myNode.appendChild(node);
+
+    }else{
+
+        searchResult.hits.forEach ((value, index, array) =>{
+            const doc_title = value.document["document"]
+            const doc_color = value.document["doc_color"]
+            const heading_url = value.document["heading_url"]
+            const heading_text = value.document["heading_text"]
+            const search_text = value.document["text"]
+
+            const node_div = document.createElement("div");
+            node_div.classList.add('search-item');
+
+            const table = document.createElement("table");
+            table.classList.add('search-result-table');
+            node_div.appendChild(table);
+
+            const tbody = document.createElement("tbody");
+            table.appendChild(tbody);
+
+            // Row 1
+            let row = document.createElement("tr");
+            let cell = document.createElement("td");
+            let i = document.createElement("i");
+                i.classList.add("fa","fa-file-text-o");
+                i.style.backgroundColor = "#" + doc_color;
+                cell.appendChild(i);
+            let textnode = document.createTextNode("\xa0" + doc_title);
+            cell.appendChild(textnode);
+            row.appendChild(cell)
+            cell = document.createElement("td");
+            
+            const a = document.createElement('a'); 
+            const link = document.createTextNode(heading_text)
+            a.appendChild(link);
+            a.title = heading_text;
+            a.href = heading_url;
+            document.body.appendChild(a); 
+
+            cell.appendChild(a);
+            row.appendChild(cell)
+            tbody.appendChild(row)
+
+            // Row 2
+            row = document.createElement("tr");
+            cell = document.createElement("td");
+            cell.colSpan = 2;
+            let show_text_parts = search_text.split(" ", 10).join(" ");
+            textnode = document.createTextNode(show_text_parts);
+            cell.appendChild(textnode)
+            row.appendChild(cell)
+            tbody.appendChild(row)
+
+            myNode.appendChild(node_div);
+        })
+    }
+}
+
+
+document.getElementById("searchInput").addEventListener("keyup", search_onKeyUp);
+
+// Show when focus in
+document.getElementById("searchInput").addEventListener("focusin", (event) => {
+    // clear previous search
+    const element = document.getElementById("search_dropdown");
+    while (element.firstChild) {
+        element.removeChild(element.lastChild);
+    }
+    // show
+    const rect = document.getElementById("searchInput").getBoundingClientRect();
+    element.style.left = rect.left +'px';
+    element.style.top = rect.top + rect.height + 4 +'px';
+    element.style.display = "block";
+});

data/lib/almirah.rb

@@ -1,5 +1,6 @@
 require "thor"
 require_relative "almirah/project"
+require_relative "almirah/project_configuration"
 
 class CLI < Thor
   option :results
@@ -25,7 +26,8 @@ class Almirah
   attr_accessor :project
 
   def initialize(project_folder)
-    @project = Project.new project_folder
+    config = ProjectConfiguration.new project_folder
+    @project = Project.new config
   end
 
   def getGemRoot()

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: Almirah
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.2.1
 platform: ruby
 authors:
 - Oleksandr Ivanov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-19 00:00:00.000000000 Z
+date: 2024-06-09 00:00:00.000000000 Z
 dependencies: []
 description: The software part of the Almirah framework
 email: oleksandr.ivanov.development@gmail.com
@@ -34,9 +34,11 @@ files:
 - lib/almirah/doc_items/paragraph.rb
 - lib/almirah/doc_items/text_line.rb
 - lib/almirah/doc_items/todo_block.rb
+- lib/almirah/doc_parser.rb
 - lib/almirah/doc_types/base_document.rb
 - lib/almirah/doc_types/coverage.rb
 - lib/almirah/doc_types/index.rb
+- lib/almirah/doc_types/persistent_document.rb
 - lib/almirah/doc_types/protocol.rb
 - lib/almirah/doc_types/specification.rb
 - lib/almirah/doc_types/traceability.rb
@@ -44,7 +46,13 @@ files:
 - lib/almirah/dom/document.rb
 - lib/almirah/navigation_pane.rb
 - lib/almirah/project.rb
+- lib/almirah/project_configuration.rb
+- lib/almirah/search/specifications_db.rb
+- lib/almirah/templates/css/main.css
+- lib/almirah/templates/css/search.css
 - lib/almirah/templates/page.html
+- lib/almirah/templates/scripts/main.js
+- lib/almirah/templates/scripts/orama_search.js
 homepage: http://almirah.site
 licenses:
 - MIT