You are viewing a plain text version of this content. The canonical link for it is here.
Posted to doxia-commits@maven.apache.org by lt...@apache.org on 2007/12/16 21:18:43 UTC
svn commit: r604692 - in
/maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src:
main/java/org/apache/maven/doxia/module/twiki/TWikiParser.java
test/java/org/apache/maven/doxia/module/twiki/parser/TitleTest.java
Author: ltheussl
Date: Sun Dec 16 12:18:42 2007
New Revision: 604692
URL: http://svn.apache.org/viewvc?rev=604692&view=rev
Log:
[DOXIA-195] Guess a title for the parsed page
Submitted by: Juan F. Codagnone, Christian Nardi
Added:
maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/test/java/org/apache/maven/doxia/module/twiki/parser/TitleTest.java (with props)
Modified:
maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/TWikiParser.java
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/TWikiParser.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/TWikiParser.java?rev=604692&r1=604691&r2=604692&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/TWikiParser.java (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/TWikiParser.java Sun Dec 16 12:18:42 2007
@@ -25,6 +25,7 @@
import org.apache.maven.doxia.module.twiki.parser.GenericListBlockParser;
import org.apache.maven.doxia.module.twiki.parser.HRuleBlockParser;
import org.apache.maven.doxia.module.twiki.parser.ParagraphBlockParser;
+import org.apache.maven.doxia.module.twiki.parser.SectionBlock;
import org.apache.maven.doxia.module.twiki.parser.SectionBlockParser;
import org.apache.maven.doxia.module.twiki.parser.TableBlockParser;
import org.apache.maven.doxia.module.twiki.parser.TextParser;
@@ -34,6 +35,7 @@
import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.doxia.util.ByLineReaderSource;
import org.apache.maven.doxia.util.ByLineSource;
+import org.codehaus.plexus.util.StringUtils;
import java.io.Reader;
import java.util.ArrayList;
@@ -173,6 +175,15 @@
}
sink.head();
+
+ final String title = getTitle( blocks, source );
+ if( title != null )
+ {
+ sink.title();
+ sink.text( title );
+ sink.title_();
+ }
+
sink.head_();
sink.body();
for ( Iterator it = blocks.iterator(); it.hasNext(); )
@@ -182,5 +193,52 @@
block.traverse( sink );
}
sink.body_();
+ }
+
+ /**
+ * Guess a title for the page. It uses the first section that it finds.
+ * If it doesn't find any section tries to get it from
+ * {@link ByLineReaderSource#getName()}
+ *
+ * @return a title for a page
+ */
+ public final String getTitle( final List blocks, final ByLineSource source )
+ {
+ String title = null;
+
+ for ( Iterator it = blocks.iterator(); title == null && it.hasNext(); )
+ {
+ final Block block = (Block) it.next();
+
+ if( block instanceof SectionBlock )
+ {
+ final SectionBlock sectionBlock = (SectionBlock) block;
+ title = sectionBlock.getTitle();
+ }
+ }
+
+ if( title == null )
+ {
+ String name = source.getName();
+ if( name != null )
+ {
+ name = name.trim();
+
+ if( name.length() != 0 )
+ {
+ if(name.endsWith(".twiki"))
+ {
+ title = name.substring( 0, name.length() - 6 );
+ }
+ else
+ {
+ title = name;
+ }
+ }
+ }
+
+ }
+
+ return title;
}
}
Added: maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/test/java/org/apache/maven/doxia/module/twiki/parser/TitleTest.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/test/java/org/apache/maven/doxia/module/twiki/parser/TitleTest.java?rev=604692&view=auto
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/test/java/org/apache/maven/doxia/module/twiki/parser/TitleTest.java (added)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/test/java/org/apache/maven/doxia/module/twiki/parser/TitleTest.java Sun Dec 16 12:18:42 2007
@@ -0,0 +1,129 @@
+/*
+ * 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.
+ */
+package org.apache.maven.doxia.module.twiki.parser;
+
+import java.io.Reader;
+import java.io.StringReader;
+
+import org.apache.maven.doxia.module.twiki.TWikiParser;
+import org.apache.maven.doxia.parser.ParseException;
+import org.apache.maven.doxia.util.ByLineReaderSource;
+import org.apache.maven.doxia.util.ByLineSource;
+
+/**
+ * Tests for {@link TWikiParser#getTitle(java.util.List)}
+ *
+ *
+ * @author Juan F. Codagnone
+ * @since Nov 10, 2007
+ */
+public class TitleTest extends AbstractBlockTestCase
+{
+
+ public void testSectionTitle() throws Exception
+ {
+ final ByLineSource source = new ByLineReaderSource(
+ new StringReader( "---++ Test\n hello world" ) );
+
+ final TWikiParser twikiParser = new TWikiParser();
+
+ assertEquals("Test", twikiParser.getTitle( twikiParser.parse(source),
+ source ) );
+ }
+
+ public void testNoSectionTitle() throws Exception
+ {
+ final ByLineSource source = new NamedByLineSource(
+ new ByLineReaderSource(
+ new StringReader( "hello world" )), "testpage" );
+
+ final TWikiParser twikiParser = new TWikiParser();
+
+ assertEquals("testpage", twikiParser.getTitle( twikiParser.parse(source),
+ source ) );
+ }
+
+ public void testNoSectionTwikiExtensionTitle() throws Exception
+ {
+ final ByLineSource source = new NamedByLineSource(
+ new ByLineReaderSource(
+ new StringReader( "hello world" )), "testpage.twiki" );
+
+ final TWikiParser twikiParser = new TWikiParser();
+
+ assertEquals("testpage", twikiParser.getTitle( twikiParser.parse(source),
+ source ) );
+ }
+
+}
+
+class NamedByLineSource implements ByLineSource
+{
+ /** reader */
+ private final ByLineReaderSource reader;
+ /** reader's name */
+ private final String name;
+
+ public NamedByLineSource( final ByLineReaderSource reader, final String name )
+ {
+ if( reader == null || name == null ) {
+ throw new IllegalArgumentException("null arguments are not allowed");
+ }
+
+ this.reader = reader;
+ this.name = name;
+ }
+
+ /** @see ByLineReaderSource#close() */
+ public final void close()
+ {
+ reader.close();
+ }
+
+ /** @see ByLineReaderSource#getLineNumber() */
+ public final int getLineNumber()
+ {
+ return reader.getLineNumber();
+ }
+
+ /** @see ByLineReaderSource#getName() */
+ public final String getName()
+ {
+ return name;
+ }
+
+ /** @see ByLineReaderSource#getNextLine() */
+ public final String getNextLine() throws ParseException
+ {
+ return reader.getNextLine();
+ }
+
+
+ /** @see ByLineReaderSource#unget(java.lang.String) */
+ public final void unget( final String s ) throws IllegalStateException
+ {
+ reader.unget(s);
+ }
+
+ /** @see ByLineReaderSource#ungetLine() */
+ public final void ungetLine() throws IllegalStateException
+ {
+ reader.ungetLine();
+ }
+}
\ No newline at end of file
Propchange: maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/test/java/org/apache/maven/doxia/module/twiki/parser/TitleTest.java
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/test/java/org/apache/maven/doxia/module/twiki/parser/TitleTest.java
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"