org.nuiton.i18n.plugin.bundle.BundleValidation Maven / Gradle / Ivy

Go to download
package org.nuiton.i18n.plugin.bundle;

/*
 * #%L
 * I18n :: Maven Plugin
 * %%
 * Copyright (C) 2007 - 2016 CodeLutin
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Lesser Public License for more details.
 * 
 * You should have received a copy of the GNU General Lesser Public
 * License along with this program.  If not, see
 * .
 * #L%
 */

import com.google.common.collect.ImmutableSortedSet;
import com.google.common.collect.Ordering;
import com.google.common.collect.Sets;
import com.google.common.collect.SortedSetMultimap;
import com.google.common.collect.TreeMultimap;

import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Set;
import java.util.SortedSet;

/**
 * The validation result of a validation check over multiple bundles.
 *
 * @since 3.5
 */
public class BundleValidation {

    protected ImmutableSortedSet locales;

    /** to keep all none translated i18n keys by locale. */
    protected Map> keysMissingValues = new HashMap<>();

    /**
     * Store all keys declared for each {@link Locale}.
     */
    protected SortedSetMultimap keysPerLocale;

    /**
     * Sort locales according to the order used in the POM file.
     */
    protected Ordering localeOrdering;

    public BundleValidation(Locale[] locales) {
        List localesList = Arrays.asList(locales);
        localeOrdering = Ordering.explicit(localesList);
        this.locales = ImmutableSortedSet.orderedBy(localeOrdering).addAll(localesList).build();
        this.keysPerLocale = newEmptyMapForBundles();
    }

    public Map> getKeysMissingValues() {
        return keysMissingValues;
    }

    public SortedSetMultimap getKeysPerLocale() {
        return keysPerLocale;
    }

    public SortedSetMultimap getMissingKeysPerLocale() {
        ImmutableSortedSet allKeysFromAllBundles = ImmutableSortedSet.copyOf(keysPerLocale.values());
        SortedSetMultimap missingKeysPerLocale = newEmptyMapForBundles();
        for (Locale locale : locales) {
            Set keysInBundle = keysPerLocale.get(locale);
            Set missingKeysInBundle = Sets.symmetricDifference(allKeysFromAllBundles, keysInBundle);
            missingKeysPerLocale.putAll(locale, missingKeysInBundle);
        }
        return missingKeysPerLocale;
    }

    public boolean isAnyKeyMissingInBundle() {
        return ! getMissingKeysPerLocale().isEmpty();
    }

    public boolean isAnyKeyMissingValue() {
        return ! getKeysMissingValues().isEmpty();
    }

    public boolean isFail() {
        return isAnyKeyMissingValue() || isAnyKeyMissingInBundle();
    }

    /**
     * Factory method for a method suitable to deterministically store bundles.
     */
    protected SortedSetMultimap newEmptyMapForBundles() {
        return TreeMultimap.create(localeOrdering, Ordering.natural());
    }
}