com.github.lombrozo.testnames.rules.RuleNotCamelCase Maven / Gradle / Ivy
/*
* MIT License
*
* Copyright (c) 2022-2024 Volodya Lombrozo
*
* 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.github.lombrozo.testnames.rules;
import com.github.lombrozo.testnames.Complaint;
import com.github.lombrozo.testnames.Rule;
import com.github.lombrozo.testnames.TestCase;
import com.github.lombrozo.testnames.complaints.ComplaintLinked;
import com.github.lombrozo.testnames.complaints.ComplaintWrongTestName;
import java.util.Collection;
/**
* Rule to check test case on not camel case name.
*
* @since 0.1.0
*/
public final class RuleNotCamelCase implements Rule {
/**
* The name of the rule.
*/
public static final String NAME = "RuleNotCamelCase";
/**
* The test case.
*/
private final TestCase test;
/**
* Ctor.
*
* @param test The test case
*/
RuleNotCamelCase(final TestCase test) {
this.test = test;
}
@Override
public Collection complaints() {
return new RuleConditional(
this::notCamelCase,
new ComplaintLinked(
new ComplaintWrongTestName(
this.test,
"test has to be written by using Camel Case"
).message(),
"Please rename the test by using the Camel Case",
this.getClass(),
"camel-case.md"
)
).complaints();
}
/**
* Is not in camel case.
*
* @return The result
* @checkstyle ReturnCountCheck (15 lines)
*/
@SuppressWarnings("PMD.OnlyOneReturn")
private boolean notCamelCase() {
int stack = 0;
for (final char chr : this.test.name().toCharArray()) {
if (Character.isUpperCase(chr) && stack == 0) {
return true;
} else if (stack != 0) {
stack = 0;
}
++stack;
}
return false;
}
}