UserStatistics - Code Metrics - Inspection of "Add Code Tables feature" - scriptotek/php-alma-client - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#24)

unknown

created 2021-05-26 18:58 UTC

UserStatistics B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	327
Duplicated Lines	24.77 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

Metric	Value
dl	81
loc	327
rs	8.8
c	0
b	0
f	0
wmc	45
lcom	1
cbo	3

17 Methods

Rating	Name	Duplication	Size	Complexity
A	getStatistics()	0	8	2
A	get()	0	8	2
A	getStatistic()	0	11	4
A	addStatisticRaw()	0	23	1
A	addStatistic()	0	33	1
A	removeStatistic()	0	19	4
A	updateStatistic()	0	6	1
A	getStatsByTypeCode()	11	11	3
A	getStatsByTypeDesc()	10	10	3
A	getStatsByCategoryCode()	10	10	3
A	getStatsByCategoryDesc()	10	10	3
A	getStatsBySegmentType()	0	10	3
A	searchStatsByNote()	0	10	3
A	searchStatsByTypeCode()	10	10	3
A	searchStatsByTypeDesc()	10	10	3
A	searchStatsByCategoryCode()	10	10	3
A	searchStatsByCategoryDesc()	10	10	3

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like UserStatistics often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use UserStatistics, and based on these observations, apply Extract Interface, too.

<?php

namespace Scriptotek\Alma\Users;

use Scriptotek\Alma\Client;
use Scriptotek\Alma\Model\Model;

/**
 * Iterable collection of statistics resources.
 */
