/*
    * 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.metadata;
  
  import static org.hamcrest.MatcherAssert.assertThat;
  import static org.hamcrest.Matchers.empty;
  import static org.hamcrest.Matchers.is;
  import static org.hamcrest.Matchers.nullValue;
  
  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.properties.api.config.domain.ConfigurationProperties;
  import de.smartics.properties.api.core.domain.DocumentMetaData;
  import de.smartics.properties.api.core.domain.PropertyDescriptor;
  import de.smartics.properties.impl.config.classpath.ClasspathConfigurationProperties;
  import de.smartics.properties.impl.config.classpath.ClasspathConfigurationPropertiesFactory;
  
  /**
   * This tutorial introduces to the document meta data that allows to integrate
   * the documentation of properties into a project documentation.
   */
  @Document(title = "Property Metadata", sortKey = "basics0040")
  @DocCategory({ "basics" })
  // @DocTopic(path="basics", step="40")
  public class PropertyMetaDataTutorial
  {
    private ConfigurationProperties config; // NOPMD
  
    private MetaDataProperties properties;
  
    @Before
    public void setUp()
    {
      config = createConfiguration();
      properties = config.getProperties(MetaDataProperties.class);
    }
  
    private static ConfigurationProperties createConfiguration()
    {
      final ClasspathConfigurationPropertiesFactory factory =
          new ClasspathConfigurationPropertiesFactory();
      final ClasspathConfigurationProperties config = factory.create();
      config.addClassPathProperties(MetaDataProperties.class);
      return config;
    }
  
    /**
     * If no further metadata is attached to a properties set, the following
     * metadata is created per default.
     * <ol>
     * <li>Title of the document: defaults to the fully qualified name of the
     * property</li>
     * <li>The space within which the title is unique: defaults to the type that
     * declares the property</li>
     * <li>The unique name of the document: defaults to the fully qualified name
     * of the property, too</li>
     * </ol>
     * {@insertCode}
     */
    @DocChapter
    @Test
    public void defaultMetaData()
    {
      final PropertyDescriptor descriptor = properties.hostPropertyDescriptor();
  
      final DocumentMetaData metaData = descriptor.getDocumentMetaData();
      assertThat(metaData.getCategories(), is(empty()));
      assertThat(metaData.getTags(), is(empty()));
      assertThat(metaData.getParents(), is(empty()));
      assertThat(metaData.getAudience(), is(empty()));
  
      assertThat(metaData.getNotes(), is(empty()));
      assertThat(metaData.getShortDescription(), is(nullValue()));
      assertThat(metaData.getSummary(), is(nullValue()));
      assertThat(metaData.getTitle(), is("tutorial.property.metadata.host"));
      assertThat(metaData.getSortKey(), is(nullValue()));
  
      assertThat(
          metaData.getSpace(),
          is("property:de.smartics.properties.tutorial.property.metadata.MetaDataProperties"));
      assertThat(metaData.getName(), is("tutorial.property.metadata.host"));
    }
 
   /**
    * PENDING: Show how to add documentation metadata.
    */
   @DocChapter
   @Test
   public void documentationMetaData()
   {
   }
 }