Almirah 0.2.2 → 0.2.4

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 add_row(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.add_row(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

data/lib/almirah/doc_items/markdown_table.rb

@@ -1,59 +1,63 @@
-require_relative "doc_item"
+# frozen_string_literal: true
 
-class MarkdownTable < DocItem
-
-    attr_accessor :column_names
-    attr_accessor :rows
+require_relative 'doc_item'
 
-    def initialize(heading_row)
-        @column_names = heading_row.split('|')
-        @rows = Array.new
+class MarkdownTable < DocItem
+  attr_accessor :column_names, :rows, :heading_row, :is_separator_detected
+
+  def initialize(doc, heading_row)
+    super()
+    @parent_doc = doc
+    @parent_heading = doc.headings[-1]
+    @heading_row = heading_row
+
+    res = /^[|](.*[|])/.match(heading_row)
+    @column_names = if res
+                      res[1].split('|')
+                    else
+                      ['# ERROR# ']
+                    end
+    @rows = []
+    @is_separator_detected = false
+  end
+
+  def add_row(row)
+    columns = row.split('|')
+    @rows.append(columns.map!(&:strip))
+    true
+  end
+
+  def to_html
+    s = ''
+    if @@html_table_render_in_progress
+      s += "</table>\n"
+      @@html_table_render_in_progress = false
     end
 
-    def addRow(row)
-        #check if row contains a link
-        if tmp = /(.*)\s+>\[(\S*)\]/.match(row)
-            return false # this is not a regular Markdown table.
-            # so the table type shall be changed and this row shall be passed one more time
-        end
+    s += "<table class=\"markdown_table\">\n"
+    s += "\t<thead>"
 
-        columns = row.split('|')
-        @rows.append(columns.map!{ |x| x.strip })
-        return true
+    @column_names.each do |h|
+      s += " <th>#{h}</th>"
     end
 
-    def to_html
-        s = ''
-        if @@htmlTableRenderInProgress
-            s += "</table>\n"
-            @@htmlTableRenderInProgress = false
-        end
-                   
-        s += "<table class=\"markdown_table\">\n"
-        s += "\t<thead>" 
-
-        @column_names.each do |h|
-            s += " <th>#{h}</th>"
-        end
+    s += " </thead>\n"
 
-        s += " </thead>\n"
-
-        @rows.each do |row|
-            s += "\t<tr>\n"
-            row.each do |col|
-                if col.to_i > 0 && col.to_i.to_s == col  # autoalign cells with numbers
-                    s += "\t\t<td style=\"text-align: center;\">#{col}</td>\n"
-                else
-                    f_text = format_string(col)
-                    s += "\t\t<td>#{f_text}</td>\n"
-                end
-            end
-            s += "\t</tr>\n"
+    @rows.each do |row|
+      s += "\t<tr>\n"
+      row.each do |col|
+        if col.to_i.positive? && col.to_i.to_s == col  # autoalign cells with numbers
+          s += "\t\t<td style=\"text-align: center;\">#{col}</td>\n"
+        else
+          f_text = format_string(col)
+          s += "\t\t<td>#{f_text}</td>\n"
         end
-
-        s += "</table>\n"
-
-        return s
+      end
+      s += "\t</tr>\n"
     end
 
-end
+    s += "</table>\n"
+
+    s
+  end
+end

data/lib/almirah/doc_items/paragraph.rb

@@ -4,8 +4,10 @@ class Paragraph < DocItem
 
     attr_accessor :text
 
-    def initialize(text)
-        @text = text
+    def initialize(doc, text)
+        @parent_doc = doc
+        @parent_heading = doc.headings[-1]
+        @text = text.strip
     end
 
     def getTextWithoutSpaces
@@ -14,9 +16,9 @@ class Paragraph < DocItem
 
     def to_html
         s = ''
-        if @@htmlTableRenderInProgress
+        if @@html_table_render_in_progress
             s += "</table>"
-            @@htmlTableRenderInProgress = false
+            @@html_table_render_in_progress = false
         end
 
         s += "<p>" + format_string(@text)