rdoc 3.12.2 → 4.0.0.preview2

data/test/test_rdoc_cross_reference.rb

@@ -130,7 +130,7 @@ class TestRDocCrossReference < XrefTestCase
   end
 
   def test_resolve_page
-    page = RDoc::TopLevel.new 'README.txt'
+    page = @store.add_file 'README.txt'
     page.parser = RDoc::Parser::Simple
 
     assert_ref page, 'README'

data/test/test_rdoc_encoding.rb

@@ -53,7 +53,7 @@ class TestRDocEncoding < RDoc::TestCase
 
     contents = :junk
 
-    _, err = capture_io do
+    _, err = verbose_capture_io do
       contents = RDoc::Encoding.read_file @tempfile.path, Encoding::US_ASCII
     end
 
@@ -97,6 +97,22 @@ class TestRDocEncoding < RDoc::TestCase
     assert_equal Encoding::UTF_8, content.encoding
   end
 
+  def test_class_read_file_encoding_invalid
+    skip "Encoding not implemented" unless Object.const_defined? :Encoding
+
+    @tempfile.write "# coding: ascii\nM\xE4r"
+    @tempfile.flush
+
+    contents = :junk
+    _, err = verbose_capture_io do
+      contents = RDoc::Encoding.read_file @tempfile.path, Encoding::UTF_8
+    end
+
+    assert_equal "unable to convert \"\\xE4\" on US-ASCII for #{@tempfile.path}, skipping\n", err
+
+    assert_nil contents
+  end
+
   def test_class_read_file_encoding_with_signature
     skip "Encoding not implemented" unless defined? ::Encoding
 

data/test/test_rdoc_extend.rb

@@ -0,0 +1,94 @@
+require File.expand_path '../xref_test_case', __FILE__
+
+class TestRDocExtend < XrefTestCase
+
+  def setup
+    super
+
+    @ext = RDoc::Extend.new 'M1', 'comment'
+    @ext.parent = @m1
+    @ext.store = @store
+  end
+
+  def test_module
+    assert_equal @m1, @ext.module
+    assert_equal 'Unknown', RDoc::Extend.new('Unknown', 'comment').module
+  end
+
+  def test_module_extended
+    m1 = @xref_data.add_module RDoc::NormalModule, 'Mod1'
+                  m1.add_module RDoc::NormalModule, 'Mod3'
+    m1_m2       = m1.add_module RDoc::NormalModule, 'Mod2'
+    m1_m2_m3    = m1_m2.add_module RDoc::NormalModule, 'Mod3'
+                  m1_m2_m3.add_module RDoc::NormalModule, 'Mod4'
+                  m1_m2.add_module RDoc::NormalModule, 'Mod4'
+    m1_m2_k0    = m1_m2.add_class RDoc::NormalClass, 'Klass0'
+    m1_m2_k0_m4 = m1_m2_k0.add_module RDoc::NormalModule, 'Mod4'
+                  m1_m2_k0_m4.add_module RDoc::NormalModule, 'Mod6'
+                  m1_m2_k0.add_module RDoc::NormalModule, 'Mod5'
+
+    e0_m4 = RDoc::Extend.new 'Mod4', nil
+    e0_m5 = RDoc::Extend.new 'Mod5', nil
+    e0_m6 = RDoc::Extend.new 'Mod6', nil
+    e0_m1 = RDoc::Extend.new 'Mod1', nil
+    e0_m2 = RDoc::Extend.new 'Mod2', nil
+    e0_m3 = RDoc::Extend.new 'Mod3', nil
+
+    m1_m2_k0.add_extend e0_m4
+    m1_m2_k0.add_extend e0_m5
+    m1_m2_k0.add_extend e0_m6
+    m1_m2_k0.add_extend e0_m1
+    m1_m2_k0.add_extend e0_m2
+    m1_m2_k0.add_extend e0_m3
+
+    assert_equal [e0_m4, e0_m5, e0_m6, e0_m1, e0_m2, e0_m3], m1_m2_k0.extends
+    assert_equal ['Object'], m1_m2_k0.ancestors
+
+    m1_k1 = m1.add_class RDoc::NormalClass, 'Klass1'
+
+    e1_m1 = RDoc::Extend.new 'Mod1', nil
+    e1_m2 = RDoc::Extend.new 'Mod2', nil
+    e1_m3 = RDoc::Extend.new 'Mod3', nil
+    e1_m4 = RDoc::Extend.new 'Mod4', nil
+    e1_k0_m4 = RDoc::Extend.new 'Klass0::Mod4', nil
+
+    m1_k1.add_extend e1_m1
+    m1_k1.add_extend e1_m2
+    m1_k1.add_extend e1_m3
+    m1_k1.add_extend e1_m4
+    m1_k1.add_extend e1_k0_m4
+
+    assert_equal [e1_m1, e1_m2, e1_m3, e1_m4, e1_k0_m4], m1_k1.extends
+    assert_equal ['Object'], m1_k1.ancestors
+
+    m1_k2 = m1.add_class RDoc::NormalClass, 'Klass2'
+
+    e2_m1 = RDoc::Extend.new 'Mod1', nil
+    e2_m2 = RDoc::Extend.new 'Mod2', nil
+    e2_m3 = RDoc::Extend.new 'Mod3', nil
+    e2_k0_m4 = RDoc::Extend.new 'Klass0::Mod4', nil
+
+    m1_k2.add_extend e2_m1
+    m1_k2.add_extend e2_m3
+    m1_k2.add_extend e2_m2
+    m1_k2.add_extend e2_k0_m4
+
+    assert_equal [e2_m1, e2_m3, e2_m2, e2_k0_m4], m1_k2.extends
+    assert_equal ['Object'], m1_k2.ancestors
+
+    m1_k3 = m1.add_class RDoc::NormalClass, 'Klass3'
+
+    e3_m1 = RDoc::Extend.new 'Mod1', nil
+    e3_m2 = RDoc::Extend.new 'Mod2', nil
+    e3_m4 = RDoc::Extend.new 'Mod4', nil
+
+    m1_k3.add_extend e3_m1
+    m1_k3.add_extend e3_m2
+    m1_k3.add_extend e3_m4
+
+    assert_equal [e3_m1, e3_m2, e3_m4], m1_k3.extends
+    assert_equal ['Object'], m1_k3.ancestors
+  end
+
+end
+

