Almirah 0.2.4 → 0.2.6

data/lib/almirah/doc_types/traceability.rb

@@ -1,142 +1,142 @@
-require_relative "base_document"
-
-class Traceability < BaseDocument
-
-    attr_accessor :top_doc
-    attr_accessor :bottom_doc
-    attr_accessor :items
-    attr_accessor :is_agregated
-    attr_accessor :traced_items
-
-    def initialize(top_doc, bottom_doc)
-        super()
-        @top_doc = top_doc
-        @bottom_doc = bottom_doc
-        @is_agregated = if bottom_doc
-                          false
-                        else
-                          true
-                        end
-        @traced_items = {}
-
-        if @is_agregated 
-            @id = top_doc.id + "-all"
-        else
-            @id = top_doc.id + "-" + bottom_doc.id
-        end
-
-        @title = "Traceability Matrix: " + @id
-    end
-
-    def to_console
-        puts "\e[35m" + "Traceability: " + @id + "\e[0m"
-    end
-
-    def to_html(nav_pane, output_file_path)
-
-        html_rows = Array.new
-
-        html_rows.append('')
-        s = "<h1>#{@title}</h1>\n"
-        s += "<table class=\"controlled\">\n"
-        s += "\t<thead> <th>#</th> <th style='font-weight: bold;'>#{@top_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
-
-        sorted_items = @top_doc.controlled_items.sort_by { |w| w.id }
-
-        sorted_items.each do |top_item|
-            row = render_table_row top_item
-            html_rows.append row
-        end
-        html_rows.append "</table>\n"
-
-        self.save_html_to_file(html_rows, nav_pane, output_file_path)
-        
-    end
-
-    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
-                
-                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\"><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\" #{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
-                top_item_rendered = false
-                top_item.down_links.each do |bottom_item|
-
-                    id_color = ""
-
-                    if bottom_item.parent_doc.id == @bottom_doc.id
-
-                        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_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_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
-                end
-                unless top_item_rendered
-                    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_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
-            end
-        else
-            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
-        return s
-    end
-end
+require_relative "base_document"
+
+class Traceability < BaseDocument
+
+    attr_accessor :top_doc
+    attr_accessor :bottom_doc
+    attr_accessor :items
+    attr_accessor :is_agregated
+    attr_accessor :traced_items
+
+    def initialize(top_doc, bottom_doc)
+        super()
+        @top_doc = top_doc
+        @bottom_doc = bottom_doc
+        @is_agregated = if bottom_doc
+                          false
+                        else
+                          true
+                        end
+        @traced_items = {}
+
+        if @is_agregated 
+            @id = top_doc.id + "-all"
+        else
+            @id = top_doc.id + "-" + bottom_doc.id
+        end
+
+        @title = "Traceability Matrix: " + @id
+    end
+
+    def to_console
+        puts "\e[35m" + "Traceability: " + @id + "\e[0m"
+    end
+
+    def to_html(nav_pane, output_file_path)
+
+        html_rows = Array.new
+
+        html_rows.append('')
+        s = "<h1>#{@title}</h1>\n"
+        s += "<table class=\"controlled\">\n"
+        s += "\t<thead> <th>#</th> <th style='font-weight: bold;'>#{@top_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
+
+        sorted_items = @top_doc.controlled_items.sort_by { |w| w.id }
+
+        sorted_items.each do |top_item|
+            row = render_table_row top_item
+            html_rows.append row
+        end
+        html_rows.append "</table>\n"
+
+        self.save_html_to_file(html_rows, nav_pane, output_file_path)
+        
+    end
+
+    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
+                
+                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\"><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\" #{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
+                top_item_rendered = false
+                top_item.down_links.each do |bottom_item|
+
+                    id_color = ""
+
+                    if bottom_item.parent_doc.id == @bottom_doc.id
+
+                        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_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_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
+                end
+                unless top_item_rendered
+                    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_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
+            end
+        else
+            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
+        return s
+    end
+end

data/lib/almirah/dom/doc_section.rb

@@ -1,25 +1,25 @@
-class DocSection
-  attr_accessor :sections, :heading, :parent_section
-
-  def initialize(heading)
-    @sections = []
-    @heading = heading
-    @parent_section = nil
-  end
-
-  def to_html # rubocop:disable Metrics/MethodLength
-    s = ''
-    s += "\t<li onclick=\"nav_toggle_expand_list(this, event)\">" \
-      '<span class="fa-li"><i class="fa fa-minus-square-o"> </i></span>'
-    s += "<a href=\"##{@heading.anchor_id}\">#{@heading.get_section_info}</a>\n"
-    unless @sections.empty?
-      s += "\t\t<ul class=\"fa-ul\">\n"
-      @sections.each do |sub_section|
-        s += sub_section.to_html
-      end
-      s += "\t\t</ul>\n"
-    end
-    s += "</li>\n"
-    s
-  end
-end
+class DocSection
+  attr_accessor :sections, :heading, :parent_section
+
+  def initialize(heading)
+    @sections = []
+    @heading = heading
+    @parent_section = nil
+  end
+
+  def to_html # rubocop:disable Metrics/MethodLength
+    s = ''
+    s += "\t<li onclick=\"nav_toggle_expand_list(this, event)\">" \
+      '<span class="fa-li"><i class="fa fa-minus-square-o"> </i></span>'
+    s += "<a href=\"##{@heading.anchor_id}\">#{@heading.get_section_info}</a>\n"
+    unless @sections.empty?
+      s += "\t\t<ul class=\"fa-ul\">\n"
+      @sections.each do |sub_section|
+        s += sub_section.to_html
+      end
+      s += "\t\t</ul>\n"
+    end
+    s += "</li>\n"
+    s
+  end
+end

