com.societegenerale.commons.plugin.rules.NoPublicFieldRuleTest Maven / Gradle / Ivy

Go to download
package com.societegenerale.commons.plugin.rules;

import java.util.Collection;

import com.societegenerale.commons.plugin.service.ScopePathProvider;
import com.societegenerale.commons.plugin.utils.ArchUtils;
import com.tngtech.archunit.lang.ArchRule;

import static com.tngtech.archunit.lang.syntax.ArchRuleDefinition.fields;

/**
 * It is important to respect encapsulation.
 * 
 * @see Encapsulation
 */

public class NoPublicFieldRuleTest implements ArchRuleTest {
	public static final String NO_PUBLIC_FIELD_VIOLATION_MESSAGE = "you should respect encapsulation";

	@Override
	public void execute(String packagePath, ScopePathProvider scopePathProvider, Collection excludedPaths) {

		ArchRule rulePublic = fields().that().areNotStatic().or().areNotFinal().should().notBePublic()
				.because(NO_PUBLIC_FIELD_VIOLATION_MESSAGE);

		rulePublic.check(ArchUtils.importAllClassesInPackage(scopePathProvider.getMainClassesPath(), packagePath, excludedPaths));

	}

}