Almirah 0.1.9 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c88fa681954a14b92b114aec73d996c30678749d13cfb049a25b216b83f726cb
-  data.tar.gz: 94c51c141e22015250c776e547994462f7ff878967938c0fd43b4bdff698fa84
+  metadata.gz: da8737eaa32966b6559639becfd0737c25394340b1f32cc682a1063a78205190
+  data.tar.gz: 40914f94ceda02630a170c04965d65a83a5073db6d5aa32eb678caaf2823ee96
 SHA512:
-  metadata.gz: 0c793599f7119665dc724c4fe66102dab3168e3d9ef34a1efb77f928f521a58689945111a22acc5a1d358a85a4575700b8f8675a39f561cc8a54f8c214adba92
-  data.tar.gz: 3e95fd1f182d88233f244d59fd7ed36ca1924f1cb1e0594065e35511da739e58aa77b17d5a8b974499378ef430fb41eb6770b067f28e402ceb076828fdf186cb
+  metadata.gz: a3f545f59badec9c749b0b9104eb9a2ae7737bd47f2c36a1c5d2b743df8a6931654500b798b6309b3a96368b926d64e8dd52f4faae4fd83affe453a861cbad9e
+  data.tar.gz: eeb982a3da8bbba0dadf6832fc9491d334e31b06aaf8749921e8a4bb0dc6fa9b94a8a249b05c883f3a288b242550be46342a9bccdec11b809910caaa5644930c

data/lib/almirah/doc_fabric.rb

@@ -1,20 +1,7 @@
 require_relative 'doc_types/base_document'
 require_relative 'doc_types/specification'
 require_relative 'doc_types/protocol'
-require_relative 'doc_items/text_line'
-require_relative 'doc_items/doc_item'
-require_relative 'doc_items/heading'
-require_relative 'doc_items/paragraph'
-require_relative 'doc_items/blockquote'
-require_relative 'doc_items/code_block'
-require_relative 'doc_items/todo_block'
-require_relative 'doc_items/controlled_paragraph'
-require_relative 'doc_items/markdown_table'
-require_relative 'doc_items/controlled_table'
-require_relative 'doc_items/image'
-require_relative 'doc_items/markdown_list'
-require_relative 'doc_items/doc_footer'
-
+require_relative 'doc_parser'
 require_relative 'dom/document'
 
 class DocFabric
@@ -45,326 +32,15 @@ class DocFabric
   end
 
   def self.parse_document(doc)
-    temp_md_table = nil
-    temp_md_list = nil
-    temp_code_block = nil
 
     file = File.open(doc.path)
     file_lines = file.readlines
     file.close
 
