Almirah 0.2.2 → 0.2.4

data/lib/almirah/project.rb

@@ -1,324 +1,306 @@
+# frozen_string_literal: true
+
 require 'fileutils'
-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
-
-    attr_accessor :specifications
-    attr_accessor :protocols
-    attr_accessor :traceability_matrices
-    attr_accessor :coverage_matrices
-    attr_accessor :specifications_dictionary
-    attr_accessor :index
-    attr_accessor :project
-    attr_accessor :configuration
-
-    def initialize(configuration)
-        @configuration = configuration
-        @specifications = Array.new
-        @protocols = Array.new
-        @traceability_matrices = Array.new
-        @coverage_matrices = Array.new
-        @specifications_dictionary = Hash.new
-        @index = nil
-        @project = self
-        FileUtils.remove_dir(@configuration.project_root_directory + "/build", true)
-        copy_resources
+require_relative 'doc_fabric'
+require_relative 'navigation_pane'
+require_relative 'doc_types/traceability'
+require_relative 'doc_types/index'
+require_relative 'search/specifications_db'
+
+class Project # rubocop:disable Metrics/ClassLength,Style/Documentation
+  attr_accessor :specifications, :protocols, :traceability_matrices, :coverage_matrices, :specifications_dictionary,
+                :index, :project, :configuration
+
+  def initialize(configuration)
+    @configuration = configuration
+    @specifications = []
+    @protocols = []
+    @traceability_matrices = []
+    @coverage_matrices = []
+    @specifications_dictionary = {}
+    @covered_specifications_dictionary = {}
+    @index = nil
+    @project = self
+    FileUtils.remove_dir("#{@configuration.project_root_directory}/build", true)
+    copy_resources
+  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 # rubocop:disable Metrics/MethodLength
+    parse_all_specifications
+    parse_all_protocols
+    link_all_specifications
+    link_all_protocols
+    check_wrong_specification_referenced
+    create_index
+    render_all_specifications(@specifications)
+    render_all_specifications(@traceability_matrices)
+    render_all_specifications(@coverage_matrices)
+    render_all_protocols
+    render_index
+    create_search_data
+  end
+
+  def specifications_and_results(test_run) # rubocop:disable Metrics/MethodLength
+    parse_all_specifications
+    parse_test_run test_run
+    link_all_specifications
+    link_all_protocols
+    check_wrong_specification_referenced
+    create_index
+    render_all_specifications(@specifications)
+    render_all_specifications(@traceability_matrices)
+    render_all_specifications(@coverage_matrices)
+    render_all_protocols
+    render_index
+    create_search_data
+  end
+
+  def transform(file_extension)
+    transform_all_specifications file_extension
+  end
+
+  def transform_all_specifications(_file_extension)
+    path = @configuration.project_root_directory
+
+    # find all specifications
+    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)
+      f_name = File.basename(f, File.extname(f)).downcase + '._md'
+      FileUtils.copy_file(f, "#{f_directory}/#{f_name}")
+      # transform the original one
+      # but do nothing for now - TODO
     end
+  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 )
+  def parse_all_specifications
+    path = @configuration.project_root_directory
+    # do a lasy pass first to get the list of documents id
+    Dir.glob("#{path}/specifications/**/*.md").each do |f|
+      DocFabric.add_lazy_doc_id(f)
     end
-
-    def specifications_and_protocols
-
-        parse_all_specifications
-        parse_all_protocols
-        link_all_specifications
-        link_all_protocols
-        check_wrong_specification_referenced
-        create_index
-        render_all_specifications(@specifications)
-        render_all_specifications(@traceability_matrices)
-        render_all_specifications(@coverage_matrices)
-        render_all_protocols
-        render_index
-        create_search_data
+    # parse documents in the second pass
+    Dir.glob("#{path}/specifications/**/*.md").each do |f| # rubocop:disable Style/CombinableLoops
+      doc = DocFabric.create_specification(f)
+      @specifications.append(doc)
+      @specifications_dictionary[doc.id.to_s.downcase] = doc
     end
+  end
 
-    def specifications_and_results( test_run )
-
-        parse_all_specifications
-        parse_test_run test_run
-        link_all_specifications
-        link_all_protocols
-        check_wrong_specification_referenced
-        create_index
-        render_all_specifications(@specifications)
-        render_all_specifications(@traceability_matrices)
-        render_all_specifications(@coverage_matrices)
-        render_all_protocols
-        render_index
-        create_search_data
+  def parse_all_protocols
+    path = @configuration.project_root_directory
+    Dir.glob("#{path}/tests/protocols/**/*.md").each do |f|
+      doc = DocFabric.create_protocol(f)
+      @protocols.append(doc)
     end
+  end
 
