Almirah 0.1.6 → 0.1.8

data/lib/almirah/doc_items/text_line.rb

@@ -1,139 +1,270 @@
-class TextLine
+class TextLineToken
+    attr_accessor :value
+    def initialize()
+        @value = ""
+    end
+end
 
-    @@lazy_doc_id_dict = Hash.new
+class ItalicToken < TextLineToken
+    attr_accessor :value
+    def initialize()
+        @value = "*"
+    end
+end
 
-    def self.add_lazy_doc_id(id)
-        doc_id = id.to_s.downcase
-        @@lazy_doc_id_dict[doc_id] = doc_id
+class BoldToken < TextLineToken
+    attr_accessor :value
+    def initialize()
+        @value = "**"
     end
+end
 
-    def format_string(str)
-        state = 'default'
-        prev_state = 'default'
-        result = ''
-        stack = ''
-        prev_c = ''
-        link_text = ''
-        link_url = ''
-        str.each_char do |c|
-            if c == '*'
-                if state == 'default'
-                    prev_state, state = change_state(c, state, 'first_asterisk_detected')
-
-                elsif state == 'first_asterisk_detected'
-                    prev_state, state = change_state(c, state, 'second_asterisk_detected')
-                
-                elsif state == 'second_asterisk_detected'
-                    prev_state, state = change_state(c, state, 'third_asterisk_detected')
-                
-                elsif state == 'second_asterisk_detected'
-                    prev_state, state = change_state(c, state, 'third_asterisk_detected')
-
-                elsif state == 'italic_started'
-                    prev_state, state = change_state(c, state, 'default')
-                    result += italic(stack)
-
-                elsif state == 'bold_started'
-                    prev_state, state = change_state(c, state, 'first_asterisk_after_bold_detected')
-
-                elsif state == 'first_asterisk_after_bold_detected'
-                    prev_state, state = change_state(c, state, 'default')
-                    result += bold(stack)
-
-                elsif state == 'bold_and_italic_started'
-                    prev_state, state = change_state(c, state, 'first_asterisk_after_bold_and_italic_detected')
-
-                elsif state == 'first_asterisk_after_bold_and_italic_detected'
-                    prev_state, state = change_state(c, state, 'second_asterisk_after_bold_and_italic_detected')
-
-                elsif state == 'second_asterisk_after_bold_and_italic_detected'
-                    prev_state, state = change_state(c, state, 'default')
-                    result += bold_and_italic(stack)
+class BoldAndItalicToken < TextLineToken
+    attr_accessor :value
+    def initialize()
+        @value = "***"
+    end
+end
 
-                else
-                end
-            elsif c == '['
-                if state == 'default'
-                    prev_state, state = change_state(c, state, 'square_bracket_left_detected')
-                else
-                end
-            elsif c == ']'
-                if state == 'square_bracket_left_detected'
-                    prev_state, state = change_state(c, state, 'default')
-                    result += '[]'
+class ParentheseLeft < TextLineToken
+    attr_accessor :value
+    def initialize()
+        @value = "("
+    end
+end
 
-                elsif state == 'link_text_started'
-                    prev_state, state = change_state(c, state, 'square_bracket_right_detected')
-                    link_text = stack
+class ParentheseRight < TextLineToken
+    attr_accessor :value
+    def initialize()
+        @value = ")"
+    end
+end
 
-                else
-                end
-            elsif c == '('
-                if state == 'square_bracket_right_detected'
-                    prev_state, state = change_state(c, state, 'brace_left_detected')
-                else
-                    result += c
-                end
-            elsif c == ')'
-                if state == 'brace_left_detected'
-                    prev_state, state = change_state(c, state, 'default')
-                    result += '()'
+class SquareBracketLeft < TextLineToken
+    attr_accessor :value
+    def initialize()
+        @value = "["
+    end
+end
+
+class SquareBracketRight < TextLineToken
+    attr_accessor :value
+    def initialize()
+        @value = "]"
+    end
+end
 
