ImageStyle - Code Metrics - Inspection of "FIXES" - sunnysideup/silverstripe-imagewithstyle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 34e737...1a9402 )

by Nicolaas

created 2018-05-14 04:18 UTC

ImageStyle B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	396
Duplicated Lines	13.64 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes

Metric	Value
wmc	52
lcom	1
cbo	6
dl	54
loc	396
c	0
b	0
f	0
rs	7.9487

16 Methods

Rating	Name	Duplication	Size	Complexity
A	i18n_singular_name()	0	4	1
A	i18n_plural_name()	0	4	1
A	canCreate()	0	4	1
A	canEdit()	0	5	1
A	canDelete()	0	9	2
C	validate()	45	45	11
A	onBeforeWrite()	0	9	2
A	onAfterWrite()	0	5	1
D	requireDefaultRecords()	0	38	10
A	getExportFields()	0	5	1
A	CMSEditLink()	0	6	1
A	CMSAddLink()	0	6	1
C	getCMSFields()	9	50	8
B	HasStyleVariable()	0	13	6
A	HasOptionsAsArray()	0	6	2
A	OptionsAsArray()	0	13	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 ImageStyle 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 ImageStyle, and based on these observations, apply Extract Interface, too.

<?php



class ImageStyle extends DataObject
namespace YourVendor;

class YourClass { }
{


    /**
     * see _config folder for details ...
     * @var array
     */
    private static $record_defaults = [];


    #######################
    ### Names Section
    #######################

    private static $singular_name = 'Image Style';


    function i18n_singular_name()

    {
        return _t('ImageStyle.SINGULAR_NAME', 'Image Style');
    }

    private static $plural_name = 'Image Styles';


    function i18n_plural_name()

    {
        return _t('ImageStyle.PLURAL_NAME', 'Image Styles');
    }


    #######################
    ### Model Section
    #######################

    private static $db = [

        'Title' => 'Varchar',
        'ClassNameForCSS' => 'Varchar',
        'Description' => 'Text',
        'Var1Name' => 'Varchar',
        'Var1Type' => 'Enum(\'Pixels,Percentage,Options\', \'Pixels\')',
        'Var1Options' => 'Varchar(200)',
        'Var1Description' => 'Varchar(200)',

        'Var2Name' => 'Varchar',
        'Var2Type' => 'Enum(\'Pixels,Percentage,Options\', \'Pixels\')',
        'Var2Options' => 'Varchar(200)',
        'Var2Description' => 'Varchar(200)',

        'Var3Name' => 'Varchar',
        'Var3Type' => 'Enum(\'Pixels,Percentage,Options\', \'Pixels\')',
        'Var3Options' => 'Varchar(200)',
        'Var3Description' => 'Varchar(200)',

        'Var4Name' => 'Varchar',
        'Var4Type' => 'Enum(\'Pixels,Percentage,Options\', \'Pixels\')',
        'Var4Options' => 'Varchar(200)',
        'Var4Description' => 'Varchar(200)',

        'Var5Name' => 'Varchar',
        'Var5Type' => 'Enum(\'Pixels,Percentage,Options\', \'Pixels\')',
        'Var5Options' => 'Varchar(200)',
        'Var5Description' => 'Varchar(200)',

    ];

    private static $has_many = [

        'ImagesWithStyle' => 'ImageWithStyle'
    ];


    #######################
    ### Further DB Field Details
    #######################

    private static $indexes = [

        'Title' => true
    ];

    private static $default_sort = [

        'Title' => 'ASC'
    ];

    private static $required_fields = [
        'Title',
        'ClassNameForCSS'
    ];

    private static $searchable_fields = [

        'Title' => 'PartialMatchFilter',
        'Description' => 'PartialMatchFilter',
        'ClassNameForCSS' => 'PartialMatchFilter'
    ];


    #######################
    ### Field Names and Presentation Section
    #######################

