/*
    * Copyright 2011-2013 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;
  
  /**
   * Tests {@link StringFunction#toHyphenVersion(String)}.
   */
  @Uut(type = StringFunction.class, method = "toHyphenVersion(String)")
  public class StringFunctionToHyphenVersionTest
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    // --- members --------------------------------------------------------------
  
    // ****************************** Inner Classes *****************************
  
    // ********************************* Methods ********************************
  
    // --- prepare --------------------------------------------------------------
  
    // --- helper ---------------------------------------------------------------
  
    @Test
    @TestDocHint(sentence = "toHyphenVersion: null -> null", indexSortKey = "001")
    public void returnsNullIfNullIsPassedAsArgument()
    {
      final String result = StringFunction.toHyphenVersion(null);
      assertThat(result, is(nullValue()));
    }
  
    @Test
    @TestDocHint(sentence = "toHyphenVersion: \"\" -> \"\"", indexSortKey = "002")
    public void returnsTheEmptyStringIfTheEmptyStringIsPassedAsArgument()
    {
      final String result = StringFunction.toHyphenVersion("");
      assertThat(result, is(equalTo("")));
    }
  
    @Test
    @TestDocHint(sentence = "toHyphenVersion: \"abc\" -> \"abc\"",
        indexSortKey = "003")
    public void hyphenVersionOfAllLowerCaseInputIsUnmodified()
    {
      final String result = StringFunction.toHyphenVersion("abc"); // NOPMD
      assertThat(result, is(equalTo("abc")));
    }
  
    @Test
    @TestDocHint(sentence = "toHyphenVersion: \"Abc\" -> \"abc\"",
        indexSortKey = "004")
    public void hyphenVersionOfFistLetterCapitalIsTransformedToAllLowerCase()
    {
      final String result = StringFunction.toHyphenVersion("Abc");
      assertThat(result, is(equalTo("abc")));
    }
  
    @Test
    @TestDocHint(sentence = "toHyphenVersion: \"a\" -> \"a\"",
        indexSortKey = "005")
    @Category(Technical.class)
    public void alsoWorksOnASingleLowerCaseLetter()
    {
      final String result = StringFunction.toHyphenVersion("a");
      assertThat(result, is(equalTo("a")));
    }
  
    @Test
    @TestDocHint(sentence = "toHyphenVersion: \"A\" -> \"a\"",
        indexSortKey = "006")
    @Category(Technical.class)
    public void alsoWorksOnASingleCapitalLetter()
    {
     final String result = StringFunction.toHyphenVersion("A");
     assertThat(result, is(equalTo("a")));
   }
 
   @Test
   @TestDocHint(sentence = "toHyphenVersion: \"aBc\" -> \"a-bc\"",
       indexSortKey = "010")
   public void hyphensACapitalLetter()
   {
     final String result = StringFunction.toHyphenVersion("aBc");
     assertThat(result, is(equalTo("a-bc")));
   }
 
   @Test
   @TestDocHint(
       sentence = "toHyphenVersion: \"thisIsACamleCaseExample\" -> \"this-is-a-camle-case-example\"",
       indexSortKey = "011")
   public void hyphensMultipleCapitalLetter()
   {
     final String result =
         StringFunction.toHyphenVersion("thisIsACamleCaseExample");
     assertThat(result, is(equalTo("this-is-a-camle-case-example")));
   }
   // --- tests ----------------------------------------------------------------
 
 }