commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From scolebou...@apache.org
Subject cvs commit: jakarta-commons/lang/src/test/org/apache/commons/lang WordUtilsTest.java LangTestSuite.java WordWrapUtilsTest.java
Date Sun, 17 Aug 2003 21:57:37 GMT
scolebourne    2003/08/17 14:57:37

  Modified:    lang/src/test/org/apache/commons/lang LangTestSuite.java
  Added:       lang/src/java/org/apache/commons/lang WordUtils.java
               lang/src/test/org/apache/commons/lang WordUtilsTest.java
  Removed:     lang/src/java/org/apache/commons/lang WordWrapUtils.java
               lang/src/test/org/apache/commons/lang WordWrapUtilsTest.java
  Log:
  Rename WordWrapUtils to WordUtils
  Refactor wrapLine method, making it public and work properly
  Remove wrapText method
  Test
  
  Revision  Changes    Path
  1.1                  jakarta-commons/lang/src/java/org/apache/commons/lang/WordUtils.java
  
  Index: WordUtils.java
  ===================================================================
  /* ====================================================================
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 2002-2003 The Apache Software Foundation.  All rights
   * reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions
   * are met:
   *
   * 1. Redistributions of source code must retain the above copyright
   *    notice, this list of conditions and the following disclaimer.
   *
   * 2. Redistributions in binary form must reproduce the above copyright
   *    notice, this list of conditions and the following disclaimer in
   *    the documentation and/or other materials provided with the
   *    distribution.
   *
   * 3. The end-user documentation included with the redistribution, if
   *    any, must include the following acknowlegement:
   *       "This product includes software developed by the
   *        Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowlegement may appear in the software itself,
   *    if and wherever such third-party acknowledgements normally appear.
   *
   * 4. The names "The Jakarta Project", "Commons", and "Apache Software
   *    Foundation" must not be used to endorse or promote products derived
   *    from this software without prior written permission. For written
   *    permission, please contact apache@apache.org.
   *
   * 5. Products derived from this software may not be called "Apache"
   *    nor may "Apache" appear in their names without prior written
   *    permission of the Apache Software Foundation.
   *
   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   * SUCH DAMAGE.
   * ====================================================================
   *
   * This software consists of voluntary contributions made by many
   * individuals on behalf of the Apache Software Foundation.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   */
  package org.apache.commons.lang;
  
  /**
   * <p><code>WordUtils</code> is a utility class to assist with word wrapping.</p>
   * 
   * <p>This class tries to handle <code>null</code> input gracefully.
   * An exception will not be thrown for a <code>null</code> input.
   * Each method documents its behaviour in more detail.</p>
   * 
   * @author Apache Jakarta Velocity
   * @author Henri Yandell
   * @author Stephen Colebourne
   * @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a>
   * @author <a href="mailto:ggregory@seagullsw.com">Gary Gregory</a>
   * @since 2.0
   * @version $Id: WordUtils.java,v 1.1 2003/08/17 21:57:37 scolebourne Exp $
   */
  public class WordUtils {
  
      /**
       * <p><code>WordWrapUtils</code> instances should NOT be constructed
in
       * standard programming. Instead, the class should be used as
       * <code>WordWrapUtils.wrap("foo bar", 20);</code>.</p>
       *
       * <p>This constructor is public to permit tools that require a JavaBean
       * instance to operate.</p>
       */
      public WordUtils() {
      }
  
      // Wrapping
      //--------------------------------------------------------------------------
  //    /**
  //     * <p>Wraps a block of text to a specified line length using '\n' as
  //     * a newline.</p>
  //     *
  //     * <p>This method takes a block of text, which might have long lines in it
  //     * and wraps the long lines based on the supplied lineLength parameter.</p>
  //     * 
  //     * <p>If a single word is longer than the line length (eg. a URL), it will
  //     * not be broken, and will display beyond the expected width.</p>
  //     * 
  //     * <p>If there are tabs in inString, you are going to get results that are
  //     * a bit strange. Tabs are a single character but are displayed as 4 or 8
  //     * spaces. Remove the tabs.</p>
  //     *
  //     * @param str  text which is in need of word-wrapping, may be null
  //     * @param lineLength  the column to wrap the words at
  //     * @return the text with all the long lines word-wrapped
  //     *  <code>null</code> if null string input
  //     */
  //    public static String wrapText(String str, int lineLength) {
  //        return wrap(str, null, lineLength);
  //    }
      
  //    /**
  //     * <p>Wraps a block of text to a specified line length.</p>
  //     *
  //     * <p>This method takes a block of text, which might have long lines in it
  //     * and wraps the long lines based on the supplied lineLength parameter.</p>
  //     * 
  //     * <p>If a single word is longer than the wrapColumn (eg. a URL), it will
  //     * not be broken, and will display beyond the expected width.</p>
  //     * 
  //     * <p>If there are tabs in inString, you are going to get results that are
  //     * a bit strange. Tabs are a single character but are displayed as 4 or 8
  //     * spaces. Remove the tabs.</p>
  //     *
  //     * @param str  text which is in need of word-wrapping, may be null
  //     * @param newLineChars  the characters that define a newline, null treated as \n
  //     * @param lineLength  the column to wrap the words at
  //     * @return the text with all the long lines word-wrapped
  //     *  <code>null</code> if null string input
  //     */
  //    public static String wrapText(String str, String newLineChars, int lineLength) {
  //        if (str == null) {
  //            return null;
  //        }
  //        if (newLineChars == null) {
  //            newLineChars = "\n";
  //        }
  //        StringTokenizer lineTokenizer = new StringTokenizer(str, newLineChars, true);
  //        StringBuffer stringBuffer = new StringBuffer();
  //
  //        while (lineTokenizer.hasMoreTokens()) {
  //            try {
  //                String nextLine = lineTokenizer.nextToken();
  //
  //                if (nextLine.length() > lineLength) {
  //                    // This line is long enough to be wrapped.
  //                    nextLine = wrapLine(nextLine, null, lineLength, false);
  //                }
  //
  //                stringBuffer.append(nextLine);
  //
  //            } catch (NoSuchElementException nsee) {
  //                // thrown by nextToken(), but I don't know why it would
  //                break;
  //            }
  //        }
  //
  //        return (stringBuffer.toString());
  //    }
  
      /**
       * <p>Wraps a single line of text, identifying words by <code>' '</code>.</p>
       * 
       * <p>New lines will be separated by the system property line separator.
       * Very long words, such as URLs will <i>not</i> be wrapped.</p>
       * 
       * <p>Leading spaces on a new line are stripped.
       * Trailing spaces are not stripped.</p>
       *
       * <pre>
       * WordUtils.wrap(null, *) = null
       * WordUtils.wrap("", *) = null
       * </pre>
       *
       * @param str  the String to be word wrapped, may be null
       * @param wrapLength  the column to wrap the words at, less than 1 is treated as 1
       * @return a line with newlines inserted, <code>null</code> if null input
       */
      public static String wrap(String str, int wrapLength) {
          return wrap(str, wrapLength, null, false);
      }
      
      /**
       * <p>Wraps a single line of text, identifying words by <code>' '</code>.</p>
       * 
       * <p>Leading spaces on a new line are stripped.
       * Trailing spaces are not stripped.</p>
       * 
       * <pre>
       * WordUtils.wrap(null, *, *, *) = null
       * WordUtils.wrap("", *, *, *) = null
       * </pre>
       *
       * @param str  the String to be word wrapped, may be null
       * @param wrapLength  the column to wrap the words at, less than 1 is treated as 1
       * @param newLineStr  the string to insert for a new line, 
       *  <code>null</code> uses the system property line separator
       * @param wrapLongWords  true if long words (such as URLs) should be wrapped
       * @return a line with newlines inserted, <code>null</code> if null input
       */
      public static String wrap(String str, int wrapLength, String newLineStr, boolean wrapLongWords)
{
          if (str == null) {
              return null;
          }
          if (newLineStr == null) {
              newLineStr = SystemUtils.LINE_SEPARATOR;
          }
          if (wrapLength < 1) {
              wrapLength = 1;
          }
          int inputLineLength = str.length();
          int offset = 0;
          StringBuffer wrappedLine = new StringBuffer(inputLineLength + 32);
          
          while ((inputLineLength - offset) > wrapLength) {
              if (str.charAt(offset) == ' ') {
                  offset++;
                  continue;
              }
              int spaceToWrapAt = str.lastIndexOf(' ', wrapLength + offset);
  
              if (spaceToWrapAt >= offset) {
                  // normal case
                  wrappedLine.append(str.substring(offset, spaceToWrapAt));
                  wrappedLine.append(newLineStr);
                  offset = spaceToWrapAt + 1;
                  
              } else {
                  // really long word or URL
                  if (wrapLongWords) {
                      // wrap really long word one line at a time
                      wrappedLine.append(str.substring(offset, wrapLength + offset));
                      wrappedLine.append(newLineStr);
                      offset += wrapLength;
                  } else {
                      // do not wrap really long word, just extend beyond limit
                      spaceToWrapAt = str.indexOf(' ', wrapLength + offset);
                      if (spaceToWrapAt >= 0) {
                          wrappedLine.append(str.substring(offset, spaceToWrapAt));
                          wrappedLine.append(newLineStr);
                          offset = spaceToWrapAt + 1;
                      } else {
                          wrappedLine.append(str.substring(offset));
                          offset = inputLineLength;
                      }
                  }
              }
          }
  
          // Whatever is left in line is short enough to just pass through
          wrappedLine.append(str.substring(offset));
  
          return wrappedLine.toString();
      }
  
  }
  
  
  
  1.21      +1 -0      jakarta-commons/lang/src/test/org/apache/commons/lang/LangTestSuite.java
  
  Index: LangTestSuite.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/lang/src/test/org/apache/commons/lang/LangTestSuite.java,v
  retrieving revision 1.20
  retrieving revision 1.21
  diff -u -r1.20 -r1.21
  --- LangTestSuite.java	17 Aug 2003 19:41:17 -0000	1.20
  +++ LangTestSuite.java	17 Aug 2003 21:57:37 -0000	1.21
  @@ -112,6 +112,7 @@
           suite.addTest(StringEscapeUtilsTest.suite());
           suite.addTest(SystemUtilsTest.suite());
           suite.addTest(UnhandledExceptionTest.suite());
  +        suite.addTest(WordUtilsTest.suite());
           return suite;
       }
   }
  
  
  
  1.1                  jakarta-commons/lang/src/test/org/apache/commons/lang/WordUtilsTest.java
  
  Index: WordUtilsTest.java
  ===================================================================
  /* ====================================================================
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 2002-2003 The Apache Software Foundation.  All rights
   * reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions
   * are met:
   *
   * 1. Redistributions of source code must retain the above copyright
   *    notice, this list of conditions and the following disclaimer.
   *
   * 2. Redistributions in binary form must reproduce the above copyright
   *    notice, this list of conditions and the following disclaimer in
   *    the documentation and/or other materials provided with the
   *    distribution.
   *
   * 3. The end-user documentation included with the redistribution, if
   *    any, must include the following acknowlegement:
   *       "This product includes software developed by the
   *        Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowlegement may appear in the software itself,
   *    if and wherever such third-party acknowlegements normally appear.
   *
   * 4. The names "The Jakarta Project", "Commons", and "Apache Software
   *    Foundation" must not be used to endorse or promote products derived
   *    from this software without prior written permission. For written
   *    permission, please contact apache@apache.org.
   *
   * 5. Products derived from this software may not be called "Apache"
   *    nor may "Apache" appear in their names without prior written
   *    permission of the Apache Software Foundation.
   *
   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   * SUCH DAMAGE.
   * ====================================================================
   *
   * This software consists of voluntary contributions made by many
   * individuals on behalf of the Apache Software Foundation.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   */
  package org.apache.commons.lang;
  
  import java.lang.reflect.Constructor;
  import java.lang.reflect.Modifier;
  
  import junit.framework.Test;
  import junit.framework.TestCase;
  import junit.framework.TestSuite;
  
  /**
   * Unit tests for WordUtils class.
   * 
   * @author <a href="mailto:ridesmet@users.sourceforge.net">Ringo De Smet</a>
   * @author Henri Yandell
   * @author Stephen Colebourne
   * @version $Id: WordUtilsTest.java,v 1.1 2003/08/17 21:57:37 scolebourne Exp $
   */
  public class WordUtilsTest extends TestCase {
  
      public WordUtilsTest(String name) {
          super(name);
      }
  
      public static Test suite() {
          TestSuite suite = new TestSuite(WordUtilsTest.class);
          suite.setName("WordUtilsTests");
          return suite;
      }
  
      //-----------------------------------------------------------------------
      public void testConstructor() {
          assertNotNull(new WordUtils());
          Constructor[] cons = WordUtils.class.getDeclaredConstructors();
          assertEquals(1, cons.length);
          assertEquals(true, Modifier.isPublic(cons[0].getModifiers()));
          assertEquals(true, Modifier.isPublic(WordUtils.class.getModifiers()));
          assertEquals(false, Modifier.isFinal(WordUtils.class.getModifiers()));
      }
      
      //-----------------------------------------------------------------------
      public void testWrap_StringInt() {
          assertEquals(null, WordUtils.wrap(null, 20));
          assertEquals(null, WordUtils.wrap(null, -1));
          
          assertEquals("", WordUtils.wrap("", 20));
          assertEquals("", WordUtils.wrap("", -1));
          
          // normal
          String systemNewLine = System.getProperty("line.separator");
          String input = "Here is one line of text that is going to be wrapped after 20 columns.";
          String expected = "Here is one line of" + systemNewLine + "text that is going" 
              + systemNewLine + "to be wrapped after" + systemNewLine + "20 columns.";
          assertEquals(expected, WordUtils.wrap(input, 20));
          
          // long word at end
          input = "Click here to jump to the jakarta website - http://jakarta.apache.org";
          expected = "Click here to jump" + systemNewLine + "to the jakarta" + systemNewLine

              + "website -" + systemNewLine + "http://jakarta.apache.org";
          assertEquals(expected, WordUtils.wrap(input, 20));
          
          // long word in middle
          input = "Click here, http://jakarta.apache.org, to jump to the jakarta website";
          expected = "Click here," + systemNewLine + "http://jakarta.apache.org," + systemNewLine

              + "to jump to the" + systemNewLine + "jakarta website";
          assertEquals(expected, WordUtils.wrap(input, 20));
      }
      
      public void testWrap_StringIntStringBoolean() {
          assertEquals(null, WordUtils.wrap(null, 20, "\n", false));
          assertEquals(null, WordUtils.wrap(null, 20, "\n", true));
          assertEquals(null, WordUtils.wrap(null, 20, null, true));
          assertEquals(null, WordUtils.wrap(null, 20, null, false));
          assertEquals(null, WordUtils.wrap(null, -1, null, true));
          assertEquals(null, WordUtils.wrap(null, -1, null, false));
          
          assertEquals("", WordUtils.wrap("", 20, "\n", false));
          assertEquals("", WordUtils.wrap("", 20, "\n", true));
          assertEquals("", WordUtils.wrap("", 20, null, false));
          assertEquals("", WordUtils.wrap("", 20, null, true));
          assertEquals("", WordUtils.wrap("", -1, null, false));
          assertEquals("", WordUtils.wrap("", -1, null, true));
          
          // normal
          String input = "Here is one line of text that is going to be wrapped after 20 columns.";
          String expected = "Here is one line of\ntext that is going\nto be wrapped after\n20
columns.";
          assertEquals(expected, WordUtils.wrap(input, 20, "\n", false));
          assertEquals(expected, WordUtils.wrap(input, 20, "\n", true));
  
          // unusual newline char
          input = "Here is one line of text that is going to be wrapped after 20 columns.";
          expected = "Here is one line of<br />text that is going<br />to be wrapped
after<br />20 columns.";
          assertEquals(expected, WordUtils.wrap(input, 20, "<br />", false));
          assertEquals(expected, WordUtils.wrap(input, 20, "<br />", true));
  
          // short line length
          input = "Here is one line";
          expected = "Here\nis one\nline";
          assertEquals(expected, WordUtils.wrap(input, 6, "\n", false));
          expected = "Here\nis\none\nline";
          assertEquals(expected, WordUtils.wrap(input, 2, "\n", false));
          assertEquals(expected, WordUtils.wrap(input, -1, "\n", false));
  
          // system newline char
          String systemNewLine = System.getProperty("line.separator");
          input = "Here is one line of text that is going to be wrapped after 20 columns.";
          expected = "Here is one line of" + systemNewLine + "text that is going" + systemNewLine

              + "to be wrapped after" + systemNewLine + "20 columns.";
          assertEquals(expected, WordUtils.wrap(input, 20, null, false));
          assertEquals(expected, WordUtils.wrap(input, 20, null, true));
  
          // with extra spaces
          input = " Here:  is  one  line  of  text  that  is  going  to  be  wrapped  after
 20  columns.";
          expected = "Here:  is  one  line\nof  text  that  is \ngoing  to  be \nwrapped 
after  20 \ncolumns.";
          assertEquals(expected, WordUtils.wrap(input, 20, "\n", false));
          assertEquals(expected, WordUtils.wrap(input, 20, "\n", true));
          
          // with tab
          input = "Here is\tone line of text that is going to be wrapped after 20 columns.";
          expected = "Here is\tone line of\ntext that is going\nto be wrapped after\n20 columns.";
          assertEquals(expected, WordUtils.wrap(input, 20, "\n", false));
          assertEquals(expected, WordUtils.wrap(input, 20, "\n", true));
          
          // with tab at wrapColumn
          input = "Here is one line of\ttext that is going to be wrapped after 20 columns.";
          expected = "Here is one line\nof\ttext that is\ngoing to be wrapped\nafter 20 columns.";
          assertEquals(expected, WordUtils.wrap(input, 20, "\n", false));
          assertEquals(expected, WordUtils.wrap(input, 20, "\n", true));
          
          // difference because of long word
          input = "Click here to jump to the jakarta website - http://jakarta.apache.org";
          expected = "Click here to jump\nto the jakarta\nwebsite -\nhttp://jakarta.apache.org";
          assertEquals(expected, WordUtils.wrap(input, 20, "\n", false));
          expected = "Click here to jump\nto the jakarta\nwebsite -\nhttp://jakarta.apach\ne.org";
          assertEquals(expected, WordUtils.wrap(input, 20, "\n", true));
          
          // difference because of long word in middle
          input = "Click here, http://jakarta.apache.org, to jump to the jakarta website";
          expected = "Click here,\nhttp://jakarta.apache.org,\nto jump to the\njakarta website";
          assertEquals(expected, WordUtils.wrap(input, 20, "\n", false));
          expected = "Click here,\nhttp://jakarta.apach\ne.org, to jump to\nthe jakarta website";
          assertEquals(expected, WordUtils.wrap(input, 20, "\n", true));
  //        System.err.println(expected);
  //        System.err.println(WordUtils.wrap(input, 20, "\n", false));
      }
  }
  
  
  

Mime
View raw message