Question

I was analyzing my code with PHP Mess Detector when PHPMD reported some of my codes has high NPath Complexity. One example would be:

function compareDates($date1, $date2){
    if($date->year < $date2->year){
        return -1;
    }
    if($date->year > $date2->year){
        return 1;
    }
    if($date->month < $date2->month){
        return -1;
    }
    if($date->month > $date2->month){
        return 1;
    }
    if($date->day < $date2->day){
        return -1;
    }
    if($date->day > $date2->day){
        return 1;
    }
    // etc.. same for hour, minute, second.
    return 0;
}

The result would be that this function has very high NPath complexity. Is there a generic way of coding to reduce such control structures and NPath complexity?

Source Code: http://code.google.com/p/phpraise/source/browse/trunk/phpraise/core/datetime/RaiseDateTime.php#546

Answer 1

Your code actually is relatively simple, just poorly structured. I would recommend creating a subfunction that takes two parameters and handles the return of -1/1 and then iterating through an array of fields to check on, as this would be a bit easier, but a few things of note:

1. Your way is OK. It’s not clean, but it’s clear and if it works there’s no pressing need to change it – any programmer who looks at it will be able to understand what you’re doing, even if they scoff at your implementation.

2. Complexity isn’t a holy grail. It’s important, and as a programmer who does a lot of maintenance programming I think it’s really important that the people writing the code I maintain know about complexity, but you can’t entirely avoid complexity and sometimes the complex solution (using McCabe’s Complexity) is the easiest to read.

The only change I would really recommend you making is having a single return call. Do something like:

$compare_val = 0;

At the top of your file, and then change your subsequent if calls to elseifs and instead of returning the value, just update $compare_val and return it at the end of your function.