com.ocadotechnology.config.ConfigUsageChecker Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of OcavaCore Show documentation
There is a newer version: 16.6.21
/*
 * Copyright © 2017-2023 Ocado (Ocava)
 *
 * 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 com.ocadotechnology.config;

import static com.ocadotechnology.config.ModularConfigUtils.EXTENDS;

import java.util.HashSet;
import java.util.Properties;
import java.util.Set;
import java.util.function.Predicate;

import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Sets;

class ConfigUsageChecker {
    private static final Predicate IS_STANDARD_PROPERTY = property -> !property.contains("@") && !property.contains(EXTENDS);

    private final HashSet accessedProperties = new HashSet<>();
    private final HashSet definedProperties = new HashSet<>();

    PropertiesAccessor checkAccessTo(Properties properties) {
        definedProperties.addAll(properties.stringPropertyNames());
        return key -> {
            accessedProperties.add(key);
            return properties.getProperty(key);
        };
    }

    Set getUnrecognisedProperties() {
        return Sets.union(getUnrecognisedNonPrefixedProperties(), getUnrecognisedPrefixedProperties());
    }

    private Set getUnrecognisedNonPrefixedProperties() {
        ImmutableSet definedNonPrefixedProperties = definedProperties.stream()
                .filter(IS_STANDARD_PROPERTY)
                .collect(ImmutableSet.toImmutableSet());

        ImmutableSet accessedNonPrefixedProperties = accessedProperties.stream()
                .filter(IS_STANDARD_PROPERTY)
                .collect(ImmutableSet.toImmutableSet());

        return Sets.difference(definedNonPrefixedProperties, accessedNonPrefixedProperties);
    }

    private Set getUnrecognisedPrefixedProperties() {
        ImmutableSet definedNonPrefixedProperties = accessedProperties.stream()
                .filter(IS_STANDARD_PROPERTY)
                .collect(ImmutableSet.toImmutableSet());
        return definedProperties.stream()
                .filter(p -> unrecognisedPrefixedProperty(p, definedNonPrefixedProperties))
                .collect(ImmutableSet.toImmutableSet());
    }

    private boolean unrecognisedPrefixedProperty(String property, Set definedNonPrefixedProperties) {
        if (!property.contains("@")) {
            return false;
        }
        String propertyFromPrefixedProperty = extractPropertyFromPrefixedProperty(property);
        return !definedNonPrefixedProperties.contains(propertyFromPrefixedProperty);
    }

    private String extractPropertyFromPrefixedProperty(String property) {
        return property.contains("@") ?
                property.substring(property.lastIndexOf("@") + 1) :
                property;
    }
}