-                elsif state == 'link_url_started'
-                    prev_state, state = change_state(c, state, 'default')
-                    link_url = stack
-                    result += link(link_text, link_url)
+class SquareBracketRightAndParentheseLeft < TextLineToken
+    attr_accessor :value
+    def initialize()
+        @value = "]("
+    end
+end
+
+class TextLineParser
+    attr_accessor :supported_tokens
+
+    def initialize()
+        @supported_tokens = Array.new
+        @supported_tokens.append(BoldAndItalicToken.new)
+        @supported_tokens.append(BoldToken.new)
+        @supported_tokens.append(ItalicToken.new)
+        @supported_tokens.append(SquareBracketRightAndParentheseLeft.new)
+        @supported_tokens.append(ParentheseLeft.new)
+        @supported_tokens.append(ParentheseRight.new)
+        @supported_tokens.append(SquareBracketLeft.new)
+        @supported_tokens.append(SquareBracketRight.new)
+        @supported_tokens.append(TextLineToken.new)
+    end
 
+    def tokenize(str)
+        result = Array.new
+        sl = str.length
+        si = 0
+        while si < sl
+            @supported_tokens.each do |t|
+                tl = t.value.length
+                if tl != 0  # literal is the last supported token in the list
+                    projected_end_position = si+tl-1
+                    if projected_end_position > sl
+                        next
+                    end
+                    buf = str[si..projected_end_position]
+                    if buf == t.value
+                        result.append(t)
+                        si = projected_end_position +1
+                        break
+                    end
                 else
-                    result += c
+                    if (result.length > 0) and (result[-1].instance_of? TextLineToken)
+                        literal = result[-1]
+                        literal.value += str[si]
+                    else
+                        literal = TextLineToken.new
+                        literal.value = str[si]
+                        result.append(literal)
+                    end
+                    si += 1
                 end
-            else
-                if state == 'default'
-                    result += c
-                else
-                    if state == 'first_asterisk_detected'
-                        prev_state, state = change_state(c, state, 'italic_started')
-                        stack = ''
+            end
+        end
+        return result
+    end
+end
 
-                    elsif state == 'second_asterisk_detected'
-                        prev_state, state = change_state(c, state, 'bold_started')
-                        stack = ''
+class TextLineBuilderContext
 
-                    elsif state == 'third_asterisk_detected'
-                        prev_state, state = change_state(c, state, 'bold_and_italic_started')
-                        stack = ''
-                    
-                    elsif state == 'first_asterisk_after_bold_detected'
-                        prev_state, state = change_state(c, state, 'bold_started')
+    def italic(str)
+        return str
+    end
 
-                    elsif state == 'first_asterisk_after_bold_and_italic_detected'
-                        prev_state, state = change_state(c, state, 'bold_and_italic_started')
+    def bold(str)
+        return str
+    end
 
-                    elsif state == 'second_asterisk_after_bold_and_italic_detected'
-                        prev_state, state = change_state(c, state, 'bold_and_italic_started')
+    def bold_and_italic(str)
+        return str
+    end
 
-                    elsif state == 'square_bracket_left_detected'
-                        prev_state, state = change_state(c, state, 'link_text_started')
-                        stack = ''
+    def link(link_text, link_url)
+        return link_url
+    end
+end
 
-                    elsif state == 'square_bracket_right_detected'
-                        prev_state, state = change_state(c, state, 'default')
-                        result += stack + c
-                        c = ''
+class TextLineBuilder
+    attr_accessor :builder_context
 
-                    elsif state == 'brace_left_detected'
-                        prev_state, state = change_state(c, state, 'link_url_started')
-                        stack = ''
+    def initialize(builder_context)
+        @builder_context = builder_context
+    end
 
