Almirah 0.1.9 → 0.2.1

data/lib/almirah/project.rb

@@ -1,10 +1,10 @@
 require 'fileutils'
-require 'yaml'
 require_relative "doc_fabric"
 require_relative "navigation_pane"
 require_relative "doc_types/traceability"
 require_relative "doc_types/coverage"
 require_relative "doc_types/index"
+require_relative "search/specifications_db"
 
 class Project
 
@@ -12,14 +12,13 @@ class Project
     attr_accessor :protocols
     attr_accessor :traceability_matrices
     attr_accessor :coverage_matrices
-    attr_accessor :project_root_directory
     attr_accessor :specifications_dictionary
     attr_accessor :index
     attr_accessor :project
-    attr_accessor :project_configuration
+    attr_accessor :configuration
 
-    def initialize(path)
-        @project_root_directory = path
+    def initialize(configuration)
+        @configuration = configuration
         @specifications = Array.new
         @protocols = Array.new
         @traceability_matrices = Array.new
@@ -27,19 +26,22 @@ class Project
         @specifications_dictionary = Hash.new
         @index = nil
         @project = self
-        @project_configuration = {}
-        load_project_file()
-        FileUtils.remove_dir(@project_root_directory + "/build", true)
+        FileUtils.remove_dir(@configuration.project_root_directory + "/build", true)
+        copy_resources
     end
 
-    def load_project_file
-        begin
-            @project_configuration = YAML.load_file(@project_root_directory + '/project.yml') 
-        rescue Psych::SyntaxError => e
-            puts "YAML syntax error: #{e.message}"
-          rescue Errno::ENOENT
-            puts "Project file not found: project.yml"
-        end
+    def copy_resources
+        # scripts
+        gem_root = File.expand_path './../..', File.dirname(__FILE__)
+        src_folder =  gem_root + "/lib/almirah/templates/scripts"
+        dst_folder = @configuration.project_root_directory + "/build/scripts"
+        FileUtils.mkdir_p(dst_folder)
+        FileUtils.copy_entry( src_folder, dst_folder )
+        # css
+        src_folder =  gem_root + "/lib/almirah/templates/css"
+        dst_folder = @configuration.project_root_directory + "/build/css"
+        FileUtils.mkdir_p(dst_folder)
+        FileUtils.copy_entry( src_folder, dst_folder )
     end
 
     def specifications_and_protocols
@@ -55,6 +57,7 @@ class Project
         render_all_specifications(@coverage_matrices)
         render_all_protocols
         render_index
+        create_search_data
     end
 
     def specifications_and_results( test_run )
@@ -70,6 +73,7 @@ class Project
         render_all_specifications(@coverage_matrices)
         render_all_protocols
         render_index
+        create_search_data
     end
 
     def transform( file_extension )
@@ -78,10 +82,10 @@ class Project
 
     def transform_all_specifications( file_extension )
 
-        path = @project_root_directory
+        path = @configuration.project_root_directory
 
         # find all specifications
-        Dir.glob( "#{@project_root_directory}/specifications/**/*.md" ).each do |f|
+        Dir.glob( "#{path}/specifications/**/*.md" ).each do |f|
             puts f
             # make a copy with another extention to preserve the content
             f_directory = File.dirname(f)
@@ -93,12 +97,13 @@ class Project
     end
 
     def parse_all_specifications
+        path = @configuration.project_root_directory
         # do a lasy pass first to get the list of documents id
-        Dir.glob( "#{@project_root_directory}/specifications/**/*.md" ).each do |f|
+        Dir.glob( "#{path}/specifications/**/*.md" ).each do |f|
             DocFabric.add_lazy_doc_id(f)
         end
         # parse documents in the second pass
-        Dir.glob( "#{@project_root_directory}/specifications/**/*.md" ).each do |f|
+        Dir.glob( "#{path}/specifications/**/*.md" ).each do |f|
             doc = DocFabric.create_specification(f)
             @specifications.append(doc)
             @specifications_dictionary[doc.id.to_s.downcase] = doc
@@ -106,7 +111,8 @@ class Project
     end
 
     def parse_all_protocols
-        Dir.glob( "#{@project_root_directory}/tests/protocols/**/*.md" ).each do |f|
+        path = @configuration.project_root_directory
+        Dir.glob( "#{path}/tests/protocols/**/*.md" ).each do |f|
             puts "Prot: " + f
             doc = DocFabric.create_protocol(f)
             @protocols.append(doc)
@@ -114,7 +120,8 @@ class Project
     end
 
     def parse_test_run( test_run )
