Index: src/test/java/org/apache/maven/doxia/sink/AbstractSinkTest.java
===================================================================
--- src/test/java/org/apache/maven/doxia/sink/AbstractSinkTest.java (revision 0)
+++ src/test/java/org/apache/maven/doxia/sink/AbstractSinkTest.java (revision 0)
@@ -0,0 +1,949 @@
+package org.apache.maven.doxia.sink;
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import org.apache.maven.doxia.parser.Parser;
+import org.apache.maven.doxia.sink.Sink;
+import org.codehaus.plexus.PlexusTestCase;
+
+import java.io.CharArrayWriter;
+import java.io.File;
+import java.io.FileWriter;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.InputStreamReader;
+import java.io.Reader;
+import java.io.Writer;
+
+/**
+ * Abstract base class to test sinks.
+ */
+public abstract class AbstractSinkTest
+ extends PlexusTestCase
+{
+ private final CharArrayWriter writer = new CharArrayWriter();
+ private Sink sink;
+
+ /**
+ * Resets the writer and creates a new sink with it.
+ */
+ protected void setUp()
+ {
+ writer.reset();
+ sink = createSink( writer );
+ }
+
+ // ---------------------------------------------------------------------
+ // Common test cases
+ // ----------------------------------------------------------------------
+
+ /**
+ * Tests that the current sink is able to render the common test document.
+ * @see SinkTestDocument
+ * @throws IOException If the target test document could not be generated.
+ */
+ public final void testTestDocument() throws IOException
+ {
+ Sink testSink = createSink( getTestWriter( "testDocument" ) );
+
+ SinkTestDocument.generate( testSink );
+
+ testSink.close();
+ }
+
+ /**
+ * Checks that the sequence [title(), text( title ), title_()],
+ * invoked on the current sink, produces the same result as
+ * {@link #getTitleBlock getTitleBlock}( title ).
+ * NewLines are ignored.
+ */
+ public void testTitle()
+ {
+ String title = "Grodek";
+ sink.title();
+ sink.text( title );
+ sink.title_();
+
+ String expected = noNewLine( writer.toString() );
+ assertEquals( "Wrong title!",
+ expected, noNewLine( getTitleBlock( title ) ) );
+ }
+
+ /**
+ * Checks that the sequence [author(), text( author ), author_()]
+ * , invoked on the current sink, produces the same result as
+ * {@link #getAuthorBlock getAuthorBlock}( author ).
+ * NewLines are ignored.
+ */
+ public void testAuthor()
+ {
+ String author = "Georg Trakl";
+ sink.author();
+ sink.text( author );
+ sink.author_();
+
+ String expected = noNewLine( writer.toString() );
+ assertEquals( "Wrong author!",
+ expected, noNewLine( getAuthorBlock( author ) ) );
+ }
+
+ /**
+ * Checks that the sequence [date(), text( date ), date_()],
+ * invoked on the current sink, produces the same result as
+ * {@link #getDateBlock getDateBlock}( date ). NewLines are ignored.
+ */
+ public void testDate()
+ {
+ String date = "1914";
+ sink.date();
+ sink.text( date );
+ sink.date_();
+
+ String expected = noNewLine( writer.toString() );
+ assertEquals( "Wrong date!",
+ expected, noNewLine( getDateBlock( date ) ) );
+ }
+
+ /**
+ * Checks that the sequence [head(), head_()],
+ * invoked on the current sink, produces the same result as
+ * {@link #getHeadBlock getHeadBlock()}. NewLines are ignored.
+ */
+ public void testHead()
+ {
+ sink.head();
+ sink.head_();
+
+ String expected = noNewLine( writer.toString() );
+ assertEquals( "Wrong head!", expected, noNewLine( getHeadBlock() ) );
+ }
+
+ /**
+ * Checks that the sequence [body(), body_()],
+ * invoked on the current sink, produces the same result as
+ * {@link #getBodyBlock getBodyBlock()}. NewLines are ignored.
+ */
+ public void testBody()
+ {
+ sink.body();
+ sink.body_();
+
+ String expected = noNewLine( writer.toString() );
+ assertEquals( "Wrong body!", expected, noNewLine( getBodyBlock() ) );
+ }
+
+ /**
+ * Checks that the sequence [sectionTitle(), text( title ),
+ * sectionTitle_()], invoked on the current sink, produces
+ * the same result as
+ * {@link #getSectionTitleBlock getSectionTitleBlock}( title ).
+ * NewLines are ignored.
+ */
+ public void testSectionTitle()
+ {
+ String title = "Title";
+ sink.sectionTitle();
+ sink.text( title );
+ sink.sectionTitle_();
+
+ String expected = noNewLine( writer.toString() );
+ assertEquals( "Wrong sectionTitle!",
+ expected, noNewLine( getSectionTitleBlock( title ) ) );
+ }
+
+ /**
+ * Checks that the sequence [section1(), sectionTitle1(),
+ * text( title ), sectionTitle1_(), section1_()],
+ * invoked on the current sink, produces the same result as
+ * {@link #getSection1Block getSection1Block}( title ).
+ * NewLines are ignored.
+ */
+ public void testSection1()
+ {
+ String title = "Title1";
+ sink.section1();
+ sink.sectionTitle1();
+ sink.text( title );
+ sink.sectionTitle1_();
+ sink.section1_();
+
+ String expected = noNewLine( writer.toString() );
+ assertEquals( "Wrong section1 block!",
+ expected, noNewLine( getSection1Block( title ) ) );
+ }
+
+ /**
+ * Checks that the sequence [section2(), sectionTitle2(),
+ * text( title ), sectionTitle2_(), section2_()],
+ * invoked on the current sink, produces the same result as
+ * {@link #getSection2Block getSection2Block}( title ).
+ * NewLines are ignored.
+ */
+ public void testSection2()
+ {
+ String title = "Title2";
+ sink.section2();
+ sink.sectionTitle2();
+ sink.text( title );
+ sink.sectionTitle2_();
+ sink.section2_();
+
+ String expected = noNewLine( writer.toString() );
+ assertEquals( "Wrong section2 block!",
+ expected, noNewLine( getSection2Block( title ) ) );
+ }
+
+ /**
+ * Checks that the sequence [section3(), sectionTitle3(),
+ * text( title ), sectionTitle3_(), section3_()],
+ * invoked on the current sink, produces the same result as
+ * {@link #getSection3Block getSection3Block}( title ).
+ * NewLines are ignored.
+ */
+ public void testSection3()
+ {
+ String title = "Title3";
+ sink.section3();
+ sink.sectionTitle3();
+ sink.text( title );
+ sink.sectionTitle3_();
+ sink.section3_();
+
+ String expected = noNewLine( writer.toString() );
+ assertEquals( "Wrong section3 block!",
+ expected, noNewLine( getSection3Block( title ) ) );
+ }
+
+ /**
+ * Checks that the sequence [section4(), sectionTitle4(),
+ * text( title ), sectionTitle4_(), section4_()],
+ * invoked on the current sink, produces the same result as
+ * {@link #getSection4Block getSection4Block}( title ).
+ * NewLines are ignored.
+ */
+ public void testSection4()
+ {
+ String title = "Title4";
+ sink.section4();
+ sink.sectionTitle4();
+ sink.text( title );
+ sink.sectionTitle4_();
+ sink.section4_();
+
+ String expected = noNewLine( writer.toString() );
+ assertEquals( "Wrong section4 block!",
+ expected, noNewLine( getSection4Block( title ) ) );
+ }
+
+ /**
+ * Checks that the sequence [section5(), sectionTitle5(),
+ * text( title ), sectionTitle5_(), section5_()],
+ * invoked on the current sink, produces the same result as
+ * {@link #getSection5Block getSection5Block}( title ).
+ * NewLines are ignored.
+ */
+ public void testSection5()
+ {
+ String title = "Title5";
+ sink.section5();
+ sink.sectionTitle5();
+ sink.text( title );
+ sink.sectionTitle5_();
+ sink.section5_();
+
+ String expected = noNewLine( writer.toString() );
+ assertEquals( "Wrong section5 block!",
+ expected, noNewLine( getSection5Block( title ) ) );
+ }
+
+ /**
+ * Checks that the sequence [list(), listItem(), text( item ),
+ * listItem_(), list_()], invoked on the current sink, produces
+ * the same result as {@link #getListBlock getListBlock}( item ).
+ * NewLines are ignored.
+ */
+ public void testList()
+ {
+ String item = "list item";
+ sink.list();
+ sink.listItem();
+ sink.text( item );
+ sink.listItem_();
+ sink.list_();
+
+ String expected = noNewLine( writer.toString() );
+ assertEquals( "Wrong list!",
+ expected, noNewLine( getListBlock( item ) ) );
+ }
+
+ /**
+ * Checks that the sequence
+ * [numberedList( Sink.NUMBERING_LOWER_ROMAN ), numberedListItem(),
+ * text( item ), numberedListItem_(), numberedList_()],
+ * invoked on the current sink, produces the same result as
+ * {@link #getNumberedListBlock getNumberedListBlock}( item ).
+ * NewLines are ignored.
+ */
+ public void testNumberedList()
+ {
+ String item = "numbered list item";
+ sink.numberedList( Sink.NUMBERING_LOWER_ROMAN );
+ sink.numberedListItem();
+ sink.text( item );
+ sink.numberedListItem_();
+ sink.numberedList_();
+
+ String expected = noNewLine( writer.toString() );
+ assertEquals( "Wrong numbered list!",
+ expected, noNewLine( getNumberedListBlock( item ) ) );
+ }
+
+ /**
+ * Checks that the sequence [definitionList(), definitionListItem(),
+ * definedTerm(), text( definum ), definedTerm_(), definition(),
+ * text( definition ), definition_(), definitionListItem_(),
+ * definitionList_()], invoked on the current sink, produces the same
+ * result as {@link #getDefinitionListBlock getDefinitionListBlock}
+ * ( definum, definition ). NewLines are ignored.
+ */
+ public void testDefinitionList()
+ {
+ String definum = "definum";
+ String definition = "definition";
+ sink.definitionList();
+ sink.definitionListItem();
+ sink.definedTerm();
+ sink.text( definum );
+ sink.definedTerm_();
+ sink.definition();
+ sink.text( definition );
+ sink.definition_();
+ sink.definitionListItem_();
+ sink.definitionList_();
+
+ String expected = noNewLine( writer.toString() );
+ assertEquals( "Wrong definition list!", expected,
+ noNewLine( getDefinitionListBlock( definum, definition ) ) );
+ }
+
+ /**
+ * Checks that the sequence [figure(), figureGraphics( source ),
+ * figureCaption(), text( caption ), figureCaption_(), figure_()],
+ * invoked on the current sink, produces the same result as
+ * {@link #getFigureBlock getFigureBlock}( source, caption ).
+ * NewLines are ignored.
+ */
+ public void testFigure()
+ {
+ String source = "figure";
+ String caption = "Figure caption";
+ sink.figure();
+ sink.figureGraphics( source );
+ sink.figureCaption();
+ sink.text( caption );
+ sink.figureCaption_();
+ sink.figure_();
+
+
+ String expected = noNewLine( writer.toString() );
+ assertEquals( "Wrong figure!", expected,
+ noNewLine( getFigureBlock( source, caption ) ) );
+ }
+
+ /**
+ * Checks that the sequence [table(),
+ * tableRows( Parser.JUSTIFY_CENTER, false ), tableRow(), tableCell(),
+ * text( cell ), tableCell_(), tableRow_(), tableRows_(), tableCaption(),
+ * text( caption ), tableCaption_(), table_()],
+ * invoked on the current sink, produces the same result as
+ * {@link #getTableBlock getTableBlock}( cell, caption ).
+ * NewLines are ignored.
+ */
+ public void testTable()
+ {
+ String cell = "cell";
+ String caption = "Table caption";
+ int[] justify = { Parser.JUSTIFY_CENTER };
+ sink.table();
+ sink.tableRows( justify, false );
+ sink.tableRow();
+ sink.tableCell();
+ sink.text( cell );
+ sink.tableCell_();
+ sink.tableRow_();
+ sink.tableRows_();
+ sink.tableCaption();
+ sink.text( caption );
+ sink.tableCaption_();
+ sink.table_();
+
+
+ String expected = noNewLine( writer.toString() );
+ assertEquals( "Wrong table!", expected,
+ noNewLine( getTableBlock( cell, caption ) ) );
+ }
+ /**
+ * Checks that the sequence [paragraph(), text( text ),
+ * paragraph_()], invoked on the current sink, produces
+ * the same result as {@link #getParagraphBlock getParagraphBlock}( text ).
+ * NewLines are ignored.
+ */
+ public void testParagraph()
+ {
+ String text = "Text";
+ sink.paragraph();
+ sink.text( text );
+ sink.paragraph_();
+
+ String expected = noNewLine( writer.toString() );
+ assertEquals( "Wrong paragraph!",
+ expected, noNewLine( getParagraphBlock( text ) ) );
+ }
+
+ /**
+ * Checks that the sequence [verbatim( true ), text( text ),
+ * verbatim_()], invoked on the current sink, produces the
+ * same result as {@link #getVerbatimBlock getVerbatimBlock}( text ).
+ * NewLines are ignored.
+ */
+ public void testVerbatim()
+ {
+ String text = "Text";
+ sink.verbatim( true );
+ sink.text( text );
+ sink.verbatim_();
+
+ String expected = noNewLine( writer.toString() );
+ assertEquals( "Wrong verbatim!",
+ expected, noNewLine( getVerbatimBlock( text ) ) );
+ }
+
+ /**
+ * Checks that the sequence [horizontalRule()],
+ * invoked on the current sink, produces the same result as
+ * {@link #getHorizontalRuleBlock getHorizontalRuleBlock()}.
+ * NewLines are ignored.
+ */
+ public void testHorizontalRule()
+ {
+ sink.horizontalRule();
+
+ String expected = noNewLine( writer.toString() );
+ assertEquals( "Wrong horizontal rule!",
+ expected, noNewLine( getHorizontalRuleBlock() ) );
+ }
+
+ /**
+ * Checks that the sequence [pageBreak()],
+ * invoked on the current sink, produces the same result as
+ * {@link #getPageBreakBlock getPageBreakBlock()}. NewLines are ignored.
+ */
+ public void testPageBreak()
+ {
+ sink.pageBreak();
+
+ String expected = noNewLine( writer.toString() );
+ assertEquals( "Wrong pageBreak!",
+ expected, noNewLine( getPageBreakBlock() ) );
+ }
+
+ /**
+ * Checks that the sequence [anchor( anchor ), text( anchor ),
+ * anchor_()], invoked on the current sink, produces the same
+ * result as {@link #getAnchorBlock getAnchorBlock}( anchor ).
+ * NewLines are ignored.
+ */
+ public void testAnchor()
+ {
+ String anchor = "Anchor";
+ sink.anchor( anchor );
+ sink.text( anchor );
+ sink.anchor_();
+
+ String expected = noNewLine( writer.toString() );
+ assertEquals( "Wrong anchor!",
+ expected, noNewLine( getAnchorBlock( anchor ) ) );
+ }
+
+ /**
+ * Checks that the sequence [link( link ), text( text ),
+ * link_()], invoked on the current sink, produces the same
+ * result as {@link #getLinkBlock getLinkBlock}( link, text ).
+ * NewLines are ignored.
+ */
+ public void testLink()
+ {
+ String link = "Link";
+ String text = "Text";
+ sink.link( link );
+ sink.text( text );
+ sink.link_();
+
+ String expected = noNewLine( writer.toString() );
+ assertEquals( "Wrong link!",
+ expected, noNewLine( getLinkBlock( link, text ) ) );
+ }
+
+ /**
+ * Checks that the sequence [italic(), text( text ), italic_()],
+ * invoked on the current sink, produces the same result as
+ * {@link #getItalicBlock getItalicBlock}( text ). NewLines are ignored.
+ */
+ public void testItalic()
+ {
+ String text = "Italic";
+ sink.italic();
+ sink.text( text );
+ sink.italic_();
+
+ String expected = noNewLine( writer.toString() );
+ assertEquals( "Wrong italic!",
+ expected, noNewLine( getItalicBlock( text ) ) );
+ }
+
+ /**
+ * Checks that the sequence [bold(), text( text ), bold_()],
+ * invoked on the current sink, produces the same result as
+ * {@link #getBoldBlock getBoldBlock}( text ). NewLines are ignored.
+ */
+ public void testBold()
+ {
+ String text = "Bold";
+ sink.bold();
+ sink.text( text );
+ sink.bold_();
+
+ String expected = noNewLine( writer.toString() );
+ assertEquals( "Wrong bold!",
+ expected, noNewLine( getBoldBlock( text ) ) );
+ }
+
+ /**
+ * Checks that the sequence [monospaced(), text( text ),
+ * monospaced_()], invoked on the current sink, produces the same
+ * result as {@link #getMonospacedBlock getMonospacedBlock}( text ).
+ * NewLines are ignored.
+ */
+ public void testMonospaced()
+ {
+ String text = "Monospaced";
+ sink.monospaced();
+ sink.text( text );
+ sink.monospaced_();
+
+ String expected = noNewLine( writer.toString() );
+ assertEquals( "Wrong monospaced!",
+ expected, noNewLine( getMonospacedBlock( text ) ) );
+ }
+
+ /**
+ * Checks that the sequence [lineBreak()],
+ * invoked on the current sink, produces the same result as
+ * {@link #getLineBreakBlock getLineBreakBlock()}. NewLines are ignored.
+ */
+ public void testLineBreak()
+ {
+ sink.lineBreak();
+
+ String expected = noNewLine( writer.toString() );
+ assertEquals( "Wrong lineBreak!",
+ expected, noNewLine( getLineBreakBlock() ) );
+ }
+
+ /**
+ * Checks that the sequence [nonBreakingSpace()],
+ * invoked on the current sink, produces the same result as
+ * {@link #getNonBreakingSpaceBlock getNonBreakingSpaceBlock()}.
+ * NewLines are ignored.
+ */
+ public void testNonBreakingSpace()
+ {
+ sink.nonBreakingSpace();
+
+ String expected = noNewLine( writer.toString() );
+ assertEquals( "Wrong nonBreakingSpace!",
+ expected, noNewLine( getNonBreakingSpaceBlock() ) );
+ }
+
+ /**
+ * Checks that the sequence [text( text )],
+ * invoked on the current sink, produces the same result as
+ * {@link #getTextBlock getTextBlock()}. NewLines are ignored.
+ */
+ public void testText()
+ {
+ String text = "~, =, -, +, *, [, ], <, >, {, }, \\";
+ sink.text( text );
+
+ String expected = noNewLine( writer.toString() );
+ assertEquals( "Wrong text!",
+ expected, noNewLine( getTextBlock( text ) ) );
+ }
+
+ /**
+ * Checks that the sequence [rawText( text )],
+ * invoked on the current sink, produces the same result as
+ * {@link #getRawTextBlock getRawTextBlock}( text ). NewLines are ignored.
+ */
+ public void testRawText()
+ {
+ String text = "~, =, -, +, *, [, ], <, >, {, }, \\";
+ sink.rawText( text );
+
+ String expected = noNewLine( writer.toString() );
+ assertEquals( "Wrong rawText!",
+ expected, noNewLine( getRawTextBlock( text ) ) );
+ }
+
+
+ // ----------------------------------------------------------------------
+ // Methods for creating the test reader and writer
+ // ----------------------------------------------------------------------
+
+ /**
+ * Returns a FileWriter to write to a file with the given name
+ * in the test target output directory.
+ * @param baseName The name of the target file.
+ * @return A FileWriter.
+ * @throws IOException If the FileWriter could not be generated.
+ */
+ protected Writer getTestWriter( String baseName )
+ throws IOException
+ {
+ File outputDirectory = new File( getBasedirFile(), getOutputDir() );
+
+ if ( !outputDirectory.exists() )
+ {
+ outputDirectory.mkdirs();
+ }
+
+ return new FileWriter(
+ new File( outputDirectory, baseName + "." + outputExtension() ) );
+ }
+
+ /**
+ * Returns an InputStreamReader to read a resource from a file
+ * in the test target output directory.
+ * @param baseName The name of the resource file to read.
+ * @param extension The file extension of the resource file to read.
+ * @return An InputStreamReader.
+ * @throws IOException If the InputStreamReader could not be generated.
+ */
+ protected Reader getTestReader( String baseName, String extension )
+ throws IOException
+ {
+ InputStream is =
+ Thread.currentThread().getContextClassLoader().getResourceAsStream(
+ baseName + "." + extension );
+
+ InputStreamReader reader = new InputStreamReader( is );
+
+ return reader;
+ }
+
+
+ // ----------------------------------------------------------------------
+ // Utility methods
+ // ----------------------------------------------------------------------
+
+ private String noNewLine( String text )
+ {
+ String EOL = System.getProperty( "line.separator" );
+ return text.replaceAll( EOL, "" );
+ }
+
+ /**
+ * Returns the common base directory.
+ * @return The common base directory as a File.
+ */
+ protected File getBasedirFile()
+ {
+ return new File( getBasedir() );
+ }
+
+ /**
+ * Returns the directory where all test output will go.
+ * @return The test output directory.
+ */
+ protected String getOutputDir()
+ {
+ return "target/test-output";
+ }
+
+ /**
+ * Returns the sink that is currently being tested.
+ * @return The current test sink.
+ */
+ protected Sink getSink()
+ {
+ return sink;
+ }
+
+
+ // ----------------------------------------------------------------------
+ // Abstract methods the individual SinkTests must provide
+ // ----------------------------------------------------------------------
+
+ /**
+ * Determines the default file extension for the current sink.
+ * @return The default file extension.
+ */
+ protected abstract String outputExtension();
+
+ /**
+ * Return a new instance of the sink that is being tested.
+ * @param writer The writer for the sink.
+ * @return A new sink.
+ */
+ protected abstract Sink createSink( Writer writer );
+
+ /**
+ * Returns a title block generated by this sink.
+ * @param title The title to use.
+ * @return The result of invoking a title block on the current sink.
+ * @see #testTitle()
+ */
+ protected abstract String getTitleBlock( String title );
+
+ /**
+ * Returns an author block generated by this sink.
+ * @param author The author to use.
+ * @return The result of invoking an author block on the current sink.
+ * @see #testAuthor()
+ */
+ protected abstract String getAuthorBlock( String author );
+
+ /**
+ * Returns a date block generated by this sink.
+ * @param date The date to use.
+ * @return The result of invoking a date block on the current sink.
+ * @see #testDate()
+ */
+ protected abstract String getDateBlock( String date );
+
+ /**
+ * Returns a head block generated by this sink.
+ * @return The result of invoking a head block on the current sink.
+ * @see #testHead()
+ */
+ protected abstract String getHeadBlock();
+
+ /**
+ * Returns a body block generated by this sink.
+ * @return The result of invoking a body block on the current sink.
+ * @see #testBody()
+ */
+ protected abstract String getBodyBlock();
+
+ /**
+ * Returns a SectionTitle block generated by this sink.
+ * @param title The title to use.
+ * @return The result of invoking a SectionTitle block on the current sink.
+ * @see #testSectionTitle()
+ */
+ protected abstract String getSectionTitleBlock( String title );
+
+ /**
+ * Returns a Section1 block generated by this sink.
+ * @param title The title to use.
+ * @return The result of invoking a Section1 block on the current sink.
+ * @see #testSection1()
+ */
+ protected abstract String getSection1Block( String title );
+
+ /**
+ * Returns a Section2 block generated by this sink.
+ * @param title The title to use.
+ * @return The result of invoking a Section2 block on the current sink.
+ * @see #testSection2()
+ */
+ protected abstract String getSection2Block( String title );
+
+ /**
+ * Returns a Section3 block generated by this sink.
+ * @param title The title to use.
+ * @return The result of invoking a Section3 block on the current sink.
+ * @see #testSection3()
+ */
+ protected abstract String getSection3Block( String title );
+
+ /**
+ * Returns a Section4 block generated by this sink.
+ * @param title The title to use.
+ * @return The result of invoking a Section4 block on the current sink.
+ * @see #testSection4()
+ */
+ protected abstract String getSection4Block( String title );
+
+ /**
+ * Returns a Section5 block generated by this sink.
+ * @param title The title to use.
+ * @return The result of invoking a Section5 block on the current sink.
+ * @see #testSection5()
+ */
+ protected abstract String getSection5Block( String title );
+
+ /**
+ * Returns a list block generated by this sink.
+ * @param item The item to use.
+ * @return The result of invoking a list block on the current sink.
+ * @see #testList()
+ */
+ protected abstract String getListBlock( String item );
+
+ /**
+ * Returns a NumberedList block generated by this sink.
+ * @param item The item to use.
+ * @return The result of invoking a NumberedList block on the current sink.
+ * @see #testNumberedList()
+ */
+ protected abstract String getNumberedListBlock( String item );
+
+ /**
+ * Returns a DefinitionList block generated by this sink.
+ * @param definum The term to define.
+ * @param definition The definition.
+ * @return The result of invoking a DefinitionList block on the current sink.
+ * @see #testDefinitionList()
+ */
+ protected abstract String getDefinitionListBlock( String definum,
+ String definition );
+
+ /**
+ * Returns a Figure block generated by this sink.
+ * @param source The figure source string.
+ * @param caption The caption to use (may be null).
+ * @return The result of invoking a Figure block on the current sink.
+ * @see #testFigure()
+ */
+ protected abstract String getFigureBlock( String source, String caption );
+
+ /**
+ * Returns a Table block generated by this sink.
+ * @param cell A tabel cell to use.
+ * @param caption The caption to use (may be null).
+ * @return The result of invoking a Table block on the current sink.
+ * @see #testTable()
+ */
+ protected abstract String getTableBlock( String cell, String caption );
+
+ /**
+ * Returns a Paragraph block generated by this sink.
+ * @param text The text to use.
+ * @return The result of invoking a Paragraph block on the current sink.
+ * @see #testParagraph()
+ */
+ protected abstract String getParagraphBlock( String text );
+
+ /**
+ * Returns a Verbatim block generated by this sink.
+ * @param text The text to use.
+ * @return The result of invoking a Verbatim block on the current sink.
+ * @see #testVerbatim()
+ */
+ protected abstract String getVerbatimBlock( String text );
+
+ /**
+ * Returns a HorizontalRule block generated by this sink.
+ * @return The result of invoking a HorizontalRule block on the current sink.
+ * @see #testHorizontalRule()
+ */
+ protected abstract String getHorizontalRuleBlock();
+
+ /**
+ * Returns a PageBreak block generated by this sink.
+ * @return The result of invoking a PageBreak block on the current sink.
+ * @see #testPageBreak()
+ */
+ protected abstract String getPageBreakBlock();
+
+ /**
+ * Returns a Anchor block generated by this sink.
+ * @param anchor The anchor to use.
+ * @return The result of invoking a Anchor block on the current sink.
+ * @see #testAnchor()
+ */
+ protected abstract String getAnchorBlock( String anchor );
+
+ /**
+ * Returns a Link block generated by this sink.
+ * @param link The link to use.
+ * @param text The link text.
+ * @return The result of invoking a Link block on the current sink.
+ * @see #testLink()
+ */
+ protected abstract String getLinkBlock( String link, String text );
+
+ /**
+ * Returns a Italic block generated by this sink.
+ * @param text The text to use.
+ * @return The result of invoking a Italic block on the current sink.
+ * @see #testItalic()
+ */
+ protected abstract String getItalicBlock( String text );
+
+ /**
+ * Returns a Bold block generated by this sink.
+ * @param text The text to use.
+ * @return The result of invoking a Bold block on the current sink.
+ * @see #testBold()
+ */
+ protected abstract String getBoldBlock( String text );
+
+ /**
+ * Returns a Monospaced block generated by this sink.
+ * @param text The text to use.
+ * @return The result of invoking a Monospaced block on the current sink.
+ * @see #testMonospaced()
+ */
+ protected abstract String getMonospacedBlock( String text );
+
+ /**
+ * Returns a LineBreak block generated by this sink.
+ * @return The result of invoking a LineBreak block on the current sink.
+ * @see #testLineBreak()
+ */
+ protected abstract String getLineBreakBlock();
+
+ /**
+ * Returns a NonBreakingSpace block generated by this sink.
+ * @return The result of invoking a NonBreakingSpace block
+ * on the current sink.
+ * @see #testNonBreakingSpace()
+ */
+ protected abstract String getNonBreakingSpaceBlock();
+
+ /**
+ * Returns a Text block generated by this sink.
+ * @param text The text to use.
+ * @return The result of invoking a Text block on the current sink.
+ * @see #testText()
+ */
+ protected abstract String getTextBlock( String text );
+
+ /**
+ * Returns a RawText block generated by this sink.
+ * @param text The text to use.
+ * @return The result of invoking a RawText block on the current sink.
+ * @see #testRawText()
+ */
+ protected abstract String getRawTextBlock( String text );
+
+}
Property changes on: src/test/java/org/apache/maven/doxia/sink/AbstractSinkTest.java
___________________________________________________________________
Name: svn:keywords
+ "Author Date Id Revision"
Name: svn:eol-style
+ native
Index: src/test/java/org/apache/maven/doxia/sink/SinkTestDocument.java
===================================================================
--- src/test/java/org/apache/maven/doxia/sink/SinkTestDocument.java (revision 0)
+++ src/test/java/org/apache/maven/doxia/sink/SinkTestDocument.java (revision 0)
@@ -0,0 +1,359 @@
+package org.apache.maven.doxia.sink;
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import org.apache.maven.doxia.parser.Parser;
+import org.apache.maven.doxia.sink.Sink;
+
+/**
+ * Used to generate a test document that contains all sink elements.
+ */
+public class SinkTestDocument
+{
+
+ private SinkTestDocument()
+ {
+ // do not instantiate
+ }
+
+ /**
+ * Dumps a test document that mimics aptconvert's test.apt,
+ * into the the specified sink.
+ * @param sink The sink to receive the events.
+ */
+ public static void generate( Sink sink )
+ {
+ sink.head();
+
+ sink.title();
+ sink.text( "Title" );
+ sink.title_();
+
+ sink.author();
+ sink.text( "Author" );
+ sink.author_();
+
+ sink.date();
+ sink.text( "Date" );
+ sink.date_();
+
+ sink.head_();
+
+
+ sink.body();
+
+ // TODO: what is this supposed to do?
+ //sink.sectionTitle();
+ //sink.text( "" );
+ //sink.sectionTitle_();
+
+ sink.paragraph();
+ sink.text( "Paragraph 1, line 1. " );
+ sink.text( "Paragraph 1, line 2." );
+ sink.paragraph_();
+
+ sink.paragraph();
+ sink.text( "Paragraph 2, line 1. " );
+ sink.text( "Paragraph 2, line 2." );
+ sink.paragraph_();
+
+ sink.section1();
+ sink.sectionTitle1();
+ sink.text( "Section title" );
+ sink.sectionTitle1_();
+
+ sink.section2();
+ sink.sectionTitle2();
+ sink.text( "Sub-section title" );
+ sink.sectionTitle2_();
+
+ sink.section3();
+ sink.sectionTitle3();
+ sink.text( "Sub-sub-section title" );
+ sink.sectionTitle3_();
+
+ sink.section4();
+ sink.sectionTitle4();
+ sink.text( "Sub-sub-sub-section title" );
+ sink.sectionTitle4_();
+
+ sink.section5();
+ sink.sectionTitle5();
+ sink.text( "Sub-sub-sub-sub-section title" );
+ sink.sectionTitle5_();
+
+ sink.list();
+ sink.listItem();
+ sink.paragraph();
+ sink.text( "List item 1." );
+ sink.paragraph_();
+ sink.listItem_();
+ sink.listItem();
+ sink.paragraph();
+ sink.text( "List item 2." );
+ sink.paragraph_();
+ sink.paragraph();
+ sink.text( "Paragraph contained in list item 2." );
+ sink.paragraph_();
+ sink.list();
+ sink.listItem();
+ sink.paragraph();
+ sink.text( "Sub-list item 1." );
+ sink.paragraph_();
+ sink.listItem_();
+ sink.listItem();
+ sink.paragraph();
+ sink.text( "Sub-list item 2." );
+ sink.paragraph_();
+ sink.listItem_();
+ sink.list_();
+ sink.listItem_();
+ sink.listItem();
+ sink.paragraph();
+ sink.text( "List item 3. " );
+ sink.text( "Force end of list:" );
+ sink.paragraph_();
+ sink.listItem_();
+ sink.list_();
+
+ sink.verbatim( true );
+ sink.text( "Verbatim text not contained in list item 3" );
+ sink.verbatim_();
+
+ sink.numberedList( Sink.NUMBERING_DECIMAL );
+ sink.numberedListItem();
+ sink.paragraph();
+ sink.text( "Numbered item 1." );
+ sink.paragraph_();
+ sink.numberedList( Sink.NUMBERING_UPPER_ALPHA );
+ sink.numberedListItem();
+ sink.paragraph();
+ sink.text( "Numbered item A." );
+ sink.paragraph_();
+ sink.numberedListItem_();
+ sink.numberedListItem();
+ sink.paragraph();
+ sink.text( "Numbered item B." );
+ sink.paragraph_();
+ sink.numberedListItem_();
+ sink.numberedList_();
+ sink.numberedListItem_();
+ sink.numberedListItem();
+ sink.paragraph();
+ sink.text( "Numbered item 2." );
+ sink.paragraph_();
+ sink.numberedListItem_();
+ sink.numberedList_();
+
+ sink.paragraph();
+ sink.text( "List numbering schemes: [[1]], [[a]], [[A]], [[i]], [[I]]." );
+ sink.paragraph_();
+
+ sink.definitionList();
+ sink.definitionListItem();
+ sink.definedTerm();
+ sink.text( "Defined term 1" );
+ sink.definedTerm_();
+ sink.definition();
+ sink.paragraph();
+ sink.text( "of definition list." );
+ sink.paragraph_();
+ sink.definition_();
+ sink.definitionListItem_();
+ sink.definitionListItem();
+ sink.definedTerm();
+ sink.text( "Defined term 2" );
+ sink.definedTerm_();
+ sink.definition();
+ sink.paragraph();
+ sink.text( "of definition list." );
+ sink.paragraph_();
+ sink.verbatim( true );
+ sink.text( "Verbatim text\n in a box " );
+ sink.verbatim_();
+ sink.definition_();
+ sink.definitionListItem_();
+ sink.definitionList_();
+
+ sink.paragraph();
+ sink.text( "--- instead of +-- suppresses the box around verbatim text." );
+ sink.paragraph_();
+
+ sink.figure();
+ sink.figureGraphics( "figure" );
+ sink.figureCaption();
+ sink.text( "Figure caption" );
+ sink.figureCaption_();
+ sink.figure_();
+
+ int[] justification =
+ {
+ Parser.JUSTIFY_CENTER, Parser.JUSTIFY_LEFT, Parser.JUSTIFY_RIGHT
+ };
+ sink.table();
+ sink.tableRows( justification, true );
+ sink.tableRow();
+ sink.tableHeaderCell();
+ sink.text( "Centered" );
+ sink.lineBreak();
+ sink.text( "cell 1,1" );
+ sink.tableHeaderCell_();
+ sink.tableHeaderCell();
+ sink.text( "Left-aligned" );
+ sink.lineBreak();
+ sink.text( "cell 1,2" );
+ sink.tableHeaderCell_();
+ sink.tableHeaderCell();
+ sink.text( "Right-aligned" );
+ sink.lineBreak();
+ sink.text( "cell 1,3" );
+ sink.tableHeaderCell_();
+ sink.tableRow_();
+ sink.tableRow();
+ sink.tableCell();
+ sink.text( "cell 2,1" );
+ sink.tableCell_();
+ sink.tableCell();
+ sink.text( "cell 2,2" );
+ sink.tableCell_();
+ sink.tableCell();
+ sink.text( "cell 2,3" );
+ sink.tableCell_();
+ sink.tableRow_();
+ sink.tableRows_();
+ sink.tableCaption();
+ sink.text( "Table caption" );
+ sink.tableCaption_();
+ sink.table_();
+
+ sink.paragraph();
+ sink.text( "No grid, no caption:" );
+ sink.paragraph_();
+
+ int[] justify =
+ {
+ Parser.JUSTIFY_CENTER, Parser.JUSTIFY_CENTER
+ };
+ sink.table();
+ sink.tableRows( justify, false );
+ sink.tableRow();
+ sink.tableCell();
+ sink.text( "cell" );
+ sink.tableCell_();
+ sink.tableCell();
+ sink.text( "cell" );
+ sink.tableCell_();
+ sink.tableRow_();
+ sink.tableRow();
+ sink.tableCell();
+ sink.text( "cell" );
+ sink.tableCell_();
+ sink.tableCell();
+ sink.text( "cell" );
+ sink.tableCell_();
+ sink.tableRow_();
+ sink.tableRows_();
+ sink.table_();
+
+ sink.paragraph();
+ sink.text( "Horizontal line:" );
+ sink.paragraph_();
+ sink.horizontalRule();
+
+ sink.pageBreak();
+ sink.paragraph();
+ sink.text( "New page." );
+ sink.paragraph_();
+
+ sink.paragraph();
+ sink.italic();
+ sink.text( "Italic" );
+ sink.italic_();
+ sink.text( " font. " );
+ sink.bold();
+ sink.text( "Bold" );
+ sink.bold_();
+ sink.text( " font. " );
+ sink.monospaced();
+ sink.text( "Monospaced" );
+ sink.monospaced_();
+ sink.text( " font." );
+ sink.paragraph_();
+
+ sink.paragraph();
+ sink.anchor( "Anchor" );
+ sink.text( "Anchor" );
+ sink.anchor_();
+ sink.text( ". Link to " );
+ sink.link( "Anchor" );
+ sink.text( "Anchor" );
+ sink.link_();
+ sink.text( ". Link to " );
+ sink.link( "http://www.pixware.fr" );
+ sink.text( "http://www.pixware.fr" );
+ sink.link_();
+ sink.text( ". Link to " );
+ sink.link( "Anchor" );
+ sink.text( "showing alternate text" );
+ sink.link_();
+ sink.text( ". Link to " );
+ sink.link( "http://www.pixware.fr" );
+ sink.text( "Pixware home page" );
+ sink.link_();
+ sink.text( "." );
+ sink.paragraph_();
+
+ sink.paragraph();
+ sink.text( "Force line" );
+ sink.lineBreak();
+ sink.text( "break." );
+ sink.paragraph_();
+
+ sink.paragraph();
+ sink.text( "Non" );
+ sink.nonBreakingSpace();
+ sink.text( "breaking" );
+ sink.nonBreakingSpace();
+ sink.text( "space." );
+ sink.paragraph_();
+
+ sink.paragraph();
+ sink.text( "Escaped special characters: " );
+ sink.text( "~, =, -, +, *, [, ], <, >, {, }, \\." );
+ sink.paragraph_();
+
+ sink.paragraph();
+ String copyright = String.valueOf( '\u00a9' );
+ sink.text( "Copyright symbol: " + copyright + ", "
+ + copyright + ", " + copyright + "." );
+ sink.paragraph_();
+
+ sink.section5_();
+ sink.section4_();
+ sink.section3_();
+ sink.section2_();
+ sink.section1_();
+
+ sink.body_();
+
+ sink.flush();
+ }
+
+}
Property changes on: src/test/java/org/apache/maven/doxia/sink/SinkTestDocument.java
___________________________________________________________________
Name: svn:keywords
+ "Author Date Id Revision"
Name: svn:eol-style
+ native