data/test/test_rdoc_generator_darkfish.rb

@@ -24,17 +24,21 @@ class TestRDocGeneratorDarkfish < RDoc::TestCase
       break
     end
 
-    rd = RDoc::RDoc.new
-    rd.options = @options
-    RDoc::RDoc.current = rd
+    @rdoc.options = @options
 
-    @g = @options.generator.new @options
+    @g = @options.generator.new @store, @options
+    @rdoc.generator = @g
 
-    rd.generator = @g
-
-    @top_level = RDoc::TopLevel.new 'file.rb'
+    @top_level = @store.add_file 'file.rb'
     @top_level.parser = RDoc::Parser::Ruby
-    @klass = @top_level.add_class RDoc::NormalClass, 'Object'
+    @klass = @top_level.add_class RDoc::NormalClass, 'Klass'
+
+    @alias_constant = RDoc::Constant.new 'A', nil, ''
+    @alias_constant.record_location @top_level
+
+    @top_level.add_constant @alias_constant
+
+    @klass.add_module_alias @klass, 'A', @top_level
 
     @meth = RDoc::AnyMethod.new nil, 'method'
     @meth_bang = RDoc::AnyMethod.new nil, 'method!'
@@ -46,6 +50,11 @@ class TestRDocGeneratorDarkfish < RDoc::TestCase
 
     @ignored = @top_level.add_class RDoc::NormalClass, 'Ignored'
     @ignored.ignore
+
+    @store.complete :private
+
+    @object      = @store.find_class_or_module 'Object'
+    @klass_alias = @store.find_class_or_module 'Klass::A'
   end
 
   def teardown
@@ -64,11 +73,18 @@ class TestRDocGeneratorDarkfish < RDoc::TestCase
     refute File.exist?(path), "#{path} exists"
   end
 
+  def mu_pp obj
+    s = ''
+    s = PP.pp obj, s
+    s = s.force_encoding Encoding.default_external if defined? Encoding
+    s.chomp
+  end
+
   def test_generate
-    top_level = RDoc::TopLevel.new 'file.rb'
+    top_level = @store.add_file 'file.rb'
     top_level.add_class @klass.class, @klass.name
 
-    @g.generate [top_level]
+    @g.generate
 
     assert_file 'index.html'
     assert_file 'Object.html'
@@ -76,7 +92,7 @@ class TestRDocGeneratorDarkfish < RDoc::TestCase
     assert_file 'js/search_index.js'
 
     encoding = if Object.const_defined? :Encoding then