-        Dir.glob( "#{@project_root_directory}/tests/runs/#{test_run}/**/*.md" ).each do |f|
+        path = @configuration.project_root_directory
+        Dir.glob( "#{path}/tests/runs/#{test_run}/**/*.md" ).each do |f|
             puts "Run: " + f
             doc = DocFabric.create_protocol(f)
             @protocols.append(doc)
@@ -128,14 +135,12 @@ class Project
             # puts "Link: #{c[0].id} - #{c[1].id}"
         end
         # separatelly create design inputs treceability
-        if (@project_configuration.key? 'specifications') and (@project_configuration['specifications'].key? 'input')
-            @project_configuration['specifications']['input'].each do |i|
-                if @specifications_dictionary.has_key? i.to_s.downcase
-                    document = @specifications_dictionary[i.to_s.downcase]
-                    if document
-                        trx = Traceability.new document, nil, true
-                        @traceability_matrices.append trx
-                    end
+        @configuration.get_design_inputs.each do |i|
+            if @specifications_dictionary.has_key? i.to_s.downcase
+                document = @specifications_dictionary[i.to_s.downcase]
+                if document
+                    trx = Traceability.new document, nil, true
+                    @traceability_matrices.append trx
                 end
             end
         end
@@ -144,7 +149,7 @@ class Project
     def link_all_protocols
         @protocols.each do |p|
             @specifications.each do |s|
-                if p.up_link_doc_id.has_key?(s.id.to_s)
+                if p.up_link_docs.has_key?(s.id.to_s)
                     link_protocol_to_spec(p,s)
                 end
             end
@@ -160,7 +165,7 @@ class Project
         end
 
         @specifications.each do |s|
-            s.up_link_doc_id.each do |key, value|
+            s.up_link_docs.each do |key, value|
                 unless available_specification_ids.has_key?(key)
                     # now key points to the doc_id that does not exist
                     wrong_doc_id = key
@@ -184,10 +189,10 @@ class Project
 
     def link_two_specifications(doc_A, doc_B)
 
-        if doc_B.up_link_doc_id.has_key?(doc_A.id.to_s)
+        if doc_B.up_link_docs.has_key?(doc_A.id.to_s)
             top_document = doc_A
             bottom_document = doc_B
-        elsif doc_A.up_link_doc_id.has_key?(doc_B.id.to_s)
+        elsif doc_A.up_link_docs.has_key?(doc_B.id.to_s)
             top_document = doc_B
             bottom_document = doc_A
         else
@@ -253,16 +258,16 @@ class Project
 
     def render_all_specifications(spec_list)     
 
-        pass = @project_root_directory
+        path = @configuration.project_root_directory
 
-        FileUtils.mkdir_p(pass + "/build/specifications")
+        FileUtils.mkdir_p(path + "/build/specifications")
     
         spec_list.each do |doc|
 
             doc.to_console
 
-            img_src_dir = pass + "/specifications/" + doc.id + "/img"
-            img_dst_dir = pass + "/build/specifications/" + doc.id + "/img"
+            img_src_dir = path + "/specifications/" + doc.id + "/img"
+            img_dst_dir = path + "/build/specifications/" + doc.id + "/img"
      
             FileUtils.mkdir_p(img_dst_dir)
 
@@ -272,7 +277,7 @@ class Project
 
             # create a sidebar first
             nav_pane = NavigationPane.new(doc) 
-            doc.to_html( nav_pane, "#{pass}/build/specifications/" )
+            doc.to_html( nav_pane, "#{path}/build/specifications/" )
         end
     end
 
@@ -281,15 +286,14 @@ class Project
         # create a sidebar first
         # nav_pane = NavigationPane.new(@specifications)        
 
-        pass = @project_root_directory
+        path = @configuration.project_root_directory
 
-        # FileUtils.remove_dir(pass + "/build/tests", true)
-        FileUtils.mkdir_p(pass + "/build/tests/protocols")
+        FileUtils.mkdir_p(path + "/build/tests/protocols")
     
         @protocols.each do |doc|
 
-            img_src_dir = pass + "/tests/protocols/" + doc.id + "/img"
-            img_dst_dir = pass + "/build/tests/protocols/" + doc.id + "/img"
+            img_src_dir = path + "/tests/protocols/" + doc.id + "/img"
+            img_dst_dir = path + "/build/tests/protocols/" + doc.id + "/img"
      
             FileUtils.mkdir_p(img_dst_dir)
 
