/*
    * #%L
    * wcm.io
    * %%
    * Copyright (C) 2018 wcm.io
    * %%
    * 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.
   * #L%
   */
  package io.wcm.qa.glnm.maven.freemarker.util;
  
  import java.io.File;
  import java.util.ArrayList;
  import java.util.List;
  
  import org.apache.commons.io.FilenameUtils;
  import org.apache.commons.lang3.StringUtils;
  
  import com.google.common.base.CaseFormat;
  
  import io.wcm.qa.glnm.maven.freemarker.pojo.SelectorPojo;
  import io.wcm.qa.glnm.maven.freemarker.pojo.SpecPojo;
  
  /**
   * Utility methods to convert between different casings.
   *
   * @since 1.0.0
   */
  public final class FormatUtil {
  
    private static final String FILE_ENDING_GSPEC = ".gspec";
    private static final String REGEX_NAME_CLEANING = "\\.";
  
    private FormatUtil() {
      // do not instantiate
    }
  
    /**
     * <p>getClassName.</p>
     *
     * @param file to extract class name from
     * @return class name build from file name
     */
    public static String getClassName(File file) {
      return getClassName(FilenameUtils.getBaseName(file.getPath()));
    }
  
    /**
     * <p>getClassName.</p>
     *
     * @param selector to extract class name from
     * @return class name from selectors element name
     */
    public static String getClassName(SelectorPojo selector) {
      String elementName = selector.elementName();
      String relativeElementName = getRelativeElementName(elementName);
      String cleanElementName = getCleanElementName(relativeElementName);
      return kebapToUpperCamel(cleanElementName);
    }
  
    /**
     * <p>getFullyQualifiedWebElementClassName.</p>
     *
     * @param packageName name of package
     * @param selector to extract class name from
     * @return class name from selectors element name
     */
    public static String getFullyQualifiedWebElementClassName(String packageName, SelectorPojo selector) {
      return getFullyQualifiedClassName(packageName, selector, "Gwe");
    }
  
    /**
     * <p>getFullyQualifiedSelectorClassName.</p>
     *
     * @param selector to extract class name from
     * @return class name from selectors element name
     * @param packageName a {@link java.lang.String} object.
     */
    public static String getFullyQualifiedSelectorClassName(String packageName, SelectorPojo selector) {
      return getFullyQualifiedClassName(packageName, selector, "");
    }
  
    private static String getFullyQualifiedClassName(String packageName, SelectorPojo selector, String classNamePostfix) {
      List<String> classNames = new ArrayList<String>();
      String[] elementNameParts = selector.elementName().split("\\.");
      for (String namePart : elementNameParts) {
        String cleanName = getCleanElementName(namePart);
        String className = kebapToUpperCamel(cleanName);
        classNames.add(className);
     }
     String joinedClassNames = StringUtils.join(classNames, classNamePostfix
         + ".");
     return packageName + "." + joinedClassNames + classNamePostfix;
   }
 
   /**
    * <p>getClassName.</p>
    *
    * @param specPojo to extract name from
    * @return class name from spec file
    */
   public static String getClassName(SpecPojo specPojo) {
     return kebapToUpperCamel(specPojo.getBaseName());
   }
 
   /**
    * <p>getClassName.</p>
    *
    * @param string kebap cased string
    * @return class name formatted string from kebap string
    */
   public static String getClassName(String string) {
     return kebapToUpperCamel(string);
   }
 
   /**
    * <p>getConstantName.</p>
    *
    * @param selector to extract name from
    * @return selectors element name formatted for use as constant name
    */
   public static String getConstantName(SelectorPojo selector) {
     String elementName = selector.elementName();
     String relativeElementName = getRelativeElementName(elementName);
     String cleanElementName = getCleanElementName(relativeElementName);
     return kebapToConstant(cleanElementName);
   }
 
   /**
    * <p>getSelectorsPackageName.</p>
    *
    * @param packageRoot root package to prepend
    * @param spec to extract package name from
    * @return absolute package name built from package root and spec
    */
   public static String getSelectorsPackageName(String packageRoot, SpecPojo spec) {
     StringBuilder stringBuilder = new StringBuilder();
     stringBuilder.append(packageRoot);
     String relativePackageName = getPackageName(spec);
     if (!StringUtils.startsWith(relativePackageName, ".")) {
       stringBuilder.append(".");
     }
     stringBuilder.append(relativePackageName);
     return stringBuilder.toString();
   }
 
   private static String getCleanElementName(String elementName) {
     return elementName.replaceAll(REGEX_NAME_CLEANING, "__");
   }
 
   private static String getPackageName(SpecPojo spec) {
     String relativePath = spec.getRelativeFilePath();
     String relativePathWithoutExtension = StringUtils.removeEnd(relativePath, FILE_ENDING_GSPEC);
     String lowerCasePath = relativePathWithoutExtension.toLowerCase().replaceAll("[^a-z0-9/]", "");
     return lowerCasePath.replaceAll("/", ".");
   }
 
   /**
    * Format as constant name.
    * @param input lower hyphen formatted string
    * @return upper case with underscores version of input string
    */
   private static String kebapToConstant(String input) {
     return CaseFormat.LOWER_HYPHEN.to(CaseFormat.UPPER_UNDERSCORE, input);
   }
 
   /**
    * Format as class name.
    * @param input lower hyphen formatted string
    * @return upper camel case version of input string
    */
   private static String kebapToUpperCamel(String input) {
     return CaseFormat.LOWER_HYPHEN.to(CaseFormat.UPPER_CAMEL, input);
   }
 
   protected static String getRelativeElementName(String elementName) {
     return elementName.replaceFirst("^.*\\.", "");
   }
 
 }