-                    else
-                    end
-                    stack += c
+    def restore(token_list)
+        result = ""
+        if token_list == nil
+            return ""
+        end
+        sub_list_url_text = nil
+        sub_list_url_address = nil
+        tl = token_list.length
+        ti = 0
+        while ti < tl
+            case token_list[ti].class.name
+            when "ItalicToken"
+                is_found = false
+                ti_starting_position = ti
+                # try to find closing part
+                tii = ti + 1
+                while tii < tl
+                    if token_list[tii].instance_of? ItalicToken
+                        sub_list = token_list[(ti+1)..(tii-1)]
+                        result += @builder_context.italic(restore(sub_list))
+                        ti = tii +1
+                        is_found = true
+                        break
+                    end 
+                    tii += 1 
+                end
+                unless is_found
+                    result += "*"
+                    ti = ti_starting_position + 1
+                end
+            when "BoldToken"
+                is_found = false
+                ti_starting_position = ti
+                # try to find closing part
+                tii = ti + 1
+                while tii < tl
+                    if token_list[tii].instance_of? BoldToken
+                        sub_list = token_list[(ti+1)..(tii-1)]
+                        result += @builder_context.bold(restore(sub_list))
+                        ti = tii +1
+                        is_found = true
+                        break
+                    end 
+                    tii += 1 
+                end
+                unless is_found
+                    result += "**"
+                    ti = ti_starting_position + 1
+                end
+            when "BoldAndItalicToken"
+                is_found = false
+                ti_starting_position = ti
+                # try to find closing part
+                tii = ti + 1
+                while tii < tl
+                    if token_list[tii].instance_of? BoldAndItalicToken
+                        sub_list = token_list[(ti+1)..(tii-1)]
+                        result += @builder_context.bold_and_italic(restore(sub_list))
+                        ti = tii +1
+                        is_found = true
+                        break
+                    end 
+                    tii += 1 
+                end
+                unless is_found
+                    result += "***"
+                    ti = ti_starting_position + 1
                 end
+            when "SquareBracketLeft"
+                # try to find closing part
+                is_found = false
+                tii = ti + 1
+                ti_starting_position = ti
+                while tii < tl
+                    case token_list[tii].class.name 
+                    when "SquareBracketRightAndParentheseLeft" 
+                        sub_list_url_text = token_list[(ti+1)..(tii-1)]
+                        ti = tii +1
+                        tiii = ti
+                        while tiii < tl
+                            case token_list[tiii].class.name
+                            when "ParentheseRight"
+                                sub_list_url_address = token_list[(tii+1)..(tiii-1)]
+                                ti = tiii +1
+                                is_found = true
+                                break
+                            end
+                            tiii += 1
+                        end
+                        break
+                    when "SquareBracketRight"
+                        break
+                    end 
+                    tii += 1
+                end
+                if is_found
+                    result += @builder_context.link(restore(sub_list_url_text), restore(sub_list_url_address))
+                else
+                    result += "["
+                    ti = ti_starting_position + 1
+                end
+           
+            when "TextLineToken", "ParentheseLeft", "ParentheseRight", "SquareBracketLeft", "SquareBracketRight"
+                result += token_list[ti].value
+                ti += 1 
+            else
+                ti += 1             
             end
-            prev_c = c
         end
         return result
     end
+end
+
+class TextLine < TextLineBuilderContext
+
+    @@lazy_doc_id_dict = Hash.new
+
+    def self.add_lazy_doc_id(id)
+        doc_id = id.to_s.downcase
+        @@lazy_doc_id_dict[doc_id] = doc_id
+    end
+
+    def format_string(str)
+        tlp = TextLineParser.new
+        tlb = TextLineBuilder.new(self)
+        tlb.restore(tlp.tokenize(str))
+    end
 
     def change_state(c, cur_state, new_state)
         # puts "[#{c}] Transition: #{cur_state} --> #{new_state}"
@@ -153,7 +284,6 @@ class TextLine
     end
 
     def link(link_text, link_url)
-
         # define default result first
         result = "<a target=\"_blank\" rel=\"noopener\" href=\"#{link_url}\" class=\"external\">#{link_text}</a>"
 

data/lib/almirah/doc_types/index.rb

@@ -44,7 +44,7 @@ class Index < BaseDocument
 
         sorted_items.each do |doc|
             s = "\t<tr>\n"
