Almirah 0.2.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da8737eaa32966b6559639becfd0737c25394340b1f32cc682a1063a78205190
-  data.tar.gz: 40914f94ceda02630a170c04965d65a83a5073db6d5aa32eb678caaf2823ee96
+  metadata.gz: 34b91589658288fe6c451f14cbb14601ac2c4d083e28b4495aef3f1bb1edcd34
+  data.tar.gz: 3d834bb51eb285b7acac6b7c44090bab14c40d0d2e64b4743c5867b41375c0ef
 SHA512:
-  metadata.gz: a3f545f59badec9c749b0b9104eb9a2ae7737bd47f2c36a1c5d2b743df8a6931654500b798b6309b3a96368b926d64e8dd52f4faae4fd83affe453a861cbad9e
-  data.tar.gz: eeb982a3da8bbba0dadf6832fc9491d334e31b06aaf8749921e8a4bb0dc6fa9b94a8a249b05c883f3a288b242550be46342a9bccdec11b809910caaa5644930c
+  metadata.gz: 48e6c007534e2af97110faa435a2596fdd772c2a0acc8cc4980432cdc7c9d99b517f13a9460a05d8d5c0a7d3564ebd53249cffcb571f3087dd9cb3317c5c4093
+  data.tar.gz: 22ec1eaef53f7cf629ebd607fc321555f759c33b18510ec0787bdea61918636a985d84d7068ce02f6a81803a6dfe17fdd7250fc7ca8cd75a2fb1f4ed47a99981

data/lib/almirah/doc_items/blockquote.rb

@@ -11,9 +11,9 @@ class Blockquote < DocItem
     def to_html
         s = ''
         f_text = format_string(@text)
-        if @@htmlTableRenderInProgress
+        if @@html_table_render_in_progress
             s += "</table>\n"
-            @@htmlTableRenderInProgress = false
+            @@html_table_render_in_progress = false
         end
 
         s += "<div class=\"blockquote\"><p>#{f_text}</div>\n"

data/lib/almirah/doc_items/code_block.rb

@@ -13,9 +13,9 @@ class CodeBlock < DocItem
     def to_html
         s = ''
 
-        if @@htmlTableRenderInProgress
+        if @@html_table_render_in_progress
             s += "</table>\n"
-            @@htmlTableRenderInProgress = false
+            @@html_table_render_in_progress = false
         end
         s += "<code>"
         @code_lines.each do |l|

data/lib/almirah/doc_items/controlled_paragraph.rb

@@ -19,14 +19,14 @@ class ControlledParagraph < Paragraph
 
     def to_html
         s = ''
-        unless @@htmlTableRenderInProgress                    
+        unless @@html_table_render_in_progress                    
             s += "<table class=\"controlled\">\n"
-            s += "\t<thead> <th>#</th> <th></th> <th>UL</th> <th>DL</th> <th>COV</th> </thead>\n"
-            @@htmlTableRenderInProgress = true
+            s += "\t<thead> <th>#</th> <th></th> <th title=\"Up-links\">UL</th> <th title=\"Down-links\">DL</th> <th title=\"Test Coverage\">COV</th> </thead>\n"
+            @@html_table_render_in_progress = true
         end
         f_text = format_string(@text)
         s += "\t<tr>\n"
-        s += "\t\t<td class=\"item_id\"> <a name=\"#{@id}\" id=\"#{@id}\" href=\"##{@id}\">#{@id}</a></td>\n"
+        s += "\t\t<td class=\"item_id\"> <a name=\"#{@id}\" id=\"#{@id}\" href=\"##{@id}\" title=\"Paragraph ID\">#{@id}</a></td>\n"
         s += "\t\t<td class=\"item_text\">#{f_text}</td>\n"
 
         if @up_link_ids
@@ -34,18 +34,18 @@ class ControlledParagraph < Paragraph
                 if tmp = /^([a-zA-Z]+)[-]\d+/.match(@up_link_ids[0])
                     up_link_doc_name = tmp[1].downcase
                 end
