Package slash.navigation.converter.tools

Class ResourceBundleCompletenessReport

java.lang.Object

slash.navigation.converter.tools.ResourceBundleCompletenessReport

public class ResourceBundleCompletenessReport
extends Object

Computes, per locale, how many of a base locale's resource bundle keys a translated bundle carries, and flags regressions against a previous measurement. This class is pure: it never reads or writes files itself, so its logic can be unit-tested against in-memory key sets. analyzeDirectory(java.io.File, java.lang.String, java.lang.String) is the only method that touches the file system.

Author:

Christian Pesch

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ResourceBundleCompletenessReport.LocaleCompleteness

Field Summary

Fields

Modifier and Type	Field	Description
static final double	DEFAULT_REGRESSION_THRESHOLD

Constructor Summary

Constructors

Constructor	Description
ResourceBundleCompletenessReport()

Method Summary

Modifier and Type	Method	Description
Map<String,ResourceBundleCompletenessReport.LocaleCompleteness>	analyze(Map<String,Set<String>> localeKeys, Set<String> baseKeys)	Computes completeness of every locale in localeKeys against baseKeys.
Map<String,ResourceBundleCompletenessReport.LocaleCompleteness>	analyzeDirectory(File directory, String prefix, String baseLocale)	Loads every <prefix>_<locale>.properties file in directory and reports its completeness against <prefix>_<baseLocale>.properties.
List<String>	findRegressions(Map<String,Double> previousPercentByLocale, Map<String,ResourceBundleCompletenessReport.LocaleCompleteness> current, double threshold)	Returns the locales that regressed: they were previously at or above threshold and are now below it.
Map<String,Double>	loadBaseline(File file)	Loads a locale=percent properties file, as written by a previous run of this report.
static void	main(String[] args)	Command line entry point for the release-preparation workflow: prints a per-locale completeness report and exits non-zero only when a locale that was previously at or above DEFAULT_REGRESSION_THRESHOLD has dropped below it since the baseline file was last written.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_REGRESSION_THRESHOLD

public static final double DEFAULT_REGRESSION_THRESHOLD

See Also:

• Constant Field Values

Constructor Details

ResourceBundleCompletenessReport

public ResourceBundleCompletenessReport()

Method Details

analyze

public Map<String,ResourceBundleCompletenessReport.LocaleCompleteness> analyze(Map<String,Set<String>> localeKeys,
 Set<String> baseKeys)

Computes completeness of every locale in localeKeys against baseKeys. A locale not present in baseKeys at all still gets a result: 0 keys, all missing, 0 percent.

findRegressions

public List<String> findRegressions(Map<String,Double> previousPercentByLocale,
 Map<String,ResourceBundleCompletenessReport.LocaleCompleteness> current,
 double threshold)

Returns the locales that regressed: they were previously at or above threshold and are now below it. A locale with no previous measurement (a first sighting, or a brand-new locale) never counts as a regression, however low its current percentage is.

analyzeDirectory

public Map<String,ResourceBundleCompletenessReport.LocaleCompleteness> analyzeDirectory(File directory,
 String prefix,
 String baseLocale)
                                                                                 throws IOException

Loads every <prefix>_<locale>.properties file in directory and reports its completeness against <prefix>_<baseLocale>.properties.

Throws:

IOException

loadBaseline

public Map<String,Double> loadBaseline(File file)
                                throws IOException

Loads a locale=percent properties file, as written by a previous run of this report. Used as the "previous measurement" input to findRegressions(java.util.Map<java.lang.String, java.lang.Double>, java.util.Map<java.lang.String, slash.navigation.converter.tools.ResourceBundleCompletenessReport.LocaleCompleteness>, double). Returns an empty map if file is null or does not exist, so a first run never has anything to regress against.

Throws:

IOException

main

public static void main(String[] args)
                 throws IOException

Command line entry point for the release-preparation workflow: prints a per-locale completeness report and exits non-zero only when a locale that was previously at or above DEFAULT_REGRESSION_THRESHOLD has dropped below it since the baseline file was last written. A locale absent from the baseline (a first sighting, or a brand-new locale, e.g. sr today) never fails the run, however low its percentage is.

Throws:

IOException