-                 Regexp.escape Encoding.default_external.name
+                 Regexp.escape Encoding::UTF_8.name
                else
                  Regexp.escape 'UTF-8'
                end
@@ -90,11 +106,11 @@ class TestRDocGeneratorDarkfish < RDoc::TestCase
   end
 
   def test_generate_dry_run
-    @options.dry_run = true
-    top_level = RDoc::TopLevel.new 'file.rb'
+    @g.dry_run = true
+    top_level = @store.add_file 'file.rb'
     top_level.add_class @klass.class, @klass.name
 
-    @g.generate [top_level]
+    @g.generate
 
     refute_file 'index.html'
     refute_file 'Object.html'
@@ -111,7 +127,7 @@ class TestRDocGeneratorDarkfish < RDoc::TestCase
       File.expand_path('file/file.txt'),
     ]
 
-    @g.generate [@top_level]
+    @g.generate
 
     assert_file 'images/image.png'
     assert_file 'file.txt'
@@ -122,17 +138,27 @@ class TestRDocGeneratorDarkfish < RDoc::TestCase
     FileUtils.touch 'static/image.png'
 
     @options.static_path = [File.expand_path('static')]
-    @options.dry_run = true
+    @g.dry_run = true
 
-    @g.generate [@top_level]
+    @g.generate
 
     refute_file 'image.png'
   end
 
+  def test_setup
+    @g.setup
+
+    assert_equal [@klass_alias, @ignored, @klass, @object],
+                 @g.classes.sort_by { |klass| klass.full_name }
+    assert_equal [@top_level],                           @g.files
+    assert_equal [@meth, @meth, @meth_bang, @meth_bang], @g.methods
+    assert_equal [@klass_alias, @klass, @object], @g.modsort
+  end
+
   def test_template_for
     classpage = Pathname.new @options.template_dir + 'class.rhtml'
 
-    template = @g.send(:template_for, classpage)
+    template = @g.send(:template_for, classpage, true, RDoc::ERBIO)
     assert_kind_of RDoc::ERBIO, template
 
     assert_same template, @g.send(:template_for, classpage)
@@ -141,7 +167,7 @@ class TestRDocGeneratorDarkfish < RDoc::TestCase
   def test_template_for_dry_run
     classpage = Pathname.new @options.template_dir + 'class.rhtml'
 
-    template = @g.send(:template_for, classpage)
+    template = @g.send(:template_for, classpage, true, ERB)
     assert_kind_of ERB, template
 
     assert_same template, @g.send(:template_for, classpage)

data/test/test_rdoc_generator_json_index.rb

@@ -19,15 +19,13 @@ class TestRDocGeneratorJsonIndex < RDoc::TestCase
     @options.option_parser = OptionParser.new
     @options.finish
 
-    @darkfish = RDoc::Generator::Darkfish.new @options
+    @darkfish = RDoc::Generator::Darkfish.new @store, @options
     @g = RDoc::Generator::JsonIndex.new @darkfish, @options
 
-    @rdoc = RDoc::RDoc.new
     @rdoc.options = @options
     @rdoc.generator = @g
-    RDoc::RDoc.current = @rdoc
 
-    @top_level = RDoc::TopLevel.new 'file.rb'
+    @top_level = @store.add_file 'file.rb'
     @top_level.parser = RDoc::Parser::Ruby
 
     @klass = @top_level.add_class RDoc::NormalClass, 'C'
@@ -43,7 +41,7 @@ class TestRDocGeneratorJsonIndex < RDoc::TestCase
     @ignored = @top_level.add_class RDoc::NormalClass, 'Ignored'
     @ignored.ignore
 
-    @page = RDoc::TopLevel.new 'page.rdoc'
+    @page = @store.add_file 'page.rdoc'
     @page.parser = RDoc::Parser::Simple
 
     @top_levels = [@top_level, @page].sort
@@ -70,6 +68,28 @@ class TestRDocGeneratorJsonIndex < RDoc::TestCase
     s.chomp
   end
 