@@ -297,17 +301,24 @@ class Project
                 FileUtils.copy_entry( img_src_dir, img_dst_dir )
             end
 
-            doc.to_html( nil, "#{pass}/build/tests/protocols/" )
+            doc.to_html( nil, "#{path}/build/tests/protocols/" )
         end
     end
 
-    def render_index    
+    def render_index
 
-        path = @project_root_directory
+        path = @configuration.project_root_directory
 
         doc = @index
         doc.to_console
 
         doc.to_html("#{path}/build/")
     end
+
+    def create_search_data
+        db = SpecificationsDb.new @specifications 
+        data_path = @configuration.project_root_directory + "/build/data"
+        FileUtils.mkdir_p(data_path)
+        db.save(data_path)
+    end
 end

data/lib/almirah/project_configuration.rb

@@ -0,0 +1,42 @@
+require 'yaml'
+
+class ProjectConfiguration
+
+    attr_accessor :project_root_directory
+    attr_accessor :parameters
+
+    def initialize(path)
+        @project_root_directory = path
+        @parameters = {}
+        load_project_file()
+    end
+
+    def load_project_file
+        begin
+            @parameters = YAML.load_file(@project_root_directory + '/project.yml') 
+        rescue Psych::SyntaxError => e
+            puts "YAML syntax error: #{e.message}"
+          rescue Errno::ENOENT
+            puts "Project file not found: project.yml"
+        end
+    end
+
+    def get_design_inputs
+        if (@parameters.key? 'specifications') and (@parameters['specifications'].key? 'input')
+            return @parameters['specifications']['input']
+        end
+        return []
+    end
+
+    def is_spec_db_shall_be_created
+        if (@parameters.key? 'output')
+            @parameters['output'].each do |p|
+               if p == 'specifications_db'
+                return true
+               end
+            end
+        end
+        return false
+    end
+
+end

data/lib/almirah/search/specifications_db.rb

@@ -0,0 +1,66 @@
+require 'json'
+# Prepare JSON database file for further indexing by other tools
+class SpecificationsDb
+
+    attr_accessor :specifications
+    attr_accessor :data
+
+    def initialize(spec_list)
+        @specifications = spec_list
+        @data = []
+        create_data
+    end
+
+    def create_data
+        @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, \
+                        "doc_color" => i.parent_doc.color, \
+                        "text" => i.text, \
+                        "heading_url" => i.parent_heading.get_url(), \
+                        "heading_text" => i.parent_heading.get_section_info()
+                    }
+                    @data.append e                    
+                elsif i.instance_of? MarkdownList
+                    e = add_markdown_list_item_to_db( @data, i, i)    
+                end
+            end
+        end
+    end
+
+    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)
+                f_text = r.text
+                e = {   "document" => 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(), \
+                        "heading_text" => item_for_reference.parent_heading.get_section_info()
+                    }
+                data << e
+                add_markdown_list_item_to_db(data, item_for_reference, r)
+            else
+                f_text = r
+                e = {   "document" => 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(), \
+                        "heading_text" => item_for_reference.parent_heading.get_section_info()
+                    }
+                data << e
+            end
+        end
+        return e
+    end
+
+    def save(path)
+        json = JSON.generate(@data)
+
+        file = File.open( path + "/specifications_db.json", "w" )
+        file.puts json
+        file.close
+    end
+end

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

@@ -0,0 +1,298 @@
+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;
+}
+#searchInput{
+    float: left;
+    margin: 4px 6px;
+    text-decoration: none;
+}
+.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;
+}

data/lib/almirah/templates/css/search.css

@@ -0,0 +1,40 @@
+/* Dropdown Content (Hidden by Default) */
+.search-results-content {
+    display: none;
+    position: absolute;
+    background-color: #f6f6f6;
+    min-width: 600px;
+    border: 1px solid #ddd;
+    z-index: 2;
+}
+  
+/* Links inside the dropdown 
+.search-results-content a, a:link, a:visited {
+    color: #169;
+    text-decoration: none;
+    display: inline-block;
+}*/
+
+div.search-item {
+    padding: 2px;
+    text-align:left;
+    vertical-align:middle;
+    padding-right:10px;
+    border: 1px solid #bbb;
+}
+table.search-result-table{
+    border: 0;
+    margin: 0;
+    border-collapse: collapse;
+    width: 100%;
+    margin-bottom: 0px;
+    border-spacing: 0px;
+    overflow: hidden;
+}
+table.search-result-table td {
+    padding: 4px;
+    width: 50%;
+    text-align:left;
+    vertical-align:middle;
+    padding-right:10px;
+}