More

Author: BurdetteLamar

test/rdoc/end_to_end/heading_test.rb

@@ -18,7 +18,7 @@ def test_headings
 ===== Section 2.1.1.1.1
 ====== Section 2.1.1.1.1.1
 MARKUP
-    Helper.run_rdoc(__method__, markup) do |html_lines|
+    Helper.run_rdoc(markup, __method__) do |html_lines|
       heading_lines = Helper.select_lines(html_lines, /^<h\d/)
       # Check count of headings.
       markup_lines = markup.lines

test/rdoc/end_to_end/helper.rb

@@ -6,21 +6,25 @@
 
 class Helper
 
+  # Create temporary directory.
   def self.setup(filestem)
     @dirpath = File.join(Dir.tmpdir, 'MarkupTest-' + filestem)
     FileUtils.rm_rf(@dirpath)
     Dir.mkdir(@dirpath)
   end
 
+  # Remove temporary directory.
   def self.teardown
     FileUtils.rm_rf(@dirpath)
   end
 
+  # Convenience method for selecting lines.
   def self.select_lines(lines, pattern)
     lines.select { |line| line.match(pattern) }
   end
 
-  def self.run_rdoc(method, markup)
+  # Run rdoc for given markup; method is used in setup.
+  def self.run_rdoc(markup, method)
 
     filestem = method.to_s
     self.setup(filestem)

test/rdoc/end_to_end/horizontal_rule_test.rb

@@ -14,12 +14,12 @@ def test_horizontal_rule
 ---
 
 MARKUP
-    Helper.run_rdoc(__method__, markup) do |html_lines|
+    Helper.run_rdoc(markup, __method__) 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.
+      # 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)

test/rdoc/end_to_end/text_markup_test.rb

@@ -34,7 +34,7 @@ def test_italic
 = Heading containing <em>italic phrase</em>.
 
 MARKUP
-    Helper.run_rdoc(__method__, markup) do |html_lines|
+    Helper.run_rdoc(markup, __method__) 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.)
@@ -68,7 +68,7 @@ def test_bold
 = Heading containing <b>bold phrase</b>.
 
 MARKUP
-    Helper.run_rdoc(__method__, markup) do |html_lines|
+    Helper.run_rdoc(markup, __method__) 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.)
@@ -111,7 +111,7 @@ def test_monofont
 = Heading containing <code>monofont phrase</code>.
 
 MARKUP
-    Helper.run_rdoc(__method__, markup) do |html_lines|
+    Helper.run_rdoc(markup, __method__) do |html_lines|
       monofont_word_lines = Helper.select_lines(html_lines, '<code>monofont_word</code>')
       # Check count of monofont words.
       # (Five, not four, b/c the heading generates two.)
@@ -138,7 +138,7 @@ def test_character_conversions
 = Heading containing #{convertible_characters}.
 
 MARKUP
-    Helper.run_rdoc(__method__, markup) do |html_lines|
+    Helper.run_rdoc(markup, __method__) do |html_lines|
       converted_character_lines = Helper.select_lines(html_lines, '© ® … – — ‘foo’ “bar”')
       # Check count of converted character lines.
       # (The generated heading line contains escapes, and so does not match.)