+  def test_build_index
+    index = @g.build_index
+
+    expected = {
+      :index => {
+        :searchIndex     => %w[c d meth() meth() page],
+        :longSearchIndex => %w[c c::d c#meth() c::d#meth()],
+        :info            => [
+          @klass.search_record[2..-1],
+          @nest_klass.search_record[2..-1],
+          @meth.search_record[2..-1],
+          @nest_meth.search_record[2..-1],
+          @page.search_record[2..-1],
+        ],
+      },
+    }
+
+    expected[:index][:longSearchIndex] << ''
+
+    assert_equal expected, index
+  end
+
   def test_class_dir
     assert_equal @darkfish.class_dir, @g.class_dir
   end
@@ -79,7 +99,7 @@ class TestRDocGeneratorJsonIndex < RDoc::TestCase
   end
 
   def test_generate
-    @g.generate @top_levels
+    @g.generate
 
     assert_file 'js/searcher.js'
     assert_file 'js/navigation.js'
@@ -134,7 +154,7 @@ class TestRDocGeneratorJsonIndex < RDoc::TestCase
     text.force_encoding Encoding::ISO_8859_1
     @klass.add_comment comment(text), @top_level
 
-    @g.generate @top_levels
+    @g.generate
 
     json = File.read 'js/search_index.js'
     json.force_encoding Encoding::UTF_8

data/test/test_rdoc_generator_markup.rb

@@ -5,17 +5,17 @@ class TestRDocGeneratorMarkup < RDoc::TestCase
   include RDoc::Text
   include RDoc::Generator::Markup
 
+  attr_reader :store
+
   def setup
     super
 
     @options = RDoc::Options.new
-    @rdoc = RDoc::RDoc.new
     @rdoc.options = @options
+
     @parent = self
     @path = '/index.html'
     @symbols = {}
-
-    RDoc::RDoc.current = @rdoc
   end
 
   def test_aref_to

data/test/test_rdoc_generator_ri.rb

@@ -6,14 +6,17 @@ class TestRDocGeneratorRI < RDoc::TestCase
     super
 
     @options = RDoc::Options.new
-    @options.encoding = Encoding::UTF_8 if Object.const_defined? :Encoding
+    if Object.const_defined? :Encoding then
+      @options.encoding = Encoding::UTF_8
+      @store.encoding = Encoding::UTF_8
+    end
 
     @tmpdir = File.join Dir.tmpdir, "test_rdoc_generator_ri_#{$$}"
     FileUtils.mkdir_p @tmpdir
 
-    @g = RDoc::Generator::RI.new @options
+    @g = RDoc::Generator::RI.new @store, @options
 
-    @top_level = RDoc::TopLevel.new 'file.rb'
+    @top_level = @store.add_file 'file.rb'
     @klass = @top_level.add_class RDoc::NormalClass, 'Object'
 
     @meth = RDoc::AnyMethod.new nil, 'method'
@@ -48,7 +51,7 @@ class TestRDocGeneratorRI < RDoc::TestCase
   end
 
   def test_generate
-    @g.generate nil
+    @g.generate
 
     assert_file File.join(@tmpdir, 'cache.ri')
 
@@ -67,16 +70,15 @@ class TestRDocGeneratorRI < RDoc::TestCase
   end
 
   def test_generate_dry_run
-    @options.dry_run = true
-    @g = RDoc::Generator::RI.new @options
+    @store.dry_run = true
+    @g = RDoc::Generator::RI.new @store, @options
 
-    top_level = RDoc::TopLevel.new 'file.rb'
+    top_level = @store.add_file 'file.rb'
     top_level.add_class @klass.class, @klass.name
 
-    @g.generate nil
+    @g.generate
 
     refute_file File.join(@tmpdir, 'cache.ri')
-
     refute_file File.join(@tmpdir, 'Object')
   end
 

data/test/test_rdoc_include.rb

@@ -7,6 +7,8 @@ class TestRDocInclude < XrefTestCase
 
     @inc = RDoc::Include.new 'M1', 'comment'
     @inc.parent = @m1
+    @inc.record_location @top_level
+    @inc.store = @store
   end
 
   def test_module
@@ -92,5 +94,15 @@ class TestRDocInclude < XrefTestCase
     assert_equal [m1_m2_m4, m1_m2, m1, 'Object'], m1_k3.ancestors
   end
 
+  def test_store_equals
+    incl = RDoc::Include.new 'M', nil
+    incl.record_location RDoc::TopLevel.new @top_level.name
+
+    incl.store = @store
+
+    assert_same @top_level, incl.file
+    assert_same @store,     incl.file.store
+  end
+
 end
 

data/test/test_rdoc_markdown.rb

@@ -0,0 +1,977 @@
+# coding: UTF-8
+
+require 'rubygems'
+require 'minitest/autorun'
+require 'pp'
+
+require 'rdoc'
+require 'rdoc/markup/block_quote'
+require 'rdoc/markdown'
+
+class TestRDocMarkdown < RDoc::TestCase
+
+  def setup
+    @RM = RDoc::Markup
+
+    @parser = RDoc::Markdown.new
+  end
+
+  def mu_pp obj
+    s = ''
+    s = PP.pp obj, s
+    s.force_encoding Encoding.default_external if defined? Encoding
+    s.chomp
+  end
+
+  def test_class_parse
+    doc = RDoc::Markdown.parse "hello\n\nworld"
+
+    expected = doc(para("hello"), para("world"))
+
+    assert_equal expected, doc
+  end
+
+  def test_emphasis
+    assert_equal '_word_',             @parser.emphasis('word')
+    assert_equal '<em>two words</em>', @parser.emphasis('two words')
+    assert_equal '<em>*bold*</em>',    @parser.emphasis('*bold*')
+  end
+
+  def test_parse_auto_link_email
+    doc = parse "Autolink: <nobody-0+_./!%~$@example>"
+
+    expected = doc(para("Autolink: mailto:nobody-0+_./!%~$@example"))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_auto_link_url
+    doc = parse "Autolink: <http://example>"
+
+    expected = doc(para("Autolink: http://example"))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_block_quote
+    doc = parse <<-BLOCK_QUOTE
+> this is
+> a block quote
+    BLOCK_QUOTE
+
+    expected =
+      doc(
+        block(
+          para("this is\na block quote")))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_block_quote_continue
+    doc = parse <<-BLOCK_QUOTE
+> this is
+a block quote
+    BLOCK_QUOTE
+
+    expected =
+      doc(
+        block(
+          para("this is\na block quote")))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_block_quote_list
+    doc = parse <<-BLOCK_QUOTE
+> text
+>
+> * one
+> * two
+    BLOCK_QUOTE
+
+    expected =
+      doc(
+        block(
+          para("text"),
+          list(:BULLET,
+            item(nil, para("one")),
+            item(nil, para("two")))))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_block_quote_newline
+    doc = parse <<-BLOCK_QUOTE
+> this is
+a block quote
+
+    BLOCK_QUOTE
+
+    expected =
+      doc(
+        block(
+          para("this is\na block quote")))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_block_quote_separate
+    doc = parse <<-BLOCK_QUOTE
+> this is
+a block quote
+
+> that continues
+    BLOCK_QUOTE
+
+    expected =
+      doc(
+        block(
+          para("this is\na block quote"),
+          para("that continues")))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_char_entity
+    doc = parse '&pi; &nn;'
+
+    expected = doc(para('π &nn;'))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_code
+    doc = parse "Code: `text`"
+
+    expected = doc(para("Code: <code>text</code>"))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_code_github
+    doc = parse <<-MD
+Example:
+
+```
+code goes here
+```
+    MD
+
+    expected =
+      doc(
+        para("Example:"),
+        verb("code goes here\n"))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_code_github_format
+    doc = parse <<-MD
+Example:
+
+``` ruby
+code goes here
+```
+    MD
+
+    code = verb("code goes here\n")
+    code.format = :ruby
+
+    expected =
+      doc(
+        para("Example:"),
+        code)
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_definition_list
+    doc = parse <<-MD
+one
+:   This is a definition
+
+two
+:   This is another definition
+    MD
+
+    expected = doc(
+      list(:NOTE,
+        item(%w[one], para("This is a definition")),
+        item(%w[two], para("This is another definition"))))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_definition_list_indents
+    doc = parse <<-MD
+zero
+: Indented zero characters
+
+one
+ : Indented one characters
+
+two
+  : Indented two characters
+
+three
+   : Indented three characters
+
+four
+    : Indented four characters
+
+    MD
+
+    expected = doc(
+      list(:NOTE,
+        item(%w[zero],  para("Indented zero characters")),
+        item(%w[one],   para("Indented one characters")),
+        item(%w[two],   para("Indented two characters")),
+        item(%w[three], para("Indented three characters"))),
+      para("four\n : Indented four characters"))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_definition_list_multi_description
+    doc = parse <<-MD
+label
+:   This is a definition
+
+:   This is another definition
+    MD
+
+    expected = doc(
+      list(:NOTE,
+        item(%w[label], para("This is a definition")),
+        item(nil,       para("This is another definition"))))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_definition_list_multi_label
+    doc = parse <<-MD
+one
+two
+:   This is a definition
+    MD
+
+    expected = doc(
+      list(:NOTE,
+        item(%w[one two], para("This is a definition"))))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_definition_list_multi_line
+    doc = parse <<-MD
+one
+:   This is a definition
+that extends to two lines
+
+two
+:   This is another definition
+that also extends to two lines
+    MD
+
+    expected = doc(
+      list(:NOTE,
+        item(%w[one],
+          para("This is a definition\nthat extends to two lines")),
+        item(%w[two],
+          para("This is another definition\nthat also extends to two lines"))))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_definition_list_no
+    @parser.definition_lists = false
+
+    doc = parse <<-MD
+one
+:   This is a definition
+
+two
+:   This is another definition
+    MD
+
+    expected = doc(
+        para("one\n: This is a definition"),
+        para("two\n: This is another definition"))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_entity_dec
+    doc = parse "Entity: &#65;"
+
+    expected = doc(para("Entity: A"))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_entity_hex
+    doc = parse "Entity: &#x41;"
+
+    expected = doc(para("Entity: A"))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_entity_named
+    doc = parse "Entity: &pi;"
+
+    expected = doc(para("Entity: π"))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_emphasis_star
+    doc = parse "it *works*\n"
+
+    expected = @RM::Document.new(
+      @RM::Paragraph.new("it _works_"))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_emphasis_underscore
+    doc = parse "it _works_\n"
+
+    expected =
+      doc(
+        para("it _works_"))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_emphasis_underscore_embedded
+    doc = parse "foo_bar bar_baz\n"
+
+    expected =
+      doc(
+        para("foo_bar bar_baz"))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_emphasis_underscore_in_word
+    doc = parse "it foo_bar_baz\n"
+
+    expected =
+      doc(
+        para("it foo_bar_baz"))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_escape
+    assert_equal doc(para("Backtick: `")), parse("Backtick: \\`")
+
+    assert_equal doc(para("Backslash: \\")), parse("Backslash: \\\\")
+
+    assert_equal doc(para("Colon: :")), parse("Colon: \\:")
+  end
+
+  def test_parse_heading_atx
+    doc = parse "# heading\n"
+
+    expected = @RM::Document.new(
+      @RM::Heading.new(1, "heading"))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_heading_setext_dash
+    doc = parse <<-MD
+heading
+---
+    MD
+
+    expected = @RM::Document.new(
+      @RM::Heading.new(2, "heading"))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_heading_setext_equals
+    doc = parse <<-MD
+heading
+===
+    MD
+
+    expected = @RM::Document.new(
+      @RM::Heading.new(1, "heading"))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_html
+    @parser.html = true
+
+    doc = parse "<address>Links here</address>\n"
+
+    expected = doc(
+      @RM::Raw.new("<address>Links here</address>"))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_html_hr
+    @parser.html = true
+
+    doc = parse "<hr>\n"
+
+    expected = doc(raw("<hr>"))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_html_no_html
+    @parser.html = false
+
+    doc = parse "<address>Links here</address>\n"
+
+    expected = doc()
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_image
+    doc = parse "image ![alt text](path/to/image.jpg)"
+
+    expected = doc(para("image {alt text}[path/to/image.jpg]"))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_line_break
+    doc = parse "Some text  \nwith extra lines"
+
+    expected = doc(
+      para("Some text", hard_break, "with extra lines"))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_link_reference_id
+    doc = parse <<-MD
+This is [an example][id] reference-style link.
+
+[id]: http://example.com "Optional Title Here"
+    MD
+
+    expected = doc(
+      para("This is {an example}[http://example.com] reference-style link."))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_link_reference_id_adjacent
+    doc = parse <<-MD
+[this] [this] should work
+
+[this]: example
+    MD
+
+    expected = doc(
+      para("{this}[example] should work"))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_link_reference_id_eof
+    doc = parse <<-MD.chomp
+This is [an example][id] reference-style link.
+
+[id]: http://example.com "Optional Title Here"
+    MD
+
+    expected = doc(
+      para("This is {an example}[http://example.com] reference-style link."))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_link_reference_id_many
+    doc = parse <<-MD
+This is [an example][id] reference-style link.
+
+And [another][id].
+
+[id]: http://example.com "Optional Title Here"
+    MD
+
+    expected = doc(
+      para("This is {an example}[http://example.com] reference-style link."),
+      para("And {another}[http://example.com]."))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_link_reference_implicit
+    doc = parse <<-MD
+This is [an example][] reference-style link.
+
+[an example]: http://example.com "Optional Title Here"
+    MD
+
+    expected = doc(
+      para("This is {an example}[http://example.com] reference-style link."))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_list_bullet
+    doc = parse <<-MD
+* one
+* two
+    MD
+
+    expected = doc(
+      list(:BULLET,
+        item(nil, para("one")),
+        item(nil, para("two"))))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_list_bullet_auto_link
+    doc = parse <<-MD
+* <http://example/>
+    MD
+
+    expected = doc(
+      list(:BULLET,
+        item(nil, para("http://example/"))))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_list_bullet_continue
+    doc = parse <<-MD
+* one
+
+* two
+    MD
+
+    expected = doc(
+      list(:BULLET,
+        item(nil, para("one")),
+        item(nil, para("two"))))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_list_bullet_multiline
+    doc = parse <<-MD
+* one
+  two
+    MD
+
+    expected = doc(
+      list(:BULLET,
+        item(nil, para("one\n two"))))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_list_bullet_nest
+    doc = parse <<-MD
+* outer
+    * inner
+    MD
+
+    expected = doc(
+      list(:BULLET,
+        item(nil,
+          para("outer"),
+          list(:BULLET,
+            item(nil,
+              para("inner"))))))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_list_bullet_nest_loose
+    doc = parse <<-MD
+* outer
+
+    * inner
+    MD
+
+    expected = doc(
+      list(:BULLET,
+        item(nil,
+          para("outer"),
+          list(:BULLET,
+            item(nil, para("inner"))))))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_list_bullet_nest_continue
+    doc = parse <<-MD
+* outer
+    * inner
+  continue inner
+* outer 2
+    MD
+
+    expected = doc(
+      list(:BULLET,
+        item(nil,
+          para("outer"),
+          list(:BULLET,
+            item(nil,
+              para("inner\n continue inner")))),
+        item(nil,
+          para("outer 2"))))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_list_number
+    doc = parse <<-MD
+1. one
+1. two
+    MD
+
+    expected = doc(
+      list(:NUMBER,
+        item(nil, para("one")),
+        item(nil, para("two"))))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_list_number_continue
+    doc = parse <<-MD
+1. one
+
+1. two
+    MD
+
+    expected = doc(
+      list(:NUMBER,
+        item(nil, para("one")),
+        item(nil, para("two"))))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_note
+    @parser.notes = true
+
+    doc = parse <<-MD
+Some text.[^1]
+
+[^1]: With a footnote
+    MD
+
+    expected = doc(
+      para("Some text.{*1}[rdoc-label:foottext-1:footmark-1]"),
+      @RM::Rule.new(1),
+      para("{^1}[rdoc-label:footmark-1:foottext-1] With a footnote"))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_note_indent
+    @parser.notes = true
+
+    doc = parse <<-MD
+Some text.[^1]
+
+[^1]: With a footnote
+
+    more
+    MD
+
+    expected = doc(
+      para("Some text.{*1}[rdoc-label:foottext-1:footmark-1]"),
+      rule(1),
+      para("{^1}[rdoc-label:footmark-1:foottext-1] With a footnote\n\nmore"))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_note_inline
+    @parser.notes = true
+
+    doc = parse <<-MD
+Some text. ^[With a footnote]
+    MD
+
+    expected = doc(
+      para("Some text. {*1}[rdoc-label:foottext-1:footmark-1]"),
+      @RM::Rule.new(1),
+      para("{^1}[rdoc-label:footmark-1:foottext-1] With a footnote"))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_note_no_notes
+    @parser.notes = false
+
+    assert_raises RuntimeError do # TODO use a real error
+      parse "Some text.[^1]"
+    end
+  end
+
+  def test_parse_note_multiple
+    @parser.notes = true
+
+    doc = parse <<-MD
+Some text[^1]
+with inline notes^[like this]
+and an extra note.[^2]
+
+[^1]: With a footnote
+
+[^2]: Which should be numbered correctly
+    MD
+
+    expected = doc(
+      para("Some text{*1}[rdoc-label:foottext-1:footmark-1]\n" +
+           "with inline notes{*2}[rdoc-label:foottext-2:footmark-2]\n" +
+           "and an extra note.{*3}[rdoc-label:foottext-3:footmark-3]"),
+
+      rule(1),
+
+      para("{^1}[rdoc-label:footmark-1:foottext-1] With a footnote"),
+      para("{^2}[rdoc-label:footmark-2:foottext-2] like this"),
+      para("{^3}[rdoc-label:footmark-3:foottext-3] " +
+           "Which should be numbered correctly"))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_paragraph
+    doc = parse "it worked\n"
+
+    expected = doc(para("it worked"))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_paragraph_break_on_newline
+    @parser.break_on_newline = true
+
+    doc = parse "one\ntwo\n"
+
+    expected = doc(para("one", hard_break, "two"))
+
+    assert_equal expected, doc
+
+    doc = parse "one  \ntwo\nthree\n"
+
+    expected = doc(para("one", hard_break, "two", hard_break, "three"))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_paragraph_stars
+    doc = parse "it worked ****\n"
+
+    expected = @RM::Document.new(
+      @RM::Paragraph.new("it worked ****"))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_paragraph_html
+    @parser.html = true
+
+    doc = parse "<address>Links here</address>"
+
+    expected = doc(raw("<address>Links here</address>"))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_paragraph_html_no_html
+    @parser.html = false
+
+    doc = parse "<address>Links here</address>"
+
+    expected = doc()
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_paragraph_indent_one
+    doc = parse <<-MD
+ text
+    MD
+
+    expected = doc(para("text"))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_paragraph_indent_two
+    doc = parse <<-MD
+  text
+    MD
+
+    expected = doc(para("text"))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_paragraph_indent_three
+    doc = parse <<-MD
+   text
+    MD
+
+    expected = doc(para("text"))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_paragraph_multiline
+    doc = parse "one\ntwo"
+
+    expected = doc(para("one\ntwo"))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_paragraph_two
+    doc = parse "one\n\ntwo"
+
+    expected = @RM::Document.new(
+      @RM::Paragraph.new("one"),
+      @RM::Paragraph.new("two"))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_plain
+    doc = parse "it worked"
+
+    expected = @RM::Document.new(
+      @RM::Paragraph.new("it worked"))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_reference_link_embedded_bracket
+    doc = parse "With [embedded [brackets]] [b].\n\n[b]: /url/\n"
+
+    expected =
+      doc(
+        para("With {embedded [brackets]}[/url/]."))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_rule_dash
+    doc = parse "- - -\n\n"
+
+    expected = @RM::Document.new(@RM::Rule.new(1))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_rule_underscore
+    doc = parse "_ _ _\n\n"
+
+    expected = @RM::Document.new(@RM::Rule.new(1))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_rule_star
+    doc = parse "* * *\n\n"
+
+    expected = @RM::Document.new(@RM::Rule.new(1))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_strong_star
+    doc = parse "it **works**\n"
+
+    expected = @RM::Document.new(
+      @RM::Paragraph.new("it *works*"))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_strong_underscore
+    doc = parse "it __works__\n"
+
+    expected = @RM::Document.new(
+      @RM::Paragraph.new("it *works*"))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_strong_emphasis_star
+    doc = parse "it ***works***\n"
+
+    expected = @RM::Document.new(
+      @RM::Paragraph.new("it <b>_works_</b>"))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_strong_emphasis_underscore
+    doc = parse "it ___works___\n"
+
+    expected = @RM::Document.new(
+      @RM::Paragraph.new("it <b>_works_</b>"))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_style
+    @parser.css = true
+
+    doc = parse "<style>h1 { color: red }</style>\n"
+
+    expected = doc(
+      @RM::Raw.new("<style>h1 { color: red }</style>"))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_style_disabled
+    doc = parse "<style>h1 { color: red }</style>\n"
+
+    expected = doc()
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_verbatim
+    doc = parse <<-MD
+    text
+    MD
+
+    expected = doc(verb("text\n"))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_verbatim_eof
+    doc = parse "    text"
+
+    expected = doc(verb("text\n"))
+
+    assert_equal expected, doc
+  end
+
+  def test_strong
+    assert_equal '*word*',            @parser.strong('word')
+    assert_equal '<b>two words</b>',  @parser.strong('two words')
+    assert_equal '<b>_emphasis_</b>', @parser.strong('_emphasis_')
+  end
+
+  def parse text
+    @parser.parse text
+  end
+
+end
+