-                s += "\t\t<td class=\"item_id\"><a href=\"./../#{up_link_doc_name}/#{up_link_doc_name}.html##{@up_link_ids[0]}\" class=\"external\">#{@up_link_ids[0]}</a></td>\n"
+                s += "\t\t<td class=\"item_id\"><a href=\"./../#{up_link_doc_name}/#{up_link_doc_name}.html##{@up_link_ids[0]}\" class=\"external\" title=\"Linked to\">#{@up_link_ids[0]}</a></td>\n"
             else
                 s += "\t\t<td class=\"item_id\">"
                 s += "<div id=\"DL_#{@id}\" style=\"display: block;\">"
-                s += "<a  href=\"#\" onclick=\"downlink_OnClick(this.parentElement); return false;\" class=\"external\">#{@up_link_ids.length}</a>"
+                s += "<a  href=\"#\" onclick=\"downlink_OnClick(this.parentElement); return false;\" class=\"external\" title=\"Number of up-links\">#{@up_link_ids.length}</a>"
                 s += "</div>"
                 s += "<div id=\"DLS_#{@id}\" style=\"display: none;\">"
                 @up_link_ids.each do |lnk|
                     if tmp = /^([a-zA-Z]+)[-]\d+/.match(lnk)
                         up_link_doc_name = tmp[1].downcase
                     end
-                    s += "\t\t\t<a href=\"./../#{up_link_doc_name}/#{up_link_doc_name}.html##{lnk}\" class=\"external\">#{lnk}</a>\n<br>"
+                    s += "\t\t\t<a href=\"./../#{up_link_doc_name}/#{up_link_doc_name}.html##{lnk}\" class=\"external\" title=\"Linked to\">#{lnk}</a>\n<br>"
                 end
                 s += "</div>"
                 s += "</td>\n"
@@ -59,15 +59,15 @@ class ControlledParagraph < Paragraph
                 down_link_doc_name = tmp[1].downcase
             end
             if @down_links.length == 1
-                s += "\t\t<td class=\"item_id\"><a href=\"./../#{down_link_doc_name}/#{down_link_doc_name}.html##{@down_links[0].id}\" class=\"external\">#{@down_links[0].id}</a></td>\n"
+                s += "\t\t<td class=\"item_id\"><a href=\"./../#{down_link_doc_name}/#{down_link_doc_name}.html##{@down_links[0].id}\" class=\"external\" title=\"Referenced in\">#{@down_links[0].id}</a></td>\n"
             else
                 s += "\t\t<td class=\"item_id\">"
                 s += "<div id=\"DL_#{@id}\" style=\"display: block;\">"
-                s += "<a  href=\"#\" onclick=\"downlink_OnClick(this.parentElement); return false;\" class=\"external\">#{@down_links.length}</a>"
+                s += "<a  href=\"#\" onclick=\"downlink_OnClick(this.parentElement); return false;\" class=\"external\" title=\"Number of references\">#{@down_links.length}</a>"
                 s += "</div>"
                 s += "<div id=\"DLS_#{@id}\" style=\"display: none;\">"
                 @down_links.each do |lnk|
-                    s += "\t\t\t<a href=\"./../#{lnk.parent_doc.id}/#{lnk.parent_doc.id}.html##{lnk.id}\" class=\"external\">#{lnk.id}</a>\n<br>"
+                    s += "\t\t\t<a href=\"./../#{lnk.parent_doc.id}/#{lnk.parent_doc.id}.html##{lnk.id}\" class=\"external\" title=\"Referenced in\">#{lnk.id}</a>\n<br>"
                 end
                 s += "</div>"
                 s += "</td>\n"
@@ -80,7 +80,7 @@ class ControlledParagraph < Paragraph
             if tmp = /^(.+)[.]\d+/.match(@coverage_links[0].id)    # guessing that all the links refer to one document
                 cov_link_doc_name = tmp[1].downcase
             end