-    def transform( file_extension )
-        transform_all_specifications file_extension 
+  def parse_test_run(test_run)
+    path = @configuration.project_root_directory
+    Dir.glob("#{path}/tests/runs/#{test_run}/**/*.md").each do |f|
+      doc = DocFabric.create_protocol(f)
+      @protocols.append(doc)
     end
+  end
 
-    def transform_all_specifications( file_extension )
-
-        path = @configuration.project_root_directory
-
-        # find all specifications
-        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)
-            f_name = File.basename(f, File.extname(f)).downcase + "._md"
-            FileUtils.copy_file( f, "#{f_directory}/#{f_name}")
-            # transform the original one
-            # but do nothing for now - TODO
-        end
+  def link_all_specifications # rubocop:disable Metrics/MethodLength
+    comb_list = @specifications.combination(2)
+    comb_list.each do |c|
+      link_two_specifications(c[0], c[1])
+      # puts "Link: #{c[0].id} - #{c[1].id}"
     end
-
-    def parse_all_specifications
-        path = @configuration.project_root_directory
-        # do a lasy pass first to get the list of documents id
-        Dir.glob( "#{path}/specifications/**/*.md" ).each do |f|
-            DocFabric.add_lazy_doc_id(f)
-        end
-        # parse documents in the second pass
-        Dir.glob( "#{path}/specifications/**/*.md" ).each do |f|
-            doc = DocFabric.create_specification(f)
-            @specifications.append(doc)
-            @specifications_dictionary[doc.id.to_s.downcase] = doc
-        end
+    # separatelly create design inputs treceability
+    @configuration.get_design_inputs.each do |i|
+      next unless @specifications_dictionary.key? i.to_s.downcase
+
+      document = @specifications_dictionary[i.to_s.downcase]
+      if document
+        doc = DocFabric.create_traceability_document(document, nil)
+        @traceability_matrices.append doc
+      end
     end
-
-    def parse_all_protocols
-        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)
+  end
+
+  def link_all_protocols # rubocop:disable Metrics/MethodLength
+    @protocols.each do |p|
+      @specifications.each do |s|
+        if p.up_link_docs.key?(s.id.to_s)
+          link_protocol_to_spec(p, s)
+          @covered_specifications_dictionary[s.id.to_s] = s
         end
+      end
     end
-
-    def parse_test_run( test_run )
-        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)
-        end
+    # create coverage documents
+    @covered_specifications_dictionary.each do |_key, value|
+      doc = DocFabric.create_coverage_matrix(value)
+      @coverage_matrices.append doc
     end
+  end
 
-    def link_all_specifications
-        combList = @specifications.combination(2)
-        combList.each do |c|
-            link_two_specifications(c[0], c[1])
-            # puts "Link: #{c[0].id} - #{c[1].id}"
-        end
-        # separatelly create design inputs treceability
-        @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
-    end
+  def check_wrong_specification_referenced # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
+    available_specification_ids = {}
 
-    def link_all_protocols
-        @protocols.each do |p|
-            @specifications.each do |s|
-                if p.up_link_docs.has_key?(s.id.to_s)
-                    link_protocol_to_spec(p,s)
-                end
-            end
-        end
+    @specifications.each do |s|
+      available_specification_ids[s.id.to_s.downcase] = s
     end
 
-    def check_wrong_specification_referenced
+    @specifications.each do |s| # rubocop:disable Style/CombinableLoops
+      s.up_link_docs.each do |key, _value|
+        next if available_specification_ids.key?(key)
 
-        available_specification_ids = Hash.new
+        # now key points to the doc_id that does not exist
+        wrong_doc_id = key
+        # find the item that reference to it
+        s.controlled_items.each do |item|
+          next if item.up_link_ids.nil?
 
-        @specifications.each do |s|
-            available_specification_ids[ s.id.to_s.downcase ] = s
-        end
+          item.up_link_ids.each do |up_link_id|
+            next unless tmp = /^([a-zA-Z]+)-\d+/.match(up_link_id) # SRS
 
-        @specifications.each do |s|
-            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
-                    # find the item that reference to it
-                    s.controlled_items.each do |item|
-                        unless item.up_link_ids.nil?
-                            item.up_link_ids.each do |up_link_id|
-                                if tmp = /^([a-zA-Z]+)[-]\d+/.match(up_link_id) # SRS
-                                    if tmp[1].downcase == wrong_doc_id
-                                        # we got it finally!
-                                        s.wrong_links_hash[ up_link_id.to_s ] = item
-                                    end
-                                end
-                            end
-                        end
-                    end
-                end
+            if tmp[1].downcase == wrong_doc_id
+              # we got it finally!
+              s.wrong_links_hash[up_link_id.to_s] = item
             end
+          end
         end
+      end
     end
