/*
    * Copyright 2011-2012 smartics, Kronseder & Reiner GmbH
    *
    * Licensed 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 de.smartics.util.lang;
  
  import static org.hamcrest.CoreMatchers.equalTo;
  import static org.hamcrest.CoreMatchers.is;
  import static org.hamcrest.CoreMatchers.nullValue;
  import static org.hamcrest.MatcherAssert.assertThat;
  
  import org.junit.Test;
  import org.junit.experimental.categories.Category;
  
  import de.smartics.testdoc.annotations.TestDocHint;
  import de.smartics.testdoc.annotations.Uut;
  import de.smartics.testdoc.categories.Technical;
  import de.smartics.testdoc.categories.type.Coverage;
  
  /**
   * Tests {@link StringFunction#chop(StringBuilder)}.
   */
  @Uut(type = StringFunction.class, method = "chop(StringBuilder)")
  public class StringFunctionChopTest
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    // --- members --------------------------------------------------------------
  
    // ****************************** Inner Classes *****************************
  
    // ********************************* Methods ********************************
  
    // --- prepare --------------------------------------------------------------
  
    // --- helper ---------------------------------------------------------------
  
    @Test
    @TestDocHint(sentence = "chop: null -> null", indexSortKey = "001")
    public void returnsNullIfNullIsPassedAsArgument()
    {
      final String result = StringFunction.chop(null);
      assertThat(result, is(nullValue()));
    }
  
    @Test
    @TestDocHint(sentence = "chop: \"\" -> \"\"", indexSortKey = "002")
    public void returnsTheEmptyStringIfTheEmptyStringIsPassedAsArgument()
    {
      final String result = StringFunction.chop(new StringBuilder(""));
      assertThat(result, is(equalTo("")));
    }
  
    @Test
    @TestDocHint(sentence = "chop: \"x\" -> \"\"", indexSortKey = "003")
    @Category(Technical.class)
    public void chopsTheLastCharacterIfThereIsOne()
    {
      final String result = StringFunction.chop(new StringBuilder("x"));
      assertThat(result, is(equalTo("")));
    }
  
    @Test
    @TestDocHint(sentence = "chop: \"abc\" -> \"ab\"", indexSortKey = "004")
    public void chopsTheLastCharacterIfNotEmpty()
    {
      final String result = StringFunction.chop(new StringBuilder("abc"));
      assertThat(result, is(equalTo("ab")));
    }
  
    @Test
    @TestDocHint(sentence = "chop: \"abc\\r\\n\" -> \"abc\"",
        indexSortKey = "005")
    public void chopsCarrigeReturnNewLineAsOneCharacter()
    {
      final String result = StringFunction.chop(new StringBuilder("abc\r\n"));
      assertThat(result, is(equalTo("abc")));
    }
  
    @Test
    @TestDocHint(sentence = "chop: \"\\r\" -> \"\"", indexSortKey = "006")
    @Category(Technical.class)
    public void chopsCarrigeReturnWithoutNewLineAsOneChar()
    {
      final String result = StringFunction.chop(new StringBuilder("\r"));
      assertThat(result, is(equalTo("")));
   }
 
   @Test
   @TestDocHint(sentence = "chop: \"\\r\\n\" -> \"\"", indexSortKey = "007")
   @Category(Technical.class)
   public void chopsCarrigeReturnNewLineAsOneCharacterIfTheyAreTheOnlyChars()
   {
     final String result = StringFunction.chop(new StringBuilder("\r\n"));
     assertThat(result, is(equalTo("")));
   }
 
   @Test
   @TestDocHint(sentence = "chop: \"\\n\" -> \"\"", indexSortKey = "008")
   @Category(Technical.class)
   public void handlesASingleNewlineCorrectly()
   {
     final String result = StringFunction.chop(new StringBuilder("\n"));
     assertThat(result, is(equalTo("")));
   }
 
   @Test
   @TestDocHint(sentence = "chop: \"ab\\n\" -> \"ab\"", indexSortKey = "009")
   @Category(Coverage.class)
   public void handlesLengthGreaterOneAndNewlineCorrectly()
   {
     final String result = StringFunction.chop(new StringBuilder("ab\n"));
     assertThat(result, is(equalTo("ab")));
   }
 
   @Test
   @TestDocHint(sentence = "chop: \"\\r\" -> \"\"", indexSortKey = "010")
   @Category(Technical.class)
   public void handlesASingleCarrigeReturnCorrectly()
   {
     final String result = StringFunction.chop(new StringBuilder("\r"));
     assertThat(result, is(equalTo("")));
   }
 
   // --- tests ----------------------------------------------------------------
 
 }