CurrencyConverterComponent::getRateToUse() - Code Metrics - Inspection of "Refactoring, Add Helper, change convert method par..." - AlessandroMinoccheri/cakephp-currency-converter - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#14)

unknown

created 2018-10-31 19:39 UTC

CurrencyConverterComponent::getRateToUse() B

↳ Parent: CurrencyConverterComponent

Complexity

Conditions	8
Paths	8

Size

Total Lines	38
Code Lines	24

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	15
CRAP Score	12.8474

Importance

Changes

Metric	Value
cc	8
eloc	24
nc	8
nop	2
dl	0
loc	38
ccs	15
cts	26
cp	0.5769
crap	12.8474
rs	8.4444
c	0
b	0
f	0

<?php
namespace CurrencyConverter\Controller\Component;

use Cake\Controller\Component;
use Cake\Datasource\ConnectionManager;
use Cake\ORM\TableRegistry;
use Cake\I18n\Time;

/**
 * CurrencyConverter Component to convert currency.
 *
 * Convert an amount number from one currency to an other currency
 * Return currency rate from one currency to an other
 * output type from HTML to JSON format.
 */
class CurrencyConverterComponent extends Component
{
    
    /**
     * Using database
     *
     * @var bool
     */
    public $database;

    /**
     * Time interval for refreshing database
     *
     * @var int
     */
    public $refresh;

    /**
     * Number of decimal to use for formatting converted price
     *
     * @var int
     */
    public $decimal;

    /**
     * CurrencyratesTable Class
     * @var \Cake\ORM\Table
     */
    private $_currencyratesTable;

    /**
     * Default CurrencyConverterComponent settings.
     *
     * When calling CurrencyConverterComponent() these settings will be merged with the configuration
     * you provide.
     *
     * - `database` - Mention if Component have to store currency rate in database
     * - `refresh` - Time interval for Component to refresh currency rate in database
     * - `decimal` - Number of decimal to use when formatting amount float number
     *
     * @var array
     */
    protected $_defaultConfig = [
        'database' => true, // Mention if Component have to store currency rate in database
        'refresh' => 24, // Time interval for Component to refresh currency rate in database
        'decimal' => 2, // Number of decimal to use when formatting amount float number
    ];

    /**
     * @param array $config
     * @return void
     */
    public function initialize(array $config = []) {

        $config = $this->getConfig();

        $this->database = $config['database'];
        $this->refresh = $config['refresh'];
        $this->decimal = $config['decimal'];

        $this->_currencyratesTable = TableRegistry::get('CurrencyConverter.Currencyrates');
        $this->_currencyratesTable = /** @scrutinizer ignore-deprecated */ TableRegistry::get('CurrencyConverter.Currencyrates');
    }

    /**
     * Convert method take an amount as first parameter and convert it using $from currency and $to currency.
     *
     * @param float|string $amount the amount to convert.
     * @param string $from currency to convert from
     * @param string $to currency to convert to
     * @return float $amount converted
     */
    public function convert($amount, $from, $to)
    {
        $amount = floatval($amount);
        $rate = $this->getRateToUse($from, $to);

        return $convert = $this->_formatConvert($rate * $amount);

    }

    /**
     * Rate method return the rate of two currencies
     *
     * @param string $from currency to get the rate from
     * @param string $to currency to get the rate to
     * @return float|null $rate
     */
    public function rate($from, $to)
    {
        return $this->getRateToUse($from, $to);
    }

    /**
     * getRateToUse return rate to use
     * Using $from and $to parameters representing currency to deal with and the configuration settings
     * This method save or update currencyrates Table if necesseray too.
     *
     * @param string $from currency to get the rate from
     * @param string $to currency to get the rate to
     * @return float|null $rate
     */
    public function getRateToUse($from, $to)
    {
        if ($from == $to) {
            return 1;
        } else {
            if ($this->database) {
                // Get a currency rate from table
                $result = $this->_currencyratesTable->find('all')->where(['from_currency' => $from, 'to_currency' => $to])->first();
                if ($result) {
                    // If currency rate is in table and it doesn't have to be updated
                    if ($result->get('modified')->wasWithinLast($this->refresh . ' hours')) {
                        return $rate = $result->get('rate');

                    } else {
                        $rate = $this->_getRateFromAPI($from, $to);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
                        if ($rate) {

                            $result->rate = $rate;
                            $this->_currencyratesTable->save($result);
                        }
                        return $rate;
                    }
                }
                // If currency rate isn't in table
                if (!$result) {
                    $rate = $this->_getRateFromAPI($from, $to);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
                    if ($rate) {

                        $entity = $this->_currencyratesTable->newEntity([
                            'from_currency' => $from,
                            'to_currency' => $to,
                            'rate' => $rate
                        ]);
                        $this->_currencyratesTable->save($entity);
                    }
                    return $rate;
                }
            }
        }
        
        return $this->_getRateFromAPI($from, $to);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
    }

    /**
     * Format number using configuration
     *
     * @param float price to format
filter:
    dependency_paths: ["lib/*"]
     * @return float
     */
    private function _formatConvert($number)
    {
        return floatval(number_format($number, $this->decimal));
    }

    /**
     * Call free.currencyconverterapi.com API to get a rate for one currency to an other one currency
     *
     * @param string $from the currency
     * @param string $to the currency
     * @return int|null $rate
     */
    private function _getRateFromAPI($from, $to)
    {
        $rate = null;

        $url = 'https://free.currencyconverterapi.com/api/v5/convert?q=' . $from . '_' . $to . '&compact=ultra';
        $request = @fopen($url, 'r');

        if ($request) {

            $response = fgets($request, 4096);
            fclose($request);
            $response = json_decode($response, true);
            if (isset($response[$from . '_' . $to])) {
                $rate = $response[$from . '_' . $to];
            }
        }
        
        return $rate;
    }
}


AlessandroMinoccheri / cakephp-currency-converter

Pull Request — master (#14)

CurrencyConverterComponent::getRateToUse() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like