/*
    * Copyright 2012-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.properties.tutorial.property.list;
  
  import static org.hamcrest.MatcherAssert.assertThat;
  import static org.hamcrest.Matchers.contains;
  
  import java.net.URL;
  import java.util.List;
  
  import org.junit.Before;
  import org.junit.Test;
  
  import de.smartics.projectdoc.annotations.DocCategory;
  import de.smartics.projectdoc.annotations.Document;
  import de.smartics.projectdoc.annotations.topic.DocChapter;
  import de.smartics.projectdoc.annotations.topic.DocSection;
  import de.smartics.properties.api.config.domain.ConfigurationProperties;
  import de.smartics.properties.impl.config.classpath.ClasspathConfigurationProperties;
  import de.smartics.properties.impl.config.classpath.ClasspathConfigurationPropertiesFactory;
  
  /**
   * This tutorial introduces how declare properties for list values.
   * <p>
   * List of properties are defined like this:
   * </p>
   * {@insertCode file="ListProperties.properties"}
   */
  @Document(title = "List Properties", sortKey = "basics0100")
  @DocCategory({ "basics" })
  // @DocTopic(path="basics", step="100")
  public class ListPropertyTutorial
  {
    private ConfigurationProperties config; // NOPMD
  
    private ListProperties properties;
  
    @Before
    public void setUp()
    {
      config = createConfiguration();
      properties = config.getProperties(ListProperties.class);
    }
  
    private static ConfigurationProperties createConfiguration()
    {
      final ClasspathConfigurationPropertiesFactory factory =
          new ClasspathConfigurationPropertiesFactory();
      final ClasspathConfigurationProperties config = factory.create();
      config.addClassPathProperties(ListProperties.class);
      return config;
    }
  
    /**
     * <p>
     * Lists of strings are declared like this:
     * </p>
     * {@insertCode source="ListProperties#listOfStrings()"}
     * <p>
     * Accessing a list of values is straight forward.
     * </p>
     * {@insertCode}
     */
    @Test
    @DocChapter
    public void propertyWithValueOfTypeListOfString()
    {
      final List<String> list = properties.listOfStrings();
      assertThat(list, contains("one", "two", "three")); // NOPMD
    }
  
    /**
     * <p>
     * Lists of integers are declared like this:
     * </p>
     * {@insertCode source="ListProperties#listOfInts()"}
     * <p>
     * Accessing a list of values is straight forward.
     * </p>
     * {@insertCode}
     */
    @Test
    @DocChapter
    public void propertyWithValueOfTypeListOfInteger()
    {
      final List<Integer> list = properties.listOfInts();
     assertThat(list, contains(1, 2, 3));
   }
 
   /**
    * <p>
    * The elements are split by any non-alphanumeric character.
    * </p>
    */
   @Test
   @DocChapter
   public void separators()
   {
     final List<String> list = properties.listOfStrings();
     assertThat(list, contains("one", "two", "three"));
   }
 
   /**
    * <p>
    * Therefore the pipe is also a valid delimiter.
    * </p>
    */
   @Test
   @DocSection
   public void pipeAsSeparator()
   {
     final List<String> list = properties.pipedListOfStrings();
     assertThat(list, contains("one", "two", "three"));
   }
 
   /**
    * <p>
    * Therefore the pipe is also a valid delimiter.
    * </p>
    */
   @Test
   @DocSection
   public void blankAsSeparator()
   {
     final List<String> list = properties.blankedListOfStrings();
     assertThat(list, contains("one", "two", "three"));
   }
 
   /**
    * <p>
    * Every non-alpha-numeric character serves as a delimiter. We use Apache's
    * <a href="http://commons.apache.org/beanutils/">common-beanutils</a> for
    * the conversion of values.
    * </p>
    * <p>
    * As you can see in the properties file, elements that contain spaces or a
    * separator are set in double quotes.
    * </p>
    */
   @Test
   @DocSection
   public void propertyWithSpecialStrings()
   {
     final List<String> list = properties.extremeListOfStrings();
     assertThat(list,
         contains("one", "two two", "three three three", "comma',", "\"hey!\""));
   }
 
   /**
    * <p>
    * Lists of URLs are declared like this:
    * </p>
    * {@insertCode source="ListProperties#listOfUrls()"}
    * <p>
    * Accessing a list of values is straight forward.
    * </p>
    * {@insertCode}
    * <p>
    * Since a comma is a valid character in an URL, the comma is not a valid
    * separator to specify URLs. The default separation character is the pipe
    * (<code>|</code>). Therefore URLs are best separated one on each line with
    * a leading pipe.
    */
   @Test
   @DocChapter
   public void propertyWithValueOfTypeListOfUrl() throws Exception
   {
     final List<URL> list = properties.listOfUrls();
     assertThat(
         list,
         contains(new URL("http://www.example.com/index.html"), new URL(
             "http://www.example.com/products.html"), new URL(
             "http://www.example.com/news.html")));
   }
 
   /**
    * <p>
    * But you may also separate URLs by whitespaces alone.
    * </p>
    */
   @DocSection
   public void urlsSeparatedByNewlines() throws Exception
   {
     final List<URL> list = properties.listOfNewLineUrls();
     assertThat(
         list,
         contains(new URL("http://www.example.com/index.html"), new URL(
             "http://www.example.com/products.html"), new URL(
             "http://www.example.com/news.html")));
   }
 
   /**
    * <p>
    * Lists of enums are declared like this:
    * </p>
    * {@insertCode source="ListProperties#listOfPriorities()"}
    * <p>
    * Accessing a list of values is straight forward.
    * </p>
    * {@insertCode}
    */
   @Test
   @DocChapter
   public void propertyWithValueOfTypeListOfEnums()
   {
     final List<Priority> list = properties.listOfPriorities();
     assertThat(
         list,
         contains(Priority.REQUIRED, Priority.VERY_IMPORTANT,
             Priority.NICE_TO_HAVE));
   }
 }