-            s += "\t\t<td class=\"item_text\" style='padding: 5px;'><a href=\"./specifications/#{doc.id}/#{doc.id}.html\" class=\"external\">#{doc.title}</a></td>\n"
+            s += "\t\t<td class=\"item_text\" style='padding: 5px;'><a href=\"./specifications/#{doc.id}/#{doc.id}.html\" class=\"external\"><i class=\"fa fa-file-text-o\" style='background-color: ##{doc.color};'> </i>&nbsp#{doc.title}</a></td>\n"
             s += "\t\t<td class=\"item_id\" style='width: 7%;'>#{doc.controlled_items.length.to_s}</td>\n"
             s += "\t\t<td class=\"item_id\" style='width: 7%;'>#{doc.items_with_uplinks_number.to_s}</td>\n"
             s += "\t\t<td class=\"item_id\" style='width: 7%;'>#{doc.items_with_downlinks_number.to_s}</td>\n"
@@ -97,18 +97,36 @@ class Index < BaseDocument
         s += "<table class=\"controlled\">\n"
         s += "\t<thead>\n"
         s += "\t\t<th>Title</th>\n"
+        s += "\t\t<th>Coverage</th>\n"
         s += "\t\t<th>Top Document</th>\n"
         s += "\t\t<th>Bottom Document</th>\n"
         s += "</thead>\n"
         html_rows.append s
 
         sorted_items = @project.traceability_matrices.sort_by { |w| w.id }
+        # buble-up design inputs
+        design_inputs = [] 
+        others = []
+        sorted_items.each do |doc|
+            if doc.bottom_doc
+                others.append doc
+            else
+                design_inputs.append doc
+            end
+        end
+        sorted_items = design_inputs + others
 
         sorted_items.each do |doc|
             s = "\t<tr>\n"
+            coverage = doc.traced_items.length.to_f / doc.top_doc.controlled_items.length.to_f * 100.0
             s += "\t\t<td class=\"item_text\" style='padding: 5px;'><a href=\"./specifications/#{doc.id}/#{doc.id}.html\" class=\"external\">#{doc.title}</a></td>\n"
-            s += "\t\t<td class=\"item_text\" style='width: 25%; padding: 5px;'>#{doc.top_doc.title}</td>\n"
-            s += "\t\t<td class=\"item_text\" style='width: 25%; padding: 5px;'>#{doc.bottom_doc.title}</td>\n"
+            s += "\t\t<td class=\"item_id\" style='width: 7%;'>#{'%.2f' % coverage}%</td>\n"
+            s += "\t\t<td class=\"item_text\" style='width: 25%; padding: 5px;'><i class=\"fa fa-file-text-o\" style='background-color: ##{doc.top_doc.color};'> </i>&nbsp#{doc.top_doc.title}</td>\n"
+            if doc.bottom_doc
+                s += "\t\t<td class=\"item_text\" style='width: 25%; padding: 5px;'><i class=\"fa fa-file-text-o\" style='background-color: ##{doc.bottom_doc.color};'> </i>&nbsp#{doc.bottom_doc.title}</td>\n"
+            else
+                s += "\t\t<td class=\"item_text\" style='width: 25%; padding: 5px;'><i class=\"fa fa-circle-o\"'> </i>&nbspAll References</td>\n"
+            end
             s += "</tr>\n"
             html_rows.append s
         end

data/lib/almirah/doc_types/specification.rb

@@ -15,6 +15,7 @@ class Specification < BaseDocument
     attr_accessor :duplicates_list
     attr_accessor :last_used_id
     attr_accessor :last_used_id_number
+    attr_accessor :color
 
     def initialize(fele_path)
 
@@ -35,6 +36,8 @@ class Specification < BaseDocument
         @last_used_id = ""
         @last_used_id_number = 0
 
+        @color = 'bbb'
+
         @id = File.basename(fele_path, File.extname(fele_path)).downcase
         @up_link_doc_id = Hash.new
     end

data/lib/almirah/doc_types/traceability.rb

@@ -6,12 +6,14 @@ class Traceability < BaseDocument
     attr_accessor :bottom_doc
     attr_accessor :items
     attr_accessor :is_agregated