    private static $field_labels = [

        'Title' => 'Style',

        'Var1Name' => 'Variable 1 Label',
        'Var1Type' => 'Variable 1 Type',
        'Var1Options' => 'Variable 1 Options',
        'Var1Description' => 'Variable 1 Description',

        'Var2Name' => 'Variable 2 Label',
        'Var2Type' => 'Variable 2 Type',
        'Var2Options' => 'Variable 1 Options',
        'Var2Description' => 'Variable 1 Description',

        'Var3Name' => 'Variable 3 Label',
        'Var3Type' => 'Variable 3 Type',
        'Var3Options' => 'Variable 1 Options',
        'Var4Description' => 'Variable 1 Description',

        'Var4Name' => 'Variable 4 Label',
        'Var4Type' => 'Variable 4 Type',
        'Var4Options' => 'Variable 4 Options',
        'Var4Description' => 'Variable 4 Description',

        'Var5Name' => 'Variable 5 Label',
        'Var5Type' => 'Variable 5 Type',
        'Var5Options' => 'Variable 5 Options',
        'Var5Description' => 'Variable 5 Description',
    ];

    private static $field_labels_right = [];

    private static $summary_fields = [

        'Title' => 'Style',
        'ImagesWithStyle.Count' => 'Usage Count'
    ];


    #######################
    ### Casting Section
    #######################


    #######################
    ### can Section
    #######################

    function canCreate($member = null)

    {
        return false;
    }

    function canEdit($member = null)

    {
        //we block edits in CMS
        return parent::canEdit($member);
    }

    function canDelete($member = null)

    {
        if($this->ImagesWithStyle()->count() === 0 ) {
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }

            return parent::canDelete($member);
        }