-            s += "\t\t<td class=\"item_id\"><a href=\"./../../tests/protocols/#{cov_link_doc_name}/#{cov_link_doc_name}.html\" class=\"external\">#{@coverage_links.length}</a></td>\n"
+            s += "\t\t<td class=\"item_id\"><a href=\"./../../tests/protocols/#{cov_link_doc_name}/#{cov_link_doc_name}.html\" class=\"external\" title=\"Number of verification steps\">#{@coverage_links.length}</a></td>\n"
         else
             s += "\t\t<td class=\"item_id\"></td>\n"
         end

data/lib/almirah/doc_items/controlled_table.rb

@@ -87,10 +87,14 @@ class ControlledTable < DocItem
 
     attr_accessor :column_names
     attr_accessor :rows
+    attr_accessor :is_separator_detected
+
+    def initialize(doc, markdown_table)
+        @parent_doc = doc
+        @parent_heading = doc.headings[-1]
 
-    def initialize(markdown_table, parent_doc)
-        @parent_doc = parent_doc
         @column_names = markdown_table.column_names
+        @is_separator_detected = markdown_table.is_separator_detected
         # copy and re-format existing rows
         @rows = Array.new
 
@@ -151,9 +155,9 @@ class ControlledTable < DocItem
 
     def to_html
         s = ''
-        if @@htmlTableRenderInProgress
+        if @@html_table_render_in_progress
             s += "</table>\n"
-            @@htmlTableRenderInProgress = false
+            @@html_table_render_in_progress = false
         end
                    
         s += "<table class=\"markdown_table\">\n"

data/lib/almirah/doc_items/doc_footer.rb

@@ -7,9 +7,9 @@ class DocFooter < DocItem
 
     def to_html
         s = ''
-        if @@htmlTableRenderInProgress
+        if @@html_table_render_in_progress
             s += "</table>\n"
-            @@htmlTableRenderInProgress = false
+            @@html_table_render_in_progress = false
         end
         return s
     end

data/lib/almirah/doc_items/doc_item.rb

@@ -7,7 +7,7 @@ class DocItem < TextLine
     @parent_doc = nil
     @parent_heading = nil
 
-    @@htmlTableRenderInProgress = false
+    @@html_table_render_in_progress = false
 
     def get_url
         ''

data/lib/almirah/doc_items/heading.rb

@@ -1,98 +1,93 @@
-require_relative "paragraph"
+# frozen_string_literal: true
+
+require_relative 'paragraph'
 
 class Heading < Paragraph
+  attr_accessor :level, :anchor_id, :section_number
 
-    attr_accessor :level
-    attr_accessor :anchor_id
-    attr_accessor :section_number
-
-    @@global_section_number = ""
-
-    def initialize(doc, text, level)
-        @parent_doc = doc
-        @text = text
-        @level = level
-
-        if level != 0 # skip Doc Title
-            if @@global_section_number == ""
-                @@global_section_number = "1"
-                for n in 1..(level-1) do
-                    @@global_section_number += ".1"
-                end
-            else
-                previous_level = @@global_section_number.split(".").length
-
-                if previous_level == level
-
-                    a = @@global_section_number.split(".")
-                    a[-1] = (a[-1].to_i() +1).to_s
-                    @@global_section_number = a.join(".")
-
-                elsif level > previous_level
-
-                    a = @@global_section_number.split(".")
-                    a.push("1")
-                    @@global_section_number = a.join(".")
-                
-                else # level < previous_level
-
-                    a = @@global_section_number.split(".")
-                    delta = previous_level - level
-                    a.pop(delta)
-                    @@global_section_number = a.join(".")
-                    # increment
-                    a = @@global_section_number.split(".")
-                    a[-1] = (a[-1].to_i() +1).to_s
-                    @@global_section_number = a.join(".")
-                end
-            end
-        end
-        @section_number = @@global_section_number
-        @anchor_id = get_anchor_text()
-    end
+  @@global_section_number = ''
+
+  def initialize(doc, text, level)
+    super(doc, text)
+    @level = level
 