-    file_lines.each do |s|
-      if s.lstrip != ''
-        if res = /^(\#{1,})\s(.*)/.match(s) # Heading
-
-          if temp_md_table
-            doc.items.append temp_md_table
-            temp_md_table = nil
-          end
-          if temp_md_list
-            doc.items.append temp_md_list
-            temp_md_list = nil
-          end
-
-          level = res[1].length
-          value = res[2]
-
-          if level == 1 && doc.title == ''
-            doc.title = value
-            level = 0 # Doc Title is a Root
-            Heading.reset_global_section_number
-          end
-
-          item = Heading.new(value, level)
-          item.parent_doc = doc
-          doc.items.append(item)
-          doc.headings.append(item)
-
-        elsif res = /^%\s(.*)/.match(s) # Pandoc Document Title
-
-          title = res[1]
-
-          if doc.title == ''
-            doc.title = title
-            Heading.reset_global_section_number
-          end
-
-          item = Heading.new(title, 0)
-          item.parent_doc = doc
-          doc.items.append(item)
-          doc.headings.append(item)
-
-          Heading.reset_global_section_number # Pandoc Document Title is not a section, so it shall not be taken into account in numbering
-
-        elsif res = /^\[(\S*)\]\s+(.*)/.match(s) # Controlled Paragraph
-
-          if temp_md_table
-            doc.items.append temp_md_table
-            temp_md_table = nil
-          end
-          if temp_md_list
-            doc.items.append temp_md_list
-            temp_md_list = nil
-          end
-
-          id = res[1]
-          text = res[2]
-          up_links = nil
-
-          # check if it contains the uplink (one or many)
-          # TODO: check this regular expression
-          first_pos = text.length # for trailing commas
-          tmp = text.scan(/(>\[(?>[^\[\]]|\g<0>)*\])/) # >[SRS-001], >[SYS-002]
-          if tmp.length > 0
-            up_links = []
-            tmp.each do |ul|
-              up_links.append(ul[0])
-              # try to find the real end of text
-              pos = text.index(ul[0])
-              first_pos = pos if pos < first_pos
-              # remove uplink from text
-              text = text.split(ul[0]).join('')
-            end
-            # remove trailing commas and spaces
-            if text.length > first_pos
-              first_pos -= 1
-              text = text[0..first_pos].strip
-            end
-          end
-
-          # since we already know id and text
-          item = ControlledParagraph.new(text, id)
-
-          if up_links
-            doc.items_with_uplinks_number += 1 # for statistics
-            up_links.each do |ul|
-              next unless tmp = />\[(\S*)\]$/.match(ul) # >[SRS-001]
-
-              up_link_id = tmp[1]
-
-              item.up_link_ids = [] unless item.up_link_ids
-
-              item.up_link_ids.append(up_link_id)
-
-              if tmp = /^([a-zA-Z]+)-\d+/.match(up_link_id) # SRS
-                doc.up_link_doc_id[tmp[1].downcase.to_s] = tmp[1].downcase # multiple documents could be up-linked
-              end
-            end
-          end
-
-          item.parent_doc = doc
-          item.parent_heading = doc.headings[-1]
-
-          doc.items.append(item)
-          # for statistics
-          if doc.dictionary.has_key?(id.to_s)
-            doc.duplicated_ids_number += 1
-            doc.duplicates_list.append(item)
-          else
-            doc.dictionary[id.to_s] = item # for fast search
-          end
-          doc.controlled_items.append(item) # for fast search
-
-          # for statistics
-          n = /\d+/.match(id)[0].to_i
-          if n > doc.last_used_id_number
-            doc.last_used_id = id
-            doc.last_used_id_number = n
-          end
-
-        elsif res = /^!\[(.*)\]\((.*)\)/.match(s) # Image
-
-          if temp_md_table
-            doc.items.append temp_md_table
-            temp_md_table = nil
-          end
-          if temp_md_list
-            doc.items.append temp_md_list
-            temp_md_list = nil
-          end
-
-          img_text = res[1]
-          img_path = res[2]
-
-          item = Image.new(img_text, img_path)
-          item.parent_doc = doc
-
-          doc.items.append(item)
-
-        elsif res = /^(\*\s+)(.*)/.match(s)   # check if unordered list start
+    DocParser.parse(doc, file_lines)
 
-          if temp_md_table
-            doc.items.append temp_md_table
-            temp_md_table = nil
-          end
-
-          row = res[2]
-
-          if temp_md_list
-            temp_md_list.addRow(s)
-          else
-            item = MarkdownList.new(false)
-            item.addRow(s)
-            item.parent_doc = doc
-            temp_md_list = item
-          end
-
-        elsif res = /^\d[.]\s(.*)/.match(s)   # check if ordered list start
-
-          if temp_md_table
-            doc.items.append temp_md_table
-            temp_md_table = nil
-          end
-
-          row = res[1]
-
-          if temp_md_list
-            temp_md_list.addRow(s)
-          else
-            item = MarkdownList.new(true)
-            item.addRow(s)
-            item.parent_doc = doc
-            temp_md_list = item
-          end
-
-        elsif s[0] == '|' # check if table
-
-          if temp_md_list
-            doc.items.append temp_md_list
-            temp_md_list = nil
-          end
-
-          if res = /^[|](-{3,})[|]/.match(s) # check if it is a separator first
-
-            if temp_md_table
-            # separator is found after heading - just skip it
-            else
-              # separator out of table scope consider it just as a regular paragraph
-              item = Paragraph.new(s)
-              item.parent_doc = doc
-              doc.items.append(item)
-            end
-
-          elsif res = /^[|](.*[|])/.match(s) # check if it looks as a table
-
-            row = res[1]
-
-            if temp_md_table
-              # check if it is a controlled table
-              unless temp_md_table.addRow(row)
-                temp_md_table = ControlledTable.new(temp_md_table, doc)
-                temp_md_table.parent_doc = doc
-                temp_md_table.addRow(row)
-              end
-            else
-              # start table from heading
-              temp_md_table = MarkdownTable.new(row)
-              temp_md_table.parent_doc = doc
-            end
-          end
-
-        elsif res = /^>(.*)/.match(s) # check if blockquote
-
-          if temp_md_table
-            doc.items.append temp_md_table
-            temp_md_table = nil
-          end
-          if temp_md_list
-            doc.items.append temp_md_list
-            temp_md_list = nil
-          end
-
-          item = Blockquote.new(res[1])
-          item.parent_doc = doc
-          doc.items.append(item)
-
-        elsif res = /^```(\w*)/.match(s) # check if code block
-
-          if temp_md_table
-            doc.items.append temp_md_table
-            temp_md_table = nil
-          end
-          if temp_md_list
-            doc.items.append temp_md_list
-            temp_md_list = nil
-          end
-
-          suggested_format = ''
-          suggested_format = res[1] if res.length == 2
-
-          if temp_code_block
-            # close already opened block
-            doc.items.append(temp_code_block)
-            temp_code_block = nil
-          else
-            # start code block
-            temp_code_block = CodeBlock.new(suggested_format)
-            temp_code_block.parent_doc = doc
-          end
-
-        elsif res = /^TODO:(.*)/.match(s) # check if TODO block
-
-          if temp_md_table
-            doc.items.append temp_md_table
-            temp_md_table = nil
-          end
-          if temp_md_list
-            doc.items.append temp_md_list
-            temp_md_list = nil
-          end
-
-          text = '**TODO**: ' + res[1]
-
-          item = TodoBlock.new(text)
-          item.parent_doc = doc
-          doc.items.append(item)
-          doc.todo_blocks.append(item)
-
-        else # Reqular Paragraph
-          if temp_md_table
-            doc.items.append temp_md_table
-            temp_md_table = nil
-          end
-          if temp_md_list
-            if MarkdownList.unordered_list_item?(s) || MarkdownList.ordered_list_item?(s)
-              temp_md_list.addRow(s)
-              next
-            else
-              doc.items.append temp_md_list
-              temp_md_list = nil
-            end
-          end
-          if temp_code_block
-            temp_code_block.code_lines.append(s)
-          else
-            item = Paragraph.new(s)
-            item.parent_doc = doc
-            doc.items.append(item)
-          end
-        end
-      elsif temp_md_list
-        doc.items.append temp_md_list
-        temp_md_list = nil # lists are separated by emty line from each other
-      end
-    end
-    # Finalize non-closed elements
-    if temp_md_table
-      doc.items.append temp_md_table
-      temp_md_table = nil
-    end
-    if temp_md_list
-      doc.items.append temp_md_list
-      temp_md_list = nil
-    end
-    if temp_code_block
-      doc.items.append temp_code_block
-      temp_code_block = nil
-    end
-    # Add footer to close opened tables if any
-    item = DocFooter.new
-    item.parent_doc = doc
-    doc.items.append(item)
     # Build dom
     doc.dom = Document.new(doc.headings) if doc.is_a?(Specification)
+    
   end
 end

data/lib/almirah/doc_items/controlled_paragraph.rb

@@ -7,7 +7,9 @@ class ControlledParagraph < Paragraph
     attr_accessor :down_links
     attr_accessor :coverage_links
 
-    def initialize(text, id)
+    def initialize(doc, text, id)
+        @parent_doc = doc
+        @parent_heading = doc.headings[-1]
         @text = text.strip
         @id = id
         @up_link_ids = nil

data/lib/almirah/doc_items/controlled_table.rb

@@ -129,7 +129,7 @@ class ControlledTable < DocItem
                 # save uplink key but do not rewrite
                 if col.up_link_doc_id != nil 
                     
-                    @parent_doc.up_link_doc_id[ col.up_link_doc_id.to_s ] = col.up_link_doc_id
+                    @parent_doc.up_link_docs[ col.up_link_doc_id.to_s ] = col.up_link_doc_id
 
                     # save reference to the test step
                     new_row.up_link = col.up_link

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

@@ -8,7 +8,8 @@ class Heading < Paragraph
 
     @@global_section_number = ""
 
-    def initialize(text, level)
+    def initialize(doc, text, level)
+        @parent_doc = doc
         @text = text
         @level = level
 
@@ -51,7 +52,11 @@ class Heading < Paragraph
     end
 
     def get_section_info
-        s = @section_number + " " + @text
+        if level == 0 # Doc Title
+            s = @text
+        else
+            s = @section_number + " " + @text
+        end
     end
 
     def get_anchor_text()
@@ -76,6 +81,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_items/markdown_list.rb

@@ -10,7 +10,10 @@ class MarkdownList < DocItem
 
     @@lists_stack = Array.new
 
-    def initialize(is_ordered)
+    def initialize(doc, is_ordered)
+        @parent_doc = doc
+        @parent_heading = doc.headings[-1]
+
         @rows = Array.new
         @is_ordered = is_ordered
         @current_nesting_level = 0
@@ -30,7 +33,7 @@ class MarkdownList < DocItem
 
             prev_lists_stack_item = @@lists_stack[-1]
             # the following line pushes new list to the lists_stack in the constructor!
-            nested_list = MarkdownList.new( MarkdownList.ordered_list_item?(raw_text) )
+            nested_list = MarkdownList.new( @parent_doc, MarkdownList.ordered_list_item?(raw_text) )
             nested_list.current_nesting_level = @current_nesting_level + 1
             nested_list.indent_position = pos