FakeCar::vin() - Code Metrics - Inspection of "Add engine power and torque" - pelmered/fake-car - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — feature/add-engine-power-and-t... ( af7024 )

by Peter

created 2024-02-03 03:33 UTC

FakeCar::vin() A

↳ Parent: FakeCar

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

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

<?php

namespace Faker\Provider;

use Exception;
use Faker\Generator;

class FakeCar extends \Faker\Provider\Base
{
    protected const EBCDIC = "0123456789.ABCDEFGH..JKLMN.P.R..STUVWXYZ";
    protected const MODEL_YEAR = "ABCDEFGHJKLMNPRSTVWXY123456789";

    protected FakeCarDataProviderInterface $dataProvider;

    /**
     * @param Generator $generator
     */
    public function __construct(Generator $generator)
    {
        parent::__construct($generator);
        $this->setDataProvider(new FakeCarDataProvider());
    }

    public function setDataProvider(FakeCarDataProviderInterface $dataProvider): void
    {
        $this->dataProvider = $dataProvider;
    }

    /**
     * Get vehicle string with brand and model
     *
     * @return string
     */
    public function vehicle(): string
    {
        $vehicleBrand = $this->vehicleBrand();

        return $vehicleBrand.' '.$this->vehicleModel($vehicleBrand);
    }

    /**
     * Get vehicle with brand and model as an array
     *
     * @return array
     */
    public function vehicleArray(): array
    {
        $vehicleBrand = $this->vehicleBrand();

        return [
            'brand' => $vehicleBrand,
            'model' => $this->vehicleModel($vehicleBrand)
        ];
    }

    /**
     * Get random vehicle brand
     *
     * @return string
     */
    public function vehicleBrand(): string
    {
        return (string) $this->dataProvider->getVehicleBrand();
    }

    /**
     * Get random vehicle model
     *
     * @param string $brand Get random model from specific brand (optional)
     *
     * @return mixed
     */
    public function vehicleModel(string $brand = null): string
    {
        return (string) $this->dataProvider->getVehicleModel($brand);
        return (string) $this->dataProvider->/** @scrutinizer ignore-call */ getVehicleModel($brand);
    }

    /**
     * Generate VIN
     * @link https://en.wikipedia.org/wiki/Vehicle_identification_number
     *
     * @param int $year
     *
     * @return mixed
     */
    public function vin(int $year = 1980): string
    {
        $modelYear = static::modelYear($year);
        $regex = "([a-hj-npr-z0-9]{8})_{$modelYear}([a-hj-npr-z0-9]{7})";
        $vin = static::regexify($regex);
        return str_replace('_', self::checkDigit($vin), $vin);
    }

    /**
     * Get vehicle registration number
     *
     * @param string $regex
     *
     * @return string
     */
    public function vehicleRegistration(string $regex = '[A-Z]{3}-[0-9]{3}'): string
    {
        //TODO: Set format based on locale
        return static::regexify($regex);
    }

    /**
     * Get vehicle type
     *
     * @return string
     * @throws Exception
     */
    public function vehicleType(): string
    {
        return (string) $this->dataProvider->getVehicleType();
    }

    /**
     * Get vehicle fuel type
     *
     * @param int $count
     *
     * @return string
     */
    public function vehicleFuelType(int $count = 1): string
    {
        return (string) $this->dataProvider->getVehicleFuelType($count);
        return (string) $this->dataProvider->/** @scrutinizer ignore-call */ getVehicleFuelType($count);
    }

    /**
     * Get vehicle door count
     *
     * @return int
     * @throws Exception
     */
    public function vehicleDoorCount(): int
    {
        return (int) $this->dataProvider->getVehicleDoorCount();
    }

    /**
     * Get vehicle door count
     *
     * @return int
     * @throws Exception
     */
    public function vehicleSeatCount(): int
    {
        return (int) $this->dataProvider->getVehicleSeatCount();
    }

    /**
     * Get an array of random vehicle properties
     *
     * @param int $count
     *
     * @return array
     * @throws Exception
     */
    public function vehicleProperties(int $count = 0): array
    {
        return $this->dataProvider->getVehicleProperties($count);
    }

    /**
     * Get random vehicle gearbox type
     *
     * @return mixed
     * @throws Exception
     */
    public function vehicleGearBoxType(): string
    {
        return $this->dataProvider->getVehicleGearBoxType();
    }


    /**
     * Get engine torque
     *
     * @return mixed
     * @throws Exception
     */
    public function vehicleEngineTorque(): string
    {
        return $this->dataProvider->getVehicleEngineTorque();
    }

    /**
     * Get engine power (horsepower or kilowatts)
     *
     * @return mixed
     * @throws Exception
     */
    public function vehicleEnginePower(): string
    {
        return $this->dataProvider->getVehicleEnginePower();
    }


    /**
     * @param int $year
     *
     * @return string
     */
    public static function modelYear(int $year = 1980): string
    {
        return substr(self::MODEL_YEAR, ($year - 1980) % 30, 1);
    }

    /**
     * @param string $character
     *
     * @return string
     */
    private static function transliterate(string $character): string
    {
        return stripos(self::EBCDIC, $character) % 10;
    }

    /**php
     * @param string $vin
     *
     * @return mixed
     */
    private static function checkDigit(string $vin): string
    {
        $map = "0123456789X";
        $weights = "8765432X098765432";
        $sum = 0;
        for ($i=0; $i < 17; $i++) {
            $sum += self::transliterate(substr($vin, $i, 1))
                    * stripos($map, $weights[$i]);
        }
        return $map[$sum % 11];
    }

    /**
     * @param $vin
     *
     * @return bool
     */
    public static function validateVin(string $vin): bool
    {
        if (strlen($vin) !== 17) {
            return false;
        }

        return self::checkDigit($vin) == $vin[8];
    }
}


pelmered / fake-car

Push — feature/add-engine-power-and-t... ( af7024 )

FakeCar::vin() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like