/*
    * 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.key;
  
  import static org.hamcrest.MatcherAssert.assertThat;
  import static org.hamcrest.Matchers.is;
  
  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.core.domain.PropertyKey;
  import de.smartics.properties.impl.config.classpath.ClasspathConfigurationProperties;
  import de.smartics.properties.impl.config.classpath.ClasspathConfigurationPropertiesFactory;
  
  /**
   * This tutorial introduces shows how to declare a property whose property key
   * is required at runtime.
   */
  @Document(title = "Accessing Property Keys", sortKey = "basics0070")
  @DocCategory({ "basics" })
  // @DocTopic(path="basics", step="70")
  public class PropertyKeyAccessTutorial
  {
    private ClasspathConfigurationProperties config; // NOPMD
  
    private DescriptorAndKeyProperties properties;
  
    @Before
    public void setUp()
    {
      config = createConfiguration();
      properties = config.getProperties(DescriptorAndKeyProperties.class);
    }
  
    private static ClasspathConfigurationProperties createConfiguration()
    {
      final ClasspathConfigurationPropertiesFactory factory =
          new ClasspathConfigurationPropertiesFactory();
      final ClasspathConfigurationProperties config = factory.create();
      config.addClassPathProperties(DescriptorAndKeyProperties.class);
      return config;
    }
  
    /**
     * <p>
     * We have shown how the descriptor of a property can be made available in the
     * {@link de.smartics.properties.tutorial.property.PropertyTutorial}. We also
     * mentioned that a property key can be retrieved without the need of fetching
     * the whole property descriptor. Now let's look at how to declare this!
     * </p>
     * <p>
     * As you may have anticipated, declaring access to a property is quite simple
     * and analogous to declaring access to a property descriptor.
     * </p>
     * {@insertCode source="DescriptorAndKeyProperties"}
     * <p>
     * Accessing the property key information is also straight forward:
     * </p>
     * {@insertCode}
     */
    @DocChapter
    @Test
    public void declarationOfAProperty()
    {
      final PropertyKey key = properties.hostPropertyKey();
  
      assertThat(key.getPropertySet(), is("tutorial.property.key"));
      assertThat(key.getName(), is("host"));
    }
  }