        return false;
    }



    #######################
    ### write Section
    #######################




    public function validate()

    {
        $result = parent::validate();
        $fieldLabels = $this->FieldLabels();
        $indexes = $this->Config()->get('indexes');
        $requiredFields = $this->Config()->get('required_fields');
        if(is_array($requiredFields)) {
            foreach($requiredFields as $field) {
                $value = $this->$field;
                if(! $value) {
                    $fieldWithoutID = $field;
                    if(substr($fieldWithoutID, -2) === 'ID') {
                        $fieldWithoutID = substr($fieldWithoutID, 0, -2);
                    }
                    $myName = isset($fieldLabels[$fieldWithoutID]) ? $fieldLabels[$fieldWithoutID] : $fieldWithoutID;
                    $result->error(
                        _t(
                            'ImageStyle.'.$field.'_REQUIRED',
                            $myName.' is required'
                        ),
                        'REQUIRED_ImageStyle_'.$field
                    );
                }
                if (isset($indexes[$field]) && isset($indexes[$field]['type']) && $indexes[$field]['type'] === 'unique') {
                    $id = (empty($this->ID) ? 0 : $this->ID);
                    $count = ImageStyle::get()
                        ->filter(array($field => $value))
                        ->exclude(array('ID' => $id))
                        ->count();
                    if($count > 0) {
                        $myName = $fieldLabels['$field'];
                        $result->error(
                            _t(
                                'ImageStyle.'.$field.'_UNIQUE',
                                $myName.' needs to be unique'
                            ),
                            'UNIQUE_ImageStyle_'.$field
                        );
                    }
                }
            }
        }

        return $result;
    }

    public function onBeforeWrite()
    {
        parent::onBeforeWrite();
        $this->ClassNameForCSS = preg_replace('/\W+/','-',strtolower(strip_tags($this->ClassNameForCSS)));

        if(! $this->ClassNameForCSS) {

            $this->ClassNameForCSS = 'image-with-style-'.$this->ID;

        }
        //...
    }

    public function onAfterWrite()
    {
        parent::onAfterWrite();
        //...
    }

    public function requireDefaultRecords()
    {
        parent::requireDefaultRecords();
        //...
        $defaults = $this->Config()->record_defaults;
        $currentOnes = array_flip(ImageStyle::get()->column('ID'));
        $imageNames = Config::inst()->get('PerfectCMSImageDataExtension', 'perfect_cms_images_image_definitions');
        foreach($defaults as $defaultValues) {
            foreach($defaultValues as $field => $value) {
                if(is_array($value)) {
                    $defaultValues[$field] = serialize($value);
                }
            }
            $obj = ImageStyle::get()->filter(['Title' => $defaultValues['Title']])->first();
            if(!$obj) {
                $obj = ImageStyle::create($defaultValues);
            } else {
                foreach($obj->db() as $field => $type) {
                    $obj->$field = null;
                }
                foreach($defaultValues as $field => $value) {
                    $obj->$field = $value;
                }
            }
            unset($currentOnes[$obj->ID]);
            $obj->write();
            if(! isset($imageNames[$obj->ClassNameForCSS])) {

                user_error('You need to define a perfect CMS image with the following name: '.$obj->ClassNameForCSS);

            }

        }
        foreach($currentOnes as $id) {
            $obj = ImageStyle::get()->byID($id);
            if($obj->canDelete()) {
                $obj->delete();
            }
        }
    }


    #######################
    ### Import / Export Section
    #######################

    public function getExportFields()

    {
        //..
        return parent::getExportFields();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }



    #######################
    ### CMS Edit Section
    #######################


    public function CMSEditLink()
    {
        $controller = singleton("tba");

        return $controller->Link().$this->ClassName."/EditForm/field/".$this->ClassName."/item/".$this->ID."/edit";
    }

    public function CMSAddLink()
    {
        $controller = singleton("tba");

        return $controller->Link().$this->ClassName."/EditForm/field/".$this->ClassName."/item/new";
    }


    public function getCMSFields()
    {
        $fields = parent::getCMSFields();

        //do first??
        $rightFieldDescriptions = $this->Config()->get('field_labels_right');
        foreach($rightFieldDescriptions as $field => $desc) {

            $formField = $fields->DataFieldByName($field);
            if(! $formField) {
                $formField = $fields->DataFieldByName($field.'ID');
            }
            if($formField) {
                $formField->setDescription($desc);
            }
        }

        // move variables to their own tab
        for($i = 1; $i < 6; $i++) {
            if($this->HasStyleVariable('Var'.$i)) {
                $fieldsToAdd = [
                    $fields->dataFieldByName('Var'.$i.'Name'),
                    $fields->dataFieldByName('Var'.$i.'Type'),
                    $fields->dataFieldByName('Var'.$i.'Options'),
                    $fields->dataFieldByName('Var'.$i.'Description')
                ];
                $fields->addFieldsToTab(
                    'Root.Variable '.$i,
                    $fieldsToAdd
                );
            } else {
                $fields->removeByName('Var'.$i.'Name');
                $fields->removeByName('Var'.$i.'Type');
                $fields->removeByName('Var'.$i.'Options');
                $fields->removeByName('Var'.$i.'Description');
            }
        }
        $fields->removeByName('ImagesWithStyle');

        //make everything readonly
        foreach($fields->saveableFields() as $field) {
            $fieldName = $field->getName();
            $oldField = $fields->dataFieldByName($fieldName);
            if ($oldField) {
                $newField = $oldField->performReadonlyTransformation();
                $fields->replaceField($fieldName, $newField);
            }
        }

        return $fields;
    }


    public function HasStyleVariable($varName)
    {
        $name = $varName.'Name';
        $type = $varName.'Type';
        $hasBase = $this->$name && $this->$type ? true : false;
        if($this->$type === 'Options') {
            return $hasBase && is_array($this->OptionsAsArray($varName)) ? true : false;
        } else {

            return $hasBase;
        }

    }
    public function HasOptionsAsArray($varName)
    {
        $options = $this->OptionsAsArray($varName);

        return count($options) ? true : false;
    }

    public function OptionsAsArray($varName) : array
    {
        $options = $varName.'Options';
        $array = [];
        if($this->$options) {
            $array = @unserialize($this->$options);
        }
        if(is_array($array)) {
            return $array;
        }

        return [];
    }


}
