ComplexPriceObject - Code Metrics - sunnysideup/silverstripe-ecommerce_complex_pricing - Measure and Improve Code Quality continuously with Scrutinizer

ComplexPriceObject B
last analyzed 2018-03-20 01:04 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	214
Duplicated Lines	4.67 %

Coupling/Cohesion

Components	1
Dependencies	12

Importance

Changes

Metric	Value
wmc	43
lcom	1
cbo	12
dl	10
loc	214
rs	8.3157
c	0
b	0
f	0

13 Methods

Rating	Name	Duplication	Size	Complexity
B	getCMSFields()	10	34	5
A	Buyable()	0	4	1
B	getBuyable()	0	12	7
A	CalculatedPrice()	0	4	1
B	getCalculatedPrice()	0	20	6
A	AppliesTo()	0	4	1
B	getAppliesTo()	0	18	6
A	NoLongerValidNice()	0	4	1
A	getNoLongerValidNice()	0	15	4
B	validate()	0	21	7
A	Name()	0	4	1
A	getName()	0	7	2
A	onBeforeWrite()	0	4	1

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 ComplexPriceObject 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 ComplexPriceObject, and based on these observations, apply Extract Interface, too.

<?php
/**
 * This object is attached to any Buyable
 * using the ComplexPriceBuyableDecorator
 *
 *
 */

class ComplexPriceObject extends DataObject
namespace YourVendor;

class YourClass { }
{
    private static $db = array(

        'NewPrice' => 'Currency',
        'Percentage' => 'Double',
        'Reduction' => 'Currency',
        'From' => 'SS_Datetime',
        'Until' => 'SS_Datetime',
        'NoLongerValid' => 'Boolean'
    );

    private static $many_many = array(

        'Groups' => 'Group',
        'EcommerceCountries' => 'EcommerceCountry'
    );

    private static $searchable_fields = array(

        "NoLongerValid" => true,
        "From" => true,
        "Until" => true
    );

    private static $field_labels = array(

        'From' => 'Valid From',
        'Until' => 'Valid Until',
        'NoLongerValidNice' => 'Valid?'
    );

    private static $summary_fields = array(

        'From' => 'Valid From',
        'Until' => 'Valid Until',
        'AppliesTo' => 'Applies To',
        'CalculatedPrice' => 'New Price',
        'NoLongerValidNice' => 'Valid'
    );

    private static $casting = array(

        'NoLongerValidNice' => 'Varchar',
        'Buyable' => 'DataOject',
        'Name' => 'Varchar',
        'CalculatedPrice' => 'Currency',
        'AppliesTo' => 'Text'
    );

    private static $singular_name = "Price";


    private static $plural_name = "Prices";


    //defaults
    private static $default_sort = "\"Until\" DESC";


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

        $fields->replaceField("From", $from = new DateField("From", "Valid From - add any date and time"));
        $fields->replaceField("Until", $until = new DateField("Until", "Valid Until - add any date and time"));
        $fields->replaceField("NewPrice", new CurrencyField("NewPrice", "PRICE (OPTION 1 / 3) - only enter if there is a set new price independent of the 'standard' price."));
        $fields->replaceField("Percentage", new NumericField("Percentage", "PERCENTAGE (OPTIONAL 2/ 3) discount from 0 (0% discount) to 100 (100% discount)."));
        $fields->replaceField("Reduction", new CurrencyField("Reduction", "REDUCTION (OPTION 3 /3 ) - e.g. if you enter 2.00 then the new price will be the standard product price minus 2."));
        if (!$this->ID) {
            $fields->addFieldToTab("Root.Main", new LiteralField("SaveFirst", "<p>Please save first - and then select security groups / countries</p>"));
            $fields->removeByName("NoLongerValid");
        }
        if ($groups = Group::get()->count()) {
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
            $groups = Group::get();
            $fields->replaceField("Groups", new CheckboxSetField("Groups", "Who", $groups->map()->toArray()));
        } else {
            $fields->removeByName("Groups");
        }
        if ($ecommerceCountries = EcommerceCountry::get()) {

            $fields->replaceField("EcommerceCountries", new CheckboxSetField("EcommerceCountries", "Where", $ecommerceCountries->map()->toArray()));
        } else {
            $fields->removeByName("EcommerceCountries");
        }
        if (DiscountCouponOption::get()->count()) {

            $fields->replaceField("DiscountCouponOptions", new CheckboxSetField("DiscountCouponOptions", "Discount Coupons", DiscountCouponOption::get()->map()->toArray()));
        } else {
            $fields->removeByName("DiscountCouponOptions");
        }