class UserStatistics extends Model
{
    /**
     * Get the user's statistics.
     *
     * @return Array of Statistics.
     */
    public function getStatistics()
    {
        $stats = array();
        foreach ($this->data as $statistic) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            $stats[] = $statistic;
        }
        return $stats;
    }

    /**
     * Get the user's statistics.
     * 
     * @return array of statistics.
     */
    public function get()
    {
        $stats = array();
        foreach ($this->data as $statistic) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            $stats[] = $statistic;
        }
        return $stats;
    }

    /**
    * Get a statistic.
    *
    * @param $typeCode code of the category type.
    * @param $categoryCode code of the statistical category.
    *
    * @return Statistic.

    */
    public function getStatistic($typeCode,$categoryCode)
    {
        $stats = array();
        foreach ($this->data as $statistic) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            if (($statistic->category_type->value == $typeCode) && 
                ($statistic->statistic_category->value == $categoryCode)) {
                $stats[] = $statistic;
            }
        }
        return $stats;
    }

    /**
    * Add a user statistic with no regard to existing Types and Categories.
    *
    * @param string $typeCode code of the category type.
    * @param string $typeDesc description of the category type.
    * @param string $categoryCode code of the statistical category.
    * @param string $categoryDesc description of the statistical category.
    * @param string $note free text description of the statistic.
    * @param string $segment_type (Internal|External)
    *
    * @return Statistic
    */
    public function addStatisticRaw($typeCode,$typeDesc,$categoryCode,$categoryDesc,$segment_type,$note)
    {
        # Create the new statistic object
        $stat_obj = (object) [
            'statistic_category' => (object) [
                'value' => $categoryCode,
                'desc'  => $categoryDesc,
            ],
            'category_type' => (object) [
                'value' => $typeCode,
                'desc'  => $typeDesc,
            ],
            'statistic_note' => $note,
            'segment_type'   => $segment_type,
        ];

        # Add the object to the user
        $this->data[] = $stat_obj;

        /*  Not Sure this is quite right or needed. */
        #return Statistic::make($this->client,$stat_obj);
        #return($this->data);
    }

    /**
    * Add a user statistic based upon existing Types and Categories.
    *
    * @param string $typeCode code of the category type.
    * @param string $categoryCode code of the statistical category.
    *
    * @return Statistic
    */
    public function addStatistic($typeCode,$categoryCode,$segmentType,$note)
    {
        //* TODO HERE *//

        /* Logic: */
        /* Lookup both $typeCode and $categoryCode in codetable */
        /* Obtain information (code/description) from both code tables. */
        /* If found and ok, add the statistic to the user */

        /* Code Tables used:
            Code Table; UserStatisticalTypes
            Code Table: UserStatCategories
        */

        # Note need some error checking etc. here.

        # Get the Type and Category Descriptions for the codes from the code tables.
        $stat = $this->client->conf->codetables->get('UserStatisticalTypes')->getRowByCode($typeCode);
        $typeDesc = $stat[0]->description;

        $stat = $this->client->conf->codetables->get('UserStatCategories')->getRowByCode($categoryCode);
        $categoryDesc = $stat[0]->description;
        #
        # These are temporary for testing.
        #$typeDesc = 'Test';
        #$categoryDesc = 'Test';
        
        # Add the statistic:
        $this->addStatisticRaw($typeCode,$typeDesc,$categoryCode,$categoryDesc,$segmentType,$note);

        # For debugging:
        #print "TypeCode: $typeCode\nTypeDesc: $typeDesc\nCategoryCode: $categoryCode\nCategoryDesc: $categoryDesc\n";
    }

    /**
    * Delete a user statistic.
    *
    * @param string $typeCode code of the category type.
    * @param string $categoryCode code of the statistical category.
    */
    public function removeStatistic($typeCode,$categoryCode)
    {
        # Old way:
        #$max = sizeof($this->data);
        #for($i = 0; $i < $max; $i++) {
        #    if (($this->data[$i]->category_type->value == $typeCode) && ($this->data[$i]->statistic_category->value == $categoryCode)) {
        #        unset($this->data[$i]);
        #        $ret = true;
        #    }
        #}

        # New way: (Thanks Rick!)
        foreach($this->data as $key => $row) {
            if (($row->category_type->value == $typeCode) && ($row->statistic_category->value == $categoryCode)) {
                array_splice($this->data, $key, 1);
            }
        }
        return;
    }

    /**
    * Update a user statistic.
    *
    */
    public function updateStatistic($fromTypeCode,$fromCategoryCode,$toTypeCode,$toCategoryCode,$segmentType,$note)
    {
        /* Remove "from" statistic, then add "to" statistic */
        $this->removeStatistic($fromTypeCode,$fromCategoryCode);
        $this->addStatistic($toTypeCode,$toCategoryCode,$segmentType,$note);
    }

    /**
    * Get Stats By Type Code.
    *
    * @return Array of Statistics.
    */
    public function getStatsByTypeCode($typeCode)

    {
        $stats = array();
        foreach ($this->data as $statistic) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            if ($statistic->category_type->value == $typeCode) {
                array_push($stats,$statistic);
            }
    
        }
        return $stats;
    } 

    /**
    * Get Stats by Type Desc.
    *
    * @return Array of statistics.
    */
    public function getStatsByTypeDesc($typeDesc)

    {
        $stats = array();
        foreach ($this->data as $statistic) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            if ($statistic->category_type->desc == $typeDesc) {
                array_push($stats,$statistic);
            }
        }
        return $stats;
    }

    /**
    * Get Stats by Category Code.
    *
    * @return Array of Statistics.
    */
    public function getStatsByCategoryCode($categoryCode)

    {
        $stats = array();
        foreach ($this->data as $statistic) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            if ($statistic->statistic_category->value == $categoryCode) {
                array_push($stats,$statistic);
            }
        }
        return $stats;
    }

    /**
    * Get Stats by Category Desc.
    *
    * @return Array of Statistics.
    */
    public function getStatsByCategoryDesc($categoryDesc)

    {
        $stats = array();
        foreach ($this->data as $statistic) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            if ($statistic->statistic_category->desc == $categoryDesc) {
                array_push($stats,$statistic);
            }
        }
        return $stats;
    }

    /**
    * Get Stats by Segment Type.
    *
    * @return Array of Statistics.
    */
    public function getStatsBySegmentType($segmentType)
    {
        $stats = array();
        foreach ($this->data as $statistic) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            if ($statistic->segment_type == $segmentType) {
                array_push($stats,$statistic);
            }
        }
        return $stats;
    }  

    /**
    * Search Stats by Note.
    *
    * @return Array of Statistics.
    */
    public function searchStatsByNote($note)
    {
        $stats = array();
        foreach ($this->data as $statistic) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            if (preg_match("/$note/i", $statistic->statistic_note)) {
                array_push($stats,$statistic);
            }
        }
        return $stats;
    }

    /** 
    * Search Stats by Type Code.
    *
    * @return Array of Statistics.
    */
    public function searchStatsByTypeCode($typeCode)

    {
        $stats = array();
        foreach ($this->data as $statistic) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            if (preg_match("/$typeCode/i", $statistic->category_type->value)) {
                array_push($stats,$statistic);
            }
        }
        return $stats;
    }

    /**
    * Search Stats by Type Code.
    *
    * @return Array of Statistics.
    */
    public function searchStatsByTypeDesc($typeDesc)

    {
        $stats = array();
        foreach ($this->data as $statistic) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            if (preg_match("/$typeDesc/i", $statistic->category_type->desc)) {
                array_push($stats,$statistic);
            }
        }
        return $stats;
    }

    /**
    * Search Stats by Type Code.
    *
    * @return Array of Statistics.
    */
    public function searchStatsByCategoryCode($categoryCode)

    {
        $stats = array();
        foreach ($this->data as $statistic) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            if (preg_match("/$categoryCode/i", $statistic->statistic_category->value)) {
                array_push($stats,$statistic);
            }
        }
        return $stats;
    }

    /**
    * Search Stats by Type Code.
    *
    * @return Array of Statistics.
    */
    public function searchStatsByCategoryDesc($categoryDesc)

    {
        $stats = array();
        foreach ($this->data as $statistic) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            if (preg_match("/$categoryDesc/i", $statistic->statistic_category->desc)) {
                array_push($stats,$statistic);
            }
        }
        return $stats;
    }

}


scriptotek / php-alma-client