Class: RDoc::Markup::TextFormatterTestCase (Ruby 2.4.2)
Description: Class : RDoc::Markup::TextFormatterTestCase - Ruby 2.4.2

Support for the Ruby 2.4 series has ended. See here for reference.

### Home Classes Methods

### In Files

- rdoc/markup/text_formatter_test_case.rb

### Parent

RDoc::Markup::FormatterTestCase

### Methods

- ::add_text_tests
- #test_accept_heading_indent
- #test_accept_paragraph_indent
- #test_accept_paragraph_wrap
- #test_accept_rule_indent
- #test_accept_verbatim_big_indent
- #test_accept_verbatim_indent
- #test_attributes

### Class/Module Index

Quicksearch

- RDoc
- RDoc::Alias
- RDoc::AnonClass
- RDoc::AnyMethod
- RDoc::Attr
- RDoc::ClassModule
- RDoc::CodeObject
- RDoc::Comment
- RDoc::Constant
- RDoc::Context
- RDoc::Context::Section
- RDoc::CrossReference
- RDoc::ERBIO
- RDoc::ERBPartial
- RDoc::Encoding
- RDoc::Error
- RDoc::Extend
- RDoc::Generator
- RDoc::Generator::Darkfish
- RDoc::Generator::JsonIndex
- RDoc::Generator::Markup
- RDoc::Generator::POT
- RDoc::Generator::POT::MessageExtractor
- RDoc::Generator::POT::PO
- RDoc::Generator::POT::POEntry
- RDoc::Generator::RI
- RDoc::GhostMethod
- RDoc::I18n
- RDoc::I18n::Locale
- RDoc::I18n::Text
- RDoc::Include
- RDoc::Markdown
- RDoc::Markdown::Literals
- RDoc::Markup
- RDoc::Markup::AttrChanger
- RDoc::Markup::AttrSpan
- RDoc::Markup::AttributeManager
- RDoc::Markup::Attributes
- RDoc::Markup::BlankLine
- RDoc::Markup::BlockQuote
- RDoc::Markup::Document
- RDoc::Markup::Formatter
- RDoc::Markup::FormatterTestCase
- RDoc::Markup::HardBreak
- RDoc::Markup::Include
- RDoc::Markup::IndentedParagraph
- RDoc::Markup::List
- RDoc::Markup::ListItem
- RDoc::Markup::Paragraph
- RDoc::Markup::Parser
- RDoc::Markup::Parser::Error
- RDoc::Markup::Parser::ParseError
- RDoc::Markup::PreProcess
- RDoc::Markup::Raw
- RDoc::Markup::Rule
- RDoc::Markup::Special
- RDoc::Markup::TextFormatterTestCase
- RDoc::Markup::ToAnsi
- RDoc::Markup::ToBs
- RDoc::Markup::ToHtml
- RDoc::Markup::ToHtmlCrossref
- RDoc::Markup::ToHtmlSnippet
- RDoc::Markup::ToJoinedParagraph
- RDoc::Markup::ToLabel
- RDoc::Markup::ToMarkdown
- RDoc::Markup::ToRdoc
- RDoc::Markup::ToTableOfContents
- RDoc::Markup::ToTest
- RDoc::Markup::ToTtOnly
- RDoc::Markup::Verbatim
- RDoc::MetaMethod
- RDoc::MethodAttr
- RDoc::Mixin
- RDoc::NormalClass
- RDoc::NormalModule
- RDoc::Options
- RDoc::Parser
- RDoc::Parser::C
- RDoc::Parser::ChangeLog
- RDoc::Parser::Markdown
- RDoc::Parser::RD
- RDoc::Parser::Ruby
- RDoc::Parser::RubyTools
- RDoc::Parser::Simple
- RDoc::Parser::Text
- RDoc::RD
- RDoc::RD::BlockParser
- RDoc::RD::Inline
- RDoc::RD::InlineParser
- RDoc::RDoc
- RDoc::RI
- RDoc::RI::Driver
- RDoc::RI::Driver::Error
- RDoc::RI::Driver::NotFoundError
- RDoc::RI::Error
- RDoc::RI::Paths
- RDoc::RI::Task
- RDoc::Require
- RDoc::RubyLex
- RDoc::RubyLex::Error
- RDoc::RubyToken
- RDoc::RubygemsHook
- RDoc::Servlet
- RDoc::SingleClass
- RDoc::Stats
- RDoc::Stats::Normal
- RDoc::Stats::Quiet
- RDoc::Stats::Verbose
- RDoc::Store
- RDoc::Store::Error
- RDoc::Store::MissingFileError
- RDoc::Task
- RDoc::TestCase
- RDoc::Text
- RDoc::TokenStream
- RDoc::TomDoc
- RDoc::TopLevel
- RDocTask

No matching classes.

# RDoc::Markup::TextFormatterTestCase

Test case for creating new plain-text `RDoc::Markup` formatters. See also `RDoc::Markup::FormatterTestCase`

See test_rdoc_markup_to_rdoc.rb for a complete example.