        $from->setConfig('showcalendar', true);
        $until->setConfig('showcalendar', true);
        return $fields;
    }

    public function Buyable()

    {
        return $this->getBuyable();
    }
    public function getBuyable()

    {
        $array = $this->stat("has_one");
        if ($array && is_array($array) && count($array)) {
            foreach ($array as $className) {
                $fieldName = $className."ID";
                if (isset($this->$fieldName) && $this->$fieldName > 0) {
                    return $className::get()->byID($this->$fieldName);
                }
            }
        }
    }

    /**
     *
     * works out any price reductions
     */
    public function CalculatedPrice()

    {
        return $this->getCalculatedPrice();
    }
    public function getCalculatedPrice()

    {
        $buyable = $this->getBuyable();
        if ($this->NewPrice && $this->NewPrice > 0) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $newPrice = $this->NewPrice;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        } else {
            $newPrice = $buyable->Price;
            if ($this->Percentage) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                $newPrice  = $newPrice - ($newPrice * ($this->Percentage / 100));
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            }
            if ($this->Reduction) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                $newPrice = $newPrice - $this->Reduction;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            }
            return $newPrice;
        }
        if ($newPrice < 0) {
            $newPrice = 0;
        }
        return $newPrice;
    }

    public function AppliesTo()
    {
        return $this->getAppliesTo();
    }
    public function getAppliesTo()
    {
        $appliesTo = array(); //;
        if ($this->Groups()) {
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 { }
            foreach ($this->Groups() as $group) {
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 { }
                $appliesTo[] = $group->getTitle();
            }
        }
        if ($this->EcommerceCountries()) {
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 { }
            foreach ($this->EcommerceCountries() as $ecommerceCountries) {
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 { }
                $appliesTo[] = $ecommerceCountries->getTitle();
            }
        }
        if (!count($appliesTo)) {
            $appliesTo[] = "Everyone";
        }
        return implode(", ", $appliesTo) . ".";
    }

    public function NoLongerValidNice()
    {
        return $this->getNoLongerValidNice();
    }
    public function getNoLongerValidNice()
    {
        $nowTS = strtotime("now");
        $untilTS = strtotime($this->Until);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        if ($this->NoLongerValid ||  $untilTS < $nowTS) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            if ($untilTS < $nowTS) {
                $this->NoLongerValid;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                $this->write();
                return "expired";
            }
            return "no longer valid";
        } else {
            return "current";
        }
    }

    public function validate()
    {
        $errors = array();
        if (strtotime($this->From) < strtotime("1 jan 2000")) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $errors[] = "The FROM field needs to be after 1 Jan 2000";
        }
        if (strtotime($this->Until) < strtotime("1 jan 2000")) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $errors[] = "The UNTIL field needs to be after 1 Jan 2000";
        }
        if (strtotime($this->Until) < strtotime($this->From)) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $errors[] = "The UNTIL field needs to be after the FROM field";
        }
        if ($this->Percentage < 0 || $this->Percentage > 100) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $errors[] = "The PERCENTAGE field needs to be between 0 and 100";
        }
        if (count($errors)== 0) {
            return new ValidationResult();
        } else {
            return new ValidationResult(false, "Please check: ".implode("; ", $errors).".");
        }
    }

    public function Name()

    {
        return $this->getName();
    }
    public function getName()

    {
        if ($buyable = $this->getBuyable()) {
            return $buyable->getTitle();
        }
        return "no name";
    }

    public function onBeforeWrite()
    {
        parent::onBeforeWrite();
    }
}


sunnysideup / silverstripe-ecommerce_complex_pricing

ComplexPriceObject B last analyzed 2018-03-20 01:04 UTC