-    def get_section_info
-        if level == 0 # Doc Title
-            s = @text
-        else
-            s = @section_number + " " + @text
+    if level != 0 # skip Doc Title
+      if @@global_section_number == ''
+        @@global_section_number = '1'
+        (1..(level - 1)).each do |_n|
+          @@global_section_number += '.1'
         end
-    end
+      else
+        previous_level = @@global_section_number.split('.').length
 
-    def get_anchor_text()
-        s = @section_number + "-" + getTextWithoutSpaces()
-    end
+        if previous_level == level
 
-    def to_html
-        s = ''
-        if @@htmlTableRenderInProgress
-            s += "</table>\n"
-            @@htmlTableRenderInProgress = false
-        end
-        heading_level = level.to_s
-        heading_text = get_section_info()
-        if level == 0
-            heading_level = 1.to_s  # Render Doc Title as a regular h1
-            heading_text = @text    # Doc Title does not have a section number
-        end 
-        s += "<a name=\"#{@anchor_id}\"></a>\n"
-        s += "<h#{heading_level}> #{heading_text} <a href=\"\##{@anchor_id}\" class=\"heading_anchor\">"
-        s += "&para;</a></h#{heading_level}>"
-        return s
-    end
+          a = @@global_section_number.split('.')
+          a[-1] = (a[-1].to_i + 1).to_s
+          @@global_section_number = a.join('.')
 
-    def get_html_link
-        if (@parent_doc.instance_of? Specification)
-            heading_text = get_section_info()
-            s = "<a href= class=\"external\">#{heading_text}</a>"
+        elsif level > previous_level
+
+          a = @@global_section_number.split('.')
+          a.push('1')
+          @@global_section_number = a.join('.')
+
+        else # level < previous_level
+
+          a = @@global_section_number.split('.')
+          delta = previous_level - level
+          a.pop(delta)
+          @@global_section_number = a.join('.')
+          # increment
+          a = @@global_section_number.split('.')
+          a[-1] = (a[-1].to_i + 1).to_s
+          @@global_section_number = a.join('.')
         end
+      end
     end
-
-    def get_url
-        "./specifications/#{parent_doc.id}/#{parent_doc.id}.html\##{@anchor_id}"
+    @section_number = @@global_section_number
+    @anchor_id = get_anchor_text
+  end
+
+  def get_section_info
+    if level.zero? # Doc Title
+      @text
+    else
+      "#{@section_number} #{@text}"
     end
+  end
 
-    def self.reset_global_section_number
-        @@global_section_number = ""
+  def get_anchor_text
+    "#{@section_number}-#{getTextWithoutSpaces}"
+  end
+
+  def get_markdown_anchor_text
+    getTextWithoutSpaces
+  end
+
+  def to_html
+    s = ''
+    if @@html_table_render_in_progress
+      s += "</table>\n"
+      @@html_table_render_in_progress = false
+    end
+    heading_level = level.to_s
+    heading_text = get_section_info
+    if level.zero?
+      heading_level = 1.to_s # Render Doc Title as a regular h1
+      heading_text = @text    # Doc Title does not have a section number
     end
-end
+    s += "<a name=\"#{@anchor_id}\"></a>\n"
+    s += "<h#{heading_level}> #{heading_text} <a href=\"\##{@anchor_id}\" class=\"heading_anchor\">"
+    s += "&para;</a></h#{heading_level}>"
+    s
+  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
+end

data/lib/almirah/doc_items/image.rb

@@ -16,9 +16,9 @@ class Image < DocItem
 
     def to_html
         s = ''
-        if @@htmlTableRenderInProgress
+        if @@html_table_render_in_progress
             s += "</table>\n"
-            @@htmlTableRenderInProgress = false
+            @@html_table_render_in_progress = false
         end
 
         s += "<p style=\"margin-top: 15px;\"><img src=\"#{@path}\" alt=\"#{@text}\" "

data/lib/almirah/doc_items/markdown_list.rb

