End-to-end tests

Author: BurdetteLamar

test/rdoc/end_to_end/heading_test.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+require_relative 'helper'
+
+class HeadingTest < XrefTestCase
+
+  def test_headings
+    markup = <<MARKUP
+= Section 1
+== Section 1.1
+=== Section 1.1.1
+==== Section 1.1.1.1
+===== Section 1.1.1.1.1
+====== Section 1.1.1.1.1.1
+= Section 2
+== Section 2.1
+=== Section 2.1.1
+==== Section 2.1.1.1
+===== Section 2.1.1.1.1
+====== Section 2.1.1.1.1.1
+MARKUP
+    Helper.run_rdoc(__method__, markup) do |html_lines|
+      heading_lines = Helper.select_lines(html_lines, /^<h\d/)
+      # Check count of headings.
+      markup_lines = markup.lines
+      assert_equal(markup_lines.size, heading_lines.size)
+      # Check each markup line against the corresponding heading line.
+      markup_lines.each_with_index do |markup_line, index|
+        heading_line = heading_lines[index]
+        doc = Document.new(heading_line)
+        root_ele = doc.root
+        # Check number of equal signs against the heading level.
+        equal_signs, section_title = markup_line.chomp.split(' ', 2)
+        heading_level = equal_signs.size
+        assert_equal("h#{heading_level}", root_ele.name)
+        # Check the id attribute.
+        id_value = root_ele.attribute('id').value
+        assert_equal("label-#{section_title.gsub(' ', '+')}", id_value)
+      end
+    end
+  end
+
+end

test/rdoc/end_to_end/helper.rb

@@ -0,0 +1,51 @@
+require 'fileutils'
+require 'rexml/document'
+require_relative '../xref_test_case'
+
+include REXML
+
+class Helper
+
+  def self.setup(filestem)
+    @dirpath = File.join(Dir.tmpdir, 'MarkupTest-' + filestem)
+    FileUtils.rm_rf(@dirpath)
+    Dir.mkdir(@dirpath)
+  end
+
+  def self.teardown
+    FileUtils.rm_rf(@dirpath)
+  end
+
+  def self.select_lines(lines, pattern)
+    lines.select { |line| line.match(pattern) }
+  end
+
+  def self.run_rdoc(method, markup)
+
+    filestem = method.to_s
+    self.setup(filestem)
+
+    # Create the markdown file.
+    rdoc_filename = filestem + '.rdoc'
+    rdoc_filepath = File.join(@dirpath, rdoc_filename)
+    File.write(rdoc_filepath, markup)
+
+    # Run rdoc, to create the HTML file.
+    Dir.chdir(@dirpath) do
+      command = "rdoc #{rdoc_filepath}"
+      system(command)
+    end
+
+    # Get the HTML as lines.
+    html_filename = filestem + '_rdoc.html'
+    html_filepath = File.join(@dirpath, 'doc', html_filename)
+    html_lines = File.readlines(html_filepath)
+
+    yield html_lines
+
+    self.teardown
+
+  end
+
+
+end

test/rdoc/end_to_end/horizontal_rule_test.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+require_relative 'helper'
+
+class HorizontalRuleTest < XrefTestCase
+
+  def test_horizontal_rule
+    markup = <<MARKUP
+---
+
+--- Not a horizontal rule.
+
+-- Not a horizontal rule.
+
+---
+
+MARKUP
+    Helper.run_rdoc(__method__, markup) do |html_lines|
+      # Check count of horizontal rules.
+      hr_lines = Helper.select_lines(html_lines, '<hr>')
+      assert_equal(2, hr_lines.size)
+      # Check count of not horizontal rules.
+      # One of the above generates an M dash, the other an N dash.
+      pattern = /<p>(—|–) Not a horizontal rule.<\/p>/
+      not_hr_lines = html_lines.select {|line| line.match(pattern) }
+      assert_equal(2, not_hr_lines.size)
+    end
+  end
+
+end

test/rdoc/end_to_end/text_markup_test.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+require_relative 'helper'
+
+class TextMarkupTest < XrefTestCase
+
+  def test_italic
+    markup = <<MARKUP
+
+Paragraph containing _italic_word_.
+
+>>>
+  Block quote containing _italic_word_.
+
+- List item containing _italic_word_.
+
+= Heading containing _italic_word_.
+
+Paragraph containing <i>italic phrase</i>.
+
+>>>
+  Block quote containing <i>italic phrase</i>.
+
+- List item containing <i>italic phrase</i>.
+
+= Heading containing <i>italic phrase</i>.
+
+Paragraph containing <em>italic phrase</em>.
+
+>>>
+  Block quote containing <em>italic phrase</em>.
+
+- List item containing <em>italic phrase</em>.
+
+= Heading containing <em>italic phrase</em>.
+
+MARKUP
+    Helper.run_rdoc(__method__, markup) do |html_lines|
+      italic_word_lines = Helper.select_lines(html_lines, '<em>italic_word</em>')
+      # Check count of italic words.
+      # (Five, not four, b/c the heading generates two.)
+      assert_equal(5, italic_word_lines.size)
+      italic_phrase_lines = Helper.select_lines(html_lines, '<em>italic phrase</em>')
+      # Check count of italic phrases.
+      # (Ten, not eight, b/c each heading generates two.)
+      assert_equal(10, italic_phrase_lines.size)
+    end
+  end
+
+  def test_bold
+    markup = <<MARKUP
+
+Paragraph containing *bold_word*.
+
+>>>
+  Block quote containing *bold_word*.
+
+- List item containing *bold_word*.
+
+= Heading containing *bold_word*.
+
+Paragraph containing <tt>bold phrase</tt>.
+
+>>>
+  Block quote containing <tt>bold phrase</tt>.
+
+- List item containing <tt>bold phrase</tt>.
+
+= Heading containing <tt>bold phrase</tt>.
+
+MARKUP
+    Helper.run_rdoc(__method__, markup) do |html_lines|
+      # Check count of bold words.
+      bold_word_lines = Helper.select_lines(html_lines, '<strong>bold_word</strong>')
+      # (Five, not four, b/c the heading generates two.)
+      assert_equal(5, bold_word_lines.size)
+      # Check count of bold phrases.
+      bold_phrase_lines = Helper.select_lines(html_lines, '<strong>bold phrase</strong>')
+      # (Five, not four, b/c the heading generates two.)
+      assert_equal(5, bold_word_lines.size)
+    end
+  end
+
+end