Weight::add() - Code Metrics - Inspection of "Merge pull request #3 from ARCANEDEV/pacth-refacto..." - ARCANEDEV/Units - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 428089...0b32e2 )

by ARCANEDEV

created 2016-08-22 19:51 UTC

Weight::add() A

↳ Parent: Weight

Complexity

Conditions	1
Paths	1

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	1

Importance

Changes	3
Bugs	0	Features	0

Metric	Value
c	3
b	0
f	0
dl	0
loc	8
ccs	6
cts	6
cp	1
rs	9.4285
cc	1
eloc	4
nc	1
nop	1
crap	1

<?php namespace Arcanedev\Units\Measures;

use Arcanedev\Units\Bases\UnitMeasure;
use Arcanedev\Units\Contracts\Weight as WeightContract;
use Arcanedev\Units\Traits\Calculatable;
use Illuminate\Support\Arr;

/**
 * Class     Weight
 *
 * @package  Arcanedev\Units
 * @author   ARCANEDEV <[email protected]>
 */
class Weight extends UnitMeasure implements WeightContract
{
    /* ------------------------------------------------------------------------------------------------
     |  Traits
     | ------------------------------------------------------------------------------------------------
     */
    use Calculatable;

    /* ------------------------------------------------------------------------------------------------
     |  Constructor
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Weight constructor.
     *
     * @param  float|int  $value
     * @param  string     $unit
     * @param  array      $options
     */
    public function __construct($value = 0, $unit = self::KG, array $options = [])
    {
        $this->setValue($value);
        $this->setUnit($unit);
        $this->setSymbols(Arr::get($options, 'symbols', []));
        $this->setFormat(
            Arr::get($options, 'decimals', 0),
            Arr::get($options, 'separators.decimal', ','),
            Arr::get($options, 'separators.thousands', '.')
        );
    }

    /* ------------------------------------------------------------------------------------------------
     |  Getters & Setters
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Get the symbol's names.
     *
     * @return array
     */
    public static function names()
    {
        return array_combine(static::units(), [
            'ton',
            'kilogram',
            'gram',
            'milligram',
        ]);
    }

    /**
     * Get the symbol name.
     *
     * @param  string  $unit
     *
     * @return string
     */
    public static function getSymbolName($unit)
    {
        static::checkUnit($unit);

        return Arr::get(static::names(), $unit);
    }

    /* ------------------------------------------------------------------------------------------------
     |  Main Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Make a weight instance.
     *
     * @param  float|int  $value
     * @param  string     $unit
     * @param  array      $options
     *
     * @return self
     */
    public static function make($value = 0, $unit = self::KG, array $options = [])
    {
        return new static($value, $unit, $options);
    }

    /**
     * Convert the weight to the given unit.
     *
     * @param  string  $to
     *
     * @return self
     */
    public function to($to)
    {
        if ($to === $this->unit()) return $this;

        $value = static::convert($this->unit(), $to, $this->value());

        return static::make($value, $to);
    }

    /**
     * Convert the weight.
     *
     * @param  string     $from
     * @param  string     $to
     * @param  float|int  $value
     *
     * @return float|int
     */
    public static function convert($from, $to, $value)
    {
        return $value * static::getRatio($to, $from);
    }

    /* ------------------------------------------------------------------------------------------------
     |  Calculation Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Add the weight.
     *
     * @param  float|int  $value
     * @param  string     $unit
     *
     * @return self
     */
    public function addWeight($value, $unit = self::KG)
    {
        return $this->add(self::make($value, $unit));
    }

    /**
     * Sub the weight.
     *
     * @param  float|int  $value
     * @param  string     $unit
     *
     * @return self
     */
    public function subWeight($value, $unit = self::KG)
    {
        return $this->sub(static::make($value, $unit));
    }

    /* ------------------------------------------------------------------------------------------------
     |  Other Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Get the weight convert ratio.
     *
     * @param  string  $to
     * @param  string  $from
     *
     * @return double|float|integer
     */
    protected static function getRatio($to, $from)
    {
        static::checkUnit($from);
        static::checkUnit($to);

        if ($to === $from) return 1;

        $ratios = static::getRatios();

        return $ratios[$to] / $ratios[$from];
    }

    /**
     * Get all the weight ratios.
     *
     * @return array
     */
    protected static function getRatios()
    {
        $rate   = 1000;
        $ratios = [
            static::TON => 0,
            static::KG  => 1,
            static::G   => 2,
            static::MG  => 3,
        ];

        return array_map(function ($ratio) use ($rate) {
            return static::calculate($rate, '^', $ratio);
        }, $ratios);
    }
}


