Almirah 0.1.9 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c88fa681954a14b92b114aec73d996c30678749d13cfb049a25b216b83f726cb
-  data.tar.gz: 94c51c141e22015250c776e547994462f7ff878967938c0fd43b4bdff698fa84
+  metadata.gz: 239bc6813a8ad20ae8cf8a99d5a36968acf8679965c123ace4f981082f08813f
+  data.tar.gz: bfe821957ccd6adebf87f21052fe1b3cb8bdffe3761c68be8dfb9bd619fc9605
 SHA512:
-  metadata.gz: 0c793599f7119665dc724c4fe66102dab3168e3d9ef34a1efb77f928f521a58689945111a22acc5a1d358a85a4575700b8f8675a39f561cc8a54f8c214adba92
-  data.tar.gz: 3e95fd1f182d88233f244d59fd7ed36ca1924f1cb1e0594065e35511da739e58aa77b17d5a8b974499378ef430fb41eb6770b067f28e402ceb076828fdf186cb
+  metadata.gz: e633985b182351caa581c6dc8e0133b78a98bd56ade57f8ab152d1bf8442e161775d4c7a161a8421c32e272edab1d9798fe5d5157ba558c6b267d5a503e25fa2
+  data.tar.gz: 72cfef9d334a4522b9fa3dea553ace439299a62dae4ba79dba7db5b284164f33d41280ecea602945068e01ce183ceac4591e408026400ec2bbbbc31ec3648c64

data/lib/almirah/doc_fabric.rb

@@ -188,6 +188,7 @@ class DocFabric
 
           item = Image.new(img_text, img_path)
           item.parent_doc = doc
+          item.parent_heading = doc.headings[-1]
 
           doc.items.append(item)
 
@@ -224,6 +225,7 @@ class DocFabric
             item = MarkdownList.new(true)
             item.addRow(s)
             item.parent_doc = doc
+            item.parent_heading = doc.headings[-1]
             temp_md_list = item
           end
 
@@ -242,6 +244,7 @@ class DocFabric
               # separator out of table scope consider it just as a regular paragraph
               item = Paragraph.new(s)
               item.parent_doc = doc
+              item.parent_heading = doc.headings[-1]
               doc.items.append(item)
             end
 
@@ -276,6 +279,7 @@ class DocFabric
 
           item = Blockquote.new(res[1])
           item.parent_doc = doc
+          item.parent_heading = doc.headings[-1]
           doc.items.append(item)
 
         elsif res = /^```(\w*)/.match(s) # check if code block
@@ -317,6 +321,7 @@ class DocFabric
 
           item = TodoBlock.new(text)
           item.parent_doc = doc
+          item.parent_heading = doc.headings[-1]
           doc.items.append(item)
           doc.todo_blocks.append(item)
 
@@ -339,6 +344,7 @@ class DocFabric
           else
             item = Paragraph.new(s)
             item.parent_doc = doc
+            item.parent_heading = doc.headings[-1]
             doc.items.append(item)
           end
         end

data/lib/almirah/doc_items/doc_item.rb

@@ -8,6 +8,10 @@ class DocItem < TextLine
     @parent_heading = nil
 
     @@htmlTableRenderInProgress = false
+
+    def get_url
+        ''
+    end
 end
 
 

data/lib/almirah/doc_items/heading.rb

@@ -76,6 +76,17 @@ class Heading < Paragraph
         return s
     end
 
+    def get_html_link
+        if (@parent_doc.instance_of? Specification)
+            heading_text = get_section_info()
+            s = "<a href= class=\"external\">#{heading_text}</a>"
+        end
+    end
+
+    def get_url
+        "./specifications/#{parent_doc.id}/#{parent_doc.id}.html\##{@anchor_id}"
+    end
+
     def self.reset_global_section_number
         @@global_section_number = ""
     end

data/lib/almirah/doc_types/base_document.rb

@@ -44,6 +44,27 @@ class BaseDocument
                 end
             elsif s.include?('{{DOCUMENT_TITLE}}')
                 file.puts s.gsub! '{{DOCUMENT_TITLE}}', @title
+            elsif s.include?('{{STYLES_AND_SCRIPTS}}')
+                if @id == 'index'
+                    file.puts '<script type="module" src="./scripts/orama_search.js"></script>'
+                    file.puts '<link rel="stylesheet" href="./css/search.css">'
+                    file.puts '<link rel="stylesheet" href="./css/main.css">'
+                    file.puts '<script src="./scripts/main.js"></script>'
+                elsif self.instance_of? Specification
+                    file.puts '<link rel="stylesheet" href="../../css/main.css">'
+                    file.puts '<script src="../../scripts/main.js"></script>'
+                elsif self.instance_of? Traceability
+                    file.puts '<link rel="stylesheet" href="../../css/main.css">'
+                    file.puts '<script src="../../scripts/main.js"></script>'
+                elsif self.instance_of? Coverage
+                    file.puts '<link rel="stylesheet" href="../../css/main.css">'
+                    file.puts '<script src="../../scripts/main.js"></script>'
+                elsif self.instance_of? Protocol
+                    file.puts '<link rel="stylesheet" href="../../../css/main.css">'
+                    file.puts '<script src="../../../scripts/main.js"></script>'
+                end
+            elsif  s.include?('{{GEM_VERSION}}')
+                file.puts "(" + Gem.loaded_specs['Almirah'].version.version + ")"
             else
                 file.puts s
             end

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
@@ -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,37 @@
+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
+                end
+            end
+        end
+    end
+
+    def save(path)
+        json = JSON.generate(@data)
+
+        file = File.open( path + "/specifications_db.json", "w" )
+        file.puts json
+        file.close
+    end
+end