-
-    def link_two_specifications(doc_A, doc_B)
-
-        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_docs.has_key?(doc_B.id.to_s)
-            top_document = doc_B
-            bottom_document = doc_A
-        else
-            return # no links
-        end
-        #puts "Link: #{doc_A.id} - #{doc_B.id}" 
-        bottom_document.controlled_items.each do |item|
-
-            if item.up_link_ids
-                item.up_link_ids.each do |up_lnk|
-
-                    if top_document.dictionary.has_key?(up_lnk.to_s)
-
-                        topItem = top_document.dictionary[up_lnk.to_s]
-                        
-                        unless topItem.down_links
-                            topItem.down_links = Array.new
-                            top_document.items_with_downlinks_number += 1   # for statistics
-                        end
-                        topItem.down_links.append(item)
-                    else
-                        # check if there is a non existing link with the right doc_id
-                        if tmp = /^([a-zA-Z]+)[-]\d+/.match(up_lnk) # SRS
-                            if tmp[1].downcase == top_document.id.downcase
-                                bottom_document.wrong_links_hash[ up_lnk ] = item
-                            end
-                        end
-                    end
-                end
-            end
+  end
+
+  def link_two_specifications(doc_a, doc_b) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
+    if doc_b.up_link_docs.key?(doc_a.id.to_s)
+      top_document = doc_a
+      bottom_document = doc_b
+    elsif doc_a.up_link_docs.key?(doc_b.id.to_s)
+      top_document = doc_b
+      bottom_document = doc_a
+    else
+      return # no links
+    end
+    # puts "Link: #{doc_a.id} - #{doc_b.id}"
+    bottom_document.controlled_items.each do |item|
+      next unless item.up_link_ids
+
+      item.up_link_ids.each do |up_lnk|
+        if top_document.dictionary.key?(up_lnk.to_s)
+
+          top_item = top_document.dictionary[up_lnk.to_s]
+
+          unless top_item.down_links
+            top_item.down_links = []
+            top_document.items_with_downlinks_number += 1 # for statistics
+          end
+          top_item.down_links.append(item)
+        elsif tmp = /^([a-zA-Z]+)-\d+/.match(up_lnk)
+          # check if there is a non existing link with the right doc_id
+          if tmp[1].downcase == top_document.id.downcase
+            bottom_document.wrong_links_hash[up_lnk] = item
+          end # SRS
         end
-        # create treceability document
-        trx = Traceability.new top_document, bottom_document, false
-        @traceability_matrices.append trx
+      end
     end
-
-    def link_protocol_to_spec(protocol, specification)
-
-        top_document = specification
-        bottom_document = protocol
-
-        bottom_document.controlled_items.each do |item|
-
-            if top_document.dictionary.has_key?(item.up_link.to_s)
-
-                topItem = top_document.dictionary[item.up_link.to_s]
-                
-                unless topItem.coverage_links
-                    topItem.coverage_links = Array.new
-                    top_document.items_with_coverage_number += 1    # for statistics
-                end
-                topItem.coverage_links.append(item)
-            end
+    # create treceability document
+    doc = DocFabric.create_traceability_document(top_document, bottom_document)
+    @traceability_matrices.append doc
+  end
+
+  def link_protocol_to_spec(protocol, specification) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
+    top_document = specification
+    bottom_document = protocol
+
+    bottom_document.controlled_items.each do |item|
+      next unless item.up_link_ids
+
+      item.up_link_ids.each do |up_lnk|
+        if top_document.dictionary.key?(up_lnk.to_s)
+
+          top_item = top_document.dictionary[up_lnk.to_s]
+
+          unless top_item.coverage_links
+            top_item.coverage_links = []
+            top_document.items_with_coverage_number += 1 # for statistics
+          end
+          top_item.coverage_links.append(item)
+        elsif tmp = /^([a-zA-Z]+)-\d+/.match(up_lnk)
+          # check if there is a non existing link with the right doc_id
+          if tmp[1].downcase == top_document.id.downcase
+            bottom_document.wrong_links_hash[up_lnk] = item
+          end # SRS
         end
-        # create coverage document
-        trx = Coverage.new top_document
-        @coverage_matrices.append trx
+      end
     end
+  end
 
-    def create_index
-        @index = Index.new( @project )
-    end
+  def create_index
+    @index = Index.new(@project)
+  end
 
-    def render_all_specifications(spec_list)     
+  def render_all_specifications(spec_list) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+    path = @configuration.project_root_directory
 
-        path = @configuration.project_root_directory
+    FileUtils.mkdir_p("#{path}/build/specifications")
 
-        FileUtils.mkdir_p(path + "/build/specifications")
-    
-        spec_list.each do |doc|
+    spec_list.each do |doc|
+      doc.to_console
 
-            doc.to_console
+      img_src_dir = "#{path}/specifications/#{doc.id}/img"
+      img_dst_dir = "#{path}/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)
+      FileUtils.mkdir_p(img_dst_dir)
 