+    attr_accessor :traced_items
 
     def initialize(top_doc, bottom_doc, is_agregated)
 
         @top_doc = top_doc
         @bottom_doc = bottom_doc
         @is_agregated = is_agregated
+        @traced_items = {}
 
         @items = Array.new
         @headings = Array.new
@@ -37,7 +39,11 @@ class Traceability < BaseDocument
         s = "<h1>#{@title}</h1>\n"
         s += "<table class=\"controlled\">\n"
         s += "\t<thead> <th>#</th> <th style='font-weight: bold;'>#{@top_doc.title}</th> "
-        s += "<th>#</th> <th style='font-weight: bold;'>#{@bottom_doc.title}</th> "
+        if @bottom_doc
+            s += "<th>#</th> <th style='font-weight: bold;'>#{@bottom_doc.title}</th> "
+        else
+            s += "<th>#</th> <th style='font-weight: bold;'>All References</th> "
+        end
         s += "<th style='font-weight: bold;'>Document Section</th>"
         s += "</thead>\n"
         html_rows.append s
@@ -57,27 +63,36 @@ class Traceability < BaseDocument
     def render_table_row(top_item)
         s = ""
         top_f_text = top_item.format_string( top_item.text )
-        
+        id_color = ""
+
         if top_item.down_links
 
             if @is_agregated
-
-                if top_item.down_links.length > 1
-                    id_color = "style='background-color: #fff8c5;'"
-                else
-                    id_color = ""
-                end
+                
+                top_item_rendered = false
 
                 top_item.down_links.each do |bottom_item|
+                    id_color = "style='background-color: ##{bottom_item.parent_doc.color};'"
                     bottom_f_text = bottom_item.format_string( bottom_item.text )
                     document_section = bottom_item.parent_heading.get_section_info
                     s += "\t<tr>\n"
-                    s += "\t\t<td class=\"item_id\" #{id_color}><a href=\"./../#{top_item.parent_doc.id}/#{top_item.parent_doc.id}.html##{top_item.id}\" class=\"external\">#{top_item.id}</a></td>\n"
+                    s += "\t\t<td class=\"item_id\"><a href=\"./../#{top_item.parent_doc.id}/#{top_item.parent_doc.id}.html##{top_item.id}\" class=\"external\">#{top_item.id}</a></td>\n"
                     s += "\t\t<td class=\"item_text\" style='width: 34%;'>#{top_f_text}</td>\n"
-                    s += "\t\t<td class=\"item_id\"><a href=\"./../#{bottom_item.parent_doc.id}/#{bottom_item.parent_doc.id}.html##{bottom_item.id}\" class=\"external\">#{bottom_item.id}</a></td>\n"
+                    s += "\t\t<td class=\"item_id\" #{id_color}><a href=\"./../#{bottom_item.parent_doc.id}/#{bottom_item.parent_doc.id}.html##{bottom_item.id}\" class=\"external\">#{bottom_item.id}</a></td>\n"
                     s += "\t\t<td class=\"item_text\" style='width: 34%;'>#{bottom_f_text}</td>\n"
                     s += "\t\t<td class=\"item_text\" style='width: 16%;'>#{document_section}</td>\n"
                     s += "\t</tr>\n"
+                    top_item_rendered = true
+                    @traced_items[top_item.id.to_s.downcase] = top_item
+                end
+                unless top_item_rendered
+                    s += "\t<tr>\n"
+                    s += "\t\t<td class=\"item_id\"><a href=\"./../#{top_item.parent_doc.id}/#{top_item.parent_doc.id}.html##{top_item.id}\" class=\"external\">#{top_item.id}</a></td>\n"
+                    s += "\t\t<td class=\"item_text\" style='width: 34%;'>#{top_f_text}</td>\n"
+                    s += "\t\t<td class=\"item_id\"></td>\n"
+                    s += "\t\t<td class=\"item_text\" style='width: 34%;'></td>\n"
+                    s += "\t\t<td class=\"item_text\" style='width: 16%;'></td>\n"
+                    s += "\t</tr>\n"
                 end
 
             else
