Kohana_Model_Shipping_Item - Code Metrics - Inspection of "SUP-900 Upgrade phpunit to 7^" - OpenBuildings/shipping - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — master (#22)

by Stanimir
created 2020-02-18 15:53 UTC
Kohana_Model_Shipping_Item A

↳ Parent: Project
Complexity

Total Complexity
Size/Duplication

Total Lines	310
Duplicated Lines	0 %
Coupling/Cohesion

Components	1
Dependencies	10
Test Coverage

Coverage
91.86%
Importance

Changes
Metric	Value
wmc	37
lcom	1
cbo	10
dl	0
loc	310
ccs	79
cts	86
cp	0.9186
rs	9.44
c	0
b	0
f	0
25 Methods

Rating	Name	Size	Complexity
A	initialize()	28	1
A	filter_discounted_items()	8	1
A	sort_by_price()	13	2
A	relative_prices()	12	2
A	shipping_insist()	8	1
A	purchase_item_shipping()	4	1
A	paid_at()	4	1
A	currency()	4	1
A	monetary()	4	1
A	group_key()	9	3
A	price()	8	2
A	additional_item_price()	10	2
A	is_discounted()	4	1
A	quantity()	4	1
A	total_price()	6	1
A	total_delivery_time()	6	2
A	shipping_date()	10	1
A	total_additional_item_price()	4	1
A	shipping_method()	7	2
A	update_address()	12	5
A	performFreeze()	4	1
A	performUnfreeze()	4	1
A	shipping_group_insist()	8	1
A	isFrozen()	4	1
A	setFrozen()	4	1
<?php defined('SYSPATH') OR die('No direct script access.');

use Clippings\Freezable\FreezableInterface;
use Clippings\Freezable\FreezableTrait;

/**
 * @package    openbuildings\shipping
 * @author     Ivan Kerin <[email protected]>
 * @copyright  (c) 2013 OpenBuildings Ltd.
 * @license    http://spdx.org/licenses/BSD-3-Clause
 */
class Kohana_Model_Shipping_Item extends Jam_Model implements FreezableInterface {

	use FreezableTrait;

	/**
	 * @codeCoverageIgnore
	 */
	public static function initialize(Jam_Meta $meta)
	{
		$meta
			->associations(array(
				'brand_purchase_shipping' => Jam::association('belongsto', array(
					'inverse_of' => 'items'
				)),
				'purchase_item' => Jam::association('belongsto', array(
					'inverse_of' => 'shipping_item',
					'foreign_key' => 'purchase_item_id',
					'foreign_model' => 'purchase_item_product'
				)),
				'shipping_group' => Jam::association('belongsto', array(
					'inverse_of' => 'shipping_items'
				)),
			))
			->fields(array(
				'id' => Jam::field('primary'),
				'model' => Jam::field('polymorphic'),
				'total_delivery_time' => Jam::field('range', array(
					'format' => 'Model_Shipping::format_shipping_time'
				)),
				'is_frozen' => Jam::field('boolean'),
			))
			->validator('purchase_item', array(
				'present' => TRUE
			));
	}

	/**
	 * Filter out Model_Shipping_Item's of shipping_groups that are discounted,
	 * based on the provided total price
	 * @param  array     $items array of Model_Shipping_Item objects
	 * @param  Jam_Price $total
	 * @return array     Model_Shipping_Item objects
	 */
	public static function filter_discounted_items(array $items, Jam_Price $total)
	{
		Array_Util::validate_instance_of($items, 'Model_Shipping_Item');

		return array_filter($items, function($item) use ($total) {
			return ! $item->is_discounted($total);
		});
	}

	/**
	 * Sort Model_Shipping_Item by price, biggest price first
	 * @param  array  $items
	 * @return array
	 */
	public static function sort_by_price(array $items)
	{
		Array_Util::validate_instance_of($items, 'Model_Shipping_Item');

		// Suppress warnings as usort throws "Array was modified by the user comparison function"
		// When price method is being mocked.
		// Relevant php bug: https://bugs.php.net/bug.php?id=50688
		@ usort($items, function($item1, $item2){
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
			return $item1->price()->is(Jam_Price::GREATER_THAN, $item2->price()) ? -1 : 1;
		});

		return $items;
	}

	/**
	 * Sort and get all the realtive prices of Model_Shipping_Item object (using relative_price method)
	 * @param  array  $items
	 * @return array  Jam_Price objects
	 */
	public static function relative_prices(array $items)
	{
		Array_Util::validate_instance_of($items, 'Model_Shipping_Item');

		$items = Model_Shipping_Item::sort_by_price($items);

		$prices = array_map(function($item, $index) {
			return $index == 0 ? $item->total_price() : $item->total_additional_item_price();
		}, $items, array_keys($items));

		return $prices;
	}

	/**
	 * Get the shipping object associated with this item
	 * @return Model_Shipping
	 * @throws Kohana_Exception If shipping_group or its shipping is NULL
	 */
	public function shipping_insist()
	{
		$self = $this;

		return Jam_Behavior_Paranoid::with_filter(Jam_Behavior_Paranoid::ALL, function() use ($self) {
			return $self->get_insist('shipping_group')->get_insist('shipping');
		});
	}

	public function purchase_item_shipping()
	{
		return $this->get_insist('purchase_item')->get_insist('reference')->shipping();
	}

	/**
	 * Return the date the purchase was paid
	 */
	public function paid_at()
	{
		return $this->get_insist('brand_purchase_shipping')->paid_at();
	}

	/**
	 * Get the currency for pricing calculations
	 * @return string
	 * @throws Kohana_Exception If brand_purchase_shipping is NULL
	 */
	public function currency()
	{
		return $this->get_insist('brand_purchase_shipping')->currency();
	}

	/**
	 * Get the monetary object for currency calculations
	 * @return Monetary
	 * @throws Kohana_Exception If brand_purchase_shipping is NULL
	 */
	public function monetary()
	{
		return $this->get_insist('brand_purchase_shipping')->monetary();
	}

	/**
	 * Generate a key based on which shipping groups will be devided.
	 * The items in the same group are shipped toggether, allowing us to use
	 * additional_item_price instead of price.
	 *
	 * Groups by method and ships_from
	 * @return string
	 * @throws Kohana_Exception If shipping_group or shipping is NULL
	 */
	public function group_key()
	{
		$group = $this->shipping_group;
<?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 ( ! $group OR ! $group->shipping)
			return NULL;

		return $group->method_id.'-'.$group->shipping->ships_from_id;
	}

	/**
	 * Get the price from shipping_group, converted into purchase's currency / monetary
	 * @return Jam_Price
	 * @throws Kohana_Exception If shipping_group is NULL
	 */
	public function price()
	{
		$price = $this->shipping_group_insist()->price ?: new Jam_Price(0, $this->currency());

		return $price
			->monetary($this->monetary())
				->convert_to($this->currency());
	}

	/**
	 * Get the additional_item_price from shipping_group, converted into purchase's currency / monetary
	 * If there is no additional_item_price, return price instead
	 * @return Jam_Price
	 * @throws Kohana_Exception If shipping_group is NULL
	 */
	public function additional_item_price()
	{
		$group = $this->shipping_group_insist();

		$additional_price = $group->additional_item_price ?: $group->price;

		return $additional_price
			->monetary($this->monetary())
				->convert_to($this->currency());
	}

	/**
	 * Get shipping_group's is_discounted
	 * If there is no additional_item_price, return price instead
	 * @return boolean
	 * @throws Kohana_Exception If shipping_group is NULL
	 */
	public function is_discounted(Jam_Price $total)
	{
		return $this->shipping_group_insist()->is_discounted($total);
	}

	/**
	 * Get purchase_item's quantity
	 * @return Jam_Price
	 * @throws Kohana_Exception If shipping_group is NULL
	 */
	public function quantity()
	{
		return $this->get_insist('purchase_item')->quantity;
	}

	/**
	 * Return price(), if quantity() > 1 the nany additional items are summed using additional_items_price()
	 * @return Jam_Price
	 * @throws Kohana_Exception If shipping_group is NULL
	 */
	public function total_price()
	{
		$additional_items_price = $this->additional_item_price()->multiply_by($this->quantity() - 1);

		return $this->price()->add($additional_items_price);
	}

	/**
	 * Shipping group's delivery_time
	 * Freezable
	 *
	 * @return Jam_Range
	 */
	public function total_delivery_time()
	{
		return $this->isFrozen()
			? $this->total_delivery_time
<?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->shipping_group_insist()->total_delivery_time();
	}

	/**
	 * Return the shipping date for this item
	 * @return Jam_Range
	 */
	public function shipping_date()
	{
		$paid_at = $this->paid_at();
		$days = $this->total_delivery_time();

		$from_day = strtotime("{$paid_at} + {$days->min()} weekdays");
		$to_day = strtotime("{$paid_at} + {$days->max()} weekdays");

		return new Jam_Range(array($from_day, $to_day));
	}

	/**
	 * Return additional_items_price() multiplied by quantity()
	 * @return Jam_Price
	 * @throws Kohana_Exception If shipping_group or purchase_item is NULL
	 */
	public function total_additional_item_price()
	{
		return $this->additional_item_price()->multiply_by($this->quantity());
	}

	/**
	 * Use paranoid for shipping group
	 */
	public function shipping_group_insist()
	{
		$self = $this;

		return Jam_Behavior_Paranoid::with_filter(Jam_Behavior_Paranoid::ALL, function() use ($self) {
			return $self->get_insist('shipping_group');
		});
	}

	public function shipping_method()
	{
		if ( ! $this->shipping_group)
<?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 NULL;

		return $this->shipping_group->method;
<?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.");
        }
    }

}
	}

	public function update_address(Model_Brand_Purchase_Shipping $brand_purchase_shipping)
	{
		$ship_to = $brand_purchase_shipping->ship_to();

		if ( ! $ship_to)
			return;

		if (! $this->shipping_group OR ! $this->shipping_group->location OR ! $this->shipping_group->location->contains($ship_to))
<?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->shipping_group = $this->purchase_item_shipping()->cheapest_group_in($ship_to);
<?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.");
        }
    }

}
		}
	}

	public function isFrozen()
	{
		return $this->is_frozen;
<?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.");
        }
    }

}
	}

	public function setFrozen($frozen)
	{
		$this->is_frozen = (bool) $frozen;
<?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.");
        }
    }

}
	}

	public function performFreeze()
	{
		$this->total_delivery_time = $this->total_delivery_time();
<?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.");
        }
    }

}
	}

	public function performUnfreeze()
	{
		$this->total_delivery_time = NULL;
<?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.");
        }
    }

}
	}
}

OpenBuildings / shipping

Pull Request — master (#22)

Kohana_Model_Shipping_Item A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

25 Methods

Duplication Side-by-Side

Filter issues like
