AppStateESS/homestead

View on GitHub
class/HMS_Roommate.php

Summary

Maintainability
D
2 days
Test Coverage

File HMS_Roommate.php has 448 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php

namespace Homestead;

use \Homestead\Exception\RoommateException;
Severity: Minor
Found in class/HMS_Roommate.php - About 6 hrs to fix

HMS_Roommate has 30 functions (exceeds 20 allowed). Consider refactoring.
Open

class HMS_Roommate
{

    public $id           = 0;
    public $term         = null;
Severity: Minor
Found in class/HMS_Roommate.php - About 3 hrs to fix

Consider simplifying this complex logical expression.
Open

        if ($result['rlc_first_choice_id']  == $resultb['rlc_first_choice_id'] ||
        $result['rlc_first_choice_id']  == $resultb['rlc_second_choice_id'] ||
        $result['rlc_first_choice_id']  == $resultb['rlc_third_choice_id'] ||
        $result['rlc_second_choice_id'] == $resultb['rlc_first_choice_id'] ||
        $result['rlc_second_choice_id'] == $resultb['rlc_second_choice_id'] ||
Severity: Critical
Found in class/HMS_Roommate.php - About 1 hr to fix

Function can_live_together has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
Open

    public function can_live_together()
    {
        $requestor = strToLower($this->requestor);
        $requestee = strToLower($this->requestee);
        $term = $this->term;
Severity: Minor
Found in class/HMS_Roommate.php - About 1 hr to fix

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

  • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
  • Code is considered more complex for each "break in the linear flow of the code"
  • Code is considered more complex when "flow breaking structures are nested"

Further reading

Method can_live_together has 34 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function can_live_together()
    {
        $requestor = strToLower($this->requestor);
        $requestee = strToLower($this->requestee);
        $term = $this->term;
Severity: Minor
Found in class/HMS_Roommate.php - About 1 hr to fix

Method canLiveTogetherAdmin has 27 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function canLiveTogetherAdmin(Student $roommate1, Student $roommate2, $term)
    {

        // Sanity Checking
        if (is_null($roommate1)) {
Severity: Minor
Found in class/HMS_Roommate.php - About 1 hr to fix

Function canLiveTogetherAdmin has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
Open

    public function canLiveTogetherAdmin(Student $roommate1, Student $roommate2, $term)
    {

        // Sanity Checking
        if (is_null($roommate1)) {
Severity: Minor
Found in class/HMS_Roommate.php - About 45 mins to fix

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

  • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
  • Code is considered more complex for each "break in the linear flow of the code"
  • Code is considered more complex when "flow breaking structures are nested"

Further reading

Consider simplifying this complex logical expression.
Open

        if ($aYear != $bYear || ($aYear == $bYear && (($aSem == TERM_SPRING && $bSem != TERM_SPRING) || ($bSem == TERM_SPRING && $aSem != TERM_SPRING)))) {
            return E_ROOMMATE_TYPE_MISMATCH;
        }
Severity: Major
Found in class/HMS_Roommate.php - About 40 mins to fix

Avoid too many return statements within this method.
Open

        return E_SUCCESS;
Severity: Major
Found in class/HMS_Roommate.php - About 30 mins to fix

Avoid too many return statements within this method.
Open

        return $this->can_live_together();
Severity: Major
Found in class/HMS_Roommate.php - About 30 mins to fix

Avoid too many return statements within this method.
Open

            return E_ROOMMATE_NO_APPLICATION;
Severity: Major
Found in class/HMS_Roommate.php - About 30 mins to fix

Avoid too many return statements within this method.
Open

            return E_ROOMMATE_TYPE_MISMATCH;
Severity: Major
Found in class/HMS_Roommate.php - About 30 mins to fix

Avoid too many return statements within this method.
Open

            return E_ROOMMATE_PENDING_REQUEST;
Severity: Major
Found in class/HMS_Roommate.php - About 30 mins to fix

Avoid too many return statements within this method.
Open

            return E_ROOMMATE_TYPE_MISMATCH;
Severity: Major
Found in class/HMS_Roommate.php - About 30 mins to fix

Similar blocks of code found in 2 locations. Consider refactoring.
Open

    public static function roommate_pager()
    {
        $pager = new \DBPager('hms_roommate', '\Homestead\HMS_Roommate');

        $pager->db->addWhere('confirmed', 1);
Severity: Major
Found in class/HMS_Roommate.php and 1 other location - About 1 hr to fix
class/ConfirmedRoommatePager.php on lines 10..26

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 107.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

There are no issues that match your filters.

Category
Status