@@ -99,6 +114,7 @@ class Traceability < BaseDocument
                         s += "\t\t<td class=\"item_text\" style='width: 16%;'>#{document_section}</td>\n"
                         s += "\t</tr>\n"
                         top_item_rendered = true
+                        @traced_items[top_item.id.to_s.downcase] = top_item
                     end
                 end
                 unless top_item_rendered

data/lib/almirah/dom/doc_section.rb

@@ -12,7 +12,7 @@ class DocSection
 
     def to_html
         s = ''
-        s += "\t<li><span class=\"fa-li\"><i class=\"fa fa-plus-square-o\"> </i></span>"
+        s += "\t<li><span class=\"fa-li\"><i class=\"fa fa-sticky-note-o\"> </i></span>"
         s += "<a href=\"\#" + @heading.anchor_id.to_s + "\">" + @heading.get_section_info + "</a>\n"
         if @sections.length >0
             s += "\t\t<ul class=\"fa-ul\">\n"

data/lib/almirah/project.rb

@@ -1,4 +1,5 @@
 require 'fileutils'
+require 'YAML'
 require_relative "doc_fabric"
 require_relative "navigation_pane"
 require_relative "doc_types/traceability"
@@ -15,7 +16,7 @@ class Project
     attr_accessor :specifications_dictionary
     attr_accessor :index
     attr_accessor :project
-    attr_accessor :on_server
+    attr_accessor :project_configuration
 
     def initialize(path)
         @project_root_directory = path
@@ -26,9 +27,19 @@ class Project
         @specifications_dictionary = Hash.new
         @index = nil
         @project = self
-        @on_server = false
+        @project_configuration = {}
+        load_project_file()
+        FileUtils.remove_dir(@project_root_directory + "/build", true)
+    end
 
-        FileUtils.remove_dir(@project_root_directory + "/build", true)      
+    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
     end
 
     def specifications_and_protocols
@@ -90,6 +101,7 @@ class Project
         Dir.glob( "#{@project_root_directory}/specifications/**/*.md" ).each do |f|
             doc = DocFabric.create_specification(f)
             @specifications.append(doc)
+            @specifications_dictionary[doc.id.to_s.downcase] = doc
         end
     end
 
@@ -115,6 +127,18 @@ class Project
             link_two_specifications(c[0], c[1])
             # 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
+                end
+            end
+        end
     end
 
     def link_all_protocols

data/lib/almirah/templates/page.html

@@ -378,7 +378,7 @@ 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</a>
+        Powered by <a target="_blank" rel="noopener" href="https://www.almirah.site/">Almirah Framework (0.1.8)</a>
     </div><!-- footer -->
     <!-- The modal window for image zoom -->
     <div id="image_modal_div" class="modal">

data/lib/almirah.rb

@@ -7,9 +7,9 @@ class CLI < Thor
     def please(project_folder)
       a = Almirah.new project_folder
       if options[:results]
-        a.results( options[:results], false )
+        a.results( options[:results] )
       else
-        a.default(false)
+        a.default()
       end
     end
 
@@ -18,17 +18,6 @@ class CLI < Thor
     a = Almirah.new project_folder
     a.transform "docx"
   end
-
-  option :results
-  desc "server <project_folder>", "say <project_folder>"
-  def server(project_folder)
-    a = Almirah.new project_folder
-    if options[:results]
-      a.results( options[:results], true )
-    else
-      a.default(true)
-    end
-  end
 end
 
 class Almirah
@@ -43,8 +32,7 @@ class Almirah
     File.expand_path './..', File.dirname(__FILE__)
   end
 
-  def results( test_run, on_server )
-    @project.on_server = on_server
+  def results( test_run )
     @project.specifications_and_results test_run
   end
 
@@ -52,8 +40,7 @@ class Almirah
     @project.transform file_extension
   end
 
-  def default(on_server)
-    @project.on_server = on_server
+  def default()
     @project.specifications_and_protocols
   end