Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cognitive complexity metric for Java #850

Merged
merged 23 commits into from
Jun 28, 2023
Merged

Cognitive complexity metric for Java #850

Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
88c9b9e
Adds first failing test
dburriss May 30, 2022
3463391
Trying to understand results
dburriss Oct 1, 2022
b268b6c
Fixes from changes to complexity calc
dburriss Jan 13, 2023
a0a64fb
Adds case test
dburriss May 29, 2023
1353d62
Cargo fmt
dburriss May 29, 2023
c073919
depth is immutable
dburriss May 29, 2023
ade793a
Update no cognitive test only
dburriss May 29, 2023
a077e9a
Add single branch back
dburriss May 29, 2023
727c65c
Convert other tests
dburriss Jun 1, 2023
58faf1c
Check switch expression also covered
dburriss Jun 1, 2023
24daa05
Adds NOT condition test
dburriss Jun 2, 2023
6b4c952
fmt
dburriss Jun 2, 2023
9ef21cf
Adds classes to java test examples
dburriss Jun 15, 2023
a08a52e
Push updated lock file
dburriss Jun 24, 2023
715b1af
Remove todo
dburriss Jun 26, 2023
ca46ad2
Boolean to boolean
dburriss Jun 26, 2023
f496a35
Java test formatting
dburriss Jun 26, 2023
b5e7c54
Remove Cargo.lock
dburriss Jun 26, 2023
a00e538
Fix test results
dburriss Jun 26, 2023
8b68b9e
Fix comments
dburriss Jun 27, 2023
4167e9b
Last Boolean to boolean
dburriss Jun 27, 2023
10655c6
Fix comment count
dburriss Jun 27, 2023
71cd125
Update comment
dburriss Jun 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
232 changes: 231 additions & 1 deletion src/metrics/cognitive.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -452,7 +452,44 @@ impl Cognitive for TsxCode {
js_cognitive!(Tsx);
}

implement_metric_trait!(Cognitive, PreprocCode, CcommentCode, JavaCode, KotlinCode);
impl Cognitive for JavaCode {
fn compute(
node: &Node,
stats: &mut Stats,
nesting_map: &mut FxHashMap<usize, (usize, usize, usize)>,
) {
use Java::*;

let (mut nesting, depth, mut lambda) = get_nesting_from_map(node, nesting_map);

match node.kind_id().into() {
IfStatement => {
if !Self::is_else_if(node) {
increase_nesting(stats,&mut nesting, depth, lambda);
}
}
ForStatement | WhileStatement | DoStatement | SwitchBlock | CatchClause => {
increase_nesting(stats,&mut nesting, depth, lambda);
}
Else /* else-if also */ => {
increment_by_one(stats);
}
UnaryExpression => {
stats.boolean_seq.not_operator(node.kind_id());
}
BinaryExpression => {
compute_booleans::<language_java::Java>(node, stats, AMPAMP, PIPEPIPE);
}
LambdaExpression => {
lambda += 1;
}
_ => {}
}
nesting_map.insert(node.id(), (nesting, depth, lambda));
}
}

implement_metric_trait!(Cognitive, PreprocCode, CcommentCode, KotlinCode);

#[cfg(test)]
mod tests {
Expand Down Expand Up @@ -1696,4 +1733,197 @@ mod tests {
},
);
}

#[test]
fn java_no_cognitive() {
check_metrics::<JavaParser>("int a = 42;", "foo.java", |metric| {
insta::assert_json_snapshot!(
metric.cognitive,
@r###"
{
"sum": 0.0,
"average": null,
"min": 0.0,
"max": 0.0
}
"###
);
});
}

#[test]
fn java_single_branch_function() {
check_metrics::<JavaParser>(
"class X {
public static void print(boolean a){
if(a){ // +1
System.out.println(\"test1\");
}
}
}",
"foo.java",
|metric| {
insta::assert_json_snapshot!(
metric.cognitive,
@r###"
{
"sum": 1.0,
"average": 1.0,
"min": 0.0,
"max": 1.0
}
"###
);
},
);
}

#[test]
fn java_multiple_branch_function() {
check_metrics::<JavaParser>(
"class X {
public static void print(boolean a, boolean b){
if(a){ // +1
System.out.println(\"test1\");
}
if(b){ // +1
System.out.println(\"test2\");
}
else { // +1
System.out.println(\"test3\");
}
}
}",
"foo.java",
|metric| {
insta::assert_json_snapshot!(
metric.cognitive,
@r###"
{
"sum": 3.0,
"average": 3.0,
"min": 0.0,
"max": 3.0
}
"###
);
},
);
}

#[test]
fn java_compound_conditions() {
check_metrics::<JavaParser>(
"class X {
public static void print(boolean a, boolean b, boolean c, boolean d){
if(a && b){ // +2 (+1 &&)
System.out.println(\"test1\");
}
if(c && d){ // +2 (+1 &&)
System.out.println(\"test2\");
}
}
}",
"foo.java",
|metric| {
insta::assert_json_snapshot!(
metric.cognitive,
@r###"
{
"sum": 4.0,
"average": 4.0,
"min": 0.0,
"max": 4.0
}"###
);
},
);
}

#[test]
fn java_switch_statement() {
check_metrics::<JavaParser>(
"class X {
public static void print(boolean a, boolean b, boolean c, boolean d){
switch(expr){ //+1
case 1:
System.out.println(\"test1\");
break;
case 2:
System.out.println(\"test2\");
break;
default:
System.out.println(\"test\");
}
}
}",
"foo.java",
|metric| {
insta::assert_json_snapshot!(
metric.cognitive,
@r###"
{
"sum": 1.0,
"average": 1.0,
"min": 0.0,
"max": 1.0
}"###
);
},
);
}

#[test]
fn java_switch_expression() {
check_metrics::<JavaParser>(
"class X {
public static void print(boolean a, boolean b, boolean c, boolean d){
switch(expr){ // +1
case 1 -> System.out.println(\"test1\");
case 2 -> System.out.println(\"test2\");
default -> System.out.println(\"test\");
}
}
}",
"foo.java",
|metric| {
insta::assert_json_snapshot!(
metric.cognitive,
@r###"
{
"sum": 1.0,
"average": 1.0,
"min": 0.0,
"max": 1.0
}"###
);
},
);
}

#[test]
fn java_not_booleans() {
check_metrics::<JavaParser>(
"class X {
public static void print(boolean a, boolean b, boolean c, boolean d){
if (a && !(b && c)) { // +3 (+1 &&, +1 &&)
Luni-4 marked this conversation as resolved.
Show resolved Hide resolved
printf(\"test\");
}
}
}",
"foo.java",
|metric| {
insta::assert_json_snapshot!(
metric.cognitive,
@r###"
{
"sum": 3.0,
"average": 3.0,
"min": 0.0,
"max": 3.0
}"###
);
},
);
}
}