Example:

    class TestRDocMarkupToNewTextFormat < RDoc::Markup::TextFormatterTestCase

      add_visitor_tests
      add_text_tests

      def setup
        super

        @to = RDoc::Markup::ToNewTextFormat.new
      end

      def accept_blank_line
        assert_equal :junk, @to.res.join
      end

      # ...

    end

### Public Class Methods

add_text_tests() click to toggle source

Adds test cases to the calling TestCase.

                   # File rdoc/markup/text_formatter_test_case.rb, line 34
    def self.add_text_tests
      self.class_eval do

        ##
        # Test case that calls <tt>@to.accept_heading</tt>

        def test_accept_heading_indent
          @to.start_accepting
          @to.indent = 3
          @to.accept_heading @RM::Heading.new(1, 'Hello')

          accept_heading_indent
        end

        ##
        # Test case that calls <tt>@to.accept_rule</tt>

        def test_accept_rule_indent
          @to.start_accepting
          @to.indent = 3
          @to.accept_rule @RM::Rule.new(1)

          accept_rule_indent
        end

        ##
        # Test case that calls <tt>@to.accept_verbatim</tt>

        def test_accept_verbatim_indent
          @to.start_accepting
          @to.indent = 2
          @to.accept_verbatim @RM::Verbatim.new("hi\n", " world\n")

          accept_verbatim_indent
        end

        ##
        # Test case that calls <tt>@to.accept_verbatim</tt> with a big indent

        def test_accept_verbatim_big_indent
          @to.start_accepting
          @to.indent = 2
          @to.accept_verbatim @RM::Verbatim.new("hi\n", "world\n")

          accept_verbatim_big_indent
        end

        ##
        # Test case that calls <tt>@to.accept_paragraph</tt> with an indent

        def test_accept_paragraph_indent
          @to.start_accepting
          @to.indent = 3
          @to.accept_paragraph @RM::Paragraph.new(('words ' * 30).strip)

          accept_paragraph_indent
        end

        ##
        # Test case that calls <tt>@to.accept_paragraph</tt> with a long line

        def test_accept_paragraph_wrap
          @to.start_accepting
          @to.accept_paragraph @RM::Paragraph.new(('words ' * 30).strip)

          accept_paragraph_wrap
        end

        ##
        # Test case that calls <tt>@to.attributes</tt> with an escaped
        # cross-reference.  If this test doesn't pass something may be very
        # wrong.

        def test_attributes
          assert_equal 'Dog', @to.attributes("\\Dog")
        end

      end
    end

### Public Instance Methods

test_accept_heading_indent() click to toggle source

Test case that calls `@to.accept_heading`

                   # File rdoc/markup/text_formatter_test_case.rb, line 40
    def test_accept_heading_indent
      @to.start_accepting
      @to.indent = 3
      @to.accept_heading @RM::Heading.new(1, 'Hello')

      accept_heading_indent
    end

test_accept_paragraph_indent() click to toggle source

Test case that calls `@to.accept_paragraph` with an indent

                   # File rdoc/markup/text_formatter_test_case.rb, line 84
    def test_accept_paragraph_indent
      @to.start_accepting
      @to.indent = 3
      @to.accept_paragraph @RM::Paragraph.new(('words ' * 30).strip)

      accept_paragraph_indent
    end

test_accept_paragraph_wrap() click to toggle source

Test case that calls `@to.accept_paragraph` with a long line

                   # File rdoc/markup/text_formatter_test_case.rb, line 95
    def test_accept_paragraph_wrap
      @to.start_accepting
      @to.accept_paragraph @RM::Paragraph.new(('words ' * 30).strip)

      accept_paragraph_wrap
    end

test_accept_rule_indent() click to toggle source

Test case that calls `@to.accept_rule`

                   # File rdoc/markup/text_formatter_test_case.rb, line 51
    def test_accept_rule_indent
      @to.start_accepting
      @to.indent = 3
      @to.accept_rule @RM::Rule.new(1)

      accept_rule_indent
    end

test_accept_verbatim_big_indent() click to toggle source

Test case that calls `@to.accept_verbatim` with a big indent

                   # File rdoc/markup/text_formatter_test_case.rb, line 73
    def test_accept_verbatim_big_indent
      @to.start_accepting
      @to.indent = 2
      @to.accept_verbatim @RM::Verbatim.new("hi\n", "world\n")

      accept_verbatim_big_indent
    end

test_accept_verbatim_indent() click to toggle source

Test case that calls `@to.accept_verbatim`

                   # File rdoc/markup/text_formatter_test_case.rb, line 62
    def test_accept_verbatim_indent
      @to.start_accepting
      @to.indent = 2
      @to.accept_verbatim @RM::Verbatim.new("hi\n", " world\n")

      accept_verbatim_indent
    end

test_attributes() click to toggle source

Test case that calls `@to.attributes` with an escaped cross-reference. If this test doesn't pass something may be very wrong.

                   # File rdoc/markup/text_formatter_test_case.rb, line 107
    def test_attributes
      assert_equal 'Dog', @to.attributes("\\Dog")
    end