JezK

Edit File: test_rdoc_tom_doc.rb

require 'rdoc/test_case'

class TestRDocTomDoc < RDoc::TestCase

def setup
    super

@top_level = RDoc::TopLevel.new 'file.rb'

@TD = RDoc::TomDoc
    @td = @TD.new
  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_class_add_post_processor
    RDoc::TomDoc.add_post_processor

pp = RDoc::Markup::PreProcess.new __FILE__, []

text = "# Public: Do some stuff\n"

comment = RDoc::Comment.new text, nil
    comment.format = 'tomdoc'

parent = RDoc::Context.new

pp.handle comment, parent

method = parent.add_method RDoc::AnyMethod.new(nil, 'm')

assert_equal 'Public', method.section.title
    assert_equal "# Do some stuff\n", comment.text
  end

def test_class_signature
    c = comment <<-COMMENT
Signature

method_<here>(args)

here - something
    COMMENT
    c.format = 'tomdoc'

signature = @TD.signature c

assert_equal "method_<here>(args)\n", signature
  end

def test_class_signature_no_space
    c = comment <<-COMMENT
Signature
  method_<here>(args)

here - something
    COMMENT
    c.format = 'tomdoc'

signature = @TD.signature c

assert_equal "method_<here>(args)\n", signature

expected =
      @RM::Document.new(
        @RM::Heading.new(3, 'Signature'),
        @RM::List.new(:NOTE,
          @RM::ListItem.new('here',
            @RM::Paragraph.new('something'))))
    expected.file = @top_level

assert_equal expected, c.parse
  end

def test_class_signature_none
    c = comment ''
    c.format = 'tomdoc'

assert_nil @TD.signature c
  end

def test_class_rdoc
    c = comment <<-COMMENT
=== Signature

method_<here>(args)

here - something
    COMMENT
    c.format = 'rdoc'

signature = @TD.signature c

assert_nil signature
  end

def test_class_signature_two_space
    c = comment <<-COMMENT
Signature

method_<here>(args)

here - something
    COMMENT
    c.format = 'tomdoc'

signature = @TD.signature c

assert_equal "method_<here>(args)\n", signature

assert_equal expected, c.parse
  end

def test_parse_paragraph
    text = "Public: Do some stuff\n"

expected =
      @RM::Document.new(
        @RM::Paragraph.new('Do some stuff'))

assert_equal expected, @TD.parse(text)
  end

def test_parse_arguments
    text = <<-TEXT
Create new Arg object.

name        - name of argument
description - arguments description
    TEXT

expected =
      @RM::Document.new(
        @RM::Paragraph.new('Create new Arg object.'),
        @RM::BlankLine.new,
        @RM::List.new(
          :NOTE,
          @RM::ListItem.new(
            'name',
            @RM::Paragraph.new('name of argument')),
          @RM::ListItem.new(
            'description',
            @RM::Paragraph.new('arguments description'))))

assert_equal expected, @TD.parse(text)
  end

def test_parse_arguments_multiline
    text = <<-TEXT
Do some stuff

foo - A comment goes here
  and is more than one line
    TEXT

expected =
      @RM::Document.new(
        @RM::Paragraph.new('Do some stuff'),
        @RM::BlankLine.new,
        @RM::List.new(
          :NOTE,
          @RM::ListItem.new(
            'foo',
            @RM::Paragraph.new(
              'A comment goes here', 'and is more than one line'))))

assert_equal expected, @TD.parse(text)
  end

def test_parse_arguments_nested
    text = <<-TEXT
Do some stuff

foo - A comment goes here
      :bar - bar documentation
    TEXT

expected =
      @RM::Document.new(
        @RM::Paragraph.new('Do some stuff'),
        @RM::BlankLine.new,
        @RM::List.new(
          :NOTE,
          @RM::ListItem.new(
            'foo',
            @RM::Paragraph.new('A comment goes here'),
            @RM::List.new(
              :NOTE,
              @RM::ListItem.new(
                ':bar',
                @RM::Paragraph.new('bar documentation'))))))

assert_equal expected, @TD.parse(text)
  end

def test_parse_examples
    text = <<-TEXT
Do some stuff

Examples

1 + 1
    TEXT

document = @TD.parse(text)
    assert_equal expected, document
    assert document.parts.last.ruby?
  end

def test_parse_examples_signature
    text = <<-TEXT
Do some stuff

Examples

1 + 1

Signature

foo(args)
    TEXT

expected =
      @RM::Document.new(
        @RM::Paragraph.new('Do some stuff'),
        @RM::BlankLine.new,
        @RM::Heading.new(3, 'Examples'),
        @RM::BlankLine.new,
        @RM::Verbatim.new("1 + 1\n"),
        @RM::Heading.new(3, 'Signature'),
        @RM::BlankLine.new,
        @RM::Verbatim.new("foo(args)\n"))

document = @TD.parse(text)
    assert_equal expected, document
    assert document.parts[4].ruby?
    refute document.parts.last.ruby?
  end

def test_parse_returns
    text = <<-TEXT
Do some stuff

Returns a thing
    TEXT

expected =
      @RM::Document.new(
        @RM::Paragraph.new('Do some stuff'),
        @RM::BlankLine.new,
        @RM::Paragraph.new('Returns a thing'))

assert_equal expected, @TD.parse(text)
  end

def test_parse_returns_multiline
    text = <<-TEXT
Do some stuff

Returns a thing
  that is multiline
    TEXT

expected =
      @RM::Document.new(
        @RM::Paragraph.new('Do some stuff'),
        @RM::BlankLine.new,
        @RM::Paragraph.new('Returns a thing', 'that is multiline'))

assert_equal expected, @TD.parse(text)
  end

def test_parse_signature
    text = <<-TEXT
Do some stuff

Signature

some_method(args)
    TEXT

expected =
      @RM::Document.new(
        @RM::Paragraph.new('Do some stuff'),
        @RM::BlankLine.new,
        @RM::Heading.new(3, 'Signature'),
        @RM::BlankLine.new,
        @RM::Verbatim.new("some_method(args)\n"))

assert_equal expected, @TD.parse(text)
  end

def test_tokenize_paragraph
    @td.tokenize "Public: Do some stuff\n"

expected = [
      [:TEXT,    "Do some stuff",  0, 0],
      [:NEWLINE, "\n",            13, 0],
    ]