@@ -1,167 +1,158 @@
-require_relative "doc_item"
+# frozen_string_literal: true
+
+require_relative 'doc_item'
 
 class MarkdownList < DocItem
+  attr_accessor :rows, :text, :is_ordered, :indent_position, :current_nesting_level
 
-    attr_accessor :rows
-    attr_accessor :text
-    attr_accessor :is_ordered
-    attr_accessor :indent_position
-    attr_accessor :current_nesting_level
+  @@lists_stack = []
 
-    @@lists_stack = Array.new
+  def initialize(doc, is_ordered)
+    super()
+    @parent_doc = doc
+    @parent_heading = doc.headings[-1]
 
-    def initialize(doc, is_ordered)
-        @parent_doc = doc
-        @parent_heading = doc.headings[-1]
+    @rows = []
+    @is_ordered = is_ordered
+    @current_nesting_level = 0
+    @indent_position = 0
+    @text = ''
 
-        @rows = Array.new
-        @is_ordered = is_ordered
-        @current_nesting_level = 0
-        @indent_position = 0
-        @text = ''
+    @@lists_stack.push(self)
+  end
 
-        @@lists_stack.push(self)
-    end
+  def addRow(raw_text)
+    pos = calculate_text_position(raw_text)
+    row = raw_text[pos..-1]
 
-    def addRow(raw_text)
-        pos = calculate_text_position(raw_text)
-        row = raw_text[pos..-1]
-
-        pos = calculate_indent_position(raw_text)
-
-        if pos > @@lists_stack[-1].indent_position
-
-            prev_lists_stack_item = @@lists_stack[-1]
-            # the following line pushes new list to the lists_stack in the constructor!
-            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
-            
-            prev_row = prev_lists_stack_item.rows[-1]
-            if prev_row.is_a?(MarkdownList)
-                #cannot be there
-            else
-                nested_list.text = prev_row
-                #puts "Length: " + prev_lists_stack_item.rows.length.to_s
-                prev_lists_stack_item.rows[-1] = nested_list
-            end
-            
-            nested_list.addRow(raw_text)
-
-        elsif pos < @@lists_stack[-1].indent_position
-
-            while pos < @@lists_stack[-1].indent_position
-                @@lists_stack.pop
-            end
-            @@lists_stack[-1].rows.append(row)
-
-        else
-            @@lists_stack[-1].rows.append(row)
+    pos = calculate_indent_position(raw_text)
 
-        end
-    end
+    if pos > @@lists_stack[-1].indent_position
 
-    def calculate_indent_position(s)
-        s.downcase
-        pos = 0
-        s.each_char do |c|
-            if c != ' ' && c != '\t'
-                break
-            end
-            pos += 1
-        end
-        return pos
-    end
-    def calculate_text_position(s)
-        s.downcase
-        pos = 0
-        state = 'looking_for_list_item_marker'
-        s.each_char do |c|
-            if state == 'looking_for_list_item_marker'
-                if c == '*'
-                    state = 'looking_for_space'
-                elsif numeric?(c)
-                    state = 'looking_for_dot'
-                end
-            elsif state == 'looking_for_dot'
-                if c == '.'
-                    state = 'looking_for_space'
-                end
-            elsif state == 'looking_for_space'
-                if c == ' ' || c == '\t'
-                    state = 'looking_for_non_space'
-                end
-            elsif state == 'looking_for_non_space'
-                if c != ' ' || c != '\t'
-                    state = 'list_item_text_pos_found'
-                    break
-                end
-            end
-            pos += 1
-        end
-        return pos
-    end
+      prev_lists_stack_item = @@lists_stack[-1]
+      # the following line pushes new list to the lists_stack in the constructor!
+      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
 
-    def letter?(c)
-        c.match?(/[[:alpha:]]/)
-    end
-      
-    def numeric?(c)
-        c.match?(/[[:digit:]]/)
-    end
+      prev_row = prev_lists_stack_item.rows[-1]
+      if prev_row.is_a?(MarkdownList)
+      # cannot be there
+      else
+        nested_list.text = prev_row
+        # puts "Length: " + prev_lists_stack_item.rows.length.to_s
+        prev_lists_stack_item.rows[-1] = nested_list
+      end
 