1		<?php namespace Arcanedev\Units\Measures;
2
3		use Arcanedev\Units\Bases\UnitMeasure;
4		use Arcanedev\Units\Contracts\Weight as WeightContract;
5		use Arcanedev\Units\Traits\Calculatable;
6		use Illuminate\Support\Arr;
7
8		/**
9		* Class Weight
10		*
11		* @package Arcanedev\Units
12		* @author ARCANEDEV <[email protected]>
13		*/
14		class Weight extends UnitMeasure implements WeightContract
15		{
16		/* ------------------------------------------------------------------------------------------------
17		\| Traits
18		\| ------------------------------------------------------------------------------------------------
19		*/
20		use Calculatable;
21
22		/* ------------------------------------------------------------------------------------------------
23		\| Constructor
24		\| ------------------------------------------------------------------------------------------------
25		*/
26		/**
27		* Weight constructor.
28		*
29		* @param float\|int $value
30		* @param string $unit
31		* @param array $options
32		*/
33	168	public function __construct($value = 0, $unit = self::KG, array $options = [])
34		{
35	168	$this->setValue($value);
36	168	$this->setUnit($unit);
37	168	$this->setSymbols(Arr::get($options, 'symbols', []));
38	168	$this->setFormat(
39	168	Arr::get($options, 'decimals', 0),
40	168	Arr::get($options, 'separators.decimal', ','),
41	168	Arr::get($options, 'separators.thousands', '.')
42	126	);
43	168	}
44
45		/* ------------------------------------------------------------------------------------------------
46		\| Getters & Setters
47		\| ------------------------------------------------------------------------------------------------
48		*/
49		/**
50		* Get the symbol's names.
51		*
52		* @return array
53		*/
54	8	public static function names()
55		{
56	8	return array_combine(static::units(), [
57	8	'ton',
58	6	'kilogram',
59	6	'gram',
60	6	'milligram',
61	6	]);
62		}
63
64		/**
65		* Get the symbol name.
66		*
67		* @param string $unit
68		*
69		* @return string
70		*/
71	8	public static function getSymbolName($unit)
72		{
73	8	static::checkUnit($unit);
74
75	8	return Arr::get(static::names(), $unit);
76		}
77
78		/* ------------------------------------------------------------------------------------------------
79		\| Main Functions
80		\| ------------------------------------------------------------------------------------------------
81		*/
82		/**
83		* Make a weight instance.
84		*
85		* @param float\|int $value
86		* @param string $unit
87		* @param array $options
88		*
89		* @return self
90		*/
91	64	public static function make($value = 0, $unit = self::KG, array $options = [])
92		{
93	64	return new static($value, $unit, $options);
94		}
95
96		/**
97		* Convert the weight to the given unit.
98		*
99		* @param string $to
100		*
101		* @return self
102		*/
103	64	public function to($to)
104		{
105	64	if ($to === $this->unit()) return $this;
106
107	16	$value = static::convert($this->unit(), $to, $this->value());
108
109	16	return static::make($value, $to);
110		}
111
112		/**
113		* Convert the weight.
114		*
115		* @param string $from
116		* @param string $to
117		* @param float\|int $value
118		*
119		* @return float\|int
120		*/
121	16	public static function convert($from, $to, $value)
122		{
123	16	return $value * static::getRatio($to, $from);
124		}
125
126		/* ------------------------------------------------------------------------------------------------
127		\| Calculation Functions
128		\| ------------------------------------------------------------------------------------------------
129		*/
130		/**
131		* Add the weight.
132		*
133		* @param float\|int $value
134		* @param string $unit
135		*
136		* @return self
137		*/
138	16	public function addWeight($value, $unit = self::KG)
139		{
140	16	return $this->add(self::make($value, $unit));
141		}
142
143		/**
144		* Sub the weight.
145		*
146		* @param float\|int $value
147		* @param string $unit
148		*
149		* @return self
150		*/
151	16	public function subWeight($value, $unit = self::KG)
152		{
153	16	return $this->sub(static::make($value, $unit));
154		}
155
156		/* ------------------------------------------------------------------------------------------------
157		\| Other Functions
158		\| ------------------------------------------------------------------------------------------------
159		*/
160		/**
161		* Get the weight convert ratio.
162		*
163		* @param string $to
164		* @param string $from
165		*
166		* @return double\|float\|integer
167		*/
168	16	protected static function getRatio($to, $from)
169		{
170	16	static::checkUnit($from);
171	16	static::checkUnit($to);
172
173	16	if ($to === $from) return 1;
174
175	16	$ratios = static::getRatios();
176
177	16	return $ratios[$to] / $ratios[$from];
178		}
179
180		/**
181		* Get all the weight ratios.
182		*
183		* @return array
184		*/
185	16	protected static function getRatios()
186		{
187	16	$rate = 1000;
188		$ratios = [
189	16	static::TON => 0,
190	16	static::KG => 1,
191	16	static::G => 2,
192	16	static::MG => 3,
193	12	];
194
195	16	return array_map(function ($ratio) use ($rate) {
196	16	return static::calculate($rate, '^', $ratio);
197	16	}, $ratios);
198		}
199		}
200

ARCANEDEV / Units

Push — master ( 428089...0b32e2 )

Weight::add() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like