data/lib/almirah/dom/document.rb

@@ -1,72 +1,78 @@
-require_relative 'doc_section'
-
-class Document
-  attr_accessor :root_section
-
-  def initialize(headings_list)
-    @root_section = nil
-
-    build_sections_tree(headings_list)
-  end
-
-  def build_sections_tree(headings_list)
-    sections_stack = []
-    headings_list.each do |h|
-      if @root_section.nil?
-
-        s = DocSection.new(h)
-        s.parent_section = nil
-        @root_section = s
-        sections_stack.push s
-        # one more artificial section copy if root is not a Document Title (level 0)
-        if h.level.positive?
-          a = DocSection.new(h)
-          a.parent_section = @root_section
-          @root_section.sections.append(a)
-          sections_stack.push a
-        end
-
-      elsif sections_stack[-1].heading.level == h.level
-
-        s = DocSection.new(h)
-        s.parent_section = sections_stack[-1].parent_section
-        sections_stack[-1].parent_section.sections.append(s)
-        sections_stack[-1] = s
-
-      elsif h.level > sections_stack[-1].heading.level
-
-        s = DocSection.new(h)
-        s.parent_section = sections_stack[-1]
-        sections_stack[-1].sections.append(s)
-        sections_stack.push s
-
-      else
-        sections_stack.pop while h.level < sections_stack[-1].heading.level
-        sections_stack.push @root_section if sections_stack.empty?
-        s = DocSection.new(h)
-        if h.level == sections_stack[-1].heading.level
-          s.parent_section = sections_stack[-1].parent_section
-          sections_stack[-1].parent_section.sections.append(s)
-        else
-          s.parent_section = sections_stack[-1]
-          sections_stack[-1].sections.append(s)
-        end
-        sections_stack[-1] = s
-      end
-    end
-  end
-
-  def section_tree_to_html
-    s = ''
-    s += "<a href=\"##{@root_section.heading.anchor_id}\">#{@root_section.heading.get_section_info}</a>\n"
-    unless @root_section.sections.empty?
-      s += "\t<ul class=\"fa-ul\" style=\"margin-top: 2px;\">\n"
-      @root_section.sections.each do |sub_section|
-        s += sub_section.to_html
-      end
-      s += "\t</ul>\n"
-    end
-
-    s
-  end
-end
+require_relative 'doc_section'
+
+class Document
+  attr_accessor :root_section
+
+  def initialize(headings_list)
+    @root_section = nil
+
+    build_sections_tree(headings_list)
+  end
+
+  def build_sections_tree(headings_list)
+    sections_stack = []
+    headings_list.each do |h|
+      if @root_section.nil?
+
+        s = DocSection.new(h)
+        s.parent_section = nil
+        @root_section = s
+        sections_stack.push s
+        # one more artificial section copy if root is not a Document Title (level 0)
+        if h.level.positive?
+          a = DocSection.new(h)
+          a.parent_section = @root_section
+          @root_section.sections.append(a)
+          sections_stack.push a
+        end
+
+      elsif sections_stack[-1].heading.level == h.level
+
+        s = DocSection.new(h)
+        s.parent_section = sections_stack[-1].parent_section
+        sections_stack[-1].parent_section.sections.append(s)
+        sections_stack[-1] = s
+        # for search engine
+        s.heading.parent_heading = s.parent_section.heading
+
+      elsif h.level > sections_stack[-1].heading.level
+
+        s = DocSection.new(h)
+        s.parent_section = sections_stack[-1]
+        sections_stack[-1].sections.append(s)
+        sections_stack.push s
+        # for search engine
+        s.heading.parent_heading = s.parent_section.heading
+
+      else
+        sections_stack.pop while h.level < sections_stack[-1].heading.level
+        sections_stack.push @root_section if sections_stack.empty?
+        s = DocSection.new(h)
+        if h.level == sections_stack[-1].heading.level
+          s.parent_section = sections_stack[-1].parent_section
+          sections_stack[-1].parent_section.sections.append(s)
+        else
+          s.parent_section = sections_stack[-1]
+          sections_stack[-1].sections.append(s)
+        end
+        sections_stack[-1] = s
+        # for search engine
+        s.heading.parent_heading = s.parent_section.heading
+      end
+    end
+  end
+
+  def section_tree_to_html
+    s = ''
+    s += "<a href=\"##{@root_section.heading.anchor_id}\">#{@root_section.heading.get_section_info}</a>\n"
+    unless @root_section.sections.empty?
+      s += "\t<ul class=\"fa-ul\" style=\"margin-top: 2px;\">\n"
+      @root_section.sections.each do |sub_section|
+        s += sub_section.to_html
+      end
+      s += "\t</ul>\n"
+    end
+
+    s
+  end
+end

data/lib/almirah/navigation_pane.rb

@@ -1,17 +1,17 @@
-
-class NavigationPane
-
-    attr_accessor :specifications
-
-    def initialize(specification)
-        @doc = specification
-    end
-
-    def to_html
-        if  @doc.dom
-            return @doc.dom.section_tree_to_html()
-        else
-            return ''
-        end
-    end
+
+class NavigationPane
+
+    attr_accessor :specifications
+
+    def initialize(specification)
+        @doc = specification
+    end
+
+    def to_html
+        if  @doc.dom
+            return @doc.dom.section_tree_to_html()
+        else
+            return ''
+        end
+    end
 end