-            if File.directory?(img_src_dir)
-                FileUtils.copy_entry( img_src_dir, img_dst_dir )
-            end
+      FileUtils.copy_entry(img_src_dir, img_dst_dir) if File.directory?(img_src_dir)
 
-            # create a sidebar first
-            nav_pane = NavigationPane.new(doc) 
-            doc.to_html( nav_pane, "#{path}/build/specifications/" )
-        end
+      nav_pane = NavigationPane.new(doc)
+      doc.to_html(nav_pane, "#{path}/build/specifications/")
     end
+  end
 
-    def render_all_protocols
-        
-        # create a sidebar first
-        # nav_pane = NavigationPane.new(@specifications)        
+  def render_all_protocols
+    path = @configuration.project_root_directory
 
-        path = @configuration.project_root_directory
+    FileUtils.mkdir_p("#{path}/build/tests/protocols")
 
-        FileUtils.mkdir_p(path + "/build/tests/protocols")
-    
-        @protocols.each do |doc|
+    @protocols.each do |doc|
+      img_src_dir = "#{path}/tests/protocols/#{doc.id}/img"
+      img_dst_dir = "#{path}/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)
+      FileUtils.mkdir_p(img_dst_dir)
 
-            if File.directory?(img_src_dir)
-                FileUtils.copy_entry( img_src_dir, img_dst_dir )
-            end
+      FileUtils.copy_entry(img_src_dir, img_dst_dir) if File.directory?(img_src_dir)
 
-            doc.to_html( nil, "#{path}/build/tests/protocols/" )
-        end
+      nav_pane = NavigationPane.new(doc)
+      doc.to_html(nav_pane, "#{path}/build/tests/protocols/")
     end
+  end
 
-    def render_index
-
-        path = @configuration.project_root_directory
+  def render_index
+    path = @configuration.project_root_directory
 
-        doc = @index
-        doc.to_console
+    doc = @index
+    doc.to_console
 
-        doc.to_html("#{path}/build/")
-    end
+    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
+  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/search/specifications_db.rb

@@ -23,7 +23,9 @@ class SpecificationsDb
                     }
                     @data.append e                    
                 elsif i.instance_of? MarkdownList
-                    e = add_markdown_list_item_to_db( @data, i, i)    
+                    e = add_markdown_list_item_to_db( @data, i, i)
+                elsif i.instance_of? MarkdownTable
+                    add_markdown_table_item_to_db( @data, i, i)    
                 end
             end
         end
@@ -56,6 +58,21 @@ class SpecificationsDb
         return e
     end
 
+    def add_markdown_table_item_to_db(data, item_for_reference, item_to_process)
+        e = nil
+        table_text = ""
+        item_to_process.rows.each do |row|
+            table_text += "| " + row.join(" | ") + " |"
+        end
+        e = {   "document" => 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(), \
+                "heading_text" => item_for_reference.parent_heading.get_section_info()
+            }
+        data << e
+    end
+
     def save(path)
         json = JSON.generate(@data)
 

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

@@ -223,13 +223,16 @@ img{
     font-family: "Trebuchet MS", Verdana, sans-serif;
 }
 #top_nav a:hover {
-    background-color: black;
-    color:  white;
+    background-color: #169;
+    color:  #eee;
 }
 #top_nav a.active {
     background-color: #169;
     color: white;
 }
+#top_nav a:focus {
+    text-decoration: underline;
+}
 #searchInput{
     float: left;
     margin: 4px 6px;

data/lib/almirah/templates/page.html

@@ -9,7 +9,9 @@
 </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>
+        <a id="home_menu_item" href="javascript:void(0)" onclick="navigate_to_home()"><span><i class="fa fa-home" aria-hidden="true"></i></span>&nbsp;Home</a>
+        <a id="index_menu_item" href="javascript:void(0)" onclick="navigate_to_home()" style="display: none;"><span><i class="fa fa-info" aria-hidden="true"></i></span>&nbsp;Index</a>
+        <a id="document_tree_menu_item" href="javascript:void(0)" onclick="openNav()" style="display: none;" title="Navigation Pane"><span><i class="fa fa-folder-open-o" aria-hidden="true"></i></span></a>
         <input type="text" id="searchInput" placeholder="Search.." style="display: none;">
         <a class="split">{{DOCUMENT_TITLE}}</a>
     </div>
@@ -17,7 +19,7 @@
     <div id="main">
         <div id="closed_nav_pane" href="javascript:void(0)" onclick="openNav()">
         </div>
-        <div id="nav_pane" onclick="closeNav()">
+        <div id="nav_pane">
             {{NAV_PANE}}
         </div>
         <div id="content" href="javascript:void(0)" onclick="closeNav()">