-    def non_blank?(c)
-        c.match?(/[[:graph:]]/)
-    end
+      nested_list.addRow(raw_text)
 
-    def self.unordered_list_item?(raw_text)
+    elsif pos < @@lists_stack[-1].indent_position
 
-        if res = /(\*\s?)(.*)/.match(raw_text)
-            return true
-        end
-        return false
-    end
+      @@lists_stack.pop while pos < @@lists_stack[-1].indent_position
+      @@lists_stack[-1].rows.append(row)
 
-    def self.ordered_list_item?(raw_text)
+    else
+      @@lists_stack[-1].rows.append(row)
 
-        if res = /\d[.]\s(.*)/.match(raw_text)
-            return true
-        end
-        return false
     end
+  end
 
-    def to_html
-        s = ''
-        if @@htmlTableRenderInProgress
-            s += "</table>\n"
-            @@htmlTableRenderInProgress = false
-        end
+  def calculate_indent_position(s)
+    s.downcase
+    pos = 0
+    s.each_char do |c|
+      break if c != ' ' && c != '\t'
 
-        if @is_ordered
-            s += "<ol>\n"
-        else
-            s += "<ul>\n"
+      pos += 1
+    end
+    pos
+  end
+
+  def calculate_text_position(s)
+    s.downcase
+    pos = 0
+    state = 'looking_for_list_item_marker'
+    s.each_char do |c|
+      case state
+      when 'looking_for_list_item_marker'
+        if c == '*'
+          state = 'looking_for_space'
+        elsif numeric?(c)
+          state = 'looking_for_dot'
         end
-        
-        @rows.each do |r|
-            if r.is_a?(MarkdownList)
-                f_text = format_string(r.text)
-                s += "\t<li>#{f_text}\n"
-                s += r.to_html()
-                s += "</li>\n"
-            else
-                f_text = format_string(r)
-                #puts f_text
-                s += "\t<li>#{f_text}</li>\n"
-            end
+      when 'looking_for_dot'
+        state = 'looking_for_space' if c == '.'
+      when 'looking_for_space'
+        state = 'looking_for_non_space' if [' ', '\t'].include?(c)
+      when 'looking_for_non_space'
+        if c != ' ' || c != '\t'
+          state = 'list_item_text_pos_found'
+          break
         end
+      end
+      pos += 1
+    end
+    pos
+  end
+
+  def letter?(c)
+    c.match?(/[[:alpha:]]/)
+  end
+
+  def numeric?(c)
+    c.match?(/[[:digit:]]/)
+  end
+
+  def non_blank?(c)
+    c.match?(/[[:graph:]]/)
+  end
+
+  def self.unordered_list_item?(raw_text)
+    res = /(\*\s?)(.*)/.match(raw_text)
+    return true if res
 
-        if @is_ordered
-            s += "</ol>\n"
-        else
-            s += "</ul>\n"
-        end       
+    false
+  end
 
-        return s
+  def self.ordered_list_item?(raw_text)
+    res = /\d[.]\s(.*)/.match(raw_text)
+    return true if res
+
+    false
+  end
+
+  def to_html
+    s = ''
+    if @@html_table_render_in_progress
+      s += "</table>\n"
+      @@html_table_render_in_progress = false
+    end
+
+    s += if @is_ordered
+           "<ol>\n"
+         else
+           "<ul>\n"
+         end
+
+    @rows.each do |r|
+      if r.is_a?(MarkdownList)
+        f_text = format_string(r.text)
+        s += "\t<li>#{f_text}\n"
+        s += r.to_html
+        s += "</li>\n"
+      else
+        f_text = format_string(r)
+        # puts f_text
+        s += "\t<li>#{f_text}</li>\n"
+      end
     end
-end
+
+    s += if @is_ordered
+           "</ol>\n"
+         else
+           "</ul>\n"
+         end
+
+    s
+  end
+end