com.googlecode.l10nmavenplugin.validators.bundle.ParametricCoherenceValidator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of l10n-maven-plugin Show documentation
Maven plugin to validate localization resources in Java properties files
There is a newer version: 1.8
/*******************************************************************************
 * Copyright (c) 2012 Romain Quinio (http://code.google.com/p/l10n-maven-plugin)
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 ******************************************************************************/
package com.googlecode.l10nmavenplugin.validators.bundle;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import org.apache.commons.lang.StringUtils;

import com.googlecode.l10nmavenplugin.log.L10nValidatorLogger;
import com.googlecode.l10nmavenplugin.model.L10nReportItem;
import com.googlecode.l10nmavenplugin.model.L10nReportItem.Type;
import com.googlecode.l10nmavenplugin.model.PropertiesFile;
import com.googlecode.l10nmavenplugin.model.PropertiesFileUtils;
import com.googlecode.l10nmavenplugin.model.PropertyFamily;
import com.googlecode.l10nmavenplugin.validators.AbstractL10nValidator;
import com.googlecode.l10nmavenplugin.validators.L10nValidator;

/**
 * Validator to check the coherence of parametric properties, i.e. properties containing formatting parameters ({0},{1},...).
 * 
 * Even if the order of the parameters can vary in translations, the number of parameters and the index should usually remain identical, or some info from the
 * original language would be lost.
 * 
 * @since 1.2
 * @author romain.quinio
 * @see {@link com.googlecode.l10nmavenplugin.validators.bundle.HtmlTagCoherenceValidator}
 * @see {@link com.googlecode.l10nmavenplugin.validators.property.ParametricMessageValidator}
 * 
 */
public class ParametricCoherenceValidator extends AbstractL10nValidator implements L10nValidator {

  /**
   * Detection of parameters in properties, ex: {0}, {0,date}, {0,number,integer}
   */
  private static final String CAPTURE_PARAMETERS_REGEXP = "(?:\\{([0-9]+)(?:,[a-z]+){0,2}\\})";
  private static final String DETECT_PARAMETERS_REGEXP = "^.*" + CAPTURE_PARAMETERS_REGEXP + ".*$";

  protected static final Pattern CAPTURE_PARAMETERS_PATTERN = Pattern.compile(CAPTURE_PARAMETERS_REGEXP);
  protected static final Pattern DETECT_PARAMETERS_PATTERN = Pattern.compile(DETECT_PARAMETERS_REGEXP);

  public ParametricCoherenceValidator(L10nValidatorLogger logger) {
    super(logger);
  }

  public static boolean isParametric(String message) {
    Matcher m = DETECT_PARAMETERS_PATTERN.matcher(message);
    return m.matches();
  }

  /**
   * Extract and re-order the parameters by index, then WARN if order is not the same.
   */
  public int validate(PropertyFamily propertyFamily, List reportItems) {
    String key = propertyFamily.getKey();

    Map> resourceParameters = new HashMap>();

    Collection propertiesFiles = propertyFamily.getExistingPropertyFiles();

    for (PropertiesFile propertiesFile : propertiesFiles) {
      String message = propertiesFile.getProperties().getProperty(key);
      List parameters = captureParameters(message);
      if (parameters.size() > 0) {
        resourceParameters.put(propertiesFile, parameters);
      }
    }

    // Ignore messages only present in a single properties (i.e global / not translated)
    if (resourceParameters.size() >= 2) {
      Map, Collection> reverseMap = PropertiesFileUtils.reverseMap(resourceParameters);
      if (reverseMap.size() > 1) {
        List majorityKey = PropertiesFileUtils.getMajorityKey(reverseMap);
        Collection majorityPropertiesNames = reverseMap.get(majorityKey);
        for (Entry, Collection> entry : reverseMap.entrySet()) {
          if (!entry.getKey().equals(majorityKey)) {
            Collection faultyPropertiesFiles = entry.getValue();
            // Only warn for now, need more feedback before moving to error.
            L10nReportItem reportItem = new L10nReportItem(Type.INCOHERENT_PARAMETERS, "Incoherent usage of parameters: " + displayParameters(entry.getKey())
                + " versus " + displayParameters(majorityKey) + " in <" + majorityPropertiesNames + ">", faultyPropertiesFiles.toString(), key, null, null);
            reportItems.add(reportItem);
            logger.log(reportItem);
          }
        }
      }
    }
    return 0;
  }

  /**
   * Capture parameters of message
   * 
   * @param message
   * @return
   */
  private List captureParameters(String message) {
    Matcher m = CAPTURE_PARAMETERS_PATTERN.matcher(message);

    List parameters = new ArrayList();
    while (m.find()) {
      String param = m.group(1);
      if (!StringUtils.isEmpty(param)) {
        parameters.add(Integer.valueOf(param));
      }
    }
    // Parameters may not appear in the same order depending of language
    Collections.sort(parameters);

    return parameters;
  }

  /**
   * Display parameters using {i}
   * 
   * @param parameters
   * @return
   */
  private String displayParameters(List parameters) {
    StringBuffer sb = new StringBuffer("[");
    for (int i = 0; i < parameters.size(); i++) {
      if (i != 0) {
        sb.append(",");
      }
      sb.append("{").append(parameters.get(i)).append("}");
    }
    sb.append("]");
    return sb.toString();
  }

  public boolean shouldValidate(PropertyFamily propertyFamily) {
    // Always validate
    return true;
  }
}